mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-21 10:25:24 +08:00
Code Issues Packages Projects Releases Wiki Activity
3ce7678374
godot/doc/classes/ColorPickerButton.xml

108 lines
4.2 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-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 09:03:48 +08: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-13 04:42:36 +08:00
<brief_description>
Added missing end points for brief descriptions in the docs.
2018-03-31 07:11:14 +08: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-13 04:42:36 +08:00
</brief_description>
<description>
Misc. typos Found via `codespell -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"`
2018-09-13 09:38:39 +08: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-24 05:34:28 +08: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-13 04:42:36 +08:00
</description>
<tutorials>
Link to demos from within the class reference
2020-10-01 16:34:47 +08: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-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">
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
<return type="ColorPicker">
</return>
<description>
[DOCS] Updates to assorted class descriptions.
2018-08-18 05:55:19 +08: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-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">
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
<return type="PopupPanel">
</return>
<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.
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>
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="color" type="Color" setter="set_pick_color" getter="get_pick_color" default="Color( 0, 0, 0, 1 )">
[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>
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 19:34:03 +08: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-13 04:42:36 +08:00
</members>
<signals>
<signal name="color_changed">
<argument index="0" name="color" type="Color">
</argument>
<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>
<constants>
</constants>
<theme_items>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 16:59:06 +08:00
<theme_item name="bg" type="Texture2D">
Completes doc for button classes
2020-02-04 15:46:01 +08: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-12 05:54:43 +08:00
</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_item name="disabled" type="StyleBox">
Completes doc for button classes
2020-02-04 15:46:01 +08: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-13 04:42:36 +08:00
</theme_item>
<theme_item name="focus" type="StyleBox">
Completes doc for button classes
2020-02-04 15:46:01 +08: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-13 04:42:36 +08:00
</theme_item>
<theme_item name="font" type="Font">
Completes doc for button classes
2020-02-04 15:46:01 +08: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-13 04:42:36 +08:00
</theme_item>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<theme_item name="font_color" type="Color" default="Color( 1, 1, 1, 1 )">
Completes doc for button classes
2020-02-04 15:46:01 +08: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-13 04:42:36 +08:00
</theme_item>
Change themes *_color_* to *_*_color Changed: font_color_accel -> font_accelerator_color font_color_bg -> font_unselected_color font_color_disabled -> font_disabled_color font_color_fg -> font_selected_color font_color_hover -> font_hover_color font_color_hover_pressed -> font_hover_pressed_color font_color_pressed -> font_pressed_color font_color_readonly -> font_readonly_color font_color_selected -> font_selected_color font_color_shadow -> font_shadow_color font_color_uneditable -> font_uneditable_color icon_color_disabled -> icon_disabled_color icon_color_hover -> icon_hover_color icon_color_hover_pressed -> icon_hover_pressed_color icon_color_normal -> icon_normal_color icon_color_pressed -> icon_pressed_color Also includes: font_outline_modulate -> font_outline_color tab_fg -> tab_selected tab_bg -> tab_unselected
2020-12-08 21:11:45 +08:00
<theme_item name="font_disabled_color" type="Color" default="Color( 0.9, 0.9, 0.9, 0.3 )">
Completes doc for button classes
2020-02-04 15:46:01 +08: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-13 04:42:36 +08:00
</theme_item>
Change themes *_color_* to *_*_color Changed: font_color_accel -> font_accelerator_color font_color_bg -> font_unselected_color font_color_disabled -> font_disabled_color font_color_fg -> font_selected_color font_color_hover -> font_hover_color font_color_hover_pressed -> font_hover_pressed_color font_color_pressed -> font_pressed_color font_color_readonly -> font_readonly_color font_color_selected -> font_selected_color font_color_shadow -> font_shadow_color font_color_uneditable -> font_uneditable_color icon_color_disabled -> icon_disabled_color icon_color_hover -> icon_hover_color icon_color_hover_pressed -> icon_hover_pressed_color icon_color_normal -> icon_normal_color icon_color_pressed -> icon_pressed_color Also includes: font_outline_modulate -> font_outline_color tab_fg -> tab_selected tab_bg -> tab_unselected
2020-12-08 21:11:45 +08:00
<theme_item name="font_hover_color" type="Color" default="Color( 1, 1, 1, 1 )">
Completes doc for button classes
2020-02-04 15:46:01 +08: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-13 04:42:36 +08:00
</theme_item>
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-26 05:45:28 +08:00
<theme_item name="font_outline_color" type="Color" default="Color( 1, 1, 1, 1 )">
The tint of text outline of the [ColorPickerButton].
</theme_item>
Change themes *_color_* to *_*_color Changed: font_color_accel -> font_accelerator_color font_color_bg -> font_unselected_color font_color_disabled -> font_disabled_color font_color_fg -> font_selected_color font_color_hover -> font_hover_color font_color_hover_pressed -> font_hover_pressed_color font_color_pressed -> font_pressed_color font_color_readonly -> font_readonly_color font_color_selected -> font_selected_color font_color_shadow -> font_shadow_color font_color_uneditable -> font_uneditable_color icon_color_disabled -> icon_disabled_color icon_color_hover -> icon_hover_color icon_color_hover_pressed -> icon_hover_pressed_color icon_color_normal -> icon_normal_color icon_color_pressed -> icon_pressed_color Also includes: font_outline_modulate -> font_outline_color tab_fg -> tab_selected tab_bg -> tab_unselected
2020-12-08 21:11:45 +08:00
<theme_item name="font_pressed_color" type="Color" default="Color( 0.8, 0.8, 0.8, 1 )">
Completes doc for button classes
2020-02-04 15:46:01 +08: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-13 04:42:36 +08:00
</theme_item>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<theme_item name="font_size" type="int">
Font size of the [ColorPickerButton]'s text.
</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_item name="hover" type="StyleBox">
Completes doc for button classes
2020-02-04 15:46:01 +08: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-13 04:42:36 +08:00
</theme_item>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<theme_item name="hseparation" type="int" default="2">
Completes doc for button classes
2020-02-04 15:46:01 +08: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-13 04:42:36 +08:00
</theme_item>
<theme_item name="normal" type="StyleBox">
Completes doc for button classes
2020-02-04 15:46:01 +08: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-13 04:42:36 +08:00
</theme_item>
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-26 05:45:28 +08:00
<theme_item name="outline_size" type="int" default="0">
The size of the text outline.
</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_item name="pressed" type="StyleBox">
Completes doc for button classes
2020-02-04 15:46:01 +08: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-13 04:42:36 +08:00
</theme_item>
</theme_items>
</class>
Reference in New Issue Copy Permalink