TGUI  0.7.4

Panel widget. More...

#include <Panel.hpp>

Inheritance diagram for tgui::Panel:
tgui::Container tgui::Widget tgui::Transformable tgui::SignalWidgetBase tgui::BoxLayout tgui::HorizontalLayout tgui::VerticalLayout

Public Types

typedef std::shared_ptr< PanelPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const PanelConstPtr
 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

 Panel (const Layout2d &size={100, 100})
 Default constructor. More...
 
 Panel (const Layout &width, const Layout &height)
 Constructor. More...
 
std::shared_ptr< PanelRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setBackgroundColor (const Color &backgroundColor)
 Changes the background color of the panel. More...
 
const sf::Color & getBackgroundColor () const
 Returns the background color of the panel. More...
 
- Public Member Functions inherited from tgui::Container
 Container (const Container &copy)
 Copy constructor. More...
 
Containeroperator= (const Container &right)
 Overload of assignment operator. More...
 
virtual void setFont (const Font &font) override
 Changes the font of the text in the widget and its children. More...
 
const std::vector< Widget::Ptr > & getWidgets ()
 Returns a list of all the widgets. More...
 
const std::vector< sf::String > & getWidgetNames ()
 Returns a list of the names of all the widgets. More...
 
virtual void add (const Widget::Ptr &widgetPtr, const sf::String &widgetName="")
 Adds a widget to the container. More...
 
Widget::Ptr get (const sf::String &widgetName, bool recursive=false) const
 Returns a pointer to an earlier created widget. More...
 
template<class T >
T::Ptr get (const sf::String &widgetName, bool recursive=false) const
 Returns a pointer to an earlier created widget. 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.
 
bool setWidgetName (const Widget::Ptr &widget, const std::string &name)
 Changes the name of a widget. More...
 
std::string getWidgetName (const Widget::Ptr &widget) const
 Returns the name of a widget. More...
 
void focusWidget (const Widget::Ptr &widget)
 Focuses a widget. More...
 
void focusWidget (Widget *const widget)
 Focuses a widget. More...
 
void focusNextWidget ()
 Focuses the next widget. More...
 
void focusPreviousWidget ()
 Focuses the previous widget. More...
 
void unfocusWidgets ()
 Unfocus all the widgets.
 
void uncheckRadioButtons ()
 Uncheck all the radio buttons.
 
virtual void setOpacity (float opacity) override
 Changes the opacity of the container and all its child widgets. More...
 
virtual sf::Vector2f getChildWidgetsOffset () const
 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...
 
void loadWidgetsFromFile (const std::string &filename)
 Load the child widgets from a text file. More...
 
void saveWidgetsToFile (const std::string &filename)
 Save the child widgets to a text file. More...
 
void loadWidgetsFromStream (std::stringstream &stream)
 Load the child widgets from a string stream. More...
 
void saveWidgetsToStream (std::stringstream &stream)
 Save the child widgets to a text file. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &copy)
 Copy constructor. More...
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &right)
 Overload of assignment operator. More...
 
std::shared_ptr< WidgetRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position) override
 set the position of the widget More...
 
virtual void setSize (const Layout2d &size) override
 Changes the size of the widget. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual void show ()
 Shows the widget. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hide ()
 Hides the widget. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void enable ()
 Enables the widget. More...
 
virtual void disable (bool blockMouseEvents=true)
 Disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void focus ()
 Focus the widget. More...
 
virtual void unfocus ()
 Unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const std::string & getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets.
 
virtual void moveToBack ()
 Places the widget behind all other widgets.
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip ()
 Returns the tool tip that is displayed when hovering over the widget. More...
 
std::shared_ptr< sf::Font > getFont () const
 Returns the font associated with the widget (if any) More...
 
void detachTheme ()
 Detach the theme from the widget. More...
 
std::shared_ptr< BaseThemegetTheme () const
 Returns the theme to which the widget is currently connected. More...
 
std::string getPrimaryLoadingParameter () const
 Returns the primary parameter that was passed to the loader to load this widget. More...
 
