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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llfloaterreg.h
  3.  * @brief LLFloaterReg Floater Registration Class
  4.  *
  5.  * $LicenseInfo:firstyear=2002&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2002-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 LLFLOATERREG_H
  33. #define LLFLOATERREG_H
  34. /// llcommon
  35. #include "llboost.h"
  36. #include "llrect.h"
  37. #include "llstl.h"
  38. #include "llsd.h"
  39. /// llui
  40. #include "lluictrl.h"
  41. #include <boost/function.hpp>
  42. //*******************************************************
  43. //
  44. // Floater Class Registry
  45. //
  46. class LLFloater;
  47. typedef boost::function<LLFloater* (const LLSD& key)> LLFloaterBuildFunc;
  48. class LLFloaterReg
  49. {
  50. public:
  51. // We use a list of LLFloater's instead of a set for two reasons:
  52. // 1) With a list we have a predictable ordering, useful for finding the last opened floater of a given type.
  53. // 2) We can change the key of a floater without altering the list.
  54. typedef std::list<LLFloater*> instance_list_t;
  55. typedef const instance_list_t const_instance_list_t;
  56. typedef std::map<std::string, instance_list_t> instance_map_t;
  57. struct BuildData
  58. {
  59. LLFloaterBuildFunc mFunc;
  60. std::string mFile;
  61. };
  62. typedef std::map<std::string, BuildData> build_map_t;
  63. private:
  64. friend class LLFloaterRegListener;
  65. static instance_list_t sNullInstanceList;
  66. static instance_map_t sInstanceMap;
  67. static build_map_t sBuildMap;
  68. static std::map<std::string,std::string> sGroupMap;
  69. static bool sBlockShowFloaters;
  70. public:
  71. // Registration
  72. // usage: LLFloaterClassRegistry::add("foo", (LLFloaterBuildFunc)&LLFloaterClassRegistry::build<LLFloaterFoo>);
  73. template <class T>
  74. static LLFloater* build(const LLSD& key)
  75. {
  76. T* floater = new T(key);
  77. return floater;
  78. }
  79. static void add(const std::string& name, const std::string& file, const LLFloaterBuildFunc& func,
  80. const std::string& groupname = LLStringUtil::null);
  81. // Helpers
  82. static LLRect getFloaterRect(const std::string& name);
  83. // Find / get (create) / remove / destroy
  84. static LLFloater* findInstance(const std::string& name, const LLSD& key = LLSD());
  85. static LLFloater* getInstance(const std::string& name, const LLSD& key = LLSD());
  86. static LLFloater* removeInstance(const std::string& name, const LLSD& key = LLSD());
  87. static bool destroyInstance(const std::string& name, const LLSD& key = LLSD());
  88. // Iterators
  89. static const_instance_list_t& getFloaterList(const std::string& name);
  90. // Visibility Management
  91. // return NULL if instance not found or can't create instance (no builder)
  92. static LLFloater* showInstance(const std::string& name, const LLSD& key = LLSD(), BOOL focus = FALSE);
  93. // Close a floater (may destroy or set invisible)
  94. // return false if can't find instance
  95. static bool hideInstance(const std::string& name, const LLSD& key = LLSD());
  96. // return true if instance is visible:
  97. static bool toggleInstance(const std::string& name, const LLSD& key = LLSD());
  98. static bool instanceVisible(const std::string& name, const LLSD& key = LLSD());
  99. static void showInitialVisibleInstances();
  100. static void hideVisibleInstances(const std::set<std::string>& exceptions = std::set<std::string>());
  101. static void restoreVisibleInstances();
  102. // Control Variables
  103. static std::string getRectControlName(const std::string& name);
  104. static std::string declareRectControl(const std::string& name);
  105. static std::string getVisibilityControlName(const std::string& name);
  106. static std::string declareVisibilityControl(const std::string& name);
  107. static std::string declareDockStateControl(const std::string& name);
  108. static std::string getDockStateControlName(const std::string& name);
  109. static void registerControlVariables();
  110. // Callback wrappers
  111. static void initUICtrlToFloaterVisibilityControl(LLUICtrl* ctrl, const LLSD& sdname);
  112. static void showFloaterInstance(const LLSD& sdname);
  113. static void hideFloaterInstance(const LLSD& sdname);
  114. static void toggleFloaterInstance(const LLSD& sdname);
  115. static bool floaterInstanceVisible(const LLSD& sdname);
  116. // Typed find / get / show
  117. template <class T>
  118. static T* findTypedInstance(const std::string& name, const LLSD& key = LLSD())
  119. {
  120. return dynamic_cast<T*>(findInstance(name, key));
  121. }
  122. template <class T>
  123. static T* getTypedInstance(const std::string& name, const LLSD& key = LLSD())
  124. {
  125. return dynamic_cast<T*>(getInstance(name, key));
  126. }
  127. template <class T>
  128. static T* showTypedInstance(const std::string& name, const LLSD& key = LLSD(), BOOL focus = FALSE)
  129. {
  130. return dynamic_cast<T*>(showInstance(name, key, focus));
  131. }
  132. static void blockShowFloaters(bool value) { sBlockShowFloaters = value;}
  133. };
  134. #endif