API Search || Global Search
HPS::GlyphDefinition Class Reference

#include <hps.h>

Inheritance diagram for HPS::GlyphDefinition:
HPS::Definition HPS::Object

Public Member Functions

 GlyphDefinition ()
 
 GlyphDefinition (Definition const &in_that)
 
 GlyphDefinition (GlyphDefinition const &in_that)
 
 GlyphDefinition (GlyphDefinition &&in_that)
 
HPS::Type ObjectType () const
 
GlyphDefinitionoperator= (GlyphDefinition const &in_that)
 
GlyphDefinitionoperator= (GlyphDefinition &&in_that)
 
void Set (GlyphKit const &in_kit)
 
void Show (GlyphKit &out_kit) const
 
- Public Member Functions inherited from HPS::Definition
virtual void Assign (Definition const &in_that)
 
 Definition ()
 
 Definition (Definition const &in_that)
 
 Definition (Definition &&in_that)
 
bool Equals (Definition const &in_that) const
 
UTF8 Name () const
 
bool operator!= (Definition const &in_that) const
 
Definitionoperator= (Definition const &in_that)
 
Definitionoperator= (Definition &&in_that)
 
bool operator== (Definition const &in_that) const
 
PortfolioKey Owner () const
 
void Undefine ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::GlyphDefinition
 
- Static Public Attributes inherited from HPS::Definition
static const HPS::Type staticType = HPS::Type::Definition
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The GlyphDefinition class is a smart pointer to a database object. It is a handler to a glyph defined within a portfolio.

Constructor & Destructor Documentation

HPS::GlyphDefinition::GlyphDefinition ( )

The default constructor creates an uninitialized GlyphDefinition object. The Type() function will return Type::None.

HPS::GlyphDefinition::GlyphDefinition ( Definition const &  in_that)

This constructor creates an GlyphDefinition object that shares the underlying smart-pointer of the source Definition. The copy will only be successful if the source definition is really an upcast of a glyph definition. Otherwise the copy will fail and the resulting GlyphDefinition will be invalid.

Parameters
in_thatThe source Definition to copy.
HPS::GlyphDefinition::GlyphDefinition ( GlyphDefinition const &  in_that)

The copy constructor creates an GlyphDefinition object that shares the underlying smart-pointer of the source GlyphDefinition.

Parameters
in_thatThe source GlyphDefinition to copy.
HPS::GlyphDefinition::GlyphDefinition ( GlyphDefinition &&  in_that)

The move constructor creates a GlyphDefinition by transferring the underlying impl of the rvalue reference to this GlyphDefinition thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a GlyphDefinition to take the impl from.

Member Function Documentation

GlyphDefinition& HPS::GlyphDefinition::operator= ( GlyphDefinition const &  in_that)

Associate this GlyphDefinition with the same underlying impl as the source GlyphDefinition.

Parameters
in_thatThe source GlyphDefinition for the assignment.
Returns
A reference to this GlyphDefinition.
GlyphDefinition& HPS::GlyphDefinition::operator= ( GlyphDefinition &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this GlyphDefinition thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a GlyphDefinition to take the impl from.
Returns
A reference to this GlyphDefinition.
void HPS::GlyphDefinition::Set ( GlyphKit const &  in_kit)

Redefine the glyph for this GlyphDefinition.

Parameters
in_kitThe new glyph for this GlyphDefinition.
void HPS::GlyphDefinition::Show ( GlyphKit out_kit) const

Shows the glyph for this GlyphDefinition.

Parameters
out_kitThe glyph for this GlyphDefinition.

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