Image Component Library (ICL)
Public Member Functions | Public Attributes | List of all members
icl::utils::Configurable::Property Struct Reference

Represents a single property. More...

#include <Configurable.h>

Public Member Functions

 Property ()
 
 Property (Configurable *parent, const std::string &name, const std::string &type, const std::string &info, const std::string &value, int volatileness, const std::string &tooltip)
 
bool operator== (const std::string &name) const
 for more efficient find More...
 

Public Attributes

Configurableconfigurable
 corresponding Configurable More...
 
std::string name
 property-ID More...
 
std::string type
 property-type (menu, range,....); More...
 
std::string info
 property-information (depends on type) More...
 
std::string value
 (optional) property-value this can be use to store current property value More...
 
int volatileness
 volatileness of a this property (0= no-volatileness, X=expected update every X msec) More...
 
std::string tooltip
 property description, that is also used as tooltip More...
 
std::string childPrefix
 

Detailed Description

Represents a single property.

Constructor & Destructor Documentation

◆ Property() [1/2]

icl::utils::Configurable::Property::Property ( )
inline

◆ Property() [2/2]

icl::utils::Configurable::Property::Property ( Configurable parent,
const std::string &  name,
const std::string &  type,
const std::string &  info,
const std::string &  value,
int  volatileness,
const std::string &  tooltip 
)
inline

Member Function Documentation

◆ operator==()

bool icl::utils::Configurable::Property::operator== ( const std::string &  name) const
inline

for more efficient find

Member Data Documentation

◆ childPrefix

std::string icl::utils::Configurable::Property::childPrefix

◆ configurable

Configurable* icl::utils::Configurable::Property::configurable

corresponding Configurable

◆ info

std::string icl::utils::Configurable::Property::info

property-information (depends on type)

◆ name

std::string icl::utils::Configurable::Property::name

property-ID

◆ tooltip

std::string icl::utils::Configurable::Property::tooltip

property description, that is also used as tooltip

◆ type

std::string icl::utils::Configurable::Property::type

property-type (menu, range,....);

◆ value

std::string icl::utils::Configurable::Property::value

(optional) property-value this can be use to store current property value

◆ volatileness

int icl::utils::Configurable::Property::volatileness

volatileness of a this property (0= no-volatileness, X=expected update every X msec)


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