Maarten Gribnau
b2824fe23a
Gilles meant) and added some extra doxygen tags I had lying around. Removed the cocoa file since it was rubbish. Maarten
111 lines
2.6 KiB
C++
111 lines
2.6 KiB
C++
/**
|
|
* $Id$
|
|
* ***** 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_Event.h
|
|
* Declaration of GHOST_Event class.
|
|
*/
|
|
|
|
#ifndef _GHOST_EVENT_H_
|
|
#define _GHOST_EVENT_H_
|
|
|
|
#include "GHOST_IEvent.h"
|
|
|
|
|
|
/**
|
|
* Base class for events received the operating system.
|
|
* @author Maarten Gribnau
|
|
* @date May 11, 2001
|
|
*/
|
|
class GHOST_Event : public GHOST_IEvent
|
|
{
|
|
public:
|
|
/**
|
|
* Constructor.
|
|
* @param msec The time this event was generated.
|
|
* @param type The type of this event.
|
|
* @param window The generating window (or NULL if system event).
|
|
*/
|
|
GHOST_Event(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow* window)
|
|
: m_type(type), m_time(msec), m_window(window), m_data(0)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Returns the event type.
|
|
* @return The event type.
|
|
*/
|
|
virtual GHOST_TEventType getType()
|
|
{
|
|
return m_type;
|
|
}
|
|
|
|
/**
|
|
* Returns the time this event was generated.
|
|
* @return The event generation time.
|
|
*/
|
|
virtual GHOST_TUns64 getTime()
|
|
{
|
|
return m_time;
|
|
}
|
|
|
|
/**
|
|
* Returns the window this event was generated on,
|
|
* or NULL if it is a 'system' event.
|
|
* @return The generating window.
|
|
*/
|
|
virtual GHOST_IWindow* getWindow()
|
|
{
|
|
return m_window;
|
|
}
|
|
|
|
/**
|
|
* Returns the event data.
|
|
* @return The event data.
|
|
*/
|
|
virtual GHOST_TEventDataPtr getData()
|
|
{
|
|
return m_data;
|
|
}
|
|
|
|
protected:
|
|
/** Type of this event. */
|
|
GHOST_TEventType m_type;
|
|
/** The time this event was generated. */
|
|
GHOST_TUns64 m_time;
|
|
/** Pointer to the generating window. */
|
|
GHOST_IWindow* m_window;
|
|
/** Pointer to the event data. */
|
|
GHOST_TEventDataPtr m_data;
|
|
};
|
|
|
|
#endif // _GHOST_EVENT_H_
|
|
|