GUICompositeObject.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 GUICOMPOSITEOBJECT__H_
#define GUICOMPOSITEOBJECT__H_
 
#include "GUIObject.h"
#include "eC_TList_doubleLinked.h"
 
typedef eC_TListDoubleLinked<CGUIObject*> ObjectPtrList;
 
 
// @guiliani_doxygen toplevel_control Composite Object
// @endguiliani_doxygen
class CGUICompositeObject : public CGUIObject
{
public:
    friend class CGfxWrap; 
    friend class CGUIObject; 
 
    CGUICompositeObject();
 
    CGUICompositeObject(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY,
        const eC_Value& vWidth, const eC_Value& vHeight,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUICompositeObject(
        CGUICompositeObject* const pkParent,
        const CGUIRect &kRect,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    virtual ~CGUICompositeObject();
 
    CGUICompositeObject(const CGUICompositeObject& kSource);
 
    CGUICompositeObject& operator=(const CGUICompositeObject& kSource);
 
#ifdef GUILIANI_STREAM_GUI
    virtual void ReadFromStream();
#endif // GUILIANI_STREAM_GUI
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif // GUILIANI_WRITE_GUI
 
    virtual void SetWidth(const eC_Value& vX);
 
    virtual void SetHeight(const eC_Value& vY);
 
    virtual eC_Bool AddObject(CGUIObject* pkObject);
 
    virtual void RemoveObject(CGUIObject* pkObject);
 
    virtual CGUIObject* FindObject(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    virtual eC_Bool FocusNext(
        CGUIObject* const pRefObj = NULL,
        const eC_Bool &bSubTreeOfRefObjDone = false);
 
    virtual eC_Bool FocusPrevious(
        CGUIObject* const pRefObj = NULL,
        const eC_Bool &bSubTreeOfRefObjDone = false);
 
    eC_Bool FocusAny();
 
    virtual eC_Bool DoPostDraw();
 
    void DrawOnTop(CGUIObject* pkObject);
 
    void DrawOnTopOf(CGUIObject*const pkObject, CGUIObject*const pDrawOnTopOf);
 
    inline CGUIObject* GetObjectByID(const ObjectHandle_t &eID, const eC_Bool& bOnlyVisible = false)
    {
        // Call the const-GetObjectByID function, which is the real
        // implementation.
        // Casting away constness is valid here, because all
        // CGUIObjects in Guiliani by rule shall be declared non-const
        // at construction time.
        return const_cast<CGUIObject*>(static_cast<const CGUICompositeObject* const>(this)->GetObjectByID(eID, bOnlyVisible));
    }
 
    const CGUIObject* GetObjectByID(const ObjectHandle_t &eID, const eC_Bool& bOnlyVisible = false) const;
 
    const CGUIObject* GetAndCheckObjectByID(ObjectHandle_t eObjID, const eC_String& kObjectName) const;
 
    inline CGUIObject* GetAndCheckObjectByID(ObjectHandle_t eObjID, const eC_String& kObjectName)
    {
        // Call the const-GetObjectByID function, which is the real implementation.
        return const_cast<CGUIObject*>(static_cast<const CGUICompositeObject* const>(this)->GetAndCheckObjectByID(eObjID, kObjectName));
    }
 
    virtual eC_Bool IsCompositeObject() const { return true; }
 
    virtual void SetDisabled(const eC_Bool& bDisabled) { CGUIObject::SetDisabled(bDisabled); }
 
    virtual void SetDisabled(const eC_Bool &bDisabled, const eC_Bool &bChildrenDisabled);
 
    virtual void SetInvisible(const eC_Bool& bInvisible) { CGUIObject::SetInvisible(bInvisible); }
 
    virtual void SetInvisible(const eC_Bool &bInvisible, const eC_Bool &bChildrenInvisible);
 
    virtual void SetGrayedOut(const eC_Bool &bGrayedOut) { CGUIObject::SetGrayedOut(bGrayedOut); }
 
    virtual void SetGrayedOut(const eC_Bool &bGrayedOut, const eC_Bool &bChildrenGrayedOut);
 
    virtual void SetFocussable(const eC_Bool &bFocussable) { CGUIObject::SetFocussable(bFocussable); }
 
    virtual void SetFocussable(const eC_Bool &bFocussable, const eC_Bool &bChildrenFocussable);
 
    virtual void SetClickThrough(const eC_Bool &bClickThrough) { CGUIObject::SetClickThrough(bClickThrough); }
 
    virtual void SetClickThrough(const eC_Bool &bClickThrough, const eC_Bool &bChildrenClickThrough);
 
    CGUIObject* GetChild(const eC_UInt uIndex) const;
 
    inline CGUIObject* GetChild(const eC_UInt uIndex)
    {
        // Call the const-GetObjectByID function, which is the real implementation.
        return const_cast<CGUIObject*>(static_cast<const CGUICompositeObject* const>(this)->GetChild(uIndex));
    }
 
    eC_Int GetIndexOfChild(const CGUIObject* pkObject) const;
 
    inline eC_UInt GetNumberOfChildren() const { return m_kChildObjectsList.GetQuantity(); }
 
    void RemoveAllChildren();
 
    eC_Bool InsertChildAt(const eC_UInt cuiIndex, CGUIObject* pkChild);
 
    inline void SetCyclicFocus(const eC_Bool &bCyclicFocus)
    {
        m_bCyclicFocus = bCyclicFocus;
    }
 
    inline eC_Bool CanBeCyclicFocussed() const { return m_bCyclicFocus; }
 
    eC_Bool IsAncestorOf(const CGUIObject* pkObject) const;
 
    inline const ObjectPtrList& GetChildObjectsList() const
    {
        return m_kChildObjectsList;
    }
 
    inline const ObjectPtrList& GetDrawOrderList() const
    {
        return m_kDrawOrderList;
    }
 
    void InvalidateChildren();
 
    virtual void RefreshLayout(CGUILayouter::eMovedEdges_t eMovedEdges) const;
 
    eC_Bool SendToBack(CGUIObject* pkObject);
 
    eC_Bool BringToFront(CGUIObject* pkObject);
 
    eC_Bool RaiseOneLevel(CGUIObject* pkObject);
 
    eC_Bool LowerOneLevel(CGUIObject* pkObject);
 
    void Flip(const eC_Bool& rbVertical);
 
    void Rotate(const eC_UInt& ruiDegrees, const eC_Bool& rbFirst = false);
 
#if defined(GUILIANI_STREAM_GUI) || defined(GUILIANI_WRITE_GUI)
    static const eC_Char XMLTAG_CHILDREN[];
 
    static const eC_Char XMLTAG_ENDCHILDREN[];
#endif
 
protected:
    inline ObjectPtrList& GetChildObjectsList()
    {
        return m_kChildObjectsList;
    }
 
    virtual eC_Bool FourWayNext(FourWayFocus_t eFocusDirection);
 
    virtual void HandleDraw(const CGUIRect &ClipRect);
 
private:
    void UpdateInvalidation();
 
    eC_Bool FocusNextDown();
 
    eC_Bool FocusPreviousDown();
 
    void CopyAttributes(const CGUICompositeObject& kSource);
 
    void Init();
 
private:
    ObjectPtrList m_kChildObjectsList;
 
    ObjectPtrList m_kDrawOrderList;
 
    eC_Bool m_bCyclicFocus;
};
#endif