diff options
Diffstat (limited to 'kexi/core/kexievents.h')
| -rw-r--r-- | kexi/core/kexievents.h | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/kexi/core/kexievents.h b/kexi/core/kexievents.h new file mode 100644 index 00000000..145ee68d --- /dev/null +++ b/kexi/core/kexievents.h @@ -0,0 +1,100 @@ +/* This file is part of the KDE project + Copyright (C) 2004 Cedric Pasteur <cedric.pasteur@free.fr> + + This library 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 library 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 library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. +*/ + +#ifndef KFORMDESIGNEREVENTS_H +#define KFORMDESIGNEREVENTS_H + +#include <qvaluelist.h> +#include <qguardedptr.h> + +class QDomNode; +class QObject; + +//! A simple class to store events +/*! There are three different types of events (an maybe more in the future): + * signal to slot: sender and receiver are both widgets. + * signal to user function: whenever the signal is emitted, a function in the form script is called. + * signal to action: the signal activates an application action (eg addNewRecord in Kexi) + (other :* global signal to user function: an application global signal (new window opened, etc.) calls a user script function) + + \todo add aliases for slot()?? (eg actionName()) + */ +class KEXICORE_EXPORT Event +{ + public: + Event(QObject *sender, const QCString &signal, + QObject *receiver, const QCString &slot); + Event(QObject *sender, const QCString &signal, + const QCString &functionName); + Event() : m_type(Slot) {;} + ~Event() {;} + + enum { Slot=1000, UserFunction, Action }; //! Event types + int type() {return m_type; } + void setType(int type) { m_type = type; } + + QObject* sender() const { return m_sender; } + QObject* receiver() const { return m_receiver; } + QCString signal() const { return m_signal; } + QCString slot() const { return m_slot; } + + void setSender(QObject *o) { m_sender = o; } + void setReceiver(QObject *o) { m_receiver = o; } + void setSignal(const QCString &s) { m_signal = s; } + void setSlot(const QCString &s) { m_slot = s; } + + protected: + QGuardedPtr<QObject> m_sender; + QCString m_signal; + QGuardedPtr<QObject> m_receiver; + QCString m_slot; + int m_type; +}; + +class KEXICORE_EXPORT EventList : protected QValueList<Event*> +{ + public: + EventList() {;} + ~EventList() {;} + + /*! Adds an event in list. Other overload are available, so that + other classes don't have to use Event class in simple cases. */ + void addEvent(Event *event); + void addEvent(QObject *sender, const QCString &signal, QObject *receiver, const QCString &slot); + void addEvent(QObject *sender, const QCString &signal, const QCString &action); + /*! Removes the Event \a event from the FormScript's list. */ + void removeEvent(Event *event); + + /*! \return A list of events related to widget \a name (ie where Event::sender() + or Event::receiver() == name). */ + EventList* allEventsForObject(QObject *object); + /*! Replace all ocurrences of \a oldname with \a newName inside the list. */ + //void renameWidget(const QCString &oldName, const QCString &newName); + /*! Removes all events related to widget \a name. Called eg when widget is destroyed. */ + void removeAllEventsForObject(QObject *object); + + // make some QValueList function accessible by other classes + QValueListConstIterator<Event*> constBegin() const { return QValueList<Event*>::constBegin(); } + QValueListConstIterator<Event*> constEnd() const { return QValueList<Event*>::constEnd(); } + bool isEmpty() const { return QValueList<Event*>::isEmpty(); } +}; + + +#endif + |