xlnt::phonetic_pr Class Reference

Phonetic properties Element provides a collection of properties that affect display of East Asian Languages [Serialised phoneticPr] More...

#include <phonetic_pr.hpp>

Public Types
enum	align { center, distributed, left, no_control }
	possible values for alignment property More...
enum	phonetic_type { full_width_katakana, half_width_katakana, hiragana, no_conversion }
	possible values for type property More...
using	font_id_t = std::uint32_t
	FontID represented by an unsigned 32-bit integer More...

Public Member Functions
	phonetic_pr ()=default
	Default ctor for phonetic properties More...
	phonetic_pr (font_id_t font)
	FontID ctor for phonetic properties More...
void	serialise (std::ostream &output_stream) const
	adds the xml serialised representation of this element to the stream More...
font_id_t	font_id () const
	get the font index More...
void	font_id (font_id_t font)
	set the font index More...
bool	has_type () const
	is the phonetic type set More...
phonetic_type	type () const
	returns the phonetic type More...
void	type (phonetic_type type)
	sets the phonetic type More...
bool	has_alignment () const
	is the alignment set More...
align	alignment () const
	get the alignment More...
void	alignment (align align)
	set the alignment More...
bool	operator== (const phonetic_pr &rhs) const

Static Public Member Functions
static std::string	Serialised_ID ()
static const std::string &	type_as_string (phonetic_type type)
	string form of the type enum More...
static phonetic_type	type_from_string (const std::string &str)
	type enum from string More...
static const std::string &	alignment_as_string (xlnt::phonetic_pr::align type)
	string form of alignment enum More...
static align	alignment_from_string (const std::string &str)
	alignment enum from string More...

Detailed Description

Phonetic properties Element provides a collection of properties that affect display of East Asian Languages [Serialised phoneticPr]

Member Typedef Documentation

font_id_t

using xlnt::phonetic_pr::font_id_t = std::uint32_t

FontID represented by an unsigned 32-bit integer

Member Enumeration Documentation

align

enum xlnt::phonetic_pr::align

strong

possible values for alignment property

phonetic_type

enum xlnt::phonetic_pr::phonetic_type

strong

possible values for type property

Constructor & Destructor Documentation

phonetic_pr() [1/2]

xlnt::phonetic_pr::phonetic_pr ( )

default

Default ctor for phonetic properties

phonetic_pr() [2/2]

xlnt::phonetic_pr::phonetic_pr ( font_id_t  font )

explicit

FontID ctor for phonetic properties

Member Function Documentation

alignment() [1/2]

align xlnt::phonetic_pr::alignment

(

)

const

get the alignment

alignment() [2/2]

void xlnt::phonetic_pr::alignment

(

align

align

)

set the alignment

alignment_as_string()

static const std::string& xlnt::phonetic_pr::alignment_as_string ( xlnt::phonetic_pr::align  type )

static

string form of alignment enum

alignment_from_string()

static align xlnt::phonetic_pr::alignment_from_string ( const std::string &  str )

static

alignment enum from string

font_id() [1/2]

font_id_t xlnt::phonetic_pr::font_id

(

)

const

get the font index

font_id() [2/2]

void xlnt::phonetic_pr::font_id

(

font_id_t

font

)

set the font index

has_alignment()

bool xlnt::phonetic_pr::has_alignment

(

)

const

is the alignment set

has_type()

bool xlnt::phonetic_pr::has_type

(

)

const

is the phonetic type set

serialise()

void xlnt::phonetic_pr::serialise

(

std::ostream &

output_stream

)

const

adds the xml serialised representation of this element to the stream

type() [1/2]

phonetic_type xlnt::phonetic_pr::type

(

)

const

returns the phonetic type

type() [2/2]

void xlnt::phonetic_pr::type

(

phonetic_type

type

)

sets the phonetic type

type_as_string()

static const std::string& xlnt::phonetic_pr::type_as_string ( phonetic_type  type )

static

string form of the type enum

type_from_string()

static phonetic_type xlnt::phonetic_pr::type_from_string ( const std::string &  str )

static

type enum from string

---

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

• xlnt/worksheet/phonetic_pr.hpp