virtualx-engine/doc/classes/ColorPicker.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ColorPicker" inherits="BoxContainer" category="Core" version="3.1-dev">
	<brief_description>
		Color picker control.
	</brief_description>
	<description>
		This is a simple color picker [Control]. It's useful for selecting a color from an RGB/RGBA colorspace.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="add_preset">
			<return type="void">
			</return>
			<argument index="0" name="color" type="Color">
			</argument>
			<description>
				Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker.
			</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], shows an alpha channel slider (transparency).
		</member>
		<member name="raw_mode" type="bool" setter="set_raw_mode" getter="is_raw_mode">
			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).
		</member>
	</members>
	<signals>
		<signal name="color_changed">
			<argument index="0" name="color" type="Color">
			</argument>
			<description>
				Emitted when the color is changed.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
	<theme_items>
		<theme_item name="add_preset" type="Texture">
		</theme_item>
		<theme_item name="color_hue" type="Texture">
		</theme_item>
		<theme_item name="color_sample" type="Texture">
		</theme_item>
		<theme_item name="h_width" type="int">
		</theme_item>
		<theme_item name="label_width" type="int">
		</theme_item>
		<theme_item name="margin" type="int">
		</theme_item>
		<theme_item name="preset_bg" type="Texture">
		</theme_item>
		<theme_item name="screen_picker" type="Texture">
		</theme_item>
		<theme_item name="sv_height" type="int">
		</theme_item>
		<theme_item name="sv_width" type="int">
		</theme_item>
	</theme_items>
</class>