Table of Contents

Class StyleBox

Abstract base class for defining stylized boxes for UI elements.

Inheritance
StyleBox
Derived

Remarks

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

content_margin_bottom

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.

StyleBox.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.

var content_margin_bottom : float = -1.0

Property Value

float

Remarks

  • void set_content_margin(int margin, float offset)
  • float get_content_margin(int margin)

content_margin_left

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.

var content_margin_left : float = -1.0

Property Value

float

Remarks

  • void set_content_margin(int margin, float offset)
  • float get_content_margin(int margin)

content_margin_right

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 content_margin_bottom for extra considerations.

var content_margin_right : float = -1.0

Property Value

float

Remarks

  • void set_content_margin(int margin, float offset)
  • float get_content_margin(int margin)

content_margin_top

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 content_margin_bottom for extra considerations.

var content_margin_top : float = -1.0

Property Value

float

Remarks

  • void set_content_margin(int margin, float offset)
  • float get_content_margin(int margin)

Methods

_draw(RID, Rect2)

Qualifiers: virtualconst

void _draw(RID to_canvas_item, Rect2 rect)

Parameters

to_canvas_item RID
rect Rect2

_get_draw_rect(Rect2)

Qualifiers: virtualconst

Rect2 _get_draw_rect(Rect2 rect)

Parameters

rect Rect2

_get_minimum_size

Qualifiers: virtualconst

Virtual method to be implemented by the user. Returns a custom minimum size that the stylebox must respect when drawing. By default get_minimum_size only takes content margins into account. This method can be overridden to add another size restriction. A combination of the default behavior and the output of this method will be used, to account for both sizes.

Vector2 _get_minimum_size

_test_mask(Vector2, Rect2)

Qualifiers: virtualconst

bool _test_mask(Vector2 point, Rect2 rect)

Parameters

point Vector2
rect Rect2

draw(RID, Rect2)

Qualifiers: const

Draws this stylebox using a canvas item identified by the given RID.

The RID value can either be the result of get_canvas_item called on an existing CanvasItem-derived node, or directly from creating a canvas item in the RenderingServer with canvas_item_create.

void draw(RID canvas_item, Rect2 rect)

Parameters

canvas_item RID
rect Rect2

get_content_margin(int)

Qualifiers: const

Returns the default margin of the specified Side.

float get_content_margin(int margin)

Parameters

margin int

get_current_item_drawn

Qualifiers: const

Returns the CanvasItem that handles its NOTIFICATION_DRAW or _draw callback at this moment.

CanvasItem get_current_item_drawn

get_margin(int)

Qualifiers: const

Returns the content margin offset for the specified Side.

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

float get_margin(int margin)

Parameters

margin int

get_minimum_size

Qualifiers: const

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

Vector2 get_minimum_size

get_offset

Qualifiers: const

Returns the "offset" of a stylebox. This helper function returns a value equivalent to Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP)).

Vector2 get_offset

set_content_margin(int, float)

Sets the default value of the specified Side to offset pixels.

void set_content_margin(int margin, float offset)

Parameters

margin int
offset float

set_content_margin_all(float)

Sets the default margin to offset pixels for all sides.

void set_content_margin_all(float offset)

Parameters

offset float

test_mask(Vector2, Rect2)

Qualifiers: const

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

bool test_mask(Vector2 point, Rect2 rect)

Parameters

point Vector2
rect Rect2