A round widget than can be selected or deselected when clicked with a mouse. More...
#include <RadioButton.h>
Public Types | |
using | Ptr = std::unique_ptr< RadioButton > |
Unique widget pointer. More... | |
using | ConstPtr = std::unique_ptr< const RadioButton > |
Const unique widget pointer. More... | |
Public Member Functions | |
RadioButton (const RadioButton &) | |
Copy constructor. More... | |
RadioButton & | operator= (const RadioButton &) |
Copy assignment operator. More... | |
RadioButton (RadioButton &&) noexcept | |
Move constructor. More... | |
RadioButton & | operator= (RadioButton &&) noexcept |
Move constructor. More... | |
RadioButton::Ptr | copy () const |
Create a copy of this widget. More... | |
RadioButtonRenderer * | getRenderer () |
Get the buttons renderer. More... | |
const RadioButtonRenderer * | getRenderer () const |
void | setTextClickable (bool acceptTextClick) |
Allow or disallow the button to be checked by clicking on the text next to it. More... | |
bool | isTextClickable () const |
Check if the the button can be checked by clicking on the text next to it. More... | |
void | setChecked (bool isChecked) |
Check or uncheck the button. More... | |
bool | isChecked () const |
Check whether the button is checked or not. More... | |
void | setText (const std::string &text) |
Set the text displayed next to the button. More... | |
std::string | getText () const |
Get the text displayed next to the button. More... | |
Widget::Ptr | clone () const override |
Make a copy of this widget. More... | |
std::string | getWidgetType () const override |
Get the type of the button. More... | |
~RadioButton () override | |
Destructor. More... | |
void | setName (const std::string &name) |
Set the name of the widget. More... | |
const std::string & | getName () const |
Get the name of the widget. More... | |
void | setRenderer (IWidgetRenderer::Ptr renderer) |
Set the widgets renderer. More... | |
void | setPosition (float x, float y) override |
Set the position of the widget. More... | |
void | setPosition (const Vector2f &position) override |
Set the position of the widget. More... | |
void | setPosition (const std::string &x, const std::string &y) |
Set the position of the widget relative to the size of its parent. More... | |
Vector2f | getPosition () const override |
Get the position of the widget. More... | |
Vector2f | getAbsolutePosition () const |
Get the absolute position of the widget. More... | |
void | setRotation (float angle) override |
Set the orientation of the widget. More... | |
void | rotate (float angle) override |
Rotate the widget. More... | |
float | getRotation () const override |
Get the orientation of the widget. More... | |
void | setScale (float factorX, float factorY) override |
Set the scale factors of the widget. More... | |
void | setScale (const Vector2f &scale) override |
Set the scale factor of the widget. More... | |
void | scale (float factorX, float factorY) override |
Scale the widget by an offset. More... | |
void | scale (const Vector2f &factor) override |
Scale the widget by an offset. More... | |
Vector2f | getScale () const override |
Get the current scale of the widget. More... | |
void | setOrigin (float x, float y) override |
Set the local origin of the widget. More... | |
void | setOrigin (const Vector2f &origin) override |
Set the local origin of the widget. More... | |
Vector2f | getOrigin () const override |
Get the local origin of the widget. More... | |
void | move (float offsetX, float offsetY) override |
Move the widget by a given offset. More... | |
void | move (const Vector2f &offset) override |
Move the widget by a given offset. More... | |
void | setTextSize (unsigned int size) |
Set the character size of the text. More... | |
unsigned int | getTextSize () const |
Get the character size of the text. More... | |
void | setSize (float width, float height) |
Set the size of the widget. More... | |
void | setSize (const std::string &width, const std::string &height) |
Set the size of the widget relative to the size of its parent. More... | |
Vector2f | getSize () const |
Get the size of the widget. More... | |
Vector2f | getAbsoluteSize () |
Get the absolute size of the widget. More... | |
void | setWidth (float width) |
Set the width of the widget. More... | |
void | setWidth (const std::string &width) |
Set the width of the widget relative to its parent. More... | |
void | setHeight (float height) |
Set the height of the widget. More... | |
void | setHeight (const std::string &height) |
Set the height of the widget relative to its parent. More... | |
void | setFocused (bool isFocused) |
Focus or unfocus widget. More... | |
bool | isFocused () const |
Check if widget is focused or not. More... | |
void | setEnabled (bool isEnable) |
Enable or disable the widget. More... | |
bool | isEnabled () const |
Check if widget is enabled or disabled. More... | |
void | toggleEnabled () |
Disable the widget if its currently enabled and vice versa. More... | |
void | setMouseCursor (CursorType cursor) |
Set the mouse cursor that is displayed when the mouse is on top of the widget. More... | |
CursorType | getMouseCursor () const |
Get the mouse cursor that is displayed when the mouse is on top of the widget. More... | |
void | showWithEffect (AnimationType type, Time duration) |
Show the widget with an animation. More... | |
void | hideWithEffect (AnimationType type, Time duration) |
Hide the widget with an animation. More... | |
bool | isAnimationPlaying () const |
Check whether or not an animation is currently playing. More... | |
void | setVisible (bool visible) |
Show or hide a widget. More... | |
bool | isVisible () const |
Check if the widget is visible or not. More... | |
void | toggleVisibility () |
Toggle the visibility of the widget. More... | |
bool | isContainer () const |
Check if the widget is a container or not. More... | |
bool | contains (float x, float y) const |
Check if coordinates lie inside the widget. More... | |
template<typename... Args> | |
int | on (const std::string &event, Callback< Args... > callback) |
Add an event listener to a widget event. More... | |
template<typename... Args> | |
int | on (const std::string &event, Callback< Widget *, Args... > callback) |
Add an event listener to a widget event. More... | |
template<typename... Args> | |
void | emit (const std::string &event, Args &&...args) |
Emit a widget event. More... | |
bool | unsubscribe (const std::string &event, int id) |
Remove an event listener from a widget event. More... | |
const std::shared_ptr< void > | getInternalPtr () const |
Static Public Member Functions | |
static RadioButton::Ptr | create (const std::string &text="") |
Create a new radio button widget. More... | |
Protected Member Functions | |
void | setAsContainer (bool container) |
Set whether or not the widget is a container. More... | |
A round widget than can be selected or deselected when clicked with a mouse.
Name | Argument Type | Description |
---|---|---|
check | void | The radio button was checked |
uncheck | void | The radio button was unchecked |
valueChange | bool | The radio button was checked or unchecked. Parameter = new state of the radio button |
Usage Example:
Definition at line 39 of file RadioButton.h.
using ime::ui::RadioButton::ConstPtr = std::unique_ptr<const RadioButton> |
Const unique widget pointer.
Definition at line 42 of file RadioButton.h.
using ime::ui::RadioButton::Ptr = std::unique_ptr<RadioButton> |
Unique widget pointer.
Definition at line 41 of file RadioButton.h.
ime::ui::RadioButton::RadioButton | ( | const RadioButton & | ) |
Copy constructor.
|
noexcept |
Move constructor.
|
override |
Destructor.
|
overridevirtual |
Make a copy of this widget.
You should use this function if you don't care about the type of the widget, otherwise use the widgets copy function
Implements ime::ui::Widget.
|
inherited |
Check if coordinates lie inside the widget.
x | X coordinate to be checked |
y | Y coordinate to be checked |
RadioButton::Ptr ime::ui::RadioButton::copy | ( | ) | const |
|
static |
Create a new radio button widget.
text | Text to be displayed next to the button |
|
inlineinherited |
Emit a widget event.
event | Name of the event to be emitted |
args | Arguments to pass to event listeners |
This function will invoke all event listeners of the given event.
|
inherited |
Get the absolute position of the widget.
Unlike getPosition, this function returns the absolute position of the top-left point of the widget instead of the relative position to its parent
|
inherited |
Get the absolute size of the widget.
The absolute size includes the size of the widget, the padding, margin and outline thickness
|
inherited |
Get the mouse cursor that is displayed when the mouse is on top of the widget.
|
inherited |
|
overridevirtualinherited |
Get the local origin of the widget.
Implements ime::ITransformable.
|
overridevirtualinherited |
Get the position of the widget.
Implements ime::ITransformable.
RadioButtonRenderer * ime::ui::RadioButton::getRenderer | ( | ) |
Get the buttons renderer.
The renderer gives access to functions that determine how the button is displayed. It allows you to manipulate things such as the background colour, text colour, border colour etc...
|
overridevirtualinherited |
Get the orientation of the widget.
The rotation is always in the range [0, 360]
Implements ime::ITransformable.
|
overridevirtualinherited |
Get the current scale of the widget.
Implements ime::ITransformable.
|
inherited |
Get the size of the widget.
This function only returns the size of the widget (It does not accommodate margin, outline thickness etc ...)
std::string ime::ui::RadioButton::getText | ( | ) | const |
Get the text displayed next to the button.
|
inherited |
Get the character size of the text.
|
overridevirtual |
|
inherited |
Hide the widget with an animation.
type | Type of the animation |
duration | Duration of the animation |
The animation will also be played if the widget currently hidden but it will not be seen
|
inherited |
Check whether or not an animation is currently playing.
bool ime::ui::RadioButton::isChecked | ( | ) | const |
Check whether the button is checked or not.
|
inherited |
Check if the widget is a container or not.
A container widget is a widget that can store other widgets inside it. Such widgets inherit from IWidget class
|
inherited |
Check if widget is enabled or disabled.
|
inherited |
Check if widget is focused or not.
bool ime::ui::RadioButton::isTextClickable | ( | ) | const |
Check if the the button can be checked by clicking on the text next to it.
|
inherited |
Check if the widget is visible or not.
|
overridevirtualinherited |
Move the widget by a given offset.
offset | Offset to apply |
This function adds to the current position of the widget, unlike setPosition which overwrites it
Implements ime::ITransformable.
|
overridevirtualinherited |
Move the widget by a given offset.
offsetX | Horizontal offset |
offsetY | Vertical offset |
This function adds to the current position of the widget, unlike setPosition which overwrites it
Implements ime::ITransformable.
|
inlineinherited |
Add an event listener to a widget event.
event | Event to add an event listener to |
callback | Function to execute when the event is fired |
The callback is passed event arguments (if any) on invocation. Here is an example demonstrating an event listener listening to an event with and arguments
|
inlineinherited |
Add an event listener to a widget event.
event | Event to add an event listener to |
callback | Function to execute when the event is fired |
The callback is passed a pointer to the widget as the first argument followed by the event arguments (if any) on invocation
RadioButton & ime::ui::RadioButton::operator= | ( | const RadioButton & | ) |
Copy assignment operator.
|
noexcept |
Move constructor.
|
overridevirtualinherited |
Rotate the widget.
angle | Angle of rotation, in degrees |
This function adds to the current rotation of the widget, unlike setRotation which overwrites it
Implements ime::ITransformable.
|
overridevirtualinherited |
Scale the widget by an offset.
factor | Offset to apply |
This function multiplies the current scale of the widget, unlike setScale which overwrites it
Implements ime::ITransformable.
|
overridevirtualinherited |
Scale the widget by an offset.
factorX | Horizontal scale factor |
factorY | Vertical scale factor |
This function multiplies the current scale of the widget, unlike setScale which overwrites it
Implements ime::ITransformable.
|
protectedinherited |
Set whether or not the widget is a container.
container | True to flag as container, otherwise false |
A container widget is a widget that can store other widgets inside it. Such widgets inherit from IWidget class
All widgets are not containers by default
void ime::ui::RadioButton::setChecked | ( | bool | isChecked | ) |
Check or uncheck the button.
isChecked | True to check the button, otherwise false |
|
inherited |
Enable or disable the widget.
isEnable | Set true to enable the widget or false to disable the widget |
If the widget is disabled, it wont not receive events and hence does won't dispatch callbacks
By default, the widget is enabled
|
inherited |
Focus or unfocus widget.
isFocused | True to focus or false to unfocus widget |
When the widget is focused, a previously focused widget will be unfocused
By default, the widget is not focused
|
inherited |
Set the height of the widget relative to its parent.
height | New height |
The relative height is given in percentages as shown:
This function sets the height of the widget while keeping the width the same
|
inherited |
Set the height of the widget.
height | New height of the widget |
This function sets the height while keeping the width the same
|
inherited |
Set the mouse cursor that is displayed when the mouse is on top of the widget.
cursor | The cursor to be shown |
By default, the arrow cursor is shown
|
inherited |
Set the name of the widget.
name | The name of the widget |
By default the widget is assigned a unique name. The naming convention is as follows:
widgetType + instantiation number
For example:
|
overridevirtualinherited |
Set the local origin of the widget.
origin | New origin |
The origin of the widget defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the widget, and ignore all transformations (position, scale, rotation).
The default origin of the widget is (0, 0)
Implements ime::ITransformable.
|
overridevirtualinherited |
Set the local origin of the widget.
x | X coordinate of the new origin |
y | Y coordinate of the new origin |
The origin of the widget defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the widget, and ignore all transformations (position, scale, rotation).
The default origin of the widget is (0, 0)
Implements ime::ITransformable.
|
inherited |
Set the position of the widget relative to the size of its parent.
x | New x coordinate of the widget |
y | New y coordinate of the widget |
The position is specified in percentages as shown below:
This function completely overwrites the previous position. Use the move function to apply an offset based on the previous position instead.
The default position of the widget is (0, 0)
|
overridevirtualinherited |
Set the position of the widget.
position | New position |
This function completely overwrites the previous position. Use the move function to apply an offset based on the previous position instead.
The default position of the widget is (0, 0)
Implements ime::ITransformable.
|
overridevirtualinherited |
Set the position of the widget.
x | X coordinate of the new position |
y | Y coordinate of the new position |
This function completely overwrites the previous position. use move function to apply an offset based on the previous position instead
The default position of a the widget is (0, 0)
Implements ime::ITransformable.
|
inherited |
Set the widgets renderer.
renderer | The new renderer |
The renderer determines how the widget is displayed.
|
overridevirtualinherited |
Set the orientation of the widget.
angle | New rotation, in degrees |
This function completely overwrites the previous rotation. See the rotate function to add an angle based on the previous rotation instead.
The default rotation of the widget is 0
Implements ime::ITransformable.
|
overridevirtualinherited |
Set the scale factor of the widget.
scale | New scale |
This function completely overwrites the previous scale
Implements ime::ITransformable.
|
overridevirtualinherited |
Set the scale factors of the widget.
factorX | New horizontal scale factor |
factorY | New vertical scale factor |
This function completely overwrites the previous scale
Implements ime::ITransformable.
|
inherited |
Set the size of the widget relative to the size of its parent.
width | The new width of the widget |
height | The new height of the widget |
The size is specified in percentages as shown below:
|
inherited |
Set the size of the widget.
width | The width of the widget |
height | The height of the widget |
void ime::ui::RadioButton::setText | ( | const std::string & | text | ) |
Set the text displayed next to the button.
text | The text to display |
This function will overwrite any text that was previously set
void ime::ui::RadioButton::setTextClickable | ( | bool | acceptTextClick | ) |
Allow or disallow the button to be checked by clicking on the text next to it.
acceptTextClick | True to allow, or false to disallow |
|
inherited |
Set the character size of the text.
size | New character size |
|
inherited |
Show or hide a widget.
visible | True to show or false to hide |
If the widget is hidden, it won't receive events (and thus won't send callbacks) nor will it be drawn
The widget is visible by default.
|
inherited |
Set the width of the widget relative to its parent.
width | New width |
The relative width is given in percentages as shown:
This function sets the width of the widget while keeping the height the same
|
inherited |
Set the width of the widget.
width | New width of the widget |
This function sets the width while keeping the height the same
|
inherited |
Show the widget with an animation.
type | Type of the animation |
duration | Duration of the animation |
The animation will be played if the widget currently visible
|
inherited |
Disable the widget if its currently enabled and vice versa.
If the widget is disabled, it wont not receive events and hence does won't dispatch callbacks
|
inherited |
Toggle the visibility of the widget.
This function will hide the widget if its currently visible and vice versa
|
inherited |
Remove an event listener from a widget event.
event | Event to remove event listener from |
id | Id number of the event listener |
The id is the number given when the event listener was registered