summaryrefslogtreecommitdiff
path: root/doc/classes/StyleBoxLine.xml
blob: b5da81de79e0b10927796e9aa158c70741f33788 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StyleBoxLine" inherits="StyleBox" category="Core" version="3.2">
	<brief_description>
		[StyleBox] that displays a single line.
	</brief_description>
	<description>
		[StyleBox] that displays a single line of a given color and thickness. It can be used to draw things like separators.
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="color" type="Color" setter="set_color" getter="get_color" default="Color( 0, 0, 0, 1 )">
			The line's color.
		</member>
		<member name="grow_begin" type="float" setter="set_grow_begin" getter="get_grow_begin" default="1.0">
			The number of pixels the line will extend before the [StyleBoxLine]'s bounds. If set to a negative value, the line will begin inside the [StyleBoxLine]'s bounds.
		</member>
		<member name="grow_end" type="float" setter="set_grow_end" getter="get_grow_end" default="1.0">
			The number of pixels the line will extend past the [StyleBoxLine]'s bounds. If set to a negative value, the line will end inside the [StyleBoxLine]'s bounds.
		</member>
		<member name="thickness" type="int" setter="set_thickness" getter="get_thickness" default="1">
			The line's thickness in pixels.
		</member>
		<member name="vertical" type="bool" setter="set_vertical" getter="is_vertical" default="false">
			If [code]true[/code], the line will be vertical. If [code]false[/code], the line will be horizontal.
		</member>
	</members>
	<constants>
	</constants>
</class>