action.h

Go to the documentation of this file.

/***************************************************************************
 * action.h
 * This file is part of the KDE project
 * copyright (C)2004-2007 by Sebastian Sauer (mail@dipe.org)
 *
 * This program 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 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
 * Library General Public License for more details.
 * You should have received a copy of the GNU Library General Public License
 * along with this program; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 ***************************************************************************/

#ifndef KROSS_ACTION_H
#define KROSS_ACTION_H

#include <QtCore/QVariant>
#include <QtCore/QObject>
#include <QtCore/QDir>
#include <QtCore/QUrl>
#include <QtGui/QAction>
#include <QtXml/QDomAttr>
#include <QtScript/QScriptable>

#include "errorinterface.h"
#include "childreninterface.h"

namespace Kross {

    class Script;

    class KROSSCORE_EXPORT Action
        : public QAction
        , public QScriptable
        , public ChildrenInterface
        , public ErrorInterface
    {
            Q_OBJECT

        public:

            Action(QObject* parent, const QString& name, const QDir& packagepath = QDir()); //BIC may be removed in favour of the next c'tor

            Action(QObject* parent, const QUrl& url);

            virtual ~Action();

            void fromDomElement(const QDomElement& element);

            void fromDomElement(const QDomElement& element, const QStringList& searchPath/* = QStringList()*/);

            QDomElement toDomElement() const;

            QDomElement toDomElement(const QStringList& searchPath/* = QStringList()*/) const;

            bool initialize();

            void finalize();

            bool isFinalized() const;

            Script* script() const;

        public Q_SLOTS:

            QString name() const;

            int version() const;

            QString description() const;

            void setDescription(const QString& description);

            QString iconName() const;

            void setIconName(const QString& iconname);

            bool isEnabled() const;

            void setEnabled(bool enabled);

            QString file() const;

            bool setFile(const QString& scriptfile);

            QByteArray code() const;

            void setCode(const QByteArray& code);

            QString interpreter() const;

            void setInterpreter(const QString& interpretername);

            QString currentPath() const;

            void addQObject(QObject* obj, const QString &name = QString());

            QObject* qobject(const QString &name) const;

            QStringList qobjectNames() const;

            QVariantMap options() const;

            QVariant option(const QString& name, const QVariant& defaultvalue = QVariant());

            bool setOption(const QString& name, const QVariant& value);

            QStringList functionNames();

            QVariant callFunction(const QString& name, const QVariantList& args = QVariantList());

            QVariant evaluate(const QByteArray& code);

        Q_SIGNALS:

            void updated();

            void dataChanged(Action*);

            void started(Kross::Action*);

            void finished(Kross::Action*);

            void finalized(Kross::Action*);

        private Q_SLOTS:

            void slotTriggered();

        private:
            class Private;
            Private* const d;
    };

}

Q_DECLARE_METATYPE(Kross::Action*)

#endif