TGUI
0.7.8
|
The parent class for every widget. More...
#include <TGUI/Widget.hpp>
Public Types | |
typedef std::shared_ptr< Widget > | Ptr |
Shared widget pointer. | |
typedef std::shared_ptr< const Widget > | ConstPtr |
Shared constant widget pointer. | |
Public Member Functions | |
Widget () | |
Default constructor. | |
Widget (const Widget ©) | |
Copy constructor. More... | |
~Widget () | |
Destructor. | |
Widget & | operator= (const Widget &right) |
Overload of assignment operator. More... | |
std::shared_ptr< WidgetRenderer > | getRenderer () 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... | |
Container * | getParent () const |
Returns a pointer to the parent widget. More... | |
virtual void | setOpacity (float opacity) |
Changes the opacity of the 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... | |
virtual void | setFont (const Font &font) |
Changes the font of the text in 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< BaseTheme > | getTheme () 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... | |
virtual Widget::Ptr | clone () const =0 |
Makes a copy of the widget if you don't know its exact type. More... | |
virtual void | setPosition (const Layout2d &position) |
set the position of the widget More... | |
void | setPosition (const Layout &x, const Layout &y) |
set the position of the widget More... | |
virtual void | setSize (const Layout2d &size) |
Changes the size of the widget. More... | |
void | setSize (const Layout &width, const Layout &height) |
Changes the size of the widget. More... | |
Public Member Functions inherited from tgui::Transformable | |
virtual | ~Transformable () |
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 constructor. More... | |
SignalWidgetBase & | operator= (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. | |
Protected Member Functions | |
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... | |
The parent class for every widget.
Signals
tgui::Widget::Widget | ( | const Widget & | copy | ) |
Copy constructor.
copy | Instance to copy |
|
protected |
Attach a theme to the widget.
theme | Theme to be shared with this widget |
If a theme was already attached, it will receive a detach event
|
pure virtual |
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.
Implemented in tgui::HorizontalLayout, tgui::VerticalLayout, tgui::Button, tgui::Canvas, tgui::ChatBox, tgui::CheckBox, tgui::ChildWindow, tgui::ClickableWidget, tgui::ComboBox, tgui::EditBox, tgui::Grid, tgui::Knob, tgui::Label, tgui::ListBox, tgui::MenuBar, tgui::MessageBox, tgui::Panel, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tab, and tgui::TextBox.
void tgui::Widget::detachTheme | ( | ) |
Detach the theme from the widget.
The theme will be told that the widget no longer shares the theme with the other widgets
|
virtual |
Disables the widget.
blockMouseEvents | Should mouse events be passed to the widget behind this one or blocked? |
The widget will no longer receive events and it will thus no longer send callbacks. All widgets are enabled by default.
|
virtual |
Enables the widget.
The widget will receive events and send callbacks again. All widgets are enabled by default.
|
virtual |
|
virtual |
Get the absolute position of the widget instead of the relative position to its parent.
std::shared_ptr< sf::Font > tgui::Widget::getFont | ( | ) | const |
Returns the font associated with the widget (if any)
|
inline |
Returns the opacity of the widget.
|
inline |
Returns a pointer to the parent widget.
|
inline |
Returns the primary parameter that was passed to the loader to load this widget.
|
inline |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
|
inline |
Returns the secondary parameter that was passed to the loader to load this widget.
|
inline |
Returns the theme to which the widget is currently connected.
Widget::Ptr tgui::Widget::getToolTip | ( | ) |
Returns the tool tip that is displayed when hovering over the widget.
|
inlinevirtual |
Returns the distance between the position where the widget is drawn and where the widget is placed.
This is basically the width and height of the optional borders drawn around widgets.
Reimplemented in tgui::Button, tgui::ChatBox, tgui::ComboBox, tgui::EditBox, tgui::Knob, tgui::Label, tgui::ListBox, tgui::ProgressBar, tgui::Slider, tgui::SpinButton, tgui::Tab, and tgui::TextBox.
|
inline |
Returns the type of the widget.
|
virtual |
Hides the widget.
The widget won't receive events (and thus won't send callbacks) nor will it be drawn when hidden. The widget is visible by default.
|
virtual |
Hides the widget by making it leave with an animation.
If the widget is already hidden then the animation will still play but you will not see it.
During the animation the position, size and/or opacity may change. Once the animation is done the widget will be back in the state in which it was when this function was called.
type | Type of the animation |
duration | Duration of the animation |
|
inline |
Returns true when the widget is enabled.
If this function returns false then the widget is disabled and will longer receive events and it will thus no longer send callbacks. All widgets are enabled by default.
|
inline |
Returns true when the widget is focused and false otherwise.
|
inline |
Returns true when the widget is visible.
If this function returns false then the widget is hidden, which means that it won't receive events (and thus won't send callbacks) and it won't be drawn. All widgets are visible by default.
Overload of assignment operator.
right | Instance to assign |
|
protectedvirtual |
Reload the widget.
primary | Primary parameter for the loader |
secondary | Secondary parameter for the loader |
force | Try to only change the looks of the widget and not alter the widget itself when false |
Exception | when the connected theme could not create the widget |
When primary is an empty string the built-in white theme will be used.
Reimplemented in tgui::Button, tgui::ChatBox, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Knob, tgui::Label, tgui::ListBox, tgui::MenuBar, tgui::MessageBox, tgui::ProgressBar, tgui::RadioButton, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tab, and tgui::TextBox.
|
virtual |
Changes the font of the text in the widget.
font | The new font. |
When you don't call this function then the font from the parent widget will be used.
Some widget don't need a font and won't do anything when this function is called.
Reimplemented in tgui::BoxLayout, tgui::Container, tgui::Button, tgui::ChatBox, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Label, tgui::ListBox, tgui::MenuBar, tgui::MessageBox, tgui::ProgressBar, tgui::RadioButton, tgui::Tab, and tgui::TextBox.
|
virtual |
Changes the opacity of the widget.
opacity | The opacity of the widget. 0 means completely transparent, while 1 (default) means fully opaque. |
Reimplemented in tgui::Container, tgui::Button, tgui::Canvas, tgui::ChatBox, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Knob, tgui::Label, tgui::ListBox, tgui::MenuBar, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tab, and tgui::TextBox.
set 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).
x | New x coordinate |
y | New y coordinate |
Usage examples:
|
virtual |
set 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).
position | New position |
Usage examples:
Reimplemented from tgui::Transformable.
Reimplemented in tgui::Button, tgui::Canvas, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Knob, tgui::Label, tgui::ListBox, tgui::MenuBar, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tab, and tgui::TextBox.
|
overridevirtual |
set 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).
position | New position |
Usage examples:
Reimplemented from tgui::Transformable.
Reimplemented in tgui::Button, tgui::Canvas, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Knob, tgui::Label, tgui::ListBox, tgui::MenuBar, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tab, tgui::TextBox, tgui::Button, tgui::Canvas, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Knob, tgui::Label, tgui::ListBox, tgui::MenuBar, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tab, and tgui::TextBox.
Changes the size of the widget.
width | Width of the widget |
height | Height of the widget |
Usage examples:
|
virtual |
Changes the size of the widget.
size | Size of the widget |
Usage examples:
Reimplemented from tgui::Transformable.
Reimplemented in tgui::Button, tgui::Canvas, tgui::ChatBox, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Grid, tgui::Knob, tgui::Label, tgui::ListBox, tgui::MenuBar, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tab, and tgui::TextBox.
|
overridevirtual |
Changes the size of the widget.
size | Size of the widget |
Usage examples:
Reimplemented from tgui::Transformable.
Reimplemented in tgui::BoxLayout, tgui::Button, tgui::Canvas, tgui::ChatBox, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Grid, tgui::Knob, tgui::Label, tgui::ListBox, tgui::MenuBar, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tab, tgui::TextBox, tgui::BoxLayout, tgui::Button, tgui::Canvas, tgui::ChatBox, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Grid, tgui::Knob, tgui::Label, tgui::ListBox, tgui::MenuBar, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tab, and tgui::TextBox.
void tgui::Widget::setToolTip | ( | Widget::Ptr | toolTip | ) |
Sets the tool tip that should be displayed when hovering over the widget.
toolTip | Any widget that you want to use as a tool tip (usually a Label) |
|
virtual |
|
virtual |
Shows the widget by introducing it with an animation.
The animation will also be played if the widget was already visible.
During the animation the position, size and/or opacity may change. Once the animation is done the widget will be back in the state in which it was when this function was called.
type | Type of the animation |
duration | Duration of the animation |
|
virtual |
Unfocus the widget.