Unigine::WidgetWindow Class
| Header: | #include <UnigineWidgets.h> |
| Inherits from: | Widget |
This class creates a titled window.
The object of this class looks as follows:
By default, the window created by means of this class consists of a single vertical column container and a drag area at the top.
The WidgetWindow class provides methods that allow editing the drag area. For example:
AppSystemLogic.cpp
Source code (C++)
#include "AppSystemLogic.h"
#include <UnigineWindowManager.h>
using namespace Unigine;
// EventConnections class instance to manage event subscriptions
EventConnections econnections;
EngineWindowViewportPtr window;
void on_close()
{
window.deleteLater();
}
int AppSystemLogic::init()
{
// borderless additional window
window = EngineWindowViewport::create(Math::ivec2(512, 256));
window->setBordersEnabled(false);
GuiPtr gui = window->getSelfGui();
// create window widget
WidgetWindowPtr widget_window = WidgetWindow::create(gui, "Borderless Window");
widget_window->setSizeable(false);
widget_window->setMoveable(false);
window->addChild(widget_window, Gui::ALIGN_EXPAND);
// add a close icon to the window
WidgetIconPtr close_icon = WidgetIcon::create(gui, "window_close.png");
close_icon->setPosition(10, -24);
close_icon->getEventClicked().connect(econnections, on_close);
widget_window->addChild(close_icon, Gui::ALIGN_OVERLAP | Gui::ALIGN_RIGHT | Gui::ALIGN_TOP);
// adjust the window's drag area so that it doesn't cross the close icon
widget_window->setDragAreaPadding(3, 30, 3, 0);
widget_window->setDragAreaBackground(1);
widget_window->setDragAreaBackgroundColor(Math::vec4(1.0f, 0.0f, 0.0f, 0.3f));
window->setPosition(Math::ivec2(100, 100));
window->show();
return 1;
}
int AppSystemLogic::shutdown()
{
// removing all event subscriptions
econnections.disconnectAll();
return 1;
}The window will be rendered as follows:
See Also#
- UnigineScript API sample <UnigineSDK>/data/samples/widgets/window_00
- C++ API sample <UnigineSDK>/source/samples/Api/Widgets/WidgetWindow
- C# API sample <UnigineSDK>/source/csharp/samples/Api/Widgets/WidgetWindow
WidgetWindow Class
Members
void setText ( const char * text ) #
Sets a new window title.
Arguments
- const char * text - The window title.
const char * getText() const#
Returns the current window title.
Return value
Current window title.void setTextAlign ( ) #
Sets a new alignment of the window title.
Arguments
- align - The one of the ALIGN_* pre-defined variables.
getTextAlign() const#
Returns the current alignment of the window title.
Return value
Current one of the ALIGN_* pre-defined variables.int getPaddingBottom() const#
Returns the current bottom padding for the widget content.
Return value
Current bottom padding in pixels.int getPaddingTop() const#
Returns the current top padding for the widget content.
Return value
Current top padding in pixels.int getPaddingRight() const#
Returns the current right-side padding for the widget content.
Return value
Current right-side padding in pixels.int getPaddingLeft() const#
Returns the current left-side padding for the widget content.
Return value
Current left-side padding in pixels.int getSpaceY() const#
Returns the current vertical space between the widgets in the window and between them and the window border.
Return value
Current vertical space.int getSpaceX() const#
Returns the current horizontal space between the widgets in the window and between them and the window border.
Return value
Current horizontal space.void setMaxHeight ( int height ) #
Sets a new maximum height value of the window.
Arguments
- int height - The maximum height value.
int getMaxHeight() const#
Returns the current maximum height value of the window.
Return value
Current maximum height value.void setMaxWidth ( int width ) #
Sets a new maximum width value of the window.
Arguments
- int width - The maximum width value.
int getMaxWidth() const#
Returns the current maximum width value of the window.
Return value
Current maximum width value.void setTransform ( const const Math::mat4 && transform ) #
Sets a new global widget transformation matrix.
Arguments
- const const Math::mat4 && transform - The transformation matrix.
const Math::mat4 & getTransform() const#
Returns the current global widget transformation matrix.
Return value
Current transformation matrix.void setColor ( ) #
Sets a new color for the global color multiplier. The default is equivalent to vec4(1,1,1,1) (white).
Arguments
- color - The multiplier color.
getColor() const#
Returns the current color for the global color multiplier. The default is equivalent to vec4(1,1,1,1) (white).
Return value
Current multiplier color.void setSnapDistance ( int distance ) #
Sets a new distance, at which the window snaps to another window or screen edge. The default is 0 (do not snap).
Arguments
- int distance - The distance in pixels.
int getSnapDistance() const#
Returns the current distance, at which the window snaps to another window or screen edge. The default is 0 (do not snap).
Return value
Current distance in pixels.void setFloatable ( bool floatable ) #
Sets a new value indicating if the window is animated when changing to the minimized state and back. By default this option is disabled.
Arguments
- bool floatable - Set true to enable animating the window; false - to disable it.
bool isFloatable() const#
Returns the current value indicating if the window is animated when changing to the minimized state and back. By default this option is disabled.
Return value
true if animating the window is enabled; otherwise false.void setBlendable ( bool blendable ) #
Sets a new value indicating if the window can fade in and out when changing to the minimized state and back. By default this option is disabled.
Arguments
- bool blendable - Set true to enable the window ability to fade in and out; false - to disable it.
bool isBlendable() const#
Returns the current value indicating if the window can fade in and out when changing to the minimized state and back. By default this option is disabled.
Return value
true if the window ability to fade in and out is enabled; otherwise false.void setTitleable ( bool titleable ) #
Sets a new value indicating if the window is minimized when double-clicking on it. By default this option is disabled.
Arguments
- bool titleable - Set true to enable the window minimization on double click; false - to disable it.
bool isTitleable() const#
Returns the current value indicating if the window is minimized when double-clicking on it. By default this option is disabled.
Return value
true if the window minimization on double click is enabled; otherwise false.void setSizeable ( bool sizeable ) #
Sets a new value indicating if the window is resizeable. By default this option is disabled.
Arguments
- bool sizeable - Set true to enable the ability to resize the window; false - to disable it.
bool isSizeable() const#
Returns the current value indicating if the window is resizeable. By default this option is disabled.
Return value
true if the ability to resize the window is enabled; otherwise false.void setMoveable ( bool moveable ) #
Sets a new value indicating if the window is movable. By default this option is disabled.
Arguments
- bool moveable - Set true to enable the ability to move the window; false - to disable it.
bool isMoveable() const#
Returns the current value indicating if the window is movable. By default this option is disabled.
Return value
true if the ability to move the window is enabled; otherwise false.void setBorderColor ( ) #
Sets a new border color for the widget.
Arguments
- color - The four-component vector specifying the color in the RGBA format.
getBorderColor() const#
Returns the current border color for the widget.
Return value
Current four-component vector specifying the color in the RGBA format.void setBackgroundColor ( ) #
Sets a new background color used for the widget.
Arguments
- color - The four-component vector specifying the color in the RGBA format.
getBackgroundColor() const#
Returns the current background color used for the widget.
Return value
Current four-component vector specifying the color in the RGBA format.void setDragAreaEnabled ( bool enabled ) #
Sets a new value indicating if the drag area of the window is enabled.
Arguments
- bool enabled - Set true to enable the drag area; false - to disable it.
bool isDragAreaEnabled() const#
Returns the current value indicating if the drag area of the window is enabled.
Return value
true if the drag area is enabled; otherwise false.int getDragAreaPaddingTop() const#
Returns the current top padding for the drag area.
Return value
Current top padding in pixels.int getDragAreaPaddingRight() const#
Returns the current right-side padding for the drag area.
Return value
Current right-side padding in pixels.void setDragAreaBackgroundColor ( const Math::vec4& color ) #
Sets a new color for the background of the drag area.
Arguments
- const Math::vec4& color - The background color.
Math::vec4 getDragAreaBackgroundColor() const#
Returns the current color for the background of the drag area.
Return value
Current background color.void setDragAreaBackground ( int background ) #
Sets a new value indicating if background rendering is enabled or disabled for the drag area.
Arguments
- int background - The value indicating if rendering of the background is enabled (1 if rendering is enabled; otherwise, 0).
int getDragAreaBackground() const#
Returns the current value indicating if background rendering is enabled or disabled for the drag area.
Return value
Current value indicating if rendering of the background is enabled (1 if rendering is enabled; otherwise, 0).int getDragAreaPaddingLeft() const#
Returns the current left-side padding for the drag area.
Return value
Current left-side padding in pixels.int getDragAreaPaddingBottom() const#
Returns the current bottom padding for the drag area.
Return value
Current bottom padding in pixels.void setGlobalMovement ( bool movement ) #
Sets a new value specifying if the window can be moved across the whole GUI or only within the parent widget. By default, this option is set to false, and the window can be moved only relevant to its parent.
Arguments
- bool movement - Set true to enable moving the window across the whole GUI; false - to disable it.
bool isGlobalMovement() const#
Returns the current value specifying if the window can be moved across the whole GUI or only within the parent widget. By default, this option is set to false, and the window can be moved only relevant to its parent.
Return value
true if moving the window across the whole GUI is enabled; otherwise false.int getMinTextureWidth() const#
Returns the current minimum width of the window render — the width of the window texture from the GUI skin.
Return value
Current minimum width of the window render, in pixels.int getTextWidth() const#
Returns the current window header width.
Return value
Current window header width, in pixels.int getTextHeight() const#
Returns the current window header height.
Return value
Current window header height, in pixels.void setOutBoundsCallbacksEnabled ( bool enabled ) #
Sets a new value specifying if the callback processing for the window child widgets is enabled when the cursor is outside the window.
Arguments
- bool enabled - Set true to enable callback processing for the child widgets if the cursor is outside the window; false - to disable it.
bool isOutBoundsCallbacksEnabled() const#
Returns the current value specifying if the callback processing for the window child widgets is enabled when the cursor is outside the window.
Return value
true if callback processing for the child widgets if the cursor is outside the window is enabled; otherwise false.int getMinTextureHeight() const#
Returns the current minimum height of the window render — the height of the window texture from the GUI skin.
Return value
Current minimum height of the window render, in pixels.void setStencil ( int stencil ) #
Sets a new 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 ALIGN_OVERLAP flag set (otherwise, they will expand the box widget bounds and no cutting will be done).
Arguments
- int stencil - The 1 if cutting is enabled; otherwise, 0.
int getStencil() const#
Returns the current 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 ALIGN_OVERLAP flag set (otherwise, they will expand the box widget bounds and no cutting will be done).
Return value
Current 1 if cutting is enabled; otherwise, 0.static WidgetWindowPtr create ( const Ptr<Gui> & gui, const char * str = 0, int x = 0, int y = 0 ) #
Constructor. Creates a window with given parameters and adds it to the specified GUI.Arguments
- const Ptr<Gui> & gui - GUI, to which the new window will belong.
- const char * 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.
static WidgetWindowPtr create ( const char * str = 0, int x = 0, int y = 0 ) #
Constructor. Creates a window with given parameters and adds it to the Engine GUI.Arguments
- const char * 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.
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.
void setSpace ( int x, int y ) #
Sets a space between the widgets in the window and between them and the window border.Arguments
- int x - Horizontal space. If a negative value is provided, 0 will be used instead.
- int y - Vertical space. If a negative value is provided, 0 will be used instead.
void setDragAreaPadding ( int l, int r, int t, int b ) #
Sets paddings for all sides of the drag area.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.
The information on this page is valid for UNIGINE 2.20 SDK.
Last update:
2025-05-19
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)