TGUI  0.9-dev

Child window widget. More...

#include <TGUI/Widgets/ChildWindow.hpp>

Inheritance diagram for tgui::ChildWindow:
tgui::Container tgui::Widget tgui::MessageBox

Public Types

enum  TitleAlignment { TitleAlignment::Left, TitleAlignment::Center, TitleAlignment::Right }
 Title alignments, possible options for the setTitleAlignment function. More...
 
enum  TitleButton { None = 0, Close = 1 << 0, Maximize = 1 << 1, Minimize = 1 << 2 }
 Title buttons (use bitwise OR to combine) More...
 
typedef std::shared_ptr< ChildWindowPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ChildWindowConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Container
typedef std::shared_ptr< ContainerPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ContainerConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

ChildWindowRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
ChildWindowRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setPosition (const Layout2d &position) override
 Sets the position of the widget. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the child window. More...
 
void setClientSize (Vector2f size)
 Changes the client size of the child window. More...
 
Vector2f getClientSize () const
 Returns the client size of the child window. More...
 
void setMaximumSize (Vector2f size)
 Sets the maximum size of the child window. More...
 
Vector2f getMaximumSize () const
 Returns the maximum size of the child window. More...
 
void setMinimumSize (Vector2f size)
 Sets the minimum size of the child window. More...
 
Vector2f getMinimumSize () const
 Returns the minimum size of the child window. More...
 
void setTitle (const String &title)
 Changes the title that is displayed in the title bar of the child window. More...
 
const StringgetTitle () const
 Returns the title that is displayed in the title bar of the child window. More...
 
void setTitleTextSize (unsigned int size)
 Changes the character size of the title. More...
 
unsigned int getTitleTextSize () const
 Returns the character size of the title. More...
 
void setTitleAlignment (TitleAlignment alignment)
 Changes the title alignment. More...
 
TitleAlignment getTitleAlignment () const
 Returns the title alignment. More...
 
void setTitleButtons (unsigned int buttons)
 Changes the title buttons. More...
 
unsigned int getTitleButtons () const
 Returns the title bar buttons. More...
 
void close ()
 Try to close the window. More...
 
void destroy ()
 Destroys the window. More...
 
void setResizable (bool resizable=true)
 Changes whether the child window can be resized by dragging its borders or not. More...
 
bool isResizable () const
 Checks whether the child window can be resized by dragging its borders or not. More...
 
void setPositionLocked (bool positionLocked=true)
 Changes whether the child window can be moved by dragging its title bar or not. More...
 
bool isPositionLocked () const
 Checks whether the child window can be moved by dragging its title bar or not. More...
 
void setKeepInParent (bool enabled=true)
 Sets the child window to be kept inside its parent. More...
 
bool isKeptInParent () const
 Tells whether the child window is kept inside its parent. More...
 
Vector2f getChildWidgetsOffset () const override
 Returns the distance between the position of the container and a widget that would be drawn inside this container on relative position (0,0). More...
 
bool mouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::Container
 Container (const Container &copy)
 Copy constructor.
 
 Container (Container &&copy)
 Move constructor.
 
 ~Container ()
 Destructor.
 
Containeroperator= (const Container &right)
 Overload of copy assignment operator.
 
Containeroperator= (Container &&right)
 Overload of move assignment operator.
 
const std::vector< Widget::Ptr > & getWidgets () const
 Returns a list of all the widgets in this container. More...
 
virtual void add (const Widget::Ptr &widgetPtr, const String &widgetName="")
 Adds a widget to the container. More...
 
Widget::Ptr get (const String &widgetName) const
 Returns a pointer to a widget that was added earlier. More...
 
template<class T >
T::Ptr get (const String &widgetName) const
 Returns a pointer to a widget that was added earlier. More...
 
virtual bool remove (const Widget::Ptr &widget)
 Removes a single widget that was added to the container. More...
 
virtual void removeAllWidgets ()
 Removes all widgets that were added to the container. More...
 
void uncheckRadioButtons ()
 Unchecks all the radio buttons. More...
 
virtual Vector2f getInnerSize () const
 Returns the space available for widgets inside the container. More...
 
