slicermode.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright 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_SLICERMODE_H
#define LIBPALA_SLICERMODE_H

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

#include <QtCore/QByteArray>

namespace Pala
{
    class SlicerProperty;

    class LIBPALA_EXPORT SlicerMode
    {
        public:
            SlicerMode(const QByteArray& key, const QString& name);
            virtual ~SlicerMode();

            //The following functions belong to the interface to the Palapeli application. They are not documented because the documentation is targeted at slicer developers.
            void filterProperties(QList<const Pala::SlicerProperty*>& properties) const; //This function removes all properties from the given map which are disabled in this mode, taking both Pala::SlicerProperty::isEnabled and the exceptions defined by this mode into account.
            QByteArray key() const;
            QString name() const;

            void setPropertyEnabled(const QByteArray& property, bool enabled);

            //Some space in the vtable reserved for future additions
            RESERVE_VIRTUAL_5
        private:
            class Private;
            Private* const p;
    };
}

#endif // LIBPALA_SLICERMODE_H