slicerproperty.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright 2009, 2010 Stefan Majewsky <majewsky@gmx.net>
 *
 *   This library 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 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 program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 ***************************************************************************/

#ifndef LIBPALA_SLICERPROPERTY_H
#define LIBPALA_SLICERPROPERTY_H

#if defined(MAKE_LIBPALA) || defined(USE_LOCAL_LIBPALA)
# include "libpalamacros.h"
#else
# include <libpala/libpalamacros.h>
#endif

#include <QtCore/QPair>
#include <QtCore/QVariant>
#include <QtCore/QVariantList>

namespace Pala
{
    class LIBPALA_EXPORT SlicerProperty
    {
        protected:
            explicit SlicerProperty(QVariant::Type type, const QString& caption);
        public:
            virtual ~SlicerProperty();

            //The following functions belong to the interface to the Palapeli application. They are not documented because the documentation is targeted at slicer developers.
            QString caption() const;
            QVariantList choices() const;
            QVariant defaultValue() const;
            bool isAdvanced() const;
            bool isEnabled() const;
            QByteArray key() const;
            void setKey(const QByteArray& key);
            QVariant::Type type() const;

            void setAdvanced(bool advanced = true);
            void setChoices(const QVariantList& choices);
            void setDefaultValue(const QVariant& value);
            void setEnabled(bool enabled);
        private:
            class Private;
            Private* const p;
    };

    class LIBPALA_EXPORT BooleanProperty : public Pala::SlicerProperty
    {
        public:
            explicit BooleanProperty(const QString& caption);
            virtual ~BooleanProperty();
        private:
            class Private;
            Private* const p;
    };

    class LIBPALA_EXPORT IntegerProperty : public Pala::SlicerProperty
    {
        public:
            enum Representation { SpinBox, Slider, DefaultRepresentation = SpinBox };

            explicit IntegerProperty(const QString& caption);
            virtual ~IntegerProperty();

            QPair<int, int> range() const;
            Representation representation() const;

            void setRange(int min, int max);
            void setRepresentation(Representation representation);
        private:
            class Private;
            Private* const p;
    };

    class LIBPALA_EXPORT StringProperty : public Pala::SlicerProperty
    {
        public:
            explicit StringProperty(const QString& caption);
            virtual ~StringProperty();
        private:
            class Private;
            Private* const p;
    };
}

#endif // LIBPALA_SLICERPROPERTY_H