All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
MultiWidgets::TextWidget Class Reference

A widget for displaying simple text. More...

#include <MultiWidgets/TextWidget.hpp>

Inheritance diagram for MultiWidgets::TextWidget:
MultiWidgets::TextInterfaceWidget MultiWidgets::ScrollAreaWidget MultiWidgets::Widget Stylish::CSSBoxModel MultiWidgets::InputGrabListener Stylish::Styleable Valuable::Node Valuable::Attribute Patterns::NotCopyable Valuable::Serializable MultiWidgets::TextEditWidget

Public Types

enum  TextAlign {
  TEXT_ALIGN_START = 1 << 0, TEXT_ALIGN_END = 1 << 1, TEXT_ALIGN_LEFT = 1 << 2, TEXT_ALIGN_RIGHT = 1 << 3,
  TEXT_ALIGN_HCENTER = 1 << 4, TEXT_ALIGN_JUSTIFY = 1 << 5, TEXT_ALIGN_TOP = 1 << 6, TEXT_ALIGN_VCENTER = 1 << 7,
  TEXT_ALIGN_BOTTOM = 1 << 8, TEXT_ALIGN_CENTER = TEXT_ALIGN_HCENTER | TEXT_ALIGN_VCENTER
}
 Text alignment, "text-align", http://www.w3.org/TR/css3-text/#text-align CSS3 Text module only has horizontal text align, and vertical-align/box-align properties are very different beasts. More...
 

Valuable Attributes

Valuable::StyleValue letter-spacing = QByteArray("normal")
 CSS parameter "letter-spacing" Unlike the CSS3 parameter, you can also specify percentage values here. More...
 
Radiant::FlagsT
< TextWidget::TextAlign
text-align = TextWidget::TEXT_ALIGN_START
 CSS parameter "text-align", see TextAlign for allowed values. More...
 
- Valuable Attributes inherited from MultiWidgets::TextInterfaceWidget
Radiant::Color color = Radiant::Color(0.F, 0.F, 0.F, 1.F)
 Get the text color. More...
 
float drop-shadow-blur = 0.F
 Get drop shadow blur. More...
 
Radiant::Color drop-shadow-color = Radiant::Color(0.F, 0.F, 0.F, 0.F)
 Get drop shadow color. More...
 
Nimble::Vector2f drop-shadow-offset = Nimble::Vector2f(0, 0)
 get drop shadow offset More...
 
float font-render-width = 0.F
 Get font rendering width. More...
 
float glow = 0
 Get glow amount. More...
 
Radiant::Color glow-color = Radiant::Color(1.F, 1.F, 1.F, 0.F)
 Get glow color. More...
 
QString source = QString ()
  More...
 
Radiant::Color stroke = Radiant::Color(0, 0, 0, 0)
 Get stroke color. More...
 
float stroke-width = 0.F
  More...
 
QString text = QString ()
 Text content of the widget. More...
 
float text-sharpness = 1.F
 Get font sharpness. More...
 
QTextOption::WrapMode wrap-mode = QTextOption::WrapAtWordBoundaryOrAnywhere
 CSS parameter "wrap-mode", values: "auto" (default), "none", "word", "character". More...
 
- Valuable Attributes inherited from MultiWidgets::ScrollAreaWidget
Luminous::Overflow overflow = Luminous::OverflowVisible
 Overflow mode of the scroll area. More...
 
bool resize-to-content = false
 Should the widget be automatically resized to the content size. More...
 
bool show-horizontal-scroll-bar = true
 Is the horizontal scrollbar shown? More...
 
bool show-vertical-scroll-bar = true
 Is the vertical scrollbar shown? More...
 
- Valuable Attributes inherited from MultiWidgets::Widget
float angular-damping = 1.F
 Set the angular damping of the widget, which controls how fast the the angular velocity (omega) will slow down when thrown. More...
 
float damping = 0.995000004F
 The damping of the Widget controls how quickly the Widget will slow down and stop when thrown. More...
 
float depth = 0.F
 Depth of the widget. More...
 
Widget::DisplayMode display = Widget::DISPLAY_BLOCK
 Controls widget visibility. More...
 
float extra-input-capture-radius = 0.F
 Extra radius (in widget coordinates) used when input is processed. More...
 
Radiant::FlagsT< Widget::Flagsflags = Widget::FLAGS_DEFAULT
 Widget flags define common behaviour of widget. More...
 
Radiant::FlagsT
< Widget::InputFlags
input-flags = Widget::INPUT_DEFAULT
 Current input processing parameters which determine how this widget will react to input. More...
 
float maximum-tap-motion = 50.F
 Adjusts the limit for recognizing taps within this Widget. More...
 
float maximum-tap-time = 0.5F
 Adjusts the time limit for recognizing taps. More...
 
float omega = 0.F
 Angular velocity of the widget in radians per second. More...
 
float opacity = 1.F
 Transparency factor that gets recursively applied to any child widgets this widget has. More...
 
Nimble::Vector2 origin = Nimble::Vector2f(0, 0)
 Relative origin of the widget coordinates. More...
 
float rotation = 0.F
 Clockwise rotation of the Widget in radians, relative to the parent. More...
 
float scale = 1.F
 Scale of the Widget. More...
 
float scale-damping = 1.F
 Set the scale damping of the widget. More...
 
Widget::TouchArea touch-area = Widget::TOUCH_BORDER_BOX
 Controls the default touchable area of the widget. More...
 
Nimble::Vector2f velocity = Nimble::Vector2f(0.F, 0.F)
 Return the current velocity of the Widget. More...
 
- Valuable Attributes inherited from Stylish::CSSBoxModel
Nimble::Vector2 location = Nimble::Vector2f(0.F, 0.F)
 The location of this object in pixels in its parent's coordinate system. More...
 
Nimble::Frame4f margin = Nimble::Vector4(0, 0, 0, 0)
 Size of the margin. More...
 
Nimble::Frame4f padding = Nimble::Vector4(0, 0, 0, 0)
 Size of the padding. More...
 
Nimble::SizeF size = Nimble::SizeF(100.F, 100.F)
 Box size in pixels. More...
 
- Valuable Attributes inherited from Stylish::Styleable
QString css-class = ""
 Get the CSS classes of the Styleable as a space separated string. More...
 
QString css-id = ""
 Get the CSS id of the Styleable. More...
 
- Valuable Attributes inherited from Valuable::Node
Node::Uuid id = generateId()
 Returns the unique id. More...
 

Node Events

[OUT] layout
 Layout has changed. Content size and bounding box might have changed.
See Also
DocumentWidget
TextEditWidget.
 

Public Member Functions

virtual const Nimble::RectfboundingBox () const
 
virtual float heightForWidth (float w) const
 Returns the height of the widget for the given width while maintaining aspect ratio. More...
 
const Valuable::StyleValueletterSpacing () const
 CSS parameter "letter-spacing" Unlike the CSS3 parameter, you can also specify percentage values here. More...
 
