mail[Wesnoth-commits] r33416 - in /trunk/src/gui/widgets: canvas.cpp settings.cpp window_builder.cpp


Others Months | Index by Date | Thread Index
>>   [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Header


Content

Posted by koraq on March 08, 2009 - 12:33:
Author: mordante
Date: Sun Mar  8 12:33:10 2009
New Revision: 33416

URL: http://svn.gna.org/viewcvs/wesnoth?rev=33416&view=rev
Log:
Clean up the variables page and add a grid type.

Modified:
    trunk/src/gui/widgets/canvas.cpp
    trunk/src/gui/widgets/settings.cpp
    trunk/src/gui/widgets/window_builder.cpp

Modified: trunk/src/gui/widgets/canvas.cpp
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/src/gui/widgets/canvas.cpp?rev=33416&r1=33415&r2=33416&view=diff
==============================================================================
--- trunk/src/gui/widgets/canvas.cpp (original)
+++ trunk/src/gui/widgets/canvas.cpp Sun Mar  8 12:33:10 2009
@@ -178,8 +178,12 @@
  *
  * = Variables =
  *
- * In various parts of the GUI engine the following table contains all valid
- * variable types. Note this page is automatically generated.
+ * In various parts of the GUI there are several variables types in use. This
+ * page describes them. 
+ *
+ * == Simple types ==
+ *
+ * The simple types are types which have one value or a short list of 
options.
  *
  * @start_table = variable_types
  *     unsigned                        Unsigned number (positive whole 
numbers
@@ -218,10 +222,6 @@
  *                                     list. If empty we default to the 
normal
  *                                     style.
  *
- *     section                         A section is a generic variable for a
- *                                     WML section. The description should
- *                                     explain the exact type.
- *
  *     v_align                         Vertical alignment; how an item is
  *                                     aligned vertically in the available
  *                                     space. Possible values:
@@ -259,6 +259,21 @@
  *                                     @* auto   Shows the scrollbar when
  *                                     needed. The widget will reserve space 
for
  *                                     the scrollbar, but only show when 
needed.
+ * @end_table
+ *
+ * == Section types ==
+ *
+ * For more complex parts, there are sections. Sections contain of several
+ * lines of WML and can have sub sections. For example a grid has sub 
sections
+ * which contain various widgets. Here's the list of sections.
+ *
+ * @start_table = variable_types
+ *     section                         A generic section. The documentation
+ *                                     about the section should describe the
+ *                                     section in further detail.
+ *
+ *     grid                            A grid contains serveral widgets. 
(TODO
+ *                                     add link to generic grid page.)
  * @end_table
  */
 

Modified: trunk/src/gui/widgets/settings.cpp
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/src/gui/widgets/settings.cpp?rev=33416&r1=33415&r2=33416&view=diff
==============================================================================
--- trunk/src/gui/widgets/settings.cpp (original)
+++ trunk/src/gui/widgets/settings.cpp Sun Mar  8 12:33:10 2009
@@ -865,7 +865,7 @@
  * expected to become required).
  *
  * @start_table = config
- *     grid (section)                  A grid containing the widgets for main
+ *     grid (grid)                     A grid containing the widgets for main
  *                                     widget.
  * @end_table
  *

Modified: trunk/src/gui/widgets/window_builder.cpp
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/src/gui/widgets/window_builder.cpp?rev=33416&r1=33415&r2=33416&view=diff
==============================================================================
--- trunk/src/gui/widgets/window_builder.cpp (original)
+++ trunk/src/gui/widgets/window_builder.cpp Sun Mar  8 12:33:10 2009
@@ -401,8 +401,7 @@
  *                                   Definition of the window which we want 
to
  *                                   show.
  *
- *     grid (section)                The grid with the widgets to show. FIXME
- *                                   the grid needs its own documentation 
page.
+ *     grid (grid)                   The grid with the widgets to show.
  * @end_table
  *
  * The size variables are copied to the window and will be determined 
runtime.
@@ -755,10 +754,10 @@
  *                                     Determines whether or not to show the
  *                                     scrollbar.
  *
- *     header (section = [])           Defines the grid for the optional
+ *     header (grid = [])              Defines the grid for the optional
  *                                     header. (This grid will automatically
  *                                     get the id _header_grid.)
- *     footer (section = [])           Defines the grid for the optional
+ *     footer (grid = [])              Defines the grid for the optional
  *                                     footer. (This grid will automatically
  *                                     get the id _footer_grid.)
  *
@@ -936,7 +935,7 @@
  * invisible container to just hold the items.
  *
  * @start_table = config
- *     grid (section)                  Defines the grid with the widgets to
+ *     grid (grid)                     Defines the grid with the widgets to
  *                                     place on the panel.
  * @end_table
  *
@@ -1141,7 +1140,7 @@
  * its own grid.
  *
  * @start_table = config
- *     grid (section)                  Defines the grid with the widgets to
+ *     grid (grid)                     Defines the grid with the widgets to
  *                                     place on the panel.
  *     return_value_id (string = "")   The return value id, see
  *                                     [[GUIToolkitWML#Button]] for more 
info.




Related Messages


Powered by MHonArc, Updated Sun Mar 08 12:40:29 2009