gls_event.h

Go to the documentation of this file.

#ifndef _GLS_EVENT_H
#define _GLS_EVENT_H

/*! \file gls_event.h

\brief  This header the GlsEvent structure and related classes
        in the GL Studio DO-178B Runtime Library.

\par Copyright Information
Copyright (C) 1999-2012 The DiSTI Corporation<br>
Orlando, FL USA<br>
All rights reserved.<br>

  This file is copyrighted software and contains proprietary trade secrets of
DiSTI, and embodies substantial creative efforts as well as confidential
information, ideas, and expressions.

  Permission to use, and copy this software and its documentation for any
purpose is hereby granted per the Distribution Agreement and/or the Licensing
Agreement signed with DiSTI. This permission is granted provided that:
    1.  The above copyright notice appears in all copies.
    2.  That both the copyright notice and this permission notice appear in
        the supporting documentation.
    3.  That the names DiSTI and GL Studio not be used in advertising or
        publicity pertaining to distribution of the software without specific,
        written prior permission of DiSTI.
 
  Permission to modify the software is granted, but not the right to
distribute the source code whether modified, or non-modified.  Modifying the
software might invalidate the DO-178B certification package.

  Permission to distribute binaries produced by compiling source code, or
modified source code is granted, provided you:
    1.  Provide your name and address as the primary contact for the support
        of your modified version.
    2.  Retain our contact information in regard to use of the base software. 

   DiSTI does not provide warranty for this software or guarantee that it
satisfies any specification or requirement unless otherwise stated in a
specific contractual arrangement between the customer and DiSTI.

*/

#include "gls_include.h"
#include "gls_types.h"
#include "gls_vertex.h"

// forward ref
class GlsDisplayObject;

/** encapsulates an event */
struct GlsEvent
{
    /** enumeration of possible event types */
    enum EventType
    {
        EVENT_TYPE_MOUSE_BUTTON_DOWN,   /**< mouse button down event */
        EVENT_TYPE_MOUSE_BUTTON_UP,     /**< mouse button up event   */
        EVENT_TYPE_MOUSE_MOVE,          /**< mouse move event        */
        EVENT_TYPE_MOUSE_DRAG,          /**< mouse drag event        */
        EVENT_TYPE_MOUSE_ENTER,         /**< mouse enter event       */
        EVENT_TYPE_MOUSE_LEAVE,         /**< mouse leave event       */
        EVENT_TYPE_KEYBOARD_DOWN,       /**< keyboard down event     */
        EVENT_TYPE_KEYBOARD_UP,         /**< keyboard up event       */
        EVENT_TYPE_USER,                /**< User defined event      */

        #if defined( GLS_DEBUG )
            EVENT_TYPE_INVALID          /**< invalid event type ( GLS_DEBUG only )*/
        #endif // GLS_DEBUG
    };

    /** mouse button bit flags */
    enum MouseButton
    {
        MOUSE_BUTTON_NONE   =           0u,  /**< no mouse button is down             */
        MOUSE_BUTTON_LEFT   = ( 1u << 0u ),  /**< left mouse button is down           */
        MOUSE_BUTTON_MIDDLE = ( 1u << 1u ),  /**< middle mouse button is down         */
        MOUSE_BUTTON_RIGHT  = ( 1u << 2u ),  /**< right mouse button is down          */
        MOUSE_BUTTON_USER_1 = ( 1u << 3u ),  /**< user defined mouse button 1 is down */
        MOUSE_BUTTON_USER_2 = ( 1u << 4u ),  /**< user defined mouse button 2 is down */
        MOUSE_BUTTON_USER_3 = ( 1u << 5u ),  /**< user defined mouse button 3 is down */
        MOUSE_BUTTON_USER_4 = ( 1u << 6u ),  /**< user defined mouse button 4 is down */
        MOUSE_BUTTON_USER_5 = ( 1u << 7u )   /**< user defined mouse button 5 is down */
    };

