API Documentation
Loading...
Searching...
No Matches
BasicUnitOption Class Reference

A definition of how to describe a particular set of data to a custom category of unit. More...

#include <UnitManager.h>

Inheritance diagram for BasicUnitOption:
[legend]
Collaboration diagram for BasicUnitOption:
[legend]

Public Member Functions

 BasicUnitOption (const ConstPointer< Unit > &unit, const TranslatedString &custom_title=TranslatedString())
 
virtual Buffer< ConstPointer< UnitOption > > & editSubOptions ()
 
virtual bool hasMemberUnit (const ConstPointer< Unit > &unit) const final override
 
virtual Buffer< ConstPointer< UnitOption > > subOptions () const final override
 
virtual TranslatedString title () const final override
 
virtual ConstPointer< Unitunit () const final override
 
- Public Member Functions inherited from UnitOption
virtual ConstPointer< Unitunit (const ConstPointer< Unit > &) const
 
 UnitOption (const String &id, const TranslatedString &name)
 
virtual ~UnitOption ()
 

Public Attributes

ConstPointer< Unitbase_unit
 
TranslatedString custom_title
 
- Public Attributes inherited from UnitOption
String id
 
TranslatedString name
 

Protected Attributes

Buffer< ConstPointer< UnitOption > > m_sub_options
 

Detailed Description

A definition of how to describe a particular set of data to a custom category of unit.


Constructor & Destructor Documentation

◆ BasicUnitOption()

BasicUnitOption ( const ConstPointer< Unit > & unit,
const TranslatedString & custom_title = TranslatedString() )
inline

Member Function Documentation

◆ editSubOptions()

virtual Buffer< ConstPointer< UnitOption > > & editSubOptions ( )
inlinevirtual

◆ hasMemberUnit()

virtual bool hasMemberUnit ( const ConstPointer< Unit > & unit) const
finaloverridevirtual

Implements UnitOption.

◆ subOptions()

virtual Buffer< ConstPointer< UnitOption > > subOptions ( ) const
inlinefinaloverridevirtual

Reimplemented from UnitOption.

◆ title()

virtual TranslatedString title ( ) const
finaloverridevirtual

Reimplemented from UnitOption.

◆ unit()

virtual ConstPointer< Unit > unit ( ) const
inlinefinaloverridevirtual

Implements UnitOption.

Member Data Documentation

◆ base_unit

ConstPointer<Unit> base_unit

◆ custom_title

TranslatedString custom_title

◆ m_sub_options

Buffer<ConstPointer<UnitOption> > m_sub_options
protected

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