UI_EventType.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UI_EventType.h
 *
 * COMMENTS:
 *      
 *  The various event types generated by objects and event generators.
 *
 */
#ifndef __UI_EventType__
#define __UI_EventType__

#define UI_REDRAW_FENCE_EVENT 0

// All events, except specifically noted, have keyboard modifier and cursor 
// position -- relative to window -- in altFlags, and values[X/Y]. 
enum UI_EventType
{
    UI_EVENT_NO_EVENT       = 0,
    
    // data = New window, context = old window 
    UI_EVENT_FOCUS_OFF      = 1,
    
    // data = Old window, context = New window
    UI_EVENT_FOCUS_ON       = 2,
    
    //  values[W] = buttons, values[TUVZ] = tablet data 
    UI_EVENT_BUTTON         = 3,
    
    // The event generator queues UI_EVENT_KEY_PRESS and UI_EVENT_KEY_RELEASE
    // events.
    //
    // The legacy UI_EVENT_KEYBOARD, UI_EVENT_KEYUPDOWN, UI_EVENT_FUNCTION_KEY,
    // UI_EVENT_ARROW_KEY, UI_EVENT_KEYOTHER events are synthesized from these
    // for feel handlers and are generally not queued.
    //
    // The legacy hit events are determined by id, and how to interpret data
    // depends on the hit event type.
    UI_EVENT_KEY_PRESS      = 4,
    UI_EVENT_KEY_RELEASE    = 5,

    // data = UI_Keyboard key  
    UI_EVENT_KEYBOARD       = 6,
    UI_EVENT_KEYUPDOWN      = 7,
    UI_EVENT_FUNCTION_KEY   = 8,
    UI_EVENT_ARROW_KEY      = 9,
    UI_EVENT_MOTION         = 10,
    UI_EVENT_REDRAW         = 11,
    UI_EVENT_MINIMIZE_RESTORE = 12,
    UI_EVENT_OPEN           = 13,
    UI_EVENT_CLOSE          = 14,
    UI_EVENT_DELETE         = 15,
    UI_EVENT_QUIT           = 16,
    UI_EVENT_VALUE_CHANGE   = 17,
    UI_EVENT_TIMER          = 18,
    UI_EVENT_PAUSE          = 19,
    UI_EVENT_ENABLE         = 20,
    UI_EVENT_APP_SPECIFIC   = 21,
    UI_EVENT_RESIZE         = 22,
    UI_EVENT_KEYOTHER       = 23,
    UI_EVENT_OVERRIDE       = 24,
    UI_EVENT_MOUSEWHEEL     = 25,
    UI_EVENT_DBLCLK         = 26,
    UI_EVENT_REFRESH        = 27,
    UI_EVENT_MENU           = 28,
    UI_EVENT_OVERLAY_REDRAW = 29,
    UI_EVENT_OVERLAY_CLEAR  = 30,
    UI_EVENT_VISIBLE        = 31,

    UI_EVENT_GESTURE        = 32
};


static inline bool
UIisExclusiveEvent(UI_EventType e)
{
    switch(e)
    {
    case UI_EVENT_BUTTON:
    case UI_EVENT_KEY_PRESS:
    case UI_EVENT_KEY_RELEASE:
    case UI_EVENT_KEYBOARD:
    case UI_EVENT_KEYUPDOWN:
    case UI_EVENT_FUNCTION_KEY:
    case UI_EVENT_ARROW_KEY:
    case UI_EVENT_MOTION:
    case UI_EVENT_QUIT:
    case UI_EVENT_KEYOTHER:
    case UI_EVENT_MOUSEWHEEL:
    case UI_EVENT_DBLCLK:
    case UI_EVENT_MENU:
        return true;
    default:
        return false;
    }
}

static inline bool
UIisRedrawFenceEvent(UI_EventType e)
{
    switch(e)
    {
    case UI_EVENT_BUTTON:
    case UI_EVENT_KEY_PRESS:
    case UI_EVENT_KEY_RELEASE:
    case UI_EVENT_KEYBOARD:
    case UI_EVENT_KEYUPDOWN:
    case UI_EVENT_FUNCTION_KEY:
    case UI_EVENT_ARROW_KEY:
    case UI_EVENT_MOTION:
    case UI_EVENT_RESIZE:
    case UI_EVENT_KEYOTHER:
    case UI_EVENT_MOUSEWHEEL:
    case UI_EVENT_DBLCLK:
    case UI_EVENT_REFRESH:
    case UI_EVENT_MENU:
    case UI_EVENT_OVERLAY_REDRAW:
    case UI_EVENT_OVERLAY_CLEAR:
        return true;
    default:
        return false;
    }
}

#endif