TGUI  v0.7.5
Inheritance diagram for tgui::Grid:
tgui::Container tgui::Widget tgui::Transformable tgui::SignalWidgetBase

Public Types

enum  Alignment {
  Alignment::UpperLeft, Alignment::Up, Alignment::UpperRight, Alignment::Right,
  Alignment::BottomRight, Alignment::Bottom, Alignment::BottomLeft, Alignment::Left,
  Alignment::Center
}
 The alignment of the widget in its cell. More...
 
typedef std::shared_ptr< GridPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const GridConstPtr
 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

 Grid (const Grid &copy)
 Copy constructor. More...
 
Gridoperator= (const Grid &right)
 Overload of assignment operator. More...
 
virtual void setSize (const Layout2d &size) override
 Changes the size of the grid. More...
 
virtual sf::Vector2f getSize () const override
 Returns the size of the grid. More...
 
virtual bool remove (const Widget::Ptr &widget) override
 Removes a single widget that was added to the container. More...
 
virtual void removeAllWidgets () override
 Removes all widgets that were added to the container.
 
void addWidget (const Widget::Ptr &widget, unsigned int row, unsigned int column, const Borders &borders=Borders(0, 0, 0, 0), Alignment alignment=Alignment::Center)
 Add a widget to the grid. More...
 
Widget::Ptr getWidget (unsigned int row, unsigned int column)
 Returns the widget in a specific square of the grid. More...
 
void updateWidgets ()
 Updates the position and size of the widget. More...
 
void changeWidgetBorders (const Widget::Ptr &widget, const Borders &borders=Borders(0, 0, 0, 0))
 Changes borders of a given widget. More...
 
void changeWidgetAlignment (const Widget::Ptr &widget, Alignment alignment=Alignment::Center)
 Changes the alignment of a given widget in its cell. 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...
 
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 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 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 Grid::Ptr create ()
 Creates a new grid widget. More...
 
static Grid::Ptr copy (Grid::ConstPtr grid)
 Makes a copy of another grid. 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...
 

Member Enumeration Documentation

◆ Alignment

enum tgui::Grid::Alignment
strong

The alignment of the widget in its cell.

Where in the cell is the widget located? The widget is centered by default.

Enumerator
UpperLeft 

Draw the widget in the upper left corner of the cell.

Up 

Draw the widget at the upper side of the cell (horizontally centered)

UpperRight 

Draw the widget in the upper right corner of the cell.

Right 

Draw the widget at the right side of the cell (vertically centered)

BottomRight 

Draw the widget in the bottom right corner of the cell.

Bottom 

Draw the widget at the bottom of the cell (horizontally centered)

BottomLeft 

Draw the widget in the bottom left corner of the cell.

Left 

Draw the widget at the left side of the cell (vertically centered)

Center 

Center the widget in the cell.

Constructor & Destructor Documentation

◆ Grid()

tgui::Grid::Grid ( const Grid copy)

Copy constructor.

Parameters
copyInstance to copy

Member Function Documentation

◆ addWidget()

void tgui::Grid::addWidget ( const Widget::Ptr widget,
unsigned int  row,
unsigned int  column,
const Borders borders = Borders(0, 0, 0, 0),
Alignment  alignment = Alignment::Center 
)

Add a widget to the grid.

Parameters
widgetPointer to a fully created widget that will be added to the grid
rowThe row in which the widget should be placed
columnThe column in which the widget should be placed
bordersDistance from the grid square to the widget (left, top, right, bottom)
alignmentWhere the widget is located in the square

◆ changeWidgetAlignment()

void tgui::Grid::changeWidgetAlignment ( const Widget::Ptr widget,
Alignment  alignment = Alignment::Center 
)

Changes the alignment of a given widget in its cell.

Parameters
widgetThe widget for which the alignment should be changed
alignmentThe new alignment

◆ changeWidgetBorders()

void tgui::Grid::changeWidgetBorders ( const Widget::Ptr widget,
const Borders borders = Borders(0, 0, 0, 0) 
)

Changes borders of a given widget.

Parameters
widgetThe widget to which borders should be added
bordersThe new borders around the widget

◆ clone()

virtual Widget::Ptr tgui::Grid::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.

◆ copy()

static Grid::Ptr tgui::Grid::copy ( Grid::ConstPtr  grid)
static

Makes a copy of another grid.

Parameters
gridThe other grid
Returns
The new grid

◆ create()

static Grid::Ptr tgui::Grid::create ( )
static

Creates a new grid widget.

Returns
The new grid

◆ getSize()

virtual sf::Vector2f tgui::Grid::getSize ( ) const
inlineoverridevirtual

Returns the size of the grid.

Returns
Size of the grid

Reimplemented from tgui::Transformable.

◆ getWidget()

Widget::Ptr tgui::Grid::getWidget ( unsigned int  row,
unsigned int  column 
)

Returns the widget in a specific square of the grid.

Parameters
rowThe row that the widget is in
columnThe column that the widget is in
Returns
The widget inside the given square, or nullptr when the square doesn't contain a widget

◆ operator=()

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

Overload of assignment operator.

Parameters
rightInstance to assign
Returns
Reference to itself

◆ remove()

virtual bool tgui::Grid::remove ( const Widget::Ptr widget)
overridevirtual

Removes a single widget that was added to the container.

Parameters
widgetPointer to the widget to remove
See also
remove(sf::String)

Reimplemented from tgui::Container.

◆ setSize()

virtual void tgui::Grid::setSize ( const Layout2d size)
overridevirtual

Changes the size of the grid.

Parameters
sizeNew size of the grid

Widgets in the grid will be repositionned to fill in the best way the available space of the grid. If the size is too small to have all Widgets correctly placed, the size will be ignored and the grid auto-sized until some Widgets are removed of the grid and the size was become valid again.

Reimplemented from tgui::Widget.

◆ updateWidgets()

void tgui::Grid::updateWidgets ( )

Updates the position and size of the widget.

You should no longer have to call this function manually as widgets are supposed to call this function themselves when their position or size is changed.


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