summaryrefslogtreecommitdiff
path: root/indra/llui/llcheckboxctrl.h
blob: fc04a8a781f762992bfafc4e809e2a511c426386 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/**
 * @file llcheckboxctrl.h
 * @brief LLCheckBoxCtrl base class
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLCHECKBOXCTRL_H
#define LL_LLCHECKBOXCTRL_H

#include "lluictrl.h"
#include "llbutton.h"
#include "lltextbox.h"
#include "v4color.h"

//
// Constants
//

const bool  RADIO_STYLE = true;
const bool  CHECK_STYLE = false;

//
// Classes
//
class LLFontGL;
class LLViewBorder;

class LLCheckBoxCtrl
: public LLUICtrl
, public ll::ui::SearchableControl
{
public:

    enum EWordWrap
    {
        WRAP_NONE,
        WRAP_UP,
        WRAP_DOWN
    };

    struct WordWrap : public LLInitParam::TypeValuesHelper<EWordWrap, WordWrap>
    {
        static void declareValues();
    };

    struct Params
    :   public LLInitParam::Block<Params, LLUICtrl::Params>
    {
        Optional<bool>          initial_value;  // override LLUICtrl initial_value

        Optional<LLTextBox::Params> label_text;
        Optional<LLButton::Params> check_button;

        Optional<EWordWrap, WordWrap>   word_wrap;

        Ignored                 radio_style;

        Params();
    };

    virtual ~LLCheckBoxCtrl();

protected:
    LLCheckBoxCtrl(const Params&);
    friend class LLUICtrlFactory;

public:
    // LLView interface

    virtual void        setEnabled( bool b );

    virtual void        reshape(S32 width, S32 height, bool called_from_parent = true);

    // LLUICtrl interface
    virtual void        setValue(const LLSD& value );
    virtual LLSD        getValue() const;
            bool        get() { return (bool)getValue().asBoolean(); }
            void        set(bool value) { setValue(value); }

    virtual void        setTentative(bool b);
    virtual bool        getTentative() const;

    virtual bool        setLabelArg( const std::string& key, const LLStringExplicit& text );

    virtual void        clear();
    virtual void        onCommit();

    // LLCheckBoxCtrl interface
    virtual bool        toggle()                { return mButton->toggleState(); }      // returns new state

    void                setBtnFocus() { mButton->setFocus(true); }

    void                setEnabledColor( const LLColor4 &color ) { mTextEnabledColor = color; }
    void                setDisabledColor( const LLColor4 &color ) { mTextDisabledColor = color; }

    void                setLabel( const LLStringExplicit& label );
    std::string         getLabel() const;

    void                setFont( const LLFontGL* font ) { mFont = font; }
    const LLFontGL*     getFont() const { return mFont; }

    virtual void        setControlName(const std::string& control_name, LLView* context);

    virtual bool        isDirty()   const;      // Returns true if the user has modified this control.
    virtual void        resetDirty();           // Clear dirty state

protected:
    virtual std::string _getSearchText() const
    {
        return getLabel() + getToolTip();
    }

    virtual void onSetHighlight() const // When highlight, really do highlight the label
    {
        if( mLabel )
            mLabel->ll::ui::SearchableControl::setHighlighted( ll::ui::SearchableControl::getHighlighted() );
    }

protected:
    // note: value is stored in toggle state of button
    LLButton*       mButton;
    LLTextBox*      mLabel;
    const LLFontGL* mFont;

    LLUIColor       mTextEnabledColor;
    LLUIColor       mTextDisabledColor;

    EWordWrap       mWordWrap; // off, shifts text up, shifts text down
};

// Build time optimization, generate once in .cpp file
#ifndef LLCHECKBOXCTRL_CPP
extern template class LLCheckBoxCtrl* LLView::getChild<class LLCheckBoxCtrl>(
    std::string_view name, bool recurse) const;
#endif

#endif  // LL_LLCHECKBOXCTRL_H