predicateproperties.h

Go to the documentation of this file.

/* This file is part of the KDE libraries

   Copyright (c) 2007 Jos van den Oever <jos@vandenoever.info>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License (LGPL) as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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 library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
#ifndef PREDICATEPROPERTIES_H
#define PREDICATEPROPERTIES_H

#include <kio/kio_export.h>
#include <QtCore/QSharedData>
#include <QtCore/QVariant>
class QValidator;

class KIO_EXPORT PredicateProperties {
friend class PredicatePropertyProvider;
public:
#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED PredicateProperties(const QString& predicate = QString());
#endif
    PredicateProperties(const PredicateProperties& p);
    ~PredicateProperties();
    const PredicateProperties& operator=(const PredicateProperties& p);
    enum Attributes
    {
        Addable     =  1, 
        Removable   =  2, 
        Modifiable  =  4, 
        Cumulative =  8,  
        Averaged    = 16, 
        MultiLine   = 32, 
        SqueezeText = 64  
    };
    uint attributes() const;
    const QString& key() const;
    QVariant::Type type() const;
    const QString& name() const;
    const QString& description() const;
    QValidator* createValidator() const;
    const QStringList& suggestedValues() const;
    uint minCardinality() const;
    uint maxCardinality() const;
    const PredicateProperties& parent() const;
    const QString& unit() const;
    bool isValid() const;
private:
    class Private;
    QSharedDataPointer<Private> d;
};

#endif