virtualx-engine/doc/classes/ColorPickerButton.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ColorPickerButton" inherits="Button" version="4.0">
	<brief_description>
		Button that pops out a [ColorPicker].
	</brief_description>
	<description>
		Encapsulates a [ColorPicker] making it accessible by pressing a button. Pressing the button will toggle the [ColorPicker] visibility.
		See also [BaseButton] which contains common properties and methods associated with this node.
	</description>
	<tutorials>
		<link title="GUI Drag And Drop Demo">https://godotengine.org/asset-library/asset/133</link>
		<link title="2D GD Paint Demo">https://godotengine.org/asset-library/asset/517</link>
	</tutorials>
	<methods>
		<method name="get_picker">
			<return type="ColorPicker" />
			<description>
				Returns the [ColorPicker] that this node toggles.
			</description>
		</method>
		<method name="get_popup">
			<return type="PopupPanel" />
			<description>
				Returns the control's [PopupPanel] which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden.
			</description>
		</method>
	</methods>
	<members>
		<member name="color" type="Color" setter="set_pick_color" getter="get_pick_color" default="Color(0, 0, 0, 1)">
			The currently selected color.
		</member>
		<member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha" default="true">
			If [code]true[/code], the alpha channel in the displayed [ColorPicker] will be visible.
		</member>
		<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" override="true" default="true" />
	</members>
	<signals>
		<signal name="color_changed">
			<argument index="0" name="color" type="Color" />
			<description>
				Emitted when the color changes.
			</description>
		</signal>
		<signal name="picker_created">
			<description>
				Emitted when the [ColorPicker] is created (the button is pressed for the first time).
			</description>
		</signal>
		<signal name="popup_closed">
			<description>
				Emitted when the [ColorPicker] is closed.
			</description>
		</signal>
	</signals>
	<theme_items>
		<theme_item name="bg" data_type="icon" type="Texture2D">
			The background of the color preview rect on the button.
		</theme_item>
		<theme_item name="disabled" data_type="style" type="StyleBox">
			[StyleBox] used when the [ColorPickerButton] is disabled.
		</theme_item>
		<theme_item name="focus" data_type="style" type="StyleBox">
			[StyleBox] used when the [ColorPickerButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
		</theme_item>
		<theme_item name="font" data_type="font" type="Font">
			[Font] of the [ColorPickerButton]'s text.
		</theme_item>
		<theme_item name="font_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
			Default text [Color] of the [ColorPickerButton].
		</theme_item>
		<theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.9, 0.9, 0.9, 0.3)">
			Text [Color] used when the [ColorPickerButton] is disabled.
		</theme_item>
		<theme_item name="font_hover_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
			Text [Color] used when the [ColorPickerButton] is being hovered.
		</theme_item>
		<theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
			The tint of text outline of the [ColorPickerButton].
		</theme_item>
		<theme_item name="font_pressed_color" data_type="color" type="Color" default="Color(0.8, 0.8, 0.8, 1)">
			Text [Color] used when the [ColorPickerButton] is being pressed.
		</theme_item>
		<theme_item name="font_size" data_type="font_size" type="int">
			Font size of the [ColorPickerButton]'s text.
		</theme_item>
		<theme_item name="hover" data_type="style" type="StyleBox">
			[StyleBox] used when the [ColorPickerButton] is being hovered.
		</theme_item>
		<theme_item name="hseparation" data_type="constant" type="int" default="2">
			The horizontal space between [ColorPickerButton]'s icon and text.
		</theme_item>
		<theme_item name="normal" data_type="style" type="StyleBox">
			Default [StyleBox] for the [ColorPickerButton].
		</theme_item>
		<theme_item name="outline_size" data_type="constant" type="int" default="0">
			The size of the text outline.
		</theme_item>
		<theme_item name="pressed" data_type="style" type="StyleBox">
			[StyleBox] used when the [ColorPickerButton] is being pressed.
		</theme_item>
	</theme_items>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Update docs to version 4.0 2020-02-01 02:03:48 +01:00			`<class name="ColorPickerButton" inherits="Button" version="4.0">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
Added missing end points for brief descriptions in the docs. 2018-03-31 01:11:14 +02:00			`Button that pops out a [ColorPicker].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
Misc. typos Found via `codespell -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"` 2018-09-13 03:38:39 +02:00			`Encapsulates a [ColorPicker] making it accessible by pressing a button. Pressing the button will toggle the [ColorPicker] visibility.`
Reference the BaseButton class explicitly in button class documentations Users are sometimes confused as to the `pressed` property not being visible in the Button class documentation. This is because `pressed` is defined in BaseButton. 2020-09-23 23:34:28 +02:00			`See also [BaseButton] which contains common properties and methods associated with this node.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
Link to demos from within the class reference 2020-10-01 10:34:47 +02:00			`<link title="GUI Drag And Drop Demo">https://godotengine.org/asset-library/asset/133</link>`
			`<link title="2D GD Paint Demo">https://godotengine.org/asset-library/asset/517</link>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</tutorials>`
			`<methods>`
