From cfccaff6457964db5245ac144e81b581146bfd75 Mon Sep 17 00:00:00 2001 From: frosch Date: Sun, 11 Nov 2012 16:01:34 +0000 Subject: (svn r24696) -Doc: Improve documentation for button widget types. --- src/widget_type.h | 18 +++++++++--------- src/window_gui.h | 2 +- 2 files changed, 10 insertions(+), 10 deletions(-) (limited to 'src') diff --git a/src/widget_type.h b/src/widget_type.h index be29a2a4c..6d267e1b5 100644 --- a/src/widget_type.h +++ b/src/widget_type.h @@ -49,11 +49,11 @@ enum WidgetType { WWT_PANEL, ///< Simple depressed panel WWT_INSET, ///< Pressed (inset) panel, most commonly used as combo box _text_ area - WWT_IMGBTN, ///< Button with image - WWT_IMGBTN_2, ///< Button with diff image when clicked - WWT_ARROWBTN, ///< Button with an arrow - WWT_TEXTBTN, ///< Button with text - WWT_TEXTBTN_2, ///< Button with diff text when clicked + WWT_IMGBTN, ///< (Toggle) Button with image + WWT_IMGBTN_2, ///< (Toggle) Button with diff image when clicked + WWT_ARROWBTN, ///< (Toggle) Button with an arrow + WWT_TEXTBTN, ///< (Toggle) Button with text + WWT_TEXTBTN_2, ///< (Toggle) Button with diff text when clicked WWT_LABEL, ///< Centered label WWT_TEXT, ///< Pure simple text WWT_MATRIX, ///< Grid of rows and columns. @see MatrixWidgetValues @@ -98,10 +98,10 @@ enum WidgetType { WWB_PUSHBUTTON = 1 << 7, - WWT_PUSHBTN = WWT_PANEL | WWB_PUSHBUTTON, - WWT_PUSHTXTBTN = WWT_TEXTBTN | WWB_PUSHBUTTON, - WWT_PUSHIMGBTN = WWT_IMGBTN | WWB_PUSHBUTTON, - WWT_PUSHARROWBTN = WWT_ARROWBTN | WWB_PUSHBUTTON, + WWT_PUSHBTN = WWT_PANEL | WWB_PUSHBUTTON, ///< Normal push-button (no toggle button) with custom drawing + WWT_PUSHTXTBTN = WWT_TEXTBTN | WWB_PUSHBUTTON, ///< Normal push-button (no toggle button) with text caption + WWT_PUSHIMGBTN = WWT_IMGBTN | WWB_PUSHBUTTON, ///< Normal push-button (no toggle button) with image caption + WWT_PUSHARROWBTN = WWT_ARROWBTN | WWB_PUSHBUTTON, ///< Normal push-button (no toggle button) with arrow caption NWID_PUSHBUTTON_DROPDOWN = NWID_BUTTON_DROPDOWN | WWB_PUSHBUTTON, }; diff --git a/src/window_gui.h b/src/window_gui.h index bd1448ee9..1f1b87a3f 100644 --- a/src/window_gui.h +++ b/src/window_gui.h @@ -175,7 +175,7 @@ struct WindowDesc : ZeroedMemoryAllocator { int16 default_height; ///< Prefered initial height of the window. WindowClass cls; ///< Class of the window, @see WindowClass. WindowClass parent_cls; ///< Class of the parent window. @see WindowClass - uint32 flags; ///< Flags. @see WindowDefaultFlags + uint32 flags; ///< Flags. @see WindowDefaultFlag const NWidgetPart *nwid_parts; ///< Nested widget parts describing the window. int16 nwid_length; ///< Length of the #nwid_parts array. }; -- cgit v1.2.3-70-g09d2