Struct StyleBox
Base class for drawing stylized boxes for the UI.
struct StyleBox
;
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.
Properties
| Name | Type | Description |
|---|---|---|
contentMarginBottom[get, set]
|
double | 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.
getMargin 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.
|
contentMarginLeft[get, set]
|
double | 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 contentMarginBottom for extra considerations.
|
contentMarginRight[get, set]
|
double | 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 contentMarginBottom for extra considerations.
|
contentMarginTop[get, set]
|
double | 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 contentMarginBottom for extra considerations.
|
Methods
| Name | Description |
|---|---|
draw
|
Draws this stylebox using a CanvasItem with given RID.
You can get a RID value using GodotObject on a CanvasItem-derived node.
|
getCenterSize
|
Returns the size of this StyleBox without the margins.
|
getCurrentItemDrawn
|
Returns the CanvasItem that handles its constant CanvasItem or CanvasItem callback at this moment.
|
getDefaultMargin
|
Returns the default value of the specified margin.
|
getMargin
|
Returns the content margin offset for the specified margin.
Positive values reduce size inwards, unlike Control's margin values.
|
getMinimumSize
|
Returns the minimum size that this stylebox can be shrunk to. |
getOffset
|
Returns the "offset" of a stylebox. This helper function returns a value equivalent to Vector2(style.
|
setDefaultMargin
|
Sets the default value of the specified margin to given offset in pixels.
|
testMask
|
Test a position in a rectangle, return whether it passes the mask test. |