Rose
Public Member Functions | List of all members
rose::LinearScale::LinearScaleImage Class Reference

The Indicator image of the LinearScale. More...

#include <LinearScale.h>

Inheritance diagram for rose::LinearScale::LinearScaleImage:
Inheritance graph
[legend]
Collaboration diagram for rose::LinearScale::LinearScaleImage:
Collaboration graph
[legend]

Public Member Functions

 LinearScaleImage (const LinearScaleImage &)=delete
 
 LinearScaleImage (LinearScaleImage &&)=delete
 
LinearScaleImageoperator= (const LinearScaleImage &)=delete
 
LinearScaleImageoperator= (LinearScaleImage &&)=delete
 
 LinearScaleImage (ImageId imageId)
 Constructor. More...
 
void initializeComposite () override
 See Widget::initializeComposite()
 
Rectangle widgetLayout (sdl::Renderer &renderer, Rectangle available, uint layoutStage) override
 See Widget widgetLayout()
 
void draw (sdl::Renderer &renderer, Rectangle parentRect) override
 See Widget::draw()
 
- Public Member Functions inherited from rose::ImageView
 ImageView (ImageView &&)=delete
 
 ImageView (const ImageView &)=delete
 
ImageViewoperator= (ImageView &&)=delete
 
ImageViewoperator= (const ImageView &)=delete
 
 ImageView (ImageId imageId)
 Constructor. More...
 
 ImageView (std::optional< ImageId > imageId)
 Constructor. More...
 
 ImageView (ImageId imageId, bool shrinkable)
 Constructor. More...
 
 ImageView (std::optional< ImageId > imageId, bool shrinkable)
 Constructor. More...
 
void initializeComposite () override
 See Widget::initializeComposite()
 
Rectangle widgetLayout (sdl::Renderer &renderer, Rectangle available, uint layoutStage) override
 Determine the desired size of the label with text and badge. More...
 
void draw (sdl::Renderer &renderer, Rectangle parentRect) override
 Draw the Label. More...
 
void setImageId (ImageId imageId) override
 Set the ImageId of the image texture to display. More...
 
- Public Member Functions inherited from rose::Widget
 Widget (const Widget &)=delete
 
 Widget (Widget &&)=delete
 
Widgetoperator= (const Widget &)=delete
 
Widgetoperator= (Widget &&)=delete
 
std::string_view nodeId () const noexcept override
 
std::shared_ptr< WidgetpointerWidget (const Position< int > &position, const Position< int > &containerPosition)
 Search for the Widget within which the position lies. More...
 
Position< int > computeScreenPosition ()
 Recursively compute the Widget Position on the Screen. More...
 
bool contains (const Position< int > &position)
 Determine if a given Screen Position is within the Widget Rectangle. More...
 
ApplicationgetApplication ()
 Get a reference to the Application object. More...
 
ApplicationgetApplication () const
 const version of getApplication()
 
std::shared_ptr< WindowgetWindow ()
 Get the Window ancestor of a Widget. More...
 
std::shared_ptr< WindowgetWindow () const
 const version of getWindow().
 
bool enterEvent ()
 Notify Widget of mouse pointer enter event. More...
 
void setEnterLeaveEventCallback (EventCallback eventCallback)
 Set the enter callback.
 
bool leaveEvent ()
 Notify Widget of mouse pointer leave event. More...
 
void setLeaveEventCallback (EventCallback eventCallback)
 Set the leave callback.
 
bool buttonEvent (bool pressed, uint button, uint clicks, bool passed)
 Notify Widget of mouse button events. More...
 
void setButtonEventCallback (ButtonCallback buttonCallback)
 Set the button callback.
 
bool mouseMotionEvent (bool pressed, uint button, const Position< int > &mousePos, const Position< int > &relativePos, bool passed)
 Notify Widget of mouse motion events. More...
 
void setMouseMotionEventCallback (MouseMotionCallback mouseMotionCallback)
 Set the mouse motion callback.
 
