TGUI  1.1
Loading...
Searching...
No Matches

Button widget with an image displayed next to the text (or centered in the button without text) More...

#include <TGUI/Widgets/BitmapButton.hpp>

Inheritance diagram for tgui::BitmapButton:
tgui::Button tgui::ButtonBase tgui::ClickableWidget tgui::Widget

Public Types

using Ptr = std::shared_ptr< BitmapButton >
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr< const BitmapButton >
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Button
using Ptr = std::shared_ptr< Button >
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr< const Button >
 Shared constant widget pointer.
 
- Public Types inherited from tgui::ButtonBase
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

 BitmapButton (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
 BitmapButton (const BitmapButton &)
 Copy constructor.
 
 BitmapButton (BitmapButton &&) noexcept
 Move constructor.
 
BitmapButtonoperator= (const BitmapButton &)
 Overload of copy assignment operator.
 
BitmapButtonoperator= (BitmapButton &&) noexcept
 Move assignment.
 
void setSize (const Layout2d &size) override
 Changes the size of the button.
 
void setImage (const Texture &image)
 Sets the image that should be displayed next to the text.
 
TGUI_NODISCARD const TexturegetImage () const
 Returns the image being displayed next to the text.
 
void setImageScaling (float relativeHeight)
 Sets the relative size of the image to display next to the text.
 
TGUI_NODISCARD float getImageScaling () const
 Returns the relative size of the image displayed next to the text.
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget.
 
void setSize (Layout width, Layout height)
 Changes the size of the widget.
 
- Public Member Functions inherited from tgui::Button
 Button (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
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 keyPressed (const Event::KeyEvent &event) override
 
bool canHandleKeyPress (const Event::KeyEvent &event) override
 Called by the parent of the widget to check if keyPressed would process the event.
 
- Public Member Functions inherited from tgui::ButtonBase
 ButtonBase (const char *typeName, bool initRenderer)
 
 ButtonBase (const ButtonBase &)
 Copy constructor.
 
 ButtonBase (ButtonBase &&) noexcept
 Move constructor.
 
ButtonBaseoperator= (const ButtonBase &)
 Overload of copy assignment operator.
 
ButtonBaseoperator= (ButtonBase &&) noexcept
 Move assignment.
 
 ~ButtonBase () override
 Destructor.
 
TGUI_NODISCARD ButtonRenderergetSharedRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
TGUI_NODISCARD const ButtonRenderergetSharedRenderer () const override
 
TGUI_NODISCARD ButtonRenderergetRenderer () 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 &text)
 Changes the caption of the button.
 
TGUI_NODISCARD const StringgetText () const
 Returns the caption of the button.
 
void setTextPosition (Vector2< AbsoluteOrRelativeValue > position, Vector2f origin)
 Changes the position of the caption text.
 
void setFocused (bool focused) override
 Focus or unfocus the widget.
 
TGUI_NODISCARD 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.
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget.
 
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)
 
TGUI_NODISCARD 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.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Vector2f getSize () const
 Returns the size of the widget.
 
virtual TGUI_NODISCARD Vector2f getFullSize () const
 Returns the entire size that the widget is using.
 
virtual TGUI_NODISCARD Vector2f getAbsolutePosition (Vector2f offset={}) const
 Get the absolute position of the widget instead of the relative position to its parent.
 
virtual TGUI_NODISCARD Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed.
 
void setAutoLayout (AutoLayout layout)
 
TGUI_NODISCARD AutoLayout getAutoLayout () const
 
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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Vector2f getScale () const
 Returns the scaling to be applied to the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD float getRotation () const
 Returns the rotation to be applied to the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD bool isVisible () const
 Returns true when the widget is visible.
 
TGUI_NODISCARD bool isEnabled () const
 Returns true when the widget is enabled.
 
TGUI_NODISCARD bool isFocused () const
 Returns true when the widget is focused and false otherwise.
 
TGUI_NODISCARD const StringgetWidgetType () const
 Returns the type of the widget.
 
TGUI_NODISCARD ContainergetParent () const
 Returns a pointer to the parent widget.
 
TGUI_NODISCARD BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs.
 
TGUI_NODISCARD 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 >
TGUI_NODISCARD DataType getUserData () const
 Returns data stored in the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD const FontgetInheritedFont () 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Widget::Ptr getNavigationRight () const
 Returns which widget would become focused when navigating to the right from this widget.
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
virtual TGUI_NODISCARD bool canGainFocus () const
 Returns whether the widget can currently gain focus.
 
TGUI_NODISCARD bool isContainer () const
 Returns whether the widget is a container widget or not.
 
TGUI_NODISCARD bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)
 
TGUI_NODISCARD 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 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 TGUI_NODISCARD Widget::Ptr askToolTip (Vector2f mousePos)
 
TGUI_NODISCARD const Layout2dgetPositionLayout () const
 
TGUI_NODISCARD const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
void rendererChangedCallback (const String &property)
 

Static Public Member Functions

static TGUI_NODISCARD BitmapButton::Ptr create (const String &text="")
 Creates a new bitmap button widget.
 
static TGUI_NODISCARD BitmapButton::Ptr copy (const BitmapButton::ConstPtr &button)
 Makes a copy of another button.
 
- Static Public Member Functions inherited from tgui::Button
static TGUI_NODISCARD Button::Ptr create (const String &text="")
 Creates a new button widget.
 
static TGUI_NODISCARD Button::Ptr copy (const Button::ConstPtr &button)
 Makes a copy of another button.
 
