Base class for drawing stylized boxes for the UI.
    public abstract class StyleBox : Resource

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.

Inheritance Chain

Derived Classes

Properties

    public float ContentMarginBottom { get; set; }

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(Godot.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.

    public float ContentMarginLeft { get; set; }

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.

    public float ContentMarginRight { get; set; }

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.

    public float ContentMarginTop { get; set; }

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

    public void Draw(RID canvasItem, Rect2 rect)

    public Vector2 GetCenterSize()

    public CanvasItem GetCurrentItemDrawn()

    public float GetDefaultMargin(Margin margin)

    public float GetMargin(Margin margin)

Return the content margin offset for the specified margin

Positive values reduce size inwards, unlike Control’s margin values.

    public Vector2 GetMinimumSize()

Return the minimum size that this stylebox can be shrunk to.

    public Vector2 GetOffset()

Return the “offset” of a stylebox, this is a helper function, like writing Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP)).

    public void SetDefaultMargin(Margin margin, float offset)

    public bool TestMask(Vector2 point, Rect2 rect)

Test a position in a rectangle, return whether it passes the mask test.

Tags: