Skip to content
reduz edited this page Apr 10, 2014 · 10 revisions

StyleBox

####Inherits: Resource ####Category: Core

Brief Description

Base class for dawing stylized boxes for the UI.

Member Functions

Description

StyleBox is Resource that provides an abstract base class for dawing stylized boxes for the UI. StyleBoxes are used for dawing 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.

Member Function Description

Test a position in a rectangle, return wether it pases the mask test.

  • void set_default_margin ( int margin, float offset )

Set the default offset "offset" of the margin "margin" (see MARGIN_* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded.

  • float get_default_margin ( int margin ) const

Return the default offset of the margin "margin" (see MARGIN_* enum) of a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded.

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.

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

Clone this wiki locally