TGUI  0.8-dev
Inheritance diagram for tgui::Grid:
tgui::Container tgui::Widget tgui::Transformable tgui::SignalWidgetBase

Public Types

enum  Alignment {
  Alignment::Center, Alignment::UpperLeft, Alignment::Up, Alignment::UpperRight,
  Alignment::Right, Alignment::BottomRight, Alignment::Bottom, Alignment::BottomLeft,
  Alignment::Left
}
 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, std::size_t row, std::size_t column, const Borders &borders=Borders{0}, Alignment alignment=Alignment::Center)
 Adds a widget to the grid. More...
 
Widget::Ptr getWidget (std::size_t row, std::size_t column) const
 Returns the widget in a specific cell of the grid. More...
 
void setWidgetBorders (const Widget::Ptr &widget, const Borders &borders=Borders(0, 0, 0, 0))
 Changes borders of a given widget. More...
 
void setWidgetBorders (std::size_t row, std::size_t column, const Borders &borders=Borders(0, 0, 0, 0))
 Changes borders of a widget in a certain cell. More...
 
Borders getWidgetBorders (const Widget::Ptr &widget) const
 Returns the borders around a widget. More...
 
Borders getWidgetBorders (std::size_t row, std::size_t column) const
 Returns the borders around a widget in a specific cell of the grid. More...
 
void setWidgetAlignment (const Widget::Ptr &widget, Alignment alignment=Alignment::Center)
 Changes the alignment of a given widget in its cell. More...
 
void setWidgetAlignment (std::size_t row, std::size_t column, Alignment alignment=Alignment::Center)
 Changes the alignment of a given widget in its cell. More...
 
Alignment getWidgetAlignment (const Widget::Ptr &widget) const
 Returns the alignment of a given widget. More...
 
Alignment getWidgetAlignment (std::size_t row, std::size_t column) const
 Returns the alignment of a given widget in its cell. More...
 
const std::vector< std::vector< Widget::Ptr > > & getGridWidgets () const
 Returns the widgets and their positions in the grid. More...
 
virtual void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
- Public Member Functions inherited from tgui::Container
 Container (const Container &copy)
 Copy constructor. More...
 
 ~Container ()
 Destructor.
 
Containeroperator= (const Container &right)
 Overload of assignment operator. More...
 
const std::vector< Widget::Ptr > & getWidgets () const
 Returns a list of all the widgets. More...
 
const std::vector< sf::String > & getWidgetNames () const
 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 focusNextWidget ()
 Focuses the next widget. More...
 
void focusPreviousWidget ()
 Focuses the previous widget. More...
 
void unfocusWidgets ()
 Unfocuses all the widgets.
 
void uncheckRadioButtons ()
 Unchecks all the radio buttons.
 
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)
 Loads the child widgets from a text file. More...
 
void saveWidgetsToFile (const std::string &filename)
 Saves the child widgets to a text file. More...
 
void loadWidgetsFromStream (std::stringstream &stream)
 Loads the child widgets from a string stream. More...
 
void saveWidgetsToStream (std::stringstream &stream)
 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...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~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...
 
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
 sets 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 sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. 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 ()
 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...
 
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...
 
- Public Member Functions inherited from tgui::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 Sets the position of the widget. More...
 
sf::Vector2f getPosition () const
 Gets the position of the widget. More...
 
void move (const Layout2d &offset)
 Moves the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Moves 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)
 Scales the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scales the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
virtual ~SignalWidgetBase ()
 Virtual destructor.
 
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)
 Disconnects all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnects 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
virtual void rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. 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.
 

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
Center 

Center the widget in the cell.

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)

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,
std::size_t  row,
std::size_t  column,
const Borders borders = Borders{0},
Alignment  alignment = Alignment::Center 
)

Adds 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 cell to the widget (left, top, right, bottom)
alignmentWhere the widget is located in the cell

§ 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

§ draw()

virtual void tgui::Grid::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

Implements tgui::Widget.

§ getGridWidgets()

const std::vector<std::vector<Widget::Ptr> >& tgui::Grid::getGridWidgets ( ) const

Returns the widgets and their positions in the grid.

Returns
grid of widgets

§ getSize()

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

Returns the size of the grid.

Returns
Size of the grid

Reimplemented from tgui::Transformable.

§ getWidget()

Widget::Ptr tgui::Grid::getWidget ( std::size_t  row,
std::size_t  column 
) const

Returns the widget in a specific cell of the grid.

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

§ getWidgetAlignment() [1/2]

Alignment tgui::Grid::getWidgetAlignment ( const Widget::Ptr widget) const

Returns the alignment of a given widget.

Parameters
widgetThe widget to get the alignment from
Returns
The alignment inside the cell, or Grid::Alignment::Center when the widget wasn't part of the grid

§ getWidgetAlignment() [2/2]

Alignment tgui::Grid::getWidgetAlignment ( std::size_t  row,
std::size_t  column 
) const

Returns the alignment of a given widget in its cell.

Parameters
rowThe row that the widget is in
columnThe column that the widget is in
Returns
The alignment inside the given cell, or Grid::Alignment::Center when the cell doesn't contain a widget

§ getWidgetBorders() [1/2]

Borders tgui::Grid::getWidgetBorders ( const Widget::Ptr widget) const

Returns the borders around a widget.

Parameters
widgetThe widget to get the borders from
Returns
The borders inside the around the widget, or Borders{0} when the widget wasn't part of the grid

§ getWidgetBorders() [2/2]

Borders tgui::Grid::getWidgetBorders ( std::size_t  row,
std::size_t  column 
) const

Returns the borders around a widget in a specific cell of the grid.

Parameters
rowThe row that the widget is in
columnThe column that the widget is in
Returns
The borders inside the given cell, or Borders{0} when the cell 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.

§ setWidgetAlignment() [1/2]

void tgui::Grid::setWidgetAlignment ( 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

§ setWidgetAlignment() [2/2]

void tgui::Grid::setWidgetAlignment ( std::size_t  row,
std::size_t  column,
Alignment  alignment = Alignment::Center 
)

Changes the alignment of a given widget in its cell.

Parameters
rowThe row that the widget is in
columnThe column that the widget is in
alignmentThe new alignment

§ setWidgetBorders() [1/2]

void tgui::Grid::setWidgetBorders ( 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

§ setWidgetBorders() [2/2]

void tgui::Grid::setWidgetBorders ( std::size_t  row,
std::size_t  column,
const Borders borders = Borders(0, 0, 0, 0) 
)

Changes borders of a widget in a certain cell.

Parameters
rowThe row that the widget is in
columnThe column that the widget is in
bordersThe new borders around the widget

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