YiEvent.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_EVENT_H_
#define _YI_EVENT_H_

#include "binding/YiScriptableObject.h"
#include "framework/YiPredef.h"
#include "utility/YiString.h"

class CYIEventTarget;
class CYIKeyEvent;
class CYITrackpadEvent;
class CYIFocusEvent;
class CYIActionEvent;


typedef enum
{
    YI_ACTION_NONE = 0,
    YI_ACTION_MOVE,
    YI_ACTION_DOWN,
    YI_ACTION_DELAYED_DOWN,
    YI_ACTION_UP,
    YI_ACTION_WHEEL,
    YI_ACTION_CLICK,
    YI_ACTION_OUT,
    YI_ACTION_IN,
    YI_ACTION_ENTER,
    YI_ACTION_LEAVE,
    YI_ACTION_PICK,
    YI_ACTION_LONG_PRESS,
    YI_ACTION_SUPPRESSED_MOVE,
    YI_KEY_DOWN,
    YI_KEY_UP,
    YI_KEY_INPUT,
    YI_SIGNAL_EMIT,
    YI_STATEMACHINE_WRAPPED,
    YI_STATEMACHINE_SIGNAL,
    YI_EVENT_NONE,
    YI_GPU_GENERATE_HANDLE,
    YI_GPU_LOAD_BUFFER,
    YI_GPU_UNLOAD_BUFFER,
    YI_GPU_FREE_HANDLE,
    YI_GPU_INVALIDATE_HANDLE,
    YI_FOCUS_IN,
    YI_FOCUS_OUT,
    YI_TRACKPAD_DOWN,
    YI_TRACKPAD_MOVE,
    YI_TRACKPAD_UP,
    YI_DEFERRED_DELETION,
    YI_TASK,

    // Leave this marker as last event.

    YI_EVENT_MAX

} YI_EVENT_TYPE;

typedef enum
{
    YI_EVENT_PHASE_NONE = 0,    
    YI_EVENT_PHASE_CAPTURE,     
    YI_EVENT_PHASE_AT_TARGET,   
    YI_EVENT_PHASE_BUBBLE,      
    YI_EVENT_PHASE_BROADCAST    
} YI_EVENT_PHASE;

typedef enum
{
    YI_KEY_UNIDENTIFIED = 0, 
    YI_KEY_ATTN, 
    YI_KEY_APPS, 
    YI_KEY_CRSEL, 
    YI_KEY_EXSEL, 
    YI_KEY_F1, 
    YI_KEY_F2, 
    YI_KEY_F3, 
    YI_KEY_F4, 
    YI_KEY_F5, 
    YI_KEY_F6, 
    YI_KEY_F7, 
    YI_KEY_F8, 
    YI_KEY_F9, 
    YI_KEY_F10, 
    YI_KEY_F11, 
    YI_KEY_F12, 
    YI_KEY_F13, 
    YI_KEY_F14, 
    YI_KEY_F15, 
    YI_KEY_F16, 
    YI_KEY_F17, 
    YI_KEY_F18, 
    YI_KEY_F19, 
    YI_KEY_F20, 
    YI_KEY_F21, 
    YI_KEY_F22, 
    YI_KEY_F23, 
    YI_KEY_F24, 
    YI_KEY_LAUNCH_APP1, 
    YI_KEY_LAUNCH_APP2, 
    YI_KEY_LAUNCH_MAIL, 
    YI_KEY_LIST, 
    YI_KEY_PROPS, 
    YI_KEY_SOFT1, 
    YI_KEY_SOFT2, 
    YI_KEY_SOFT3, 
    YI_KEY_SOFT4, 
    YI_KEY_ACCEPT, 
    YI_KEY_AGAIN, 
    YI_KEY_ENTER, 
    YI_KEY_FIND, 
    YI_KEY_HELP, 
    YI_KEY_INFO, 
    YI_KEY_MENU, 
    YI_KEY_PAUSE, 
    YI_KEY_PLAY, 
    YI_KEY_SCROLL_LOCK, 
    YI_KEY_EXECUTE, 
    YI_KEY_CANCEL, 
    YI_KEY_ESC, 
    YI_KEY_ZOOM, 
    YI_KEY_SEPARATOR, 
    YI_KEY_SPACE, 
    YI_KEY_ADD, 
    YI_KEY_SUBTRACT, 
    YI_KEY_MULTIPLY, 
    YI_KEY_DIVIDE, 
    YI_KEY_EQUAL, 
    YI_KEY_DECIMAL, 
    YI_KEY_BRIGHTNESS_DOWN, 
    YI_KEY_BRIGHTNESS_UP, 
    YI_KEY_CAMERA, 
    YI_KEY_EJECT, 
    YI_KEY_POWER, 
    YI_KEY_PRINT_SCREEN, 
    YI_KEY_BROWSER_FAVORITES, 
    YI_KEY_BROWSER_HOME, 
    YI_KEY_BROWSER_REFRESH, 
    YI_KEY_BROWSER_SEARCH, 
    YI_KEY_BROWSER_STOP, 
    YI_KEY_BROWSER_BACK, 
    YI_KEY_BROWSER_FORWARD, 
    YI_KEY_PAGEUP, 
    YI_KEY_PAGEDOWN, 
    YI_KEY_ARROW_LEFT, 
    YI_KEY_ARROW_RIGHT, 
    YI_KEY_ARROW_UP, 
    YI_KEY_ARROW_UP_LEFT, 
    YI_KEY_ARROW_UP_RIGHT, 
    YI_KEY_ARROW_DOWN, 
    YI_KEY_ARROW_DOWN_LEFT, 
    YI_KEY_ARROW_DOWN_RIGHT, 
    YI_KEY_HOME, 
    YI_KEY_END, 
    YI_KEY_SELECT, 
    YI_KEY_TAB, 
    YI_KEY_BACKSPACE, 
    YI_KEY_CLEAR, 
    YI_KEY_COPY, 
    YI_KEY_CUT, 
    YI_KEY_DEL, 
    YI_KEY_ERASE_EOF, 
    YI_KEY_INSERT, 
    YI_KEY_PASTE, 
    YI_KEY_UNDO, 
    YI_KEY_DEAD_GRAVE, 
    YI_KEY_DEAD_ACUTE, 
    YI_KEY_DEAD_CIRCUMFLEX, 
    YI_KEY_DEAD_TILDE, 
    YI_KEY_DEAD_MACRON, 
    YI_KEY_DEAD_BREVE, 
    YI_KEY_DEAD_ABOVE_DOT, 
    YI_KEY_DEAD_UMLAUT, 
    YI_KEY_DEAD_ABOVE_RING, 
    YI_KEY_DEAD_DOUBLE_ACUTE, 
    YI_KEY_DEAD_CARON, 
    YI_KEY_DEAD_CEDILLA, 
    YI_KEY_DEAD_OGONEK, 
    YI_KEY_DEAD_IOTA, 
    YI_KEY_DEAD_VOICED_SOUND, 
    YI_KEY_DEAD_SEMIVOICED_SOUND, 
    YI_KEY_ALPHANUMERIC, 
    YI_KEY_ALT, 
    YI_KEY_ALT_GRAPH, 
    YI_KEY_CAPS_LOCK, 
    YI_KEY_CONTROL, 
    YI_KEY_FN, 
    YI_KEY_META, 
    YI_KEY_PROCESS, 
    YI_KEY_NUM_LOCK, 
    YI_KEY_SHIFT, 
    YI_KEY_SYMBOL_LOCK, 
    YI_KEY_OS, 
    YI_KEY_COMPOSE, 
    YI_KEY_ALL_CANDIDATES, 
    YI_KEY_NEXT_CANDIDATE, 
    YI_KEY_PREVIOUS_CANDIDATE, 
    YI_KEY_CODE_INPUT, 
    YI_KEY_CONVERT, 
    YI_KEY_NONCONVERT, 
    YI_KEY_FINAL_MODE, 
    YI_KEY_FULL_WIDTH, 
    YI_KEY_HALF_WIDTH, 
    YI_KEY_MODE_CHANGE, 
    YI_KEY_ROMAN_CHARACTERS, 
    YI_KEY_HANGUL_MODE, 
    YI_KEY_HANJA_MODE, 
    YI_KEY_JUNJA_MODE, 
    YI_KEY_HIRAGANA, 
    YI_KEY_KANA_MODE, 
    YI_KEY_KANJI_MODE, 
    YI_KEY_KATAKANA, 
    YI_KEY_AUDIO_FADER_FRONT, 
    YI_KEY_AUDIO_FADER_REAR, 
    YI_KEY_AUDIO_BALANCE_LEFT, 
    YI_KEY_AUDIO_BALANCE_RIGHT, 
    YI_KEY_AUDIO_BASE_BOOST_DOWN, 
    YI_KEY_AUDIO_BASE_BOOST_UP, 
    YI_KEY_VOLUME_MUTE, 
    YI_KEY_VOLUME_DOWN, 
    YI_KEY_VOLUME_UP, 
    YI_KEY_MEDIA_PAUSE, 
    YI_KEY_MEDIA_PLAY, 
    YI_KEY_MEDIA_TRACK_END, 
    YI_KEY_MEDIA_NEXT_TRACK, 
    YI_KEY_MEDIA_FAST_FORWARD, 
    YI_KEY_MEDIA_REWIND, 
    YI_KEY_MEDIA_PLAY_PAUSE, 
    YI_KEY_MEDIA_PREVIOUS_TRACK, 
    YI_KEY_MEDIA_TRACK_SKIP, 
    YI_KEY_MEDIA_TRACK_START, 
    YI_KEY_MEDIA_STEP_FORWARD, 
    YI_KEY_MEDIA_STEP_BACKWARD, 
    YI_KEY_MEDIA_STOP, 
    YI_KEY_MEDIA_INSTANT_REPLAY, 
    YI_KEY_SELECT_MEDIA, 
    YI_KEY_BLUE, 
    YI_KEY_BROWN, 
    YI_KEY_CHANNEL_DOWN, 
    YI_KEY_CHANNEL_UP, 
    YI_KEY_CLEAR_FAVORITE0, 
    YI_KEY_CLEAR_FAVORITE1, 
    YI_KEY_CLEAR_FAVORITE2, 
    YI_KEY_CLEAR_FAVORITE3, 
    YI_KEY_DIMMER, 
    YI_KEY_DISPLAY_SWAP, 
    YI_KEY_GREEN, 
    YI_KEY_GREY, 
    YI_KEY_GUIDE, 
    YI_KEY_MEDIA_LIST, 
    YI_KEY_LINK, 
    YI_KEY_LIVE, 
    YI_KEY_LOCK, 
    YI_KEY_NEXT_DAY, 
    YI_KEY_NEXT_FAVORITE_CHANNEL, 
    YI_KEY_ON_DEMAND, 
    YI_KEY_PINP_DOWN, 
    YI_KEY_PINP_MOVE, 
    YI_KEY_PINP_TOGGLE, 
    YI_KEY_PINP_UP, 
    YI_KEY_PLAY_SPEED_DOWN, 
    YI_KEY_PLAY_SPEED_RESET, 
    YI_KEY_PREV_DAY, 
    YI_KEY_RANDOM_TOGGLE, 
    YI_KEY_RECALL_FAVORITE0, 
    YI_KEY_RECALL_FAVORITE1, 
    YI_KEY_RECALL_FAVORITE2, 
    YI_KEY_RECALL_FAVORITE3, 
    YI_KEY_MEDIA_RECORD, 
    YI_KEY_RECORD_SPEED_NEXT, 
    YI_KEY_RED, 
    YI_KEY_RF_BYPASS, 
    YI_KEY_SCAN_CHANNELS_TOGGLE, 
    YI_KEY_SCREEN_MODE_NEXT, 
    YI_KEY_SETTINGS, 
    YI_KEY_SPLIT_SCREEN_TOGGLE, 
    YI_KEY_STORE_FAVORITE0, 
    YI_KEY_STORE_FAVORITE1, 
    YI_KEY_STORE_FAVORITE2, 
    YI_KEY_STORE_FAVORITE3, 
    YI_KEY_SUBTITLE, 
    YI_KEY_AUDIO_SURROUND_MODE_NEXT, 
    YI_KEY_TELETEXT, 
    YI_KEY_VIDEO_MODE_NEXT, 
    YI_KEY_DISPLAY_WIDE, 
    YI_KEY_WINK, 
    YI_KEY_YELLOW, 
    YI_KEY_SYSTEM_HOME, 
    YI_KEY_SYSTEM_BACK, 
    YI_KEY_GAMEPAD0, 
    YI_KEY_GAMEPAD1, 
    YI_KEY_GAMEPAD2, 
    YI_KEY_GAMEPAD3, 
    YI_KEY_GAMEPAD_LEFT_BUMPER, 
    YI_KEY_GAMEPAD_RIGHT_BUMPER, 
    YI_KEY_GAMEPAD_LEFT_TRIGGER, 
    YI_KEY_GAMEPAD_RIGHT_TRIGGER, 
    YI_KEY_GAMEPAD_LEFT_STICK, 
    YI_KEY_GAMEPAD_RIGHT_STICK, 
    YI_KEY_GAMEPAD_SELECT, 
    YI_KEY_GAMEPAD_START, 
    YI_KEY_DVR, 
    YI_KEY_TV, 
    YI_KEY_CAPTIONS, 
    // New TV Remotes
    YI_KEY_SEARCH, 
    YI_KEY_VOICE_SEARCH, 
    
    // WebOS2 Magic Remote (and other magic remotes)
    YI_KEY_TV_3DMODE, 
    YI_KEY_MAGIC_INPUT, 
    
    // Leave this marker as last key code

    YI_KEY_MAX

} YI_KEY_CODE;

typedef enum
{
    YI_ASCII_NULL,
    YI_ASCII_SOH,
    YI_ASCII_STX,
    YI_ASCII_ETX,
    YI_ASCII_EOT,
    YI_ASCII_ENQ,
    YI_ASCII_ACK,
    YI_ASCII_BELL,
    YI_ASCII_BACKSPACE,
    YI_ASCII_TAB,
    YI_ASCII_LF, // 10
    YI_ASCII_VTAB,
    YI_ASCII_FF,
    YI_ASCII_CR,
    YI_ASCII_SO,
    YI_ASCII_SI,
    YI_ASCII_DLE,
    YI_ASCII_DC1,
    YI_ASCII_DC2,
    YI_ASCII_DC3,
    YI_ASCII_DC4, // 20
    YI_ASCII_NAK,
    YI_ASCII_SYN,
    YI_ASCII_ETB,
    YI_ASCII_CAN,
    YI_ASCII_EM,
    YI_ASCII_SUB,
    YI_ASCII_ESCAPE,
    YI_ASCII_FS,
    YI_ASCII_GS,
    YI_ASCII_RS, // 30
    YI_ASCII_US,
    YI_ASCII_SPACE,
    YI_ASCII_EXCLAMATION,
    YI_ASCII_QUOTATION_MARK,
    YI_ASCII_NUMBER_SIGN,
    YI_ASCII_DOLLAR_SIGN,
    YI_ASCII_PERCENT_SIGN,
    YI_ASCII_AMPERSAND,
    YI_ASCII_APOSTROPHE,
    YI_ASCII_LEFT_BRACKET,
    YI_ASCII_RIGHT_BRACKET,
    YI_ASCII_ASTERISK,
    YI_ASCII_ADD,
    YI_ASCII_COMMA,
    YI_ASCII_SUBTRACT,
    YI_ASCII_DOT,
    YI_ASCII_FORWARD_SLASH,
    YI_ASCII_ZERO,
    YI_ASCII_ONE,
    YI_ASCII_TWO,
    YI_ASCII_THREE,
    YI_ASCII_FOUR,
    YI_ASCII_FIVE,
    YI_ASCII_SIX,
    YI_ASCII_SEVEN,
    YI_ASCII_EIGHT,
    YI_ASCII_NINE,
    YI_ASCII_COLON,
    YI_ASCII_SEMI_COLON,
    YI_ASCII_LESS_THAN,
    YI_ASCII_EQUALS,
    YI_ASCII_GREATER_THAN,
    YI_ASCII_QUESTION_MARK,
    YI_ASCII_AT_SIGN,
    YI_ASCII_UPPER_CASE_A,
    YI_ASCII_UPPER_CASE_B,
    YI_ASCII_UPPER_CASE_C,
    YI_ASCII_UPPER_CASE_D,
    YI_ASCII_UPPER_CASE_E,
    YI_ASCII_UPPER_CASE_F,
    YI_ASCII_UPPER_CASE_G,
    YI_ASCII_UPPER_CASE_H,
    YI_ASCII_UPPER_CASE_I,
    YI_ASCII_UPPER_CASE_J,
    YI_ASCII_UPPER_CASE_K,
    YI_ASCII_UPPER_CASE_L,
    YI_ASCII_UPPER_CASE_M,
    YI_ASCII_UPPER_CASE_N,
    YI_ASCII_UPPER_CASE_O,
    YI_ASCII_UPPER_CASE_P,
    YI_ASCII_UPPER_CASE_Q,
    YI_ASCII_UPPER_CASE_R,
    YI_ASCII_UPPER_CASE_S,
    YI_ASCII_UPPER_CASE_T,
    YI_ASCII_UPPER_CASE_U,
    YI_ASCII_UPPER_CASE_V,
    YI_ASCII_UPPER_CASE_W,
    YI_ASCII_UPPER_CASE_X,
    YI_ASCII_UPPER_CASE_Y,
    YI_ASCII_UPPER_CASE_Z,
    YI_ASCII_LEFT_SQUARE_BRACKET,
    YI_ASCII_BACKSLASH,
    YI_ASCII_RIGHT_SQUARE_BRACKET,
    YI_ASCII_CIRCUMFLEX_ACCENT,
    YI_ASCII_UNDERSCORE,
    YI_ASCII_GRAVE_ACCENT,
    YI_ASCII_LOWER_CASE_A,
    YI_ASCII_LOWER_CASE_B,
    YI_ASCII_LOWER_CASE_C,
    YI_ASCII_LOWER_CASE_D,
    YI_ASCII_LOWER_CASE_E,
    YI_ASCII_LOWER_CASE_F,
    YI_ASCII_LOWER_CASE_G,
    YI_ASCII_LOWER_CASE_H,
    YI_ASCII_LOWER_CASE_I,
    YI_ASCII_LOWER_CASE_J,
    YI_ASCII_LOWER_CASE_K,
    YI_ASCII_LOWER_CASE_L,
    YI_ASCII_LOWER_CASE_M,
    YI_ASCII_LOWER_CASE_N,
    YI_ASCII_LOWER_CASE_O,
    YI_ASCII_LOWER_CASE_P,
    YI_ASCII_LOWER_CASE_Q,
    YI_ASCII_LOWER_CASE_R,
    YI_ASCII_LOWER_CASE_S,
    YI_ASCII_LOWER_CASE_T,
    YI_ASCII_LOWER_CASE_U,
    YI_ASCII_LOWER_CASE_V,
    YI_ASCII_LOWER_CASE_W,
    YI_ASCII_LOWER_CASE_X,
    YI_ASCII_LOWER_CASE_Y,
    YI_ASCII_LOWER_CASE_Z,
    YI_ASCII_LEFT_CURLY_BRACKET,
    YI_ASCII_VERTICAL_BAR,
    YI_ASCII_RIGHT_CURLY_BRACKET,
    YI_ASCII_TILDE,
    YI_ASCII_DELETE,
    YI_ASCII_MAX
    
} YI_ASCII_CODE;