void setLetterSpacing (const Valuable::StyleValue &spacing)
 Setter for attribute letter-spacing. More...
 
void setTextAlign (Radiant::FlagsT< TextAlign > alignFlags)
 Sets text align. More...
 
Radiant::FlagsT< TextAligntextAlign () const
 CSS parameter "text-align", see TextAlign for allowed values. More...
 
const Luminous::SimpleTextLayouttextLayout () const
 
 TextWidget (WidgetPtr parent=nullptr)
 Constructs TextWidget without content. More...
 
 TextWidget (const QString &text, WidgetPtr parent=nullptr)
 Constructs TextWidget with the given text. More...
 
virtual void update (const FrameInfo &frameInfo)
 Update widget state. More...
 
virtual ~TextWidget ()
 Destructor.
 
- Public Member Functions inherited from MultiWidgets::TextInterfaceWidget
Radiant::Color color () const
 Get the text color. More...
 
float dropShadowBlur () const
 Get drop shadow blur. More...
 
Radiant::Color dropShadowColor () const
 Get drop shadow color. More...
 
Nimble::Vector2f dropShadowOffset () const
 get drop shadow offset More...
 
const Stylish::AttributeFontfont () const
 Attribute font, other font-accessors just modify this one.
 
Stylish::AttributeFontfont ()
 
const QStringList & fontFamily () const
 CSS parameter "font-family". More...
 
Stylish::FontKerning fontKerning () const
 CSS parameter "font-kerning", values: "auto", "normal", "none" http://www.w3.org/TR/css3-fonts/#font-kerning-prop. More...
 
float fontRenderingWidth () const
 Get font rendering width. More...
 
float fontSize () const
 CSS parameter "font-size". More...
 
Stylish::FontStretch fontStretch () const
 CSS parameter "font-stretch". More...
 
Stylish::FontStyle fontStyle () const
 CSS parameter "font-style", values: "normal", "italic", "oblique". More...
 
Stylish::FontVariant fontVariant () const
 CSS parameter "font-variant", values: "normal", "small-caps". More...
 
int fontWeight () const
 CSS parameter "font-weight". More...
 
float glow () const
 Get glow amount. More...
 
Radiant::Color glowColor () const
 Get glow color. More...
 
const Valuable::StyleValuelineHeight () const
 CSS parameter "line-height". More...
 
void load (const QString &filename)
 Loads a file and starts monitoring it for changes. More...
 
void setColor (Radiant::Color color)
 Set text color. More...
 
void setColor (float r, float g, float b, float a)
 Set text color. More...
 
void setDropShadowBlur (float blur)
 Set drop shadow blur. More...
 
void setDropShadowColor (Radiant::Color color)
 Set drop shadow color. More...
 
void setDropShadowOffset (Nimble::Vector2f offset)
 Set drop shadow offset CSS parameter "drop-shadow-offset". More...
 
void setFontFamily (const QStringList &family)
 Sets font family. More...
 
void setFontKerning (Stylish::FontKerning kerning)
 Sets font kerning. More...
 
void setFontRenderingWidth (float width)
 Sets font rendering width. More...
 
void setFontSize (float pointSize)
 Sets font size in points. More...
 
void setFontStretch (Stylish::FontStretch stretch)
 Sets font stretch. More...
 
void setFontStyle (Stylish::FontStyle style)
 Sets font style. More...
 
void setFontVariant (Stylish::FontVariant variant)
 Sets font variant. More...
 
void setFontWeight (int weight)
 Sets font weight. More...
 
void setGlow (float glow)
 Set glow amount. More...
 
void setGlowColor (Radiant::Color glowColor)
 Set glow color. More...
 
void setLineHeight (const Valuable::StyleValue &height)
 
void setStrokeColor (Radiant::Color color)
 Set stroke color. More...
 
void setStrokeWidth (float width)
 Set the stroke width CSS parameter "stroke-width". More...
 
void setText (const QString &text)
 Setter for attribute text. More...
 
void setTextSharpness (float sharpness)
 Adjust sharpness. More...
 
void setWrapMode (QTextOption::WrapMode wrapMode)
 Sets wrap mode. More...
 
const QString & source () const
 
Radiant::Color strokeColor () const
 Get stroke color. More...
 
float strokeWidth () const
 
const QString & text () const
 Text content of the widget. More...
 
 TextInterfaceWidget (WidgetPtr parent=nullptr)
 Constructor. More...
 
float textSharpness () const
 Get font sharpness. More...
 
QTextOption::WrapMode wrapMode () const
 CSS parameter "wrap-mode", values: "auto" (default), "none", "word", "character". More...
 
virtual ~TextInterfaceWidget ()
 Destructor.
 
- Public Member Functions inherited from MultiWidgets::ScrollAreaWidget
bool contentFits () const
 Returns true if the content rect fits to the content box. More...
 
const Nimble::RectfcontentRect () const
 Get the content rectangle. More...
 
bool fitsHorizontally () const
 Returns true if the content fits horizontally into the widget. More...
 
bool fitsVertically () const
 Returns true if the content fits vertically into the widget. More...
 
WidgetPtr horizontalScrollBar () const
 Get the current horizontal scrollbar widget.
 
Luminous::Overflow overflow () const
 Overflow mode of the scroll area. More...
 
void positionHorizontalScrollbar ()
 Sets location to horizontal scrollbar based on scroll value. More...
 
void positionVerticalScrollbar ()
 Sets location to vertical scrollbar based on scroll value. More...
 
bool resizeToContent () const
 Should the widget be automatically resized to the content size. More...
 
const Nimble::Vector2fscroll () const
 Get the current scroll coordinates. More...
 
 ScrollAreaWidget (WidgetPtr parent=nullptr)
 Construct a new ScrollAreaWidget. More...
 
void setContentRect (const Nimble::Rectf &rect)
 Set the content rectangle that defines the scrollable area. More...
 
void setHorizontalScrollBar (const WidgetPtr &widget)
 Set the horizontal scrollbar widget. More...
 
void setOverflow (Luminous::Overflow overflow)
 Setter for attribute overflow. More...
 
void setResizeToContent (bool resize)
 Setter for attribute resize-to-content. More...
 
void setScroll (Nimble::Vector2f scroll)
 Scroll to given coordinates. More...
 
void setShowHorizontalScrollBar (bool show)
 Setter for attribute show-horizontal-scroll-bar. More...
 
void setShowVerticalScrollBar (bool show)
 Setter for attribute show-vertical-scroll-bar. More...
 
void setVerticalScrollBar (const WidgetPtr &widget)
 Set the vertical scrollbar widget. More...
 
bool showHorizontalScrollBar () const
 Is the horizontal scrollbar shown? More...
 
bool showVerticalScrollBar () const
 Is the vertical scrollbar shown? More...
 
WidgetPtr verticalScrollBar () const
 Get the vertical scrollbar widget. More...
 
const Nimble::RectfviewRect () const
 Get the view rectangle. More...
 
virtual ~ScrollAreaWidget ()=0
 Destructor.
 
