426bcc9941
In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
92 lines
4.2 KiB
XML
92 lines
4.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="StyleBox" inherits="Resource" category="Core" version="3.2">
|
|
<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.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="draw" qualifiers="const">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="canvas_item" type="RID">
|
|
</argument>
|
|
<argument index="1" name="rect" type="Rect2">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_center_size" qualifiers="const">
|
|
<return type="Vector2">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_current_item_drawn" qualifiers="const">
|
|
<return type="CanvasItem">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_margin" qualifiers="const">
|
|
<return type="float">
|
|
</return>
|
|
<argument index="0" name="margin" type="int" enum="Margin">
|
|
</argument>
|
|
<description>
|
|
Returns the content margin offset for the specified margin
|
|
Positive values reduce size inwards, unlike [Control]'s margin values.
|
|
</description>
|
|
</method>
|
|
<method name="get_minimum_size" qualifiers="const">
|
|
<return type="Vector2">
|
|
</return>
|
|
<description>
|
|
Returns the minimum size that this stylebox can be shrunk to.
|
|
</description>
|
|
</method>
|
|
<method name="get_offset" qualifiers="const">
|
|
<return type="Vector2">
|
|
</return>
|
|
<description>
|
|
Returns the "offset" of a stylebox, this is a helper function, like writing [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code].
|
|
</description>
|
|
</method>
|
|
<method name="test_mask" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<argument index="0" name="point" type="Vector2">
|
|
</argument>
|
|
<argument index="1" name="rect" type="Rect2">
|
|
</argument>
|
|
<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">
|
|
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">
|
|
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">
|
|
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">
|
|
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>
|