You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
koffice/lib/kross/api/dict.h

70 lines
2.2 KiB

/***************************************************************************
* dict.h
* This file is part of the KDE project
* copyright (C)2004-2005 by Sebastian Sauer (mail@dipe.org)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library 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
* Library General Public License for more details.
* You should have received a copy of the GNU Library General Public License
* along with this program; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
***************************************************************************/
#ifndef KROSS_API_DICT_H
#define KROSS_API_DICT_H
#include <qstring.h>
#include <qmap.h>
#include "object.h"
#include "value.h"
namespace Kross { namespace Api {
/**
* The Dict class implementates \a Value to handle
* key=value base dictonaries/maps.
*/
class Dict : public Value< List, QMap<QString, Object::Ptr> >
{
friend class Value< List, QMap<QString, Object::Ptr> >;
public:
/**
* Constructor.
*
* @param value The map of \a Object instances accessible
* via there string-identifier that is in this
* \a Dict intialy.
*/
explicit Dict(const QMap<QString, Object::Ptr> value);
/**
* Destructor.
*/
virtual ~Dict();
/// \see Kross::Api::Object::getClassName()
virtual const QString getClassName() const;
/**
* \return a string representation of the whole dictonary.
*
* \see Kross::Api::Object::toString()
*/
virtual const QString toString();
};
}}
#endif