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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file lltooltip.h
  3.  * @brief LLToolTipMgr class definition and related classes
  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.  */
  32. #ifndef LL_LLTOOLTIP_H
  33. #define LL_LLTOOLTIP_H
  34. // Library includes
  35. #include "llsingleton.h"
  36. #include "llinitparam.h"
  37. #include "llpanel.h"
  38. #include "llstyle.h"
  39. //
  40. // Classes
  41. //
  42. class LLToolTipView : public LLView
  43. {
  44. public:
  45. struct Params : public LLInitParam::Block<Params, LLView::Params>
  46. {
  47. Params();
  48. };
  49. LLToolTipView(const LLToolTipView::Params&);
  50. /*virtual*/ BOOL handleHover(S32 x, S32 y, MASK mask);
  51. /*virtual*/ BOOL handleMouseDown(S32 x, S32 y, MASK mask);
  52. /*virtual*/ BOOL handleMiddleMouseDown(S32 x, S32 y, MASK mask);
  53. /*virtual*/ BOOL handleRightMouseDown(S32 x, S32 y, MASK mask);
  54. /*virtual*/ BOOL handleScrollWheel( S32 x, S32 y, S32 clicks );
  55. void drawStickyRect();
  56. /*virtual*/ void draw();
  57. };
  58. class LLToolTip : public LLPanel
  59. {
  60. public:
  61. struct StyledText : public LLInitParam::Block<StyledText>
  62. {
  63. Mandatory<std::string> text;
  64. Optional<LLStyle::Params> style;
  65. };
  66. struct Params : public LLInitParam::Block<Params, LLPanel::Params> 
  67. {
  68. typedef boost::function<void(void)> click_callback_t;
  69. Optional<std::string> message;
  70. Multiple<StyledText> styled_message;
  71. Optional<LLCoordGL> pos;
  72. Optional<F32> delay_time,
  73. visible_time_over,  // time for which tooltip is visible while mouse on it
  74. visible_time_near, // time for which tooltip is visible while mouse near it
  75. visible_time_far; // time for which tooltip is visible while mouse moved away
  76. Optional<LLRect> sticky_rect;
  77. Optional<const LLFontGL*> font;
  78. Optional<LLUIImage*> image;
  79. Optional<LLUIColor> text_color;
  80. Optional<bool> time_based_media,
  81. web_based_media,
  82. media_playing;
  83. Optional<click_callback_t> click_callback,
  84. click_playmedia_callback,
  85. click_homepage_callback;
  86. Optional<S32> max_width,
  87. padding;
  88. Optional<bool> wrap;
  89. Params();
  90. };
  91. /*virtual*/ void draw();
  92. /*virtual*/ BOOL handleHover(S32 x, S32 y, MASK mask);
  93. /*virtual*/ void onMouseLeave(S32 x, S32 y, MASK mask);
  94. /*virtual*/ void setVisible(BOOL visible);
  95. bool isFading();
  96. F32 getVisibleTime();
  97. bool hasClickCallback();
  98. LLToolTip(const Params& p);
  99. void initFromParams(const LLToolTip::Params& params);
  100. private:
  101. class LLTextBox* mTextBox;
  102. class LLButton*     mInfoButton;
  103. class LLButton*     mPlayMediaButton;
  104. class LLButton*     mHomePageButton;
  105. LLFrameTimer mFadeTimer;
  106. LLFrameTimer mVisibleTimer;
  107. bool mHasClickCallback;
  108. S32 mPadding; // pixels
  109. };
  110. // used for the inspector tooltips which need different background images etc.
  111. class LLInspector : public LLToolTip
  112. {
  113. public:
  114. struct Params : public LLInitParam::Block<Params, LLToolTip::Params> 
  115. {};
  116. };
  117. class LLToolTipMgr : public LLSingleton<LLToolTipMgr>
  118. {
  119. LOG_CLASS(LLToolTipMgr);
  120. public:
  121. LLToolTipMgr();
  122. void show(const LLToolTip::Params& params);
  123. void show(const std::string& message);
  124. void unblockToolTips();
  125. void blockToolTips();
  126. void hideToolTips();
  127. bool toolTipVisible();
  128. LLRect getToolTipRect();
  129. LLRect getMouseNearRect();
  130. void updateToolTipVisibility();
  131. private:
  132. void createToolTip(const LLToolTip::Params& params);
  133. bool mToolTipsBlocked;
  134. class LLToolTip* mToolTip;
  135. // tooltip creation is deferred until the UI is drawn every frame
  136. // so the last tooltip to be created in a given frame will win
  137. LLToolTip::Params mLastToolTipParams; // description of last tooltip we showed
  138. LLToolTip::Params mNextToolTipParams; // description of next tooltip we want to show
  139. bool mNeedsToolTip; // do we want to show a tooltip
  140. LLRect mMouseNearRect;
  141. };
  142. //
  143. // Globals
  144. //
  145. extern LLToolTipView *gToolTipView;
  146. #endif