GUICompositeBehaviour.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 __COMPOSITEBHVR__H_
#define __COMPOSITEBHVR__H_
 
#include "GUIBehaviourDecorator.h"
#include "GUIDeleteNotification.h"
 
class CGUIEvent;
 
class CGUICompositeBehaviour : public CGUIBehaviourDecorator, protected CGUIDeleteNotification
{
public:
    CGUICompositeBehaviour();
 
    virtual ~CGUICompositeBehaviour();
 
    void AddBehaviour(CGUIBehaviourDecorator* pBehaviour, eC_Bool bAtFront = false);
 
    void RemoveBehaviour(CGUIBehaviourDecorator* pBehaviour);
 
    void RemoveAllBehaviours();
 
    virtual eC_Bool IsCompositeBehaviour() const { return true; }
 
    virtual CGUIBehaviourDecorator* Clone() const;
 
    // All following event handling methods forward the calls to child behaviours.
 
    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,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoButtonUp(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    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 eC_Bool Decrease();
 
    virtual eC_Bool Increase();
 
    virtual eC_Bool DoDrag(
        const eC_Value& vDeltaX,
        const eC_Value& vDeltaY,
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoDragEnd(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoMouseEnter(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoMouseLeave(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoMouseMove(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoUserEvent(CGUIEvent* const pEvent);
 
    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 void GetFocus();
 
    virtual void LoseFocus();
 
    CGUICompositeBehaviour& operator=(const CGUICompositeBehaviour& rSource);
 
#if defined(GUILIANI_STREAM_GUI)
    virtual void ReadFromStream();
#endif
 
#if defined(GUILIANI_WRITE_GUI)
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
#if defined(GUILIANI_STREAM_GUI) || defined(GUILIANI_WRITE_GUI)
    static const eC_Char XMLTAG_NUMBER_OF_BEHAVIOURS[];
#endif
 
protected:
    void CopyBehaviours(const CGUICompositeBehaviour& rSource);
 
    typedef eC_TListDoubleLinked<CGUIBehaviourDecorator*> BehaviourList;
 
    BehaviourList m_Behaviours; 
};
 
#endif