    /** keyboard modifier bit flags */
    enum KeyboardModifier
    {
        KEYBOARD_MODIFIER_NONE        =             0u,  /**< no modifier keys are down           */
        KEYBOARD_MODIFIER_SHIFT       =  ( 1u << 0u  ),  /**< shift key is down                   */
        KEYBOARD_MODIFIER_CAPS_LOCK   =  ( 1u << 1u  ),  /**< caps lock key is down               */
        KEYBOARD_MODIFIER_CTRL        =  ( 1u << 2u  ),  /**< ctrl key is down                    */
        KEYBOARD_MODIFIER_ALT         =  ( 1u << 3u  ),  /**< alt key is down                     */
        KEYBOARD_MODIFIER_NUM_LOCK    =  ( 1u << 4u  ),  /**< num lock key is down                */
        KEYBOARD_MODIFIER_SCROLL_LOCK =  ( 1u << 5u  ),  /**< scroll lock key is down             */
        KEYBOARD_MODIFIER_META        =  ( 1u << 6u  ),  /**< meta key is down                    */
        KEYBOARD_MODIFIER_USER_MOD_1  =  ( 1u << 7u  ),  /**< user defined key modifier 1 is down */
        KEYBOARD_MODIFIER_USER_MOD_2  =  ( 1u << 8u  ),  /**< user defined key modifier 2 is down */
        KEYBOARD_MODIFIER_USER_MOD_3  =  ( 1u << 9u  ),  /**< user defined key modifier 3 is down */
        KEYBOARD_MODIFIER_USER_MOD_4  =  ( 1u << 10u ),  /**< user defined key modifier 4 is down */
        KEYBOARD_MODIFIER_USER_MOD_5  =  ( 1u << 11u ),  /**< user defined key modifier 5 is down */
        KEYBOARD_MODIFIER_USER_MOD_6  =  ( 1u << 12u ),  /**< user defined key modifier 6 is down */
        KEYBOARD_MODIFIER_USER_MOD_7  =  ( 1u << 13u ),  /**< user defined key modifier 7 is down */
    };

