You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
koffice/lib/kross/api/eventaction.h

87 lines
2.8 KiB

/***************************************************************************
* eventaction.h
* This file is part of the KDE project
* copyright (C)2004-2005 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_API_EVENTACTION_H
#define KROSS_API_EVENTACTION_H
#include <tqstring.h>
//#include <tqobject.h>
#include <kaction.h>
#include <ksharedptr.h>
#include "event.h"
namespace Kross { namespace Api {
// Forward declarations.
class ScriptContainer;
/**
* The EventAction class is used to wrap KAction instances
* into the Kross object hierachy and provide access to
* them.
*/
class EventAction : public Event<EventAction>
{
public:
/**
* Shared pointer to implement reference-counting.
*/
typedef KSharedPtr<EventAction> Ptr;
/**
* Constructor.
*/
EventAction(const TQString& name, KAction* action);
/**
* Destructor.
*/
virtual ~EventAction();
/// \see Kross::Api::Object::getClassName()
virtual const TQString getClassName() const;
/// \see Kross::Api::Event::call()
//virtual Object::Ptr call(const TQString& name, KSharedPtr<List> arguments);
private:
KAction* m_action;
/// \return the text associated with this action.
Kross::Api::Object::Ptr getText(Kross::Api::List::Ptr);
/// Sets the text associated with this action.
Kross::Api::Object::Ptr setText(Kross::Api::List::Ptr);
/// \return true if this action is enabled else false.
Kross::Api::Object::Ptr isEnabled(Kross::Api::List::Ptr);
/// Enables or disables this action.
Kross::Api::Object::Ptr setEnabled(Kross::Api::List::Ptr);
/// Activates the action.
Kross::Api::Object::Ptr activate(Kross::Api::List::Ptr);
};
}}
#endif