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.

@GodotBaseClass

struct StyleBox {

enum string _GODOT_internal_name;

union __anonymous;

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

bool opEquals(StyleBox other);

StyleBox opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static StyleBox _new();

bool testMask(Vector2 point, Rect2 rect);

void setDefaultMargin(long margin, double offset);

double getDefaultMargin(long margin);

double getMargin(long margin);

Vector2 getMinimumSize();

Vector2 getCenterSize();

Vector2 getOffset();

void draw(RID canvas_item, Rect2 rect);

double contentMarginLeft [@property getter];

double contentMarginLeft [@property setter];

double contentMarginRight [@property getter];

double contentMarginRight [@property setter];

double contentMarginTop [@property getter];

double contentMarginTop [@property setter];

double contentMarginBottom [@property getter];

double contentMarginBottom [@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)
getCenterSize Vector2 getCenterSize()
getDefaultMargin double getDefaultMargin(long margin)
getMargin double getMargin(long margin): Return the offset of margin "margin" (see MARGIN_* enum).
getMinimumSize Vector2 getMinimumSize(): Return the minimum size that this stylebox can be shrunk to.
getOffset 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)).
opAssign StyleBox opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(StyleBox other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
setDefaultMargin void setDefaultMargin(long margin, double offset)
testMask bool testMask(Vector2 point, Rect2 rect): Test a position in a rectangle, return whether it passes the mask test.

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

contentMarginBottom double contentMarginBottom [@property setter]
contentMarginBottom double contentMarginBottom [@property getter]
contentMarginLeft double contentMarginLeft [@property getter]
double contentMarginLeft [@property setter]
contentMarginRight double contentMarginRight [@property getter]
double contentMarginRight [@property setter]
contentMarginTop double contentMarginTop [@property getter]
double contentMarginTop [@property setter]

Static functions

_new StyleBox _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: 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 To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as 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`