Class for construction of a combo box control. More...

#include <GUIComboBox.h>

Inheritance diagram for CGUIComboBox:

[legend]

Public Types
enum	InputActionType_t { INPUT_INSERTED , INPUT_SEARCHED }

Public Types inherited from CGUIObject
enum	FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN }

Public Member Functions
	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 ()
	This destructor is automatically virtual, as the base class destructor is virtual.

eC_Bool	AddItem (CGUIListItem *pItem, eC_Bool bIsAutoAdjustArrange=true)

eC_Bool	AddItem (const eC_String &kText, eC_Bool bIsAutoAdjustArrange=true)

void	AddSelectionObserver (CGUIObserver *pObserver)

void	AdjustComboBox ()

virtual void	Close ()

virtual eC_Bool	DoChar (const eC_UInt &uiKey, const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)

virtual eC_Bool	DoDraw ()

virtual eC_Bool	DoKeyDown (const GUIKeyIdentifier_t &eKeyID, const eC_UInt &uiModifiers)

virtual eC_Bool	DoUserEvent (CGUIEvent *const pEvent)

eC_Int	FindItem (const eC_String &kItemStr) const

eC_Bool	FocusAny ()

eC_Bool	FocusSelectedItem ()

eC_Bool	GetForceVisible () const

eC_UInt	GetFrameBorderColor () const

CGUIComboBoxHeader *	GetHeader () const

CGUIEditableText *	GetHeaderLabel () const

eC_String	GetHeaderText () const

InputActionType_t	GetInputActionType () const

CGUIListItem *	GetItem (eC_UInt uiIndex) const

eC_UInt	GetItemCount () const

CGUIListBox *	GetListBox () const

eC_String	GetPreviousSelection () const

eC_String	GetSelectedItemStr () const

eC_UInt	GetSelectedTextColor () const

eC_Int	GetSelection () const

eC_Bool	IsOpen () const

virtual void	LoseFocus ()

virtual void	OnNotification (const CGUIValue &kObservedValue, const CGUIObject *const pkUpdatedObject, const eC_UInt uiX=0, const eC_UInt uiY=0)

virtual void	Open ()

virtual void	ReadFromStream ()

eC_Bool	RemoveItem (CGUIListItem *pItem, eC_Bool bIsAutoAdjustArrange=true)

eC_Bool	RemoveItem (const eC_String &kItemStr, eC_Bool bIsAutoAdjustArrange=true)

void	RemoveSelectionObserver (CGUIObserver *pObserver)

void	Reset ()

void	SetCommand (CGUICommandPtr pkCommand)

void	SetDisabled (const eC_Bool &bDisabled)

void	SetForceVisible (const eC_Bool &bForceVisible)

void	SetFrameBorderColor (const eC_UInt &uiFrameBorderColor)

void	SetFrameBorderColor (const GlobalProperty_t &eFrameBorderColor)

void	SetFrameBorderWidth (const eC_Value &vFrameBorderWidth)

void	SetGrayedOut (const eC_Bool &bGrayedOut)

void	SetHeaderButtonImages (const ImageResource_t &eBtnStandard, const ImageResource_t &eBtnPressed, const ImageResource_t &eBtnHighlighted, const ImageResource_t &eBtnGrayedOut, const ImageResource_t &eBtnFocused) const

void	SetHeaderButtonWidth (const eC_Value &vHeaderButtonWidth) const

void	SetHeaderEditable (const eC_Bool &bEditable) const

void	SetHeaderSelectedTextColor (eC_UInt uiCol) const

void	SetHeaderText (const eC_String &kStr) const

virtual void	SetHeight (const eC_Value &vHeight)

void	SetInputActionType (const InputActionType_t &eInputActionType)

void	SetItemSelectedColor (eC_UInt uiItemSelectedColor) const

void	SetLabel (CGUIEditableText *pkText) const

void	SetSelection (eC_Int iIndex)

virtual eC_Bool	SetValue (CDataPoolEntry &rkValue)

virtual eC_Bool	SetValue (const CGUIValue &rkValue)

virtual void	SetWidth (const eC_Value &vWidth)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUICompositeObject
	CGUICompositeObject ()

	CGUICompositeObject (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)

	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 (const CGUICompositeObject &kSource)

virtual	~CGUICompositeObject ()
	This destructor is automatically virtual, as the base class destructor is virtual.

virtual eC_Bool	AddObject (CGUIObject *pkObject)

eC_Bool	BringToFront (const CGUIObject *pkObject)

eC_Bool	CanBeCyclicFocussed () const

virtual eC_Bool	DoPostDraw ()

void	DrawOnTop (CGUIObject *pkObject)

void	DrawOnTopOf (CGUIObject const pkObject, CGUIObject const pDrawOnTopOf)

virtual CGUIObject *	FindObject (const eC_Value &vAbsX, const eC_Value &vAbsY)

void	Flip (const eC_Bool &rbVertical)

eC_Bool	FocusAny ()

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)

CGUIObject *	GetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName)

const CGUIObject *	GetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName) const

CGUIObject *	GetChild (const eC_UInt uIndex)

CGUIObject *	GetChild (const eC_UInt uIndex) const

const ObjectPtrList &	GetChildObjectsList () const

const ObjectPtrList &	GetDrawOrderList () const

eC_Int	GetIndexOfChild (const CGUIObject *pkObject) const

eC_UInt	GetNumberOfChildren () const

CGUIObject *	GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)

const CGUIObject *	GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const

eC_Bool	InsertChildAt (const eC_UInt cuiIndex, CGUIObject *pkChild)

