alexaClientSDK::captions::Style Struct Reference

#include <TextStyle.h>

Public Member Functions
	Style (bool bold=false, bool italic=false, bool underline=false)
bool	operator== (const Style &rhs) const
bool	operator!= (const Style &rhs) const

Public Attributes
bool	m_bold
	Indicates whether the bolded text appearance should be applied to the text. More...
bool	m_italic
	Indicates whether the italic text appearance should be applied to the text. More...
bool	m_underline
	Indicates whether the underlined text appearance should be applied to the text. More...

Detailed Description

Container used to describe basic text markup, such as bold, italic, etc.

Constructor & Destructor Documentation

Style()

alexaClientSDK::captions::Style::Style	(	bool	bold = false,
		bool	italic = false,
		bool	underline = false
	)

Constructor.

Parameters

bold	whether the bolded text appearance should be applied to the text.
italic	whether the italic text appearance should be applied to the text.
underline	whether the underlined text appearance should be applied to the text.

Member Function Documentation

operator!=()

bool alexaClientSDK::captions::Style::operator!=

(

const Style &

rhs

)

const

Operator == to compare Style values.

Parameters

rhs	The right hand side of the == operation.

Returns

Whether or not this style and rhs are equivalent.

operator==()

bool alexaClientSDK::captions::Style::operator==

(

const Style &

rhs

)

const

Operator == to compare Style values.

Parameters

rhs	The right hand side of the == operation.

Returns

Whether or not this style and rhs are equivalent.

Member Data Documentation

m_bold

bool alexaClientSDK::captions::Style::m_bold

Indicates whether the bolded text appearance should be applied to the text.

m_italic

bool alexaClientSDK::captions::Style::m_italic

Indicates whether the italic text appearance should be applied to the text.

m_underline

bool alexaClientSDK::captions::Style::m_underline

Indicates whether the underlined text appearance should be applied to the text.

---

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

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