GUIHotkeysBehaviour.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 GUI_HOTKEYS_BEHAVIOUR__H_
#define GUI_HOTKEYS_BEHAVIOUR__H_
 
#include "GUIBehaviourDecorator.h"
#include "GUIObjectHandleResource.h"
#include "GUICommand.h"
#include "eC_TList_doubleLinked.h"
 
 
 
class CGUIHotkeysBehaviour : public CGUIBehaviourDecorator
{
public:
    CGUIHotkeysBehaviour(eC_Bool bMarkAlwaysAsHandled = false);
 
    CGUIHotkeysBehaviour(const CGUIHotkeysBehaviour& kSource);
 
    CGUIHotkeysBehaviour& operator=(const CGUIHotkeysBehaviour& kSource);
 
    virtual ~CGUIHotkeysBehaviour() {}
 
    virtual CGUIBehaviourDecorator* Clone() const;
 
    void AddHotKeyMap(
        GUIKeyIdentifier_t eKeyIdentifier,
        eC_UInt uiModifiers,
        eC_Bool bCheckForModifiers,
        ObjectHandle_t eMappedObjID,
        eC_Bool bAbstractObj,
        CGUICommandPtr pkCommand = NULL,
        eC_Bool bActivated = true);
 
    void SetModifiers(
        GUIKeyIdentifier_t eKey,
        eC_UInt uiModifiers,
        eC_Bool bCheckForModifiers);
 
    void SetMarkAlwaysAsHandled(eC_Bool bMarkAlwaysAsHandled);
 
    void SetActivated(
        GUIKeyIdentifier_t eKeyContent,
        eC_UInt uiModifiers,
        eC_Bool bActivated);
 
    eC_Bool GetHotKey(
        GUIKeyIdentifier_t& reKeyIdentifier,
        eC_UInt& ruiModifiers,
        ObjectHandle_t eMappedObjID) const;
 
#ifdef GUILIANI_STREAM_GUI
    void ReadFromStream();
#endif
#ifdef GUILIANI_WRITE_GUI
    void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
protected:
    struct HotKeyMap_t
    {
        GUIKeyIdentifier_t m_eKeyID;
 
        eC_UInt m_uiModifiers;
 
        eC_Bool m_bCheckForModifiers;
 
        ObjectHandle_t m_eMappedObjID;
 
        eC_Bool m_bAbstractObj;
 
        CGUICommandPtr m_pkCommand;
 
        eC_Bool m_bActivated;
 
        HotKeyMap_t(
            GUIKeyIdentifier_t eKeyContent = GK_NONE,
            eC_UInt uiModifiers = 0,
            eC_Bool bCheckForModifiers = false,
            ObjectHandle_t eMappedObjID = NO_HANDLE,
            eC_Bool bAbstractObj = false,
            CGUICommandPtr pkCommand = NULL,
            eC_Bool bActivated = true) :
            m_eKeyID(eKeyContent),
            m_uiModifiers(uiModifiers),
            m_bCheckForModifiers(bCheckForModifiers),
            m_eMappedObjID(eMappedObjID),
            m_bAbstractObj(bAbstractObj),
            m_pkCommand(pkCommand),
            m_bActivated(bActivated)
        {
        }
    };
 
    eC_TListDoubleLinked<HotKeyMap_t> m_kHotKeyMapList;
 
    virtual eC_Bool DoKeyDown(
        const GUIKeyIdentifier_t& eKeyIdentifier,
        const eC_UInt& uiModifiers);
 
    virtual eC_Bool DoKeyUp(
        const GUIKeyIdentifier_t& eKeyIdentifier,
        const eC_UInt& uiModifiers);
 
private:
    enum CallSlot
    {
        CS_KEYDOWN,
        CS_KEYUP
    };
 
    void CopyAttributes(const CGUIHotkeysBehaviour& kSource);
 
    eC_Bool HandleHotKeyContent(
        GUIKeyIdentifier_t eKeyIdentifier,
        eC_UInt uiModifiers,
        CallSlot eSlot);
 
    eC_Bool m_bMarkAlwaysAsHandled;
};
 
#endif