void	InvalidateChildren ()
	Invalidates all chidren, but not this parent.

eC_Bool	IsAncestorOf (const CGUIObject *pkObject) const

virtual eC_Bool	IsCompositeObject () const

eC_Bool	LowerOneLevel (const CGUIObject *pkObject)

CGUICompositeObject &	operator= (const CGUICompositeObject &kSource)

eC_Bool	RaiseOneLevel (const CGUIObject *pkObject)

virtual void	ReadFromStream ()

virtual void	RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const

void	RemoveAllChildren ()

virtual void	RemoveObject (CGUIObject *pkObject)

void	Rotate (const eC_UInt &ruiDegrees, const eC_Bool &rbFirst=false)

eC_Bool	SendToBack (const CGUIObject *pkObject)

virtual void	SetClickThrough (const eC_Bool &bClickThrough)

virtual void	SetClickThrough (const eC_Bool &bClickThrough, const eC_Bool &bChildrenClickThrough)

void	SetCyclicFocus (const eC_Bool &bCyclicFocus)

virtual void	SetDisabled (const eC_Bool &bDisabled)

virtual void	SetDisabled (const eC_Bool &bDisabled, const eC_Bool &bChildrenDisabled)

virtual void	SetFocussable (const eC_Bool &bFocussable)

virtual void	SetFocussable (const eC_Bool &bFocussable, const eC_Bool &bChildrenFocussable)

virtual void	SetGrayedOut (const eC_Bool &bGrayedOut)

virtual void	SetGrayedOut (const eC_Bool &bGrayedOut, const eC_Bool &bChildrenGrayedOut)

virtual void	SetHeight (const eC_Value &vY)

virtual void	SetInvisible (const eC_Bool &bInvisible)

virtual void	SetInvisible (const eC_Bool &bInvisible, const eC_Bool &bChildrenInvisible)

virtual void	SetWidth (const eC_Value &vX)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUIObject
	CGUIObject ()

	CGUIObject (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIObject (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)

	CGUIObject (const CGUIObject &kSource)

virtual	~CGUIObject ()

void	AddValueObserver (CGUIObserver *pkObserver)

eC_Bool	CalculateInvalidatedRect (CGUIRect &rRect) const

virtual eC_Bool	ClaimFocus ()

virtual void	CreateSnapshot (eC_UInt uiBackColor=0x00)

eC_Bool	DataPoolConnectorExists () const

void	DeleteSnapshot ()

virtual void	DisableSnapshotDrawing (eC_Bool bDeleteSnapshot=true)

virtual eC_Bool	DoDraw ()

virtual eC_Bool	DoDrawSnapshot ()

virtual void	EnableSnapshotDrawing ()

virtual CGUIObject *	FindObject (const eC_Value &vAbsX, const eC_Value &vAbsY)

virtual eC_Bool	FocusAny ()

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)

CGUIRect	GetAbsRect () const

eC_Value	GetAbsXPos () const

eC_Value	GetAbsXPosCenter () const

eC_Value	GetAbsXPosREdge () const

eC_Value	GetAbsYPos () const

eC_Value	GetAbsYPosBEdge () const

eC_Value	GetAbsYPosCenter () const

eC_UByte	GetAlpha () const

CGUIBehaviourDecorator *	GetBehaviour ()

const CGUIBehaviourDecorator *	GetBehaviour () const

GUIBitmapPlaneID_t	GetBitmapID () const

CGUIBitmapPlane &	GetBitmapPlane () const

CGUIRect	GetCurrentAbsRect () const

eC_Value	GetCurrentAbsXPos () const

eC_Value	GetCurrentAbsXPosCenter () const

eC_Value	GetCurrentAbsXPosREdge () const

eC_Value	GetCurrentAbsYPos () const

eC_Value	GetCurrentAbsYPosBEdge () const

eC_Value	GetCurrentAbsYPosCenter () const

CDataPoolConnector &	GetDataPoolConnector ()

eC_Value	GetDistanceBottom () const

eC_Value	GetDistanceRight () const

eC_Value	GetHalfHeight () const

eC_Value	GetHalfWidth () const

eC_Value	GetHeight () const

ObjectHandle_t	GetID () const

CGUILayouter *	GetLayouter ()

const CGUILayouter *	GetLayouter () const

ObjectHandle_t	GetNeighborBottomID () const

ObjectHandle_t	GetNeighborLeftID () const

ObjectHandle_t	GetNeighborRightID () const

ObjectHandle_t	GetNeighborTopID () const

CGUIObject *	GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)

const CGUIObject *	GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const

CGUIRect	GetOriginRect () const

CGUICompositeObject *	GetParent ()

const CGUICompositeObject *	GetParent () const

CGUIRect	GetRelRect () const

eC_Value	GetRelXPos () const

eC_Value	GetRelXPosCenter () const

eC_Value	GetRelXPosREdge () const

eC_Value	GetRelYPos () const

eC_Value	GetRelYPosBEdge () const

eC_Value	GetRelYPosCenter () const

eC_Value	GetWidth () const

void	InvalidateArea ()

eC_Bool	IsClickable () const

eC_Bool	IsClickThrough () const

virtual eC_Bool	IsCompositeObject () const

eC_Bool	IsDescendantOf (const CGUIObject *const pAncestor) const

eC_Bool	IsDisabled () const

eC_Bool	IsDragable () const

eC_Bool	IsDragged () const

eC_Bool	IsDrawingSnapshot () const

eC_Bool	IsFocussable () const

eC_Bool	IsFocussed () const

eC_Bool	IsGrayedOut () const