- Public Member Functions inherited from MultiWidgets::Widget
virtual void addChild (const WidgetPtr &w)
 Add a child to this widget. More...
 
void addOperator (OperatorPtr op)
 Add an operator to the Widget. More...
 
bool allowRotation () const
 Check whether the widget can be rotated. More...
 
float angularDamping () const
 Set the angular damping of the widget, which controls how fast the the angular velocity (omega) will slow down when thrown. More...
 
float angularVelocity () const
 Angular velocity of the widget in radians per second. More...
 
Animationanimation ()
 Get the animation controller for this widget. More...
 
const Animationanimation () const
 Get the animation controller for this widget. More...
 
bool autoRaiseToTop () const
 Returns whether the widget is automatically raised to top. More...
 
virtual Nimble::Rect boundingRect () const
 This function defines the outer bounds of the item as a rectangle in widget coordinates. More...
 
bool checkFlags (Radiant::FlagsT< Flags > flags) const
 Checks the given flags from flags -attribute. More...
 
bool checkInputFlags (Radiant::FlagsT< InputFlags > flags) const
 Checks the given input flags from input-flags -attribute. More...
 
WidgetPtr child (size_t i)
 Return the ith child widget. More...
 
ChildIterator childBegin ()
 Returns an iterator to the first child. More...
 
ConstChildIterator childBegin () const
 Returns an iterator to the first child. More...
 
ChildIterator childEnd ()
 Returns an iterator to the end of the children. More...
 
ConstChildIterator childEnd () const
 Returns an iterator to the end of the children. More...
 
Nimble::Rect childrenRect () const
 Returns the bounding box of this widget's children in widget coordinates. More...
 
ChildReverseIterator childReverseBegin ()
 Returns an iterator addressing the first child element in reverse order. More...
 
ConstChildReverseIterator childReverseBegin () const
 Returns an iterator addressing the first child element in reverse order. More...
 
ChildReverseIterator childReverseEnd ()
 Returns an iterator addressing the next item past the last child in a reversed order. More...
 
ConstChildReverseIterator childReverseEnd () const
 Returns an iterator addressing the next item past the last child in a reversed order. More...
 
void clearFlags (Radiant::FlagsT< Flags > flags)
 Sets the given widget flags to zero in flags. More...
 
void clearInputFlags (Radiant::FlagsT< InputFlags > flags)
 Sets the given widget input flags to zero in input-flags. More...
 
WidgetPtr clone () const
 Create a clone of the widget. More...
 
bool contains (const Widget &w) const
 Checks whether the given widget is fully inside the area of this widget. More...
 
float damping () const
 The damping of the Widget controls how quickly the Widget will slow down and stop when thrown. More...
 
float depth () const
 Depth of the widget. More...
 
virtual bool deserialize (const Valuable::ArchiveElement &element)
 Deserializes the widget's attributes and its descendants from given archive element. More...
 
DisplayMode display () const
 Controls widget visibility. More...
 
void dropAllGrabs (GrabManager &input)
 Drops all the grabs that this Widget has. More...
 
virtual void dumpInfo (FILE *f=nullptr, int indent=0)
 Dump information about this widget to the given file. More...
 
virtual void eventProcess (const QByteArray &id, Radiant::BinaryData &data)
 Entry point for incoming events Class specific behaviour to events is implemented in this function. More...
 
float extraInputCaptureRadius () const
 Extra radius (in widget coordinates) used when input is processed. More...
 
template<typename W = Widget>
QList< Radiant::IntrusivePtr< W > > find (const QString &cssSelector)
 Find all descendant widgets that match the given CSS selector and can be casted to given type. More...
 
template<>
QList< WidgetPtrfind (const QString &cssSelector)
 
virtual void fingerDown (MultiTouch::Finger f, MultiWidgets::GrabManager &gm)
 Called when a new finger is grabbed by the widget. More...
 
virtual void fingerUp (MultiTouch::Finger f, MultiWidgets::GrabManager &gm)
 Called when a finger is ungrabbed by the widget When this function is called the finger is already ubgrabbed by the widget and it does not lie anymore in array returned by grabbedFingers This function is meant to be overriden: the default implementation is empty. More...
 
Radiant::FlagsT< Flagsflags () const
 Widget flags define common behaviour of widget. More...
 
bool forceRendering () const
 See whether forced rendering is enabled. More...
 
OperatorPtr getOperator (size_t i)
 Returns the ith operator. More...
 
template<class T >
QList< std::shared_ptr< T > > getOperatorsOfType ()
 Returns all the operator pointers that contain operator of the given type. More...
 
FingerIds grabbedFingers () const
 Returns all grabbed fingers. More...
 
HandIds grabbedHands () const
 Returns a list of hand ids that are grabbed by this widget. More...
 
MarkerIds grabbedMarkers () const
 Returns a list of marker ids that are grabbed by this widget. More...
 
PenIds grabbedPens () const
 Returns a list of pen ids that are grabbed by this widget. More...
 
TrackedObjectIds grabbedTrackedObjects () const
 Shortcut for InputGrabber::grabbedObjects. More...
 
virtual void handDown (MultiTouch::Hand h, MultiWidgets::GrabManager &gm)
 Called when a hand is grabbed by the widget This function is meant to be overriden: the default implementation is empty. More...
 
virtual void handUp (MultiTouch::Hand h, MultiWidgets::GrabManager &gm)
 Called when a hand is ungrabbed by the widget This function is meant to be overriden: the default implementation is empty. More...
 
virtual bool hasActiveOperators (bool recursive)
 Returns true if the Widget currently has active operators. More...
 
bool hasChild (const WidgetPtr &w, bool recursive=false)
 Returns true if the widget has w as a child or descendant. More...
 
virtual bool hasInteraction (Radiant::FlagsT< MultiTouch::TrackedObjectType > types=MultiTouch::TYPE_ALL, bool recursive=false) const
 Check if the widget is currently being interacted with. More...
 
bool hasOperator (OperatorPtr op) const
 Checks if the given operator is attached to the widget. More...
 
template<typename T >
bool hasOperatorType () const
 Checks if the given operator type is present in the operators. More...
 
virtual void hide ()
 Hide the widget. More...
 
virtual void input (MultiWidgets::GrabManager &gm, float dt) final
 Send input to a Widget. More...
 
Radiant::FlagsT< InputFlagsinputFlags () const
 Current input processing parameters which determine how this widget will react to input. More...
 
InputGrabberinputGrabber ()
 Get the input grabber for the widget. More...
 
const InputGrabberinputGrabber () const
 Get the input grabber for the widget. More...
 
bool inputMotion () const
 Check if this widget has any input motion flag enabled. More...
 
bool inputTaps () const
 Check if widget listens single-tap events. More...
 
Radiant::TimeStamp interactionBegan () const
 Returns the time when the last interaction started on the widget. More...
 
Nimble::Vector2 interactionCenter () const
 Current or previous interaction center in widget coordinates. More...
 
