Inscoper::NBO::FontFamily_Type¶

Represents the XML simple type FontFamily. More...

#include <FontFamily_Type.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	FontFamily_Type()
	~FontFamily_Type()
std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
FontFamily_Type &	operator=(const std::string & v) Assigns a new value to this object (= operator operator).
	operator std::string() const Returns the value of this object (generic conversion operator overload).
void	set(const std::string & v, bool validate =true) Assigns a new value to this object.
std::string	get() const Returns the value of this object.
std::shared_ptr< FontFamily_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a FontFamily_Type.
const std::set< std::string > &	getAllowedValues() Returns the allowed values for this object.
const std::string &	getPattern() Returns the pattern for this object.

Friends¶

	Name
std::ostream &	operator<<(std::ostream & os, const FontFamily_Type & u)

Detailed Description¶

class Inscoper::NBO::FontFamily_Type;

Represents the XML simple type FontFamily.

The font family used to draw the text. [enumeration] Note: these values are all lower case so they match the standard HTML/CSS values. "fantasy" has been included for completeness we do not recommended its regular use.

Allowed values: serif, sans-serif, cursive, fantasy, monospace

Public Functions Documentation¶

function FontFamily_Type¶

function ~FontFamily_Type¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlString¶

std::string toXmlString(
    bool validate =true
) const

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function operator=¶

function operator std::string¶

function set¶

void set(
    const std::string & v,
    bool validate =true
)

Assigns a new value to this object.

Parameters:

v The value to set
validate If true, validates constraints on value. Default is true.

function get¶

function fromBase¶

static std::shared_ptr< FontFamily_Type > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a FontFamily_Type.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Inscoper::NBO::FontFamily_Type¶

Public Functions¶

Friends¶

Detailed Description¶

Public Functions Documentation¶

function FontFamily_Type¶

function ~FontFamily_Type¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

function fromJsonString¶

function fromXmlFile¶

function fromXmlString¶

function toXmlFile¶

function toXmlString¶

function operator=¶

function operator std::string¶

function set¶

function get¶

function fromBase¶

function getAllowedValues¶

function getPattern¶

Friends¶

friend operator<<¶