summaryrefslogtreecommitdiff
path: root/doc/classes/ColorPickerButton.xml
blob: 390f80507922c61d9cf2fabda275ae91ce283a1d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ColorPickerButton" inherits="Button" version="4.0">
	<brief_description>
		Button that pops out a [ColorPicker].
	</brief_description>
	<description>
		Encapsulates a [ColorPicker] making it accessible by pressing a button. Pressing the button will toggle the [ColorPicker] visibility.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_picker">
			<return type="ColorPicker">
			</return>
			<description>
				Returns the [ColorPicker] that this node toggles.
			</description>
		</method>
		<method name="get_popup">
			<return type="PopupPanel">
			</return>
			<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.
			</description>
		</method>
	</methods>
	<members>
		<member name="color" type="Color" setter="set_pick_color" getter="get_pick_color" default="Color( 0, 0, 0, 1 )">
			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" override="true" default="true" />
	</members>
	<signals>
		<signal name="color_changed">
			<argument index="0" name="color" type="Color">
			</argument>
			<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>
	<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" default="Color( 1, 1, 1, 1 )">
		</theme_item>
		<theme_item name="font_color_disabled" type="Color" default="Color( 0.9, 0.9, 0.9, 0.3 )">
		</theme_item>
		<theme_item name="font_color_hover" type="Color" default="Color( 1, 1, 1, 1 )">
		</theme_item>
		<theme_item name="font_color_pressed" type="Color" default="Color( 0.8, 0.8, 0.8, 1 )">
		</theme_item>
		<theme_item name="hover" type="StyleBox">
		</theme_item>
		<theme_item name="hseparation" type="int" default="2">
		</theme_item>
		<theme_item name="normal" type="StyleBox">
		</theme_item>
		<theme_item name="pressed" type="StyleBox">
		</theme_item>
	</theme_items>
</class>