stmm-games-doc  0.32.0
Public Member Functions | Protected Member Functions | List of all members
stmg::Named Class Reference

String indexing for assets provided by the view (Theme) to the model(s). More...

Inheritance diagram for stmg::Named:
Inheritance graph
[legend]

Public Member Functions

 Named () noexcept=default
 Empty constructor. More...
 
 Named (const Named &oSource) noexcept=default
 Copy constructor. More...
 
 Named (Named &&oSource) noexcept=default
 Move constructor. More...
 
NamedIndexcolors () noexcept
 Color names. More...
 
const NamedIndexcolors () const noexcept
 Color names. More...
 
NamedIndexchars () noexcept
 Character names. More...
 
const NamedIndexchars () const noexcept
 Character names. More...
 
NamedIndexfonts () noexcept
 Font names. More...
 
const NamedIndexfonts () const noexcept
 Font names. More...
 
NamedIndextileAnis () noexcept
 Tile animation names. More...
 
const NamedIndextileAnis () const noexcept
 Tile animation names. More...
 
NamedIndeximages () noexcept
 Image ids. More...
 
const NamedIndeximages () const noexcept
 Image ids. More...
 
NamedIndexsounds () noexcept
 Sound ids. More...
 
const NamedIndexsounds () const noexcept
 Sound ids. More...
 
NamedIndexanimations () noexcept
 Theme animations. More...
 
const NamedIndexanimations () const noexcept
 Theme animations. More...
 
NamedIndexwidgets () noexcept
 Theme widgets. More...
 
const NamedIndexwidgets () const noexcept
 Theme widgets. More...
 
NamedIndexpainters () noexcept
 Theme painters. More...
 
const NamedIndexpainters () const noexcept
 Theme painters. More...
 

Protected Member Functions

Namedoperator= (Named &&oSource) noexcept=default
 Move assignment. More...
 
Namedoperator= (const Named &oSource) noexcept=default
 Copy assignment. More...
 
void clear () noexcept
 Clears the instance. More...
 

Detailed Description

String indexing for assets provided by the view (Theme) to the model(s).

Since strings processing is slow, integers are used to identify them.

Constructor & Destructor Documentation

◆ Named() [1/3]

stmg::Named::Named ( )
defaultnoexcept

Empty constructor.

◆ Named() [2/3]

stmg::Named::Named ( const Named oSource)
defaultnoexcept

Copy constructor.

◆ Named() [3/3]

stmg::Named::Named ( Named &&  oSource)
defaultnoexcept

Move constructor.

Member Function Documentation

◆ animations() [1/2]

NamedIndex& stmg::Named::animations ( )
inlinenoexcept

Theme animations.

Returns
Theme animations named index.

◆ animations() [2/2]

const NamedIndex& stmg::Named::animations ( ) const
inlinenoexcept

Theme animations.

Returns
Theme animations named index.

◆ chars() [1/2]

NamedIndex& stmg::Named::chars ( )
inlinenoexcept

Character names.

Used by TileChar class.

Returns
The characters named index.

◆ chars() [2/2]

const NamedIndex& stmg::Named::chars ( ) const
inlinenoexcept

Character names.

Used by TileChar class.

Returns
The characters named index.

◆ clear()

void stmg::Named::clear ( )
inlineprotectednoexcept

Clears the instance.

If you want to allow clear you have to subclass Named and make it public or use AssignableNamed.

◆ colors() [1/2]

NamedIndex& stmg::Named::colors ( )
inlinenoexcept

Color names.

Used by TileColor class.

Returns
The colors named index.

◆ colors() [2/2]

const NamedIndex& stmg::Named::colors ( ) const
inlinenoexcept

Color names.

Used by TileColor class.

Returns
The colors named index.

◆ fonts() [1/2]

NamedIndex& stmg::Named::fonts ( )
inlinenoexcept

Font names.

Used by TileFont class.

Returns
The fonts named index.

◆ fonts() [2/2]

const NamedIndex& stmg::Named::fonts ( ) const
inlinenoexcept

Font names.

Used by TileFont class.

Returns
The fonts named index.

◆ images() [1/2]

NamedIndex& stmg::Named::images ( )
inlinenoexcept

Image ids.

Returns
The image ids named index.

◆ images() [2/2]

const NamedIndex& stmg::Named::images ( ) const
inlinenoexcept

Image ids.

Returns
The image ids named index.

◆ operator=() [1/2]

Named& stmg::Named::operator= ( Named &&  oSource)
protecteddefaultnoexcept

Move assignment.

If you want to allow assignment you have to subclass Named and make it public or use AssignableNamed

Parameters
oSourceThe source.
Returns
This.

◆ operator=() [2/2]

Named& stmg::Named::operator= ( const Named oSource)
protecteddefaultnoexcept

Copy assignment.

If you want to allow assignment you have to subclass Named and make it public or use AssignableNamed

Parameters
oSourceThe source.
Returns
This.

◆ painters() [1/2]

NamedIndex& stmg::Named::painters ( )
inlinenoexcept

Theme painters.

Returns
Theme painters named index.

◆ painters() [2/2]

const NamedIndex& stmg::Named::painters ( ) const
inlinenoexcept

Theme painters.

Returns
Theme painters named index.

◆ sounds() [1/2]

NamedIndex& stmg::Named::sounds ( )
inlinenoexcept

Sound ids.

Returns
The sound ids named index.

◆ sounds() [2/2]

const NamedIndex& stmg::Named::sounds ( ) const
inlinenoexcept

Sound ids.

Returns
The sound ids named index.

◆ tileAnis() [1/2]

NamedIndex& stmg::Named::tileAnis ( )
inlinenoexcept

Tile animation names.

Used by TileAnimator class.

Returns
The tile animations named index.

◆ tileAnis() [2/2]

const NamedIndex& stmg::Named::tileAnis ( ) const
inlinenoexcept

Tile animation names.

Used by TileAnimator class.

Returns
The tile animations named index.

◆ widgets() [1/2]

NamedIndex& stmg::Named::widgets ( )
inlinenoexcept

Theme widgets.

Returns
Theme widgets named index.

◆ widgets() [2/2]

const NamedIndex& stmg::Named::widgets ( ) const
inlinenoexcept

Theme widgets.

Returns
Theme widgets named index.