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

116 lines
5.0 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" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 22:01:02 +00:00
<class name="ColorPicker" inherits="BoxContainer" version="3.5" 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>
Color picker control.
</brief_description>
<description>
Add usability notes to ColorPicker and ColorPickerButton descriptions Co-authored-by: follower <follower@rancidbacon.com>
2021-09-24 23:21:39 +00:00
Displays a color picker widget. Useful for selecting a color from an RGB/RGBA colorspace.
[b]Note:[/b] This control is the color picker widget itself. You can use a [ColorPickerButton] instead if you need a button that brings up a [ColorPicker] in a pop-up.
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 (cherry picked from commit 439be614f4706705331669a58ce03f14c34ca52f)
2020-10-01 08:34:47 +00:00
<link title="Tween Demo">https://godotengine.org/asset-library/asset/146</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>
<method name="add_preset">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<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 20:42:36 +00:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them.
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs (cherry picked from commit 788b3aa27ac01263b2e70190ace6551504e0c81e)
2021-10-05 12:24:34 +00:00
[b]Note:[/b] The presets list is only for [i]this[/i] color picker.
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>
ColorPicker: extend access to presets from gds
2018-10-03 14:12:38 +00:00
<method name="erase_preset">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="color" type="Color" />
ColorPicker: extend access to presets from gds
2018-10-03 14:12:38 +00:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Removes the given color from the list of color presets of this color picker.
ColorPicker: extend access to presets from gds
2018-10-03 14:12:38 +00:00
</description>
</method>
doc: Sync classref with current source
2018-12-13 14:12:25 +00:00
<method name="get_presets" qualifiers="const">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="PoolColorArray" />
ColorPicker: extend access to presets from gds
2018-10-03 14:12:38 +00:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the list of colors in the presets of the color picker.
ColorPicker: extend access to presets from gds
2018-10-03 14:12:38 +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>
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
<members>
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="color" type="Color" setter="set_pick_color" getter="get_pick_color" default="Color( 1, 1, 1, 1 )">
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
The currently selected color.
</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="deferred_mode" type="bool" setter="set_deferred_mode" getter="is_deferred_mode" default="false">
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]true[/code], the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues).
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 09:56:21 +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">
Alpha channel indicates opacity, not transparency
2021-12-24 08:51:31 +00:00
If [code]true[/code], shows an alpha channel slider (opacity).
Update docs [ci skip]
2018-01-11 22:38:35 +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="hsv_mode" type="bool" setter="set_hsv_mode" getter="is_hsv_mode" default="false">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
If [code]true[/code], allows editing the color with Hue/Saturation/Value sliders.
Add HSV mode to color picker
2019-05-03 17:38:45 +00:00
[b]Note:[/b] Cannot be enabled if raw mode is on.
</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="presets_enabled" type="bool" setter="set_presets_enabled" getter="are_presets_enabled" default="true">
[DOC] Fill in various missing method/member descriptions.
2019-10-06 23:26:15 +00:00
If [code]true[/code], the "add preset" button is enabled.
doc: Sync classref with current source
2019-06-24 08:39:59 +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="presets_visible" type="bool" setter="set_presets_visible" getter="are_presets_visible" default="true">
[DOC] Fill in various missing method/member descriptions.
2019-10-06 23:26:15 +00:00
If [code]true[/code], saved color presets are visible.
doc: Sync classref with current source
2019-06-24 08:39:59 +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="raw_mode" type="bool" setter="set_raw_mode" getter="is_raw_mode" default="false">
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
[b]Note:[/b] Cannot be enabled if HSV mode is on.
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
</members>
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>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00: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 20:42:36 +00:00
<description>
Emitted when the color is changed.
</description>
</signal>
ColorPicker: extend access to presets from gds
2018-10-03 14:12:38 +00:00
<signal name="preset_added">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<argument index="0" name="color" type="Color" />
ColorPicker: extend access to presets from gds
2018-10-03 14:12:38 +00:00
<description>
Emitted when a preset is added.
</description>
</signal>
<signal name="preset_removed">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<argument index="0" name="color" type="Color" />
ColorPicker: extend access to presets from gds
2018-10-03 14:12:38 +00:00
<description>
Emitted when a preset is removed.
</description>
</signal>
</signals>
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
<constants>
</constants>
<theme_items>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="h_width" data_type="constant" type="int" default="30">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 18:21:21 +00:00
The width of the hue selection slider.
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-06 15:07:21 +00:00
<theme_item name="label_width" data_type="constant" type="int" default="10">
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-06 15:07:21 +00:00
<theme_item name="margin" data_type="constant" type="int" default="4">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 18:21:21 +00:00
The margin around the [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
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:45:12 +00:00
<theme_item name="sv_height" data_type="constant" type="int" default="256">
The height of the saturation-value selection box.
</theme_item>
<theme_item name="sv_width" data_type="constant" type="int" default="256">
The width of the saturation-value selection box.
</theme_item>
<theme_item name="add_preset" data_type="icon" type="Texture">
The icon for the "Add Preset" button.
</theme_item>
<theme_item name="color_hue" data_type="icon" type="Texture">
Custom texture for the hue selection slider on the right.
</theme_item>
<theme_item name="color_sample" data_type="icon" type="Texture">
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="overbright_indicator" data_type="icon" type="Texture">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 18:21:21 +00:00
The indicator used to signalize that the color value is outside the 0-1 range.
doc: Sync classref with current source
2019-10-01 08:55:49 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="preset_bg" data_type="icon" type="Texture">
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 21:54:43 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="screen_picker" data_type="icon" type="Texture">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 18:21:21 +00:00
The icon for the screen color picker button.
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>