bool mouseScrollEvent (const Position< int > &deltaPos, bool passed)
 Notify Widget of mouse scroll wheel events. More...
 
void setMouseScrollEventCallback (ScrollCallback scrollCallback)
 Set the mouse scroll callback.
 
bool keyboardShortcutEvent (uint32_t shortcutCode, bool state, uint repeat)
 Notify the Widget of a keyboard shortcut invocation. More...
 
void setKeyboardShortcutCallback (KeyboardShortcutCallback keyboardShortcutCallback)
 Set the keyboard shortcut callback.
 
bool keyTextInputEvent (const std::string &text)
 Notify the Widget of text input. More...
 
void setTextInputCallback (TextInputCallback textInputCallback)
 Set the text input callback.
 
bool supportsKeyboardFocus () const
 
bool keyboardFocusEvent (bool hasFocus)
 Notify the Widget when it gains or looses keyboard focus. More...
 
void setKeyboardFocusCallback (KeyboardFocusCallback keyboardFocusCallback)
 Set the keyboard focus callback.
 
bool keyboardEvent (const SDL_KeyboardEvent &keyboardEvent)
 
void setKeyboardEvent (KeyboardEventCallback keyboardEventCallback)
 
- Public Member Functions inherited from rose::Visual
void setScreenRectangle (const Position< int > &containerPosition)
 Compute the screen rectangle from the Container screen Position. More...
 
Rectangle getScreenRectangle (const Position< int > &containerPosition) const
 Get the rectangle occupied by the Visual. More...
 
virtual void draw (gm::Context &context, const Position< int > &containerPosition)=0
 Draw the visual.
 
virtual Rectangle layout (rose::gm::Context &context, const Rectangle &screenRect)=0
 Layout the visual.
 
Position< int > drawPadding (const Position< int > &containerPosition)
 Pad the drawing location.
 
Rectangle layoutPadding (const Rectangle &screenRect)
 Pad the layout.
 
void setSize (const Size &size)
 Set preferred Size.
 
Size getSize () const
 Get the preferred size.
 
void setPosition (const Position< int > &position)
 Set preferred Position.
 
Position< int > getPosition () const
 Get the preferred Position.
 
void setPadding (const Padding &padding)
 Set Padding.
 
void setScreenRectangle (const Rectangle &screenRect)
 Set Screen Rectangle.
 
constexpr bool isVisible () const noexcept
 Check visibility.
 
void setVisible (bool visible) noexcept
 Set visibility.
 
void setLayoutHint (const LayoutHint &hint)
 Add a LayoutHint.
 
std::optional< int > getAttachmentHint (LayoutHint::Attachment attachment)
 Get an AttachmentHint value given a LayoutHint::Attachment. More...
 
std::optional< int > getGridHint (LayoutHint::GridLayoutHint gridLayoutHint)
 Get a GridLayoutHint value given a LayoutHint::GridLayoutHint. More...
 
template<size_t HintClass>
std::optional< const ValueMapgetHintMap () const
 
SemanticGesture supportedSemanticGestures () const
 Get supported SemanticGestures.
 
- Public Member Functions inherited from rose::Container
virtual void add (const std::shared_ptr< Node > &node)
 
void remove (const std::shared_ptr< Node > &node)
 
- Public Member Functions inherited from rose::Node
 Node (const std::shared_ptr< Container > &container)
 Create a node and add it to a Container. More...
 
void setId (const Id &nodeId) noexcept
 Set Id.
 
std::string_view getId () const
 Get Id.
 
IdPath getIdPath () const
 Get the Id Path.
 
virtual void addedToContainer ()
 Called when a Node is added to a Container. More...
 
std::shared_ptr< Containercontainer ()
 
std::shared_ptr< Containercontainer () const
 
template<typename C >
std::shared_ptr< C > containerAs ()
 
template<typename C >
std::shared_ptr< C > containerAs () const
 
