GUIToolkit - Revision history

Celtic Minstrel: /* Structure of a GUI2 Dialog (C++) */ typo

2025-01-06T01:53:56Z

‎Structure of a GUI2 Dialog (C++): typo

Bssarkar: /* Showing the Dialog */ C++ dialog construction (preliminary)

2025-01-05T14:32:19Z

‎Showing the Dialog: C++ dialog construction (preliminary)

Bssarkar: /* Custom themes */ Add links

2024-09-22T15:05:55Z

‎Custom themes: Add links

Celtic Minstrel: /* Custom themes */ Grammar fix

2024-09-22T07:37:21Z

‎Custom themes: Grammar fix

Bssarkar: /* Custom themes */ Add more info on how to change the tips and settings

2024-09-22T07:30:28Z

‎Custom themes: Add more info on how to change the tips and settings

Bssarkar: /* Custom themes */ update example

2024-09-22T07:21:23Z

‎Custom themes: update example

Bssarkar: /* Custom themes */ update example

2024-09-22T07:17:00Z

‎Custom themes: update example

Bssarkar: /* Custom themes */

2024-09-22T07:15:13Z

‎Custom themes

Bssarkar: /* Custom themes */ Small tutorial on custom theme support.

2024-09-22T07:12:53Z

‎Custom themes: Small tutorial on custom theme support.

Bssarkar: /* Showing the Dialog */

2024-09-22T07:06:06Z

‎Showing the Dialog

@@ Line 150: / Line 150: @@
 followed by any necessary '''#include'''s.
-This class usually has at least overrides the '''pre_show()''' method from the '''modal_dialog''' class. This is the single most important method and usually used for setting up the UI as this method will be called just before showing the dialog. As an example, any signals/event handlers are attached to widgets here. This class also uses the '''REGISTER_DIALOG''' macro to associate this class with its corresponding '''[window]''' in the UI WML file, so
+This class usually at least overrides the '''pre_show()''' method from the '''modal_dialog''' class. This is the single most important method and usually used for setting up the UI as this method will be called just before showing the dialog. As an example, any signals/event handlers are attached to widgets here. This class also uses the '''REGISTER_DIALOG''' macro to associate this class with its corresponding '''[window]''' in the UI WML file, so
 <syntaxhighlight lang='c++'>

@@ Line 135: / Line 135: @@
 == Showing the Dialog ==
 There are two approaches:
