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
|
/**
* @file lllineeditor.h
* @brief LLLineEditor base class
*
* Copyright (c) 2001-$CurrentYear$, Linden Research, Inc.
* $License$
*/
// Text editor widget to let users enter/edit a single line.
//
//
// Features:
// Text entry of a single line (text, delete, left and right arrow, insert, return).
// Callbacks either on every keystroke or just on the return key.
// Focus (allow multiple text entry widgets)
// Clipboard (cut, copy, and paste)
// Horizontal scrolling to allow strings longer than widget size allows
// Pre-validation (limit which keys can be used)
#ifndef LL_LLLINEEDITOR_H
#define LL_LLLINEEDITOR_H
#include "v4color.h"
#include "llframetimer.h"
#include "lleditmenuhandler.h"
#include "lluictrl.h"
#include "lluistring.h"
#include "llviewborder.h"
class LLFontGL;
class LLLineEditorRollback;
class LLButton;
typedef BOOL (*LLLinePrevalidateFunc)(const LLWString &wstr);
//
// Classes
//
class LLLineEditor
: public LLUICtrl, public LLEditMenuHandler
{
friend class LLLineEditorRollback;
public:
LLLineEditor(const LLString& name,
const LLRect& rect,
const LLString& default_text = LLString::null,
const LLFontGL* glfont = NULL,
S32 max_length_bytes = 254,
void (*commit_callback)(LLUICtrl* caller, void* user_data) = NULL,
void (*keystroke_callback)(LLLineEditor* caller, void* user_data) = NULL,
void (*focus_lost_callback)(LLLineEditor* caller, void* user_data) = NULL,
void* userdata = NULL,
LLLinePrevalidateFunc prevalidate_func = NULL,
LLViewBorder::EBevel border_bevel = LLViewBorder::BEVEL_IN,
LLViewBorder::EStyle border_style = LLViewBorder::STYLE_LINE,
S32 border_thickness = 1);
virtual ~LLLineEditor();
virtual EWidgetType getWidgetType() const;
virtual LLString getWidgetTag() const;
virtual LLXMLNodePtr getXML(bool save_children = true) const;
void setColorParameters(LLXMLNodePtr node);
static LLView* fromXML(LLXMLNodePtr node, LLView *parent, LLUICtrlFactory *factory);
// mousehandler overrides
/*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*/ BOOL handleDoubleClick(S32 x,S32 y,MASK mask);
/*virtual*/ BOOL handleKeyHere(KEY key, MASK mask, BOOL called_from_parent );
/*virtual*/ BOOL handleUnicodeCharHere(llwchar uni_char, BOOL called_from_parent);
// LLEditMenuHandler overrides
virtual void cut();
virtual BOOL canCut();
virtual void copy();
virtual BOOL canCopy();
virtual void paste();
virtual BOOL canPaste();
virtual void doDelete();
virtual BOOL canDoDelete();
virtual void selectAll();
virtual BOOL canSelectAll();
virtual void deselect();
virtual BOOL canDeselect();
// view overrides
virtual void draw();
virtual void reshape(S32 width,S32 height,BOOL called_from_parent=TRUE);
virtual void onFocusLost();
virtual void setEnabled(BOOL enabled);
// UI control overrides
virtual void clear();
virtual void onTabInto();
virtual void setFocus( BOOL b );
virtual void setRect(const LLRect& rect);
virtual BOOL acceptsTextInput() const;
virtual void onCommit();
// assumes UTF8 text
virtual void setValue(const LLSD& value );
virtual LLSD getValue() const;
virtual BOOL setTextArg( const LLString& key, const LLString& text );
virtual BOOL setLabelArg( const LLString& key, const LLString& text );
void setLabel(const LLString &new_label);
void setText(const LLString &new_text);
const LLString& getText() const { return mText.getString(); }
const LLWString& getWText() const { return mText.getWString(); }
S32 getLength() const { return mText.length(); }
S32 getCursor() { return mCursorPos; }
void setCursor( S32 pos );
void setCursorToEnd();
// Selects characters 'start' to 'end'.
void setSelection(S32 start, S32 end);
void setCommitOnFocusLost( BOOL b ) { mCommitOnFocusLost = b; }
void setCursorColor(const LLColor4& c) { mCursorColor = c; }
const LLColor4& getCursorColor() const { return mCursorColor; }
void setFgColor( const LLColor4& c ) { mFgColor = c; }
void setReadOnlyFgColor( const LLColor4& c ) { mReadOnlyFgColor = c; }
void setTentativeFgColor(const LLColor4& c) { mTentativeFgColor = c; }
void setWriteableBgColor( const LLColor4& c ) { mWriteableBgColor = c; }
void setReadOnlyBgColor( const LLColor4& c ) { mReadOnlyBgColor = c; }
void setFocusBgColor(const LLColor4& c) { mFocusBgColor = c; }
const LLColor4& getFgColor() const { return mFgColor; }
const LLColor4& getReadOnlyFgColor() const { return mReadOnlyFgColor; }
const LLColor4& getTentativeFgColor() const { return mTentativeFgColor; }
const LLColor4& getWriteableBgColor() const { return mWriteableBgColor; }
const LLColor4& getReadOnlyBgColor() const { return mReadOnlyBgColor; }
const LLColor4& getFocusBgColor() const { return mFocusBgColor; }
void setIgnoreArrowKeys(BOOL b) { mIgnoreArrowKeys = b; }
void setIgnoreTab(BOOL b) { mIgnoreTab = b; }
void setPassDelete(BOOL b) { mPassDelete = b; }
void setDrawAsterixes(BOOL b) { mDrawAsterixes = b; }
// get the cursor position of the beginning/end of the prev/next word in the text
S32 prevWordPos(S32 cursorPos) const;
S32 nextWordPos(S32 cursorPos) const;
BOOL hasSelection() { return (mSelectionStart != mSelectionEnd); }
void startSelection();
void endSelection();
void extendSelection(S32 new_cursor_pos);
void deleteSelection();
void setHandleEditKeysDirectly( BOOL b ) { mHandleEditKeysDirectly = b; }
void setSelectAllonFocusReceived(BOOL b);
void setKeystrokeCallback(void (*keystroke_callback)(LLLineEditor* caller, void* user_data));
void setFocusLostCallback(void (*keystroke_callback)(LLLineEditor* caller, void* user_data));
void setMaxTextLength(S32 max_text_length);
void setBorderWidth(S32 left, S32 right);
static BOOL isPartOfWord(llwchar c);
// Prevalidation controls which keystrokes can affect the editor
void setPrevalidate( BOOL (*func)(const LLWString &) ) { mPrevalidateFunc = func; }
static BOOL prevalidateFloat(const LLWString &str );
static BOOL prevalidateInt(const LLWString &str );
static BOOL prevalidatePositiveS32(const LLWString &str);
static BOOL prevalidateNonNegativeS32(const LLWString &str);
static BOOL prevalidateAlphaNum(const LLWString &str );
static BOOL prevalidateAlphaNumSpace(const LLWString &str );
static BOOL prevalidatePrintableNotPipe(const LLWString &str);
static BOOL prevalidatePrintableNoSpace(const LLWString &str);
static BOOL prevalidateASCII(const LLWString &str);
static BOOL postvalidateFloat(const LLString &str);
static void onMouseCaptureLost( LLMouseHandler* old_captor );
protected:
void removeChar();
void addChar(const llwchar c);
void setCursorAtLocalPos(S32 local_mouse_x);
S32 findPixelNearestPos(S32 cursor_offset = 0);
void reportBadKeystroke();
BOOL handleSpecialKey(KEY key, MASK mask);
BOOL handleSelectionKey(KEY key, MASK mask);
BOOL handleControlKey(KEY key, MASK mask);
S32 handleCommitKey(KEY key, MASK mask);
protected:
LLUIString mText; // The string being edited.
LLUIString mLabel; // text label that is visible when no user text provided
LLViewBorder* mBorder;
const LLFontGL* mGLFont;
S32 mMaxLengthChars; // Max number of characters
S32 mMaxLengthBytes; // Max length of the UTF8 string.
S32 mCursorPos; // I-beam is just after the mCursorPos-th character.
S32 mScrollHPos; // Horizontal offset from the start of mText. Used for scrolling.
LLFrameTimer mScrollTimer;
S32 mMinHPixels;
S32 mMaxHPixels;
S32 mBorderLeft;
S32 mBorderRight;
BOOL mCommitOnFocusLost;
void (*mKeystrokeCallback)( LLLineEditor* caller, void* userdata );
void (*mFocusLostCallback)( LLLineEditor* caller, void* userdata );
BOOL mIsSelecting; // Selection for clipboard operations
S32 mSelectionStart;
S32 mSelectionEnd;
S32 mLastSelectionX;
S32 mLastSelectionY;
S32 (*mPrevalidateFunc)(const LLWString &str);
LLFrameTimer mKeystrokeTimer;
LLColor4 mCursorColor;
LLColor4 mFgColor;
LLColor4 mReadOnlyFgColor;
LLColor4 mTentativeFgColor;
LLColor4 mWriteableBgColor;
LLColor4 mReadOnlyBgColor;
LLColor4 mFocusBgColor;
S32 mBorderThickness;
BOOL mIgnoreArrowKeys;
BOOL mIgnoreTab;
BOOL mDrawAsterixes;
BOOL mHandleEditKeysDirectly; // If true, the standard edit keys (Ctrl-X, Delete, etc,) are handled here instead of routed by the menu system
BOOL mSelectAllonFocusReceived;
BOOL mPassDelete;
BOOL mReadOnly;
};
class LLSearchEditor : public LLUICtrl
{
friend class LLLineEditorRollback;
public:
LLSearchEditor(const LLString& name,
const LLRect& rect,
S32 max_length_bytes,
void (*search_callback)(const LLString& search_string, void* user_data),
void* userdata);
virtual ~LLSearchEditor();
/*virtual*/ void draw();
virtual EWidgetType getWidgetType() const;
virtual LLString getWidgetTag() const;
static LLView* fromXML(LLXMLNodePtr node, LLView *parent, LLUICtrlFactory *factory);
void setText(const LLString &new_text);
void setSearchCallback(void (*search_callback)(const LLString& search_string, void* user_data), void* data) { mSearchCallback = search_callback; mCallbackUserData = data; }
// LLUICtrl interface
virtual void setValue(const LLSD& value );
virtual LLSD getValue() const;
virtual BOOL setTextArg( const LLString& key, const LLString& text );
virtual BOOL setLabelArg( const LLString& key, const LLString& text );
virtual void clear();
protected:
LLLineEditor* mSearchEdit;
LLButton* mClearSearchButton;
void (*mSearchCallback)(const LLString& search_string, void* user_data);
static void onSearchEdit(LLLineEditor* caller, void* user_data );
static void onClearSearch(void* user_data);
};
#endif // LL_LINEEDITOR_
|
