File indexing completed on 2024-05-12 16:39:54

0001 /* This file is part of the KDE project
0002    Copyright (C) 2007 Jarosław Staniek <staniek@kde.org>
0003 
0004    This program is free software; you can redistribute it and/or
0005    modify it under the terms of the GNU Library General Public
0006    License as published by the Free Software Foundation; either
0007    version 2 of the License, or (at your option) any later version.
0008 
0009    This program is distributed in the hope that it will be useful,
0010    but WITHOUT ANY WARRANTY; without even the implied warranty of
0011    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012    Library General Public License for more details.
0013 
0014    You should have received a copy of the GNU Library General Public License
0015    along with this program; see the file COPYING.  If not, write to
0016    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0017  * Boston, MA 02110-1301, USA.
0018 */
0019 
0020 #ifndef KEXI_UTILS_INTERNALPROPERTYMAP_H
0021 #define KEXI_UTILS_INTERNALPROPERTYMAP_H
0022 
0023 #include "kexiutils_export.h"
0024 #include <QVariant>
0025 #include <QByteArray>
0026 
0027 namespace KexiUtils
0028 {
0029 
0030 //! @short A simple property map
0031 /*!
0032   Some classes may need internal property system, not defined as Qt proprety
0033   system and not publicly available (e.g. KexiPart class).
0034   Property names are not case-sensitive.
0035   This class is for use by other classes by inheriting.
0036 */
0037 class KEXIUTILS_EXPORT InternalPropertyMap
0038 {
0039 public:
0040     InternalPropertyMap();
0041     ~InternalPropertyMap();
0042 
0043     /*! \returns property value for name \a name.
0044      If \a defaultValue is provided and there is no property with
0045      specified name, \a defaultValue is returned. */
0046     QVariant internalPropertyValue(const QByteArray& name,
0047                                    const QVariant& defaultValue = QVariant()) const;
0048 
0049     /*! Sets property value \a value for property \a name.
0050      If \a value is null, the property is deleted. */
0051     void setInternalPropertyValue(const QByteArray& name, const QVariant& value);
0052 
0053 private:
0054     class Private;
0055     Private * const d;
0056 };
0057 
0058 }
0059 #endif