Sync classref with current source Also fix binding of Basis.slerp 2018-05-28 14:53:15 +02:00			`<method name="get_picker">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 15:28:05 +02:00			`<return type="ColorPicker" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<description>`
[DOCS] Updates to assorted class descriptions. 2018-08-17 23:55:19 +02:00			`Returns the [ColorPicker] that this node toggles.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`</method>`
doc: Sync classref with current source Fix various missing arguments in bindings. 2018-07-26 11:56:21 +02:00			`<method name="get_popup">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 15:28:05 +02:00			`<return type="PopupPanel" />`
Added get_popup() method to ColorPickerButton. This allows to check if the picker is open or not using Popup signals. Ammend: Added docs for the method. 2017-12-01 21:58:53 +01:00			`<description>`
[DOCS] Updates to assorted class descriptions. 2018-08-17 23:55:19 +02:00			`Returns the control's [PopupPanel] which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden.`
Added get_popup() method to ColorPickerButton. This allows to check if the picker is open or not using Popup signals. Ammend: Added docs for the method. 2017-12-01 21:58:53 +01:00			`</description>`
			`</method>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</methods>`
			`<members>`
Better format arguments in variant parser 2019-09-24 19:45:03 +02:00			`<member name="color" type="Color" setter="set_pick_color" getter="get_pick_color" default="Color(0, 0, 0, 1)">`
[DOCS] ColorPickerButton member/method descs 2017-12-04 19:57:59 +01:00			`The currently selected color.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha" default="true">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 15:24:23 +02:00			`If [code]true[/code], the alpha channel in the displayed [ColorPicker] will be visible.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Fix parsing of self-closing XML tags Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`. 2019-09-24 13:34:03 +02:00			`<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" override="true" default="true" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</members>`
			`<signals>`
			`<signal name="color_changed">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 15:28:05 +02:00			`<argument index="0" name="color" type="Color" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<description>`
[DOCS] ColorPickerButton member/method descs 2017-12-04 19:57:59 +01:00			`Emitted when the color changes.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`</signal>`
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values. 2019-09-24 11:44:48 +02:00			`<signal name="picker_created">`
			`<description>`
Complete documentation of some more classes 2020-01-13 23:08:42 +01:00			`Emitted when the [ColorPicker] is created (the button is pressed for the first time).`
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values. 2019-09-24 11:44:48 +02:00			`</description>`
			`</signal>`
Sync classref with current source 2018-05-12 09:38:00 +02:00			`<signal name="popup_closed">`
			`<description>`
Complete documentation of some more classes 2020-01-13 23:08:42 +01:00			`Emitted when the [ColorPicker] is closed.`
Sync classref with current source 2018-05-12 09:38:00 +02:00			`</description>`
			`</signal>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</signals>`
			`<theme_items>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="bg" data_type="icon" type="Texture2D">`
Completes doc for button classes 2020-02-04 08:46:01 +01:00			`The background of the color preview rect on the button.`
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip] 2017-10-11 23:54:43 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="disabled" data_type="style" type="StyleBox">`
Completes doc for button classes 2020-02-04 08:46:01 +01:00			`[StyleBox] used when the [ColorPickerButton] is disabled.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="focus" data_type="style" type="StyleBox">`
Completes doc for button classes 2020-02-04 08:46:01 +01:00			`[StyleBox] used when the [ColorPickerButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="font" data_type="font" type="Font">`
Completes doc for button classes 2020-02-04 08:46:01 +01:00			`[Font] of the [ColorPickerButton]'s text.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="font_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">`
Completes doc for button classes 2020-02-04 08:46:01 +01:00			`Default text [Color] of the [ColorPickerButton].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.9, 0.9, 0.9, 0.3)">`
Completes doc for button classes 2020-02-04 08:46:01 +01:00			`Text [Color] used when the [ColorPickerButton] is disabled.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="font_hover_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">`
Completes doc for button classes 2020-02-04 08:46:01 +01:00			`Text [Color] used when the [ColorPickerButton] is being hovered.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">`
[CTL] Add missing font outline drawing routines and theme constants. 2020-12-25 22:45:28 +01:00			`The tint of text outline of the [ColorPickerButton].`
			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="font_pressed_color" data_type="color" type="Color" default="Color(0.8, 0.8, 0.8, 1)">`
Completes doc for button classes 2020-02-04 08:46:01 +01:00			`Text [Color] used when the [ColorPickerButton] is being pressed.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="font_size" data_type="font_size" type="int">`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`Font size of the [ColorPickerButton]'s text.`
			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="hover" data_type="style" type="StyleBox">`
Completes doc for button classes 2020-02-04 08:46:01 +01:00			`[StyleBox] used when the [ColorPickerButton] is being hovered.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="hseparation" data_type="constant" type="int" default="2">`
Completes doc for button classes 2020-02-04 08:46:01 +01:00			`The horizontal space between [ColorPickerButton]'s icon and text.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="normal" data_type="style" type="StyleBox">`
Completes doc for button classes 2020-02-04 08:46:01 +01:00			`Default [StyleBox] for the [ColorPickerButton].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="outline_size" data_type="constant" type="int" default="0">`
[CTL] Add missing font outline drawing routines and theme constants. 2020-12-25 22:45:28 +01:00			`The size of the text outline.`
			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="pressed" data_type="style" type="StyleBox">`
Completes doc for button classes 2020-02-04 08:46:01 +01:00			`[StyleBox] used when the [ColorPickerButton] is being pressed.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</theme_item>`
			`</theme_items>`
			`</class>`