| Classes | Functions | DevRef | Qt API | Qtopia Documentation |

# config.h

This is the verbatim text of the config.h include file. It is provided only for illustration; the copyright remains with Trolltech.

    /**********************************************************************
    ** Copyright (C) 2000-2002 Trolltech AS.  All rights reserved.
    **
    ** This file is part of the Qtopia Environment.
    **
    ** This file may be distributed and/or modified under the terms of the
    ** GNU General Public License version 2 as published by the Free Software
    ** Foundation and appearing in the file LICENSE.GPL included in the
    ** packaging of this file.
    **
    ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
    ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
    **
    ** See http://www.trolltech.com/gpl/ for GPL licensing information.
    **
    ** Contact info@trolltech.com if any conditions of this licensing are
    ** not clear to you.
    **
    **********************************************************************/

    #ifndef CONFIG_H
    #define CONFIG_H

    // ##### could use QSettings with Qt 3.0

    #include <qmap.h>
    #include <qstringlist.h>

    class ConfigPrivate;
    class Config
    {
    public:
        typedef QMap< QString, QString > ConfigGroup;

        enum Domain { File, User };
        Config( const QString &name, Domain domain=User );
        ~Config();

        bool operator == ( const Config & other ) const { return (filename == other.filename); }
        bool operator != ( const Config & other ) const { return (filename != other.filename); }

        bool isValid() const;
        bool hasKey( const QString &key ) const;

        void setGroup( const QString &gname );
        void writeEntry( const QString &key, const char* value );
        void writeEntry( const QString &key, const QString &value );
        void writeEntryCrypt( const QString &key, const QString &value );
        void writeEntry( const QString &key, int num );
    #ifdef Q_HAS_BOOL_TYPE
        void writeEntry( const QString &key, bool b );
    #endif
        void writeEntry( const QString &key, const QStringList &lst, const QChar &sep );
        void removeEntry( const QString &key );

        QString readEntry( const QString &key, const QString &deflt = QString::null ) const;
        QString readEntryCrypt( const QString &key, const QString &deflt = QString::null ) const;
        QString readEntryDirect( const QString &key, const QString &deflt = QString::null ) const;
        int readNumEntry( const QString &key, int deflt = -1 ) const;
        bool readBoolEntry( const QString &key, bool deflt = FALSE ) const;
        QStringList readListEntry( const QString &key, const QChar &sep ) const;

        // For compatibility, non-const versions.
        QString readEntry( const QString &key, const QString &deflt );
        QString readEntryCrypt( const QString &key, const QString &deflt );
        QString readEntryDirect( const QString &key, const QString &deflt );
        int readNumEntry( const QString &key, int deflt );
        bool readBoolEntry( const QString &key, bool deflt );
        QStringList readListEntry( const QString &key, const QChar &sep );

        void clearGroup();

        void write( const QString &fn = QString::null );

    protected:
        void read();
        bool parse( const QString &line );

        QMap< QString, ConfigGroup > groups;
        QMap< QString, ConfigGroup >::Iterator git;
        QString filename;
        QString lang;
        QString glang;
        bool changed;
        ConfigPrivate *d;
        static QString configFilename(const QString& name, Domain);
    };

    inline QString Config::readEntry( const QString &key, const QString &deflt ) const
    { return ((Config*)this)->readEntry(key,deflt); }
    inline QString Config::readEntryCrypt( const QString &key, const QString &deflt ) const
    { return ((Config*)this)->readEntryCrypt(key,deflt); }
    inline QString Config::readEntryDirect( const QString &key, const QString &deflt ) const
    { return ((Config*)this)->readEntryDirect(key,deflt); }
    inline int Config::readNumEntry( const QString &key, int deflt ) const
    { return ((Config*)this)->readNumEntry(key,deflt); }
    inline bool Config::readBoolEntry( const QString &key, bool deflt ) const
    { return ((Config*)this)->readBoolEntry(key,deflt); }
    inline QStringList Config::readListEntry( const QString &key, const QChar &sep ) const
    { return ((Config*)this)->readListEntry(key,sep); }

    #endif