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
|
/**
* @file llbutton.h
* @brief Header for buttons
*
* Copyright (c) 2001-2007, Linden Research, Inc.
*
* Second Life Viewer Source Code
* The source code in this file ("Source Code") is provided by Linden Lab
* to you under the terms of the GNU General Public License, version 2.0
* ("GPL"), unless you have obtained a separate licensing agreement
* ("Other License"), formally executed by you and Linden Lab. Terms of
* the GPL can be found in doc/GPL-license.txt in this distribution, or
* online at http://secondlife.com/developers/opensource/gplv2
*
* There are special exceptions to the terms and conditions of the GPL as
* it is applied to this Source Code. View the full text of the exception
* in the file doc/FLOSS-exception.txt in this software distribution, or
* online at http://secondlife.com/developers/opensource/flossexception
*
* By copying, modifying or distributing this software, you acknowledge
* that you have read and understood your obligations described above,
* and agree to abide by those obligations.
*
* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
* COMPLETENESS OR PERFORMANCE.
*/
#ifndef LL_LLBUTTON_H
#define LL_LLBUTTON_H
#include "lluuid.h"
#include "llcontrol.h"
#include "lluictrl.h"
#include "v4color.h"
#include "llframetimer.h"
#include "llfontgl.h"
#include "llimage.h"
#include "lluistring.h"
//
// Constants
//
// PLEASE please use these "constants" when building your own buttons.
// They are loaded from settings.xml at run time.
extern S32 LLBUTTON_H_PAD;
extern S32 LLBUTTON_V_PAD;
extern S32 BTN_HEIGHT_SMALL;
extern S32 BTN_HEIGHT;
// All button widths should be rounded up to this size
extern S32 BTN_GRID;
class LLUICtrlFactory;
//
// Classes
//
class LLButton
: public LLUICtrl
{
public:
// simple button with text label
LLButton(const LLString& name, const LLRect &rect, const LLString& control_name = "",
void (*on_click)(void*) = NULL, void *data = NULL);
LLButton(const LLString& name, const LLRect& rect,
const LLString &unselected_image,
const LLString &selected_image,
const LLString& control_name,
void (*click_callback)(void*),
void *callback_data = NULL,
const LLFontGL* mGLFont = NULL,
const LLString& unselected_label = LLString::null,
const LLString& selected_label = LLString::null );
virtual ~LLButton();
void init(void (*click_callback)(void*), void *callback_data, const LLFontGL* font, const LLString& control_name);
virtual EWidgetType getWidgetType() const;
virtual LLString getWidgetTag() const;
void addImageAttributeToXML(LLXMLNodePtr node, const LLString& imageName,
const LLUUID& imageID,const LLString& xmlTagName) const;
virtual LLXMLNodePtr getXML(bool save_children = true) const;
static LLView* fromXML(LLXMLNodePtr node, LLView *parent, LLUICtrlFactory *factory);
virtual BOOL handleUnicodeCharHere(llwchar uni_char, BOOL called_from_parent);
virtual BOOL handleKeyHere(KEY key, MASK mask, BOOL called_from_parent);
virtual BOOL handleMouseDown(S32 x, S32 y, MASK mask);
virtual BOOL handleMouseUp(S32 x, S32 y, MASK mask);
virtual BOOL handleHover(S32 x, S32 y, MASK mask);
virtual void draw();
virtual void onMouseCaptureLost();
// HACK: "committing" a button is the same as clicking on it.
virtual void onCommit();
virtual BOOL isDirty() { return mIsDirty; }; // Returns TRUE if the user has clicked on the button at all
void setUnselectedLabelColor( const LLColor4& c ) { mUnselectedLabelColor = c; }
void setSelectedLabelColor( const LLColor4& c ) { mSelectedLabelColor = c; }
void setClickedCallback( void (*cb)(void *data), void* data = NULL ); // mouse down and up within button
void setMouseDownCallback( void (*cb)(void *data) ) { mMouseDownCallback = cb; } // mouse down within button
void setMouseUpCallback( void (*cb)(void *data) ) { mMouseUpCallback = cb; } // mouse up, EVEN IF NOT IN BUTTON
void setHeldDownCallback( void (*cb)(void *data) ) { mHeldDownCallback = cb; } // Mouse button held down and in button
void setHeldDownDelay( F32 seconds, S32 frames = 0) { mHeldDownDelay = seconds; mHeldDownFrameDelay = frames; }
F32 getHeldDownTime() const { return mMouseDownTimer.getElapsedTimeF32(); }
BOOL toggleState() { setToggleState( !mToggleState ); return mToggleState; }
BOOL getToggleState() const { return mToggleState; }
void setToggleState(BOOL b);
void setFlashing( BOOL b ) { mFlashing = b; }
BOOL getFlashing() const { return mFlashing; }
void setHAlign( LLFontGL::HAlign align ) { mHAlign = align; }
void setLeftHPad( S32 pad ) { mLeftHPad = pad; }
void setRightHPad( S32 pad ) { mRightHPad = pad; }
const LLString getLabelUnselected() const { return wstring_to_utf8str(mUnselectedLabel); }
const LLString getLabelSelected() const { return wstring_to_utf8str(mSelectedLabel); }
// HACK to allow images to be freed when the caller knows he's done with it.
LLImageGL* getImageUnselected() const { return mImageUnselected; }
void setImageColor(const LLString& color_control);
void setImages(const LLString &image_name, const LLString &selected_name);
void setImageColor(const LLColor4& c);
void setDisabledImages(const LLString &image_name, const LLString &selected_name);
void setDisabledImages(const LLString &image_name, const LLString &selected_name, const LLColor4& c);
void setHoverImages(const LLString &image_name, const LLString &selected_name);
void setDisabledImageColor(const LLColor4& c) { mDisabledImageColor = c; }
void setDisabledSelectedLabelColor( const LLColor4& c ) { mDisabledSelectedLabelColor = c; }
void setImageOverlay(const LLString &image_name, LLFontGL::HAlign alignment = LLFontGL::HCENTER, const LLColor4& color = LLColor4::white);
LLPointer<LLImageGL> getImageOverlay() { return mImageOverlay; }
virtual void setValue(const LLSD& value );
virtual LLSD getValue() const;
void setLabel( const LLString& label);
virtual BOOL setLabelArg( const LLString& key, const LLString& text );
void setLabelUnselected(const LLString& label);
void setLabelSelected(const LLString& label);
void setDisabledLabel(const LLString& disabled_label);
void setDisabledSelectedLabel(const LLString& disabled_label);
void setDisabledLabelColor( const LLColor4& c ) { mDisabledLabelColor = c; }
void setFont(const LLFontGL *font)
{ mGLFont = ( font ? font : LLFontGL::sSansSerif); }
void setScaleImage(BOOL scale) { mScaleImage = scale; }
void setDropShadowedText(BOOL b) { mDropShadowedText = b; }
void setBorderEnabled(BOOL b) { mBorderEnabled = b; }
static void onHeldDown(void *userdata); // to be called by gIdleCallbacks
void setFixedBorder(S32 width, S32 height) { mFixedWidth = width; mFixedHeight = height; }
void setHoverGlowStrength(F32 strength) { mHoverGlowStrength = strength; }
private:
void setImageUnselectedID(const LLUUID &image_id);
void setImageSelectedID(const LLUUID &image_id);
void setImageHoverSelectedID(const LLUUID &image_id);
void setImageHoverUnselectedID(const LLUUID &image_id);
void setImageDisabledID(const LLUUID &image_id);
void setImageDisabledSelectedID(const LLUUID &image_id);
public:
void setImageUnselected(const LLString &image_name);
void setImageSelected(const LLString &image_name);
void setImageHoverSelected(const LLString &image_name);
void setImageHoverUnselected(const LLString &image_name);
void setImageDisabled(const LLString &image_name);
void setImageDisabledSelected(const LLString &image_name);
void setCommitOnReturn(BOOL commit) { mCommitOnReturn = commit; }
BOOL getCommitOnReturn() { return mCommitOnReturn; }
void setHelpURLCallback(std::string help_url);
LLString getHelpURL() { return mHelpURL; }
protected:
virtual void drawBorder(const LLColor4& color, S32 size);
protected:
void (*mClickedCallback)(void* data );
void (*mMouseDownCallback)(void *data);
void (*mMouseUpCallback)(void *data);
void (*mHeldDownCallback)(void *data);
const LLFontGL *mGLFont;
LLFrameTimer mMouseDownTimer;
S32 mMouseDownFrame;
F32 mHeldDownDelay; // seconds, after which held-down callbacks get called
S32 mHeldDownFrameDelay; // frames, after which held-down callbacks get called
LLPointer<LLImageGL> mImageOverlay;
LLFontGL::HAlign mImageOverlayAlignment;
LLColor4 mImageOverlayColor;
LLPointer<LLImageGL> mImageUnselected;
LLUIString mUnselectedLabel;
LLColor4 mUnselectedLabelColor;
LLPointer<LLImageGL> mImageSelected;
LLUIString mSelectedLabel;
LLColor4 mSelectedLabelColor;
LLPointer<LLImageGL> mImageHoverSelected;
LLPointer<LLImageGL> mImageHoverUnselected;
LLPointer<LLImageGL> mImageDisabled;
LLUIString mDisabledLabel;
LLColor4 mDisabledLabelColor;
LLPointer<LLImageGL> mImageDisabledSelected;
LLUIString mDisabledSelectedLabel;
LLColor4 mDisabledSelectedLabelColor;
LLUUID mImageUnselectedID;
LLUUID mImageSelectedID;
LLUUID mImageHoverSelectedID;
LLUUID mImageHoverUnselectedID;
LLUUID mImageDisabledID;
LLUUID mImageDisabledSelectedID;
LLString mImageUnselectedName;
LLString mImageSelectedName;
LLString mImageHoverSelectedName;
LLString mImageHoverUnselectedName;
LLString mImageDisabledName;
LLString mImageDisabledSelectedName;
LLColor4 mHighlightColor;
LLColor4 mUnselectedBgColor;
LLColor4 mSelectedBgColor;
LLColor4 mImageColor;
LLColor4 mDisabledImageColor;
BOOL mToggleState;
BOOL mScaleImage;
BOOL mDropShadowedText;
BOOL mBorderEnabled;
BOOL mFlashing;
LLFontGL::HAlign mHAlign;
S32 mLeftHPad;
S32 mRightHPad;
S32 mFixedWidth;
S32 mFixedHeight;
F32 mHoverGlowStrength;
F32 mCurGlowStrength;
BOOL mNeedsHighlight;
BOOL mCommitOnReturn;
LLString mHelpURL;
LLPointer<LLImageGL> mImagep;
BOOL mIsDirty;
static LLFrameTimer sFlashingTimer;
};
class LLSquareButton
: public LLButton
{
public:
LLSquareButton(const LLString& name, const LLRect& rect,
const LLString& label,
const LLFontGL *font = NULL,
const LLString& control_name = "",
void (*click_callback)(void*) = NULL,
void *callback_data = NULL,
const LLString& selected_label = LLString::null );
};
// Helpful functions
S32 round_up(S32 grid, S32 value);
#endif // LL_LLBUTTON_H
|
