author | mickeyl <mickeyl> | 2003-05-10 14:46:02 (UTC) |
---|---|---|
committer | mickeyl <mickeyl> | 2003-05-10 14:46:02 (UTC) |
commit | 7d97fa637bb1af225b9e5075982b32718b0f78e4 (patch) (side-by-side diff) | |
tree | e06b9043c9fc3c0cf769986ea5e6a4983dbfe784 /libopie2/opiecore/oconfig.h | |
parent | 8bf3021bf5e86f7f6f6083606d77427adc8d13a7 (diff) | |
download | opie-7d97fa637bb1af225b9e5075982b32718b0f78e4.zip opie-7d97fa637bb1af225b9e5075982b32718b0f78e4.tar.gz opie-7d97fa637bb1af225b9e5075982b32718b0f78e4.tar.bz2 |
- make oApp not return a const app object
- homogenize oconfig documentation
- remove debug output
-rw-r--r-- | libopie2/opiecore/oconfig.h | 55 |
1 files changed, 14 insertions, 41 deletions
diff --git a/libopie2/opiecore/oconfig.h b/libopie2/opiecore/oconfig.h index afe14b1..444d280 100644 --- a/libopie2/opiecore/oconfig.h +++ b/libopie2/opiecore/oconfig.h @@ -30,12 +30,13 @@ */ #ifndef OCONFIG_H #define OCONFIG_H //FIXME: Implement for X11 or reuse libqpe/Config there also? +//FIXME: Or rather use QSettings also for libqpe? #include <qpe/config.h> class QColor; class QFont; @@ -44,67 +45,40 @@ class QFont; * featuring additional handling of color and font entries */ class OConfig : public Config { public: - /** - * Constructs a OConfig object. - * - * @param name A file to parse. + * Constructs a OConfig object with a @a name. */ OConfig( const QString &name, Domain domain = User ); - /** * Destructs the OConfig object. * * Writes back any dirty configuration entries, and destroys * dynamically created objects. */ virtual ~OConfig(); - /** - * Returns the name of the group in which we are - * searching for keys and from which we are retrieving entries. - * - * @return The current group. + * @returns the name of the current group. + * The current group is used for searching keys and accessing entries. */ const QString& group() { return git.key(); }; - /** - * Reads a @ref QColor entry. - * - * Read the value of an entry specified by @p pKey in the current group - * and interpret it as a color. - * - * @param pKey The key to search for. - * @param pDefault A default value (null QColor by default) returned if the - * key was not found or if the value cannot be interpreted. - * @return The value for this key. + * @returns a @ref QColor entry or a @a default value if the key is not found. */ QColor readColorEntry( const QString& key, const QColor* pDefault ) const; - /** - * Reads a @ref QFont value. - * - * Read the value of an entry specified by @p pKey in the current group - * and interpret it as a font object. - * - * @param pKey The key to search for. - * @param pDefault A default value (null QFont by default) returned if the - * key was not found or if the read value cannot be interpreted. - * @return The value for this key. + * @returns a @ref QFont value or a @a default value if the key is not found. */ QFont readFontEntry( const QString& key, const QFont* pDefault ) const; - }; /** - * Helper class to facilitate working with @ref OConfig / @ref OSimpleConfig - * groups. + * @brief Helper class for easier use of OConfig groups. * * Careful programmers always set the group of a * @ref OConfig object to the group they want to read from * and set it back to the old one of afterwards. This is usually * written as: * <pre> @@ -126,35 +100,34 @@ class OConfig : public Config * one group (including the creation of the OConfigGroupSaver object) * in one block. * * @author Matthias Kalle Dalheimer <Kalle@kde.org> * @version $Id$ * @see OConfig - * @short Helper class for easier use of OConfig groups */ class OConfigGroupSaver { public: /** - * Constructor. You pass a pointer to the OConfigBase-derived - * object you want to work with and a string indicating the _new_ - * group. - * @param config The OConfig-derived object this - * OConfigGroupSaver works on. - * @param group The new group that the config object should switch to. + * Constructor. + * Create the object giving a @config object and a @a group to become + * the current group. */ OConfigGroupSaver( OConfig* config, QString group ) :_config(config), _oldgroup(config->group() ) { _config->setGroup( group ); } OConfigGroupSaver( OConfig* config, const char *group ) :_config(config), _oldgroup(config->group()) { _config->setGroup( group ); } OConfigGroupSaver( OConfig* config, const QCString &group ) : _config(config), _oldgroup(config->group()) { _config->setGroup( group ); } - + /** + * Destructor. + * Restores the last current group. + */ ~OConfigGroupSaver() { _config->setGroup( _oldgroup ); } OConfig* config() { return _config; }; private: OConfig* _config; |