std::shared_ptr< const NodegetNode () const
 Get a const std::shared_ptr to this node. More...
 
std::shared_ptr< NodegetNode ()
 Get a std::shared_ptr to this node. More...
 
template<typename NodeType >
std::shared_ptr< const NodegetNode () const
 Get a std::shared_ptr<const NodeType> to this node. More...
 
template<typename NodeType >
std::shared_ptr< NodeType > getNode ()
 Get a std::shared_ptr<NodeType> to this node. More...
 
std::shared_ptr< Noderemove ()
 

Additional Inherited Members

- Public Types inherited from rose::Visual
using ValueMap = std::map< int, int >
 The std::map type for each hint class.
 
- Public Types inherited from rose::Node
using NodePtr = std::shared_ptr< Node >
 
- Static Public Member Functions inherited from rose::Node
template<typename NodeType >
static std::shared_ptr< NodeType > create ()
 Create a Node with no arguments. More...
 
template<typename NodeType , typename ... Args>
static std::shared_ptr< NodeType > create (Args ... args)
 Create a Node with arguments. More...
 
template<typename NodeType , typename ContainerType , typename ... Args>
static std::shared_ptr< NodeType > add (ContainerType container, Args ... args)
 Create a Node with arguments and add to a Container. More...
 
- Public Attributes inherited from rose::Visual
std::map< size_t, ValueMapmHintsMap {}
 The std::map of hint class to ValueMap.
 
- Static Public Attributes inherited from rose::Widget
static constexpr std::string_view id = "Widget"
 
- Static Public Attributes inherited from rose::Container
static constexpr std::string_view id = "Container"
 
- Static Public Attributes inherited from rose::Node
static constexpr std::string_view id = "Node"
 
- Protected Attributes inherited from rose::ImageView
ImageId mImageId
 
- Protected Attributes inherited from rose::Widget
EventCallback mEnterEventCallback {}
 The pointer has entered the Widget.
 
EventCallback mLeaveEventCallback {}
 The pointer has left the Widget.
 
ButtonCallback mButtonEventCallback {}
 The pointer button has been pressed with the pointer inside the Widget.
 
MouseMotionCallback mMouseMotionCallback {}
 The pointer is in motion, inside the Widget with a button pressed.
 
ScrollCallback mMouseScrollCallback {}
 The mouse scroll wheel has moved with the pointer inside the Widget.
 
KeyboardShortcutCallback mKeyboardShortcutCallback {}
 A keyboard button event while the Widget has keyboard focus.
 
TextInputCallback mTextInputCallback {}
 A text input event while the Widget has keyboard focus.
 
KeyboardFocusCallback mKeyboardFocusCallback {}
 Notification that this Widget has gained or lost keyboard focus.
 
KeyboardEventCallback mKeyboardEventCallback {}
 Notification that this Widget has received a keyboard event.
 
- Protected Attributes inherited from rose::Visual
SemanticGesture mSemanticGesture {}
 
Position< int > mPos {}
 Position relative to the container, arrived at by layout.
 
Size mSize {}
 The size on screen, arrived at by layout.
 
Position< int > mPreferredPos {}
 The preferred position.
 
Size mPreferredSize {}
 The preferred size.
 
Rectangle mScreenRect {}
 The screen Rectangle computed at drawing time.
 
Padding mPadding {}
 Immediately around the Visual, used for separation and alignment.
 
State mState {}
 The object state Id string.
 
bool mVisible {true}
 If true the object is visible.
 
- Protected Attributes inherited from rose::Node
std::weak_ptr< ContainermContainer {}
 The Container that holds the Node. More...
 
Id mId {}
 

Detailed Description

The Indicator image of the LinearScale.

Constructor & Destructor Documentation

◆ LinearScaleImage()

rose::LinearScale::LinearScaleImage::LinearScaleImage ( ImageId  imageId)
inlineexplicit

Constructor.

Parameters
imageIdThe ImageId of the indicator

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