UiTooltipDisplayInterface Class Reference

#include <UiTooltipDisplayBus.h>

Inherits AZ::ComponentBus.

Public Types
enum class	AutoPositionMode { OffsetFromMouse , OffsetFromElement }
enum class	TriggerMode { OnHover , OnPress , OnClick }

Public Member Functions
virtual TriggerMode	GetTriggerMode ()=0
	Get the way the tooltip is triggered to display.
virtual void	SetTriggerMode (TriggerMode triggerMode)=0
	Set the way the tooltip is triggered to display.
virtual bool	GetAutoPosition ()=0
	Get whether the tooltip display element will be auto positioned.
virtual void	SetAutoPosition (bool autoPosition)=0
	Set whether the tooltip display element will be auto positioned.
virtual AutoPositionMode	GetAutoPositionMode ()=0
	Get auto position mode.
virtual void	SetAutoPositionMode (AutoPositionMode autoPositionMode)=0
	Set auto position mode.
virtual const AZ::Vector2 &	GetOffset ()=0
	Get the offset from the tooltip display element's pivot to the mouse position.
virtual void	SetOffset (const AZ::Vector2 &offset)=0
	Set the offset from the tooltip display element's pivot to the mouse position.
virtual bool	GetAutoSize ()=0
virtual void	SetAutoSize (bool autoSize)=0
virtual AZ::EntityId	GetTextEntity ()=0
	Get the entity id of the text element that is used for resizing.
virtual void	SetTextEntity (AZ::EntityId textEntity)=0
virtual float	GetDelayTime ()=0
	Get the amount of time to wait before showing the tooltip display element after hover start.
virtual void	SetDelayTime (float delayTime)=0
	Set the amount of time to wait before showing the tooltip display element after hover start.
virtual float	GetDisplayTime ()=0
	Get the amount of time the tooltip display element is to remain visible.
virtual void	SetDisplayTime (float displayTime)=0
	Set the amount of time the tooltip display element is to remain visible.
virtual void	PrepareToShow (AZ::EntityId tooltipElement)=0
	Show the tooltip display element.
virtual void	Hide ()=0
	Hide the tooltip display element.
virtual void	Update ()=0
	Update the tooltip display element.

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single
	Only one component on a entity can implement the events.

Detailed Description

Interface class that a tooltip display component needs to implement. A tooltip display component is responsible for displaying an element as a tooltip given sizing and positioning properties

Member Function Documentation

GetAutoSize()

virtual bool UiTooltipDisplayInterface::GetAutoSize ( )

pure virtual

Get whether the tooltip display element should be resized so that the text element size matches the size of the string

SetAutoSize()

virtual void UiTooltipDisplayInterface::SetAutoSize ( bool  autoSize )

pure virtual

Set whether the tooltip display element should be resized so that the text element size matches the size of the string

SetTextEntity()

virtual void UiTooltipDisplayInterface::SetTextEntity ( AZ::EntityId  textEntity )

pure virtual

Set the entity id of the text element that is used for resizing This must be a child of this entity

---

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

• Gems/LyShine/Code/Include/LyShine/Bus/UiTooltipDisplayBus.h