[Supertuxkart-commit] SF.net SVN: supertuxkart:[8310] main/trunk/src/guiengine

[<au...@us...>]

Revision: 8310
          http://supertuxkart.svn.sourceforge.net/supertuxkart/?rev=8310&view=rev
Author:   auria
Date:     2011-04-12 20:39:57 +0000 (Tue, 12 Apr 2011)

Log Message:
-----------
More work on docs...

Modified Paths:
--------------
    main/trunk/src/guiengine/widget.hpp
    main/trunk/src/guiengine/widgets/ribbon_widget.hpp

Modified: main/trunk/src/guiengine/widget.hpp
===================================================================
--- main/trunk/src/guiengine/widget.hpp	2011-04-12 20:31:06 UTC (rev 8309)
+++ main/trunk/src/guiengine/widget.hpp	2011-04-12 20:39:57 UTC (rev 8310)
@@ -279,6 +279,15 @@
                it instead of creating a new ID if it is. In practice, it's not widely implemented (FIXME) */
         int m_reserved_id;
         
+        /**
+         * A map that holds values for all specified widget properties (in the XML file)
+         *
+         * \note Changing any of these properties will only take effect the next time
+         *       this widget is add()ed.
+         * \note Not all widgets use all properties, some widgets may ignore some properties.
+         */
+        std::map<Property, std::string> m_properties;
+        
         Widget(WidgetType type, bool reserve_id = false);
         virtual ~Widget();
         
@@ -382,21 +391,12 @@
 
         /**
          * \name Get and set properties
+         * \{
          * Note that many properties are read only by the Widget::add method; so, while
          * it will generally work to set the properties before add() is called, modifying
          * the widget after it was added will require other widget-specific calls.
-         * \{
          */
         
-        /**
-          * A map that holds values for all specified widget properties (in the XML file)
-          *
-          * \note Changing any of these properties will only take effect the next time
-          *       this widget is add()ed.
-          * \note Not all widgets use all properties, some widgets may ignore some properties.
-          */
-        std::map<Property, std::string> m_properties;
-        
         /** 
           * Sets the text of a widget from a wchar_t.
           * Handy for many constant strings used in stk.

Modified: main/trunk/src/guiengine/widgets/ribbon_widget.hpp
===================================================================
--- main/trunk/src/guiengine/widgets/ribbon_widget.hpp	2011-04-12 20:31:06 UTC (rev 8309)
+++ main/trunk/src/guiengine/widgets/ribbon_widget.hpp	2011-04-12 20:39:57 UTC (rev 8310)
@@ -28,12 +28,12 @@
 
 namespace GUIEngine
 {
-
+    /** Types of ribbons */
     enum RibbonType
     {
-        RIBBON_COMBO, /* select one item out of many, like in a combo box */
-        RIBBON_TOOLBAR, /* a row of individual buttons */
-        RIBBON_TABS /* a tab bar */
+        RIBBON_COMBO,   //!< select one item out of many, like in a combo box
+        RIBBON_TOOLBAR, //!< a row of individual buttons
+        RIBBON_TABS     //!< a tab bar
     };
 
     /** \brief A static text/icons/tabs bar widget.
@@ -103,7 +103,7 @@
           * You may call this with the listener parameter set to NULL to remove the listener. */
         void setListener(IRibbonListener* listener) { m_listener = listener; }
         
-        /** Returns the type of this ribbon (see guiengine/engine.hpp for detailed descriptions) */
+        /** Returns the type of this ribbon (see the GUI module overview page for detailed descriptions) */
         RibbonType getRibbonType() const { return m_ribbon_type; }
         
         /** Returns the numerical ID of the selected item within the ribbon */


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.