GUIWidgetDefinitionWML - Revision history

Celtic Minstrel: /* Scrollbar Panel */ Use description from old duplicate section

2024-10-25T13:09:39Z

‎Scrollbar Panel: Use description from old duplicate section

Celtic Minstrel: /* Scrollbar panel */ Delete section

2024-10-25T13:09:01Z

‎Scrollbar panel: Delete section

Soliton: /* Label */ Merge note into description

2024-05-29T09:42:02Z

‎Label: Merge note into description

Celtic Minstrel: /* Window */ Linkify

2024-05-08T03:17:39Z

‎Window: Linkify

Celtic Minstrel: Format all the tables in wikitable style for consistency

2024-05-07T13:37:51Z

Format all the tables in wikitable style for consistency

Show changes

Bssarkar: /* Multimenu */ update entry

2024-05-07T09:59:41Z

‎Multimenu: update entry

Bssarkar: /* Stacked widget */ add tab_container entry

2024-05-07T09:57:50Z

‎Stacked widget: add tab_container entry

Bssarkar: /* Viewport */ add combobox entry

2024-05-07T09:54:11Z

‎Viewport: add combobox entry

Pentarctagon: /* Tree view */

2024-04-29T19:39:02Z

‎Tree view

Pentarctagon: /* Toggle panel */

2024-04-29T19:38:29Z

‎Toggle panel

@@ Line 340: / Line 340: @@
 == Scrollbar Panel ==
-Visible container to hold multiple widgets.
+The definition of a panel with scrollbars. A panel is a container holding
+other elements in its grid. A panel is always enabled and can't be
-This widget can draw items beyond the widgets it holds and in front of them. A panel is always active so these functions return dummy values.
+disabled. Instead it uses the states as layers to draw on.
 The following layers exist:

@@ Line 667: / Line 667: @@
 * state_enabled, the scroll label is enabled.
 * state_disabled, the scroll label is disabled.
 == Slider ==

@@ Line 450: / Line 450: @@
 == Label ==
-A label displays a text, the text can be wrapped but no scrollbars are provided.
+A label displays text that can be wrapped but no scrollbars are provided.
-Although the label itself has no event interaction it still has two states.
+A label has two states because labels are often used as visual indication of the state of the widget it labels.
 The following states exist:

@@ Line 937: / Line 937: @@
 == Window ==
-Base class of top level items, the only item which needs to store the final canvases to draw on. The definition of a window. A window is a kind of panel see the panel for which fields exist
+Base class of top level items, the only item which needs to store the final canvases to draw on. The definition of a window. A window is a kind of panel; see the [[#Panel|panel]] for which fields exist.
 [[Category: WML Reference]]
 [[Category: GUI WML Reference]]

@@ Line 385: / Line 385: @@
 |}
-== Multimenu ==
+== Multimenu Button ==
-A multimenu_button is a styled_widget to choose an element from a list of elements.
+A multimenu button is a widget to choose one or more elements from a list of elements.
-When a multimenu_button has a return value it sets the return value for the window. Normally this closes the window and returns this value to the caller. The return value can either be defined by the user or determined from the id of the multimenu_button. The return value has a higher precedence as the one defined by the id. (Of course it's weird to give a multimenu_button an id and then override its return value.)
+When a multimenu button has a return value it sets the return value for the window. Normally this closes the window and returns this value to the caller. The return value can either be defined by the user or determined from the id of the multimenu button. The return value has a higher precedence as the one defined by the id. (Of course it's weird to give a multimenu button an id and then override its return value.)
-When the multimenu_button doesn't have a standard id, but you still want to use the return value of that id, use return_value_id instead. This has a higher precedence as return_value.
+When the multimenu button doesn't have a standard id, but you still want to use the return value of that id, use return_value_id instead. This has a higher precedence as return_value.
 The following states exist:
-* state_enabled, the multimenu_button is enabled.
+* '''state_enabled''': the multimenu_button is enabled.
-* state_disabled, the multimenu_button is disabled.
+* '''state_disabled''': the multimenu_button is disabled.
-* state_pressed, the left mouse multimenu_button is down.
+* '''state_pressed''': the left mouse multimenu_button is down.
-* state_focussed, the mouse is over the multimenu_button.
+* '''state_focussed''': the mouse is over the multimenu_button.
 == Button ==

← Older revision		Revision as of 09:57, 7 May 2024
Line 757:		Line 757:

	A stacked widget has no states.		A stacked widget has no states.
		+
		+	== Tab Container ==
		+	A tabbed container that holds multiple pages, called tabs. The user can show any of those pages by clicking on a list containing names (optionally images) of the available tabs.
		+
		+	A tab container has no states.

	== Text box ==		== Text box ==

@@ Line 28: / Line 28: @@
 == Viewport ==
 A viewport is an special widget used to view only a part of the widget it 'holds'.
 == Multiline Text ==

@@ Line 836: / Line 836: @@
 * state_enabled, the listbox is enabled.
 * state_disabled, the listbox is disabled.
 == Horizontal scrollbar ==

@@ Line 829: / Line 829: @@
 * state_disabled_selected, the panel is disabled and selected.
 * state_focussed_selected, the mouse is over the panel and selected.
 == Tree view ==