Changeset 7645 for code/branches/releasetodo/src/libraries/core/GUIManager.cc

Timestamp:

Nov 13, 2010, 9:10:57 PM (13 years ago)

Author:

dafrick

Message:

Small adjustments.

File:

• code/branches/releasetodo/src/libraries/core/GUIManager.cc (modified) (4 diffs)

code/branches/releasetodo/src/libraries/core/GUIManager.cc

@@ -438 +438 @@
     }
 
+    /**
+    @brief
+        Subscribe the input function to the input event for the input window.
+        This is a helper to be used in lua, because subscribeScriptedEvent() doesn't work in lua.
+    @param window
+        The window for which the event is subscribed.
+    @param event
+        The type of event to which we subscribe.
+    @param function
+        The function that is called when the event occurs.
+    */
     void GUIManager::subscribeEventHelper(CEGUI::Window* window, const std::string& event, const std::string& function)
     {
@@ -443 +454 @@
     }
 
+    /**
+    @brief
+        Set the input tooltip text for the input ListboxItem.
+    @param item
+        The ListboxItem for which the tooltip should be set.
+    @param tooltip
+        The tooltip text that should be set.
+    */
     void GUIManager::setTooltipTextHelper(CEGUI::ListboxItem* item, const std::string& tooltip)
     {
@@ -448 +467 @@
     }
 
+    /**
+    @brief
+        Set whether the tooltips for the input Listbox are enabled.
+    @param listbox
+        The Listbox for which to enable (or disable) tooltips.
+    @param enabled
+        Whether to enable or disabel the tooltips.
+    */
     void GUIManager::setItemTooltipsEnabledHelper(CEGUI::Listbox* listbox, bool enabled)
     {
@@ -453 +480 @@
     }
 
-    
 }