|
TGUI 1.12
|
Base class for button widgets. More...
#include <TGUI/Widgets/ButtonBase.hpp>
Public Types | |
| using | Ptr = std::shared_ptr<ButtonBase> |
| Shared widget pointer. | |
| using | ConstPtr = std::shared_ptr<const ButtonBase> |
| Shared constant widget pointer. | |
| Public Types inherited from tgui::ClickableWidget | |
| using | Ptr = std::shared_ptr<ClickableWidget> |
| Shared widget pointer. | |
| using | ConstPtr = std::shared_ptr<const ClickableWidget> |
| Shared constant widget pointer. | |
| Public Types inherited from tgui::Widget | |
| using | Ptr = std::shared_ptr<Widget> |
| Shared widget pointer. | |
| using | ConstPtr = std::shared_ptr<const Widget> |
| Shared constant widget pointer. | |
Public Member Functions | |
| ButtonBase (const char *typeName, bool initRenderer) | |
| ButtonBase (const ButtonBase &) | |
| Copy constructor. | |
| ButtonBase (ButtonBase &&) noexcept | |
| Move constructor. | |
| ButtonBase & | operator= (const ButtonBase &) |
| Overload of copy assignment operator. | |
| ButtonBase & | operator= (ButtonBase &&) noexcept |
| Move assignment. | |
| ~ButtonBase () override | |
| Destructor. | |
| ButtonRenderer * | getSharedRenderer () override |
| Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
| const ButtonRenderer * | getSharedRenderer () const override |
| ButtonRenderer * | getRenderer () override |
| Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
| void | setSize (const Layout2d &size) override |
| Changes the size of the button. | |
| void | setEnabled (bool enabled) override |
| Enables or disables the widget. | |
| virtual void | setText (const String &caption) |
| Changes the caption of the button. | |
| const String & | getText () const |
| Returns the caption of the button. | |
| void | setTextPosition (Vector2< AbsoluteOrRelativeValue > position, Vector2f origin) |
| Changes the position of the caption text. | |
| void | setIgnoreKeyEvents (bool ignore) |
| Sets whether the button should ignore space and return key pressed and only react to mouse clicks. | |
| bool | getIgnoreKeyEvents () const |
| Returns whether the button ignores space and return key presses and only react to mouse clicks. | |
| void | setFocused (bool focused) override |
| Focus or unfocus the widget. | |
| bool | isMouseOnWidget (Vector2f pos) const override |
| Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. | |
| bool | leftMousePressed (Vector2f pos) override |
| Called by the parent when the left mouse button goes down on top of the widget. | |
| void | leftMouseReleased (Vector2f pos) override |
| void | leftMouseButtonNoLongerDown () override |
| void | draw (BackendRenderTarget &target, RenderStates states) const override |
| Draw the widget to a render target. | |
| void | setSize (Layout width, Layout height) |
| Changes the size of the widget. | |
| Public Member Functions inherited from tgui::ClickableWidget | |
| ClickableWidget (const char *typeName=StaticWidgetType, bool initRenderer=true) | |
| bool | isMouseOnWidget (Vector2f pos) const override |
| Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. | |
| bool | leftMousePressed (Vector2f pos) override |
| Called by the parent when the left mouse button goes down on top of the widget. | |
| void | leftMouseReleased (Vector2f pos) override |
| void | rightMousePressed (Vector2f pos) override |
| void | rightMouseReleased (Vector2f pos) override |
| void | rightMouseButtonNoLongerDown () override |
| void | draw (BackendRenderTarget &target, RenderStates states) const override |
| Draw the widget to a render target. | |
| Public Member Functions inherited from tgui::Widget | |
| Widget (const char *typeName, bool initRenderer) | |
| Widget (const Widget &) | |
| Copy constructor. | |
| Widget (Widget &&) noexcept | |
| Move constructor. | |
| virtual | ~Widget () |
| Destructor. | |
| Widget & | operator= (const Widget &) |
| Overload of copy assignment operator. | |
| Widget & | operator= (Widget &&) noexcept |
| Move assignment. | |
| void | setRenderer (std::shared_ptr< RendererData > rendererData) |
| Sets a new renderer for the widget. The renderer determines how the widget looks. | |
| virtual void | setPosition (const Layout2d &position) |
| sets the position of the widget | |
| void | setPosition (Layout x, Layout y) |
| Sets the position of the widget. | |
| Vector2f | getPosition () const |
| Gets the position of the widget. | |
| void | setSize (Layout width, Layout height) |
| Changes the size of the widget. | |
| void | setWidth (Layout width) |
| Changes the width of the widget. | |
| void | setHeight (Layout height) |
| Changes the height of the widget. | |
| Vector2f | getSize () const |
| Returns the size of the widget. | |
| virtual Vector2f | getFullSize () const |
| Returns the entire size that the widget is using. | |
| virtual Vector2f | getAbsolutePosition (Vector2f offset={}) const |
| Get the absolute position of the widget instead of the relative position to its parent. | |
| virtual Vector2f | getWidgetOffset () const |
| Returns the distance between the position where the widget is drawn and where the widget is placed. | |
| void | setAutoLayout (AutoLayout layout) |
| Sets how the position is determined compared to the other widgets in the parent. | |
| AutoLayout | getAutoLayout () const |
| Returns how the position is determined compared to the other widgets in the parent. | |
| void | setOrigin (float x, float y) |
| Sets the origin point on which the position, scale and rotation is based. | |
| void | setOrigin (Vector2f origin) |
| Sets the origin point on which the position, scale and rotation is based. | |
| Vector2f | getOrigin () const |
| Returns the relative origin point on which the position, scale and rotation is based. | |
| void | setScale (Vector2f scaleFactors) |
| Sets the scaling to be applied to the widget. | |
| void | setScale (Vector2f scaleFactors, Vector2f origin) |
| Sets the scaling to be applied to the widget. | |
| void | setScale (float scaleFactor) |
| Sets the scaling to be applied to the widget. | |
| void | setScale (float scaleFactor, Vector2f origin) |
| Sets the scaling to be applied to the widget. | |
| Vector2f | getScale () const |
| Returns the scaling to be applied to the widget. | |
| Vector2f | getScaleOrigin () const |
| Returns the origin used for scaling. | |
| void | setRotation (float angle) |
| Sets the rotation to be applied to the widget. | |
| void | setRotation (float angle, Vector2f origin) |
| Sets the rotation to be applied to the widget. | |
| float | getRotation () const |
| Returns the rotation to be applied to the widget. | |
| Vector2f | getRotationOrigin () const |
| Returns the origin used for rotations. | |
| void | showWithEffect (ShowEffectType type, Duration duration) |
| Shows the widget by introducing it with an animation. | |
| void | hideWithEffect (ShowEffectType type, Duration duration) |
| Hides the widget by making it leave with an animation. | |
| void | moveWithAnimation (Layout2d position, Duration duration) |
| Moves the widget from its current position to the given position, over a given duration. | |
| void | resizeWithAnimation (Layout2d size, Duration duration) |
| Resizes the widget from its current size to the given size, over a given duration. | |
| virtual void | setVisible (bool visible) |
| Shows or hides a widget. | |
| bool | isVisible () const |
| Returns true when the widget is visible. | |
| bool | isEnabled () const |
| Returns true when the widget is enabled. | |
| bool | isFocused () const |
| Returns true when the widget is focused and false otherwise. | |
| const String & | getWidgetType () const |
| Returns the type of the widget. | |
| Container * | getParent () const |
| Returns a pointer to the parent widget. | |
| BackendGui * | getParentGui () const |
| Returns a pointer to the gui to which this widget belongs. | |
| bool | isAnimationPlaying () const |
| Returns whether there is an active animation (started with showWithEffect or hideWithEffect). | |
| void | moveToFront () |
| Places the widget before all other widgets. | |
| void | moveToBack () |
| Places the widget behind all other widgets. | |
| void | setUserData (Any userData) |
| Stores some data into the widget. | |
| template<typename DataType> | |
| DataType | getUserData () const |
| Returns data stored in the widget. | |
| bool | hasUserData () const |
| Returns whether data stored in the widget. | |
| void | setInheritedFont (const Font &font) |
| Sets the font of the widget that is used when no font is set in the renderer. | |
| const Font & | getInheritedFont () const |
| Returns the font of the widget that is used when no font is set in the renderer. | |
| void | setInheritedOpacity (float opacity) |
| Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. | |
| float | getInheritedOpacity () const |
| Returns the opacity of the widget that is multiplied with the opacity set in the renderer. | |
| void | setTextSize (unsigned int size) |
| Changes the character size of text in this widget if it uses text. | |
| unsigned int | getTextSize () const |
| Returns the character size of text in this widget. | |
| void | setToolTip (Widget::Ptr toolTip) |
| Sets the tool tip that should be displayed when hovering over the widget. | |
| Widget::Ptr | getToolTip () const |
| Returns the tool tip that is displayed when hovering over the widget. | |
| void | setWidgetName (const String &name) |
| Changes the name of a widget. | |
| String | getWidgetName () const |
| Returns the name of a widget. | |
| void | setMouseCursor (Cursor::Type cursor) |
| Changes which mouse cursor is shown when hovering over the widget. | |
| Cursor::Type | getMouseCursor () const |
| Returns which mouse cursor is shown when hovering over the widget. | |
| void | setFocusable (bool focusable) |
| Changes whether a widget could be focused. | |
| bool | isFocusable () const |
| Returns whether a widget could be focused. | |
| void | setNavigationUp (const Widget::Ptr &widgetAbove) |
| Changes which widget should become focused when navigating upwards from this widget. | |
| Widget::Ptr | getNavigationUp () const |
| Returns which widget would become focused when navigating upwards from this widget. | |
| void | setNavigationDown (const Widget::Ptr &widgetBelow) |
| Changes which widget should become focused when navigating downwards from this widget. | |
| Widget::Ptr | getNavigationDown () const |
| Returns which widget would become focused when navigating downwards from this widget. | |
| void | setNavigationLeft (const Widget::Ptr &widgetLeft) |
| Changes which widget should become focused when navigating to the left from this widget. | |
| Widget::Ptr | getNavigationLeft () const |
| Returns which widget would become focused when navigating to the left from this widget. | |
| void | setNavigationRight (const Widget::Ptr &widgetRight) |
| Changes which widget should become focused when navigating to the right from this widget. | |
| Widget::Ptr | getNavigationRight () const |
| Returns which widget would become focused when navigating to the right from this widget. | |
| void | setIgnoreMouseEvents (bool ignore) |
| Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it. | |
| bool | getIgnoreMouseEvents () const |
| Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it. | |
| void | finishAllAnimations () |
| Makes all animations of the widget finish immediately. | |
| virtual bool | canGainFocus () const |
| Returns whether the widget can currently gain focus. | |
| bool | isContainer () const |
| Returns whether the widget is a container widget or not. | |
| bool | isMouseDown () const |
| Returns whether the left mouse button has been pressed on top of the widget. | |
| virtual void | setParent (Container *parent) |
| virtual bool | updateTime (Duration elapsedTime) |
| void | setAutoLayoutUpdateEnabled (bool enabled) |
| virtual void | mouseReleased (Event::MouseButton button, Vector2f pos) |
| virtual void | mouseMoved (Vector2f pos) |
| virtual void | keyPressed (const Event::KeyEvent &event) |
| virtual bool | canHandleKeyPress (const Event::KeyEvent &event) |
| Called by the parent of the widget to check if keyPressed would process the event. | |
| virtual void | textEntered (char32_t key) |
| virtual bool | scrolled (float delta, Vector2f pos, bool touch) |
| Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen). | |
| virtual void | mouseNoLongerOnWidget () |
| virtual Widget::Ptr | askToolTip (Vector2f mousePos) |
| const Layout2d & | getPositionLayout () const |
| const Layout2d & | getSizeLayout () const |
| void | bindPositionLayout (Layout *layout) |
| void | unbindPositionLayout (Layout *layout) |
| void | bindSizeLayout (Layout *layout) |
| void | unbindSizeLayout (Layout *layout) |
| template<typename WidgetType> | |
| std::shared_ptr< const WidgetType > | cast () const |
| Downcast const widget. | |
| template<typename WidgetType> | |
| std::shared_ptr< WidgetType > | cast () |
| Downcast widget. | |
| void | rendererChangedCallback (const String &property) |
Protected Member Functions | |
| void | mouseEnteredWidget () override |
| This function is called when the mouse enters the widget. | |
| void | mouseLeftWidget () override |
| This function is called when the mouse leaves the widget. | |
| void | rendererChanged (const String &property) override |
| Function called when one of the properties of the renderer is changed. | |
| std::unique_ptr< DataIO::Node > | save (SavingRenderersMap &renderers) const override |
| Saves the widget as a tree node in order to save it to a file. | |
| void | load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override |
| Loads the widget from a tree of nodes. | |
| void | updateTextSize () override |
| Called when the text size is changed (either by setTextSize or via the renderer). | |
| void | updateState () |
| virtual void | updateSize () |
| virtual void | updateTextPosition () |
| virtual void | initComponents () |
| void | addComponent (const std::shared_ptr< priv::dev::Component > &component) |
| std::shared_ptr< priv::dev::Component > | getComponent (const String &name) |
| Protected Member Functions inherited from tgui::ClickableWidget | |
| Signal & | getSignal (String signalName) override |
| Retrieves a signal based on its name. | |
| Widget::Ptr | clone () const override |
| Makes a copy of the widget if you don't know its exact type. | |
| Protected Member Functions inherited from tgui::Widget | |
| void | recalculateBoundPositionLayouts () |
| Calls recalculateValue() on each layout in m_boundPositionLayouts. | |
| void | recalculateBoundSizeLayouts () |
| Calls recalculateValue() on each layout in m_boundSizeLayouts. | |
Protected Attributes | |
| String | m_string |
| bool | m_down = false |
| priv::dev::ComponentState | m_state = priv::dev::ComponentState::Normal |
| bool | m_autoSize = true |
| bool | m_updatingTextSize = false |
| bool | m_ignoreKeyEvents = false |
| Vector2< AbsoluteOrRelativeValue > | m_textPosition |
| Vector2f | m_textOrigin |
| priv::dev::StylePropertyBackground | background |
| priv::dev::StylePropertyText | text |
| std::uint64_t | m_textStyleChangedCallbackId = 0 |
| std::map< String, priv::dev::StylePropertyBase * > | m_stylePropertiesNames |
| std::map< String, std::vector< priv::dev::StylePropertyBase * > > | m_stylePropertiesGlobalNames |
| std::map< String, std::shared_ptr< priv::dev::Component > > | m_namedComponents |
| std::shared_ptr< priv::dev::BackgroundComponent > | m_backgroundComponent |
| std::shared_ptr< priv::dev::TextComponent > | m_textComponent |
| std::vector< std::shared_ptr< priv::dev::Component > > | m_components |
| Protected Attributes inherited from tgui::Widget | |
| String | m_type |
| String | m_name |
| Layout2d | m_position |
| Stores the position of this widget. | |
| Layout2d | m_size |
| Stores the size of this widget. | |
| unsigned int | m_textSize = 0 |
| Vector2f | m_origin |
| Optional< Vector2f > | m_rotationOrigin |
| Optional< Vector2f > | m_scaleOrigin |
| Vector2f | m_scaleFactors = {1, 1} |
| float | m_rotationDeg = 0 |
| Vector2f | m_prevPosition |
| Vector2f | m_prevSize |
| std::unordered_set< Layout * > | m_boundPositionLayouts |
| std::unordered_set< Layout * > | m_boundSizeLayouts |
| bool | m_enabled = true |
| Stores the flag indicating whether this widget is enabled. | |
| bool | m_visible = true |
| Stores the flag indicating whether this widget is visible. | |
| Container * | m_parent = nullptr |
| BackendGui * | m_parentGui = nullptr |
| bool | m_mouseHover = false |
| bool | m_mouseDown = false |
| bool | m_focused = false |
| bool | m_focusable = true |
| std::weak_ptr< Widget > | m_navWidgetUp |
| std::weak_ptr< Widget > | m_navWidgetDown |
| std::weak_ptr< Widget > | m_navWidgetRight |
| std::weak_ptr< Widget > | m_navWidgetLeft |
| Duration | m_animationTimeElapsed |
| bool | m_containerWidget = false |
| Widget::Ptr | m_toolTip = nullptr |
| CopiedPtr< WidgetRenderer > | m_renderer = nullptr |
| std::vector< std::unique_ptr< priv::Animation > > | m_showAnimations |
| Font | m_inheritedFont |
| float | m_inheritedOpacity = 1 |
| Any | m_userData |
| Cursor::Type | m_mouseCursor = Cursor::Type::Arrow |
| AutoLayout | m_autoLayout = AutoLayout::Manual |
| bool | m_autoLayoutUpdateEnabled = true |
| bool | m_ignoreMouseEvents = false |
| Font | m_fontCached = Font::getGlobalFont() |
| float | m_opacityCached = 1 |
| bool | m_transparentTextureCached = false |
| unsigned int | m_textSizeCached = 0 |
Additional Inherited Members | |
| Static Public Member Functions inherited from tgui::ClickableWidget | |
| static ClickableWidget::Ptr | create (const Layout2d &size={"100%", "100%"}) |
| Creates a new clickable widget. | |
| static ClickableWidget::Ptr | copy (const ClickableWidget::ConstPtr &widget) |
| Makes a copy of another clickable widget. | |
| Public Attributes inherited from tgui::ClickableWidget | |
| SignalVector2f | onMousePress = {"MousePressed"} |
| The mouse went down on the widget. Optional parameter: mouse position relative to widget. | |
| SignalVector2f | onMouseRelease = {"MouseReleased"} |
| The mouse was released on top of the widget. Optional parameter: mouse position relative to widget. | |
| SignalVector2f | onClick = {"Clicked"} |
| The widget was clicked. Optional parameter: mouse position relative to widget. | |
| SignalVector2f | onRightMousePress = {"RightMousePressed"} |
| The right mouse button went down on the widget. Optional parameter: mouse position relative to widget. | |
| SignalVector2f | onRightMouseRelease = {"RightMouseReleased"} |
| The right mouse button was released on top of the widget. Optional parameter: mouse position relative to widget. | |
| SignalVector2f | onRightClick = {"RightClicked"} |
| The widget was right clicked. Optional parameter: mouse position relative to widget. | |
| Public Attributes inherited from tgui::Widget | |
| SignalVector2f | onPositionChange = {"PositionChanged"} |
| The position of the widget changed. Optional parameter: new position. | |
| SignalVector2f | onSizeChange = {"SizeChanged"} |
| The size of the widget changed. Optional parameter: new size. | |
| Signal | onFocus = {"Focused"} |
| The widget was focused. | |
| Signal | onUnfocus = {"Unfocused"} |
| The widget was unfocused. | |
| Signal | onMouseEnter = {"MouseEntered"} |
| The mouse entered the widget. | |
| Signal | onMouseLeave = {"MouseLeft"} |
| The mouse left the widget. | |
| SignalShowEffect | onShowEffectFinish = {"ShowEffectFinished"} |
| A show or hide effect finished. Optional parameters: effect type, new widget visibility or both. | |
| SignalAnimationType | onAnimationFinish = {"AnimationFinished"} |
| An animation has finished. | |
| Static Public Attributes inherited from tgui::ClickableWidget | |
| static constexpr const char | StaticWidgetType [] = "ClickableWidget" |
| Type name of the widget. | |
| Protected Types inherited from tgui::Widget | |
| using | SavingRenderersMap = std::map<const Widget*, std::pair<std::unique_ptr<DataIO::Node>, String>> |
| using | LoadingRenderersMap = std::map<String, std::shared_ptr<RendererData>> |
Base class for button widgets.
|
overridevirtual |
Draw the widget to a render target.
| target | Render target to draw to |
| states | Current render states |
Implements tgui::Widget.
|
nodiscard |
Returns whether the button ignores space and return key presses and only react to mouse clicks.
By default, key events are NOT ignored. This means that when the button is focused, pressing the space or return key has the same effect as clicking the button.
|
nodiscardoverridevirtual |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Reimplemented from tgui::Widget.
|
nodiscardoverridevirtual |
Reimplemented from tgui::Widget.
|
nodiscardoverridevirtual |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Reimplemented from tgui::Widget.
|
nodiscard |
Returns the caption of the button.
|
nodiscardoverridevirtual |
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
Implements tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Called by the parent when the left mouse button goes down on top of the widget.
| pos | Mouse position in view coordinates relative to the parent widget |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Loads the widget from a tree of nodes.
Reimplemented from tgui::Widget.
Reimplemented in tgui::ToggleButton.
|
overrideprotectedvirtual |
This function is called when the mouse enters the widget.
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
This function is called when the mouse leaves the widget.
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Function called when one of the properties of the renderer is changed.
| property | Name of the property that was changed |
Reimplemented from tgui::Widget.
|
nodiscardoverrideprotectedvirtual |
Saves the widget as a tree node in order to save it to a file.
Reimplemented from tgui::Widget.
Reimplemented in tgui::ToggleButton.
|
overridevirtual |
Enables or disables the widget.
| enabled | Is the widget enabled? |
The disabled widget will no longer receive events and thus no longer send callbacks. All widgets are enabled by default.
Reimplemented from tgui::Widget.
|
overridevirtual |
Focus or unfocus the widget.
| focused | Is the widget focused? |
When a widget is focused, the previously focused widget will be unfocused.
Reimplemented from tgui::Widget.
| void tgui::ButtonBase::setIgnoreKeyEvents | ( | bool | ignore | ) |
Sets whether the button should ignore space and return key pressed and only react to mouse clicks.
| ignore | Should space and return key press events be ignored by this button? |
By default, key events are NOT ignored. This means that when the button is focused, pressing the space or return key has the same effect as clicking the button.
|
overridevirtual |
Changes the size of the button.
| size | The new size of the button |
Reimplemented from tgui::Widget.
|
inline |
Changes the size of the widget.
| width | Width of the widget |
| height | Height of the widget |
|
virtual |
Changes the caption of the button.
| caption | New text to draw on top of the button |
| void tgui::ButtonBase::setTextPosition | ( | Vector2< AbsoluteOrRelativeValue > | position, |
| Vector2f | origin ) |
Changes the position of the caption text.
| position | Position of the text within the button (position can be both relative or absolute) |
| origin | Origin that determines which part of the text is placed at the given position |
The position consists of x and y components which are either a constant (e.g. 5) or a percentage string (e.g. "5%"). The origin consists of x and y components with values between 0 (left/top) and 1 (right/bottom).
The default text position is centered in the button, i.e. ({"50%", "50%"}, {0.5f, 0.5f})
Example that places the left side of the text at 10% of the button width and places the vertical center of the text at 25px from the top of the button:
|
overrideprotectedvirtual |
Called when the text size is changed (either by setTextSize or via the renderer).
Reimplemented from tgui::Widget.