GUIBehaviour.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 GUIBEHAVIOUR__H_
#define GUIBEHAVIOUR__H_
 
#include "GUIStreamableObject.h"
#include "GUIEventTypeResource.h"
#include "eC_Math.h"
 
class CGUIEvent;
class CGUIObject;
 
enum BehaviourType_t
{
    BT_CLICK = 0,
    BT_LONG_CLICK,
    BT_DOUBLE_CLICK,
    BT_BUTTON_DOWN,
    BT_BUTTON_UP,
    BT_FOCUS_PREVIOUS,
    BT_FOCUS_NEXT,
    BT_DECREASE,
    BT_INCREASE,
    BT_DRAG,
    BT_MOUSE_ENTER,
    BT_MOUSE_LEAVE,
    BT_MOUSE_MOVE,
    BT_WHEEL_UP,
    BT_WHEEL_DOWN,
    BT_USER_EVENT,
    BT_KEY_DOWN,
    BT_KEY_UP,
    BT_CHAR,
    BT_GETFOCUS,
    BT_LOSEFOCUS,
    BT_DRAGEND,
    BT_ONCREATE,
    BT_ONDELETE,
    BT_ONSHOW,
    BT_ONHIDE,
    BT_DUMMY
};
 
 
class CGUIBehaviour : public CGUIStreamableObject
{
public:
 
    virtual eC_Bool DoClick(
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoLongClick(
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoDoubleClick(
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoButtonDown(
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoButtonUp(
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoDrag(
        const eC_Value& vDeltaX = eC_FromInt(-1),
        const eC_Value& vDeltaY = eC_FromInt(-1),
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoDragEnd(
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
 
    virtual eC_Bool DoMouseEnter(
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoMouseLeave(
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoMouseMove(
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
 
    virtual eC_Bool FocusPrevious(
        CGUIObject* const pRefObj = NULL,
        const eC_Bool &bSubTreeOfRefObjDone = false);
 
    virtual eC_Bool FocusNext(
        CGUIObject* const pRefObj = NULL,
        const eC_Bool &bSubTreeOfRefObjDone = false);
    
    virtual void GetFocus();
 
    virtual void LoseFocus();
 
 
    virtual eC_Bool Decrease();
 
    virtual eC_Bool Increase();
    
    virtual eC_Bool DoKeyDown(
        const GUIKeyIdentifier_t &eKeyIdentifier,
        const eC_UInt &uiModifiers);
 
    virtual eC_Bool DoKeyUp(
        const GUIKeyIdentifier_t &eKeyIdentifier,
        const eC_UInt &uiModifiers);
 
    virtual eC_Bool DoChar(
        const eC_UInt &uiKey,
        const GUIKeyIdentifier_t &eKeyIdentifier,
        const eC_UInt &uiModifiers);
 
 
    virtual eC_Bool DoScrollUp(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoScrollDown(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoScrollLeft(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoScrollRight(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoUserEvent(CGUIEvent* const pEvent);
 
    virtual void OnCreate();
 
    virtual void OnDelete();
 
    virtual void OnShow();
 
    virtual void OnHide();
 
#if defined(GUILIANI_STREAM_GUI) || defined(GUILIANI_WRITE_GUI)
    static const eC_Char XMLTAG_BEHAVIOURCLASSID[];
#endif
};
 
#endif