std::string getSecondaryLoadingParameter () const
 Returns the secondary parameter that was passed to the loader to load this widget. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
- Public Member Functions inherited from tgui::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 set the position of the widget More...
 
sf::Vector2f getPosition () const
 get the position of the widget More...
 
void move (const Layout2d &offset)
 Move the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Move the widget by a given offset. More...
 
void setSize (const Layout &width, const Layout &height)
 Changes the size of the widget. More...
 
virtual sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual sf::Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
void scale (const Layout2d &factors)
 Scale the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scale the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
 SignalWidgetBase ()=default
 Default constructor.
 
 SignalWidgetBase (const SignalWidgetBase &copy)
 Copy constructor. More...
 
SignalWidgetBaseoperator= (const SignalWidgetBase &right)
 Overload of assignment operator. More...
 
template<typename Func , typename... Args>
unsigned int connect (const std::string &signalNames, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
template<typename Func , typename... Args>
unsigned int connectEx (const std::string &signalName, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
void disconnect (unsigned int id)
 Disconnects a connection. More...
 
void disconnectAll (const std::string &signalName)
 Disconnect all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnect all connections from a all signals.
 

Static Public Member Functions

static Panel::Ptr create (Layout2d size={100, 100})
 Creates a new panel widget. More...
 
static Panel::Ptr copy (Panel::ConstPtr panel)
 Makes a copy of another panel. More...
 

Protected Member Functions

virtual 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::Container
void moveWidgetToFront (Widget *const widget)
 Places a widget before all other widgets. More...
 
void moveWidgetToBack (Widget *const widget)
 Places a widget behind all other widgets. More...
 
- Protected Member Functions inherited from tgui::Widget
void attachTheme (std::shared_ptr< BaseTheme > theme)
 Attach a theme to the widget. More...
 
virtual void reload (const std::string &primary="", const std::string &secondary="", bool force=false)
 Reload the widget. More...
 

Detailed Description

Panel widget.

The panel is a static container of widgets. The background color can be solid or transparent. It can be used for having radio button groups or any other reason to group certain widgets.

Signals:

  • MousePressed (the left mouse button was pressed on top of the panel)
    • Optional parameter sf::Vector2f: Mouse position relative to the panel position
    • Uses Callback member 'mouse'
  • MouseReleased (the left mouse button was released on top of the panel)
    • Optional parameter sf::Vector2f: Mouse position relative to the panel position
    • Uses Callback member 'mouse'
  • Clicked (you left clicked the panel)
    • Optional parameter sf::Vector2f: Mouse position relative to the panel position
    • Uses Callback member 'mouse'
  • Inherited signals from Container

Constructor & Destructor Documentation

◆ Panel() [1/2]

tgui::Panel::Panel ( const Layout2d size = {100, 100})

Default constructor.

Parameters
sizeSize of the panel

◆ Panel() [2/2]

tgui::Panel::Panel ( const Layout width,
const Layout height 
)

Constructor.

Parameters
widthWidth of the widget
heightHeight of the widget

Member Function Documentation

◆ clone()

virtual Widget::Ptr tgui::Panel::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::HorizontalLayout, and tgui::VerticalLayout.

◆ copy()

static Panel::Ptr tgui::Panel::copy ( Panel::ConstPtr  panel)
static

Makes a copy of another panel.

Parameters
panelThe other panel
Returns
The new panel

◆ create()

static Panel::Ptr tgui::Panel::create ( Layout2d  size = {100, 100})
static

Creates a new panel widget.

Parameters
sizeSize of the panel
Returns
The new panel

◆ getBackgroundColor()

const sf::Color& tgui::Panel::getBackgroundColor ( ) const
inline

Returns the background color of the panel.

Returns
The current background color

◆ getRenderer()

std::shared_ptr<PanelRenderer> tgui::Panel::getRenderer ( ) const
inline

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

Returns
Reference to the renderer

◆ setBackgroundColor()

void tgui::Panel::setBackgroundColor ( const Color backgroundColor)
inline

Changes the background color of the panel.

Parameters
backgroundColorNew background color

The documentation for this class was generated from the following file: