GUIEventHandler.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 GUIEVENTHANDLER__H_
#define GUIEVENTHANDLER__H_
 
#include "eC_TList_doubleLinked.h"
#include "eC_Types.h"
#include "eC_Math.h"
 
#include "GUIObjectHandleResource.h"
#include "GUIComponentManager.h"
#include "GUIRect.h"
 
#define GETEVENTHDL CGUIComponentManager::GetInstance().GetEventHandler()
 
const eC_UInt cuiDefaultLongClickTime = 1000;
const eC_UInt cuiDefaultDoubleClickTime = 300;
 
class CGUIObject;
class CGUIEvent;
class CGUIMouseEvent;
class CGUICompositeObject;
 
 
class CGUIEventHandler
{
    friend class CGUIObject; 
    friend class CGUI; 
    friend class CGUIComponentManager; 
 
public:
    static void CreateInstance();
 
    static void DeleteInstance();
 
    void SetLegacyBehaviour(const eC_Bool bLegacyBehaviour);
 
    CGUIObject* GetFocussedObject() const;
 
    CGUIObject* GetFormerlyFocussedObject() const;
 
    void FocusLost();
 
    CGUIObject* GetHighlightedObject() const;
 
    CGUIObject* GetPressedObject() const;
 
    CGUIObject* GetDraggedObject() const;
 
    CGUIObject* GetObjectUnderMousePointer() const;
 
    CGUIObject* GetFormerlyUnderMouseObject() const;
 
    CGUICompositeObject* GetCurrentModalDialog() const;
 
    void SetModalDialog(CGUICompositeObject* pModalDialog);
 
    void ReleaseModalDialog(CGUICompositeObject* pModalDialog);
 
    eC_Bool IsObjModalDialog(CGUICompositeObject* const pObj) const;
 
    void AddModalDialogException(CGUICompositeObject* pkException);
 
    void RemoveModalDialogException(CGUICompositeObject* pkException);
 
    eC_Bool MouseWasUsed() const;
 
    void SetMouseWasUsed(eC_Bool bMouseUsed);
 
    void GetLastMousePos(eC_UInt &uiMouseX, eC_UInt &uiMouseY) const;
 
    void SetDisableEventHandling(eC_Bool bDisableEventHandling);
 
    eC_Bool GetDisableEventHandling() const;
 
    const CGUIEvent* GetCurrentEvent() const;
 
    void SetScrollModifiers(eC_UInt uiScrollModifiers);
 
    void SetDragThreshold(const eC_Int iDragThreshold);
 
    eC_Int GetDragThreshold() const;
 
    void SetHighlightingDisabled(const eC_Bool bDisabled);
 
    void SetLongClickTime(const eC_UInt uiLongClickTime);
 
    eC_UInt GetLongClickTime() const;
 
    void SetDoubleClickTime(const eC_UInt uiDoubleClickTime);
 
    eC_UInt GetDoubleClickTime() const;
 
    eC_UInt GetIdleTime();
 
    void GetDragStart(eC_Int& iDragStartX, eC_Int& iDragStartY);
 
    eC_UInt GetLastButtonDownTime();
 
    eC_Bool ExecuteClickHandler(CGUIObject* pkObject);
 
    eC_Bool IsWithinModalDialogIfAny(const CGUIObject* pObj) const;
 
#ifdef USE_ZOOM
    void SetZoom(const eC_Value& vZoomFactor, const CGUIRect& kZoomRect)
    {
        m_bZoomActive = true;
        m_vZoomFactor = vZoomFactor;
        m_kZoomArea = kZoomRect;
    }
 
    void ResetZoom()
    {
        m_bZoomActive = false;
        m_vZoomFactor = eC_FromInt(1);
    }
#endif
 
private:
    CGUIEventHandler();
 
    ~CGUIEventHandler();
 
    CGUIEventHandler(const CGUIEventHandler& kSource);
 
    CGUIEventHandler& operator=(const CGUIEventHandler& kSource);
 
    void HandleLongClick(eC_Bool& bHandled);
 
    void HandleFocus();
 
    void HandleChar(CGUIEvent* pEvent, eC_Bool& bHandled);
 
