LuaAPI/gui/widget - Revision history

Celtic Minstrel: /* clear_items */ Fix name

2026-02-16T03:45:46Z

‎clear_items: Fix name

White haired uncle: Add clear()

2024-10-21T21:04:55Z

Add clear()

White haired uncle: removed reference to negative index to add_item_of_type (has been removed, never worked anyway)

2024-09-21T17:59:12Z

removed reference to negative index to add_item_of_type (has been removed, never worked anyway)

White haired uncle: removed reference to negative index to add_item (has been removed, never worked anyway)

2024-09-21T17:58:40Z

removed reference to negative index to add_item (has been removed, never worked anyway)

Soliton at 12:07, 5 August 2024

2024-08-05T12:07:40Z

Pentarctagon: /* set_canvas */

2024-04-29T17:41:59Z

‎set_canvas

Pentarctagon: /* set_canvas */

2024-04-29T17:39:41Z

‎set_canvas

Pentarctagon at 17:30, 29 April 2024

2024-04-29T17:30:10Z

Celtic Minstrel: /* find */ Bit more info

2024-04-29T13:32:30Z

‎find: Bit more info

Celtic Minstrel: /* remove_items_at */ Fix missing argument

2024-02-07T18:56:59Z

‎remove_items_at: Fix missing argument

@@ Line 57: / Line 57: @@
 Removes one or more elements of a container type widget (like treeviews), starting at the given index. If 0 is passed as the count, all elements from that point to the end are removed. Otherwise, the specified number of elements are removed.
-=== clear ===
+=== clear_items ===
 {{DevFeature1.19|5}}
-* '''gui.widget.clear'''(''widget'')
+* '''gui.widget.clear_items'''(''widget'')
-* ''widget'':'''clear'''()
+* ''widget'':'''clear_items'''()
 Removes all elements of a container type widget.
 === find ===

← Older revision		Revision as of 21:04, 21 October 2024
Line 56:		Line 56:

	Removes one or more elements of a container type widget (like treeviews), starting at the given index. If 0 is passed as the count, all elements from that point to the end are removed. Otherwise, the specified number of elements are removed.		Removes one or more elements of a container type widget (like treeviews), starting at the given index. If 0 is passed as the count, all elements from that point to the end are removed. Otherwise, the specified number of elements are removed.
		+
		+	=== clear ===
		+	{{DevFeature1.19\|5}}
		+
		+	* '''gui.widget.clear'''(''widget'')
		+	* ''widget'':'''clear'''()
		+
		+	Removes all elements of a container type widget.

	=== find ===		=== find ===

@@ Line 48: / Line 48: @@
 * ''widget'':'''add_item_of_type'''(''category'', [''position'']) &rarr; ''the new item'', ''position''
-Add an item to a widget which is a heterogeneous container of different types of widgets, in particular multi_pages and treeviews. You can pass a negative position to count from the end of the container, but the returned position is always positive.
+Add an item to a widget which is a heterogeneous container of different types of widgets, in particular multi_pages and treeviews.
 === remove_items_at ===

@@ Line 41: / Line 41: @@
 * ''widget'':'''add_item'''([''position'']) &rarr; ''the new item'', ''position''
-Add an item to a container widget, for example a listbox. Returns the created item as a [[LuaAPI/types/widget|widget userdata]]. You can pass a negative position to count from the end of the container, but the returned position is always positive.
+Add an item to a container widget, for example a listbox. Returns the created item as a [[LuaAPI/types/widget|widget userdata]].
 === add_item_of_type ===

@@ Line 1: / Line 1: @@
-The '''gui.widget''' module contains functions for managing widgets in custom GUI2 dialogs. Since these functions take a widget userdata as the first parameter, they can only be used in the preshow or postshow of a GUI2 dialog (directly or indirectly). However, the table is available at all times, and additional methods can be installed here for unusual needs.
+The '''gui.widget''' module contains functions for managing widgets in custom GUI2 dialogs. Since these functions take a [[LuaAPI/types/widget|widget userdata]] as the first parameter, they can only be used in the preshow or postshow of a GUI2 dialog (directly or indirectly). However, the table is available at all times, and additional methods can be installed here for unusual needs.
 '''Note:''' The '''gui.widget.set_callback''' is a compatibility wrapper and is unsupported. It may be removed without warning. Callbacks should be bound by assigning the appropriate callback key on the widget.
@@ Line 41: / Line 41: @@
 * ''widget'':'''add_item'''([''position'']) &rarr; ''the new item'', ''position''
-Add an item to a container widget, for example a listbox. Returns the created item as a widget userdata. You can pass a negative position to count from the end of the container, but the returned position is always positive.
+Add an item to a container widget, for example a listbox. Returns the created item as a [[LuaAPI/types/widget|widget userdata]]. You can pass a negative position to count from the end of the container, but the returned position is always positive.
 === add_item_of_type ===

@@ Line 21: / Line 21: @@
 * [[GUICanvasWML#Image|Image]]
 * [[GUICanvasWML#Line|Line]]
-* [https://devdocs.wesnoth.org/classgui2_1_1rect__bounded__shape.html#details common attributes of rectangles, round rectangles and text]
+* [[GUICanvasWML#Bounded_Shape|common attributes of rectangles, round rectangles and text]]
 * [[GUICanvasWML#Rectangle|Rectangle]]
 * [[GUICanvasWML#Rounded_Rectangle|Rounded Rectangle]]

@@ Line 18: / Line 18: @@
 Sets the WML passed as the second argument as the canvas content (index given by the first argument) of the widget. The content of the WML table depends on which shape is used:
-* [https://devdocs.wesnoth.org/classgui2_1_1circle__shape.html#details '''circle''']
+* [[GUICanvasWML#Circle|Circle]]
-* [https://devdocs.wesnoth.org/classgui2_1_1image__shape.html#details '''image''']
+* [[GUICanvasWML#Image|Image]]
-* [https://devdocs.wesnoth.org/classgui2_1_1line__shape.html#details '''line''']
+* [[GUICanvasWML#Line|Line]]
 * [https://devdocs.wesnoth.org/classgui2_1_1rect__bounded__shape.html#details common attributes of rectangles, round rectangles and text]
-* [https://devdocs.wesnoth.org/classgui2_1_1rectangle__shape.html#details '''rectangle''']
+* [[GUICanvasWML#Rectangle|Rectangle]]
 * [https://devdocs.wesnoth.org/classgui2_1_1round__rectangle__shape.html#details '''round_rectangle''']
-* [https://devdocs.wesnoth.org/classgui2_1_1text__shape.html#details '''text''']
+* [[GUICanvasWML#Text|Text]]
 <syntaxhighlight lang=lua>

@@ Line 66: / Line 66: @@
 <syntaxhighlight lang=lua>
 dialog:find('unit_list', 2, 'preview_panel')
 </syntaxhighlight>

@@ Line 52: / Line 52: @@
 === remove_items_at ===
-* '''gui.widget.remove_items_at'''(''widget'', ''position'')
+* '''gui.widget.remove_items_at'''(''widget'', ''position'', ''count'')
-* ''widget'':'''remove_items_at'''(''position'')
+* ''widget'':'''remove_items_at'''(''position'', ''count'')
-Removes the widget at the given index of a container type widget (like treeviews).
+Removes one or more elements of a container type widget (like treeviews), starting at the given index. If 0 is passed as the count, all elements from that point to the end are removed. Otherwise, the specified number of elements are removed.
 === find ===