TGUI  v0.6.10
Public Types | Public Member Functions | List of all members
tgui::Panel Class Reference

A static container of widgets. The background color can be solid or transparent. More...

#include <Panel.hpp>

Inheritance diagram for tgui::Panel:
tgui::Container tgui::Widget tgui::Transformable tgui::CallbackManager

Public Types

- Public Types inherited from tgui::Widget

Public Member Functions

 Panel ()
 Default constructor. More...
 
 Panel (const Panel &copy)
 Copy constructor. More...
 
virtual ~Panel ()
 Destructor. More...
 
Paneloperator= (const Panel &right)
 Overload of assignment operator. More...
 
void setSize (float width, float height)
 Changes the size of the panel. More...
 
virtual sf::Vector2f getSize () const
 Returns the size of the panel. More...
 
void setBackgroundTexture (sf::Texture *const texture=nullptr)
 Changes the background texture of the panel. More...
 
sf::Texture * getBackgroundTexture ()
 Returns the background texture of the panel. More...
 
void setBackgroundColor (const sf::Color &backgroundColor)
 Changes the background color of the panel. More...
 
const sf::Color & getBackgroundColor () const
 Returns the background color of the panel. More...
 
virtual void setTransparency (unsigned char transparency)
 Changes the transparency of the widget. More...
 
- Public Member Functions inherited from tgui::Container
 Container ()
 Default constructor. More...
 
 Container (const Container &copy)
 Copy constructor. More...
 
virtual ~Container ()
 Destructor. More...
 
Containeroperator= (const Container &right)
 Overload of assignment operator. More...
 
bool setGlobalFont (const std::string &filename)
 Changes the global font. More...
 
void setGlobalFont (const sf::Font &font)
 Changes the global font. More...
 
const sf::Font & getGlobalFont () const
 Returns the global font. 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...
 
Widget::Ptr copy (const Widget::Ptr &oldWidget, const sf::String &newWidgetName="")
 Makes a copy of any existing widget and returns the pointer to the new widget. More...
 
virtual void remove (const Widget::Ptr &widget)
 Removes a single widget that was added to the container. More...
 