virtual eC_Bool	IsHighlightable () const

eC_Bool	IsHighlighted () const

eC_Bool	IsInvisible () const

eC_Bool	IsPressed () const

eC_Bool	IsStopFocus () const

void	NotifyValueObservers (const CGUIValue &kValue, const eC_UInt uiX=0, const eC_UInt uiY=0)

CGUIObject &	operator= (const CGUIObject &kSource)

virtual void	ReadFromStream ()

virtual void	RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const

void	RemoveValueObserver (CGUIObserver *pkObserver)

void	RenderToBitmap (eC_UInt uiBitmapID, eC_Value vXOffset=eC_FromInt(0), eC_Value vYOffset=eC_FromInt(0))

eC_Bool	RequestFocus ()

void	SetAlpha (eC_UByte ubAlpha)

void	SetBehaviour (CGUIBehaviourDecorator *pkBehaviour)

void	SetClickThrough (const eC_Bool &bClickThrough)

virtual void	SetDisabled (const eC_Bool &bDisabled)

virtual void	SetFocussable (const eC_Bool &bFocussable)

virtual void	SetGrayedOut (const eC_Bool &bGrayOut)

virtual void	SetHeight (const eC_Value &vY)

void	SetID (const ObjectHandle_t &eID)

virtual void	SetInvisible (const eC_Bool &bInvisible)

void	SetLayouter (CGUILayouter *pLayouter)

void	SetNeighborBottomID (const ObjectHandle_t eNewNeighborBottomID)

void	SetNeighborIDs (const ObjectHandle_t eNewNeighborLeftID, const ObjectHandle_t eNewNeighborRightID, const ObjectHandle_t eNewNeighborTopID, const ObjectHandle_t eNewNeighborBottomID)

void	SetNeighborLeftID (const ObjectHandle_t eNewNeighborLeftID)

void	SetNeighborRightID (const ObjectHandle_t eNewNeighborRightID)

void	SetNeighborTopID (const ObjectHandle_t eNewNeighborTopID)

virtual void	SetParent (CGUICompositeObject *const pkParent)

void	SetRelRect (const CGUIRect &kNewRect)

virtual void	SetRelXPos (const eC_Value &vX)

void	SetRelXPosCenter (const eC_Value &vXCenter)

void	SetRelXPosREdge (const eC_Value &vX)

virtual void	SetRelYPos (const eC_Value &vY)

void	SetRelYPosBEdge (const eC_Value &vY)

void	SetRelYPosCenter (const eC_Value &vYCenter)

void	SetStopFocus (const eC_Bool &bDontFocusToParent)

virtual eC_Bool	SetValue (CDataPoolEntry &rkValue)

virtual eC_Bool	SetValue (const CGUIValue &rkValue)

virtual void	SetWidth (const eC_Value &vX)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUIBehaviour
virtual eC_Bool	DoUserEvent (CGUIEvent *const pEvent)

virtual void	OnCreate ()

virtual void	OnDelete ()

virtual void	OnHide ()