bool intersects (const Widget &w) const
 Check if this widget intersects referenced widget. More...
 
virtual Nimble::SizeF intrinsicSize () const
 The preferred size of the Widget without scaling. More...
 
bool isDisplayed () const
 Checks whether the value of display is not none. More...
 
bool isFixed () const
 Returns true if the widget has been set to immovable. More...
 
bool isGrabbed (MultiTouch::TrackedObject::Id id) const
 Checks if a given object is grabbed by this widget. More...
 
bool isInOrphanTree () const
 Is this widget a part of a subtree that is not connected to non-orphan widget.
 
virtual bool isInside (Nimble::Vector2f v) const
 Test if the given point is inside the Widget. More...
 
virtual bool isReady (bool recursive) const final
 Recursive version of isReady. More...
 
virtual bool isReady () const
 Is the widget ready to be displayed on screen. More...
 
bool isVisible () const
 Checks whether the value of display is not none. More...
 
virtual Radiant::TimeStamp lastInteractionTime (bool recursive=false) const
 Timestamp of the last interaction on this Widget. More...
 
void lower (int levels, bool force=false)
 Lower the widget below its siblings. More...
 
void lowerToBottom (bool recursive=false)
 Brings this Widget behind its siblings and its parent If the lock-depth flag has been raised, then this widget will not change its depth and only the recursive functionality will take effect. More...
 
Nimble::Vector2f mapFromParent (const Nimble::Vector2f &p) const
 Transform a point from parent coordinates to Widget coordinates. More...
 
Nimble::Vector2f mapFromScene (const Nimble::Vector2f &p) const
 Transform a point from scene coordinates to Widget coordinates. More...
 
Nimble::Vector2f mapToParent (const Nimble::Vector2f &p) const
 Transform a point from Widget coordinates to parent coordinates. More...
 
Nimble::Vector2f mapToParent (Widget &w, const Nimble::Vector2f &p) const
 Transform a point from Widget coordinates to its ancestor coordinates. More...
 
Nimble::Vector2f mapToScene (const Nimble::Vector2f &p) const
 Transform a point from Widget coordinates to scene coordinates. More...
 
virtual void markerDown (MultiTouch::Marker m, MultiWidgets::GrabManager &gm)
 Called when a new marker is grabbed by the widget. More...
 
virtual void markerUp (MultiTouch::Marker m, MultiWidgets::GrabManager &gm)
 Called when a marker is ungrabbed by the widget. More...
 
float maximumTapMotion () const
 Adjusts the limit for recognizing taps within this Widget. More...
 
float maximumTapTime () const
 Adjusts the time limit for recognizing taps. More...
 
size_t numChildren () const
 Returns the number of child Widgets. More...
 
float opacity () const
 Transparency factor that gets recursively applied to any child widgets this widget has. More...
 
size_t operatorCount () const
 Returns the number of operators applied to this Widget. More...
 
const Operatorsoperators () const
 
Nimble::Vector2 origin () const
 Relative origin of the widget coordinates. More...
 
WidgetPtr parent () const
 Get a pointer to the Widget's parent. More...
 
virtual void parentChanged (WidgetPtr oldParent)
 This is called after the parent has changed. More...
 
virtual void penDown (MultiTouch::Pen p, MultiWidgets::GrabManager &gm)
 Called when a pen is grabbed by the widget. More...
 
virtual void penUp (MultiTouch::Pen p, MultiWidgets::GrabManager &gm)
 Called when a pen is ungrabbed by the widget This function is meant to be overriden: the default implementation is empty. More...
 
virtual void processInput (MultiWidgets::GrabManager &gm, float dt)
 Do extra input processing. More...
 
void raise (int levels, bool force=false)
 Raise the widget above its sibings. More...
 
void raiseFlags (Radiant::FlagsT< Flags > flags)
 Raises the given widget flags. More...
 
void raiseInputFlags (Radiant::FlagsT< InputFlags > flags)
 Raises the given widget input flags. More...
 
void raiseToTop (bool recursive=false)
 Brings this Widget to the front of its siblings and its parent. More...
 
virtual void removeChild (const WidgetPtr &w)
 Removes the child from this widget's child list if present. More...
 
void removeChildren ()
 Remove all child widgets from the widget.
 
virtual void removeFromParent ()
 Removes this widget from its parent (if any).
 
bool removeOperator (OperatorPtr op)
 Removes the given operator from the widget. More...
 
template<class T >
void removeOperatorType ()
 Removes all operators of given type. More...
 
virtual void render (Luminous::RenderContext &r) const final
 Render the Widget and recursively its children This function calls the rest of the rendering functions that can be overridden to specialize parts of the Widget rendering. More...
 
void reparent (WidgetPtr newParent)
 Change the widget parent to a new one while maintaining the position of widget in the scene coordinates. More...
 
float rotation () const
 Clockwise rotation of the Widget in radians, relative to the parent. More...
 
float rotationTo (const Widget &ancestor) const
 Returns the rotation relative to the given ancestor of widget. More...
 
float scale () const
 Scale of the Widget. More...
 
float scaleDamping () const
 Set the scale damping of the widget. More...
 
Nimble::Rectangle sceneGeometry () const
 Return the Widget rectangle in scene coordinates. More...
 
float sceneRotation () const
 Return the rotation of the Widget relative to the scene. More...
 
float sceneScale () const
 Return the scale of the widget relative to the scene. More...
 
Nimble::Matrix3 sceneTransform () const
 Returns the Widget's scene transformation matrix. More...
 
void setAllowRotation (bool allowRotation)
 If allowed, the Widget can be rotated. More...
 
void setAngularDamping (float angularDamping)
 Setter for attribute angular-damping. More...
 
void setAngularVelocity (float angularVelocity)
 Setter for attribute omega. More...
 
void setAutoRaiseToTop (bool v)
 Set automatic raise-to-top behaviour. More...
 
virtual void setCenterLocation (Nimble::Vector2 location)
 Sets the location of the widget center in parent coordinates The same effect is achieved by setting origin to (0.5, 0.5) and then modifying the value of location. More...
 
void setDamping (float damping)
 Setter for attribute damping. More...
 
void setDepth (float z)
 
void setDisplay (DisplayMode mode)
 Setter for attribute display. More...
 
void setExtraInputCaptureRadius (float radius)
 Setter for attribute extra-input-capture-radius. More...
 
void setFixed ()
 If set to fixed, the widget can not be moved but it will still get input. More...
 
void setFlags (Radiant::FlagsT< Flags > flags)
 Setter for attribute flags. More...
 
void setForceRendering (bool v)
 Shortcut for raising or lowering force-rendering-flag in widget's flags. More...
 
void setInOrphanTree (bool value)
 Sets this widget and all its descendants to orphan tree.
 
void setInputFlags (Radiant::FlagsT< InputFlags > flags)
 Setter for attribute input-flags. More...
 
void setInputTransparent ()
 This function makes the widget pass all the input data to its children and operators if input-operators flag has been raised in input-flags. More...
 