typedef enum
{
    YI_EVENT_PRIORITY_HIGHEST = 2,
    YI_EVENT_PRIORITY_HIGH = 1,
    YI_EVENT_PRIORITY_NORMAL = 0,
    YI_EVENT_PRIORITY_LOW = -1,
    YI_EVENT_PRIORITY_LOWEST = -2,

    YI_EVENT_PRIORITY_DEFAULT = YI_EVENT_PRIORITY_NORMAL
} YI_EVENT_PRIORITY;

class CYIEvent: public CYIScriptableObject
{
public:

    CYIEvent(YI_EVENT_TYPE eventType);
    CYIEvent(const CYIEvent &rOther);
    virtual ~CYIEvent();
    virtual std::unique_ptr<CYIEvent> Clone() const;

    const CYIString &GetName() const;

    YI_EVENT_TYPE GetType() const;
    
    void SetType(YI_EVENT_TYPE eventType);

    bool IsActionEvent() const;
    
    std::unique_ptr<CYIActionEvent> CloneAsActionEvent() const;

    bool IsKeyEvent() const;
    
    std::unique_ptr<CYIKeyEvent> CloneAsKeyEvent() const;

    bool IsFocusEvent() const;

    std::unique_ptr<CYIFocusEvent> CloneAsFocusEvent() const;