    /** Keyboard key enumeration */
    enum KeyboardKey
    {
        KEYBOARD_KEY_NULL                 = 0x00,  /**< no key              */
        KEYBOARD_KEY_SHIFT                = 0x01,  /**< shift key           */
        KEYBOARD_KEY_CTRL                 = 0x02,  /**< ctrl key            */
        KEYBOARD_KEY_ALT                  = 0x03,  /**< alt key             */
        KEYBOARD_KEY_META                 = 0x04,  /**< meta key            */
        KEYBOARD_CAPS_LOCK                = 0x05,  /**< caps lock key       */
        KEYBOARD_KEY_NUM_LOCK             = 0x06,  /**< num lock key        */
        KEYBOARD_KEY_SCROLL_LOCK          = 0x07,  /**< scroll lock key     */
        KEYBOARD_KEY_BACKSPACE            = 0x08,  /**< backspace key       */
        KEYBOARD_KEY_TAB                  = 0x09,  /**< tab key             */
        KEYBOARD_KEY_ENTER                = 0x0A,  /**< enter key           */
        KEYBOARD_KEY_PAUSE                = 0x0B,  /**< pause key           */
        KEYBOARD_KEY_INSERT               = 0x0C,  /**< insert key          */
        KEYBOARD_KEY_HOME                 = 0x0D,  /**< home key            */
        KEYBOARD_KEY_END                  = 0x0E,  /**< end key             */
        KEYBOARD_KEY_PAGE_UP              = 0x0F,  /**< page up key         */
        KEYBOARD_KEY_PAGE_DOWN            = 0x10,  /**< page down key       */
        KEYBOARD_KEY_ARROW_LEFT           = 0x11,  /**< arrow left key      */
        KEYBOARD_KEY_ARROW_UP             = 0x12,  /**< arrow up key        */
        KEYBOARD_KEY_ARROW_RIGHT          = 0x13,  /**< arrow right key     */
        KEYBOARD_KEY_ARROW_DOWN           = 0x14,  /**< arrow down key      */
        KEYBOARD_KEY_SYS_RQ               = 0x15,  /**< SysRq key           */
        KEYBOARD_KEY_PRINT_SCREEN         = 0x16,  /**< Print Screen key    */
        KEYBOARD_KEY_BREAK                = 0x17,  /**< Break key           */
        KEYBOARD_KEY_ESCAPE               = 0x18,  /**< escape key          */
        KEYBOARD_KEY_USER_MOD_1           = 0x19,  /**< user key modifier 1 */
        KEYBOARD_KEY_USER_MOD_2           = 0x1A,  /**< user key modifier 2 */
        KEYBOARD_KEY_USER_MOD_3           = 0x1B,  /**< user key modifier 3 */
        KEYBOARD_KEY_USER_MOD_4           = 0x1C,  /**< user key modifier 4 */
        KEYBOARD_KEY_USER_MOD_5           = 0x1D,  /**< user key modifier 5 */
        KEYBOARD_KEY_USER_MOD_6           = 0x1E,  /**< user key modifier 6 */
        KEYBOARD_KEY_USER_MOD_7           = 0x1F,  /**< user key modifier 7 */
        KEYBOARD_KEY_SPACE                = 0x20,  /**< ASCII code for ' '  */
        KEYBOARD_KEY_EXCLAMATION_MARK     = 0x21,  /**< ASCII code for '!'  */
        KEYBOARD_KEY_QUOTATION_MARK       = 0x22,  /**< ASCII code for '"'  */
        KEYBOARD_KEY_NUMBER_SIGN          = 0x23,  /**< ASCII code for '#'  */
        KEYBOARD_KEY_DOLLAR_SIGN          = 0x24,  /**< ASCII code for '$'  */
        KEYBOARD_KEY_PERCENT_SIGN         = 0x25,  /**< ASCII code for '%'  */
        KEYBOARD_KEY_AMPERSAND            = 0x26,  /**< ASCII code for '&'  */
        KEYBOARD_KEY_APOSTROPHE           = 0x27,  /**< ASCII code for '\'' */
        KEYBOARD_KEY_LEFT_PARENTHESES     = 0x28,  /**< ASCII code for '('  */
        KEYBOARD_KEY_RIGHT_PARENTHESES    = 0x29,  /**< ASCII code for ')'  */
        KEYBOARD_KEY_ASTERISK             = 0x2A,  /**< ASCII code for '*'  */
        KEYBOARD_KEY_PLUS                 = 0x2B,  /**< ASCII code for '+'  */
        KEYBOARD_KEY_COMMA                = 0x2C,  /**< ASCII code for ','  */
        KEYBOARD_KEY_HYPHEN               = 0x2D,  /**< ASCII code for '-'  */
        KEYBOARD_KEY_PERIOD               = 0x2E,  /**< ASCII code for '.'  */
        KEYBOARD_KEY_FORWARD_SLASH        = 0x2F,  /**< ASCII code for '/'  */
        KEYBOARD_KEY_ZERO                 = 0x30,  /**< ASCII code for '0'  */
        KEYBOARD_KEY_ONE                  = 0x31,  /**< ASCII code for '1'  */
        KEYBOARD_KEY_TWO                  = 0x32,  /**< ASCII code for '2'  */
        KEYBOARD_KEY_THREE                = 0x33,  /**< ASCII code for '3'  */
        KEYBOARD_KEY_FOUR                 = 0x34,  /**< ASCII code for '4'  */
        KEYBOARD_KEY_FIVE                 = 0x35,  /**< ASCII code for '5'  */
        KEYBOARD_KEY_SIX                  = 0x36,  /**< ASCII code for '6'  */
        KEYBOARD_KEY_SEVEN                = 0x37,  /**< ASCII code for '7'  */
        KEYBOARD_KEY_EIGHT                = 0x38,  /**< ASCII code for '8'  */
        KEYBOARD_KEY_NINE                 = 0x39,  /**< ASCII code for '9'  */
        KEYBOARD_KEY_COLON                = 0x3A,  /**< ASCII code for ':'  */
        KEYBOARD_KEY_SEMICOLON            = 0x3B,  /**< ASCII code for ';'  */
        KEYBOARD_KEY_LESS_THAN_SIGN       = 0x3C,  /**< ASCII code for '<'  */
        KEYBOARD_KEY_EQUALS_SIGN          = 0x3D,  /**< ASCII code for '='  */
        KEYBOARD_KEY_GREATER_THAN_SIGN    = 0x3E,  /**< ASCII code for '>'  */
        KEYBOARD_KEY_QUESTION_MARK        = 0x3F,  /**< ASCII code for '?'  */
        KEYBOARD_KEY_AT_SIGN              = 0x40,  /**< ASCII code for '@'  */
        KEYBOARD_KEY_UPPERCASE_A          = 0x41,  /**< ASCII code for 'A'  */
        KEYBOARD_KEY_UPPERCASE_B          = 0x42,  /**< ASCII code for 'B'  */
        KEYBOARD_KEY_UPPERCASE_C          = 0x43,  /**< ASCII code for 'C'  */
        KEYBOARD_KEY_UPPERCASE_D          = 0x44,  /**< ASCII code for 'D'  */
        KEYBOARD_KEY_UPPERCASE_E          = 0x45,  /**< ASCII code for 'E'  */
        KEYBOARD_KEY_UPPERCASE_F          = 0x46,  /**< ASCII code for 'F'  */
        KEYBOARD_KEY_UPPERCASE_G          = 0x47,  /**< ASCII code for 'G'  */
        KEYBOARD_KEY_UPPERCASE_H          = 0x48,  /**< ASCII code for 'H'  */
        KEYBOARD_KEY_UPPERCASE_I          = 0x49,  /**< ASCII code for 'I'  */
        KEYBOARD_KEY_UPPERCASE_J          = 0x4A,  /**< ASCII code for 'J'  */
        KEYBOARD_KEY_UPPERCASE_K          = 0x4B,  /**< ASCII code for 'K'  */
        KEYBOARD_KEY_UPPERCASE_L          = 0x4C,  /**< ASCII code for 'L'  */
        KEYBOARD_KEY_UPPERCASE_M          = 0x4D,  /**< ASCII code for 'M'  */
        KEYBOARD_KEY_UPPERCASE_N          = 0x4E,  /**< ASCII code for 'N'  */
        KEYBOARD_KEY_UPPERCASE_O          = 0x4F,  /**< ASCII code for 'O'  */
        KEYBOARD_KEY_UPPERCASE_P          = 0x50,  /**< ASCII code for 'P'  */
        KEYBOARD_KEY_UPPERCASE_Q          = 0x51,  /**< ASCII code for 'Q'  */
        KEYBOARD_KEY_UPPERCASE_R          = 0x52,  /**< ASCII code for 'R'  */
        KEYBOARD_KEY_UPPERCASE_S          = 0x53,  /**< ASCII code for 'S'  */
        KEYBOARD_KEY_UPPERCASE_T          = 0x54,  /**< ASCII code for 'T'  */
        KEYBOARD_KEY_UPPERCASE_U          = 0x55,  /**< ASCII code for 'U'  */
        KEYBOARD_KEY_UPPERCASE_V          = 0x56,  /**< ASCII code for 'V'  */
        KEYBOARD_KEY_UPPERCASE_W          = 0x57,  /**< ASCII code for 'W'  */
        KEYBOARD_KEY_UPPERCASE_X          = 0x58,  /**< ASCII code for 'X'  */
        KEYBOARD_KEY_UPPERCASE_Y          = 0x59,  /**< ASCII code for 'Y'  */
        KEYBOARD_KEY_UPPERCASE_Z          = 0x5A,  /**< ASCII code for 'Z'  */
        KEYBOARD_KEY_LEFT_SQUARE_BRACKET  = 0x5B,  /**< ASCII code for '['  */
        KEYBOARD_KEY_BACKSLASH            = 0x5C,  /**< ASCII code for '\'  */
        KEYBOARD_KEY_RIGHT_SQUARE_BRACKET = 0x5D,  /**< ASCII code for ']'  */
        KEYBOARD_KEY_CARET                = 0x5E,  /**< ASCII code for '^'  */
        KEYBOARD_KEY_UNDERSCORE           = 0x5F,  /**< ASCII code for '_'  */
        KEYBOARD_KEY_OPENING_SINGLE_QUOTE = 0x60,  /**< ASCII code for '`'  */
        KEYBOARD_KEY_LOWERCASE_A          = 0x61,  /**< ASCII code for 'a'  */
        KEYBOARD_KEY_LOWERCASE_B          = 0x62,  /**< ASCII code for 'b'  */
        KEYBOARD_KEY_LOWERCASE_C          = 0x63,  /**< ASCII code for 'c'  */
        KEYBOARD_KEY_LOWERCASE_D          = 0x64,  /**< ASCII code for 'd'  */
        KEYBOARD_KEY_LOWERCASE_E          = 0x65,  /**< ASCII code for 'e'  */
        KEYBOARD_KEY_LOWERCASE_F          = 0x66,  /**< ASCII code for 'f'  */
        KEYBOARD_KEY_LOWERCASE_G          = 0x67,  /**< ASCII code for 'g'  */
        KEYBOARD_KEY_LOWERCASE_H          = 0x68,  /**< ASCII code for 'h'  */
        KEYBOARD_KEY_LOWERCASE_I          = 0x69,  /**< ASCII code for 'i'  */
        KEYBOARD_KEY_LOWERCASE_J          = 0x6A,  /**< ASCII code for 'j'  */
        KEYBOARD_KEY_LOWERCASE_K          = 0x6B,  /**< ASCII code for 'k'  */
        KEYBOARD_KEY_LOWERCASE_L          = 0x6C,  /**< ASCII code for 'l'  */
        KEYBOARD_KEY_LOWERCASE_M          = 0x6D,  /**< ASCII code for 'm'  */
        KEYBOARD_KEY_LOWERCASE_N          = 0x6E,  /**< ASCII code for 'n'  */
        KEYBOARD_KEY_LOWERCASE_O          = 0x6F,  /**< ASCII code for 'o'  */
        KEYBOARD_KEY_LOWERCASE_P          = 0x70,  /**< ASCII code for 'p'  */
        KEYBOARD_KEY_LOWERCASE_Q          = 0x71,  /**< ASCII code for 'q'  */
        KEYBOARD_KEY_LOWERCASE_R          = 0x72,  /**< ASCII code for 'r'  */
        KEYBOARD_KEY_LOWERCASE_S          = 0x73,  /**< ASCII code for 's'  */
        KEYBOARD_KEY_LOWERCASE_T          = 0x74,  /**< ASCII code for 't'  */
        KEYBOARD_KEY_LOWERCASE_U          = 0x75,  /**< ASCII code for 'u'  */
        KEYBOARD_KEY_LOWERCASE_V          = 0x76,  /**< ASCII code for 'v'  */
        KEYBOARD_KEY_LOWERCASE_W          = 0x77,  /**< ASCII code for 'w'  */
        KEYBOARD_KEY_LOWERCASE_X          = 0x78,  /**< ASCII code for 'x'  */
        KEYBOARD_KEY_LOWERCASE_Y          = 0x79,  /**< ASCII code for 'y'  */
        KEYBOARD_KEY_LOWERCASE_Z          = 0x7A,  /**< ASCII code for 'z'  */
        KEYBOARD_KEY_LEFT_CURLY_BRACE     = 0x7B,  /**< ASCII code for '{'  */
        KEYBOARD_KEY_VERTICAL_LINE        = 0x7C,  /**< ASCII code for '|'  */
        KEYBOARD_KEY_RIGHT_CURLY_BRACE    = 0x7D,  /**< ASCII code for '}'  */
        KEYBOARD_KEY_TILDE                = 0x7E,  /**< ASCII code for '~'  */
        KEYBOARD_KEY_DELETE               = 0x7F,  /**< ASCII code for DEL  */
        KEYBOARD_KEY_F1                   = 0x80,  /**< Function Key 1      */
        KEYBOARD_KEY_F2                   = 0x81,  /**< Function Key 2      */
        KEYBOARD_KEY_F3                   = 0x82,  /**< Function Key 3      */
        KEYBOARD_KEY_F4                   = 0x83,  /**< Function Key 4      */
        KEYBOARD_KEY_F5                   = 0x84,  /**< Function Key 5      */
        KEYBOARD_KEY_F6                   = 0x85,  /**< Function Key 6      */
        KEYBOARD_KEY_F7                   = 0x86,  /**< Function Key 7      */
        KEYBOARD_KEY_F8                   = 0x87,  /**< Function Key 8      */
        KEYBOARD_KEY_F9                   = 0x88,  /**< Function Key 9      */
        KEYBOARD_KEY_F10                  = 0x89,  /**< Function Key 10     */
        KEYBOARD_KEY_F11                  = 0x8A,  /**< Function Key 11     */
        KEYBOARD_KEY_F12                  = 0x8B,  /**< Function Key 12     */
        KEYBOARD_KEY_USER_DEFINED_1       = 0x8C,  /**< User Defined Key 1  */
        KEYBOARD_KEY_USER_DEFINED_2       = 0x8D,  /**< User Defined Key 2  */
        KEYBOARD_KEY_USER_DEFINED_3       = 0x8E,  /**< User Defined Key 3  */
        KEYBOARD_KEY_USER_DEFINED_4       = 0x8F,  /**< User Defined Key 4  */
        KEYBOARD_KEY_USER_DEFINED_5       = 0x90,  /**< User Defined Key 5  */
        KEYBOARD_KEY_USER_DEFINED_6       = 0x91,  /**< User Defined Key 6  */
        KEYBOARD_KEY_USER_DEFINED_7       = 0x92,  /**< User Defined Key 7  */
        KEYBOARD_KEY_USER_DEFINED_8       = 0x93,  /**< User Defined Key 8  */
        KEYBOARD_KEY_USER_DEFINED_9       = 0x94,  /**< User Defined Key 9  */
        KEYBOARD_KEY_USER_DEFINED_10      = 0x95,  /**< User Defined Key 10 */
        KEYBOARD_KEY_USER_DEFINED_11      = 0x96,  /**< User Defined Key 11 */
        KEYBOARD_KEY_USER_DEFINED_12      = 0x97,  /**< User Defined Key 12 */
        KEYBOARD_KEY_USER_DEFINED_13      = 0x98,  /**< User Defined Key 13 */
        KEYBOARD_KEY_USER_DEFINED_14      = 0x99,  /**< User Defined Key 14 */
        KEYBOARD_KEY_USER_DEFINED_15      = 0x9A,  /**< User Defined Key 15 */
        KEYBOARD_KEY_USER_DEFINED_16      = 0x9B,  /**< User Defined Key 16 */
        KEYBOARD_KEY_USER_DEFINED_17      = 0x9C,  /**< User Defined Key 17 */
        KEYBOARD_KEY_USER_DEFINED_18      = 0x9D,  /**< User Defined Key 18 */
        KEYBOARD_KEY_USER_DEFINED_19      = 0x9E,  /**< User Defined Key 19 */
        KEYBOARD_KEY_USER_DEFINED_20      = 0x9F,  /**< User Defined Key 20 */
        KEYBOARD_KEY_USER_DEFINED_21      = 0xA0,  /**< User Defined Key 21 */
        KEYBOARD_KEY_USER_DEFINED_22      = 0xA1,  /**< User Defined Key 22 */
        KEYBOARD_KEY_USER_DEFINED_23      = 0xA2,  /**< User Defined Key 23 */
        KEYBOARD_KEY_USER_DEFINED_24      = 0xA3,  /**< User Defined Key 24 */
        KEYBOARD_KEY_USER_DEFINED_25      = 0xA4,  /**< User Defined Key 25 */
        KEYBOARD_KEY_USER_DEFINED_26      = 0xA5,  /**< User Defined Key 26 */
        KEYBOARD_KEY_USER_DEFINED_27      = 0xA6,  /**< User Defined Key 27 */
        KEYBOARD_KEY_USER_DEFINED_28      = 0xA7,  /**< User Defined Key 28 */
        KEYBOARD_KEY_USER_DEFINED_29      = 0xA8,  /**< User Defined Key 29 */
        KEYBOARD_KEY_USER_DEFINED_30      = 0xA9,  /**< User Defined Key 30 */
        KEYBOARD_KEY_USER_DEFINED_31      = 0xAA,  /**< User Defined Key 31 */
        KEYBOARD_KEY_USER_DEFINED_32      = 0xAB,  /**< User Defined Key 32 */
    };

    EventType         eventType;        /**< type of event */
    GlsVector2D       windowCoord;      /**< window coordinate associated with event */
    GlsUInt32         mouseButton;      /**< mouse button state ( MouseButton bit flags ) */
    GlsUInt32         keyboardModifier; /**< keyboard modifier  ( KeyboardModifier bit flags ) */
    KeyboardKey       keyboardKey;      /**< keyboard key */
    GlsUInt32         userData;         /**< user defined data */
    GlsDisplayObject *initiator;        /**< object that emitted the event else GLS_NULL */

    #if defined( GLS_DEBUG )
        /** Determine if this event is valid ( GLS_DEBUG only )
          * \return GLS_TRUE if valid else GLS_FALSE
          * \pre none
          * \post none
          */
        GlsBool IsValid( void ) const;
    #endif // GLS_DEBUG
};

/** abstract base class for dispatching events
  * \invariant none
  */
class GlsEventDispatcher
{
public:
    /** Constructor - construct an instance
      * \pre none
      * \post instance created
      */
    GlsEventDispatcher( void );

    /** Dispatch the given event (pure virtual)
      * \param event event in question
      * \return GLS_TRUE if event was handled during dispatch else GLS_FALSE
      * \pre event.IsValid()
      * \post event is dispatched and handled if return value is GLS_TRUE
      */
    virtual GlsBool DispatchEvent( GlsEvent &event ) = 0;

protected:
    /** Destructor - shall never be called
      * \pre none
      * \post none
      */
    virtual ~GlsEventDispatcher();

private:
    // Disable implicit generated Members
    GlsEventDispatcher& operator=( const GlsEventDispatcher &rhs );
    GlsEventDispatcher( const GlsEventDispatcher &src );
};

#if defined( GLS_DEBUG )
#pragma BullseyeCoverage save off
/** Determine if the given event type is valid ( GLS_DEBUG only )
  * \param eventType event type in question
  * \return GLS_TRUE if valid else GLS_FALSE
  * \pre none
  * \post none
  */
inline GlsBool GlsEventTypeIsValid( const GlsEvent::EventType eventType )
{
    return( ( GlsEvent::EVENT_TYPE_MOUSE_BUTTON_DOWN == eventType ) ||
            ( GlsEvent::EVENT_TYPE_MOUSE_BUTTON_UP   == eventType ) ||
            ( GlsEvent::EVENT_TYPE_MOUSE_MOVE        == eventType ) ||
            ( GlsEvent::EVENT_TYPE_MOUSE_DRAG        == eventType ) ||
            ( GlsEvent::EVENT_TYPE_MOUSE_ENTER       == eventType ) ||
            ( GlsEvent::EVENT_TYPE_MOUSE_LEAVE       == eventType ) ||
            ( GlsEvent::EVENT_TYPE_KEYBOARD_DOWN     == eventType ) ||
            ( GlsEvent::EVENT_TYPE_KEYBOARD_UP       == eventType ) ||
            ( GlsEvent::EVENT_TYPE_USER              == eventType ) );
}
#pragma BullseyeCoverage restore
#endif // GLS_DEBUG

#endif // _GLS_EVENT_H