godot/doc/classes/ColorPickerButton.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ColorPickerButton" inherits="Button" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A button that brings up a [ColorPicker] when pressed.
	</brief_description>
	<description>
		Encapsulates a [ColorPicker], making it accessible by pressing a button. Pressing the button will toggle the [ColorPicker]'s visibility.
		See also [BaseButton] which contains common properties and methods associated with this node.
		[b]Note:[/b] By default, the button may not be wide enough for the color preview swatch to be visible. Make sure to set [member Control.custom_minimum_size] to a big enough value to give the button enough space.
	</description>
	<tutorials>
		<link title="2D GD Paint Demo">https://godotengine.org/asset-library/asset/2768</link>
		<link title="GUI Drag And Drop Demo">https://godotengine.org/asset-library/asset/2767</link>
	</tutorials>
	<methods>
		<method name="get_picker">
			<return type="ColorPicker" />
			<description>
				Returns the [ColorPicker] that this node toggles.
				[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.
			</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.
				[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property.
			</description>
		</method>
	</methods>
	<members>
		<member name="color" type="Color" setter="set_pick_color" getter="get_pick_color" default="Color(0, 0, 0, 1)" keywords="colour">
			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" overrides="BaseButton" default="true" />
	</members>
	<signals>
		<signal name="color_changed">
			<param 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_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-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 16:08:05 +08:00			`<class name="ColorPickerButton" inherits="Button" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
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-13 04:42:36 +08:00			`<brief_description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 22:26:09 +08:00			`A button that brings up a [ColorPicker] when 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-13 04:42:36 +08:00			`</brief_description>`
			`<description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 22:26:09 +08:00			`Encapsulates a [ColorPicker], making it accessible by pressing a button. Pressing the button will toggle the [ColorPicker]'s 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-24 05:34:28 +08:00			`See also [BaseButton] which contains common properties and methods associated with this node.`
enhancement: rename exposed property Control::minimum_size to Control::custom_minimum_size 2022-04-06 00:48:21 +08:00			`[b]Note:[/b] By default, the button may not be wide enough for the color preview swatch to be visible. Make sure to set [member Control.custom_minimum_size] to a big enough value to give the button enough space.`
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-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
Update links to outdated asset library demos Update links to outdated asset library demos Co-authored-by: Max Hilbrunner <m.hilbrunner@gmail.com> 2024-03-25 09:20:59 +08:00			`<link title="2D GD Paint Demo">https://godotengine.org/asset-library/asset/2768</link>`
			`<link title="GUI Drag And Drop Demo">https://godotengine.org/asset-library/asset/2767</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-13 04:42:36 +08:00			`</tutorials>`
			`<methods>`
Sync classref with current source Also fix binding of Basis.slerp 2018-05-28 20:53:15 +08: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 21:28:05 +08: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-13 04:42:36 +08:00			`<description>`
[DOCS] Updates to assorted class descriptions. 2018-08-18 05:55:19 +08:00			`Returns the [ColorPicker] that this node toggles.`
Add warnings to methods that give access to internal nodes 2021-10-11 03:28:56 +08:00			`[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.`
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-13 04:42:36 +08:00			`</description>`
			`</method>`
doc: Sync classref with current source Fix various missing arguments in bindings. 2018-07-26 17:56:21 +08: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 21:28:05 +08: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-02 04:58:53 +08:00			`<description>`
[DOCS] Updates to assorted class descriptions. 2018-08-18 05:55:19 +08: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.`
Add warnings to methods that give access to internal nodes 2021-10-11 03:28:56 +08:00			`[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property.`
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-02 04:58:53 +08: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-13 04:42:36 +08:00			`</methods>`
			`<members>`
Add keywords to improve search in the class reference 2024-02-22 01:51:08 +08:00			`<member name="color" type="Color" setter="set_pick_color" getter="get_pick_color" default="Color(0, 0, 0, 1)" keywords="colour">`
[DOCS] ColorPickerButton member/method descs 2017-12-05 02:57:59 +08: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-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08: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 21:24:23 +08: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-13 04:42:36 +08:00			`</member>`
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com> 2021-12-03 03:38:49 +08:00			`<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" overrides="BaseButton" 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-13 04:42:36 +08:00			`</members>`
			`<signals>`
			`<signal name="color_changed">`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param 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-13 04:42:36 +08:00			`<description>`
[DOCS] ColorPickerButton member/method descs 2017-12-05 02:57:59 +08: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-13 04:42:36 +08:00			`</description>`
			`</signal>`
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values. 2019-09-24 17:44:48 +08:00			`<signal name="picker_created">`
			`<description>`
Complete documentation of some more classes 2020-01-14 06:08:42 +08: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 17:44:48 +08:00			`</description>`
			`</signal>`
Sync classref with current source 2018-05-12 15:38:00 +08:00			`<signal name="popup_closed">`
			`<description>`
Complete documentation of some more classes 2020-01-14 06:08:42 +08:00			`Emitted when the [ColorPicker] is closed.`
Sync classref with current source 2018-05-12 15:38:00 +08: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-13 04:42:36 +08:00			`</signals>`
			`<theme_items>`
Sort and group theme properties in docs, improve formatting for theme and enums 2021-12-02 02:02:20 +08:00			`<theme_item name="bg" data_type="icon" type="Texture2D">`
			`The background of the color preview rect on the button.`
			`</theme_item>`
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-13 04:42:36 +08:00			`</theme_items>`
			`</class>`