ilikecats/stk-code_catmod
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More work on docs...

Browse Source 
git-svn-id: svn+ssh://svn.code.sf.net/p/supertuxkart/code/main/trunk@8310 178a84e3-b1eb-0310-8ba1-8eac791a3b58
This commit is contained in:
auria 2011-04-12 20:39:57 +00:00
parent 2c2ea81e93
commit 0ce0edf779
2 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/guiengine/widget.hpp
View File

@ -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<Property, std::string> 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<Property, std::string> m_properties;
/**
* Sets the text of a widget from a wchar_t.
* Handy for many constant strings used in stk.

10
src/guiengine/widgets/ribbon_widget.hpp
View File

@ -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 */