intern/ghost/GHOST_IEventConsumer.h

   1 /**
   2  * $Id$
   3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version. The Blender
   9  * Foundation also sells licenses for use in proprietary software under
  10  * the Blender License.  See http://www.blender.org/BL/ for information
  11  * about this.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21  *
  22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  23  * All rights reserved.
  24  *
  25  * The Original Code is: all of this file.
  26  *
  27  * Contributor(s): none yet.
  28  *
  29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
  30  */
  31 /**
  32  * @file        GHOST_IEventConsumer.h
  33  * Declaration of GHOST_IEventConsumer interface class.
  34  */
  35
  36 #ifndef _GHOST_IEVENT_CONSUMER_H_
  37 #define _GHOST_IEVENT_CONSUMER_H_
  38
  39 #include "GHOST_IEvent.h"
  40
  41 /**
  42  * Interface class for objects interested in receiving events.
  43  * Objects interested in events should inherit this class and implement the
  44  * processEvent() method. They should then be registered with the system that
  45  * they want to receive events. The system will call the processEvent() method
  46  * for every installed event consumer to pass events.
  47  * @see GHOST_ISystem#addEventConsumer
  48  * @author      Maarten Gribnau
  49  * @date        May 14, 2001
  50  */
  51 class GHOST_IEventConsumer
  52 {
  53 public:
  54         /**
  55          * Destructor.
  56          */
  57         virtual ~GHOST_IEventConsumer()
  58         {
  59         }
  60
  61         /**
  62          * This method is called by the system when it has events to dispatch.
  63          * @see GHOST_ISystem#dispatchEvents
  64          * @param       event   The event that can be handled or ignored.
  65          * @return      Indication as to whether the event was handled.
  66          */
  67         virtual bool processEvent(GHOST_IEvent* event) = 0;
  68 };
  69
  70 #endif // _GHOST_EVENT_CONSUMER_H_
  71