Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins

WidgetWindow Class

This class creates a titled window.

WidgetWindow Class

This class inherits from Widget

Members


WidgetWindow (Gui gui, string str = 0, int x = 0, int y = 0)

Constructor. Creates a window with given parameters.

Arguments

  • Gui gui - GUI, to which the new window will belong.
  • string str - Window title. This is an optional parameter.
  • int x - Horizontal space between the widgets in the window and between them and the window border. This is an optional parameter.
  • int y - Vertical space between the widgets in the window and between them and the window border. This is an optional parameter.

vec4 getColor ()

Returns a color of the global color multiplier.

Return value

A multiplier color.

int getMaxHeight ()

Returns the maximum height value of the window.

Return value

Maximum height value.

int getMaxWidth ()

Returns the maximum width value of the window.

Return value

Maximum width value.

int getPaddingBottom ()

Returns the current bottom padding for the widget content.

Return value

Bottom padding in pixels.

int getPaddingLeft ()

Returns the current left-side padding for the widget content.

Return value

Left-side padding in pixels.

int getPaddingRight ()

Returns the current right-side padding for the widget content.

Return value

Right-side padding in pixels.

int getPaddingTop ()

Returns the current top padding for the widget content.

Return value

Top padding in pixels.

int getSnapDistance ()

Returns the distance, at which the window snaps to another window or screen edge.

Return value

Distance in pixels.

int getSpaceX ()

Returns the horizontal space between the widgets in the window and between them and the window border.

Return value

Horizontal space.

int getSpaceY ()

Returns the vertical space between the widgets in the window and between them and the window border.

Return value

Vertical space.

int getTextAlign ()

Returns the alignment of the window title.

Return value

One of the GUI_ALIGN_* pre-defined variables.

string getText ()

Returns the window title.

Return value

Window title.

mat4 getTransform ()

Returns the global widget transformation matrix.

Return value

Transformation matrix.

int isBlendable ()

Returns a value indicating if the window can fade in and out when changing to the minimized state and back.

Return value

1 if the window can fade in and out; otherwise, 0.

int isFloatable ()

Returns a value indicating if the window is animated when changing to the minimized state and back.

Return value

1 if the window is animated; otherwise, 0.

int isMoveable ()

Returns a value indicating if the window is movable.

Return value

1 if the window is movable; otherwise, 0.

int isSizeable ()

Returns a value indicating if the window is resizeable.

Return value

1 if the window is resizeable; otherwise, 0.

int isTitleable ()

Returns a value indicating if the window is minimized when double-clicking on it.

Return value

1 if the window is minimized when double-clicking on it; otherwise, 0.

void setBlendable (int mode)

Sets a value indicating if the window can fade in and out when changing to the minimized state and back.

Arguments

  • int mode - 1 to allow fading in and out, 0 to disallow it.

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 setFloatable (int mode)

Sets a value indicating if the window is animated when changing to the minimized state and back.

Arguments

  • int mode - 1 to allow animating the window, 0 not to make it.

void setMaxHeight (int height)

Sets the maximum height value for the window.

Arguments

  • int height - Maximum height value.

void setMaxWidth (int width)

Sets the maximum width value for the window.

Arguments

  • int width - Maximum width value.

void setMoveable (int mode)

Sets a value indicating if the window is movable.

Arguments

  • int mode - 1 to allow moving the window, 0 to disallow it.

void setPadding (int left, int right, int top, int bottom)

Sets widget paddings for all sides. Padding clears an area around the content of a widget (inside of it).

Arguments

  • int left - Left-side padding in pixels.
  • int right - Right-side padding in pixels.
  • int top - Top padding in pixels.
  • int bottom - Bottom padding in pixels.

void setSizeable (int mode)

Sets a value indicating if the window is resizeable.

Arguments

  • int mode - 1 to allow resizing the window, 0 to disallow it.

void setSnapDistance (int distance)

Sets a distance, at which the window snaps to another window or screen edge.

Arguments

  • int distance - Distance in pixels.

void setSpace (int space_x, int space_y)

Sets a space between the widgets in the window and between them and the window border.

Arguments

  • int space_x - Horizontal space. If a negative value is provided, 0 will be used instead.
  • int space_y - Vertical space. If a negative value is provided, 0 will be used instead.

void setTextAlign (int alignment)

Sets alignment of the window title.

Arguments

void setText (string title)

Sets a window title.

Arguments

  • string title - Window title.

void setTitleable (int mode)

Sets a value indicating if the window is minimized when double-clicking on it.

Arguments

  • int mode - 1 to allow minimization, 0 to disallow it.

void setTransform (mat4 transform)

Sets the global widget transformation matrix. This 2D matrix can be tilted, rotated, moved or modified in many ways in 3D space.

Arguments

  • mat4 transform - Transformation matrix.
Last update: 2017-07-03