virtualx-engine/doc/classes/ColorPickerButton.xml

75 lines
2.3 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ColorPickerButton" inherits="Button" category="Core" version="3.0-stable">
<brief_description>
Button that pops out a [ColorPicker]
</brief_description>
<description>
Encapsulates a [ColorPicker] making it accesible by pressing a button, pressing the button will toggle the [ColorPicker] visibility
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_picker" qualifiers="const">
<return type="ColorPicker">
</return>
<description>
Returns the [code]ColorPicker[/code] that this [code]ColorPickerButton[/code] toggles.
</description>
</method>
<method name="get_popup" qualifiers="const">
<return type="PopupPanel">
</return>
<description>
2017-12-07 08:23:08 +01: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.
</description>
</method>
</methods>
<members>
<member name="color" type="Color" setter="set_pick_color" getter="get_pick_color">
The currently selected color.
</member>
<member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha">
If [code]true[/code] the alpha channel in the displayed [ColorPicker] will be visible. Default value: [code]true[/code].
</member>
</members>
<signals>
<signal name="color_changed">
<argument index="0" name="color" type="Color">
</argument>
<description>
Emitted when the color changes.
</description>
</signal>
</signals>
<constants>
</constants>
<theme_items>
<theme_item name="bg" type="Texture">
</theme_item>
<theme_item name="disabled" type="StyleBox">
</theme_item>
<theme_item name="focus" type="StyleBox">
</theme_item>
<theme_item name="font" type="Font">
</theme_item>
<theme_item name="font_color" type="Color">
</theme_item>
<theme_item name="font_color_disabled" type="Color">
</theme_item>
<theme_item name="font_color_hover" type="Color">
</theme_item>
<theme_item name="font_color_pressed" type="Color">
</theme_item>
<theme_item name="hover" type="StyleBox">
</theme_item>
<theme_item name="hseparation" type="int">
</theme_item>
<theme_item name="normal" type="StyleBox">
</theme_item>
<theme_item name="pressed" type="StyleBox">
</theme_item>
</theme_items>
</class>