WidgetVBox Class
This class creates a single vertical column container.
WidgetVBox Class
Members
WidgetVBox (Gui gui, int x = 0, int y = 0)
Constructor. Creates a vertical box with given parameters.Arguments
- Gui gui - GUI, to which the new box will belong.
- int x - Horizontal space between the widgets in the box and between them and the box border. This is an optional parameter.
- int y - Vertical space between the widgets in the box and between them and the box border. This is an optional parameter.
int type ()
WidgetVBox type.Return value
WidgetVBox type identifier.WidgetVBox create (Widget widget)
WidgetVBox constructor.Arguments
- Widget widget - Widget smart pointer.
Return value
int getPaddingLeft ()
Returns the current left-side padding for the widget content.Return value
Left-side padding in pixels.void setSpace (int x, int y)
Sets a space between the widgets in the box and between them and the box border.Arguments
- int x - Horizontal space.
- int y - Vertical space.
vec4 getColor ()
Returns a color of the global color multiplier.Return value
A multiplier color.void setStencil (int stencil)
Sets a value indicating if a widget cuts off its children along its bounds. Everything that lies outside of them, is not rendered.Arguments
- int stencil - 1, to enable cutting; otherwise, 0.
void setColor (vec4 color)
Sets a color for the global color multiplier. The default is equivalent to #ffffff (white).Arguments
- vec4 color - A multiplier color.
void setPadding (int l, int r, int t, int b)
Sets widget paddings for all sides. Padding clears an area around the content of a widget (inside of it).Arguments
- int l - Left-side padding in pixels.
- int r - Right-side padding in pixels.
- int t - Top padding in pixels.
- int b - Bottom padding in pixels.
int getSpaceY ()
Returns the vertical space between the widgets in the box and between them and the box border.Return value
Vertical space.int getPaddingTop ()
Returns the current top padding for the widget content.Return value
Top padding in pixels.WidgetVBox getWidgetVBox ()
Returns a widget vbox pointer.Return value
WidgetVBox pointer.int getPaddingRight ()
Returns the current right-side padding for the widget content.Return value
Right-side padding in pixels.void setBackground (int background)
Sets a value indicating if a background texture should be rendered for the box.Arguments
- int background - 1 to render a background texture, 0 not to render.
int getPaddingBottom ()
Returns the current bottom padding for the widget content.Return value
Bottom padding in pixels.int getSpaceX ()
Returns the horizontal space between the widgets in the box and between them and the box border.Return value
Horizontal space.int getBackground ()
Returns a value indicating if a background texture is rendered for the box.Return value
1 if a background texture is rendered; otherwise, 0.int getStencil ()
Returns a value indicating if a widget cuts off its children along its set bounds. Everything that lies outside of them, is not rendered. This option works only if children have GUI_ALIGN_OVERLAP flag set (otherwise, they will expand the box widget bounds and no cutting will be done).Return value
1 if cutting is enabled; otherwise, 0.Last update: 2017-07-03
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)