alexaClientSDK::captions::TextStyle Struct Reference

#include <TextStyle.h>

Collaboration diagram for alexaClientSDK::captions::TextStyle:

Public Member Functions
	TextStyle (size_t index=0, const Style &style=Style())
bool	operator== (const TextStyle &rhs) const
bool	operator!= (const TextStyle &rhs) const

Public Attributes
size_t	charIndex
	The character index from which the activeStyle should be applied. More...
Style	activeStyle
	The styles that are active and should be applied from this charIndex forward. More...

Detailed Description

Container to describe style text that should be applied starting at a given index.

Constructor & Destructor Documentation

TextStyle()

alexaClientSDK::captions::TextStyle::TextStyle	(	size_t	index = 0,
		const Style &	style = Style()
	)

Constructor.

Parameters

index	The character index from which the style should be applied.
style	The styles that are active and should be applied from this index forward.

Member Function Documentation

operator!=()

bool alexaClientSDK::captions::TextStyle::operator!=

(

const TextStyle &

rhs

)

const

Operator != to compare TextStyle values.

Parameters

rhs	The right hand side of the != operation.

Returns

Whether or not this text style and rhs are not equivalent.

operator==()

bool alexaClientSDK::captions::TextStyle::operator==

(

const TextStyle &

rhs

)

const

Operator == to compare TextStyle values.

Parameters

rhs	The right hand side of the == operation.

Returns

Whether or not this text style and rhs are equivalent.

Member Data Documentation

activeStyle

Style alexaClientSDK::captions::TextStyle::activeStyle

The styles that are active and should be applied from this charIndex forward.

charIndex

size_t alexaClientSDK::captions::TextStyle::charIndex

The character index from which the activeStyle should be applied.

---

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

• /workplace/avs-device-sdk/Captions/Interface/include/Captions/TextStyle.h