summaryrefslogtreecommitdiff
path: root/indra/llui/lltoolbar.h
blob: 1a9c1cdf9fecf18cc3c2e6056f75cc848c49425b (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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
/**
 * @file lltoolbar.h
 * @author Richard Nelson
 * @brief User customizable toolbar class
 *
 * $LicenseInfo:firstyear=2011&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2011, 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_LLTOOLBAR_H
#define LL_LLTOOLBAR_H

#include "llbutton.h"
#include "llcommandmanager.h"
#include "lllayoutstack.h"
#include "lluictrl.h"
#include "llcommandmanager.h"
#include "llassettype.h"

class LLToolBar;
class LLToolBarButton;
class LLIconCtrl;

typedef boost::function<void (S32 x, S32 y, LLToolBarButton* button)> tool_startdrag_callback_t;
typedef boost::function<BOOL (S32 x, S32 y, const LLUUID& uuid, LLAssetType::EType type)> tool_handledrag_callback_t;
typedef boost::function<BOOL (void* data, S32 x, S32 y, LLToolBar* toolbar)> tool_handledrop_callback_t;

class LLToolBarButton : public LLButton
{
    friend class LLToolBar;
public:
    struct Params : public LLInitParam::Block<Params, LLButton::Params>
    {
        Optional<LLUI::RangeS32::Params>    button_width;
        Optional<S32>                       desired_height;

        Params()
        :   button_width("button_width"),
            desired_height("desired_height", 20)
        {}

    };

    LLToolBarButton(const Params& p);
    ~LLToolBarButton();

    BOOL handleMouseDown(S32 x, S32 y, MASK mask);
    BOOL handleHover(S32 x, S32 y, MASK mask);

    void reshape(S32 width, S32 height, BOOL called_from_parent = true);
    void setEnabled(BOOL enabled);
    void setCommandId(const LLCommandId& id) { mId = id; }
    LLCommandId getCommandId() { return mId; }

    void setStartDragCallback(tool_startdrag_callback_t cb)   { mStartDragItemCallback  = cb; }
    void setHandleDragCallback(tool_handledrag_callback_t cb) { mHandleDragItemCallback = cb; }

    void onMouseEnter(S32 x, S32 y, MASK mask);
    void onMouseLeave(S32 x, S32 y, MASK mask);
    void onMouseCaptureLost();

    void onCommit();

    virtual const std::string getToolTip() const;

private:
    void callIfEnabled(LLUICtrl::commit_callback_t commit, LLUICtrl* ctrl, const LLSD& param );

    LLCommandId     mId;
    S32             mMouseDownX;
    S32             mMouseDownY;
    LLUI::RangeS32  mWidthRange;
    S32             mDesiredHeight;
    bool                            mIsDragged;
    tool_startdrag_callback_t       mStartDragItemCallback;
    tool_handledrag_callback_t      mHandleDragItemCallback;

    enable_signal_t*    mIsEnabledSignal;
    enable_signal_t*    mIsRunningSignal;
    enable_signal_t*    mIsStartingSignal;
    LLPointer<LLUIImage>    mOriginalImageSelected,
                            mOriginalImageUnselected,
                            mOriginalImagePressed,
                            mOriginalImagePressedSelected;
    LLUIColor               mOriginalLabelColor,
                            mOriginalLabelColorSelected,
                            mOriginalImageOverlayColor,
                            mOriginalImageOverlaySelectedColor;
};


namespace LLToolBarEnums
{
    enum ButtonType
    {
        BTNTYPE_ICONS_WITH_TEXT = 0,
        BTNTYPE_ICONS_ONLY,

        BTNTYPE_COUNT
    };

    enum SideType
    {
        SIDE_BOTTOM,
        SIDE_LEFT,
        SIDE_RIGHT,
        SIDE_TOP,
    };

    enum EToolBarLocation
    {
        TOOLBAR_NONE = 0,
        TOOLBAR_LEFT,
        TOOLBAR_RIGHT,
        TOOLBAR_BOTTOM,

        TOOLBAR_COUNT,

        TOOLBAR_FIRST = TOOLBAR_LEFT,
        TOOLBAR_LAST = TOOLBAR_BOTTOM,
    };

    LLView::EOrientation getOrientation(SideType sideType);
}

// NOTE: This needs to occur before Param block declaration for proper compilation.
namespace LLInitParam
{
    template<>
    struct TypeValues<LLToolBarEnums::ButtonType> : public TypeValuesHelper<LLToolBarEnums::ButtonType>
    {
        static void declareValues();
    };

    template<>
    struct TypeValues<LLToolBarEnums::SideType> : public TypeValuesHelper<LLToolBarEnums::SideType>
    {
        static void declareValues();
    };
}


class LLToolBar
:   public LLUICtrl
{
    friend class LLToolBarButton;
public:

    class LLCenterLayoutPanel : public LLLayoutPanel
    {
    public:
        typedef boost::function<void(LLToolBarEnums::EToolBarLocation tb, const LLRect& rect)> reshape_callback_t;

        virtual ~LLCenterLayoutPanel() {}
        /*virtual*/ void handleReshape(const LLRect& rect, bool by_user);

        void setLocationId(LLToolBarEnums::EToolBarLocation id) { mLocationId = id; }
        void setReshapeCallback(reshape_callback_t cb) { mReshapeCallback = cb; }
        void setButtonPanel(LLPanel * panel) { mButtonPanel = panel; }

    protected:
        friend class LLUICtrlFactory;
        LLCenterLayoutPanel(const Params& params) : LLLayoutPanel(params), mButtonPanel(NULL) {}

    private:
        reshape_callback_t                  mReshapeCallback;
        LLToolBarEnums::EToolBarLocation    mLocationId;
        LLPanel *                           mButtonPanel;
    };

    struct Params : public LLInitParam::Block<Params, LLUICtrl::Params>
    {
        Mandatory<LLToolBarEnums::ButtonType>   button_display_mode;
        Mandatory<LLToolBarEnums::SideType>     side;

        Optional<LLToolBarButton::Params>       button_icon,
                                                button_icon_and_text;

        Optional<bool>                          read_only,
                                                wrap;

        Optional<S32>                           pad_left,
                                                pad_top,
                                                pad_right,
                                                pad_bottom,
                                                pad_between,
                                                min_girth;

        // default command set
        Multiple<LLCommandId::Params>           commands;

        Optional<LLPanel::Params>               button_panel;

        Params();
    };

    // virtuals
    void draw();
    void reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);
    BOOL handleRightMouseDown(S32 x, S32 y, MASK mask);
    virtual BOOL handleDragAndDrop(S32 x, S32 y, MASK mask, BOOL drop,
                                   EDragAndDropType cargo_type,
                                   void* cargo_data,
                                   EAcceptance* accept,
                                   std::string& tooltip_msg);

    static const int RANK_NONE = -1;
    bool addCommand(const LLCommandId& commandId, int rank = RANK_NONE);
    int  removeCommand(const LLCommandId& commandId);       // Returns the rank the removed command was at, RANK_NONE if not found
    bool hasCommand(const LLCommandId& commandId) const;    // is this command bound to a button in this toolbar
    bool enableCommand(const LLCommandId& commandId, bool enabled); // enable/disable button bound to the specified command, if it exists in this toolbar
    bool stopCommandInProgress(const LLCommandId& commandId);   // stop command if it is currently active
    bool flashCommand(const LLCommandId& commandId, bool flash, bool force_flashing = false); // flash button associated with given command, if in this toolbar

    void setStartDragCallback(tool_startdrag_callback_t cb)   { mStartDragItemCallback  = cb; } // connects drag and drop behavior to external logic
    void setHandleDragCallback(tool_handledrag_callback_t cb) { mHandleDragItemCallback = cb; }
    void setHandleDropCallback(tool_handledrop_callback_t cb) { mHandleDropCallback     = cb; }
    bool isReadOnly() const { return mReadOnly; }
    LLCenterLayoutPanel * getCenterLayoutPanel() const { return mCenterPanel; }

    LLToolBarButton* createButton(const LLCommandId& id);

    typedef boost::signals2::signal<void (LLView* button)> button_signal_t;
    boost::signals2::connection setButtonAddCallback(const button_signal_t::slot_type& cb);
    boost::signals2::connection setButtonEnterCallback(const button_signal_t::slot_type& cb);
    boost::signals2::connection setButtonLeaveCallback(const button_signal_t::slot_type& cb);
    boost::signals2::connection setButtonRemoveCallback(const button_signal_t::slot_type& cb);

    // append the specified string to end of tooltip
    void setTooltipButtonSuffix(const std::string& suffix) { mButtonTooltipSuffix = suffix; }

    LLToolBarEnums::SideType getSideType() const { return mSideType; }
    bool hasButtons() const { return !mButtons.empty(); }
    bool isModified() const { return mModified; }

    int  getRankFromPosition(S32 x, S32 y);
    int  getRankFromPosition(const LLCommandId& id);

    // Methods used in loading and saving toolbar settings
    void setButtonType(LLToolBarEnums::ButtonType button_type);
    LLToolBarEnums::ButtonType getButtonType() { return mButtonType; }
    command_id_list_t& getCommandsList() { return mButtonCommands; }
    void clearCommandsList();

