GUIListBox.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 __GUILISTBOX__H_
#define __GUILISTBOX__H_
 
#include "GUIScrollView.h"
#include "eC_TList_doubleLinked.h"
#include "GUIEventTypeResource.h"
#include "GUIPropertyResource.h"
#include "GUIColorPropertyObserver.h"
 
class CGUIListItem;
 
// @guiliani_doxygen toplevel_control List Box
// @endguiliani_doxygen
class CGUIListBox : public CGUIScrollView, public CGUIColorPropertyObserver
{
public:
 
    typedef eC_TListDoubleLinked<CGUIListItem*> ItemPtrList_t;
 
    typedef eC_TListDoubleLinked<eC_UInt> IndexList_t;
 
    typedef eC_TListDoubleLinked<eC_String> StringList_t;
 
    enum Mode_t
    {
        VER_EXT,
        HOR_EXT
    };
 
public:
    CGUIListBox(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY,
        const eC_Value& vWidth, const eC_Value& vHeight,
        const Mode_t & eMode = VER_EXT,
        const eC_Bool & bMultipleSelection = false,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIListBox(
        CGUICompositeObject* const pkParent,
        const CGUIRect &kRect,
        const Mode_t & eMode = VER_EXT,
        const eC_Bool & bMultipleSelection = false,
        const ObjectHandle_t &eID = NO_HANDLE);
 
#ifdef GUILIANI_STREAM_GUI
    CGUIListBox();
#endif
 
    ~CGUIListBox();
 
    eC_Bool AddItem(CGUIListItem* pItem, eC_Bool bIsAutoAdjustArrange = true);
 
 
    eC_Bool RemoveItem(CGUIListItem* pItem, eC_Bool bIsAutoAdjustArrange = true);
 
    eC_Bool RemoveItems(eC_UInt uiStartIndex, eC_UInt uiEndIndex, eC_Bool bIsAutoAdjustArrange = true);
 
    eC_Bool AddSelection(eC_UInt uiIndex);
 
    void SetBgColor(const eC_UInt& uiBgColor);
 
    void SetBgColor(const GlobalProperty_t& eBgColor);
 
    void SetDraggedFrameBgColor(const eC_UInt& uiDraggedFrameBgColor);
 
    void SetDraggedFrameBgColor(const GlobalProperty_t& eDraggedFrameBgColor);
 
    eC_Int GetSelection();
 
    IndexList_t GetSelectionIndexList();
 
    void SetSelection(eC_UInt uiIndex);
 
    void ReleaseSelection(eC_UInt uiIndex);
 
    void ReleaseAllSelection();
 
    eC_String GetSelectedItemStr();
 
    StringList_t GetSelectedItemsStrList();
 
    void SetItemSelectedColor(eC_UInt uiItemSelectedColor);
 
    eC_UInt GetItemCount() const;
 
    CGUIListItem* GetItem(eC_UInt uiIndex);
 
    CGUIListItem* GetNextItem();
 
    eC_Bool SelectObject(const CGUIObject* pObj);
 
    eC_Bool IsObjectAnItemInList(const CGUIObject* pObj) const;
 
    void DeleteAllItems();
 
    eC_Int FindItem(const eC_String& kItemStr) const;
 
    eC_Int FindItemBySubstring(const eC_String& kSearchString) const;
 
    void SetWidth(const eC_Value& vWidth);
 
    void SetHeight(const eC_Value& vHeight);
 
    virtual eC_Bool DoDraw();
 
    eC_Bool DoPostDraw();
 
    virtual eC_Bool DoClick(
        const eC_Value& vAbsX = (eC_FromInt(-1)),
        const eC_Value& vAbsY = (eC_FromInt(-1)));
 
    virtual eC_Bool RequestFocusForSelection();
 
    eC_Bool DoKeyDown(
        const GUIKeyIdentifier_t& eKeyID,
        const eC_UInt& uiModifiers);
 
    virtual eC_Bool DoMouseEnter(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    void AdjustArrangement();
 
    virtual eC_Bool DoButtonDown(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    virtual eC_Bool DoDragEnd(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    virtual eC_Bool DoDrag(const eC_Value& vDeltaX, const eC_Value& vDeltaY, const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    eC_Int GetItemIndexOfObject(const CGUIObject* pObj) const;
 
 
#ifdef GUILIANI_STREAM_GUI
    virtual void ReadFromStream();
#endif
 
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
    void SetMultipleSelection(const eC_Bool& bMultiSelection);
 
    void SetUseKeyboard(const eC_Bool& bUseKeyboard);
 
    void SetSelectedByHighlighting(const eC_Bool& bSelectedByHighlighting);
 
    void SetUnifyItemSize(const eC_Bool& bUnifyItemSize);
 
    eC_Bool FocusAny();
 
    void AddSelectionObserver(CGUIObserver* pObserver);
 
    void RemoveSelectionObserver(CGUIObserver* pObserver);
 
protected:
    void Init();
 
    virtual void GetFocus();
 
    void UpdateSelection(const CGUIObject* pkObject, const CGUIEvent* pEvent);
 
private:
    CGUIListBox(const CGUIListBox& kSource);
 
    CGUIListBox& operator =(const CGUIListBox &kSource);
 
    eC_Bool AddObject(CGUIListItem* pkObject);
 
    eC_Bool AddObject(CGUIObject* pkObject);
 
    void RemoveObject(CGUIObject* pkObject){return CGUIScrollView::RemoveObject(pkObject);}
 
    void AdjustArrangementVER_EXT(eC_Bool bVerBarIsVisible = false);
 
    void AdjustArrangementHOR_EXT(eC_Bool bHorBarIsVisible = false);
 
    void DragAndSelectItems(const eC_Bool bShiftPressed, const eC_Bool bCtrlPressed);
 
    void RegenerateIndexStringList();
 
private:
    static const eC_UInt INDEX_COLOR_BACKGROUND;
    static const eC_UInt INDEX_COLOR_DRAGGEDFRAME;
 
    ItemPtrList_t m_kItemList;
 
    IndexList_t m_kSelIndexList;
 
    StringList_t m_kSelStringList;
 
    Mode_t m_eMode;
 
    eC_Bool m_bMultipleSelection;
 
    eC_Bool m_bUseKeyboard;
 
    CGUIRect m_kSelectionFrame;
 
    eC_Value m_vAbsXPosClickPoint;
 
    eC_Value m_vAbsYPosClickPoint;
 
    eC_Bool m_bIndexStringListDirty;
 
    ItemPtrList_t::Iterator m_kCurAccessedItemIter;
 
    eC_Bool m_bSelectedByHighlighting;
 
    eC_Bool m_bUnifyItemSize;
 
    CGUISubject m_kSelectedIndexSubject;
};
#endif