|
| 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 &text) |
| 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.
|
|
| 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.
|
|
| 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) |
|
|
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.
|
|
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.
|
|
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 constexpr const char | StaticWidgetType [] = "ClickableWidget" |
| Type name of the widget.
|
|
using | SavingRenderersMap = std::map<const Widget*, std::pair<std::unique_ptr<DataIO::Node>, String>> |
|
using | LoadingRenderersMap = std::map<String, std::shared_ptr<RendererData>> |
|