    bool IsTrackpadEvent() const;

    std::unique_ptr<CYITrackpadEvent> CloneAsTrackpadEvent() const;

    CYIEventTarget *m_pTarget;                  
    CYIEventTarget *m_pCurrentTarget;           
    YI_EVENT_PHASE  m_ePhase;                   
    bool            m_bCanCancel;               
    bool            m_bCanBubble;               
    bool            m_bCanCapture;              
    bool            m_bStopPropagation;         
    bool            m_bHandled;                 
    uint64_t m_uEventTimeMs; 
private:

    YI_EVENT_TYPE   m_Type;                     
};
inline YI_EVENT_TYPE CYIEvent::GetType() const
{
    return m_Type;
}

inline bool CYIEvent::IsActionEvent() const
{
    return m_Type==YI_ACTION_PICK || m_Type==YI_ACTION_MOVE || m_Type==YI_ACTION_DOWN || m_Type==YI_ACTION_DELAYED_DOWN || m_Type==YI_ACTION_UP || m_Type==YI_ACTION_CLICK || m_Type==YI_ACTION_OUT || m_Type==YI_ACTION_IN || m_Type==YI_ACTION_WHEEL || m_Type==YI_ACTION_ENTER || m_Type==YI_ACTION_LEAVE || m_Type==YI_ACTION_LONG_PRESS || m_Type==YI_ACTION_SUPPRESSED_MOVE;
}

inline bool CYIEvent::IsKeyEvent() const
{
    return m_Type==YI_KEY_DOWN || m_Type==YI_KEY_UP || m_Type==YI_KEY_INPUT;
}

inline bool CYIEvent::IsFocusEvent() const
{
    return m_Type==YI_FOCUS_IN || m_Type==YI_FOCUS_OUT;
}

inline bool CYIEvent::IsTrackpadEvent() const
{
    return m_Type == YI_TRACKPAD_DOWN || m_Type == YI_TRACKPAD_MOVE || m_Type == YI_TRACKPAD_UP;
}

#endif // _YI_EVENT_H_