void setMaximumTapMotion (float maxMotionPixels)
 Setter for attribute maximum-tap-motion. More...
 
void setMaximumTapTime (float maxTapTimeSeconds)
 Setter for attribute maximum-tap-time. More...
 
void setOpacity (float opacity)
 Setter for attribute opacity. More...
 
void setOrigin (const Nimble::Vector2 &origin)
 Setter for attribute origin. More...
 
void setPointLocation (Nimble::Vector2 location, Nimble::Vector2 pointOnWidget)
 Sets the location of a point on the widget widget center in parent coordinates of location. More...
 
void setRelativePointLocation (Nimble::Vector2 location, Nimble::Vector2 pointOnWidgetRelative)
 Sets the location of a point on the widget widget center in parent coordinates of location. More...
 
void setRotation (float r)
 Setter for attribute rotation. More...
 
void setRotationAboutCenter (float r)
 Set the rotation of the widget about its center. More...
 
void setRotationAboutPivot (float r, Nimble::Vector2 pivot)
 Set the rotation of the widget about a point relative to the widget size Will modify the values of rotation and location. More...
 
void setRotationAboutPivotAbsolute (float r, Nimble::Vector2 pivot)
 Set the rotation of the widget about an arbitrary point in widget coordinates. More...
 
void setRotationAboutScenePoint (float r, Nimble::Vector2 scenePt)
 Set the rotation of the widget about an arbitrary point in scene coordinates. More...
 
virtual void setScale (float s)
 Setter for attribute scale. More...
 
void setScaleAboutCenter (float s)
 Set the scale of the widget about its center. More...
 
void setScaleAboutPivotAbsolute (float s, Nimble::Vector2 pivot)
 Set the scale of the widget about an arbitrary point in widget coordinates. More...
 
void setScaleDamping (float scaleDamping)
 Setter for attribute scale-damping. More...
 
virtual bool setStyle (const Stylish::Style &style)
 Sets given style for the widget. More...
 
void setTouchArea (TouchArea area)
 Setter for attribute touch-area. More...
 
void setVelocity (const Nimble::Vector2f &v)
 Set the velocity of the Widget in pixels per second. More...
 
void setVelocity (float xvel, float yvel)
 Set the velocity of the Widget in pixels per second. More...
 
void setVisible (bool v)
 Hides or shows the widget. More...
 
virtual bool shouldGrab (GrabManager &gm, MultiTouch::TrackedObject obj) const
 Should this widget grab the given object during the input. More...
 
virtual void show ()
 Show the widget. More...
 
void stopMotion ()
 Stops all motion of the widget. More...
 
const
MultiWidgets::TrackedObjectIds
tapIds () const
 Returns a set of ids of fingers possibly tapping the widget. More...
 
bool tapIsPossible () const
 Check if the currently ongoing gesture (if any) is possibly a tap. More...
 
unsigned tapObjectCount () const
 Query the number of possible tap objects. More...
 
WidgetPtr topParent () const
 Return a pointer to the Widget's top-level parent. More...
 
void touch ()
 Set the last interaction time to current time. More...
 
TouchArea touchArea () const
 Controls the default touchable area of the widget. More...
 
virtual void trackedObjectDown (MultiTouch::TrackedObject o, MultiWidgets::GrabManager &gm)
 Called when a new tracked object is grabbed by the widget. More...
 
virtual void trackedObjectUp (MultiTouch::TrackedObject o, MultiWidgets::GrabManager &gm)
 Called when a new tracked object is ungrabbed by the widget This function is meant to be overriden: the default implementation is empty. More...
 
size_t transferGrabs (WidgetPtr target, GrabManager &gm, Radiant::FlagsT< MultiTouch::TrackedObjectType > types, bool recursive=false)
 Transfer grabs from this widget to another. More...
 
const Nimble::Matrix3transform () const
 Return this Widget's transformation matrix relative to its parent. More...
 
const Nimble::Matrix4ftransform3D () const
 Return this Widget's 3D transformation matrix relative to its parent. More...
 
virtual QByteArray type () const
 This returns the plugin name of this Widget. More...
 
const Nimble::Vector2velocity () const
 Return the current velocity of the Widget. More...
 
virtual void visualFocusChange (bool gotFocus)
 Call-back function for informing the Widget of a change in users' visual focus This function is called by the application as deemed fit. More...
 
 Widget (WidgetPtr parent=nullptr)
 Construct a new Widget. More...
 
virtual ~Widget ()
 Destroys this Widget and frees references to all its children. More...
 
- Public Member Functions inherited from Stylish::CSSBoxModel
AttributeBackgroundbackground ()
 
const AttributeBackgroundbackground () const
  More...
 
Nimble::Rectf backgroundBox () const
 Background painting area, depends on background-clip value. More...
 
Radiant::Color backgroundColor () const
 
AttributeBorderborder ()
 
const AttributeBorderborder () const
  More...
 
Stylish::Border borderBottom () const
 Gets the bottom border that contains the width, style and color. More...
 
Nimble::Rectf borderBox () const
 Border box, rectangle that includes content, padding and border. More...
 
Nimble::Frame4f borderFrame () const
 Size of the border. More...
 
Stylish::Border borderLeft () const
 Gets the left border that contains the width, style and color. More...
 
Stylish::Border borderRight () const
 Gets the right border that contains the width, style and color. More...
 
Stylish::Border borderTop () const
 Gets the top border that contains the width, style and color. More...
 
float bottom () const
 Get the y coordinate of the bottom of the box.
 
Nimble::SizeF boxSize () const
 Calculates total amount of screen estate taken by the box by adding size, padding, border and margin together. More...
 
Nimble::Rectf contentBox () const
 Content box, rectangle that includes only the content area. More...
 
float height () const
 Height of this box in pixels.
 
Nimble::Vector2 location () const
 The location of this object in pixels in its parent's coordinate system. More...
 
Nimble::Frame4f margin () const
 Size of the margin. More...
 
Nimble::Rectf marginBox () const
 Margin box, rectangle that includes content, padding, border and margin. More...
 
Nimble::Frame4f padding () const
 Size of the padding. More...
 
Nimble::Rectf paddingBox () const
 Padding box, rectangle that includes content and padding but excludes border area. More...
 
void setBackgroundColor (Radiant::Color color)
 
void setBackgroundColor (float red, float green, float blue, float alpha)
 
virtual void setBorderColor (const Radiant::Color &c)
 Sets the color for all borders.
 
void setBorderColor (float r, float g, float b, float a)
 
virtual void setBorderFrame (const Nimble::Frame4f &border)
 Sets the width for all borders. More...
 
void setBorderStyle (Border::Style style)
 Sets the style for all borders.
 
void setBorderWidth (float width)
 Sets the width for all borders.
 
void setHeight (float height, ValueUnit unit=VU_PXS)
 Set the height of the box.
 
void setLocation (Nimble::Vector2 location)
 Setter for attribute location. More...
 
