summaryrefslogtreecommitdiffstats
path: root/doc/classes/StyleBoxLine.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2019-12-07 00:10:57 +0100
committerGitHub <noreply@github.com>2019-12-07 00:10:57 +0100
commit643b37aaf01138af8e5780caa938a107f2341412 (patch)
tree9311182b0ee10383614de7b39e34b0b63c4df762 /doc/classes/StyleBoxLine.xml
parent111ba06310a8688b294afc58a8f369e0a8cad4df (diff)
parentf1a76a88207d6eab65b32bcfaecc231b7e38c978 (diff)
downloadredot-engine-643b37aaf01138af8e5780caa938a107f2341412.tar.gz
Merge pull request #34086 from Calinou/doc-improve-stylebox
Improve the StyleBox class documentations
Diffstat (limited to 'doc/classes/StyleBoxLine.xml')
-rw-r--r--doc/classes/StyleBoxLine.xml7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/classes/StyleBoxLine.xml b/doc/classes/StyleBoxLine.xml
index c0745c5f39..b5da81de79 100644
--- a/doc/classes/StyleBoxLine.xml
+++ b/doc/classes/StyleBoxLine.xml
@@ -1,8 +1,10 @@
<?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>
@@ -10,14 +12,19 @@
</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>