    void HandleKeyUp(CGUIEvent* pEvent, eC_Bool& bHandled);
 
    void HandleKeyDown(CGUIEvent* pEvent, eC_Bool& bHandled);
 
    void HandleMouseWheel(CGUIEvent* pEvent, eC_Bool& bHandled);
 
    void HandleMouseMove(CGUIEvent* pEvent, eC_Bool& bHandled);
 
    void HandleRButtonDown(CGUIEvent* pEvent, eC_Bool& bHandled);
 
    void HandleLButtonDown(CGUIEvent* pEvent, eC_Bool& bHandled);
 
    void HandleRButtonUp(CGUIEvent* pEvent, eC_Bool& bHandled);
 
    void HandleLButtonUp(CGUIEvent* pEvent, eC_Bool& bHandled);
 
    void HandleEvent(CGUIEvent *pEvent);
 
    ObjectHandle_t HandleModalEvents(
        CGUIEvent* pkEvent,
        ObjectHandle_t eObjOK = NO_HANDLE,
        ObjectHandle_t eObjCancel = NO_HANDLE,
        ObjectHandle_t eObjAdditional = NO_HANDLE);
 
    void NotifyOfDestruction(CGUIObject* pObj);
 
    void SetPressedObject(CGUIObject* pObj, eC_Bool bOverwriteOriginal = false);
 
    void SetHighlightedObject(CGUIObject* pHighlightedObject);
 
    void SetFocussedObject(CGUIObject* pObj);
 
    void SetDraggedObject(CGUIObject* pObj);
 
private:
    CGUIObject* m_pkFormerlyUnderMouseObject;
 
    CGUIObject* m_pkFocussedObject;
 
    CGUIObject* m_pkHighlightedObject;
 
    CGUIObject* m_pkPressedObject;
 
    CGUIObject* m_pkOriginallyPressedObject;
 
    ObjectHandle_t m_ePressedObjectID;
 
    CGUIObject* m_pkDraggedObject;
 
    CGUIObject* m_pkObjectUnderMousePointer;
 
    eC_TListDoubleLinked<CGUICompositeObject*> m_kModalDialogList;
 
    eC_TListDoubleLinked<const CGUICompositeObject*> m_kModalDialogExceptionList;
 
    eC_Bool m_bLeftButtonPressed;
    eC_Bool m_bRightButtonPressed;
 
    eC_Int m_iOldMouseX;
    eC_Int m_iOldMouseY;
 
    eC_Bool m_bMouseUsed;
 
    eC_Bool m_bDisableEventHandling;
 
    CGUIObject* m_pkTempObject;
 
    CGUIEvent* m_pkEvent;
 
    eC_UInt m_uiScrollModifiers;
 
    eC_TListDoubleLinked<CGUIObject*> m_kListOfObjectsToFocus;
    CGUIObject* m_pkTempFocussedObject;
    CGUIObject* m_pkFormerlyFocussedObject;
 
    eC_Int m_iDragStartX;
    eC_Int m_iDragStartY;
 
    eC_Int m_iDragThreshold;
 
    eC_Int m_iCurXPos;
 
    eC_Int m_iCurYPos;
 
    eC_Value m_vCurXPos;
 
    eC_Value m_vCurYPos;
 
    eC_Bool m_bHighlightingDisabled;
 
    eC_Bool m_bIsDragging;
 
    eC_UInt m_uiLastClickTime;
 
    eC_UInt m_uiDoubleClickTime;
 
    eC_UInt m_uiLastButtonDownTime;
 
    eC_UInt m_uiLongClickTime;
 
    eC_Bool m_bLongClickGenerated;
 
    CGUIObject* m_pkLastClickedObject;
 
    eC_Bool m_bForceDoButtonUpToPressedObject;
 
    eC_Bool m_bIgnorePressedObjectRect;
 
    eC_Bool m_bDragAndClick;
 
#ifdef USE_ZOOM
    eC_Bool m_bZoomActive;
    eC_Value m_vZoomFactor;
    CGUIRect m_kZoomArea;
#endif
};
 
#endif