StyleBox¶
Inherits: Resource < RefCounted < Object
Inherited By: StyleBoxEmpty, StyleBoxFlat, StyleBoxLine, StyleBoxTexture
Abstract base class for defining stylized boxes for UI elements.
Description¶
StyleBox is an abstract base class for drawing stylized boxes for UI elements. It is used for panels, buttons, LineEdit 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.
Note: For control nodes that have Theme Properties, the focus
StyleBox is displayed over the normal
, hover
or pressed
StyleBox. This makes the focus
StyleBox more reusable across different nodes.
Properties¶
|
||
|
||
|
||
|
Methods¶
void |
|
_get_draw_rect ( Rect2 rect ) virtual const |
|
_get_minimum_size ( ) virtual const |
|
_test_mask ( Vector2 point, Rect2 rect ) virtual const |
|
void |
|
get_content_margin ( Side margin ) const |
|
get_current_item_drawn ( ) const |
|
get_margin ( Side margin ) const |
|
get_minimum_size ( ) const |
|
get_offset ( ) const |
|
void |
set_content_margin ( Side margin, float offset ) |
void |
set_content_margin_all ( float offset ) |
Property Descriptions¶
float content_margin_bottom = -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.
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.
float content_margin_left = -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 content_margin_bottom for extra considerations.
float content_margin_right = -1.0