AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::captions::TextStyle Struct Reference

#include <TextStyle.h>

Collaboration diagram for alexaClientSDK::captions::TextStyle:
Collaboration graph
[legend]

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
indexThe character index from which the style should be applied.
styleThe 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
rhsThe 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
rhsThe 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 files:

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0