f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
101 lines
5.3 KiB
XML
101 lines
5.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="StyleBox" inherits="Resource" version="3.4">
|
|
<brief_description>
|
|
Base class for drawing stylized boxes for the UI.
|
|
</brief_description>
|
|
<description>
|
|
StyleBox is [Resource] that provides an abstract base class for drawing stylized boxes for the UI. StyleBoxes are used for drawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below.
|
|
[b]Note:[/b] For children of [Control] that have [i]Theme Properties[/i], the [code]focus[/code] [StyleBox] is displayed over the [code]normal[/code], [code]hover[/code] or [code]pressed[/code] [StyleBox]. This makes the [code]focus[/code] [StyleBox] more reusable across different nodes.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="draw" qualifiers="const">
|
|
<return type="void" />
|
|
<argument index="0" name="canvas_item" type="RID" />
|
|
<argument index="1" name="rect" type="Rect2" />
|
|
<description>
|
|
Draws this stylebox using a [CanvasItem] with given [RID].
|
|
You can get a [RID] value using [method Object.get_instance_id] on a [CanvasItem]-derived node.
|
|
</description>
|
|
</method>
|
|
<method name="get_center_size" qualifiers="const">
|
|
<return type="Vector2" />
|
|
<description>
|
|
Returns the size of this [StyleBox] without the margins.
|
|
</description>
|
|
</method>
|
|
<method name="get_current_item_drawn" qualifiers="const">
|
|
<return type="CanvasItem" />
|
|
<description>
|
|
Returns the [CanvasItem] that handles its [constant CanvasItem.NOTIFICATION_DRAW] or [method CanvasItem._draw] callback at this moment.
|
|
</description>
|
|
</method>
|
|
<method name="get_default_margin" qualifiers="const">
|
|
<return type="float" />
|
|
<argument index="0" name="margin" type="int" enum="Margin" />
|
|
<description>
|
|
Returns the default value of the specified [enum Margin].
|
|
</description>
|
|
</method>
|
|
<method name="get_margin" qualifiers="const">
|
|
<return type="float" />
|
|
<argument index="0" name="margin" type="int" enum="Margin" />
|
|
<description>
|
|
Returns the content margin offset for the specified [enum Margin].
|
|
Positive values reduce size inwards, unlike [Control]'s margin values.
|
|
</description>
|
|
</method>
|
|
<method name="get_minimum_size" qualifiers="const">
|
|
<return type="Vector2" />
|
|
<description>
|
|
Returns the minimum size that this stylebox can be shrunk to.
|
|
</description>
|
|
</method>
|
|
<method name="get_offset" qualifiers="const">
|
|
<return type="Vector2" />
|
|
<description>
|
|
Returns the "offset" of a stylebox. This helper function returns a value equivalent to [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code].
|
|
</description>
|
|
</method>
|
|
<method name="set_default_margin">
|
|
<return type="void" />
|
|
<argument index="0" name="margin" type="int" enum="Margin" />
|
|
<argument index="1" name="offset" type="float" />
|
|
<description>
|
|
Sets the default value of the specified [enum Margin] to given [code]offset[/code] in pixels.
|
|
</description>
|
|
</method>
|
|
<method name="test_mask" qualifiers="const">
|
|
<return type="bool" />
|
|
<argument index="0" name="point" type="Vector2" />
|
|
<argument index="1" name="rect" type="Rect2" />
|
|
<description>
|
|
Test a position in a rectangle, return whether it passes the mask test.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="content_margin_bottom" type="float" setter="set_default_margin" getter="get_default_margin" default="-1.0">
|
|
The bottom margin for the contents of this style box. Increasing this value reduces the space available to the contents from the bottom.
|
|
If this value is negative, it is ignored and a child-specific margin is used instead. For example for [StyleBoxFlat] the border thickness (if any) is used instead.
|
|
It is up to the code using this style box to decide what these contents are: for example, a [Button] respects this content margin for the textual contents of the button.
|
|
[method get_margin] should be used to fetch this value as consumer instead of reading these properties directly. This is because it correctly respects negative values and the fallback mentioned above.
|
|
</member>
|
|
<member name="content_margin_left" type="float" setter="set_default_margin" getter="get_default_margin" default="-1.0">
|
|
The left margin for the contents of this style box. Increasing this value reduces the space available to the contents from the left.
|
|
Refer to [member content_margin_bottom] for extra considerations.
|
|
</member>
|
|
<member name="content_margin_right" type="float" setter="set_default_margin" getter="get_default_margin" default="-1.0">
|
|
The right margin for the contents of this style box. Increasing this value reduces the space available to the contents from the right.
|
|
Refer to [member content_margin_bottom] for extra considerations.
|
|
</member>
|
|
<member name="content_margin_top" type="float" setter="set_default_margin" getter="get_default_margin" default="-1.0">
|
|
The top margin for the contents of this style box. Increasing this value reduces the space available to the contents from the top.
|
|
Refer to [member content_margin_bottom] for extra considerations.
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|