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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llscriptfloater.h
  3.  * @brief LLScriptFloater class definition
  4.  *
  5.  * $LicenseInfo:firstyear=2009&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2009-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_SCRIPTFLOATER_H
  33. #define LL_SCRIPTFLOATER_H
  34. #include "lltransientdockablefloater.h"
  35. class LLToastNotifyPanel;
  36. /**
  37.  * Handles script notifications ("ScriptDialog" and "ScriptDialogGroup")
  38.  * and manages Script Floaters.
  39.  */
  40. class LLScriptFloaterManager : public LLSingleton<LLScriptFloaterManager>
  41. {
  42. // *TODO
  43. // LLScriptFloaterManager and LLScriptFloater will need some refactoring after we 
  44. // know how script notifications should look like.
  45. public:
  46. typedef enum e_object_type
  47. {
  48. OBJ_SCRIPT,
  49. OBJ_GIVE_INVENTORY,
  50. OBJ_LOAD_URL,
  51. OBJ_UNKNOWN
  52. }EObjectType;
  53. /**
  54.  * Handles new notifications.
  55.  * Saves notification and object ids, removes old notification if needed, creates script chiclet
  56.  * Note that one object can spawn one script floater.
  57.  */
  58. void onAddNotification(const LLUUID& notification_id);
  59. /**
  60.  * Handles notification removal.
  61.  * Removes script notification toast, removes script chiclet, closes script floater
  62.  */
  63. void onRemoveNotification(const LLUUID& notification_id);
  64. /**
  65.  * Toggles script floater.
  66.  * Removes "new message" icon from chiclet and removes notification toast.
  67.  */
  68. void toggleScriptFloater(const LLUUID& object_id, bool set_new_message = false);
  69. LLUUID findObjectId(const LLUUID& notification_id);
  70. LLUUID findNotificationId(const LLUUID& object_id);
  71. static EObjectType getObjectType(const LLUUID& notification_id);
  72. static std::string getObjectName(const LLUUID& notification_id);
  73. typedef boost::signals2::signal<void(const LLSD&)> object_signal_t;
  74. boost::signals2::connection addNewObjectCallback(const object_signal_t::slot_type& cb) { return mNewObjectSignal.connect(cb); }
  75. boost::signals2::connection addToggleObjectFloaterCallback(const object_signal_t::slot_type& cb) { return mToggleFloaterSignal.connect(cb); }
  76. struct FloaterPositionInfo
  77. {
  78. LLRect mRect;
  79. bool mDockState;
  80. };
  81. void saveFloaterPosition(const LLUUID& object_id, const FloaterPositionInfo& fpi);
  82. bool getFloaterPosition(const LLUUID& object_id, FloaterPositionInfo& fpi);
  83. protected:
  84. typedef std::map<std::string, EObjectType> object_type_map;
  85. static object_type_map initObjectTypeMap();
  86. // <notification_id, object_id>
  87. typedef std::map<LLUUID, LLUUID> script_notification_map_t;
  88. script_notification_map_t::const_iterator findUsingObjectId(const LLUUID& object_id);
  89. private:
  90. script_notification_map_t mNotifications;
  91. object_signal_t mNewObjectSignal;
  92. object_signal_t mToggleFloaterSignal;
  93. // <object_id, floater position>
  94. typedef std::map<LLUUID, FloaterPositionInfo> floater_position_map_t;
  95. floater_position_map_t mFloaterPositions;
  96. };
  97. /**
  98.  * Floater script forms.
  99.  * LLScriptFloater will create script form based on notification data and 
  100.  * will auto fit the form.
  101.  */
  102. class LLScriptFloater : public LLDockableFloater
  103. {
  104. public:
  105. /**
  106.  * key - UUID of scripted Object
  107.  */
  108. LLScriptFloater(const LLSD& key);
  109. virtual ~LLScriptFloater(){};
  110. /**
  111.  * Toggle existing floater or create and show a new one.
  112.  */
  113. static bool toggle(const LLUUID& object_id);
  114. /**
  115.  * Creates and shows floater
  116.  */
  117. static LLScriptFloater* show(const LLUUID& object_id);
  118. const LLUUID& getNotificationId() { return mNotificationId; }
  119. void setNotificationId(const LLUUID& id);
  120. /**
  121.  * Close notification if script floater is closed.
  122.  */
  123. /*virtual*/ void onClose(bool app_quitting);
  124. /**
  125.  * Hide all notification toasts when we show dockable floater
  126.  */
  127. /*virtual*/ void setDocked(bool docked, bool pop_on_undock = true);
  128. /**
  129.  * Hide all notification toasts when we show dockable floater
  130.  */
  131. /*virtual*/ void setVisible(BOOL visible);
  132. bool getSavePosition() { return mSaveFloaterPosition; }
  133. void setSavePosition(bool save) { mSaveFloaterPosition = save; }
  134. void savePosition();
  135. void restorePosition();
  136. protected:
  137. /**
  138.  * Creates script form, will delete old form if floater is shown for same object.
  139.  */
  140. void createForm(const LLUUID& object_id);
  141. /*virtual*/ void getAllowedRect(LLRect& rect);
  142. /**
  143.  * Hide all notification toasts.
  144.  */
  145. static void hideToastsIfNeeded();
  146. /**
  147.  * Removes chiclets new messages icon
  148.  */
  149. void onMouseDown();
  150. /*virtual*/ void onFocusLost();
  151. /*virtual*/ void onFocusReceived();
  152. void dockToChiclet(bool dock);
  153. private:
  154. LLToastNotifyPanel* mScriptForm;
  155. LLUUID mNotificationId;
  156. LLUUID mObjectId;
  157. bool mSaveFloaterPosition;
  158. };
  159. #endif //LL_SCRIPTFLOATER_H