StyleBox

Base class for drawing stylized boxes for the UI.

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. Note: For children of Control 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.

@GodotBaseClass

struct StyleBox {

package

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(StyleBox other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static StyleBox _new();

void draw(RID canvas_item, Rect2 rect);

Vector2 getCenterSize();

CanvasItem getCurrentItemDrawn();

double getDefaultMargin(long margin);

double getMargin(long margin);

Vector2 getMinimumSize();

Vector2 getOffset();

void setDefaultMargin(long margin, double offset);

bool testMask(Vector2 point, Rect2 rect);

double contentMarginBottom [@property getter];

double contentMarginBottom [@property setter];

double contentMarginLeft [@property getter];

double contentMarginLeft [@property setter];

double contentMarginRight [@property getter];

double contentMarginRight [@property setter];

double contentMarginTop [@property getter];

double contentMarginTop [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

draw void draw(RID canvas_item, Rect2 rect): Draws this stylebox using a CanvasItem with given RID. You can get a RID value using GodotObject.getInstanceId on a CanvasItem-derived node.
getCenterSize Vector2 getCenterSize(): Returns the size of this StyleBox without the margins.
getCurrentItemDrawn CanvasItem getCurrentItemDrawn(): Returns the CanvasItem that handles its constant CanvasItem.NOTIFICATION_DRAW or CanvasItem._draw callback at this moment.
getDefaultMargin double getDefaultMargin(long margin): Returns the default value of the specified margin.
getMargin double getMargin(long margin): Returns the content margin offset for the specified margin. Positive values reduce size inwards, unlike Control's margin values.
getMinimumSize Vector2 getMinimumSize(): Returns the minimum size that this stylebox can be shrunk to.
getOffset Vector2 getOffset(): 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)).
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(StyleBox other)
opEquals bool opEquals(typeof(null) n)
setDefaultMargin void setDefaultMargin(long margin, double offset): Sets the default value of the specified margin to given offset in pixels.
testMask bool testMask(Vector2 point, Rect2 rect): Test a position in a rectangle, return whether it passes the mask test.
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

contentMarginBottom double contentMarginBottom [@property getter]
double contentMarginBottom [@property setter]: 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 double contentMarginLeft [@property getter]
double contentMarginLeft [@property setter]: 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 double contentMarginRight [@property getter]
double contentMarginRight [@property setter]: 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 double contentMarginTop [@property getter]
double contentMarginTop [@property setter]: 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.

Static functions

_new StyleBox _new(): Construct a new instance of StyleBox. Note: use memnew!StyleBox instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

StyleBox

Members

Aliases

Functions

Mixins

Properties

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

StyleBox

From mixin baseCasts

From `mixin baseCasts`