intern/ghost/GHOST_IEvent.h

   1 /*
   2  * ***** BEGIN GPL LICENSE BLOCK *****
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  19  * All rights reserved.
  20  *
  21  * The Original Code is: all of this file.
  22  *
  23  * Contributor(s): none yet.
  24  *
  25  * ***** END GPL LICENSE BLOCK *****
  26  */
  27
  28 /** \file ghost/GHOST_IEvent.h
  29  *  \ingroup GHOST
  30  * Declaration of GHOST_IEvent interface class.
  31  */
  32
  33 #ifndef __GHOST_IEVENT_H__
  34 #define __GHOST_IEVENT_H__
  35
  36 #include <stddef.h>
  37 #include "GHOST_Types.h"
  38
  39 class GHOST_IWindow;
  40
  41 /**
  42  * Interface class for events received from GHOST.
  43  * You should not need to inherit this class. The system will pass these events
  44  * to the GHOST_IEventConsumer::processEvent() method of event consumers.<br>
  45  * Use the getType() method to retrieve the type of event and the getData()
  46  * method to get the event data out. Using the event type you can cast the
  47  * event data to the correct event dat structure.
  48  * \see GHOST_IEventConsumer#processEvent
  49  * \see GHOST_TEventType
  50  * \author      Maarten Gribnau
  51  * \date        May 31, 2001
  52  */
  53 class GHOST_IEvent
  54 {
  55 public:
  56         /**
  57          * Destructor.
  58          */
  59         virtual ~GHOST_IEvent()
  60         {
  61         }
  62
  63         /**
  64          * Returns the event type.
  65          * \return The event type.
  66          */
  67         virtual GHOST_TEventType getType() = 0;
  68
  69         /**
  70          * Returns the time this event was generated.
  71          * \return The event generation time.
  72          */
  73         virtual GHOST_TUns64 getTime() = 0;
  74
  75         /**
  76          * Returns the window this event was generated on,
  77          * or NULL if it is a 'system' event.
  78          * \return The generating window.
  79          */
  80         virtual GHOST_IWindow *getWindow() = 0;
  81
  82         /**
  83          * Returns the event data.
  84          * \return The event data.
  85          */
  86         virtual GHOST_TEventDataPtr getData() = 0;
  87
  88 #ifdef WITH_CXX_GUARDEDALLOC
  89         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_IEvent")
  90 #endif
  91 };
  92
  93 #endif // __GHOST_IEVENT_H__
  94