GUILayoutHelper.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_LAYOUT_HELPER__H_
#define GUI_LAYOUT_HELPER__H_
 
#include "eC_Types.h"
#include "eC_Math.h"
#include "eC_TList_doubleLinked.h"
#include "GUIObject.h"
 
class CGUICompositeObject;
class CGUIRect;
 
#define GET_LAYOUT_HELPER           #error "please use GUILayouter:: instead"
 
 
class CGUILayoutHelper
{
public:
    enum ListAlignment_t
    {
        LIST_ALIGN_HORIZONTAL=0,
        LIST_ALIGN_VERTICAL,
        LIST_ALIGN_INVALID // TODO: Why?
    };
 
    enum RepositionAlignment_t
    {
        REPOSITION_ALIGN_TOP=0,
        REPOSITION_ALIGN_BOTTOM,
        REPOSITION_ALIGN_LEFT,
        REPOSITION_ALIGN_RIGHT,
        REPOSITION_ALIGN_INVALID
    };
 
    enum LayoutAlignment_t
    {
        LAYOUT_ALIGN_LEFT,
        LAYOUT_ALIGN_RIGHT,
        LAYOUT_ALIGN_TOP,
        LAYOUT_ALIGN_BOTTOM,
        LAYOUT_ALIGN_HORIZONTAL_CENTERED,
        LAYOUT_ALIGN_VERTICAL_CENTERED,
        LAYOUT_DISTRIBUTE_HORIZONTALLY,
        LAYOUT_DISTRIBUTE_VERTICALLY
    };
    
    enum LayoutFlip_t
    {
        LAYOUT_FLIP_HORIZONTAL,
        LAYOUT_FLIP_VERTICAL
    };
 
    enum LayoutRotate_t
    {
        LAYOUT_ROTATE_RIGHT,
        LAYOUT_ROTATE_LEFT
    };
 
    ~CGUILayoutHelper() {}
 
    static void AlignChildren(
        const CGUICompositeObject* pkParent,
        LayoutAlignment_t eAlignment,
        const eC_Value& vRelDistance = eC_FromInt(0));
 
    static void AlignObject(
        CGUIObject* pkAlignedObj,
        LayoutAlignment_t eAlignment,
        const CGUIObject* pkRefObj);
 
    static void AlignObject(
        CGUIObject* pkAlignedObj,
        LayoutAlignment_t eAlignment);
 
    static void AlignObjects(
        eC_TListDoubleLinked<CGUIObject*>& pkAlignedObjs,
        LayoutAlignment_t eAlignment,
        const CGUIObject* pkRefObj);
 
    static void AlignToGrid(
        const CGUICompositeObject* pkParentObj,
        eC_UInt uiRow,
        eC_UInt uiColumn, eC_Bool bMakeSameSize);
 
    static void ResizeObject(
        CGUIObject* pkObj, const
        CGUIObject* pkRefObj);
 
    static void ResizeObjects(
        eC_TListDoubleLinked<CGUIObject*>& pkObjs,
        const CGUIObject* pkRefObj);
 
    static void DistributeObjects(
        eC_TListDoubleLinked<CGUIObject*>& pkObjs,
        eC_Bool bHorizontal,
        eC_Bool bVertical);
 
    static void AdaptWidth(
        CGUIObject* pkObj,
        const CGUIObject* pkRefObj);
 
    static void AdaptWidth(
        eC_TListDoubleLinked<CGUIObject*>& pkObjs,
        const CGUIObject* pkRefObj);
 
    static void AdaptHeight(
        CGUIObject* pkObj,
        CGUIObject* pkRefObj);
 
    static void AdaptHeight(
        eC_TListDoubleLinked<CGUIObject*>& pkObjs,
        CGUIObject* pkRefObj);
 
    static void SpreadHorizontally(
        const CGUICompositeObject* pkParent,
        const eC_Value& vSpace);
 
    static void SpreadVertically(
        const CGUICompositeObject* pkParent,
        const eC_Value& vSpace);
 
    static void MoveToCurrentAbsXPos(
        CGUIObject* pkObject,
        const eC_Value& vAbsXPos);
 
    static void MoveToCurrentAbsYPos(
        CGUIObject* pkObject,
        const eC_Value& vAbsYPos);
 
    static eC_Value GetCurrentAbsXPos(const CGUIObject* pkObject);
 
    static eC_Value GetCurrentAbsYPos(const CGUIObject* pkObject);
 
    static CGUIRect GetCurrentAbsRect(const CGUIObject* pkObject);
 
    static eC_Value GetCurrentAbsXDistance(
        const CGUIObject* pkObjectOnRight,
        const CGUIObject* pkObjectOnLeft)
    {
        return GetCurrentAbsXPos(pkObjectOnRight) - GetCurrentAbsXPos(pkObjectOnLeft);
    }
 
    static eC_Value GetCurrentAbsYDistance(
        const CGUIObject* pkObjectAtBottom,
        const CGUIObject* pkObjectAtTop)
    {
        return GetCurrentAbsYPos(pkObjectAtBottom) - GetCurrentAbsYPos(pkObjectAtTop);
    }
 
    static void UseBoundingRectangleOfChildren(CGUICompositeObject *pkParent);
 
    static void RepositionChildren(
        CGUICompositeObject *pkParent,
        const eC_Value& vBorder,
        const eC_Value& vGap,
        const RepositionAlignment_t& eBasePoint,
        const eC_Bool& bResizeParent = true,
        const eC_Bool& bDoubleBorder = true);
 
    static void AdjustListArrangement(
        CGUICompositeObject* pkParent,
        const CGUIRect& kAvailableArea,
        const eC_Bool& bUnifyItemSize,
        const ListAlignment_t& eBasePoint);
 
    static void FlipObject(CGUIObject* pkFlipObj, const LayoutFlip_t& eFlip);
 
    static void RotateObject(CGUIObject* pkRotateObj, const LayoutRotate_t& eRotate);
 
    static void ResizeChildren(CGUICompositeObject* pkParent, const eC_Value& vWidthScale, const eC_Value& vHeightScale);
 
private:
 
    CGUILayoutHelper() {}
 
    CGUILayoutHelper(const CGUILayoutHelper& kSource);
 
    CGUILayoutHelper& operator=(const CGUILayoutHelper& kSource);
};
#endif