summaryrefslogtreecommitdiff
path: root/doc/classes/ScrollBar.xml
blob: 1f1415bebe19f1cc3a3b92f569c81ef6ccbe15fa (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ScrollBar" inherits="Range" version="4.0">
	<brief_description>
		Base class for scroll bars.
	</brief_description>
	<description>
		Scrollbars are a [Range]-based [Control], that display a draggable area (the size of the page). Horizontal ([HScrollBar]) and Vertical ([VScrollBar]) versions are available.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="custom_step" type="float" setter="set_custom_step" getter="get_custom_step" default="-1.0">
			Overrides the step used when clicking increment and decrement buttons or when using arrow keys when the [ScrollBar] is focused.
		</member>
		<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" override="true" default="0" />
		<member name="step" type="float" setter="set_step" getter="get_step" override="true" default="0.0" />
	</members>
	<signals>
		<signal name="scrolling">
			<description>
				Emitted when the scrollbar is being scrolled.
			</description>
		</signal>
	</signals>
</class>