- Static Public Member Functions inherited from tgui::ClickableWidget
static TGUI_NODISCARD ClickableWidget::Ptr create (const Layout2d &size={"100%", "100%"})
 Creates a new clickable widget.
 
static TGUI_NODISCARD ClickableWidget::Ptr copy (const ClickableWidget::ConstPtr &widget)
 Makes a copy of another clickable widget.
 

Static Public Attributes

static constexpr const char StaticWidgetType [] = "BitmapButton"
 Type name of the widget.
 
- Static Public Attributes inherited from tgui::Button
static constexpr const char StaticWidgetType [] = "Button"
 Type name of the widget.
 
- Static Public Attributes inherited from tgui::ClickableWidget
static constexpr const char StaticWidgetType [] = "ClickableWidget"
 Type name of the widget.
 

Protected Member Functions

void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed.
 
TGUI_NODISCARD 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 updateSize () override
 
void initComponentsBitmapButton ()
 
void updateTextPosition () override
 
TGUI_NODISCARD 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::Button
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.
 
TGUI_NODISCARD SignalgetSignal (String signalName) override
 Retrieves a signal based on its name.
 
TGUI_NODISCARD 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::ButtonBase
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.
 
TGUI_NODISCARD 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 initComponents ()
 
void addComponent (const std::shared_ptr< priv::dev::Component > &component)
 
TGUI_NODISCARD std::shared_ptr< priv::dev::Component > getComponent (const String &name)
 
- Protected Member Functions inherited from tgui::ClickableWidget
TGUI_NODISCARD SignalgetSignal (String signalName) override
 Retrieves a signal based on its name.
 
TGUI_NODISCARD 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.
 

Additional Inherited Members

- Public Attributes inherited from tgui::Button
SignalString onPress = {"Pressed"}
 The button was pressed. Optional parameter: text of the button.
 
- 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.
 
- 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 > >
 
- Protected Attributes inherited from tgui::ButtonBase
String m_string
 
bool m_down = false
 
priv::dev::ComponentState m_state = priv::dev::ComponentState::Normal
 
bool m_autoSize = true
 
bool m_updatingTextSize = false
 
Vector2< AbsoluteOrRelativeValuem_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< Vector2fm_rotationOrigin
 
Optional< Vector2fm_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.
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
std::weak_ptr< Widgetm_navWidgetUp
 
std::weak_ptr< Widgetm_navWidgetDown
 
std::weak_ptr< Widgetm_navWidgetRight
 
std::weak_ptr< Widgetm_navWidgetLeft
 
Duration m_animationTimeElapsed
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_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
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 

Detailed Description

Button widget with an image displayed next to the text (or centered in the button without text)

Member Function Documentation

◆ clone()

TGUI_NODISCARD Widget::Ptr tgui::BitmapButton::clone ( ) const
overrideprotectedvirtual

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 TGUI_NODISCARD BitmapButton::Ptr tgui::BitmapButton::copy ( const BitmapButton::ConstPtr button)
static

Makes a copy of another button.

Parameters
buttonThe other button
Returns
The new button

◆ create()

static TGUI_NODISCARD BitmapButton::Ptr tgui::BitmapButton::create ( const String text = "")
static

Creates a new bitmap button widget.

Parameters
textThe text to display on the button
Returns
The new bitmap button

◆ getImage()

TGUI_NODISCARD const Texture & tgui::BitmapButton::getImage ( ) const

Returns the image being displayed next to the text.

Returns
Glyph displayed next to text

◆ getImageScaling()

TGUI_NODISCARD float tgui::BitmapButton::getImageScaling ( ) const

Returns the relative size of the image displayed next to the text.

Returns
Value between 0 and 1 that determines the height of the image compared to the button height. If 0 (default), the image has its original size and is unaffected by the button size

◆ load()

void tgui::BitmapButton::load ( const std::unique_ptr< DataIO::Node > &  node,
const LoadingRenderersMap &  renderers 
)
overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

◆ rendererChanged()

void tgui::BitmapButton::rendererChanged ( const String property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyName of the property that was changed

Reimplemented from tgui::Widget.

◆ save()

TGUI_NODISCARD std::unique_ptr< DataIO::Node > tgui::BitmapButton::save ( SavingRenderersMap &  renderers) const
overrideprotectedvirtual

Saves the widget as a tree node in order to save it to a file.

Reimplemented from tgui::Widget.

◆ setImage()

void tgui::BitmapButton::setImage ( const Texture image)

Sets the image that should be displayed next to the text.

Parameters
imageGlyph to display

◆ setImageScaling()

void tgui::BitmapButton::setImageScaling ( float  relativeHeight)

Sets the relative size of the image to display next to the text.

Parameters
relativeHeightValue between 0 and 1 that determines the height of the image compared to the button height. If set to 0 (default), the image will always have its original size, no matter what the button size is.

◆ setSize() [1/3]

virtual void tgui::Widget::setSize ( const Layout2d size)
virtual

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

void tgui::BitmapButton::setSize ( const Layout2d size)
overridevirtual

Changes the size of the button.

Parameters
sizeThe new size of the button

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

void tgui::Widget::setSize ( Layout  width,
Layout  height 
)
inline

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ updateSize()

void tgui::BitmapButton::updateSize ( )
overrideprotectedvirtual

Reimplemented from tgui::ButtonBase.

◆ updateTextPosition()

void tgui::BitmapButton::updateTextPosition ( )
overrideprotectedvirtual

Reimplemented from tgui::ButtonBase.


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