llexpandabletextbox.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:5k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llexpandabletextbox.h
  3.  * @brief LLExpandableTextBox and related class definitions
  4.  *
  5.  * $LicenseInfo:firstyear=2004&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2004-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LL_LLEXPANDABLETEXTBOX_H
  33. #define LL_LLEXPANDABLETEXTBOX_H
  34. #include "lltexteditor.h"
  35. #include "llscrollcontainer.h"
  36. /**
  37.  * LLExpandableTextBox is a text box control that will show "More" link at end of text
  38.  * if text doesn't fit into text box. After pressing "More" the text box will expand to show
  39.  * all text. If text is still too big, a scroll bar will appear inside expanded text box.
  40.  */
  41. class LLExpandableTextBox : public LLUICtrl
  42. {
  43. protected:
  44. /**
  45.  * Extended text box. "More" link will appear at end of text if 
  46.  * text is too long to fit into text box size.
  47.  */
  48. class LLTextBoxEx : public LLTextEditor
  49. {
  50. public:
  51. struct Params : public LLInitParam::Block<Params, LLTextEditor::Params>
  52. {
  53. Mandatory<std::string> more_label;
  54. Params();
  55. };
  56. // adds or removes "More" link as needed
  57. /*virtual*/ void reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);
  58. /*virtual*/ void setText(const LLStringExplicit& text, const LLStyle::Params& input_params = LLStyle::Params());
  59. void setTextBase(const std::string& text) { LLTextBase::setText(text); }
  60. /**
  61.  * Returns difference between text box height and text height.
  62.  * Value is positive if text height is greater than text box height.
  63.  */
  64. virtual S32 getVerticalTextDelta();
  65. /**
  66.  * Returns the height of text rect.
  67.  */
  68. S32 getTextPixelHeight();
  69. /**
  70.  * Shows "More" link
  71.  */
  72. void showExpandText();
  73. /**
  74.  * Hides "More" link
  75.  */
  76. void hideExpandText();
  77. protected:
  78. LLTextBoxEx(const Params& p);
  79. friend class LLUICtrlFactory;
  80. private:
  81. std::string mExpanderLabel;
  82. bool mExpanderVisible;
  83. };
  84. public:
  85. struct Params : public LLInitParam::Block<Params, LLUICtrl::Params>
  86. {
  87. Optional<LLTextBoxEx::Params> textbox;
  88. Optional<LLScrollContainer::Params> scroll;
  89. Optional<S32> max_height;
  90. Optional<bool> bg_visible,
  91.    expanded_bg_visible;
  92. Optional<LLUIColor> bg_color,
  93.    expanded_bg_color;
  94. Params();
  95. };
  96. /**
  97.  * Sets text
  98.  */
  99. virtual void setText(const std::string& str);
  100. /**
  101.  * Returns text
  102.  */
  103. virtual std::string getText() const { return mText; }
  104. /**
  105.  * Sets text
  106.  */
  107. /*virtual*/ void setValue(const LLSD& value);
  108. /**
  109.  * Returns text
  110.  */
  111. /*virtual*/ LLSD getValue() const { return mText; }
  112. /**
  113.  * Collapses text box on focus_lost event
  114.  */
  115. /*virtual*/ void onFocusLost();
  116. /**
  117.  * Collapses text box on top_lost event
  118.  */
  119. /*virtual*/ void onTopLost();
  120. /**
  121.  * Draws text box, collapses text box if its expanded and its parent's position changed
  122.  */
  123. /*virtual*/ void draw();
  124. protected:
  125. LLExpandableTextBox(const Params& p);
  126. friend class LLUICtrlFactory;
  127. /**
  128.  * Expands text box.
  129.  * A scroll bar will appear if expanded height is greater than max_height
  130.  */
  131. virtual void expandTextBox();
  132. /**
  133.  * Collapses text box.
  134.  */
  135. virtual void collapseTextBox();
  136. /**
  137.  * Collapses text box if it is expanded and its parent's position changed
  138.  */
  139. virtual void collapseIfPosChanged();
  140. /**
  141.  * Updates text box rect to avoid horizontal scroll bar
  142.  */
  143. virtual void updateTextBoxRect();
  144. /**
  145.  * User clicked on "More" link - expand text box
  146.  */
  147. virtual void onExpandClicked();
  148. /**
  149.  * Saves collapsed text box's states(rect, parent rect...)
  150.  */
  151. virtual void saveCollapsedState();
  152. /**
  153.  * Recalculate text delta considering min_height and window rect.
  154.  */
  155. virtual S32 recalculateTextDelta(S32 text_delta);
  156. protected:
  157. std::string mText;
  158. LLTextBoxEx* mTextBox;
  159. LLScrollContainer* mScroll;
  160. S32 mMaxHeight;
  161. LLRect mCollapsedRect;
  162. bool mExpanded;
  163. LLRect mParentRect;
  164. bool mBGVisible;
  165. bool mExpandedBGVisible;
  166. LLUIColor mBGColor;
  167. LLUIColor mExpandedBGColor;
  168. };
  169. #endif //LL_LLEXPANDABLETEXTBOX_H