void setLocation (Nimble::Vector2 location, ValueUnit unit)
 Set the location of this object. More...
 
void setLocation (float x, float y)
 Set the location of this object. More...
 
void setLocation (float x, float y, ValueUnit unit)
 Set the location of this object. More...
 
void setMargin (const Nimble::Frame4f &margin)
 Setter for attribute margin. More...
 
void setMargin (float one_side_margin)
 Set the size of the margin for all sides to be equal.
 
virtual void setPadding (const Nimble::Frame4f &padding)
 Setter for attribute padding. More...
 
void setPadding (float oneSidePadding)
 Set the size of the padding for all sides to be equal. More...
 
void setSize (Nimble::SizeF size)
 Setter for attribute size. More...
 
void setSize (float width, float height, ValueUnit unit=VU_PXS)
 Set box size. More...
 
void setSize (Nimble::SizeF size, ValueUnit widthUnit, ValueUnit heightUnit)
 Set box size. More...
 
void setWidth (float width, ValueUnit unit=VU_PXS)
 Set the width of the box.
 
void setX (float x, ValueUnit unit=VU_PXS)
 Set the x component of the location of this box.
 
void setY (float y, ValueUnit unit=VU_PXS)
 Set the y component of the location of this box.
 
Nimble::SizeF size () const
 Box size in pixels. More...
 
float width () const
 Width of this box in pixels.
 
float x () const
 Get the x component of the location of this box in pixels.
 
float y () const
 Get the y component of the location of this box in pixels.
 
- Public Member Functions inherited from Stylish::Styleable
void addCSSClass (const QString &s)
 Adds the Styleable to CSS class s. More...
 
void addCSSClasses (const QStringList &classes)
 Adds the Styleable to given CSS classes. More...
 
QString attributeSource (const QByteArray &name) const
 Gets CSS declaration source location based on the attribute name For example if this object has "size" attribute that is set from a CSS file, attributeSource("size") would return "filename.css:line". More...
 
const Style & childStyle () const
 Cached style that should be applied to all children of this object.
 
const Radiant::ArraySet
< QByteArray > & 
cssClasses () const
 Get the CSS classes of the Styleable in lowercase.
 
const QString & cssClassStr () const
 Get the CSS classes of the Styleable as a space separated string. More...
 
QString cssId () const
 Get the CSS id of the Styleable. More...
 
const QByteArray & cssType () const
 Get the CSS type of the Styleable.
 
bool hasCSSClass (const QByteArray &s) const
 Does the Styleable belong to given CSS class. More...
 
bool match (const SimpleSelector &ss, int *specificityOut=nullptr) const
 Checks if SimpleSelector matches this object. More...
 
bool pseudoClass (const QByteArray &name) const
 Query if the Styleable has pseudo class called name.
 
void removeCSSClass (const QString &s)
 Remove the Styleable from CSS class s. More...
 
void setCSSClasses (const QString &s)
 Set the CSS classes as a space separated list You almost always want to use addCSSClass instead of this one. More...
 
void setCSSId (const QString &s)
 Set the CSS id of the Styleable. More...
 
void setCSSType (const QByteArray &s)
 Set the CSS type of the Styleable.
 
virtual bool setProperty (Valuable::Attribute &var, const Valuable::StyleValue &value, Layer layer)
 Converts the given Stylish::Value to Valuable::Attribute.
 
void setPseudoClass (const QByteArray &name, bool state)
 Disable or enable pseudo class.
 
virtual bool setStyle (const Style &style)
 Applies a style to the object. More...
 
QString simpleSelector (bool includePseudoClasses=true) const
 Returns a CSS simple selector that matches this Styleable.
 
const Style & style () const
 Returns the style for this object.
 
 Styleable (const QByteArray &name="Styleable")
 Constructor for Styleable. More...
 
- Public Member Functions inherited from Valuable::Node
bool acceptsEvent (const QByteArray &messageId) const
 Returns true if this object accepts event 'id' in eventProcess.
 
bool addAttribute (Attribute *const attribute)
 Adds a new Attribute to the list of attribute objects. More...
 
bool addAttribute (const QByteArray &name, Attribute *const attribute)
 Adds a new Attribute to the list of attribute objects.
 
template<typename Widget >
bool addAttribute (const QByteArray &name, const Radiant::IntrusivePtr< Widget > &attribute)
 Adds a new Attribute to the list of attribute objects. More...
 
long addListener (const QByteArray &attribute, v8::Persistent< v8::Function > func, int role=Attribute::CHANGE_ROLE)
 Add a JavaScript attribute listener to attribute belonging this Node. More...
 
virtual Attributeattribute (const QByteArray &name) const
 Gets an Attribute with the given name. More...
 
template<typename T >
AttributeT< T > * attribute (const QByteArray &name) const
 Gets an Attribute with the given name. More...
 
const containerattributes () const
 
void clearValues (Layer layer)
 Clears all Attribute values of the given layer. More...
 
void debugDump ()
 Prints the contents of this Attribute to the terminal.
 
void eventAddDeprecated (const QByteArray &deprecatedId, const QByteArray &newId)
 Register a deprecated event that is automatically converted to new event id and a warning is issued when it is used. More...
 
void eventAddIn (const QByteArray &messageId)
 Registers a new event that this class handles in eventProcess.
 
template<typename Widget >
long eventAddListener (const QByteArray &eventId, const QByteArray &messageId, Radiant::IntrusivePtr< Widget > &listener, ListenerType listenerType=DIRECT, const Radiant::BinaryData *defaultData=0)
 Add an event listener to this object. More...
 
long eventAddListener (const QByteArray &eventId, const QByteArray &messageId, Valuable::Node *listener, ListenerType listenerType=DIRECT, const Radiant::BinaryData *defaultData=0)
 Add an event listener to this object. More...
 
long eventAddListener (const QByteArray &eventId, ListenerFuncVoid func, ListenerType listenerType=DIRECT)
 Add an event listener to this object. More...
 
long eventAddListener (const QByteArray &eventId, Node *dstNode, ListenerFuncVoid func, ListenerType listenerType=DIRECT)
 
long eventAddListenerBd (const QByteArray &eventId, Node *dstNode, ListenerFuncBd func, ListenerType listenerType=DIRECT)
 
long eventAddListenerBd (const QByteArray &eventId, ListenerFuncBd func, ListenerType listenerType=DIRECT)
 Add an event listener to this object. More...
 
void eventAddOut (const QByteArray &eventId)
 Registers a new event this class can send with eventSend.
 
const QSet< QByteArray > & eventInNames () const
 Returns set of all registered IN events.
 
unsigned eventListenerCount () const
 Returns the number of event listeners.
 
const QSet< QByteArray > & eventOutNames () const
 Returns set of all registered OUT events.
 
void eventPassingEnable (bool enable)
 Control whether events are passed.
 
template<typename Widget >
int eventRemoveListener (Radiant::IntrusivePtr< Widget > &listener)
 Removes all events from this object to given listener. More...
 
