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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file lldockablefloater.h
  3.  * @brief Creates a panel of a specific kind for a toast.
  4.  *
  5.  * $LicenseInfo:firstyear=2003&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2003-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_DOCKABLEFLOATER_H
  33. #define LL_DOCKABLEFLOATER_H
  34. #include "llerror.h"
  35. #include "llfloater.h"
  36. #include "lldockcontrol.h"
  37. /**
  38.  * Represents floater that can dock.
  39.  * In case impossibility deriving from LLDockableFloater use LLDockControl.
  40.  */
  41. class LLDockableFloater : public LLFloater
  42. {
  43. static const U32 UNDOCK_LEAP_HEIGHT = 12;
  44. static void init(LLDockableFloater* thiz);
  45. public:
  46. LOG_CLASS(LLDockableFloater);
  47. LLDockableFloater(LLDockControl* dockControl, const LLSD& key,
  48. const Params& params = getDefaultParams());
  49. /**
  50.  * Constructor.
  51.  * @param dockControl a pointer to the doc control instance
  52.  * @param uniqueDocking - a flag defines is docking should work as tab(at one
  53.  * moment only one docked floater can be shown), also this flag defines is dock
  54.  * tongue should be used.
  55.  * @params key a floater key.
  56.    * @params params a floater parameters
  57.  */
  58. LLDockableFloater(LLDockControl* dockControl, bool uniqueDocking,
  59. const LLSD& key, const Params& params = getDefaultParams());
  60. /**
  61.  * Constructor.
  62.  * @param dockControl a pointer to the doc control instance
  63.  * @param uniqueDocking - a flag defines is docking should work as tab(at one
  64.  * moment only one docked floater can be shown).
  65.  * @praram useTongue - a flag defines is dock tongue should be used.
  66.  * @params key a floater key.
  67.    * @params params a floater parameters
  68.  */
  69. LLDockableFloater(LLDockControl* dockControl, bool uniqueDocking,
  70. bool useTongue, const LLSD& key,
  71. const Params& params = getDefaultParams());
  72. virtual ~LLDockableFloater();
  73. static LLHandle<LLFloater> getInstanceHandle() { return sInstanceHandle; }
  74. static void toggleInstance(const LLSD& sdname);
  75. /**
  76.  *  If descendant class overrides postBuild() in order to perform specific
  77.  *  construction then it must still invoke its superclass' implementation.
  78.  */
  79. /* virtula */BOOL postBuild();
  80. /* virtual */void setDocked(bool docked, bool pop_on_undock = true);
  81. /* virtual */void draw();
  82. /**
  83.  *  If descendant class overrides setVisible() then it must still invoke its
  84.  *  superclass' implementation.
  85.  */
  86. /*virtual*/ void setVisible(BOOL visible);
  87. /**
  88.  *  If descendant class overrides setMinimized() then it must still invoke its
  89.  *  superclass' implementation.
  90.  */
  91. /*virtual*/ void setMinimized(BOOL minimize);
  92. LLView * getDockWidget();
  93. virtual void onDockHidden();
  94. virtual void onDockShown();
  95. LLDockControl* getDockControl();
  96. /**
  97.  * Returns true if screen channel should consider floater's size when drawing toasts.
  98.  *
  99.  * By default returns false.
  100.  */
  101. virtual bool overlapsScreenChannel() { return mOverlapsScreenChannel && getVisible() && isDocked(); }
  102. virtual void setOverlapsScreenChannel(bool overlaps) { mOverlapsScreenChannel = overlaps; }
  103. bool getUniqueDocking() { return mUniqueDocking; }
  104. bool getUseTongue() { return mUseTongue; }
  105. private:
  106. /**
  107.  * Provides unique of dockable floater.
  108.  * If dockable floater already exists it should  be closed.
  109.  */
  110. void resetInstance();
  111. protected:
  112. void setDockControl(LLDockControl* dockControl, bool docked = true);
  113. const LLUIImagePtr& getDockTongue();
  114. private:
  115. std::auto_ptr<LLDockControl> mDockControl;
  116. LLUIImagePtr mDockTongue;
  117. static LLHandle<LLFloater> sInstanceHandle;
  118. /**
  119.  * Provides possibility to define that dockable floaters can be docked
  120.  *  non exclusively.
  121.  */
  122. bool mUniqueDocking;
  123. bool mUseTongue;
  124. bool mOverlapsScreenChannel;
  125. };
  126. #endif /* LL_DOCKABLEFLOATER_H */