CGUIString::TextChunk::Tag Struct Reference

A tag looks like this "Hello [b]there[/b] little". More...

#include <CGUIString.h>

Classes
struct	TagAttribute

Public Types
enum	TagType {   TAG_B , TAG_I , TAG_FONT , TAG_SIZE ,   TAG_COLOR , TAG_IMGLEFT , TAG_IMGRIGHT , TAG_ICON ,   TAG_TOOLTIP , TAG_INVALID }
	Tag Type. More...

Public Member Functions
bool	SetTagType (const CStrW &tagtype)
	Set tag from string. More...
TagType	GetTagType (const CStrW &tagtype) const

Public Attributes
TagType	m_TagType
	In [b="Hello"][/b] m_TagType is TAG_B. More...
std::wstring	m_TagValue
	In [b="Hello"][/b] m_TagValue is 'Hello'. More...
std::vector< TagAttribute >	m_TagAttributes
	Some tags need an additional attributes. More...

Detailed Description

A tag looks like this "Hello [b]there[/b] little".

Member Enumeration Documentation

TagType

enum CGUIString::TextChunk::Tag::TagType

Tag Type.

Enumerator
TAG_B
TAG_I
TAG_FONT
TAG_SIZE
TAG_COLOR
TAG_IMGLEFT
TAG_IMGRIGHT
TAG_ICON
TAG_TOOLTIP
TAG_INVALID

Member Function Documentation

GetTagType()

CGUIString::TextChunk::Tag::TagType CGUIString::TextChunk::Tag::GetTagType

(

const CStrW &

tagtype

)

const

SetTagType()

bool CGUIString::TextChunk::Tag::SetTagType

(

const CStrW &

tagtype

)

Set tag from string.

Parameters

tagtype

TagType by string, like 'img' for [img]

Returns

True if m_TagType was set.

Member Data Documentation

m_TagAttributes

std::vector<TagAttribute> CGUIString::TextChunk::Tag::m_TagAttributes

Some tags need an additional attributes.

m_TagType

TagType CGUIString::TextChunk::Tag::m_TagType

In [b="Hello"][/b] m_TagType is TAG_B.

m_TagValue

std::wstring CGUIString::TextChunk::Tag::m_TagValue

In [b="Hello"][/b] m_TagValue is 'Hello'.

---

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

• /home/docker/jenkins/workspace/technical-docs/source/gui/SettingTypes/CGUIString.h
• /home/docker/jenkins/workspace/technical-docs/source/gui/SettingTypes/CGUIString.cpp