Logo Search packages:      
Sourcecode: blender version File versions

GHOST_IEvent.h

Go to the documentation of this file.
/**
 * $Id: GHOST_IEvent.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_IEvent.h
 * Declaration of GHOST_IEvent interface class.
 */

#ifndef _GHOST_IEVENT_H_
#define _GHOST_IEVENT_H_

#include "GHOST_Types.h"

class GHOST_IWindow;

/**
 * Interface class for events received from GHOST.
 * You should not need to inherit this class. The system will pass these events
 * to the GHOST_IEventConsumer::processEvent() method of event consumers.<br>
 * Use the getType() method to retrieve the type of event and the getData() 
 * method to get the event data out. Using the event type you can cast the 
 * event data to the correct event dat structure.
 * @see GHOST_IEventConsumer#processEvent
 * @see GHOST_TEventType
 * @author  Maarten Gribnau
 * @date    May 31, 2001
 */
00055 class GHOST_IEvent
{
public:
      /**
       * Destructor.
       */
00061       virtual ~GHOST_IEvent()
      {
      }

      /**
       * Returns the event type.
       * @return The event type.
       */
      virtual GHOST_TEventType getType() = 0;

      /**
       * Returns the time this event was generated.
       * @return The event generation time.
       */
      virtual GHOST_TUns64 getTime() = 0;

      /**
       * Returns the window this event was generated on, 
       * or NULL if it is a 'system' event.
       * @return The generating window.
       */
      virtual GHOST_IWindow* getWindow() = 0;
      
      /**
       * Returns the event data.
       * @return The event data.
       */
      virtual GHOST_TEventDataPtr getData() = 0;
};

#endif // _GHOST_IEVENT_H_


Generated by  Doxygen 1.6.0   Back to index