Open 3D Engine LyShine Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
UiClickableTextInterface Class Referenceabstract

#include <UiTextBus.h>

Inherits AZ::ComponentBus.

Classes

struct  ClickableTextRect
 Defines an area of interaction for clickable text, along with metadata. More...
 

Public Types

using ClickableTextRects = AZStd::vector< ClickableTextRect >
 

Public Member Functions

virtual void GetClickableTextRects (UiClickableTextInterface::ClickableTextRects &clickableTextRects)=0
 Populates given clickable text rects for a text component.
 
virtual void SetClickableTextColor (int id, const AZ::Color &color)=0
 Sets the drawbatch color for clickable text, given by the ID.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 Only one component on an entity can implement the events.
 

Detailed Description

Interface that describes "clickable" areas of text for a text component.

Text components can contain anchor tags that allow user interaction with text. These anchor tags define clickable areas that can be stylized (via color) and provide information to listeners regarding the text.

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