void setTextSize (unsigned int size) override
 Changes the character size of all existing and future child widgets. More...
 
void loadWidgetsFromFile (const String &filename, bool replaceExisting=true)
 Loads the child widgets from a text file. More...
 
void saveWidgetsToFile (const String &filename)
 Saves the child widgets to a text file. More...
 
void loadWidgetsFromStream (std::stringstream &stream, bool replaceExisting=true)
 Loads the child widgets from a string stream. More...
 
void loadWidgetsFromStream (std::stringstream &&stream, bool replaceExisting=true)
 Loads the child widgets from a string stream. More...
 
void saveWidgetsToStream (std::stringstream &stream) const
 Saves the child widgets to a text file. More...
 
void moveWidgetToFront (const Widget::Ptr &widget)
 Places a widget before all other widgets. More...
 
void moveWidgetToBack (const Widget::Ptr &widget)
 Places a widget behind all other widgets. More...
 
bool focusNextWidget ()
 Focuses the next widget in this container. More...
 
bool focusPreviousWidget ()
 Focuses the previous widget in this container. More...
 
void setFocused (bool focused) override
 Focus or unfocus the widget. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
void showWithEffect (ShowAnimationType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowAnimationType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const StringgetWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
 
void moveToFront ()
 Places the widget before all other widgets. More...
 
void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
virtual unsigned int getTextSize () const
 Returns the character size of text in this widget. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
void setWidgetName (const String &name)
 Changes the name of a widget. More...
 
String getWidgetName () const
 Returns the name of a widget. More...
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused. More...
 
bool isFocusable () const
 Returns whether a widget could be focused. More...
 
virtual bool canGainFocus () const
 Returns whether the widget can currently gain focus. More...
 
bool isContainer () const
 Returns whether the widget is a container widget or not. More...
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 

Static Public Member Functions

static ChildWindow::Ptr create (const String &title="", unsigned int titleButtons=TitleButton::Close)
 Creates a new child window widget. More...
 
static ChildWindow::Ptr copy (ChildWindow::ConstPtr childWindow)
 Makes a copy of another child window. More...
 

Public Attributes

Signal onMousePress = {"MousePressed"}
 The mouse went down on the widget.
 
SignalChildWindow onClose = {"Closed"}
 The window was closed. Optional parameter: pointer to the window.
 
SignalChildWindow onMinimize = {"Minimized"}
 The window was minimized. Optional parameter: pointer to the window.
 
SignalChildWindow onMaximize = {"Maximized"}
 The window was maximized. Optional parameter: pointer to the window.
 
SignalChildWindow onEscapeKeyPress = {"EscapeKeyPressed"}
 The escape key was pressed while the child window was focused. Optional parameter: pointer to the window.
 
- Public Attributes inherited from tgui::Widget
SignalVector2f onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalVector2f onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
Signal onFocus = {"Focused"}
 The widget was focused.
 
Signal onUnfocus = {"Unfocused"}
 The widget was unfocused.
 
Signal onMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
Signal onMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 
SignalAnimation onAnimationFinish = {"AnimationFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 

Protected Member Functions

SignalgetSignal (String signalName) override
 Retrieves a signal based on its name. More...
 
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed. More...
 
std::unique_ptr< DataIO::Node > save (SavingRenderersMap &renderers) const override
 Saves the widget as a tree node in order to save it to a file.
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes.
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
- Protected Member Functions inherited from tgui::Widget
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget.
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget.
 

Detailed Description

Child window widget.

Member Enumeration Documentation

◆ TitleAlignment

Title alignments, possible options for the setTitleAlignment function.

Enumerator
Left 

Places the title on the left side of the title bar.

Center 

Places the title in the middle of the title bar.

Right 

Places the title on the right side of the title bar.

◆ TitleButton

Title buttons (use bitwise OR to combine)

Enumerator
None 

No buttons.

Close 

Include a close button.

Maximize 

Include a maximize button.

Minimize 

Include a minimize button.

Member Function Documentation

◆ clone()

Widget::Ptr tgui::ChildWindow::clone ( ) const
inlineoverrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns
Copy of the widget

Implements tgui::Widget.

Reimplemented in tgui::MessageBox.

◆ close()

void tgui::ChildWindow::close ( )

Try to close the window.

This will trigger the Closed signal. If no callback is requested then the window will be closed.

◆ copy()

static ChildWindow::Ptr tgui::ChildWindow::copy ( ChildWindow::ConstPtr  childWindow)
static

Makes a copy of another child window.

Parameters
childWindowThe other child window
Returns
The new child window

◆ create()

static ChildWindow::Ptr tgui::ChildWindow::create ( const String title = "",
unsigned int  titleButtons = TitleButton::Close 
)
static

Creates a new child window widget.

Returns
The new child window

◆ destroy()

void tgui::ChildWindow::destroy ( )

Destroys the window.

When no callback is requested when closing the window, this function will be called automatically.

When you requested a callback on close then you get the opportunity to cancel the closing of the window. If you want to keep it open then don't do anything, if you want to close it then just call this function.

◆ draw()

void tgui::ChildWindow::draw ( sf::RenderTarget &  target,
sf::RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Reimplemented from tgui::Container.

◆ getChildWidgetsOffset()

Vector2f tgui::ChildWindow::getChildWidgetsOffset ( ) const
overridevirtual

Returns the distance between the position of the container and a widget that would be drawn inside this container on relative position (0,0).

Returns
Offset of the widgets in the container

Reimplemented from tgui::Container.

◆ getClientSize()

Vector2f tgui::ChildWindow::getClientSize ( ) const

Returns the client size of the child window.

Returns
Size of the child window contents

This sets the size of the child window excluding the title bar and the borders.

◆ getMaximumSize()

Vector2f tgui::ChildWindow::getMaximumSize ( ) const

Returns the maximum size of the child window.

Returns
Maximum size of the child window

This size includes the title bar and the borders.

◆ getMinimumSize()

Vector2f tgui::ChildWindow::getMinimumSize ( ) const

Returns the minimum size of the child window.

Returns
Minimum size of the child window

This size includes the title bar and the borders.

◆ getRenderer()

ChildWindowRenderer* tgui::ChildWindow::getRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer
Warning
After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getSharedRenderer()

ChildWindowRenderer* tgui::ChildWindow::getSharedRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ getSignal()

Signal& tgui::ChildWindow::getSignal ( String  signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::Widget.

Reimplemented in tgui::MessageBox.

◆ getTitle()

const String& tgui::ChildWindow::getTitle ( ) const

Returns the title that is displayed in the title bar of the child window.

Returns
Title of the child window

◆ getTitleAlignment()

TitleAlignment tgui::ChildWindow::getTitleAlignment ( ) const

Returns the title alignment.

Returns
How the title is aligned in the title bar

◆ getTitleButtons()

unsigned int tgui::ChildWindow::getTitleButtons ( ) const

Returns the title bar buttons.

Returns
Which buttons are available in the title bar

◆ getTitleTextSize()

unsigned int tgui::ChildWindow::getTitleTextSize ( ) const

Returns the character size of the title.

Returns
The current title text size

◆ isKeptInParent()

bool tgui::ChildWindow::isKeptInParent ( ) const

Tells whether the child window is kept inside its parent.

Returns
When it's set to true, the child window will always be kept automatically inside its parent. It's set to false by default.

◆ isPositionLocked()

bool tgui::ChildWindow::isPositionLocked ( ) const

Checks whether the child window can be moved by dragging its title bar or not.

Returns
Is the child window frozen at its current position?

◆ isResizable()

bool tgui::ChildWindow::isResizable ( ) const

Checks whether the child window can be resized by dragging its borders or not.

Returns
Can the user change the size of the window by dragging one of the borders?

◆ mouseOnWidget()

bool tgui::ChildWindow::mouseOnWidget ( Vector2f  pos) const
overridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns
Is the mouse on top of the widget?

Implements tgui::Widget.

◆ rendererChanged()

void tgui::ChildWindow::rendererChanged ( const String property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyLowercase name of the property that was changed

Reimplemented from tgui::Container.

Reimplemented in tgui::MessageBox.

◆ setClientSize()

void tgui::ChildWindow::setClientSize ( Vector2f  size)

Changes the client size of the child window.

Parameters
sizeNew size of the child window contents

This sets the size of the child window excluding the title bar and the borders.

◆ setKeepInParent()

void tgui::ChildWindow::setKeepInParent ( bool  enabled = true)

Sets the child window to be kept inside its parent.

Parameters
enabledWhen it's set to true, the child window will always be kept automatically inside its parent. It's set to false by default.

◆ setMaximumSize()

void tgui::ChildWindow::setMaximumSize ( Vector2f  size)

Sets the maximum size of the child window.

Parameters
sizeSets the new maximum size of the child window

This function sets the maximum size of the entire window, including borders and titlebar. If the window is larger than the new maximum size, it will automatically be shrunk.

◆ setMinimumSize()

void tgui::ChildWindow::setMinimumSize ( Vector2f  size)

Sets the minimum size of the child window.

Parameters
sizeSets the new minimum size of the child window

This function sets the minimum size of the entire window, including borders and titlebar. If the window is smaller than the new minimum size, it will automatically be enlarged.

◆ setPosition() [1/3]

virtual void tgui::Widget::setPosition

sets the position of the widget

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters
positionNew position
See also
move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition({40, 30});
// Place the widget relative to the size of its parent
widget->setPosition({"5%", "10%"});
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition({tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50});

◆ setPosition() [2/3]

void tgui::ChildWindow::setPosition ( const Layout2d position)
overridevirtual

Sets the position of the widget.

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters
positionNew position
See also
move, getPosition

Reimplemented from tgui::Widget.

◆ setPosition() [3/3]

void tgui::Widget::setPosition
inline

Sets the position of the widget.

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters
xNew x coordinate
yNew y coordinate
Warning
This setPosition overload must never be used from internal TGUI code or by custom widget implementations

◆ setPositionLocked()

void tgui::ChildWindow::setPositionLocked ( bool  positionLocked = true)

Changes whether the child window can be moved by dragging its title bar or not.

Parameters
positionLockedIs the child window frozen at its current position?

Locking the position only affects user interaction, the setPosition function will still move the window.

◆ setResizable()

void tgui::ChildWindow::setResizable ( bool  resizable = true)

Changes whether the child window can be resized by dragging its borders or not.

Parameters
resizableCan the user change the size of the window by dragging one of the borders?

◆ setSize() [1/3]

virtual void tgui::Widget::setSize

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});

◆ setSize() [2/3]

void tgui::ChildWindow::setSize ( const Layout2d size)
overridevirtual

Changes the size of the child window.

Parameters
sizeSets the new size of the child window

This is the size of the entire child window, including the title bar and the borders. To set the size of the contents of the window (exluding the title bar and borders), use setClientSize instead.

Reimplemented from tgui::Container.

◆ setSize() [3/3]

void tgui::Widget::setSize
inline

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setTitle()

void tgui::ChildWindow::setTitle ( const String title)

Changes the title that is displayed in the title bar of the child window.

Parameters
titleNew title for the child window

◆ setTitleAlignment()

void tgui::ChildWindow::setTitleAlignment ( TitleAlignment  alignment)

Changes the title alignment.

Parameters
alignmentHow should the title be aligned in the title bar?

◆ setTitleButtons()

void tgui::ChildWindow::setTitleButtons ( unsigned int  buttons)

Changes the title buttons.

Parameters
buttonsWhich buttons should be available in the title bar?

By default ChildWindows only display a close button. The following example gives the ChildWindow both a minimize and close button.

childWindow->setTitleButtons(ChildWindow::TitleButtons::Minimize | ChildWindow::TitleButtons::Close);

◆ setTitleTextSize()

void tgui::ChildWindow::setTitleTextSize ( unsigned int  size)

Changes the character size of the title.

Parameters
sizeThe new title text size. If the size is set to 0 then the character size is determined by the height of the title bar.

The documentation for this class was generated from the following file:
TGUI_API Layout bindHeight(Gui &gui)
Bind to the height of the gui view.
TGUI_API Layout bindLeft(std::shared_ptr< Widget > widget)
Bind to the x position of the widget.
TGUI_API Layout bindBottom(std::shared_ptr< Widget > widget)
Bind to the bottom of the widget.