template<typename Widget >
int eventRemoveListener (const QByteArray &eventId=QByteArray(), const QByteArray &messageId=QByteArray(), Radiant::IntrusivePtr< Widget > &listener=Radiant::IntrusivePtr< Widget >())
 Removes events from this object that match the parameters. More...
 
int eventRemoveListener (const QByteArray &eventId=QByteArray(), const QByteArray &messageId=QByteArray(), Valuable::Node *listener=0)
 Removes event listeners from this object. More...
 
int eventRemoveListener (Valuable::Node *listener)
 Removes all events from this object to given listener. More...
 
bool eventRemoveListener (long listenerId)
 Removes event listener with given id. More...
 
void eventSend (const QByteArray &eventId, Radiant::BinaryData &bd)
 Sends an event and bd to all listeners on this eventId.
 
void eventSend (const QByteArray &eventId)
 Sends an event to all listeners on this eventId.
 
template<typename P1 >
void eventSend (const QByteArray &eventId, const P1 &p1)
 Sends an event to all listeners on this eventId. More...
 
template<typename P1 , typename P2 >
void eventSend (const QByteArray &eventId, const P1 &p1, const P2 &p2)
 Sends an event to all listeners on this eventId. More...
 
template<typename P1 , typename P2 , typename P3 >
void eventSend (const QByteArray &eventId, const P1 &p1, const P2 &p2, const P3 &p3)
 Sends an event to all listeners on this eventId. More...
 
template<typename P1 , typename P2 , typename P3 , typename P4 >
void eventSend (const QByteArray &eventId, const P1 &p1, const P2 &p2, const P3 &p3, const P4 &p4)
 Sends an event to all listeners on this eventId. More...
 
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 >
void eventSend (const QByteArray &eventId, const P1 &p1, const P2 &p2, const P3 &p3, const P4 &p4, const P5 &p5)
 Sends an event to all listeners on this eventId. More...
 
unsigned eventSourceCount () const
 Returns the number of event sources.
 
Uuid id () const
 Returns the unique id.
 
bool isBeingDestroyed () const
 Returns true if we are about to delete this object. More...
 
bool loadFromFileXML (const QString &filename)
 Reads this object (and its children) from an XML file.
 
bool loadFromMemoryXML (const QByteArray &buffer)
 Reads this object (and its children) from a memory buffer.
 
 Node (Node *host, const QByteArray &name="", bool transit=false)
 Constructs a new Node and adds it under the given host. More...
 
 Node (Node &&node)
 Moves a node, including all its attributes, events etc. More...
 
Nodeoperator= (Node &&node)
 Moves a node, replacing this. More...
 
virtual bool readElement (const ArchiveElement &element)
 Handles a serialization element that lacks automatic handlers. More...
 
void removeAttribute (Attribute *const attribute)
 Removes an Attribute from the list of attribute objects.
 
bool saveToFileXML (const QString &filename, unsigned int opts=SerializationOptions::DEFAULTS) const
 Saves this object (and its children) to an XML file.
 
bool saveToMemoryXML (QByteArray &buffer, unsigned int opts=SerializationOptions::DEFAULTS) const
 Saves this object (and its children) to binary data buffer.
 
virtual ArchiveElement serialize (Archive &doc) const
 Serializes this object (and its children) to a DOM node.
 
virtual void setAsDefaults ()
 Sets the current USER attribute value as the default value and clears the USER value. More...
 
void setId (Uuid newId)
 Sets the unique id. More...
 
template<class T >
bool setValue (const QByteArray &name, const T &v)
 Uses a query string to find a Attribute, and sets a new value to that if found. More...
 
bool setValue (const QByteArray &name, v8::Handle< v8::Value > v)
 Set attribute value from JavaScript. More...
 
- Public Member Functions inherited from Valuable::Attribute
long addListener (ListenerFunc func, int role=CHANGE_ROLE)
 Adds a listener that is invoked whenever the value is changed. More...
 
long addListener (Node *listener, ListenerFunc func, int role=CHANGE_ROLE)
 Adds a listener that is invoked whenever the value is changed. More...
 
long addListener (v8::Persistent< v8::Function > func, int role=CHANGE_ROLE)
 Adds a JavaScript listener that is invoked whenever the value is changed. More...
 
virtual float asFloat (bool *const ok=0, Layer layer=LAYER_CURRENT) const
 Converts the value object in a floating point number. More...
 
virtual int asInt (bool *const ok=0, Layer layer=LAYER_CURRENT) const
 Converts the value object in an integer. More...
 
virtual QString asString (bool *const ok=0, Layer layer=LAYER_CURRENT) const
 Converts the value object to a string. More...
 
 Attribute (const Attribute &o)
 Create a copy of the given Attribute WITHOUT the link to host, listeners, or the attribute name. More...
 
 Attribute (Node *host, const QByteArray &name, bool transit=false)
 Constructs a new value object and attaches it to its host. More...
 
virtual void clearValue (Layer layer)
 Unsets the value from a specific layer. More...
 
virtual void emitChange ()
 Invokes the change valueChanged function of all listeners.
 
void eventProcessFloat (const char *id, float v)
 Utility function for sending a float message to the object.
 
void eventProcessInt (const char *id, int v)
 Utility function for sending an int message to the object.
 
void eventProcessString (const char *id, const QString &str)
 Utility function for sending string message to the object.
 
void eventProcessString (const char *id, const char *str)
 Utility function for sending string message to the object.
 
void eventProcessVector2 (const char *id, Nimble::Vector2)
 Utility function for sending a Nimble::Vector2f message to the object.
 
void eventProcessVector3 (const char *id, Nimble::Vector3)
 Utility function for sending a Vector3 message to the object.
 
void eventProcessVector4 (const char *id, Nimble::Vector4)
 Utility function for sending a Vector4 message to the object.
 
virtual bool handleShorthand (const Valuable::StyleValue &value, Radiant::ArrayMap< Valuable::Attribute *, Valuable::StyleValue > &expanded)
 If attribute supports shorthand properties, this should be used to parse those. More...
 
Nodehost () const
 The host object of the value object (is any). More...
 
virtual bool isChanged () const
 
virtual bool isValueDefinedOnLayer (Layer layer) const
 Check if the given layer defines a value. More...
 
bool layerForSerialization (SerializationOptions flags, Layer &layer) const
 
const QByteArray & name () const
 Returns the name of the object.
 
const Attributeoperator= (const Attribute &)
 Create a copy of the given Attribute WITHOUT the link to host, listeners, or the attribute name. More...
 
AttributeownerShorthand () const
 
QByteArray path () const
 Returns the path (separated by '/'s) from the root.
 
void removeHost ()
 Sets the host pointer to zero and removes this object from the host. More...
 
bool removeListener (Node *listener, int role=ALL_ROLES)
 Removes a listener from the listener list. More...
 
bool removeListener (long id)
 Removes a listener from the listener list. More...
 
void removeListeners (int role=ALL_ROLES)
 Removes listeners from the listener list.
 
