configuration::int_configlet Class Reference
Stores a simple integer in a configuration repository. More...
#include <configlet.h>
Public Member Functions | |
| int_configlet (const basis::astring §ion, const basis::astring &entry, int current_value=0, int default_value=0) | |
| virtual | ~int_configlet () |
| int | current_value () const |
| virtual void | current_value (int new_current) |
| the modifier function is virtual so derived classes can extend. | |
| int | default_value () const |
| void | default_value (int new_default) |
| virtual bool | load (configurator &config) |
| retrieves the configlet's information from the "config". | |
| virtual bool | store (configurator &config) const |
| writes the configlet's information out to the "config". | |
| configlet * | duplicate () const |
| a virtual copy constructor for configlets. | |
Detailed Description
Stores a simple integer in a configuration repository.
Definition at line 115 of file configlet.h.
Constructor & Destructor Documentation
| configuration::int_configlet::int_configlet | ( | const basis::astring & | section, | |
| const basis::astring & | entry, | |||
| int | current_value = 0, |
|||
| int | default_value = 0 | |||
| ) |
Definition at line 122 of file configlet.cpp.
Referenced by duplicate().
| configuration::int_configlet::~int_configlet | ( | ) | [virtual] |
Definition at line 130 of file configlet.cpp.
Member Function Documentation
| void configuration::int_configlet::current_value | ( | int | new_current | ) | [virtual] |
the modifier function is virtual so derived classes can extend.
Reimplemented in configuration::bounded_int_configlet.
Definition at line 132 of file configlet.cpp.
| int configuration::int_configlet::current_value | ( | ) | const [inline] |
Definition at line 122 of file configlet.h.
Referenced by configuration::bounded_int_configlet::current_value(), and load().
| void configuration::int_configlet::default_value | ( | int | new_default | ) | [inline] |
Definition at line 128 of file configlet.h.
| int configuration::int_configlet::default_value | ( | ) | const [inline] |
Definition at line 127 of file configlet.h.
Referenced by configuration::bounded_int_configlet::current_value().
| configlet * configuration::int_configlet::duplicate | ( | ) | const [virtual] |
a virtual copy constructor for configlets.
the returned object will be a new copy of this configlet.
Implements configuration::configlet.
Reimplemented in configuration::bounded_int_configlet.
Definition at line 148 of file configlet.cpp.
References int_configlet().
| bool configuration::int_configlet::load | ( | configurator & | config | ) | [virtual] |
retrieves the configlet's information from the "config".
true is returned when this is successful. note that false is returned if the entry was not originally present; if the configurator has the AUTO_STORE behavior, then we will write out the default value on failure. the next load() would be a success in that case, but would return the default.
Implements configuration::configlet.
Definition at line 135 of file configlet.cpp.
References current_value(), configuration::configlet::entry(), configuration::configurator::get(), configuration::configurator::load(), and configuration::configlet::section().
| bool configuration::int_configlet::store | ( | configurator & | config | ) | const [virtual] |
writes the configlet's information out to the "config".
Implements configuration::configlet.
Definition at line 145 of file configlet.cpp.
References configuration::configlet::entry(), configuration::configlet::section(), and configuration::configurator::store().
The documentation for this class was generated from the following files:
- /var/www/hoople2/source/core/library/configuration/configlet.h
- /var/www/hoople2/source/core/library/configuration/configlet.cpp
