/home/kitware/dashboards/avogadro/libavogadro/src/extension.h

/**********************************************************************
  Extension - Extension Class Interface

  Copyright (C) 2007-2008 Donald Ephraim Curtis

  This file is part of the Avogadro molecular editor project.
  For more information, see <http://avogadro.openmolecules.net/>

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

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

  You should have received a copy of the GNU 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 EXTENSION_H
#define EXTENSION_H

#include "plugin.h"

#include <QVector>
#include <QSettings>
#include <QtPlugin>

#define AVOGADRO_EXTENSION(i, t, d)          \
  public: \
    static QString staticIdentifier() { return i; }          \
    QString identifier() const { return i; }                 \
    static QString staticName() { return t; }                \
    QString name() const { return t; }                       \
    static QString staticDescription() { return d; }         \
    QString description() const { return d; }

#define AVOGADRO_EXTENSION_FACTORY(c)     \
  public: \
    Avogadro::Plugin *createInstance(QObject *parent = 0) { return new c(parent); } \
    Avogadro::Plugin::Type type() const { return Avogadro::Plugin::ExtensionType; } \
    QString identifier() const { return c::staticIdentifier(); } \
    QString name() const { return c::staticName(); }         \
    QString description() const { return c::staticDescription(); }

class QDockWidget;
class QUndoCommand;
class QTextEdit;
class QAction;

namespace Avogadro {

  class DockWidget;
  class GLWidget;
  class Molecule;

  class A_EXPORT Extension : public Plugin
  {

  Q_OBJECT

  public:
    Extension(QObject *parent = 0);

    virtual ~Extension();

    enum MoleculeChangedHint
    {
      KeepOld   = 0x00, 
      DeleteOld = 0x01, 
      NewWindow = 0x02 
    };

    Plugin::Type type() const;

    QString typeName() const;

    virtual QList<QAction *> actions() const = 0;

    virtual QString menuPath(QAction *action) const;

    virtual bool usesNetwork(QAction *action) const;

    virtual QDockWidget * dockWidget();

    virtual QList<DockWidget*> dockWidgets() const;

    virtual int numDockWidgets() const;

    virtual QUndoCommand* performAction(QAction *action, GLWidget *widget) = 0;

    virtual void writeSettings(QSettings &settings) const;

    virtual void readSettings(QSettings &settings);

    virtual int usefulness() const;

  public Q_SLOTS:
    virtual void setMolecule(Molecule *molecule);

  Q_SIGNALS:
    void message(const QString &m);
    void actionsChanged(Extension*);

    void moleculeChanged(Molecule *, int);
    
    void performCommand(QUndoCommand*);

  protected:
    QList<DockWidget*> m_dockWidgets;
  };

} // end namespace Avogadro

#endif