virtualx-engine/doc/classes/VScrollBar.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VScrollBar" inherits="ScrollBar" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A vertical scrollbar that goes from top (min) to bottom (max).
	</brief_description>
	<description>
		A vertical scrollbar, typically used to navigate through content that extends beyond the visible height of a control. It is a [Range]-based control and goes from top (min) to bottom (max). Note that this direction is the opposite of [VSlider]'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="decrement" data_type="icon" type="Texture2D">
			Icon used as a button to scroll the [ScrollBar] up. Supports custom step using the [member ScrollBar.custom_step] property.
		</theme_item>
		<theme_item name="decrement_highlight" data_type="icon" type="Texture2D">
			Displayed when the mouse cursor hovers over the decrement button.
		</theme_item>
		<theme_item name="decrement_pressed" data_type="icon" type="Texture2D">
			Displayed when the decrement button is being pressed.
		</theme_item>
		<theme_item name="increment" data_type="icon" type="Texture2D">
			Icon used as a button to scroll the [ScrollBar] down. Supports custom step using the [member ScrollBar.custom_step] property.
		</theme_item>
		<theme_item name="increment_highlight" data_type="icon" type="Texture2D">
			Displayed when the mouse cursor hovers over the increment button.
		</theme_item>
		<theme_item name="increment_pressed" data_type="icon" type="Texture2D">
			Displayed when the increment button is being pressed.
		</theme_item>
		<theme_item name="grabber" data_type="style" type="StyleBox">
			Used as texture for the grabber, the draggable element representing current scroll.
		</theme_item>
		<theme_item name="grabber_highlight" data_type="style" type="StyleBox">
			Used when the mouse hovers over the grabber.
		</theme_item>
		<theme_item name="grabber_pressed" data_type="style" type="StyleBox">
			Used when the grabber is being dragged.
		</theme_item>
		<theme_item name="scroll" data_type="style" type="StyleBox">
			Used as background of this [ScrollBar].
		</theme_item>
		<theme_item name="scroll_focus" data_type="style" type="StyleBox">
			Used as background when the [ScrollBar] has the GUI focus.
		</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" ?>`
Bump version to 4.1-dev Can't stop, won't stop, they said, huh? 2023-03-01 01:44:37 +01:00			`<class name="VScrollBar" inherits="ScrollBar" version="4.1" 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 scrollbar that goes from top (min) to bottom (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 scrollbar, typically used to navigate through content that extends beyond the visible height of a control. It is a [Range]-based control and goes from top (min) to bottom (max). Note that this direction is the opposite of [VSlider]'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 theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="decrement" data_type="icon" type="Texture2D">`
Complete documentation of various classes 2020-01-08 22:51:16 +01:00			`Icon used as a button to scroll the [ScrollBar] up. Supports custom step using the [member ScrollBar.custom_step] property.`
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="decrement_highlight" data_type="icon" type="Texture2D">`
Complete documentation of various classes 2020-01-08 22:51:16 +01:00			`Displayed when the mouse cursor hovers over the decrement button.`
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>`
Added increment_pressed and decrement_pressed icons to scrollbars 2021-08-17 21:06:19 +02:00			`<theme_item name="decrement_pressed" data_type="icon" type="Texture2D">`
			`Displayed when the decrement button is being pressed.`
			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="increment" data_type="icon" type="Texture2D">`
Complete documentation of various classes 2020-01-08 22:51:16 +01:00			`Icon used as a button to scroll the [ScrollBar] down. Supports custom step using the [member ScrollBar.custom_step] property.`
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="increment_highlight" data_type="icon" type="Texture2D">`
Complete documentation of various classes 2020-01-08 22:51:16 +01:00			`Displayed when the mouse cursor hovers over the increment button.`
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>`
Added increment_pressed and decrement_pressed icons to scrollbars 2021-08-17 21:06:19 +02:00			`<theme_item name="increment_pressed" data_type="icon" type="Texture2D">`
			`Displayed when the increment button is being pressed.`
			`</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" data_type="style" type="StyleBox">`
			`Used as texture for the grabber, the draggable element representing current scroll.`
			`</theme_item>`
			`<theme_item name="grabber_highlight" data_type="style" type="StyleBox">`
			`Used when the mouse hovers over the grabber.`
			`</theme_item>`
			`<theme_item name="grabber_pressed" data_type="style" type="StyleBox">`
			`Used when the grabber is being dragged.`
			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="scroll" data_type="style" type="StyleBox">`
Complete documentation of various classes 2020-01-08 22:51:16 +01:00			`Used as background of this [ScrollBar].`
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="scroll_focus" data_type="style" type="StyleBox">`
Complete documentation of various classes 2020-01-08 22:51:16 +01:00			`Used as background when the [ScrollBar] has the GUI focus.`
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>`
			`</theme_items>`
			`</class>`