SHAPER  9.15.0
Config_Prop Class Reference

Class which describes a one property. More...

Public Types

enum  PropType {
  Disabled , Space , Boolean , Color ,
  String , Selector , DblSpin , IntSpin ,
  Double , Integer , GroupBox , Tab ,
  Frame , Font , DirList , File ,
  Slider , Shortcut , ShortcutTree , BiColor ,
  Background , Directory , Cursor
}
 Type of stored property. More...
 
enum  CursorType { ArrowCursor , CrossCursor , HandCursor }
 

Public Member Functions

 Config_Prop (const std::string &theSection, const std::string &theName, const std::string &theTitle, PropType theType, const std::string &theDefaultValue, const std::string &theMin, const std::string &theMax)
 Creates a one property. More...
 
const std::string & section () const
 Get name of section. More...
 
const std::string & name () const
 Get name of property. More...
 
const std::string & title () const
 Get title of property. More...
 
void setTitle (const std::string &theTitle)
 Set title of property. More...
 
PropType type () const
 Get type of property. More...
 
void setType (PropType theType)
 Set type of property. More...
 
const std::string & value () const
 Get property's value in string format. More...
 
void setValue (const std::string &theValue)
 Set property's value in string format. More...
 
const std::string & defaultValue () const
 Get default value of property. More...
 
void setDefaultValue (const std::string &theValue)
 Set default value of property. More...
 
bool operator== (const Config_Prop *theProp) const
 Allows to compare Config_Prop with each other. More...
 
const std::string & min () const
 Returns minimal value. More...
 
void setMin (const std::string &theMin)
 
const std::string & max () const
 Returns maximal value. More...
 
void setMax (const std::string &theMax)
 

Detailed Description

Class which describes a one property.

Member Enumeration Documentation

◆ PropType

Type of stored property.

Constructor & Destructor Documentation

◆ Config_Prop()

Config_Prop::Config_Prop ( const std::string &  theSection,
const std::string &  theName,
const std::string &  theTitle,
PropType  theType,
const std::string &  theDefaultValue,
const std::string &  theMin,
const std::string &  theMax 
)
inline

Creates a one property.

Parameters
theSection- name of section (domain of using) of the property.
theName- name (title) of the value.
theTitle- title of the value
theType- type of the value.
theDefaultValue- default value of the property. This is an initial property value

Member Function Documentation

◆ section()

const std::string& Config_Prop::section ( ) const
inline

Get name of section.

◆ name()

const std::string& Config_Prop::name ( ) const
inline

Get name of property.

◆ title()

const std::string& Config_Prop::title ( ) const
inline

Get title of property.

◆ setTitle()

void Config_Prop::setTitle ( const std::string &  theTitle)
inline

Set title of property.

◆ type()

PropType Config_Prop::type ( ) const
inline

Get type of property.

◆ setType()

void Config_Prop::setType ( PropType  theType)
inline

Set type of property.

◆ value()

const std::string& Config_Prop::value ( ) const
inline

Get property's value in string format.

◆ setValue()

void Config_Prop::setValue ( const std::string &  theValue)

Set property's value in string format.

◆ defaultValue()

const std::string& Config_Prop::defaultValue ( ) const
inline

Get default value of property.

◆ setDefaultValue()

void Config_Prop::setDefaultValue ( const std::string &  theValue)

Set default value of property.

◆ operator==()

bool Config_Prop::operator== ( const Config_Prop theProp) const
inline

Allows to compare Config_Prop with each other.

◆ min()

const std::string& Config_Prop::min ( ) const
inline

Returns minimal value.

◆ max()

const std::string& Config_Prop::max ( ) const
inline

Returns maximal value.