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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llscrollbar.h
  3.  * @brief Scrollbar UI widget
  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_SCROLLBAR_H
  33. #define LL_SCROLLBAR_H
  34. #include "stdtypes.h"
  35. #include "lluictrl.h"
  36. #include "v4color.h"
  37. #include "llbutton.h"
  38. //
  39. // Classes
  40. //
  41. class LLScrollbar
  42. : public LLUICtrl
  43. {
  44. public:
  45. enum ORIENTATION { HORIZONTAL, VERTICAL };
  46. typedef boost::function<void (S32, LLScrollbar*)> callback_t;
  47. struct Params 
  48. : public LLInitParam::Block<Params, LLUICtrl::Params>
  49. {
  50. Mandatory<ORIENTATION> orientation;
  51. Mandatory<S32> doc_size;
  52. Mandatory<S32> doc_pos;
  53. Mandatory<S32> page_size;
  54. Optional<callback_t>  change_callback;
  55. Optional<S32> step_size;
  56. Optional<S32> thickness;
  57. Optional<LLUIImage*> thumb_image_vertical,
  58. thumb_image_horizontal,
  59. track_image_horizontal,
  60. track_image_vertical;
  61. Optional<bool> bg_visible;
  62. Optional<LLUIColor> track_color,
  63. thumb_color,
  64. bg_color;
  65. Optional<LLButton::Params> up_button;
  66. Optional<LLButton::Params> down_button;
  67. Optional<LLButton::Params> left_button;
  68. Optional<LLButton::Params> right_button;
  69. Params();
  70. };
  71. protected:
  72. LLScrollbar (const Params & p);
  73. friend class LLUICtrlFactory;
  74. public:
  75. virtual ~LLScrollbar();
  76. virtual void setValue(const LLSD& value);
  77. // Overrides from LLView
  78. virtual BOOL handleKeyHere(KEY key, MASK mask);
  79. virtual BOOL handleMouseDown(S32 x, S32 y, MASK mask);
  80. virtual BOOL handleMouseUp(S32 x, S32 y, MASK mask);
  81. virtual BOOL handleDoubleClick(S32 x, S32 y, MASK mask);
  82. virtual BOOL handleHover(S32 x, S32 y, MASK mask);
  83. virtual BOOL handleScrollWheel(S32 x, S32 y, S32 clicks);
  84. virtual BOOL handleDragAndDrop(S32 x, S32 y, MASK mask, BOOL drop, 
  85. EDragAndDropType cargo_type, void *cargo_data, EAcceptance *accept, std::string &tooltip_msg);
  86. virtual void reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);
  87. virtual void draw();
  88. // How long the "document" is.
  89. void setDocSize( S32 size );
  90. S32 getDocSize() const { return mDocSize; }
  91. // How many "lines" the "document" has scrolled.
  92. // 0 <= DocPos <= DocSize - DocVisibile
  93. bool setDocPos( S32 pos, BOOL update_thumb = TRUE );
  94. S32 getDocPos() const { return mDocPos; }
  95. BOOL isAtBeginning();
  96. BOOL isAtEnd();
  97. // Setting both at once.
  98. void setDocParams( S32 size, S32 pos );
  99. // How many "lines" of the "document" is can appear on a page.
  100. void setPageSize( S32 page_size );
  101. S32 getPageSize() const { return mPageSize; }
  102. // The farthest the document can be scrolled (top of the last page).
  103. S32 getDocPosMax() const { return llmax( 0, mDocSize - mPageSize); }
  104. void pageUp(S32 overlap);
  105. void pageDown(S32 overlap);
  106. void onLineUpBtnPressed(const LLSD& data);
  107. void onLineDownBtnPressed(const LLSD& data);
  108. private:
  109. void updateThumbRect();
  110. bool changeLine(S32 delta, BOOL update_thumb );
  111. callback_t mChangeCallback;
  112. const ORIENTATION mOrientation;
  113. S32 mDocSize; // Size of the document that the scrollbar is modeling.  Units depend on the user.  0 <= mDocSize.
  114. S32 mDocPos; // Position within the doc that the scrollbar is modeling, in "lines" (user size)
  115. S32 mPageSize; // Maximum number of lines that can be seen at one time.
  116. S32 mStepSize;
  117. BOOL mDocChanged;
  118. LLRect mThumbRect;
  119. S32 mDragStartX;
  120. S32 mDragStartY;
  121. F32 mHoverGlowStrength;
  122. F32 mCurGlowStrength;
  123. LLRect mOrigRect;
  124. S32 mLastDelta;
  125. LLUIColor mTrackColor;
  126. LLUIColor mThumbColor;
  127. LLUIColor mBGColor;
  128. bool mBGVisible;
  129. LLUIImagePtr mThumbImageV;
  130. LLUIImagePtr mThumbImageH;
  131. LLUIImagePtr mTrackImageV;
  132. LLUIImagePtr mTrackImageH;
  133. S32 mThickness;
  134. };
  135. #endif  // LL_SCROLLBAR_H