virtual void	OnShow ()

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=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoButtonUp (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoDrag (const eC_Value &vDeltaX=eC_FromInt(-1), const eC_Value &vDeltaY=eC_FromInt(-1), const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoDragEnd (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoMouseEnter (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoMouseLeave (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoMouseMove (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual void	GetFocus ()

virtual eC_Bool	Decrease ()

virtual eC_Bool	Increase ()

virtual eC_Bool	DoKeyUp (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)

Public Member Functions inherited from CGUIStreamableObject
const eC_String &	GetXMLTag () const

virtual void	ReadFromStream ()

void	SetXMLTag (const eC_String &kXMLTag)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUIAnimatable
virtual	~CGUIAnimatable ()
	Destructor. Removes all existing animation callbacks.

virtual void	DoAnimate (const eC_Value &vTimes=eC_FromInt(1))

virtual eC_Bool	IsAnimating () const

virtual void	StartAnimation ()

virtual void	StopAnimation ()

Public Member Functions inherited from CGUIColorPropertyObserver
	CGUIColorPropertyObserver ()
	default-constructor

	~CGUIColorPropertyObserver ()
	destructor

eC_UInt	AddColorProperty (const eC_Bool &bColorIsProperty, const eC_UInt &uiColorValue, const GlobalProperty_t &eColorProperty)

void	AddColorProperty (const eC_UInt &uiIndex, const eC_Bool &bColorIsProperty, const eC_UInt &uiColorValue, const GlobalProperty_t &eColorProperty)

ColorValue_t	GetColorProperty (const eC_UInt &uiIndex) const

eC_UInt	GetColorValue (const eC_UInt &uiIndex) const

virtual void	OnColorPropertyChange ()

virtual void	OnNotification ()
	Called by CGUISubject whenever an observed object triggers an update. More...

void	RemoveColorProperty (const eC_UInt &uiIndex)

void	SetColorProperty (const eC_UInt &uiIndex, const ColorValue_t &kColorValue)

void	SetColorProperty (const eC_UInt &uiIndex, const eC_UInt &uiColorValue)

void	SetColorProperty (const eC_UInt &uiIndex, const GlobalProperty_t &eColorProperty)

Public Member Functions inherited from CGUIObserver
	CGUIObserver ()
	Default constructor.

virtual	~CGUIObserver ()
	Default destructor. Notifies all subjects of destruction.

const eC_TListDoubleLinked< CGUISubject * > &	GetSubjectList () const

virtual void	OnNotification ()
	Called by CGUISubject whenever an observed object triggers an update. More...

virtual void	OnNotification (const CGUIObject *const pkUpdatedObject)

virtual void	OnNotification (const CGUIValue &kObservedValue, const CGUIObject *const pkUpdatedObject, const eC_UInt uiX=0, const eC_UInt uiY=0)

virtual void	OnNotification (const eC_String &kMessage)

void	SetAutoDelete (const eC_Bool bAutoDelete)

Protected Member Functions
virtual eC_Bool	DoClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual void	RemoveObject (CGUIObject *pkObject)

Protected Member Functions inherited from CGUICompositeObject
virtual eC_Bool	FourWayNext (FourWayFocus_t eFocusDirection)

ObjectPtrList &	GetChildObjectsList ()

virtual void	HandleDraw (const CGUIRect &ClipRect)

Protected Member Functions inherited from CGUIObject
virtual eC_Bool	CreateBitmapPlane ()

virtual eC_Bool	FourWayNext (FourWayFocus_t eFocusDirection)

Protected Member Functions inherited from CGUIStreamableObject
eC_UInt	ReadStreamingHeader (const eC_UInt &uiClassVersion, const eC_UInt &uiClassMinVersion=0) const

void	WriteStreamingFooter (const eC_Bool &bWriteClassID) const

void	WriteStreamingHeader (const eC_Bool &bWriteClassID, const eC_Char *const pkClassIDTag, const eC_Int &iClassID, const eC_UInt &uiClassVersion) const

Protected Member Functions inherited from CGUIObserver
virtual void	AddSubject (CGUISubject *pSubjectToAdd)

virtual void	RemoveSubject (CGUISubject *pSubjectToRemove)

Additional Inherited Members
Static Public Attributes inherited from CGUICompositeObject
static const eC_Char	XMLTAG_CHILDREN []
	XML comment tag to be used before writing children to a stream.

static const eC_Char	XMLTAG_ENDCHILDREN []
	XML comment tag to be used after writing children to a stream.

Static Public Attributes inherited from CGUIObject
static const eC_Char	XMLTAG_ALPHA []
	XML tag to be used writing alpha-value into a stream.

static const eC_Char	XMLTAG_CLICKTHROUGH []
	XML tag to be used writing clickthrough-state into a stream.

static const eC_Char	XMLTAG_CONTROLCLASSID []
	XML tag to be used when writing a control class ID into a stream.

static const eC_Char	XMLTAG_DISABLED []
	XML tag to be used writing disabled-state into a stream.

static const eC_Char	XMLTAG_FOCUSSABLE []
	XML tag to be used writing focussable-state into a stream.

static const eC_Char	XMLTAG_GRAYEDOUT []
	XML tag to be used writing grayedout-state into a stream.

static const eC_Char	XMLTAG_HEIGHT []
	XML tag to be used writing height into a stream.

static const eC_Char	XMLTAG_INVISIBLE []
	XML tag to be used writing invisible-state into a stream.

static const eC_Char	XMLTAG_OBJECTID []
	XML tag to be used writing object id into a stream.

static const eC_Char	XMLTAG_OVERRIDDENNEIGHBORS []
	XML tag to be used writing overridden neighbors into a stream.

static const eC_Char	XMLTAG_WIDTH []
	XML tag to be used writing width into a stream.

static const eC_Char	XMLTAG_XPOS []
	XML tag to be used writing x-position into a stream.

static const eC_Char	XMLTAG_YPOS []
	XML tag to be used writing y-position into a stream.

Static Public Attributes inherited from CGUIBehaviour
static const eC_Char	XMLTAG_BEHAVIOURCLASSID []
	XML tag to be used when writing a behaviour class ID into a stream.

Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char	XMLTAG_CLASSVERSION []

Detailed Description

Class for construction of a combo box control.

The "combo box" control consists of a scrollable list combined with an input field. The list portion of the combo box may be displayed unfold or fold when the user selects the drop-down button next to the control. The "combo box" can be used for e.g., drop-down selection lists (Class: CGUIComboBox).

A combo box consists of a scrollable list combined with an input field as header that is either editable or not. The list portion of the control may be displayed dropped down or dropped up when the user selects the drop-down button next to the control. The currently selected item (if any) in the list is displayed. In addition, if the user types a character in the header, the list box is opened. If the type of combo box is to insert an input string, a new item is created and inserted to the list. After the combo box is opened, the next item is selected that matches that initial string in the header. The list is implemented using CGUIListBox class and the header is implemented with CGUIComboBoxHeader.

The combo box has two possible layouts, either the list is under header or above the header. The layout is decided automatically according to the space under the header or above the header. If there is enough space under header, the combo box has the layout of having list box under header, otherwise it checks whether there is enough space above header. It there is, then it turns out to have the list box above header.

The height of the combo box is adjusted according to the items that are inserted into the list box. If there is any change affect the height of the combo box, the height of the combo box is adjusted automatically.

It is possible to open or close the list box if the user clicks the drop-down button in the header. The list will also be opened when the user types character in the editable input field. The item can be selected into the combo box by clicking the item in the list box or pressing the GK_ACTION key if the selected item in the list box is focused.

The items in the combo box can be inserted by AddItem and removed by RemoveItem methods.

Key events are handled as follows:

If the drop down button is focused and the GK_ACTION key is pressed, the list is opened and the selected item is focused.
Entering characters in the header (if it is set to editable) will either search for an entry in the listbox which matches the entered search-string (if mode is INPUT_SEARCHED) or create a new entry within the ListBox (if mnode is INPUT_INSERTED).
If the user hits the GK_ACTION key while focusing an entry in the listbox, the respective entry is selected and the text of header bar is updated accordingly. The list is then closed.
Pressing GK_ESCAPE key closes the list, if is currently open.

It is possible to execute a user callback after an item is selected into header.

Example:

// Create a combo box
CGUIComboBox *pComboBox = new CGUIComboBox(&GETGUI, eC_FromInt(100), eC_FromInt(40), eC_FromInt(110), eC_FromInt(20), eC_FromInt(20));
// Create some dummy content
const eC_Char* kContent[] = { "Earth", "Mars", "Venus", "Jupiter", "Saturn" };
for (int i=0;i<5;i++)
{
CGUIListItem * pListItem = new CGUIListItem(NULL, 0, 0, eC_FromInt(80), eC_FromInt(20), kContent[i]);
// Modify the newly created item's label
pListItem->GetLabel()->SetAligned(CGUIText::V_CENTERED);
pListItem->GetLabel()->SetTextColor(0xff000000, 0xffffffff, 0xff000000, 0xffffffff);
// Add it to the ComboBox
pComboBox->AddItem(pListItem);
}
// Set some visualization parameters. (e.g. Colors and Images)
pComboBox->SetItemSelectedColor(0xff0000cc);
pComboBox->SetHeaderButtonImages(
IMG_STDCTRL_IMGBTN_STANDARD,
IMG_STDCTRL_IMGBTN_PRESSED,IMG_STDCTRL_IMGBTN_HIGHLIGHTED,
IMG_STDCTRL_IMGBTN_GRAYED_OUT,IMG_STDCTRL_IMGBTN_FOCUSED);
pComboBox->GetHeader()->SetInputFieldImages(
IMG_STDCTRL_INPUTFIELD_STANDARD,
IMG_STDCTRL_INPUTFIELD_HIGHLIGHTED,
IMG_STDCTRL_INPUTFIELD_FOCUSSED,
IMG_STDCTRL_INPUTFIELD_GRAYEDOUT);
// Select an item by index
pComboBox->SetSelection(2);
// Make the comboxbox-header editable, so that users can enter a search-string
pComboBox->SetHeaderEditable(true);

Member Enumeration Documentation

◆ InputActionType_t

enum CGUIComboBox::InputActionType_t

Decide whether the input string in the header is taken as an element or the input string is just searched in the list and the most matched element is selected into header.

Enumerator
INPUT_INSERTED	The input string is inserted to the list after the user finishes typing.
INPUT_SEARCHED	The typed input string is searched and the matched string is selected into header.

Constructor & Destructor Documentation

◆ CGUIComboBox() [1/2]

CGUIComboBox::CGUIComboBox ( )

CGUIComboBox standard constructor.

See also: CGUICompositeObject().

◆ CGUIComboBox() [2/2]

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`
	)

CGUIComboBox constructor.

Parameters

pkParent	Pointer to the designated parent object.
vX	X-position relative to its parent object
vY	Y-position of the combo box left top corner of the header relative to the combo box's parent object
vWidth	Width of the composite object
vHeight	The height of the combo box when it is closed. It equals to the height of the header.
vHeaderButtonWidth	the width of the header button.
eID	Object Identifier of this composite object (choose NO_HANDLE if none is required)

Member Function Documentation

◆ AddItem() [1/2]

eC_Bool CGUIComboBox::AddItem	(	CGUIListItem *	pItem,
		eC_Bool	bIsAutoAdjustArrange = `true`
	)

Add an item to the container object of this list box. The height of the combo box is automatically adjusted if desired.

Parameters

pItem	Pointer to the item which will be added to the container object's childlist and the item list of this class.
bIsAutoAdjustArrange	Flag to enable and disable the autoadjust. Defaults to true = enable autoadjust.

Returns: True if the object was added, otherwise False.

◆ AddItem() [2/2]

eC_Bool CGUIComboBox::AddItem	(	const eC_String &	kText,
		eC_Bool	bIsAutoAdjustArrange = `true`
	)

Add an item to the container object of this list box. The height of the combo box is automatically adjusted if desired.

Parameters

kText	Text which shall be shown on the new item
bIsAutoAdjustArrange	Flag to enable and disable the autoadjust. Defaults to true = enable autoadjust.

Returns: true if the object was added, otherwise false.

◆ AdjustComboBox()

void CGUIComboBox::AdjustComboBox ( )

Arranges the entries of the combo box vertically. Call this method after adding or removing entries without activated auto adjustment.

See also: AddItem() and RemoveItem()

◆ Close()

virtual void CGUIComboBox::Close ( )

virtual

Closes the combo box by setting its drop-down list invisible. The focus is transferred to the header. The height of the combo box is changed to be same as the header.

If the combo box is not open, this method does nothing.

◆ DoChar()

virtual eC_Bool CGUIComboBox::DoChar	(	const eC_UInt &	uiKey,
		const GUIKeyIdentifier_t &	eKeyIdentifier,
		const eC_UInt &	uiModifiers
	)

virtual

If the ComboBox is configured to run in mode INPUT_SEARCHED, then incoming character events will be used to search the entries of the Listbox for matches. If a matching entry is found, it will automatically be selected.

Parameters

uiKey	The keycode.
eKeyIdentifier	The Guiliani key identifier.
uiModifiers	The key modifiers bitfield.

Returns: Always false

Reimplemented from CGUIBehaviour.

◆ DoClick()

virtual eC_Bool CGUIComboBox::DoClick	(	const eC_Value &	vAbsX = `eC_FromInt(-1)`,
		const eC_Value &	vAbsY = `eC_FromInt(-1)`
	)

protectedvirtual

Handle the event after user clicks the control. If the button is clicked, the list box is opened and the selected item gets the focused or closed. If an item in the list box is clicked, the item is selected and the text of the item is set into the header. If a command is available, it is executed.

Parameters

vAbsX	X-position in screen coordinates where the click occurred
vAbsY	Y-position in screen coordinates where the click occurred

Returns: True The event has been handled.
False The event has not been handled.

Reimplemented from CGUIBehaviour.

◆ DoDraw()

virtual eC_Bool CGUIComboBox::DoDraw ( )

virtual

Reimplemented to fill the control with background color. If multiple selection mode is set, it draws the dragged frame.

Returns: True if something was painted, otherwise False.

Reimplemented from CGUIObject.

◆ DoKeyDown()

virtual eC_Bool CGUIComboBox::DoKeyDown	(	const GUIKeyIdentifier_t &	eKeyID,
		const eC_UInt &	uiModifiers
	)

virtual

Close the combobox in reaction to GK_ESCAPE events.

Parameters

eKeyID	The Guiliani key identifier.
uiModifiers	The key modifiers bitfield.

Returns: True if the combobox was closed.

Reimplemented from CGUIBehaviour.

◆ DoUserEvent()

virtual eC_Bool CGUIComboBox::DoUserEvent ( CGUIEvent *const pEvent )

virtual

Close the combobox if the user clicks anywhere outside of the ComboBox

Parameters

pEvent The event to process

Returns: always false

Reimplemented from CGUIBehaviour.

◆ FindItem()

eC_Int CGUIComboBox::FindItem ( const eC_String & kItemStr ) const

Find the item index with the given item string.

Parameters

kItemStr The given item string that should be found.

Returns: The index of the found item, or -1 if no item was found.

◆ FocusAny()

eC_Bool CGUIComboBox::FocusAny ( )

virtual

FocusAny will call FocusSelectedItem internally.

Returns: False if no item was selected, otherwise it returns the result of RequestFocus() on the selected item.

Reimplemented from CGUIObject.

◆ FocusSelectedItem()

eC_Bool CGUIComboBox::FocusSelectedItem ( )

This will focus the currently selected item within the listbox (if any)

Returns: False if no item was selected. Otherwise it returns the result of RequestFocus() on the selected item.

◆ GetForceVisible()

eC_Bool CGUIComboBox::GetForceVisible ( ) const

Check if Force Visible is currently active

Returns: true if set

◆ GetFrameBorderColor()

eC_UInt CGUIComboBox::GetFrameBorderColor ( ) const

Return the currently set color for the frame-boder

Returns: color

◆ GetHeader()

CGUIComboBoxHeader * CGUIComboBox::GetHeader ( ) const

Returns the ComboBoxHeader

Returns: combobox-header

◆ GetHeaderLabel()

CGUIEditableText * CGUIComboBox::GetHeaderLabel ( ) const

Get the label of the header . Use this to obtain a pointer to the internal text for formatting etc.

Returns: Pointer to the internal text label.

◆ GetHeaderText()

eC_String CGUIComboBox::GetHeaderText ( ) const

Get the text that is currently displayed in the header.

Returns: The header text.

◆ GetInputActionType()

InputActionType_t CGUIComboBox::GetInputActionType ( ) const

Get the input action type of the combo box.

Returns: The active input action type.

◆ GetItem()

CGUIListItem * CGUIComboBox::GetItem ( eC_UInt uiIndex ) const

Get item in the list box by given index.

Parameters

uiIndex The given index.

Returns: The list item corresponds to the index.

◆ GetItemCount()

eC_UInt CGUIComboBox::GetItemCount ( ) const

Get the number of the items that are in the item list.

Returns: count of items in the list.

◆ GetListBox()

CGUIListBox * CGUIComboBox::GetListBox ( ) const

Returns the ListBox pointer.

Returns: GUIListBox pointer.

◆ GetPreviousSelection()

eC_String CGUIComboBox::GetPreviousSelection ( ) const

Get the previously selected item string.

Returns: The previsouly selected item string.

◆ GetSelectedItemStr()

eC_String CGUIComboBox::GetSelectedItemStr ( ) const

Get the item string of the selected item.

Returns: The string related to the selected item in the combo box.

◆ GetSelectedTextColor()

eC_UInt CGUIComboBox::GetSelectedTextColor ( ) const

Get the color currently used as the background for selected text.

Returns: the selected text color.

See also: CGUIBaseInputField::GetSelectedTextColor()

◆ GetSelection()

eC_Int CGUIComboBox::GetSelection ( ) const

Get the current selected item index.

Returns: The index of the currently selected item or -1 if no selection

◆ IsOpen()

eC_Bool CGUIComboBox::IsOpen ( ) const

Check whether the combo box is open.

Returns: True if it is open; otherwise False.

◆ LoseFocus()

virtual void CGUIComboBox::LoseFocus ( )

virtual

After the combo box loses focus and the focused object is not the descendant of this combo box, we close this combo box.

Reimplemented from CGUIBehaviour.

◆ OnNotification()

virtual void CGUIComboBox::OnNotification	(	const CGUIValue &	kObservedValue,
		const CGUIObject *const	pkUpdatedObject,
		const eC_UInt	uiX = `0`,
		const eC_UInt	uiY = `0`
	)

virtual

Observes CGUIComboBoxHeader to get informed if input finished.

Parameters

kObservedValue	The update observed value.
pkUpdatedObject	The observed object.
uiX	X-Index Additional X-Index in case the updated value is part of a multidimensional array
uiY	Y-Index Additional Y-Index in case the updated value is part of a multidimensional array

Reimplemented from CGUIObserver.

◆ Open()

virtual void CGUIComboBox::Open ( )

virtual

Opens the combo box by setting its drop-down list visible. It also determines the opening direction of the combo box according to the location and height of all parents to avoid clipping of the opened list box. It also selects an item in the list. The item is chosen either by exactly matching the current header text or by searching for the first item containing the current header text.

If the list box is empty (no combo box items present), the box is never opened.

◆ ReadFromStream()

virtual void CGUIComboBox::ReadFromStream ( )

virtual

Reads composite object attributes and children from stream.

Reads attributes from the streaming file. Only for use with GUIFactoryManager.

See also: CGUIObject::ReadFromStream()

Exceptions

CGUIStreamingControlException When catching a CGUIStreamingControlException from a child, this method adds the object from the exception, resets the object pointer to 'this', then re-throws.

Reimplemented from CGUICompositeObject.

◆ RemoveItem() [1/2]

eC_Bool CGUIComboBox::RemoveItem	(	CGUIListItem *	pItem,
		eC_Bool	bIsAutoAdjustArrange = `true`
	)

Removes an item from the scrolled container. The height of the combo box is automatically adjusted if desired. Objects are removed from the internal container of scrolled objects and the item list.

Parameters

pItem	Item to be removed.
bIsAutoAdjustArrange	Flag to enable and disable the autoadjust. Defaults to true = enable autoadjust.

Returns: True if the item was removed, otherwise False.

◆ RemoveItem() [2/2]

eC_Bool CGUIComboBox::RemoveItem	(	const eC_String &	kItemStr,
		eC_Bool	bIsAutoAdjustArrange = `true`
	)

Removes an item with given item string from the scrolled container. Objects are removed from the internal container of scrolled objects and the item list. If there are more than one items with same text, only the first item is removed. The height of the combo box is automatically adjusted if necessary.

Parameters

kItemStr	The given item string.
bIsAutoAdjustArrange	Flag to enable and disable the autoadjust. Defaults to true = enable autoadjust.

Returns: True if there is one item is removed, otherwise False.

◆ RemoveObject()

virtual void CGUIComboBox::RemoveObject ( CGUIObject * pkObject )

protectedvirtual

Overridden to NULL internal object pointers in case the Header or List gets destroyed

Parameters

pkObject object to remove

Reimplemented from CGUICompositeObject.

◆ RemoveSelectionObserver()

void CGUIComboBox::RemoveSelectionObserver ( CGUIObserver * pObserver )

Unsubscribe a selection observer.

Parameters

pObserver The Observer that wants to unsubscribe.

◆ Reset()

void CGUIComboBox::Reset ( )

Removes all list items and the header text. The height of the combo box is automatically adjusted if necessary.

◆ SetCommand()

void CGUIComboBox::SetCommand ( CGUICommandPtr pkCommand )

Attaches a command to this control. This command is executed whenever one of the items is selected into the header.

Parameters

pkCommand The command to attach to this control.

◆ SetDisabled()

void CGUIComboBox::SetDisabled ( const eC_Bool & bDisabled )

virtual

Toggle Disabled state of the combo box.

Parameters

bDisabled Defines if the combo box is disabled out or not.

Reimplemented from CGUICompositeObject.

◆ SetForceVisible()

void CGUIComboBox::SetForceVisible ( const eC_Bool & bForceVisible )

Force Listbox to be visible when opening. This may be needed, if the height of the current parent is not high enough to fit even one line. On opening the parent is changed and on closing set back to original parent.

Parameters

bForceVisible

◆ SetFrameBorderColor() [1/2]

void CGUIComboBox::SetFrameBorderColor ( const eC_UInt & uiFrameBorderColor )

Set the frame border color around the list box.

Parameters

uiFrameBorderColor The frame border color.

◆ SetFrameBorderColor() [2/2]

void CGUIComboBox::SetFrameBorderColor ( const GlobalProperty_t & eFrameBorderColor )

Set the frame border color around the list box.

Parameters

eFrameBorderColor The frame border color.

◆ SetFrameBorderWidth()

void CGUIComboBox::SetFrameBorderWidth ( const eC_Value & vFrameBorderWidth )

Set the frame border width around the list box. The list box's width, height, position, the header's position and the height of the combo box may also be adjusted.

Parameters

vFrameBorderWidth The frame border width.

◆ SetGrayedOut()

void CGUIComboBox::SetGrayedOut ( const eC_Bool & bGrayedOut )

virtual

Toggle GrayedOut state of the combo box.

Parameters

bGrayedOut Defines if the combo box is grayed out or not.

Reimplemented from CGUICompositeObject.

◆ SetHeaderButtonImages()

void CGUIComboBox::SetHeaderButtonImages	(	const ImageResource_t &	eBtnStandard,
		const ImageResource_t &	eBtnPressed,
		const ImageResource_t &	eBtnHighlighted,
		const ImageResource_t &	eBtnGrayedOut,
		const ImageResource_t &	eBtnFocused
	)		const

Sets the images of the drop-down button in the header. Directly passed to CGUIComboBoxHeader::SetButtonImages.

Parameters

eBtnStandard	Image used when in normal state
eBtnPressed	Image used when in pressed state
eBtnHighlighted	Image used when in highlighted state
eBtnGrayedOut	Image used when in grayed-out state
eBtnFocused	Image used when in focused state

◆ SetHeaderButtonWidth()

void CGUIComboBox::SetHeaderButtonWidth ( const eC_Value & vHeaderButtonWidth ) const

Set the width of the header button.

Parameters

vHeaderButtonWidth The width of the header button.

◆ SetHeaderEditable()

void CGUIComboBox::SetHeaderEditable ( const eC_Bool & bEditable ) const

Set the header as editable or not.

Parameters

bEditable

◆ SetHeaderSelectedTextColor()

void CGUIComboBox::SetHeaderSelectedTextColor ( eC_UInt uiCol ) const

Sets the color used as the background for selected text.

Parameters

uiCol The selected text color.

See also: CGUIBaseInputField::SetSelectedTextColor()

◆ SetHeaderText()

void CGUIComboBox::SetHeaderText ( const eC_String & kStr ) const

Set the string for the header.

Parameters

kStr	New text for the header.

◆ SetHeight()

virtual void CGUIComboBox::SetHeight ( const eC_Value & vHeight )

virtual

Changes the height of the combo box when it is closed. The height of header is also changed to be the given height.

Parameters

vHeight The new height.

Reimplemented from CGUICompositeObject.

◆ SetInputActionType()

void CGUIComboBox::SetInputActionType ( const InputActionType_t & eInputActionType )

Set the input action type for the combo box.

Parameters

eInputActionType The input action type.

◆ SetItemSelectedColor()

void CGUIComboBox::SetItemSelectedColor ( eC_UInt uiItemSelectedColor ) const

Set the color for the selected item. Directly passed to CGUIListBox::SetItemSelectedColor.

Parameters

uiItemSelectedColor Background color for selected items.

◆ SetLabel()

void CGUIComboBox::SetLabel ( CGUIEditableText * pkText ) const

Changes the internal text. This call is directly passed through to CGUIHeader::SetLabel.

Parameters

pkText The new text to be used by the internal edit control of the header.

◆ SetSelection()

void CGUIComboBox::SetSelection ( eC_Int iIndex )

Set the selected item. This call is directly passed to CGUIListBox::SetSelection.

Parameters

iIndex Index of the item to be selected.

◆ SetValue() [1/2]

virtual eC_Bool CGUIComboBox::SetValue ( CDataPoolEntry & rkValue )

virtual

If the given DataPoolEntry contains an array of values, they will be added into the List of the CGUIComboBox. If it contains a single value, it will be entered into the Header of the CGUIComboBox.

See also: AddItem(), SetHeaderText()

Parameters

rkValue The DataPoolEntry containing the new value(s)

Returns: Always True.

Reimplemented from CGUIObject.

◆ SetValue() [2/2]

virtual eC_Bool CGUIComboBox::SetValue ( const CGUIValue & rkValue )

virtual

Sets the text within the Header of the CGUIComboBox.

See also: SetHeaderText()

Parameters

rkValue The CGUIValue containing the new value

Returns: Always True.

Reimplemented from CGUIObject.

◆ SetWidth()

virtual void CGUIComboBox::SetWidth ( const eC_Value & vWidth )

virtual

Calls the base class implementation and sets the children's width to the proper value. The width of items and list box is adjusted too.

Parameters

vWidth The new width.

Reimplemented from CGUICompositeObject.

◆ WriteToStream()

virtual void CGUIComboBox::WriteToStream ( const eC_Bool bWriteClassID = false )

virtual

Writes all object attributes to the streaming file. StreamWriter has to be initialized. Only for use with GUIStreamWriter.

Parameters

bWriteClassID This flag is used to select if writing of ControlID, leading and trailing tags is performed. Only GUIStreamWriter and GUICompositeObject have to set this flag true.

See also: CGUIStreamWriter

Reimplemented from CGUICompositeObject.

The documentation for this class was generated from the following file:

GUIComboBox.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ InputActionType_t

Constructor & Destructor Documentation

◆ CGUIComboBox() [1/2]

◆ CGUIComboBox() [2/2]

Member Function Documentation

◆ AddItem() [1/2]

◆ AddItem() [2/2]

◆ AdjustComboBox()

◆ Close()

◆ DoChar()

◆ DoClick()

◆ DoDraw()

◆ DoKeyDown()

◆ DoUserEvent()

◆ FindItem()

◆ FocusAny()

◆ FocusSelectedItem()

◆ GetForceVisible()

◆ GetFrameBorderColor()

◆ GetHeader()

◆ GetHeaderLabel()

◆ GetHeaderText()

◆ GetInputActionType()

◆ GetItem()

◆ GetItemCount()

◆ GetListBox()

◆ GetPreviousSelection()

◆ GetSelectedItemStr()

◆ GetSelectedTextColor()

◆ GetSelection()

◆ IsOpen()

◆ LoseFocus()

◆ OnNotification()

◆ Open()

◆ ReadFromStream()

◆ RemoveItem() [1/2]

◆ RemoveItem() [2/2]

◆ RemoveObject()

◆ RemoveSelectionObserver()

◆ Reset()

◆ SetCommand()

◆ SetDisabled()

◆ SetForceVisible()

◆ SetFrameBorderColor() [1/2]

◆ SetFrameBorderColor() [2/2]

◆ SetFrameBorderWidth()

◆ SetGrayedOut()

◆ SetHeaderButtonImages()

◆ SetHeaderButtonWidth()

◆ SetHeaderEditable()

◆ SetHeaderSelectedTextColor()

◆ SetHeaderText()

◆ SetHeight()

◆ SetInputActionType()

◆ SetItemSelectedColor()

◆ SetLabel()

◆ SetSelection()

◆ SetValue() [1/2]

◆ SetValue() [2/2]

◆ SetWidth()

◆ WriteToStream()