GUIComboBox.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 GUICOMBOBOX__H_
#define GUICOMBOBOX__H_
 
#include "GUICompositeObject.h"
#include "GUICommand.h"
#include "GUIComboBoxHeader.h"
#include "GUIListBox.h"
#include "GUIColorPropertyObserver.h"
 
class CGUIListItem;
 
// @guiliani_doxygen toplevel_control Combo Box
// @endguiliani_doxygen
class CGUIComboBox : public CGUICompositeObject, public CGUIColorPropertyObserver
{
public:
    enum InputActionType_t
    {
        INPUT_INSERTED, 
        INPUT_SEARCHED  
    };
 
public:
    CGUIComboBox();
 
    CGUIComboBox(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY,
        const eC_Value& vWidth, const eC_Value& vHeight,
        const eC_Value& vHeaderButtonWidth,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    virtual ~CGUIComboBox();
 
#ifndef GUILIANI_NO_DATAPOOL
    virtual eC_Bool SetValue(CDataPoolEntry& rkValue);
#endif
 
    virtual eC_Bool SetValue(const CGUIValue& rkValue);
 
    virtual void Open();
 
    virtual void Close();
 
    eC_Bool IsOpen() const;
 
    eC_Bool AddItem(CGUIListItem* pItem, eC_Bool bIsAutoAdjustArrange = true);
 
    eC_Bool AddItem(const eC_String& kText, eC_Bool bIsAutoAdjustArrange = true);
 
    eC_Bool RemoveItem(CGUIListItem* pItem, eC_Bool bIsAutoAdjustArrange = true);
 
    eC_Bool RemoveItem(const eC_String& kItemStr, eC_Bool bIsAutoAdjustArrange = true);
 
    void Reset();
 
    virtual eC_Bool DoDraw();
 
    eC_Int GetSelection() const;
 
    void SetSelection(eC_Int iIndex);
 
    void SetItemSelectedColor(eC_UInt uiItemSelectedColor) const;
 
    eC_UInt GetItemCount() const;
 
    CGUIListItem* GetItem(eC_UInt uiIndex) const;
 
    eC_String GetSelectedItemStr() const;
 
    CGUIListBox* GetListBox() const;
 
    eC_Int FindItem(const eC_String& kItemStr) const;
 
    void SetHeaderButtonWidth(const eC_Value& vHeaderButtonWidth) const;
 
    void SetHeaderButtonImages(
        const ImageResource_t &eBtnStandard,
        const ImageResource_t &eBtnPressed,
        const ImageResource_t &eBtnHighlighted,
        const ImageResource_t &eBtnGrayedOut,
        const ImageResource_t &eBtnFocused) const;
 
    void SetHeaderEditable(const eC_Bool& bEditable) const;
 
    void SetHeaderText(const eC_String& kStr) const;
 
    eC_String GetHeaderText() const;
 
    CGUIComboBoxHeader* GetHeader() const;
 
    void SetHeaderSelectedTextColor(eC_UInt uiCol) const;
 
    eC_UInt GetSelectedTextColor() const;
 
    CGUIEditableText* GetHeaderLabel() const;
 
    void SetLabel(CGUIEditableText* pkText) const;
 
    void SetCommand(CGUICommandPtr pkCommand);
 
    virtual eC_Bool DoUserEvent(CGUIEvent* const pEvent);
 
    virtual eC_Bool DoKeyDown(const GUIKeyIdentifier_t& eKeyID, const eC_UInt& uiModifiers);
 
    virtual eC_Bool DoChar(const eC_UInt &uiKey, const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers);
 
    virtual void OnNotification(const CGUIValue& kObservedValue, const CGUIObject* const pkUpdatedObject, const eC_UInt uiX = 0, const eC_UInt uiY = 0);
 
    virtual void SetWidth(const eC_Value& vWidth);
 
    virtual void SetHeight(const eC_Value& vHeight);
 
    eC_String GetPreviousSelection() const;
 
    void SetInputActionType(const InputActionType_t& eInputActionType);
 
    InputActionType_t GetInputActionType() const;
 
    virtual void LoseFocus();
 
    void AddSelectionObserver(CGUIObserver* pObserver);
 
    void RemoveSelectionObserver(CGUIObserver* pObserver);
 
    void SetFrameBorderWidth(const eC_Value& vFrameBorderWidth);
 
    eC_UInt GetFrameBorderColor() const;
 
    void SetFrameBorderColor(const eC_UInt& uiFrameBorderColor);
 
    void SetFrameBorderColor(const GlobalProperty_t& eFrameBorderColor);
 
    eC_Bool FocusAny();
 
    eC_Bool FocusSelectedItem();
 
    void SetGrayedOut(const eC_Bool &bGrayedOut);
    void SetDisabled(const eC_Bool& bDisabled);
 
    void AdjustComboBox();
 
    void SetForceVisible(const eC_Bool& bForceVisible);
 
    eC_Bool GetForceVisible() const;
 
#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
 
protected:
    virtual eC_Bool DoClick(
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual void RemoveObject(CGUIObject* pkObject);
 
private:
    enum ListPosition_t
    {
        UNDER_HEADER,  
        ABOVE_HEADER   
    };
 
private:
    void UpdateHeaderString();
 
    void DetermineListDirection();
 
    CGUIComboBox(const CGUIComboBox& kSource);
 
    CGUIComboBox& operator=(const CGUIComboBox& kSource);
 
    void Init(const eC_Value& vHeaderButtonWidth);
 
private:
    CGUIComboBoxHeader* m_pkHeader;
 
    CGUIListBox* m_pkListBox;
 
    CGUICommandPtr m_pkCommand;
 
    eC_String m_kPrevSelectedStr;
 
    InputActionType_t m_eInputActionType;
 
    eC_Bool m_bEditing;
 
    CGUISubject m_kSelectedIndexSubject;
 
    eC_Value m_vFrameBorderWidth;
 
    CGUICompositeObject* m_pkOriginalParent;
    eC_Value m_vOriginalRelXPos;
    eC_Value m_vOriginalRelYPos;
 
    eC_Bool m_bForceVisible;
 
    eC_Int m_iSelectionIndex;
};
 
#endif