TGUI  0.9.1

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

typedef std::shared_ptr< BitmapButtonPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const BitmapButtonConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Button
typedef std::shared_ptr< ButtonPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ButtonConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::ButtonBase
typedef std::shared_ptr< ButtonBasePtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ButtonBaseConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::ClickableWidget
typedef std::shared_ptr< ClickableWidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ClickableWidgetConstPtr
 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

 BitmapButton (const BitmapButton &)
 Copy constructor.
 
 BitmapButton (BitmapButton &&)
 Move constructor.
 
BitmapButtonoperator= (const BitmapButton &)
 Overload of copy assignment operator.
 
BitmapButtonoperator= (BitmapButton &&)
 Move assignment.
 
 ~BitmapButton ()
 Destructor.
 
void setSize (const Layout2d &size) override
 Changes the size of the button. More...
 
virtual void setText (const String &text) override
 Changes the caption of the button. More...
 
void setImage (const Texture &image)
 Sets the image that should be displayed next to the text. More...
 
const TexturegetImage () const
 Returns the image being displayed next to the text. More...
 
void setImageScaling (float relativeHeight)
 Sets the relative size of the image to display next to the text. More...
 
float getImageScaling () const
 Returns the relative size of the image displayed next to the text. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::ButtonBase
 ButtonBase (const ButtonBase &)
 Copy constructor.
 
 ButtonBase (ButtonBase &&)
 Move constructor.
 
ButtonBaseoperator= (const ButtonBase &)
 Overload of copy assignment operator.
 
ButtonBaseoperator= (ButtonBase &&)
 Move assignment.
 
ButtonRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
ButtonRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the button. More...
 
void setEnabled (bool enabled) override
 Enables or disables the widget. More...
 
const StringgetText () const
 Returns the caption of the button. More...
 
void setTextSize (unsigned int size) override
 Changes the character size of the text. More...
 
unsigned int getTextSize () const override
 Returns the character size of the text. More...
 
void setFocused (bool focused) override
 Focus or unfocus the widget. More...
 
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void draw (BackendRenderTargetBase &target, RenderStates states) const override
 Draw the widget to a render target. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::ClickableWidget
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void draw (BackendRenderTargetBase &target, RenderStates states) const override
 Draw the widget to a render target. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
virtual ~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...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
void setWidth (Layout width)
 Changes the width of the widget. More...
 
void setHeight (Layout height)
 Changes the height of the widget. More...
 
Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the top-left point of the widget instead of the relative position to its parent. More...
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based. More...
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based. More...
 
Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based. More...
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget. More...
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget. More...
 
Vector2f getScaleOrigin () const
 Returns the origin used for scaling. More...
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget. More...
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget. More...
 
float getRotation () const
 Returns the rotation to be applied to the widget. More...
 
Vector2f getRotationOrigin () const
 Returns the origin used for rotations. More...
 
void showWithEffect (ShowAnimationType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowAnimationType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const StringgetWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
GuiBasegetParentGui () const
 Returns a pointer to the gui to which this widget belongs. More...
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
 
void moveToFront ()
 Places the widget before all other widgets. More...
 
void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
void setWidgetName (const String &name)
 Changes the name of a widget. More...
 
String getWidgetName () const
 Returns the name of a widget. More...
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget. More...
 
Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the widget. More...
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused. More...
 
bool isFocusable () const
 Returns whether a widget could be focused. More...
 
virtual bool canGainFocus () const
 Returns whether the widget can currently gain focus. More...
 
bool isContainer () const
 Returns whether the widget is a container widget or not. More...
 
bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget. More...
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 

Static Public Member Functions

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

Protected Member Functions

void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed. More...
 
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.
 
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::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.
 
SignalgetSignal (String signalName) override
 Retrieves a signal based on its name. More...
 
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::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. More...
 
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.
 
- Protected Member Functions inherited from tgui::ClickableWidget
SignalgetSignal (String signalName) override
 Retrieves a signal based on its name. More...
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 

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.
 
SignalAnimation onAnimationFinish = {"AnimationFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 

Detailed Description

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

Member Function Documentation

◆ clone()

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

Makes a copy of another button.

Parameters
buttonThe other button
Returns
The new button

◆ create()

static 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()

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

Returns the image being displayed next to the text.

Returns
Glyph displayed next to text

◆ getImageScaling()

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

◆ 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.

◆ 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

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});
TGUI_API Layout bindHeight(std::shared_ptr< Widget > widget)
Bind to the height of the 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
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

◆ setText()

virtual void tgui::BitmapButton::setText ( const String text)
overridevirtual

Changes the caption of the button.

Parameters
textNew text to draw on top of the button

Reimplemented from tgui::ButtonBase.


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