virtual bool set (float v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
 Sets the value of the object.
 
virtual bool set (int v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
 Sets the value of the object.
 
virtual bool set (const QString &v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
 Sets the value of the object.
 
virtual bool set (const Nimble::Vector2f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
 Sets the value of the object.
 
virtual bool set (const Nimble::Vector3f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
 Sets the value of the object.
 
virtual bool set (const Nimble::Vector4f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
 Sets the value of the object.
 
virtual bool set (const StyleValue &value, Layer layer=USER)
 Sets the value of the object.
 
void setName (const QByteArray &s)
 Sets the name of the object.
 
void setOwnerShorthand (Attribute *owner)
 
- Public Member Functions inherited from Valuable::Serializable
virtual bool deserializeXML (const DOMElement &element)
 Deserializes (reads) this object from an XML element. More...
 
bool isSerializable () const
 
void setSerializable (bool v)
 

Protected Member Functions

virtual void loadText (const QString &text)
 
virtual void renderContent (Luminous::RenderContext &r) const
 Render the content of the Widget. More...
 
void useVerticalTextOffset (bool use)
 
float verticalTextOffset () const
 
- Protected Member Functions inherited from MultiWidgets::TextInterfaceWidget
const Luminous::TextStyletextStyle () const
 

Additional Inherited Members

- Static Public Member Functions inherited from MultiWidgets::Widget
static std::vector< WidgetPtrallWidgets ()
 
static void calculateMotion (const FingerArray &fingers, Nimble::Vector2f &translate, float &scale, float &rotate, Nimble::Vector2f &prevCenter)
 Computes the translation, rotation, and scale to apply to widget based on the interacting fingers. More...
 
static void checkOrphanTrees ()
 
static WidgetPtr create (const Valuable::ArchiveElement &element)
 Creates and deserializes a widget from the given archive. More...
 
static WidgetPtr findById (Uuid id)
 Search Widget by its id. More...
 
static void listExistingWidgetsToTerminal ()
 List existing widgets to terminal, for debugging.
 
static std::size_t widgetCount ()
 Returns the number of widget instances in the application. More...
 
- Protected Attributes inherited from Stylish::CSSBoxModel
AttributeBackground m_background
 Background for this box.
 
AttributeBorder m_cssBorder
 Borders for this box.
 
Valuable::AttributeFrame m_cssMargin
 Size of the margin for this box (top, right, bottom, left)
 
Valuable::AttributeFrame m_cssPadding
 Size of the padding (top, right, bottom, left)
 
Valuable::AttributeLocation2f m_location
 Location of the upper-left corner.
 
Valuable::AttributeSizeF m_size
 Size of the content-box of the widget.
 

Detailed Description

A widget for displaying simple text.

This widget supports simple basic text, that is used in labels or other cases of "plain text". Text appearance can be adjusted with the selection of font, font size, kerning etc. The parameters affect all text inside this widget.

Examples:
MixedJavaScriptExample.js.

Member Enumeration Documentation

Text alignment, "text-align", http://www.w3.org/TR/css3-text/#text-align CSS3 Text module only has horizontal text align, and vertical-align/box-align properties are very different beasts.

Therefore, we have extended text-align with our own vertical alignment flags.

Enumerator
TEXT_ALIGN_START 

"start"

TEXT_ALIGN_END 

"end"

TEXT_ALIGN_LEFT 

"left"

TEXT_ALIGN_RIGHT 

"right"

TEXT_ALIGN_HCENTER 

"hcenter", center text horizontally In CSS3 this is just "center", but we use "center" to align both vertically and horizontally.

TEXT_ALIGN_JUSTIFY 

"justify"

TEXT_ALIGN_TOP 

"top", aligns the text to top using bounding box (not using line height etc)

TEXT_ALIGN_VCENTER 

"vcenter", aligns the bounding box vertically to center of the widget

TEXT_ALIGN_BOTTOM 

"bottom", aligns the text to bottom using bounding box (not using baseline etc)

TEXT_ALIGN_CENTER 

"center", align both vertically and horizontally, this differs from CSS3 "center"

Constructor & Destructor Documentation

MultiWidgets::TextWidget::TextWidget ( WidgetPtr  parent = nullptr)
explicit

Constructs TextWidget without content.

Parameters
parentParent widget
MultiWidgets::TextWidget::TextWidget ( const QString &  text,
WidgetPtr  parent = nullptr 
)

Constructs TextWidget with the given text.

Parameters
textText for the widget
parentParent widget

Member Function Documentation

virtual float MultiWidgets::TextWidget::heightForWidth ( float  width) const
virtual

Returns the height of the widget for the given width while maintaining aspect ratio.

Parameters
widthWidth to get the height for.
Returns
Height for the given width.

Reimplemented from MultiWidgets::Widget.

const Valuable::StyleValue & MultiWidgets::TextWidget::letterSpacing ( ) const

CSS parameter "letter-spacing" Unlike the CSS3 parameter, you can also specify percentage values here.

Parameters
spacingspacing in absolute values or percentages (relative to the original value)
See Also
http://www.w3.org/TR/css3-text/#letter-spacing
setLetterSpacing
Returns
Current value of the letter-spacing attribute
virtual void MultiWidgets::TextWidget::renderContent ( Luminous::RenderContext r) const
protectedvirtual

Render the content of the Widget.

This function is called from the main render function. Does nothing by default.

Overriding: Usually custom rendering of the widget should go here. This is empty by default so there is no need to call the implementation of the base class.

Parameters
rRender context of the rendering thread

Reimplemented from MultiWidgets::Widget.

Reimplemented in MultiWidgets::TextEditWidget.

void MultiWidgets::TextWidget::setLetterSpacing ( const Valuable::StyleValue letterSpacing)

Setter for attribute letter-spacing.

See Also
letterSpacing
Parameters
letterSpacingnew attribute value
void MultiWidgets::TextWidget::setTextAlign ( Radiant::FlagsT< TextAlign alignFlags)

Sets text align.

Setter for attribute text-align.

Parameters
alignFlagsCollection of alignments combined with bitwise or
See Also
textAlign
Stylish::AttributeFont::setTextAlign
Parameters
alignFlagsnew attribute value
Radiant::FlagsT< TextWidget::TextAlign > MultiWidgets::TextWidget::textAlign ( ) const

CSS parameter "text-align", see TextAlign for allowed values.

See Also
ScrollAreaWidget::overflow
TextEditWidget::follow-cursor
setTextAlign
Returns
Current value of the text-align attribute
virtual void MultiWidgets::TextWidget::update ( const FrameInfo frameInfo)
virtual

Update widget state.

This function is called by the application during its update step. This function may be called several times per rendered frame. This function is always called after input() and before render(). If you need to know if this call is the last update for this rendered frame, use the FrameInfo::isLastUpdate(). The default implementation is empty.

Parameters
frameInfoFrame information since last update call

Reimplemented from MultiWidgets::ScrollAreaWidget.

Reimplemented in MultiWidgets::TextEditWidget.