开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 游戏 > 游戏引擎 > 查看源码
lllineeditor.h
资源名称：snowglobe-src-viewer-2.0.0-r0.tar.gz　[点击查看]
上传用户：king477883
上传日期：2021-03-01
资源大小：9553k
文件大小：13k
源码类别：

游戏引擎

开发平台：

C++ Builder

lllineeditor.h：源码内容
  1. /** 
  2.  * @file lllineeditor.h
  3.  * @brief Text editor widget to let users enter/edit a single line.
  4.  *
  5.  * Features: 
  6.  * Text entry of a single line (text, delete, left and right arrow, insert, return).
  7.  * Callbacks either on every keystroke or just on the return key.
  8.  * Focus (allow multiple text entry widgets)
  9.  * Clipboard (cut, copy, and paste)
  10.  * Horizontal scrolling to allow strings longer than widget size allows 
  11.  * Pre-validation (limit which keys can be used)
  12.  * Optional line history so previous entries can be recalled by CTRL UP/DOWN
  13.  *
  14.  * $LicenseInfo:firstyear=2001&license=viewergpl$
  15.  * 
  16.  * Copyright (c) 2001-2010, Linden Research, Inc.
  17.  * 
  18.  * Second Life Viewer Source Code
  19.  * The source code in this file ("Source Code") is provided by Linden Lab
  20.  * to you under the terms of the GNU General Public License, version 2.0
  21.  * ("GPL"), unless you have obtained a separate licensing agreement
  22.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  23.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  24.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  25.  * 
  26.  * There are special exceptions to the terms and conditions of the GPL as
  27.  * it is applied to this Source Code. View the full text of the exception
  28.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  29.  * online at
  30.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  31.  * 
  32.  * By copying, modifying or distributing this software, you acknowledge
  33.  * that you have read and understood your obligations described above,
  34.  * and agree to abide by those obligations.
  35.  * 
  36.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  37.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  38.  * COMPLETENESS OR PERFORMANCE.
  39.  * $/LicenseInfo$
  40.  */
  42. #ifndef LL_LLLINEEDITOR_H
  43. #define LL_LLLINEEDITOR_H
  45. #include "v4color.h"
  46. #include "llframetimer.h"
  48. #include "lleditmenuhandler.h"
  49. #include "lluictrl.h"
  50. #include "lluistring.h"
  51. #include "llviewborder.h"
  53. #include "llpreeditor.h"
  54. #include "lltextvalidate.h"
  56. class LLFontGL;
  57. class LLLineEditorRollback;
  58. class LLButton;
  59. class LLContextMenu;
  61. class LLLineEditor
  62. : public LLUICtrl, public LLEditMenuHandler, protected LLPreeditor
  63. {
  64. public:
  66. typedef boost::function<void (LLLineEditor* caller)> keystroke_callback_t;
  68. struct Params : public LLInitParam::Block<Params, LLUICtrl::Params>
  69. {
  70. Optional<std::string> default_text;
  71. Optional<S32> max_length_bytes;
  73. Optional<keystroke_callback_t> keystroke_callback;
  75. Optional<LLTextValidate::validate_func_t, LLTextValidate::ValidateTextNamedFuncs> prevalidate_callback;
  77. Optional<LLViewBorder::Params> border;
  79. Optional<LLUIImage*> background_image,
  80. background_image_disabled,
  81. background_image_focused;
  83. Optional<bool> select_on_focus,
  84. handle_edit_keys_directly,
  85. revert_on_esc,
  86. commit_on_focus_lost,
  87. ignore_tab;
  89. // colors
  90. Optional<LLUIColor> cursor_color,
  91. text_color,
  92. text_readonly_color,
  93. text_tentative_color,
  94. highlight_color,
  95. preedit_bg_color;
  97. Optional<S32> text_pad_left,
  98. text_pad_right;
  100. Ignored bg_visible;
  102. Params();
  103. };
  104. protected:
  105. LLLineEditor(const Params&);
  106. friend class LLUICtrlFactory;
  107. friend class LLFloaterEditUI;
  108. void showContextMenu(S32 x, S32 y);
  109. public:
  110. virtual ~LLLineEditor();
  112. // mousehandler overrides
  113. /*virtual*/ BOOL handleMouseDown(S32 x, S32 y, MASK mask);
  114. /*virtual*/ BOOL handleMouseUp(S32 x, S32 y, MASK mask);
  115. /*virtual*/ BOOL handleHover(S32 x, S32 y, MASK mask);
  116. /*virtual*/ BOOL handleDoubleClick(S32 x,S32 y,MASK mask);
  117. /*virtual*/ BOOL handleMiddleMouseDown(S32 x,S32 y,MASK mask);
  118. /*virtual*/ BOOL handleRightMouseDown(S32 x, S32 y, MASK mask);
  119. /*virtual*/ BOOL handleKeyHere(KEY key, MASK mask );
  120. /*virtual*/ BOOL handleUnicodeCharHere(llwchar uni_char);
  121. /*virtual*/ void onMouseCaptureLost();
  123. // LLEditMenuHandler overrides
  124. virtual void cut();
  125. virtual BOOL canCut() const;
  126. virtual void copy();
  127. virtual BOOL canCopy() const;
  128. virtual void paste();
  129. virtual BOOL canPaste() const;
  131. virtual void updatePrimary();
  132. virtual void copyPrimary();
  133.   virtual void pastePrimary();
  134. virtual BOOL canPastePrimary() const;
  136. virtual void doDelete();
  137. virtual BOOL canDoDelete() const;
  139. virtual void selectAll();
  140. virtual BOOL canSelectAll() const;
  142. virtual void deselect();
  143. virtual BOOL canDeselect() const;
  145. // view overrides
  146. virtual void draw();
  147. virtual void reshape(S32 width,S32 height,BOOL called_from_parent=TRUE);
  148. virtual void onFocusReceived();
  149. virtual void onFocusLost();
  150. virtual void setEnabled(BOOL enabled);
  152. // UI control overrides
  153. virtual void clear();
  154. virtual void onTabInto();
  155. virtual void setFocus( BOOL b );
  156. virtual void  setRect(const LLRect& rect);
  157. virtual BOOL acceptsTextInput() const;
  158. virtual void onCommit();
  159. virtual BOOL isDirty() const; // Returns TRUE if user changed value at all
  160. virtual void resetDirty(); // Clear dirty state
  162. // assumes UTF8 text
  163. virtual void setValue(const LLSD& value );
  164. virtual LLSD getValue() const;
  165. virtual BOOL setTextArg( const std::string& key, const LLStringExplicit& text );
  166. virtual BOOL setLabelArg( const std::string& key, const LLStringExplicit& text );
  168. void setLabel(const LLStringExplicit &new_label) { mLabel = new_label; }
  169. const std::string&  getLabel() { return mLabel.getString(); }
  171. void setText(const LLStringExplicit &new_text);
  173. const std::string& getText() const { return mText.getString(); }
  174. LLWString       getWText() const { return mText.getWString(); }
  175. LLWString getConvertedText() const; // trimmed text with paragraphs converted to newlines
  177. S32 getLength() const { return mText.length(); }
  179. S32 getCursor() const { return mCursorPos; }
  180. void setCursor( S32 pos );
  181. void setCursorToEnd();
  183. // Selects characters 'start' to 'end'.
  184. void setSelection(S32 start, S32 end);
  185. virtual void getSelectionRange(S32 *position, S32 *length) const;
  187. void setCommitOnFocusLost( BOOL b ) { mCommitOnFocusLost = b; }
  188. void setRevertOnEsc( BOOL b ) { mRevertOnEsc = b; }
  190. void setCursorColor(const LLColor4& c) { mCursorColor = c; }
  191. const LLColor4& getCursorColor() const { return mCursorColor.get(); }
  193. void setFgColor( const LLColor4& c ) { mFgColor = c; }
  194. void setReadOnlyFgColor( const LLColor4& c ) { mReadOnlyFgColor = c; }
  195. void setTentativeFgColor(const LLColor4& c) { mTentativeFgColor = c; }
  197. const LLColor4& getFgColor() const { return mFgColor.get(); }
  198. const LLColor4& getReadOnlyFgColor() const { return mReadOnlyFgColor.get(); }
  199. const LLColor4& getTentativeFgColor() const { return mTentativeFgColor.get(); }
  201. const LLFontGL* getFont() const { return mGLFont; }
  203. void setIgnoreArrowKeys(BOOL b) { mIgnoreArrowKeys = b; }
  204. void setIgnoreTab(BOOL b) { mIgnoreTab = b; }
  205. void setPassDelete(BOOL b) { mPassDelete = b; }
  206. void setDrawAsterixes(BOOL b);
  208. // get the cursor position of the beginning/end of the prev/next word in the text
  209. S32 prevWordPos(S32 cursorPos) const;
  210. S32 nextWordPos(S32 cursorPos) const;
  212. BOOL hasSelection() const { return (mSelectionStart != mSelectionEnd); }
  213. void startSelection();
  214. void endSelection();
  215. void extendSelection(S32 new_cursor_pos);
  216. void deleteSelection();
  218. void setHandleEditKeysDirectly( BOOL b ) { mHandleEditKeysDirectly = b; }
  219. void setSelectAllonFocusReceived(BOOL b);
  221. typedef boost::function<void (LLLineEditor* caller, void* user_data)> callback_t;
  222. void setKeystrokeCallback(callback_t callback, void* user_data);
  224. void setMaxTextLength(S32 max_text_length);
  225. // Manipulate left and right padding for text
  226. void getTextPadding(S32 *left, S32 *right);
  227. void setTextPadding(S32 left, S32 right);
  229. // Prevalidation controls which keystrokes can affect the editor
  230. void setPrevalidate( LLTextValidate::validate_func_t func );
  231. static BOOL postvalidateFloat(const std::string &str);
  233. // line history support:
  234. void setEnableLineHistory( BOOL enabled ) { mHaveHistory = enabled; } // switches line history on or off 
  235. void updateHistory(); // stores current line in history
  237. void setReplaceNewlinesWithSpaces(BOOL replace);
  239. void setContextMenu(LLContextMenu* new_context_menu);
  241. private:
  242. // private helper methods
  244. void                    pasteHelper(bool is_primary);
  246. void removeChar();
  247. void addChar(const llwchar c);
  248. void setCursorAtLocalPos(S32 local_mouse_x);
  249. S32 findPixelNearestPos(S32 cursor_offset = 0) const;
  250. void reportBadKeystroke();
  251. BOOL handleSpecialKey(KEY key, MASK mask);
  252. BOOL handleSelectionKey(KEY key, MASK mask);
  253. BOOL handleControlKey(KEY key, MASK mask);
  254. S32 handleCommitKey(KEY key, MASK mask);
  255. void updateTextPadding();
  257. // Draw the background image depending on enabled/focused state.
  258. void drawBackground();
  260. //
  261. // private data members
  262. //
  263. void updateAllowingLanguageInput();
  264. BOOL hasPreeditString() const;
  265. // Implementation (overrides) of LLPreeditor
  266. virtual void resetPreedit();
  267. virtual void updatePreedit(const LLWString &preedit_string,
  268. const segment_lengths_t &preedit_segment_lengths, const standouts_t &preedit_standouts, S32 caret_position);
  269. virtual void markAsPreedit(S32 position, S32 length);
  270. virtual void getPreeditRange(S32 *position, S32 *length) const;
  271. virtual BOOL getPreeditLocation(S32 query_position, LLCoordGL *coord, LLRect *bounds, LLRect *control) const;
  272. virtual S32 getPreeditFontSize() const;
  273. virtual LLWString getPreeditString() const { return getWText(); }
  275. protected:
  276. LLUIString mText; // The string being edited.
  277. std::string mPrevText; // Saved string for 'ESC' revert
  278. LLUIString mLabel; // text label that is visible when no user text provided
  280. // line history support:
  281. BOOL mHaveHistory; // flag for enabled line history
  282. typedef std::vector<std::string> line_history_t;
  283. line_history_t mLineHistory; // line history storage
  284. line_history_t::iterator mCurrentHistoryLine; // currently browsed history line
  286. LLViewBorder* mBorder;
  287. const LLFontGL* mGLFont;
  288. S32 mMaxLengthBytes; // Max length of the UTF8 string in bytes
  289. S32 mCursorPos; // I-beam is just after the mCursorPos-th character.
  290. S32 mScrollHPos; // Horizontal offset from the start of mText.  Used for scrolling.
  291. LLFrameTimer mScrollTimer;
  292. S32 mTextPadLeft; // Used to reserve space before the beginning of the text for children.
  293. S32 mTextPadRight; // Used to reserve space after the end of the text for children.
  294. S32 mTextLeftEdge; // Pixels, cached left edge of text based on left padding and width
  295. S32 mTextRightEdge; // Pixels, cached right edge of text based on right padding and width
  297. BOOL mCommitOnFocusLost;
  298. BOOL mRevertOnEsc;
  300. keystroke_callback_t mKeystrokeCallback;
  302. BOOL mIsSelecting; // Selection for clipboard operations
  303. S32 mSelectionStart;
  304. S32 mSelectionEnd;
  305. S32 mLastSelectionX;
  306. S32 mLastSelectionY;
  307. S32 mLastSelectionStart;
  308. S32 mLastSelectionEnd;
  310. LLTextValidate::validate_func_t mPrevalidateFunc;
  312. LLFrameTimer mKeystrokeTimer;
  313. LLTimer mTripleClickTimer;
  315. LLUIColor mCursorColor;
  316. LLUIColor mFgColor;
  317. LLUIColor mReadOnlyFgColor;
  318. LLUIColor mTentativeFgColor;
  319. LLUIColor mHighlightColor; // background for selected text
  320. LLUIColor mPreeditBgColor; // preedit marker background color
  322. S32 mBorderThickness;
  324. BOOL mIgnoreArrowKeys;
  325. BOOL mIgnoreTab;
  326. BOOL mDrawAsterixes;
  328. BOOL mHandleEditKeysDirectly;  // If true, the standard edit keys (Ctrl-X, Delete, etc,) are handled here instead of routed by the menu system
  329. BOOL mSelectAllonFocusReceived;
  330. BOOL mPassDelete;
  332. BOOL mReadOnly;
  334. LLWString mPreeditWString;
  335. LLWString mPreeditOverwrittenWString;
  336. std::vector<S32> mPreeditPositions;
  337. LLPreeditor::standouts_t mPreeditStandouts;
  339. LLHandle<LLView> mContextMenuHandle;
  341. private:
  342. // Instances that by default point to the statics but can be overidden in XML.
  343. LLPointer<LLUIImage> mBgImage;
  344. LLPointer<LLUIImage> mBgImageDisabled;
  345. LLPointer<LLUIImage> mBgImageFocused;
  347. BOOL        mReplaceNewlinesWithSpaces; // if false, will replace pasted newlines with paragraph symbol.
  349. // private helper class
  350. class LLLineEditorRollback
  351. {
  352. public:
  353. LLLineEditorRollback( LLLineEditor* ed )
  354. :
  355. mCursorPos( ed->mCursorPos ),
  356. mScrollHPos( ed->mScrollHPos ),
  357. mIsSelecting( ed->mIsSelecting ),
  358. mSelectionStart( ed->mSelectionStart ),
  359. mSelectionEnd( ed->mSelectionEnd )
  360. {
  361. mText = ed->getText();
  362. }
  364. void doRollback( LLLineEditor* ed )
  365. {
  366. ed->mCursorPos = mCursorPos;
  367. ed->mScrollHPos = mScrollHPos;
  368. ed->mIsSelecting = mIsSelecting;
  369. ed->mSelectionStart = mSelectionStart;
  370. ed->mSelectionEnd = mSelectionEnd;
  371. ed->mText = mText;
  372. ed->mPrevText = mText;
  373. }
  375. std::string getText()   { return mText; }
  377. private:
  378. std::string mText;
  379. S32 mCursorPos;
  380. S32 mScrollHPos;
  381. BOOL mIsSelecting;
  382. S32 mSelectionStart;
  383. S32 mSelectionEnd;
  384. }; // end class LLLineEditorRollback
  386. }; // end class LLLineEditor
  388. // Build time optimization, generate once in .cpp file
  389. #ifndef LLLINEEDITOR_CPP
  390. extern template class LLLineEditor* LLView::getChild<class LLLineEditor>(
  391. const std::string& name, BOOL recurse) const;
  392. #endif
  394. #endif  // LL_LINEEDITOR_