virtual void remove (Widget *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...
 
bool setWidgetName (const Widget::Ptr &widget, const std::string &name)
 Changes the name of a widget. More...
 
bool getWidgetName (const Widget::Ptr &widget, std::string &name) 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. More...
 
void uncheckRadioButtons ()
 Uncheck all the radio buttons. More...
 
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...
 
void bindGlobalCallback (std::function< void(const Callback &)> func)
 Bind a function to the callbacks of all child widgets. More...
 
template<typename T >
void bindGlobalCallback (void(T::*func)(const Callback &), T *const classPtr)
 Bind a function to the callbacks of all child widgets. More...
 
virtual void unbindGlobalCallback ()
 Unbind the global callback function(s). More...
 
bool loadWidgetsFromFile (const std::string &filename)
 Loads a form from a file. More...
 
bool saveWidgetsToFile (const std::string &filename)
 Save the widgets to a file. More...
 
virtual sf::Vector2f getWidgetsOffset () 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...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor. More...
 
 Widget (const Widget &copy)
 Copy constructor. More...
 
virtual ~Widget ()
 Destructor. More...
 
Widgetoperator= (const Widget &right)
 Overload of assignment operator. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget on the screen. More...
 
virtual void show ()
 Shows the widget. More...
 
virtual void hide ()
 Hides the widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void enable ()
 Enables the widget. More...
 
virtual void disable ()
 Disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
bool isDisabled () const
 Returns true when the widget is disabled. More...
 
bool isLoaded () const
 Returns true when the widget is loaded successfully. 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...
 
WidgetTypes getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
unsigned char getTransparency () const
 Returns the transparency of the widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets. More...
 
virtual void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setCallbackId (unsigned int callbackId)
 Changes the callback id of the widget. More...
 
unsigned int getCallbackId ()
 Returns the callback id of the widget. More...
 
- Public Member Functions inherited from tgui::Transformable
 Transformable ()
 Default constructor. More...
 
virtual ~Transformable ()
 Destructor. More...
 
virtual void setPosition (float x, float y)
 Set the position of the widget. More...
 
void setPosition (const sf::Vector2f &position)
 set the position of the widget More...
 
const sf::Vector2f & getPosition () const
 get the position of the widget More...
 
void move (float offsetX, float offsetY)
 Move the widget by a given offset. More...
 
void move (const sf::Vector2f &offset)
 Move the widget by a given offset. More...
 
virtual sf::Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
void scale (float factorX, float factorY)
 Scale the widget. More...
 
void scale (const sf::Vector2f &factors)
 Scale the widget. More...
 
- Public Member Functions inherited from tgui::CallbackManager
void bindCallback (std::function< void()> func, unsigned int trigger)
 Bind a function to one or more specific callback trigger(s). More...
 
template<typename T >
void bindCallback (void(T::*func)(), T *const classPtr, unsigned int trigger)
 Bind a function to one or more specific callback trigger(s). More...
 
void bindCallbackEx (std::function< void(const Callback &)> func, unsigned int trigger)
 Bind a function to one or more specific callback trigger(s). More...
 
template<typename T >
void bindCallbackEx (void(T::*func)(const Callback &), T *const classPtr, unsigned int trigger)
 Bind a function to one or more specific callback trigger(s). More...
 
void bindCallback (unsigned int trigger)
 Bind one or more specific callback trigger(s) to the parent widget. More...
 
void unbindCallback (unsigned int trigger)
 Unbind all callback function bound to the given trigger. More...
 
void unbindAllCallback ()
 Unbind all callback functions bound to any callback. More...
 

Detailed Description

A static container of widgets. The background color can be solid or transparent.

Member Enumeration Documentation

Defines specific triggers to Panel.

Enumerator
LeftMousePressed 

The left mouse button was pressed.

LeftMouseReleased 

The left mouse button was released.

LeftMouseClicked 

The left mouse button was clicked.

AllPanelCallbacks 

All triggers defined in Panel and its base classes.

Constructor & Destructor Documentation

tgui::Panel::Panel ( )

Default constructor.

tgui::Panel::Panel ( const Panel copy)

Copy constructor.

Parameters
copyInstance to copy
virtual tgui::Panel::~Panel ( )
virtual

Destructor.

Member Function Documentation

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

Returns the background color of the panel.

Returns
The current background color
sf::Texture* tgui::Panel::getBackgroundTexture ( )

Returns the background texture of the panel.

Returns
Pointer to the texture that is being used as background of the panel. This pointer is nullptr when no background texture was set.
virtual sf::Vector2f tgui::Panel::getSize ( ) const
virtual

Returns the size of the panel.

Returns
Size of the panel

Implements tgui::Transformable.

Panel& tgui::Panel::operator= ( const Panel right)

Overload of assignment operator.

Parameters
rightInstance to assign
Returns
Reference to itself
void tgui::Panel::setBackgroundColor ( const sf::Color &  backgroundColor)

Changes the background color of the panel.

Parameters
backgroundColorNew background color
void tgui::Panel::setBackgroundTexture ( sf::Texture *const  texture = nullptr)

Changes the background texture of the panel.

Parameters
texturePointer to the texture that should be used as background of the panel
Warning
You should make sure that the texture stays alive.

If the texture has a different size than the panel then it will be scaled to fill the whole panel. Pass nullptr to this function to remove the background texture.

void tgui::Panel::setSize ( float  width,
float  height 
)
virtual

Changes the size of the panel.

Parameters
widthSets the new width of the panel
heightSets the new height of the panel

Implements tgui::Transformable.

virtual void tgui::Panel::setTransparency ( unsigned char  transparency)
virtual

Changes the transparency of the widget.

Parameters
transparencyThe transparency of the widget. 0 is completely transparent, while 255 (default) means fully opaque.

Note that this will only change the transparency of the images. The parts of the widgets that use a color will not be changed. You must change them yourself by setting the alpha channel of the color.

Reimplemented from tgui::Container.


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