GUIScriptedInput.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef _GUISCRIPTEDINPUT_H_
#define _GUISCRIPTEDINPUT_H_
 
#include "eC_Types.h"
#include "GUIInputMedia.h"
#include "GUIEvent.h"
#include "GUIEventTypeResource.h"
#include "eC_TList_doubleLinked.h"
#include "eC_String.h"
#include "GUIPoint.h"
 
class CGUIEvent;
 
// @guiliani_doxygen toplevel_module Scripted Input
// @endguiliani_doxygen
class CGUIScriptedInput : public CGUIInputMedia
{
public:
    struct ScriptedInputEvent_t
    {
        EventType_t m_eEventType; 
        GUIKeyIdentifier_t m_eGUIKey; 
        eC_UInt m_uiKey; 
        eC_Int m_iMouseXPos; 
        eC_Int m_iMouseYPos; 
        eC_Bool m_bLeftButton; 
        eC_Bool m_bRightButton; 
        eC_UInt m_uiTime; 
        eC_Bool m_bMouseEvent; 
        eC_Bool m_bImmediateEvent; 
        eC_Value m_vDistance; 
        eC_UInt m_uiModifiers; 
    };
 
public:
    static void CreateInstance(const eC_UInt uiStartDelay = 5000);
 
    static void DeleteInstance();
 
    virtual void PollEvent();
 
    virtual void StopIdle()
    {
        CGUIInputMedia::StopIdle();
 
        if (ms_pkConnectedInputMedia)
            ms_pkConnectedInputMedia->StopIdle();
    }
 
    static eC_Bool SimulateLeftButtonClick(CGUIObject* pkObject);
 
    static eC_Bool SimulateKeyPress(const GUIKeyIdentifier_t &eKeyIdentifier);
 
    static void AddMouseEvent(
        const EventType_t eEventType,
        const eC_Int iMouseXPos,
        const eC_Int iMouseYPos,
        const eC_UInt uiTime = 0,
        const eC_Bool bImmediate = false);
 
    static void AddMouseMovement(
        const eC_Int iMouseStartXPos,
        const eC_Int iMouseStartYPos,
        const eC_Int iMouseEndXPos,
        const eC_Int iMouseEndYPos,
        const eC_UInt uiDuration,
        const eC_Bool bDrag,
        const eC_UInt uiTime = 0,
        const eC_Bool bImmediate = false);
 
    static void AddMouseWheel(
        const eC_Int& iMouseXPos,
        const eC_Int& iMouseYPos,
        const eC_Value& vDistance,
        const eC_UInt& uiModifiers,
        const eC_UInt& uiTime = 0,
        const eC_Bool& bImmediate = false);
 
    static void AddKeyboardEvent(
        const EventType_t& eEventType,
        const eC_UInt& uiKey,
        const GUIKeyIdentifier_t& eGUIKey,
        const eC_UInt& uiTime = 0,
        const eC_Bool& bImmediate = false);
 
    static void AddGestureEvent(
        const eC_Int& iMouseXPos,
        const eC_Int& iMouseYPos,
        const eC_Value& vSpan,
        const eC_UInt& uiTime = 0,
        const eC_Bool& bImmediate = false);
 
    static void EnableVirtualMouseCursor(const eC_Bool bShowMouseCursor);
 
    static void EnableStressTest(const eC_Bool bStressTestActive);
 
    static void EnableRunOnceMode(const eC_Bool bRunOnceMode);
 
    static void ClearEventQueue();
 
#ifdef GUILIANI_STREAM_GUI
    static void ReadFromFile(const eC_String &kPath);
#endif //#ifdef GUILIANI_STREAM_GUI
 
    static eC_Bool IsEventQueueEmpty()
    {
        return ms_kEventsList.IsEmpty();
    }
 
protected:
    CGUIScriptedInput(const eC_UInt uiStartTime);
    ~CGUIScriptedInput();
 
    CGUIEvent* CreateRandomEvent();
 
private:
    static void AddMouseEventToQueue(
        const EventType_t& eEventType,
        const eC_Int& iMouseXPos,
        const eC_Int& iMouseYPos,
        const eC_Bool& bLeftButton,
        const eC_Bool& bRightButton,
        const eC_UInt& uiTime = 0,
        const eC_Bool& bImmediate = false);
 
    CGUIScriptedInput(const CGUIScriptedInput& kSource);
 
    CGUIScriptedInput& operator=(const CGUIScriptedInput& kSource);
 
private:
    eC_UInt m_uiTimeToNextEvent;
 
    eC_UInt m_uiTimeAtLastEvent;
 
    static eC_TListDoubleLinked<ScriptedInputEvent_t> ms_kEventsList;
 
    static eC_TListDoubleLinked<ScriptedInputEvent_t>::SafeIterator ms_kEventsListIter;
 
    static eC_Bool ms_bStressTestActive;
 
    static eC_Bool ms_bRunOnceActive;
 
    static CGUIInputMedia* ms_pkConnectedInputMedia;
 
    static CGUIObject* ms_pMouseCursor;
    CGUIPoint m_kPosition;
    CGUIPoint m_kDirection;
    eC_Bool m_bButtonPressed;
};
#endif