Logo Search packages:      
Sourcecode: blender version File versions

GHOST_CallbackEventConsumer.h

Go to the documentation of this file.
/**
 * $Id: GHOST_CallbackEventConsumer.h,v 1.6 2002/12/28 22:26:45 maarten Exp $
 * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version. The Blender
 * Foundation also sells licenses for use in proprietary software under
 * the Blender License.  See http://www.blender.org/BL/ for information
 * about this.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL/BL DUAL LICENSE BLOCK *****
 */
/**
 * @file    GHOST_CallbackEventConsumer.h
 * Declaration of GHOST_CallbackEventConsumer class.
 */

#ifndef _GHOST_CALLBACK_EVENT_CONSUMER_H_
#define _GHOST_CALLBACK_EVENT_CONSUMER_H_

#include "GHOST_IEventConsumer.h"
#include "GHOST_C-api.h"

/**
 * Event consumer that will forward events to a call-back routine.
 * Especially useful for the C-API.
 * @author  Maarten Gribnau
 * @date    October 25, 2001
 */
00048 class GHOST_CallbackEventConsumer : public GHOST_IEventConsumer
{
public:
      /**
       * Constructor.
       * @param   eventCallback     The call-back routine invoked.
       * @param   userData          The data passed back though the call-back routine.
       */
      GHOST_CallbackEventConsumer(
            GHOST_EventCallbackProcPtr eventCallback, 
            GHOST_TUserDataPtr userData);

      /**
       * Destructor.
       */
00063       virtual ~GHOST_CallbackEventConsumer(void)
      {
      }

      /**
       * This method is called by an event producer when an event is available.
       * @param event   The event that can be handled or ignored.
       * @return Indication as to whether the event was handled.
       */
      virtual     bool processEvent(GHOST_IEvent* event);

protected:
      /** The call-back routine invoked. */
00076       GHOST_EventCallbackProcPtr    m_eventCallback;
      /** The data passed back though the call-back routine. */
00078       GHOST_TUserDataPtr                  m_userData;
};

#endif // _GHOST_CALLBACK_EVENT_CONSUMER_H_


Generated by  Doxygen 1.6.0   Back to index