AbstractParameter.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of FRAPPER
research.animationsinstitut.de
sourceforge.net/projects/frapper

Copyright (c) 2008-2009 Filmakademie Baden-Wuerttemberg, Institute of Animation 

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; version 2.1 of the License.

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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
-----------------------------------------------------------------------------
*/


#ifndef ABSTRACTPARAMETER_H
#define ABSTRACTPARAMETER_H

#include "FrapperPrerequisites.h"
#include <QtCore/QObject>
#include <QtCore/QHash>
#include <QtCore/QList>
#include <QtCore/QString>


namespace Frapper {

//
// Forward Declarations
//
class Node;


class FRAPPER_CORE_EXPORT AbstractParameter : public QObject
{

    Q_OBJECT

public: // type definitions

    typedef QHash<QString, AbstractParameter *> Map;

    typedef QList<AbstractParameter *> List;

public: // constructors and destructors

    AbstractParameter ( const QString &name );

    AbstractParameter ( const AbstractParameter &parameter );

    virtual ~AbstractParameter ();

public: // functions

    QString getName () const;

    bool isEnabled () const;

    virtual void setEnabled ( bool enabled, bool propagate = true );

    virtual void setName ( const QString &name );

    Node * getNode () const;

    virtual void setNode ( Node *node );

    virtual AbstractParameter * clone () = 0;

    virtual bool isGroup () const = 0;

    virtual void reset () = 0;

signals:  // signals

    void enabledChanged ();


protected: // data

    QString m_name;

    bool m_enabled;

    Node *m_node;
};

} // end namespace Frapper

#endif