action.h

/***************************************************************************
 * This file is part of the KDE project
 * copyright (C) 2005 by Sebastian Sauer (mail@dipe.org)
 * copyright (C) 2005 by Tobi Krebs (tobi.krebs@gmail.com)
 * copyright (C) 2006 by Sascha Kupper (kusato@kfnv.de)
 *
 * 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 KOMACRO_ACTION_H
#define KOMACRO_ACTION_H
 
#include "manager.h"
#include "context.h"
#include "variable.h"
 
#include <tqobject.h>
#include <ksharedptr.h>
#include <tqstringlist.h>
 
namespace KoMacro {

    class KOMACRO_EXPORT Action
        : public TQObject // TQt functionality like signals and slots
        , public TDEShared // shared reference-counting
    {
            TQ_OBJECT
  

            TQ_PROPERTY(TQString name READ name WRITE setName)
 
            
            TQ_PROPERTY(TQString text READ text WRITE setText)
 
            
            TQ_PROPERTY(TQString comment READ comment WRITE setComment)
 
        public:

            typedef TQMap<TQString, TDESharedPtr<Action> > Map;

            explicit Action(const TQString& name, const TQString& text = TQString());

            virtual ~Action();

            virtual const TQString toString() const;

            const TQString name() const;
            
            void setName(const TQString& name); 

            const TQString text() const;

            void setText(const TQString& text);

            const TQString comment() const;

            void setComment(const TQString& comment);

            bool hasVariable(const TQString& name) const;

            TDESharedPtr<Variable> variable(const TQString& name) const;

            Variable::Map variables() const;

            TQStringList variableNames() const;

            void setVariable(TDESharedPtr<Variable> variable);

            void setVariable(const TQString& name, const TQString& text, const TQVariant& variant);

            void removeVariable(const TQString& name);

            virtual bool notifyUpdated(const TDESharedPtr<MacroItem> &macroitem, const TQString& name) {
                Q_UNUSED(macroitem);
                Q_UNUSED(name);
                return true; // The default implementation does nothing.
            }
 
        public slots:

            virtual void activate(TDESharedPtr<Context> context) = 0;
 
        private:
            class Private;
            Private* const d;
    };
 
}
 
#endif