diff options
author | Maarten Gribnau <mail@maartengribnau.com> | 2002-12-29 01:26:45 +0300 |
---|---|---|
committer | Maarten Gribnau <mail@maartengribnau.com> | 2002-12-29 01:26:45 +0300 |
commit | b2824fe23a152f1e53d73cbf846d4843360c6601 (patch) | |
tree | fc60bfb0ad5a97300d49f75e0012f4adaea9911c /intern/ghost/GHOST_IEvent.h | |
parent | 9e3c814e7272237c9d6b13f4d7b8a9b5d41a3ed6 (diff) |
Removed those extra CVS tag lines in the header files of ghost (now I know what
Gilles meant) and added some extra doxygen tags I had lying around.
Removed the cocoa file since it was rubbish.
Maarten
Diffstat (limited to 'intern/ghost/GHOST_IEvent.h')
-rw-r--r-- | intern/ghost/GHOST_IEvent.h | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/intern/ghost/GHOST_IEvent.h b/intern/ghost/GHOST_IEvent.h index eb60b5d2e53..4ec47c6d732 100644 --- a/intern/ghost/GHOST_IEvent.h +++ b/intern/ghost/GHOST_IEvent.h @@ -28,13 +28,9 @@ * * ***** END GPL/BL DUAL LICENSE BLOCK ***** */ - /** - - * $Id$ - * Copyright (C) 2001 NaN Technologies B.V. - * @author Maarten Gribnau - * @date May 31, 2001 + * @file GHOST_IEvent.h + * Declaration of GHOST_IEvent interface class. */ #ifndef _GHOST_IEVENT_H_ @@ -45,7 +41,14 @@ class GHOST_IWindow; /** - * Interface class for events received the operating system. + * 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 */ |