KviKvsHash.h

Go to the documentation of this file.

#ifndef _KVI_KVS_HASH_H_
#define _KVI_KVS_HASH_H_
//=============================================================================
//
//   File : KviKvsHash.h
//   Creation date : Tue 07 Oct 2003 01:22:37 by Szymon Stefanek
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2003-2010 Szymon Stefanek <pragma at kvirc dot net>
//
//   This program is FREE software. You can redistribute it and/or
//   modify it under the terms of the GNU General Public License
//   as published by the Free Software Foundation; either version 2
//   of the License, or (at your option) any later version.
//
//   This program is distributed in the HOPE that it will be USEFUL,
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//   See the GNU General Public License for more details.
//
//   You should have received a copy of the GNU General Public License
//   along with this program. If not, write to the Free Software Foundation,
//   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
//=============================================================================

#include "kvi_settings.h"
#include "KviPointerHashTable.h"
#include "KviQString.h"
#include "KviKvsVariant.h"
#include "KviHeapObject.h"

typedef KVIRC_API_TYPEDEF KviPointerHashTableIterator<QString, KviKvsVariant> KviKvsHashIterator;

class KVIRC_API KviKvsHash : public KviHeapObject
{
public:
        KviKvsHash();

        KviKvsHash(const KviKvsHash & hash);

        ~KviKvsHash();

public:
        void unset(const QString & szKey);

        void set(const QString & szKey, KviKvsVariant * pVal);

        KviKvsVariant * find(const QString & szKey) const;

        KviKvsVariant * get(const QString & szKey);

        bool isEmpty() const;

        void clear();

        kvs_uint_t size() const;

        void appendAsString(QString & szBuffer) const;

        const KviPointerHashTable<QString, KviKvsVariant> * dict();

        void serialize(QString & szResult);

private:
        KviPointerHashTable<QString, KviKvsVariant> * m_pDict;
};

#endif // _KVI_KVS_HASH_H_