StyleBox¶
Inherits: Resource < Reference < Object
Inherited By: StyleBoxLine, StyleBoxFlat, StyleBoxTexture, StyleBoxEmpty
Category: Core
Brief Description¶
Base class for drawing stylized boxes for the UI.
Properties¶
| float | content_margin_bottom |
| float | content_margin_left |
| float | content_margin_right |
| float | content_margin_top |
Methods¶
| void | draw ( RID canvas_item, Rect2 rect ) const |
| Vector2 | get_center_size ( ) const |
| float | get_margin ( Margin margin ) const |
| Vector2 | get_minimum_size ( ) const |
| Vector2 | get_offset ( ) const |
| bool | test_mask ( Vector2 point, Rect2 rect ) const |
Description¶
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.
Property Descriptions¶
- float content_margin_bottom
| Setter | set_default_margin(value) |
| Getter | get_default_margin() |
- float content_margin_left
| Setter | set_default_margin(value) |
| Getter | get_default_margin() |
- float content_margin_right
| Setter | set_default_margin(value) |
| Getter | get_default_margin() |
- float content_margin_top
| Setter | set_default_margin(value) |
| Getter | get_default_margin() |
Method Descriptions¶
- Vector2 get_center_size ( ) const
Return the offset of margin “margin” (see MARGIN_* enum).
- Vector2 get_minimum_size ( ) const
Return the minimum size that this stylebox can be shrunk to.
- Vector2 get_offset ( ) const
Return the “offset” of a stylebox, this is a helper function, like writing Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP)).
Test a position in a rectangle, return whether it passes the mask test.