From 0ce0edf7790f1bc1b7d0a009fee09a9001852a39 Mon Sep 17 00:00:00 2001 From: auria Date: Tue, 12 Apr 2011 20:39:57 +0000 Subject: [PATCH] More work on docs... git-svn-id: svn+ssh://svn.code.sf.net/p/supertuxkart/code/main/trunk@8310 178a84e3-b1eb-0310-8ba1-8eac791a3b58 --- src/guiengine/widget.hpp | 20 ++++++++++---------- src/guiengine/widgets/ribbon_widget.hpp | 10 +++++----- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/guiengine/widget.hpp b/src/guiengine/widget.hpp index a50983ac4..3fe3b2d51 100644 --- a/src/guiengine/widget.hpp +++ b/src/guiengine/widget.hpp @@ -279,6 +279,15 @@ namespace GUIEngine 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 m_properties; + Widget(WidgetType type, bool reserve_id = false); virtual ~Widget(); @@ -382,21 +391,12 @@ namespace GUIEngine /** * \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 m_properties; - /** * Sets the text of a widget from a wchar_t. * Handy for many constant strings used in stk. diff --git a/src/guiengine/widgets/ribbon_widget.hpp b/src/guiengine/widgets/ribbon_widget.hpp index 2adb1bdaa..b0b00c436 100644 --- a/src/guiengine/widgets/ribbon_widget.hpp +++ b/src/guiengine/widgets/ribbon_widget.hpp @@ -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 @@ namespace GUIEngine * 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 */