class EE::UI::UITooltip¶
Overview¶
#include <uitooltip.hpp> class UITooltip: public EE::UI::UIWidget { public: // construction virtual ~UITooltip(); // methods static UITooltip* New(); static Vector2f getTooltipPosition(UIWidget* toolip, const Vector2f& requestedPosition); virtual Uint32 getType() const; virtual bool isType(const Uint32& type) const; virtual void setTheme(UITheme* Theme); void show(); void hide(); virtual void draw(); Graphics::Font* getFont() const; void setFont(Graphics::Font* font); virtual const String& getText(); virtual void setText(const String& text); const Color& getFontColor() const; void setFontColor(const Color& color); const Color& getFontShadowColor() const; void setFontShadowColor(const Color& color); virtual void onTextChanged(); virtual void onFontChanged(); const Text* getTextCache() const; Text* getTextCache(); Float getTextWidth(); Float getTextHeight(); Uint32 getNumLines(); Vector2f getAlignOffset(); UINode* getTooltipOf() const; void setTooltipOf(UINode* tooltipOf); const UIFontStyleConfig& getFontStyleConfig() const; void setFontStyleConfig(const UIFontStyleConfig& styleConfig); Uint32 getCharacterSize() const; UITooltip* setFontSize(const Uint32& characterSize); UITooltip* setFontStyle(const Uint32& fontStyle); const Uint32& getFontStyle() const; const Float& getOutlineThickness() const; UITooltip* setOutlineThickness(const Float& outlineThickness); const Color& getOutlineColor() const; UITooltip* setOutlineColor(const Color& outlineColor); virtual bool applyProperty(const StyleSheetProperty& attribute); virtual std::string getPropertyString(const PropertyDefinition* propertyDef, const Uint32& propertyIndex = 0) const; virtual std::vector<PropertyId> getPropertiesImplemented() const; const String& getStringBuffer() const; void setStringBuffer(const String& stringBuffer); void resetTextToStringBuffer(); bool dontAutoHideOnMouseMove() const; void setDontAutoHideOnMouseMove(bool dontAutoHideOnMouseMove); const TextTransform::Value& getTextTransform() const; void setTextTransform(const TextTransform::Value& textTransform); Vector2f getTooltipPosition(const Vector2f& requestedPosition); bool getUsingCustomStyling() const; void setUsingCustomStyling(bool usingCustomStyling); void setFontShadowOffset(const Vector2f& offset); const Vector2f& getFontShadowOffset() const; void notifyTextChangedFromTextCache(); virtual void wrapText(const Uint32& maxWidth); void setWordWrap(bool set); bool isWordWrap() const; };
Inherited Members¶
public: // typedefs typedef std::function<void(const Event*)> EventCallback; typedef std::function<void(const Event*)> EventCallback; // methods virtual void setPosition(const Vector2f& position); virtual void setRotation(float angle); virtual void setScale(float factorX, float factorY); virtual void setScale(const Vector2f& factors); virtual void setScaleOrigin(float x, float y); virtual void setScaleOrigin(const Vector2f& origin); virtual void setRotationOrigin(float x, float y); virtual void setRotationOrigin(const Vector2f& origin); virtual const Vector2f& getRotationOrigin() const; virtual const Vector2f& getPosition() const; virtual const float& getRotation() const; virtual const Vector2f& getScale() const; virtual const Vector2f& getScaleOrigin() const; void move(float offsetX, float offsetY); void move(const Vector2f& offset); void rotate(float angle); void scale(float factorX, float factorY); void scale(const Vector2f& factor); const Transform& getTransform() const; const Transform& getInverseTransform() const; static Node* New(); virtual void worldToNodeTranslation(Vector2f& position) const; virtual void nodeToWorldTranslation(Vector2f& position) const; virtual void worldToNode(Vector2i& pos) const; virtual void nodeToWorld(Vector2i& pos) const; virtual void worldToNode(Vector2f& pos) const; virtual void nodeToWorld(Vector2f& pos) const; virtual Uint32 getType() const; virtual bool isType(const Uint32& type) const; void messagePost(const NodeMessage* Msg); virtual void setPosition(const Vector2f& Pos); virtual Node* setPosition(const Float& x, const Float& y); virtual Node* setSize(const Sizef& size); Node* setSize(const Float& Width, const Float& Height); virtual const Sizef& getSize() const; const Sizef& getPixelsSize() const; Node* setVisible(const bool& visible, bool emitEventNotification = true); Node* setChildrenVisibility(bool visible, bool emitEventNotification = true); bool isVisible() const; bool hasVisibility() const; Node* setEnabled(const bool& enabled); bool isEnabled() const; bool isDisabled() const; Node* getParent() const; Node* setParent(Node* parent); virtual void close(); virtual void draw(); virtual void update(const Time& time); virtual void scheduledUpdate(const Time& time); Node* getNextNode() const; Node* getPrevNode() const; Node* getNextNodeLoop() const; Node* setData(const UintPtr& data); const UintPtr& getData() const; Node* setBlendMode(const BlendMode& blend); const BlendMode& getBlendMode() const; Node* toFront(); Node* toBack(); void toPosition(const Uint32& position); const Uint32& getNodeFlags() const; void setNodeFlags(const Uint32& flags); bool isSceneNode() const; bool isUISceneNode() const; bool isUINode() const; bool isWidget() const; bool isWindow() const; bool isLayout() const; bool isClipped() const; bool isRotated() const; bool isScaled() const; bool isFrameBuffer() const; bool isMouseOver() const; bool isMouseOverMeOrChildren() const; bool isMeOrParentTreeVisible() const; bool isMeOrParentTreeRotated() const; bool isMeOrParentTreeScaled() const; bool isMeOrParentTreeScaledOrRotated() const; bool isMeOrParentTreeScaledOrRotatedOrFrameBuffer() const; Uint32 addEventListener(const Uint32& eventType, const EventCallback& callback); Uint32 on(const Uint32& eventType, const EventCallback& callback); Uint32 onClick(const std::function<void(const MouseEvent*)>& callback, const MouseButton& button = MouseButton::EE_BUTTON_LEFT); Uint32 onDoubleClick(const std::function<void(const MouseEvent*)>& callback, const MouseButton& button = MouseButton::EE_BUTTON_LEFT); void removeEventsOfType(const Uint32& eventType); void removeEventListener(const Uint32& callbackId); void removeEventListener(const std::vector<Uint32>& callbacksIds); void clearEventListener(); Node* getFirstChild() const; Node* getLastChild() const; const Polygon2f& getWorldPolygon(); const Rectf& getWorldBounds(); bool isParentOf(const Node* node) const; void sendEvent(const Event* Event); void sendMouseEvent(const Uint32& Event, const Vector2i& position, const Uint32& flags); void sendCommonEvent(const Uint32& Event); void sendTextEvent(const Uint32& event, const std::string& text); void closeAllChildren(); const std::string& getId() const; virtual Node* setId(const std::string& id); const String::HashType& getIdHash() const; Node* find(const std::string& id) const; Node* hasChild(const std::string& id) const; template <typename T> T* find(const std::string& id) const; template <typename T> T* bind(const std::string& id, T*& node); template <typename T> T* asType(); template <typename T> const T* asConstType() const; Node* findByType(const Uint32& type) const; template <typename T> T* findByType(const Uint32& type) const; template <typename T> T* bindByType(const Uint32& type, T*& node); std::vector<Node*> findAllByType(const Uint32& type) const; template <typename T> std::vector<T*> findAllByType(const Uint32& type) const; bool inNodeTree(Node* node) const; bool isReverseDraw() const; void setReverseDraw(bool reverseDraw); void invalidateDraw(); virtual void setRotation(float angle); void setRotation(const Float& angle, const OriginPoint& center); const OriginPoint& getRotationOriginPoint() const; void setRotationOriginPoint(const OriginPoint& center); void setRotationOriginPointPixels(const OriginPoint& center); void setRotationOriginPointX(const std::string& xEq); void setRotationOriginPointY(const std::string& yEq); Vector2f getRotationCenter() const; void setScale(const Float& scale); virtual void setScale(const Vector2f& scale); void setScale(const Vector2f& scale, const OriginPoint& center); void setScale(const Float& scale, const OriginPoint& center); const OriginPoint& getScaleOriginPoint() const; void setScaleOriginPoint(const OriginPoint& center); void setScaleOriginPointPixels(const OriginPoint& center); void setScaleOriginPointX(const std::string& xEq); void setScaleOriginPointY(const std::string& yEq); Vector2f getScaleCenter() const; virtual void setScale(float factorX, float factorY); virtual void setScaleOrigin(float x, float y); virtual void setRotationOrigin(float x, float y); const Float& getAlpha() const; virtual void setAlpha(const Float& alpha); virtual void setChildrenAlpha(const Float& alpha); ActionManager* getActionManager() const; Node* runAction(Action* action); bool removeAction(Action* action); bool removeActions(const std::vector<Action*>& actions); bool removeActionsByTag(const Action::UniqueID& tag); std::vector<Action*> getActions(); std::vector<Action*> getActionsByTag(const Action::UniqueID& tag); void clearActions(); Transform getLocalTransform() const; Transform getGlobalTransform() const; Transform getNodeToWorldTransform() const; Transform getWorldToNodeTransform() const; Vector2f convertToNodeSpace(const Vector2f& worldPoint) const; Vector2f convertToWorldSpace(const Vector2f& nodePoint) const; Rectf getLocalBounds() const; bool hasFocus() const; bool hasFocusWithin() const; virtual Node* setFocus(NodeFocusReason reason = NodeFocusReason::Unknown); Node* getFirstWidget() const; Node* getParentWidget() const; void enableReportSizeChangeToChildren(); void disableReportSizeChangeToChildren(); bool reportSizeChangeToChildren() const; Node* centerHorizontal(); Node* centerVertical(); Node* center(); Node* clipEnable(); Node* clipDisable(); void writeNodeFlag(const Uint32& Flag, const Uint32& Val); SceneNode* getSceneNode() const; EventDispatcher* getEventDispatcher() const; virtual bool isDrawInvalidator() const; bool invalidated() const; virtual void invalidate(Node* invalidator); Uint32 getChildCount() const; Uint32 getChildOfTypeCount(const Uint32& type) const; Node* getChildAt(Uint32 index) const; Uint32 getNodeIndex() const; Uint32 getNodeOfTypeIndex() const; void runOnMainThread(Actions::Runnable::RunnableFunc runnable, const Time& delay = Seconds(0), const Action::UniqueID& uniqueIdentifier = 0); bool ensureMainThread(Actions::Runnable::RunnableFunc runnable, const Action::UniqueID& uniqueIdentifier = 0); void setTimeout(Actions::Runnable::RunnableFunc runnable, const Time& delay = Seconds(0), const Action::UniqueID& uniqueIdentifier = 0); void setInterval(Actions::Runnable::RunnableFunc runnable, const Time& interval, const Action::UniqueID& uniqueIdentifier = 0); void debounce(Actions::Runnable::RunnableFunc runnable, const Time& delay, const Action::UniqueID& uniqueIdentifier); bool isChild(Node* child) const; bool inParentTreeOf(Node* child) const; bool inParentTreeOfType(Uint32 type) const; Node* getParentOfType(Uint32 type) const; void setLoadingState(bool loading); bool isLoadingState() const; virtual void onIdChange(); bool isClosing() const; bool isClosingChildren() const; virtual Node* overFind(const Vector2f& Point); void detach(); void forEachNode(std::function<void(Node*)> func); void forEachChild(std::function<void(Node*)> func); virtual void nodeDraw(); Uint32 forceKeyDown(const KeyEvent& event); Uint32 foceKeyUp(const KeyEvent& event); Uint32 forceTextInput(const TextInputEvent& Event); const Vector2f& getScreenPos() const; Rectf getScreenRect() const; bool hasEventsOfType(const Uint32& eventType) const; static UINode* New(); virtual void worldToNodeTranslation(Vector2f& position) const; virtual void nodeToWorldTranslation(Vector2f& position) const; virtual void worldToNode(Vector2i& pos) const; virtual void nodeToWorld(Vector2i& pos) const; virtual void worldToNode(Vector2f& pos) const; virtual void nodeToWorld(Vector2f& pos) const; virtual Uint32 getType() const; virtual bool isType(const Uint32& type) const; virtual void setPosition(const Vector2f& Pos); virtual Node* setPosition(const Float& x, const Float& y); UINode* setPixelsPosition(const Vector2f& position); UINode* setPixelsPosition(const Float& x, const Float& y); virtual const Vector2f& getPosition() const; const Vector2f& getPixelsPosition() const; virtual Node* setSize(const Sizef& size); virtual Node* setSize(const Float& Width, const Float& Height); UINode* setPixelsSize(const Sizef& size); UINode* setPixelsSize(const Float& x, const Float& y); virtual const Sizef& getSize() const; Rect getRect() const; Rectf getRectBox() const; virtual void draw(); Uint32 getHorizontalAlign() const; UINode* setHorizontalAlign(Uint32 halign); Uint32 getVerticalAlign() const; UINode* setVerticalAlign(Uint32 valign); UINode* setGravity(Uint32 hvalign); UINodeDrawable* setBackgroundFillEnabled(bool enabled); UINode* setBackgroundDrawable(Drawable* drawable, bool ownIt = false, int index = 0); UINode* setBackgroundDrawable(const std::string& drawable, int index); UINode* setBackgroundColor(const Color& color); UINode* setBackgroundTint(const Color& color, int index); UINode* setBackgroundPositionX(const std::string& positionX, int index = 0); UINode* setBackgroundPositionY(const std::string& positionY, int index = 0); UINode* setBackgroundRepeat(const std::string& repeatRule, int index = 0); UINode* setBackgroundSize(const std::string& size, int index = 0); Color getBackgroundColor() const; Color getBackgroundTint(int index = 0) const; UINode* setBorderRadius(const unsigned int& corners); UINode* setTopLeftRadius(const std::string& radius); UINode* setTopRightRadius(const std::string& radius); UINode* setBottomLeftRadius(const std::string& radius); UINode* setBottomRightRadius(const std::string& radius); Uint32 getBorderRadius() const; UINodeDrawable* setForegroundFillEnabled(bool enabled); UINode* setForegroundDrawable(Drawable* drawable, bool ownIt = false, int index = 0); UINode* setForegroundDrawable(const std::string& drawable, int index = 0); Color getForegroundColor() const; Color getForegroundTint(int index) const; UINode* setForegroundColor(const Color& color); UINode* setForegroundTint(const Color& color, int index); UINode* setForegroundPositionX(const std::string& positionX, int index = 0); UINode* setForegroundPositionY(const std::string& positionY, int index = 0); UINode* setForegroundRepeat(const std::string& repeatRule, int index = 0); UINode* setForegroundSize(const std::string& size, int index = 0); UINode* setForegroundRadius(const unsigned int& corners); Uint32 getForegroundRadius() const; UIBorderDrawable* setBorderEnabled(bool enabled) const; UINode* setBorderColor(const Color& color); Color getBorderColor(); UINode* setBorderWidth(const unsigned int& width); Float getBorderWidth() const; const Uint32& getFlags() const; virtual UINode* setFlags(const Uint32& flags); virtual UINode* unsetFlags(const Uint32& flags); virtual UINode* resetFlags(Uint32 newFlags = 0); UINodeDrawable* getBackground() const; bool hasBackground() const; UINodeDrawable* getForeground() const; bool hasForeground() const; UIBorderDrawable* getBorder() const; void setThemeByName(const std::string& Theme); virtual void setTheme(UITheme* Theme); virtual UINode* setThemeSkin(UITheme* Theme, const std::string& skinName); virtual UINode* setThemeSkin(const std::string& skinName); void setThemeToChildren(UITheme* Theme); UISkin* getSkin() const; virtual UINode* setSkin(const UISkin& Skin); UINode* setSkin(UISkin* skin); UINode* setSkinColor(const Color& color); const Color& getSkinColor() const; void removeSkin(); virtual void pushState(const Uint32& State, bool emitEvent = true); virtual void popState(const Uint32& State, bool emitEvent = true); Sizef getSkinSize(const Uint32& state = UIState::StateFlagNormal) const; void applyDefaultTheme(); Node* getWindowContainer() const; bool isTabFocusable() const; bool isDragging() const; void setDragging(bool dragging, bool emitDropEvent = true); void startDragging(const Vector2f& position); bool ownsChildPosition() const; const Vector2f& getDragPoint() const; void setDragPoint(const Vector2f& Point); bool isDragEnabled() const; void setDragEnabled(const bool& enable); void setDragButton(const Uint32& Button); const Uint32& getDragButton() const; virtual Node* setFocus(NodeFocusReason reason = NodeFocusReason::Unknown); Float getPropertyRelativeTargetContainerLength(const CSS::PropertyRelativeTarget& relativeTarget, const Float& defaultValue = 0, const Uint32& propertyIndex = 0) const; virtual Float convertLength(const CSS::StyleSheetLength& length, const Float& containerLength) const; Float convertLengthAsDp(const CSS::StyleSheetLength& length, const Float& containerLength) const; Float lengthFromValue(const std::string& value, const CSS::PropertyRelativeTarget& relativeTarget, const Float& defaultValue = 0, const Uint32& propertyIndex = 0) const; Float lengthFromValue(const CSS::StyleSheetProperty& property, const Float& defaultValue = 0); Float lengthFromValueAsDp(const std::string& value, const CSS::PropertyRelativeTarget& relativeTarget, const Float& defaultValue = 0, const Uint32& propertyIndex = 0) const; Float lengthFromValueAsDp(const CSS::StyleSheetProperty& property, const Float& defaultValue = 0) const; UISceneNode* getUISceneNode() const; Input* getInput() const; void setMinWidth(const Float& width); void setMinHeight(const Float& height); void setMinSize(const Sizef& size); const Sizef& getCurMinSize() const; Rectf getLocalDpBounds() const; virtual void nodeDraw(); void clearForeground(); void clearBackground(); const ClipType& getClipType() const; UINode* setClipType(const ClipType& clipType); bool hasBorder() const; virtual const Rectf& getPixelsPadding() const; const std::string& getMinWidthEq() const; void setMinSizeEq(const std::string& minWidthEq, const std::string& minHeightEq); void setMinWidthEq(const std::string& minWidthEq); const std::string& getMinHeightEq() const; void setMinHeightEq(const std::string& minHeightEq); const std::string& getMaxWidthEq() const; void setMaxSizeEq(const std::string& maxWidthEq, const std::string& maxHeightEq); void setMaxWidthEq(const std::string& maxWidthEq); const std::string& getMaxHeightEq() const; void setMaxHeightEq(const std::string& maxHeightEq); Sizef getMinSize() const; Sizef getMaxSize() const; Sizef getMinSizePx() const; Sizef getMaxSizePx() const; Sizef fitMinMaxSizeDp(const Sizef& size) const; Sizef fitMinMaxSizePx(const Sizef& size) const; virtual bool isScrollable() const; static UIWidget* New(); static UIWidget* NewWithTag(const std::string& tag); virtual Uint32 getType() const; virtual bool isType(const Uint32& type) const; virtual UINode* setFlags(const Uint32& flags); virtual UINode* unsetFlags(const Uint32& flags); virtual UIWidget* setAnchors(const Uint32& flags); virtual void setTheme(UITheme* Theme); virtual UINode* setThemeSkin(const std::string& skinName); virtual UINode* setThemeSkin(UITheme* Theme, const std::string& skinName); virtual Node* setId(const std::string& id); virtual bool acceptsDropOfWidget(const UIWidget* widget); UIWidget* acceptsDropOfWidgetInTree(const UIWidget* widget); UITooltip* getTooltip(); void tooltipRemove(); UIWidget* setTooltipText(const String& text); UIWidget* setTooltipTextIfNotEmpty(const String& text); String getTooltipText(); void updateAnchorsDistances(); const Rectf& getLayoutMargin() const; const Rectf& getLayoutPixelsMargin() const; UIWidget* setLayoutMargin(const Rectf& margin); UIWidget* setLayoutMarginLeft(const Float& marginLeft); UIWidget* setLayoutMarginRight(const Float& marginRight); UIWidget* setLayoutMarginTop(const Float& marginTop); UIWidget* setLayoutMarginBottom(const Float& marginBottom); UIWidget* setLayoutPixelsMargin(const Rectf& margin); UIWidget* setLayoutPixelsMarginLeft(const Float& marginLeft); UIWidget* setLayoutPixelsMarginRight(const Float& marginRight); UIWidget* setLayoutPixelsMarginTop(const Float& marginTop); UIWidget* setLayoutPixelsMarginBottom(const Float& marginBottom); Float getLayoutWeight() const; UIWidget* setLayoutWeight(const Float& weight); Uint32 getLayoutGravity() const; UIWidget* setLayoutGravity(const Uint32& layoutGravity); const SizePolicy& getLayoutWidthPolicy() const; UIWidget* setLayoutWidthPolicy(const SizePolicy& widthPolicy); const SizePolicy& getLayoutHeightPolicy() const; UIWidget* setLayoutHeightPolicy(const SizePolicy& heightPolicy); UIWidget* setLayoutSizePolicy(const SizePolicy& widthPolicy, const SizePolicy& heightPolicy); UIWidget* setLayoutPositionPolicy(const PositionPolicy& layoutPositionPolicy, UIWidget* of); UIWidget* getLayoutPositionPolicyWidget() const; PositionPolicy getLayoutPositionPolicy() const; virtual void loadFromXmlNode(const pugi::xml_node& node); void notifyLayoutAttrChange(); void notifyLayoutAttrChangeParent(); void setStyleSheetInlineProperty(const std::string& name, const std::string& value, const Uint32& specificity = UINT32_MAX - 1); virtual bool applyProperty(const StyleSheetProperty& attribute); const Rectf& getPadding() const; virtual const Rectf& getPixelsPadding() const; UIWidget* setPadding(const Rectf& padding); UIWidget* setPaddingLeft(const Float& paddingLeft); UIWidget* setPaddingRight(const Float& paddingRight); UIWidget* setPaddingTop(const Float& paddingTop); UIWidget* setPaddingBottom(const Float& paddingBottom); UIWidget* setPaddingPixels(const Rectf& padding); UIWidget* setPaddingPixelsLeft(const Float& paddingLeft); UIWidget* setPaddingPixelsRight(const Float& paddingRight); UIWidget* setPaddingPixelsTop(const Float& paddingTop); UIWidget* setPaddingPixelsBottom(const Float& paddingBottom); const std::string& getStyleSheetTag() const; const std::string& getStyleSheetId() const; const std::vector<std::string>& getStyleSheetClasses() const; UIWidget* getStyleSheetParentElement() const; UIWidget* getStyleSheetPreviousSiblingElement() const; UIWidget* getStyleSheetNextSiblingElement() const; Uint32 getStyleSheetPseudoClasses() const; std::vector<const char*> getStyleSheetPseudoClassesStrings() const; UIWidget* resetClass(); UIWidget* setClass(const std::string& cls); UIWidget* setClass(std::string&& cls); UIWidget* setClasses(const std::vector<std::string>& classes); UIWidget* addClass(const std::string& cls); UIWidget* addClasses(const std::vector<std::string>& classes); UIWidget* removeClass(const std::string& cls); UIWidget* removeClasses(const std::vector<std::string>& classes); bool hasClass(const std::string_view& cls) const; void toggleClass(const std::string& cls); void setElementTag(const std::string& tag); const std::vector<std::string>& getClasses() const; const std::string& getElementTag() const; virtual void pushState(const Uint32& State, bool emitEvent = true); virtual void popState(const Uint32& State, bool emitEvent = true); UIStyle* getUIStyle() const; void reloadStyle(bool reloadChildren = true, bool disableAnimations = false, bool reportStateChange = true, bool forceReApplyProperties = false, bool resetPropertyCache = false); void beginAttributesTransaction(); void endAttributesTransaction(); const Uint32& getStyleState() const; const Uint32& getStylePreviousState() const; std::vector<UIWidget*> findAllByClass(const std::string& className); std::vector<UIWidget*> findAllByTag(const std::string& tag); UIWidget* findByClass(const std::string& className); template <typename T> T* findByClass(const std::string& className); UIWidget* findByTag(const std::string& tag); template <typename T> T* findByTag(const std::string& tag); UIWidget* querySelector(const CSS::StyleSheetSelector& selector); UIWidget* querySelector(const std::string& selector); template <typename T> T* querySelector(const std::string& selector); std::vector<UIWidget*> querySelectorAll(const CSS::StyleSheetSelector& selector); std::vector<UIWidget*> querySelectorAll(const std::string& selector); std::string getPropertyString(const std::string& property) const; virtual std::string getPropertyString(const PropertyDefinition* propertyDef, const Uint32& propertyIndex = 0) const; virtual std::vector<PropertyId> getPropertiesImplemented() const; bool isSceneNodeLoading() const; void reportStyleStateChangeRecursive(bool disableAnimations = false, bool forceReApplyStyles = false); UITooltip* createTooltip(); bool isTabStop() const; void setTabStop(); void unsetTabStop(); bool isTabFocusable() const; void setTabFocusable(); void unsetTabFocusable(); UIWidget* getPrevTabWidget() const; UIWidget* getNextTabWidget() const; bool hasPseudoClass(const std::string& pseudoCls) const; bool isTooltipEnabled() const; void setTooltipEnabled(bool enabled); UIWidget* getPrevWidget() const; UIWidget* getNextWidget() const; String getTranslatorString(const std::string& str); String getTranslatorString(const std::string& str, const String& defaultValue); String i18n(const std::string& str); String i18n(const std::string& str, const String& defaultValue);
Detailed Documentation¶
Methods¶
virtual Uint32 getType() const
Gets the widget type identifier.
Returns a unique type identifier for this widget class.
Returns:
The widget type as a Uint32.
virtual bool isType(const Uint32& type) const
Checks if the widget is of a specific type.
Determines whether this widget is of the specified type or derived from it.
Parameters:
type |
The type identifier to check. |
Returns:
True if the widget is of the specified type, false otherwise.
virtual void setTheme(UITheme* Theme)
Sets the theme for this widget.
Applies the specified theme to the widget, affecting its visual appearance. The theme controls colors, fonts, borders, and other visual properties.
Parameters:
Theme |
Pointer to the UITheme to apply. |
virtual void draw()
Draws the node.
Virtual method that can be overridden to implement custom drawing behavior. The default implementation does nothing. This is called during the render cycle.
virtual bool applyProperty(const StyleSheetProperty& attribute)
Applies a CSS property to this widget.
Applies the specified CSS property to the widget, updating its style and triggering any necessary style changes.
Parameters:
attribute |
The CSS property to apply. |
Returns:
True if the property was applied successfully, false otherwise.
virtual std::string getPropertyString(const PropertyDefinition* propertyDef, const Uint32& propertyIndex = 0) const
Gets a property value as a string with property definition.
Returns the value of the specified CSS property as a string, using the property definition for proper formatting.
Parameters:
propertyDef |
The property definition. |
propertyIndex |
The property index (for multi-value properties). |
Returns:
The property value as a string.
virtual std::vector<PropertyId> getPropertiesImplemented() const
Gets the list of properties implemented by this widget.
Returns a vector of property IDs that this widget implements. This is used for CSS property introspection and validation.
Returns:
Vector of implemented property IDs.