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

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

游戏引擎

开发平台：

C++ Builder

llbutton.h：源码内容
  1. /** 
  2.  * @file llbutton.h
  3.  * @brief Header for buttons
  4.  *
  5.  * $LicenseInfo:firstyear=2001&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2001-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.  */
  33. #ifndef LL_LLBUTTON_H
  34. #define LL_LLBUTTON_H
  36. #include "lluuid.h"
  37. #include "llcontrol.h"
  38. #include "lluictrl.h"
  39. #include "v4color.h"
  40. #include "llframetimer.h"
  41. #include "llfontgl.h"
  42. #include "lluiimage.h"
  43. #include "lluistring.h"
  45. //
  46. // Constants
  47. //
  49. // PLEASE please use these "constants" when building your own buttons.
  50. // They are loaded from settings.xml at run time.
  51. extern S32 LLBUTTON_H_PAD;
  52. extern S32 BTN_HEIGHT_SMALL;
  53. extern S32 BTN_HEIGHT;
  55. //
  56. // Helpful functions
  57. //
  58. S32 round_up(S32 grid, S32 value);
  61. class LLUICtrlFactory;
  63. //
  64. // Classes
  65. //
  67. class LLButton
  68. : public LLUICtrl
  69. {
  70. public:
  71. struct Params 
  72. : public LLInitParam::Block<Params, LLUICtrl::Params>
  73. {
  74. // text label
  75. Optional<std::string> label_selected;
  76. Optional<bool> label_shadow;
  77. Optional<bool> auto_resize;
  78. Optional<bool> use_ellipses;
  80. // images
  81. Optional<LLUIImage*> image_unselected,
  82. image_selected,
  83. image_hover_selected,
  84. image_hover_unselected,
  85. image_disabled_selected,
  86. image_disabled,
  87. image_pressed,
  88. image_pressed_selected,
  89. image_overlay;
  91. Optional<std::string> image_overlay_alignment;
  93. // colors
  94. Optional<LLUIColor> label_color,
  95. label_color_selected,
  96. label_color_disabled,
  97. label_color_disabled_selected,
  98. highlight_color,
  99. image_color,
  100. image_color_disabled,
  101. image_overlay_color,
  102. flash_color;
  104. // layout
  105. Optional<S32> pad_right;
  106. Optional<S32> pad_left;
  107. Optional<S32> pad_bottom; // under text label
  109. //image overlay paddings
  110. Optional<S32> image_top_pad;
  111. Optional<S32> image_bottom_pad;
  113. /**
  114.  * Space between image_overlay and label
  115.  */
  116. Optional<S32> imgoverlay_label_space;
  118. // callbacks
  119. Optional<CommitCallbackParam> click_callback, // alias -> commit_callback
  120. mouse_down_callback,
  121. mouse_up_callback,
  122. mouse_held_callback;
  124. // misc
  125. Optional<bool> is_toggle,
  126. scale_image,
  127. commit_on_return;
  129. Optional<F32> hover_glow_amount;
  130. Optional<TimeIntervalParam> held_down_delay;
  132. Params();
  133. };
  135. protected:
  136. friend class LLUICtrlFactory;
  137. LLButton(const Params&);
  139. public:
  141. ~LLButton();
  142. // For backward compatability only
  143. typedef boost::function<void(void*)> button_callback_t;
  145. void addImageAttributeToXML(LLXMLNodePtr node, const std::string& imageName,
  146. const LLUUID& imageID,const std::string& xmlTagName) const;
  147. virtual BOOL handleUnicodeCharHere(llwchar uni_char);
  148. virtual BOOL handleKeyHere(KEY key, MASK mask);
  149. virtual BOOL handleMouseDown(S32 x, S32 y, MASK mask);
  150. virtual BOOL handleMouseUp(S32 x, S32 y, MASK mask);
  151. virtual BOOL handleHover(S32 x, S32 y, MASK mask);
  152. virtual BOOL handleRightMouseDown(S32 x, S32 y, MASK mask);
  153. virtual BOOL handleRightMouseUp(S32 x, S32 y, MASK mask);
  154. virtual void draw();
  155. /*virtual*/ BOOL postBuild();
  157. virtual void onMouseEnter(S32 x, S32 y, MASK mask);
  158. virtual void onMouseLeave(S32 x, S32 y, MASK mask);
  159. virtual void onMouseCaptureLost();
  161. virtual void onCommit();
  163. void setUnselectedLabelColor( const LLColor4& c ) { mUnselectedLabelColor = c; }
  164. void setSelectedLabelColor( const LLColor4& c ) { mSelectedLabelColor = c; }
  165. void setUseEllipses( BOOL use_ellipses ) { mUseEllipses = use_ellipses; }
  168. boost::signals2::connection setClickedCallback( const commit_signal_t::slot_type& cb ); // mouse down and up within button
  169. boost::signals2::connection setMouseDownCallback( const commit_signal_t::slot_type& cb );
  170. boost::signals2::connection setMouseUpCallback( const commit_signal_t::slot_type& cb ); // mouse up, EVEN IF NOT IN BUTTON
  171. // Passes a 'count' parameter in the commit param payload, i.e. param["count"])
  172. boost::signals2::connection setHeldDownCallback( const commit_signal_t::slot_type& cb ); // Mouse button held down and in button
  175. // *TODO: Deprecate (for backwards compatability only)
  176. boost::signals2::connection setClickedCallback( button_callback_t cb, void* data );
  177. boost::signals2::connection setMouseDownCallback( button_callback_t cb, void* data );
  178. boost::signals2::connection setMouseUpCallback( button_callback_t cb, void* data );
  179. boost::signals2::connection setHeldDownCallback( button_callback_t cb, void* data );
  181. void setHeldDownDelay( F32 seconds, S32 frames = 0) { mHeldDownDelay = seconds; mHeldDownFrameDelay = frames; }
  183. F32 getHeldDownTime() const { return mMouseDownTimer.getElapsedTimeF32(); }
  185. BOOL toggleState();
  186. BOOL getToggleState() const;
  187. void setToggleState(BOOL b);
  189. void setHighlight(bool b);
  190. void setFlashing( BOOL b );
  191. BOOL getFlashing() const { return mFlashing; }
  193. void setHAlign( LLFontGL::HAlign align ) { mHAlign = align; }
  194. LLFontGL::HAlign getHAlign() const { return mHAlign; }
  195. void setLeftHPad( S32 pad ) { mLeftHPad = pad; }
  196. void setRightHPad( S32 pad ) { mRightHPad = pad; }
  198. void  setImageOverlayTopPad( S32 pad ) { mImageOverlayTopPad = pad; }
  199. S32  getImageOverlayTopPad() const { return mImageOverlayTopPad; }
  200. void  setImageOverlayBottomPad( S32 pad ) { mImageOverlayBottomPad = pad; }
  201. S32  getImageOverlayBottomPad() const { return mImageOverlayBottomPad; }
  203. const std::string getLabelUnselected() const { return wstring_to_utf8str(mUnselectedLabel); }
  204. const std::string getLabelSelected() const { return wstring_to_utf8str(mSelectedLabel); }
  206. void setImageColor(const std::string& color_control);
  207. void setImageColor(const LLColor4& c);
  208. /*virtual*/ void setColor(const LLColor4& c);
  210. void setImages(const std::string &image_name, const std::string &selected_name);
  212. void setDisabledImageColor(const LLColor4& c) { mDisabledImageColor = c; }
  214. void setDisabledSelectedLabelColor( const LLColor4& c ) { mDisabledSelectedLabelColor = c; }
  216. void setImageOverlay(const std::string& image_name, LLFontGL::HAlign alignment = LLFontGL::HCENTER, const LLColor4& color = LLColor4::white);
  217. void  setImageOverlay(const LLUUID& image_id, LLFontGL::HAlign alignment = LLFontGL::HCENTER, const LLColor4& color = LLColor4::white);
  218. LLPointer<LLUIImage> getImageOverlay() { return mImageOverlay; }
  220. void            autoResize(); // resize with label of current btn state 
  221. void            resize(LLUIString label); // resize with label input
  222. void setLabel( const LLStringExplicit& label);
  223. virtual BOOL setLabelArg( const std::string& key, const LLStringExplicit& text );
  224. void setLabelUnselected(const LLStringExplicit& label);
  225. void setLabelSelected(const LLStringExplicit& label);
  226. void setDisabledLabelColor( const LLColor4& c ) { mDisabledLabelColor = c; }
  228. void setFont(const LLFontGL *font)
  229. { mGLFont = ( font ? font : LLFontGL::getFontSansSerif()); }
  231. S32 getLastDrawCharsCount() const { return mLastDrawCharsCount; }
  233. void setScaleImage(BOOL scale) { mScaleImage = scale; }
  234. BOOL getScaleImage() const { return mScaleImage; }
  236. void setDropShadowedText(BOOL b) { mDropShadowedText = b; }
  238. void setBorderEnabled(BOOL b) { mBorderEnabled = b; }
  240. void setHoverGlowStrength(F32 strength) { mHoverGlowStrength = strength; }
  242. void setImageUnselected(LLPointer<LLUIImage> image);
  243. void setImageSelected(LLPointer<LLUIImage> image);
  244. void setImageHoverSelected(LLPointer<LLUIImage> image);
  245. void setImageHoverUnselected(LLPointer<LLUIImage> image);
  246. void setImageDisabled(LLPointer<LLUIImage> image);
  247. void setImageDisabledSelected(LLPointer<LLUIImage> image);
  249. void setCommitOnReturn(BOOL commit) { mCommitOnReturn = commit; }
  250. BOOL getCommitOnReturn() const { return mCommitOnReturn; }
  252. static void onHeldDown(void *userdata);  // to be called by gIdleCallbacks
  253. static void toggleFloaterAndSetToggleState(LLUICtrl* ctrl, const LLSD& sdname);
  254. static void setFloaterToggle(LLUICtrl* ctrl, const LLSD& sdname);
  255. static void setDockableFloaterToggle(LLUICtrl* ctrl, const LLSD& sdname);
  256. static void showHelp(LLUICtrl* ctrl, const LLSD& sdname);
  258. void setForcePressedState(bool b) { mForcePressedState = b; }
  260. void  setAutoResize(bool auto_resize) { mAutoResize = auto_resize; }
  262. protected:
  263. LLPointer<LLUIImage> getImageUnselected() const { return mImageUnselected; }
  264. LLPointer<LLUIImage> getImageSelected() const { return mImageSelected; }
  266. LLFrameTimer mMouseDownTimer;
  268. private:
  269. void drawBorder(LLUIImage* imagep, const LLColor4& color, S32 size);
  270. void resetMouseDownTimer();
  272. private:
  273. commit_signal_t*  mMouseDownSignal;
  274. commit_signal_t*  mMouseUpSignal;
  275. commit_signal_t*  mHeldDownSignal;
  277. const LLFontGL* mGLFont;
  279. S32 mMouseDownFrame;
  280. S32  mMouseHeldDownCount;  // Counter for parameter passed to held-down callback
  281. F32 mHeldDownDelay; // seconds, after which held-down callbacks get called
  282. S32 mHeldDownFrameDelay; // frames, after which held-down callbacks get called
  283. S32 mLastDrawCharsCount;
  285. LLPointer<LLUIImage> mImageOverlay;
  286. LLFontGL::HAlign mImageOverlayAlignment;
  287. LLUIColor mImageOverlayColor;
  289. LLPointer<LLUIImage> mImageUnselected;
  290. LLUIString mUnselectedLabel;
  291. LLUIColor mUnselectedLabelColor;
  293. LLPointer<LLUIImage> mImageSelected;
  294. LLUIString mSelectedLabel;
  295. LLUIColor mSelectedLabelColor;
  297. LLPointer<LLUIImage> mImageHoverSelected;
  299. LLPointer<LLUIImage> mImageHoverUnselected;
  301. LLPointer<LLUIImage> mImageDisabled;
  302. LLUIColor mDisabledLabelColor;
  304. LLPointer<LLUIImage> mImageDisabledSelected;
  305. LLUIString mDisabledSelectedLabel;
  306. LLUIColor mDisabledSelectedLabelColor;
  308. LLPointer<LLUIImage> mImagePressed;
  309. LLPointer<LLUIImage> mImagePressedSelected;
  311. LLUIColor mHighlightColor;
  312. LLUIColor mFlashBgColor;
  314. LLUIColor mImageColor;
  315. LLUIColor mDisabledImageColor;
  317. BOOL mIsToggle;
  318. BOOL mScaleImage;
  320. BOOL mDropShadowedText;
  321. BOOL mAutoResize;
  322. BOOL mUseEllipses;
  323. BOOL mBorderEnabled;
  325. BOOL mFlashing;
  327. LLFontGL::HAlign mHAlign;
  328. S32 mLeftHPad;
  329. S32 mRightHPad;
  330. S32 mBottomVPad; // under text label
  332. S32 mImageOverlayTopPad;
  333. S32 mImageOverlayBottomPad;
  335. /*
  336.  * Space between image_overlay and label
  337.  */
  338. S32 mImgOverlayLabelSpace;
  340. F32 mHoverGlowStrength;
  341. F32 mCurGlowStrength;
  343. BOOL mNeedsHighlight;
  344. BOOL mCommitOnReturn;
  345. BOOL mFadeWhenDisabled;
  346. bool mForcePressedState;
  348. LLFrameTimer mFlashingTimer;
  349. };
  351. // Build time optimization, generate once in .cpp file
  352. #ifndef LLBUTTON_CPP
  353. extern template class LLButton* LLView::getChild<class LLButton>(
  354. const std::string& name, BOOL recurse) const;
  355. #endif
  357. #endif  // LL_LLBUTTON_H