upstream/wesnoth
1
0
Fork 0
mirror of https://github.com/wesnoth/wesnoth synced 2025-05-05 15:29:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up the variables page and add a grid type.

Browse Source
This commit is contained in:
Mark de Wever 2009-03-08 11:33:10 +00:00
parent 4477dda2c9
commit abe08f2c2a
3 changed files with 27 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/gui/widgets/canvas.cpp
View File

@ -178,8 +178,12 @@ tline::tline(const config& cfg) :
*
* = 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 @@ tline::tline(const config& cfg) :
* 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:
@ -260,6 +260,21 @@ tline::tline(const config& cfg) :
* 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
*/
const std::string& debug = (cfg["debug"]);

2
src/gui/widgets/settings.cpp
View File

@ -865,7 +865,7 @@ tscroll_label_definition::tresolution::tresolution(const config& cfg) :
* 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
*

11
src/gui/widgets/window_builder.cpp
View File

@ -401,8 +401,7 @@ twindow_builder::tresolution::tresolution(const config& cfg) :
* 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 @@ tbuilder_listbox::tbuilder_listbox(const config& cfg) :
* 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 @@ tbuilder_panel::tbuilder_panel(const config& cfg) :
* 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 @@ tbuilder_toggle_panel::tbuilder_toggle_panel(const config& cfg) :
* 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.