private:
    friend class LLUICtrlFactory;
    LLToolBar(const Params&);
    ~LLToolBar();

    void initFromParams(const Params&);
    void createContextMenu();
    void updateLayoutAsNeeded();
    void createButtons();
    void resizeButtonsInRow(std::vector<LLToolBarButton*>& buttons_in_row, S32 max_row_girth);
    BOOL isSettingChecked(const LLSD& userdata);
    void onSettingEnable(const LLSD& userdata);
    void onRemoveSelectedCommand();

private:
    // static layout state
    const bool                      mReadOnly;
    const LLToolBarEnums::SideType  mSideType;
    const bool                      mWrap;
    const S32                       mPadLeft,
                                    mPadRight,
                                    mPadTop,
                                    mPadBottom,
                                    mPadBetween,
                                    mMinGirth;

    // drag and drop state
    tool_startdrag_callback_t       mStartDragItemCallback;
    tool_handledrag_callback_t      mHandleDragItemCallback;
    tool_handledrop_callback_t      mHandleDropCallback;
    bool                            mDragAndDropTarget;
    int                             mDragRank;
    S32                             mDragx,
                                    mDragy,
                                    mDragGirth;

    typedef std::list<LLToolBarButton*> toolbar_button_list;
    typedef std::map<LLUUID, LLToolBarButton*> command_id_map;
    toolbar_button_list             mButtons;
    command_id_list_t               mButtonCommands;
    command_id_map                  mButtonMap;

    LLToolBarEnums::ButtonType      mButtonType;
    LLToolBarButton::Params         mButtonParams[LLToolBarEnums::BTNTYPE_COUNT];

    // related widgets
    LLLayoutStack*                  mCenteringStack;
    LLCenterLayoutPanel*            mCenterPanel;
    LLPanel*                        mButtonPanel;
    LLHandle<class LLContextMenu>   mPopupMenuHandle;
    LLHandle<class LLView>          mRemoveButtonHandle;

    LLToolBarButton*                mRightMouseTargetButton;

    bool                            mNeedsLayout;
    bool                            mModified;

    button_signal_t*                mButtonAddSignal;
    button_signal_t*                mButtonEnterSignal;
    button_signal_t*                mButtonLeaveSignal;
    button_signal_t*                mButtonRemoveSignal;

    std::string                     mButtonTooltipSuffix;

    LLIconCtrl*                     mCaretIcon;
};


#endif  // LL_LLTOOLBAR_H