Qt API | Qtopia 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

    #include <qtopia/qpeglobal.h>

    // ##### could use QSettings with Qt 3.0
    #include <qmap.h>
    #include <qstringlist.h>
    #include <qcstring.h>

    #include <qstring.h>
    #include <qtopia/qtopiawinexport.h>

    typedef QMap< QString, QString > ConfigGroup;
    typedef QMap< QString, ConfigGroup> ConfigGroupMap;

    class ConfigPrivate;
    class QTextStream;
    class QTOPIA_EXPORT Config
    {
    public:

        enum Domain { File, User };
        Config( const QString &name, Domain domain=User );
    #ifdef QTOPIA_DESKTOP
        Config( QTextStream &s, Domain domain=User );
    #endif
        ~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 writeEntry( const QString &key, const QByteArray& byteArray); // libqtopia
        void removeEntry( const QString &key );

        // libqtopia...
        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;
        QByteArray readByteArrayEntry(const QString& key) const;
        QByteArray readByteArrayEntry(const QString& key, const QByteArray& deflt) const;
        // ... end.

        // For compatibility, non-const versions.
        QString readEntry( const QString &key, const QString &deflt = QString::null );
        QString readEntryCrypt( const QString &key, const QString &deflt = QString::null );
        QString readEntryDirect( const QString &key, const QString &deflt = QString::null );
        int readNumEntry( const QString &key, int deflt = -1 );
        bool readBoolEntry( const QString &key, bool deflt = FALSE );
        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;
        ConfigGroupMap::Iterator git;
        QString filename;
        QString lang;
        QString glang;
        bool changed;
        ConfigPrivate *d;
        static QString configFilename(const QString& name, Domain);

    private:
        /* This cannot be made public or protected because of binary compat issues */
        void read( QTextStream &s );
    };

    #endif