-* '''The Internal (C++) approach:''' Needs a dedicated C++ class that extends from '''[https://github.com/wesnoth/wesnoth/blob/master/src/gui/dialogs/modal_dialog.cpp modal_dialog]''' and an associated builder class. An older documentation is available is the tex documents [https://github.com/wesnoth/wesnoth/tree/master/doc/design/gui2 here]. Examples of GUI2 dialogs created this way can be found in the game's source [https://github.com/wesnoth/wesnoth/tree/master/src/gui/dialogs here] and their associated WML files are [https://github.com/wesnoth/wesnoth/tree/master/data/gui/window here].
+* '''The Internal (C++) approach:''' Needs a dedicated C++ class that extends from '''[https://github.com/wesnoth/wesnoth/blob/master/src/gui/dialogs/modal_dialog.cpp modal_dialog]''' and an associated builder class. An older documentation is available as a set of tex documents [https://github.com/wesnoth/wesnoth/tree/master/doc/design/gui2 here]. Examples of GUI2 dialogs created this way can be found in the game's source [https://github.com/wesnoth/wesnoth/tree/master/src/gui/dialogs here] and their associated WML files are [https://github.com/wesnoth/wesnoth/tree/master/data/gui/window here].
 * '''The UMC (WML + Lua) approach:''' The recommended method for UMC content to show their own GUI2 dialogs. Here, you will have to load the corresponding WML file by passing its path (and pre/postshow) functions to the [[LuaAPI/gui#gui.show_dialog|gui.show_dialog]] lua function.
 == Custom themes ==

@@ Line 142: / Line 142: @@
 {{DevFeature1.19|4}}
-Add-ons can also define their own custom gui2 themes by writing their own '''[gui]''' tags. This allows reskinning most of the dialogs and UI seen in Wesnoth. Users will be able to switch between different themes using the '''Preferences > Display > UI Theme''' button, or the Lua '''gui.switch_theme''' function (inside a scenario).
+Add-ons can also define their own custom gui2 themes by writing their own '''[[GUIToolkitWML#GUI|[gui]]]''' tags. This allows reskinning most of the dialogs and UI seen in Wesnoth. Users will be able to switch between different themes using the '''Preferences > Display > UI Theme''' button, or the Lua '''[[LuaAPI/gui#gui.switch_theme|gui.switch_theme]]''' function (inside a scenario).
 To use this functionality:
 # Add a '''gui-theme.cfg''' file in the Add-on root. (This is a special filename, just like ''achievements.cfg'' or ''cores.cfg''. This is the starting point for your custom theme.
@@ Line 148: / Line 148: @@
 # Include any files/folders inside your '''[gui]''' tags, or for small themes, you can put them inside the '''[gui]''' tag in the <code>gui-theme.cfg</code> file instead. Note that you don't need to include the <code>gui/macros</code> folder as it will be included automatically.
 # Inside those folders, put your widget and dialog definitions. Pay notice to `id` keys inside window and widget definitions as these will replace the corresponding definitions from the core default. It is not necessary for a custom theme to provide definitions for all existing windows/dialogs and widgets. Anything not provided by a custom theme will use the corresponding definition from the default theme instead.
-# You can also change any other settings inside the '''[gui]''' tag, such as UI sounds and various UI parameters. Last but not the list, you can replace the tips shown in the titlescreen by replacing the '''{tips.cfg}''' with your own file inclusion. If you want to append your own tips, include your cfg files after/before that line. For syntax of the tips files, see [https://github.com/wesnoth/wesnoth/blob/master/data/tips.cfg here].
+# You can also change any other [[GUIToolkitWML#Subtag_.5Bsettings.5D|settings]] inside the '''[gui]''' tag, such as UI sounds and various UI parameters. Last but not the list, you can replace the tips shown in the titlescreen by replacing the '''{tips.cfg}''' with your own file inclusion. If you want to append your own tips, include your cfg files after/before that line. For syntax of the tips files, see [https://github.com/wesnoth/wesnoth/blob/master/data/tips.cfg here].
 Example from <code>modern.cfg</code>:

@@ Line 142: / Line 142: @@
 {{DevFeature1.19|4}}
-Add-ons can also define their own custom gui2 themes by writing their own '''[gui]''' tags. This allows to reskin most of the dialogs and UI seen in Wesnoth. Users will be able to switch between different themes using the '''Preferences > Display > UI Theme''' button, or the Lua '''gui.switch_theme''' function (inside a scenario).
+Add-ons can also define their own custom gui2 themes by writing their own '''[gui]''' tags. This allows reskinning most of the dialogs and UI seen in Wesnoth. Users will be able to switch between different themes using the '''Preferences > Display > UI Theme''' button, or the Lua '''gui.switch_theme''' function (inside a scenario).
 To use this functionality:
 # Add a '''gui-theme.cfg''' file in the Add-on root. (This is a special filename, just like ''achievements.cfg'' or ''cores.cfg''. This is the starting point for your custom theme.

@@ Line 148: / Line 148: @@
 # Include any files/folders inside your '''[gui]''' tags, or for small themes, you can put them inside the '''[gui]''' tag in the <code>gui-theme.cfg</code> file instead. Note that you don't need to include the <code>gui/macros</code> folder as it will be included automatically.
 # Inside those folders, put your widget and dialog definitions. Pay notice to `id` keys inside window and widget definitions as these will replace the corresponding definitions from the core default. It is not necessary for a custom theme to provide definitions for all existing windows/dialogs and widgets. Anything not provided by a custom theme will use the corresponding definition from the default theme instead.
 Example from <code>modern.cfg</code>:
@@ Line 163: / Line 164: @@
 	[settings]
 		popup_show_delay = 200
 		popup_show_time = 5000
 		help_show_time = 0
 		double_click_time = 500
 		repeat_button_repeat_time = 350
 		sound_button_click = "button.wav"
 		sound_toggle_button_click = "checkbox.wav"
@@ Line 175: / Line 177: @@
 		sound_slider_adjust = "slider.wav"
 		has_helptip_message = _" (Press ‘$hotkey’ for more information)"
 	[/settings]

@@ Line 149: / Line 149: @@
 # Inside those folders, put your widget and dialog definitions. Pay notice to `id` keys inside window and widget definitions as these will replace the corresponding definitions from the core default. It is not necessary for a custom theme to provide definitions for all existing windows/dialogs and widgets. Anything not provided by a custom theme will use the corresponding definition from the default theme instead.
-Example from <code>default.cfg</code>:
+Example from <code>modern.cfg</code>:
 <syntaxhighlight lang=wml>
 #textdomain wesnoth-lib
@@ Line 155: / Line 155: @@
 ### Defines a gui, all widgets and windows used in a certain 'theme'.
 ###
 [gui]
-	id = "default"            # replace with the id for your theme, must be unique
+	id = "modern"
-	description = "Default"   # user visible name shown on the menu
+	description = "Modern"
 	[settings]
@@ Line 178: / Line 180: @@
 	{tips.cfg}
-	{gui/macros/}
+	{gui/themes/modern/widgets}
-	{gui/themes/default/widget/}
+	{gui/themes/modern/dialogs}
 [/gui]
 </syntaxhighlight>

@@ Line 147: / Line 147: @@
 # Write the '''[gui]''' tag inside this file. For the syntax of the '''[gui]''' tag, see [[GUIToolkitWML#GUI|here]]. Examples are the [https://github.com/wesnoth/wesnoth/blob/master/data/gui/themes/default/default.cfg default.cfg] file and the [https://github.com/wesnoth/wesnoth/blob/master/data/gui/themes/modern/modern.cfg modern.cfg] files from the two core themes.
 # Include any files/folders inside your '''[gui]''' tags, or for small themes, you can put them inside the '''[gui]''' tag in the <code>gui-theme.cfg</code> file instead. Note that you don't need to include the <code>gui/macros</code> folder as it will be included automatically.
 Example from <code>default.cfg</code>:
@@ Line 158: / Line 160: @@
 Replace these lines with WML paths to your folders.
 == Links ==

← Older revision		Revision as of 07:06, 22 September 2024
Line 138:		Line 138:

	* '''The UMC (WML + Lua) approach:''' The recommended method for UMC content to show their own GUI2 dialogs. Here, you will have to load the corresponding WML file by passing its path (and pre/postshow) functions to the [[LuaAPI/gui#gui.show_dialog\|gui.show_dialog]] lua function.		* '''The UMC (WML + Lua) approach:''' The recommended method for UMC content to show their own GUI2 dialogs. Here, you will have to load the corresponding WML file by passing its path (and pre/postshow) functions to the [[LuaAPI/gui#gui.show_dialog\|gui.show_dialog]] lua function.
		+
		+	== Custom themes ==
		+	{{DevFeature1.19\|4}}
		+	Add-ons can also define their own custom gui2 themes by writing their own '''[gui]''' tags. This allows to reskin most of the dialogs and UI seen in Wesnoth. Users will be able to switch between different themes using the '''Preferences > Display > UI Theme''' button, or the Lua '''gui.switch_theme''' function (inside a scenario).
		+	To use this functionality:
		+	# Add a '''gui-theme.cfg''' file in the Add-on root. (This is a special filename, just like ''achievements.cfg'' or ''cores.cfg''. This is the starting point for your custom theme.
		+	# Write the '''[gui]''' tag inside this file. For the syntax of the '''[gui]''' tag, see [[GUIToolkitWML#GUI\|here]]. Examples are the [https://github.com/wesnoth/wesnoth/blob/master/data/gui/themes/default/default.cfg default.cfg] file and the [https://github.com/wesnoth/wesnoth/blob/master/data/gui/themes/modern/modern.cfg modern.cfg] files from the two core themes.
		+	# Include any files/folders inside your '''[gui]''' tags, or for small themes, you can put them inside the '''[gui]''' tag in the <code>gui-theme.cfg</code> file instead.
		+	Example from <code>default.cfg</code>:
		+	<syntaxhighlight lang=wml>
		+	# previous part
		+	[/settings]
		+
		+	{tips.cfg}
		+
		+	# {gui/macros/}
		+	{gui/themes/modern/widgets}
		+	{gui/themes/modern/dialogs}
		+
		+	[/gui]
		+	</syntaxhighlight>

	== Links ==		== Links ==