godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/ColorPickerButton.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

110 lines
6.1 KiB
XML
Raw Normal View History

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 20:42:36 +00: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 08:08:05 +00: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-12 20:42:36 +00:00
<brief_description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00: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-12 20:42:36 +00:00
</brief_description>
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00: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-23 21:34:28 +00: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-05 16:48:21 +00: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-12 20:42:36 +00:00
</description>
<tutorials>
Link to demos from within the class reference
2020-10-01 08:34:47 +00: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 20:42:36 +00:00
</tutorials>
<methods>
Sync classref with current source Also fix binding of Basis.slerp
2018-05-28 12:53:15 +00: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 13:28:05 +00: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 20:42:36 +00:00
<description>
[DOCS] Updates to assorted class descriptions.
2018-08-17 21:55:19 +00:00
Returns the [ColorPicker] that this node toggles.
Add warnings to methods that give access to internal nodes
2021-10-10 19:28:56 +00: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-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 09:56:21 +00: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 13:28:05 +00: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 20:58:53 +00:00
<description>
[DOCS] Updates to assorted class descriptions.
2018-08-17 21:55:19 +00: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-10 19:28:56 +00: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-01 20:58:53 +00: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 20:42:36 +00:00
</methods>
<members>
Better format arguments in variant parser
2019-09-24 17:45:03 +00: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 18:57:59 +00: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 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 13:24:23 +00: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 20:42:36 +00:00
</member>
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 19:38:49 +00: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-12 20:42:36 +00:00
</members>
<signals>
<signal name="color_changed">
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00: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-12 20:42:36 +00:00
<description>
[DOCS] ColorPickerButton member/method descs
2017-12-04 18:57:59 +00: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 20:42:36 +00:00
</description>
</signal>
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 09:44:48 +00:00
<signal name="picker_created">
<description>
Complete documentation of some more classes
2020-01-13 22:08:42 +00: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 09:44:48 +00:00
</description>
</signal>
Sync classref with current source
2018-05-12 07:38:00 +00:00
<signal name="popup_closed">
<description>
Complete documentation of some more classes
2020-01-13 22:08:42 +00:00
Emitted when the [ColorPicker] is closed.
Sync classref with current source
2018-05-12 07:38:00 +00: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 20:42:36 +00:00
</signals>
<theme_items>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00: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 07:46:01 +00: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 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00: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 07:46:01 +00: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 20:42:36 +00:00
</theme_item>
Add focus font color to Button and derivatives
2021-10-26 14:28:12 +00:00
<theme_item name="font_focus_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
Text [Color] used when the [ColorPickerButton] is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00: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 07:46:01 +00: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 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00: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 21:45:28 +00:00
The tint of text outline of the [ColorPickerButton].
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00: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 07:46:01 +00: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 20:42:36 +00:00
</theme_item>
Further separate icon from text of buttons in both editor and default themes
2023-08-05 04:13:48 +00:00
<theme_item name="h_separation" data_type="constant" type="int" default="4">
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
The horizontal space between [ColorPickerButton]'s icon and text.
</theme_item>
<theme_item name="outline_size" data_type="constant" type="int" default="0">
The size of the text outline.
Document MDSF font outlines may require `msdf_pixel_range` adjustments
2022-12-19 16:15:44 +00:00
[b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
</theme_item>
<theme_item name="font" data_type="font" type="Font">
[Font] of the [ColorPickerButton]'s text.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00: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 11:49:10 +00:00
Font size of the [ColorPickerButton]'s text.
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
<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">
Document that transparent StyleBoxes/textures should be used for UI focus
2021-11-20 16:43:34 +00:00
[StyleBox] used when the [ColorPickerButton] is focused. The [code]focus[/code] [StyleBox] is displayed [i]over[/i] the base [StyleBox], so a partially transparent [StyleBox] should be used to ensure the base [StyleBox] remains visible. A [StyleBox] that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a [StyleBoxEmpty] resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="hover" data_type="style" type="StyleBox">
Completes doc for button classes
2020-02-04 07:46:01 +00: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 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="normal" data_type="style" type="StyleBox">
Completes doc for button classes
2020-02-04 07:46:01 +00: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 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="pressed" data_type="style" type="StyleBox">
Completes doc for button classes
2020-02-04 07:46:01 +00: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 20:42:36 +00:00
</theme_item>
</theme_items>
</class>