virtualx-engine/doc/classes/VSlider.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VSlider" inherits="Slider" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A vertical slider that goes from bottom (min) to top (max).
	</brief_description>
	<description>
		A vertical slider, used to adjust a value by moving a grabber along a vertical axis. It is a [Range]-based control and goes from bottom (min) to top (max). Note that this direction is the opposite of [VScrollBar]'s.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="size_flags_horizontal" type="int" setter="set_h_size_flags" getter="get_h_size_flags" overrides="Control" enum="Control.SizeFlags" is_bitfield="true" default="0" />
		<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" overrides="Control" enum="Control.SizeFlags" is_bitfield="true" default="1" />
	</members>
	<theme_items>
		<theme_item name="center_grabber" data_type="constant" type="int" default="0">
			Boolean constant. If [code]1[/code], the grabber texture size will be ignored and it will fit within slider's bounds based only on its center position.
		</theme_item>
		<theme_item name="grabber_offset" data_type="constant" type="int" default="0">
			Horizontal offset of the grabber.
		</theme_item>
		<theme_item name="grabber" data_type="icon" type="Texture2D">
			The texture for the grabber (the draggable element).
		</theme_item>
		<theme_item name="grabber_disabled" data_type="icon" type="Texture2D">
			The texture for the grabber when it's disabled.
		</theme_item>
		<theme_item name="grabber_highlight" data_type="icon" type="Texture2D">
			The texture for the grabber when it's focused.
		</theme_item>
		<theme_item name="tick" data_type="icon" type="Texture2D">
			The texture for the ticks, visible when [member Slider.tick_count] is greater than 0.
		</theme_item>
		<theme_item name="grabber_area" data_type="style" type="StyleBox">
			The background of the area below the grabber.
		</theme_item>
		<theme_item name="grabber_area_highlight" data_type="style" type="StyleBox">
			The background of the area below the grabber that displays when it's being hovered or focused.
		</theme_item>
		<theme_item name="slider" data_type="style" type="StyleBox">
			The background for the whole slider. Determines the width of the [code]grabber_area[/code].
		</theme_item>
	</theme_items>
</class>
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 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="VSlider" inherits="Slider" 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 22:42:36 +02:00			`<brief_description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`A vertical slider that goes from bottom (min) to top (max).`
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 22:42:36 +02:00			`</brief_description>`
			`<description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`A vertical slider, used to adjust a value by moving a grabber along a vertical axis. It is a [Range]-based control and goes from bottom (min) to top (max). Note that this direction is the opposite of [VScrollBar]'s.`
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 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
Run doctool after overridden properties changes 2019-09-03 12:44:58 +02:00			`<members>`
Display `BitField[Enum]` in docs to distinguish from `Enum` 2023-06-15 16:06:22 +02:00			`<member name="size_flags_horizontal" type="int" setter="set_h_size_flags" getter="get_h_size_flags" overrides="Control" enum="Control.SizeFlags" is_bitfield="true" default="0" />`
			`<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" overrides="Control" enum="Control.SizeFlags" is_bitfield="true" default="1" />`
Run doctool after overridden properties changes 2019-09-03 12:44:58 +02:00			`</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 22:42:36 +02:00			`<theme_items>`
Add center_grabber property to Slider 2022-11-23 14:56:10 +01:00			`<theme_item name="center_grabber" data_type="constant" type="int" default="0">`
			`Boolean constant. If [code]1[/code], the grabber texture size will be ignored and it will fit within slider's bounds based only on its center position.`
			`</theme_item>`
ColorPicker UX improvements - Tabs and MenuButton for mode selection and enabling/disabling colorized sliders - MenuButton for shape selection with new icon for each shape - Drag and drop functionality for presets to arrange order - A chronological list of recently selected presets which are global for the editor - Presets are now highlighted as being active or inactive - Thicker sliders for easy targeting - `grabber_offset` theme constant for Slider - Uncolorized sliders 2022-06-30 13:34:32 +02:00			`<theme_item name="grabber_offset" data_type="constant" type="int" default="0">`
			`Horizontal offset of the grabber.`
			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="grabber" data_type="icon" type="Texture2D">`
Add LOTS of missing docs 2020-03-03 19:21:21 +01:00			`The texture for the grabber (the draggable element).`
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 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="grabber_disabled" data_type="icon" type="Texture2D">`
Add LOTS of missing docs 2020-03-03 19:21:21 +01:00			`The texture for the grabber when it's 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-12 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="grabber_highlight" data_type="icon" type="Texture2D">`
Add LOTS of missing docs 2020-03-03 19:21:21 +01:00			`The texture for the grabber when it's focused.`
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 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="tick" data_type="icon" type="Texture2D">`
Add LOTS of missing docs 2020-03-03 19:21:21 +01:00			`The texture for the ticks, visible when [member Slider.tick_count] is greater than 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-12 22:42:36 +02:00			`</theme_item>`
Sort and group theme properties in docs, improve formatting for theme and enums 2021-12-01 19:02:20 +01:00			`<theme_item name="grabber_area" data_type="style" type="StyleBox">`
			`The background of the area below the grabber.`
			`</theme_item>`
			`<theme_item name="grabber_area_highlight" data_type="style" type="StyleBox">`
Fill random docs 2022-11-21 03:48:36 +01:00			`The background of the area below the grabber that displays when it's being hovered or focused.`
Sort and group theme properties in docs, improve formatting for theme and enums 2021-12-01 19:02:20 +01:00			`</theme_item>`
			`<theme_item name="slider" data_type="style" type="StyleBox">`
			`The background for the whole slider. Determines the width of the [code]grabber_area[/code].`
			`</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-12 22:42:36 +02:00			`</theme_items>`
			`</class>`