Inheritance diagram for iWidgetListBox:

Detailed Description

Listbox widget interface.

Public Member Functions
virtual void	ClearColumns ()=0
	Remove all columns. More...

virtual void	AddColumn (const achar *aaszName, tU32 anSize)=0
	Add a column with the specified name and size. More...

virtual tBool	RemoveColumn (tU32 anColumn)=0
	Remove the specified columns. More...

virtual tU32	GetNumColumns () const =0
	Get the number of columns in the list box. {Property}. More...

virtual tBool	SetColumnName (tU32 anColumn, const achar *aaszName)=0
	Set the name/header of the column. {Property}. More...

virtual const achar *	GetColumnName (tU32 anColumn) const =0
	Get the name/header of the column. {Property}. More...

virtual tBool	SetColumnWidth (tU32 anColumn, tU32 anWidth)=0
	Set the width of the specified column. {Property}. More...

virtual tU32	GetColumnWidth (tU32 anColumn) const =0
	Get the width of the specified column. {Property}. More...

virtual tU32	GetNumItems () const =0
	Get the number of items in the listbox. {Property}. More...

virtual void	ClearItems ()=0
	Remove all items in the list box. More...

virtual tU32	AddItem (const achar *aaszText)=0
	Add an item. More...

virtual tBool	RemoveItem (tU32 anItem)=0
	Remove an item. More...

virtual tBool	SetItemText (tU32 anColumn, tU32 anItem, const achar *aaszText)=0
	Set the text of an item element. More...

virtual const achar *	GetItemText (tU32 anColumn, tU32 anItem) const =0
	Get the text of an item element. More...

virtual tBool	SetItemWidget (tU32 anColumn, tU32 anItem, iWidget *apWidget)=0
	Set the widget of an item element. More...

virtual iWidget *	GetItemWidget (tU32 anColumn, tU32 anItem) const =0
	Get the widget of an item element. More...

virtual tBool	SetItemIcon (tU32 anItem, iOverlay *apIcon)=0
	Set the icon of an item. {Property}. More...

virtual iOverlay *	GetItemIcon (tU32 anItem) const =0
	Get the icon of an item. {Property}. More...

virtual tBool	SetItemData (tU32 anItem, iUnknown *apData)=0
	Set the data of an item. {Property}. More...

virtual iUnknown *	GetItemData (tU32 anItem) const =0
	Get the data of an item. {Property}. More...

virtual tBool	SetSortKey (tU32 anKeyColumn)=0
	Set the sorting key column. More...

virtual tU32	GetSortKey () const =0
	Get the sorting key column. More...

virtual void	SetSortAscendant (tBool abAscendant)=0
	Set whether to use ascendant or descendant sorting. More...

virtual tBool	GetSortAscendant () const =0
	Get whether to use ascendant or descendant sorting. {Property}. More...

virtual tU32	GetItemFromText (tU32 anColumn, const achar *aaszName) const =0
	Get the index of the first item that has the specified text in the specified column. More...

virtual void	ClearSelection ()=0
	Clear the selection. More...

virtual tBool	AddSelection (tU32 anItem)=0
	Add a selection. More...

virtual tBool	RemoveSelection (tU32 anItem)=0
	Remove a selection. More...

virtual tU32	GetNumSelections () const =0
	Get the number of selections. {Property}. More...

virtual tU32	GetSelection (tU32 anIndex) const =0
	Get the active selection at the specified index. {Property}. More...

virtual tBool	SetSelected (tU32 anSelection)=0
	Set all selections to the selection specified. More...

virtual tU32	GetSelected () const =0
	Get the first selection. {Property}. More...

virtual tBool	GetIsItemSelected (tU32 anItem) const =0
	Check if the specified item is selected. {Property}. More...

virtual tBool	AddSelectedItem (tU32 anCol, const achar *aaszText)=0
	Get the first item with the selected text in the specified column and add it to the selection. More...

virtual const achar *	GetSelectedItemText (tU32 anCol, tU32 anIndex) const =0
	Get the text in the column of the selection at the specified index. More...

virtual iWidget *	GetSelectedItemWidget (tU32 anCol, tU32 anIndex) const =0
	Get the widget in the column of the selection at the specified index. More...

virtual tBool	SetSelectedItem (tU32 anCol, const achar *aaszText)=0
	Get the first item with the selected text in the specified column and set it as the selection. {Property}. More...

virtual const achar *	GetSelectedItem (tU32 anCol) const =0
	Get the text in the specified column of the first selection. {Property}. More...

virtual tBool	SetItemHeight (tF32 afHeight)=0
	Set the height of an item. {Property}. More...

virtual tF32	GetItemHeight () const =0
	Get the height of an item. {Property}. More...

virtual void	AutoScroll ()=0
	Auto scroll to the selection or last item if no item is selected. More...

virtual tBool	SetItemTextColor (tU32 anColumn, tU32 anItem, tU32 anTextColor)=0
	Set the color of the text of the specified column/item. Set anColumn to eInvalidHandle to set all the columns at once. More...

virtual tU32	GetItemTextColor (tU32 anColumn, tU32 anItem) const =0
	Set the color of the text of the specified column/item. More...

virtual void	SetMaxNumItems (tU32 anMaxItems)=0
	Set the maximum number of items. More...

virtual tU32	GetMaxNumItems () const =0
	Get the maximum number of items. {Property}. More...

Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual void ClearColumns ( )

pure virtual

Remove all columns.

virtual void AddColumn	(	const achar *	aaszName,
		tU32	anSize
	)

pure virtual

Add a column with the specified name and size.

virtual tBool RemoveColumn ( tU32 anColumn )

pure virtual

Remove the specified columns.

virtual tU32 GetNumColumns ( ) const

pure virtual

Get the number of columns in the list box. {Property}.

virtual tBool SetColumnName	(	tU32	anColumn,
		const achar *	aaszName
	)

pure virtual

Set the name/header of the column. {Property}.

virtual const achar* GetColumnName ( tU32 anColumn ) const

pure virtual

Get the name/header of the column. {Property}.

virtual tBool SetColumnWidth	(	tU32	anColumn,
		tU32	anWidth
	)

pure virtual

Set the width of the specified column. {Property}.

virtual tU32 GetColumnWidth ( tU32 anColumn ) const

pure virtual

Get the width of the specified column. {Property}.

virtual tU32 GetNumItems ( ) const

pure virtual

Get the number of items in the listbox. {Property}.

virtual void ClearItems ( )

pure virtual

Remove all items in the list box.

virtual tU32 AddItem ( const achar * aaszText )

pure virtual

Add an item.

virtual tBool RemoveItem ( tU32 anItem )

pure virtual

Remove an item.

virtual tBool SetItemText	(	tU32	anColumn,
		tU32	anItem,
		const achar *	aaszText
	)

pure virtual

Set the text of an item element.

virtual const achar* GetItemText	(	tU32	anColumn,
		tU32	anItem
	)		const

pure virtual

Get the text of an item element.

virtual tBool SetItemWidget	(	tU32	anColumn,
		tU32	anItem,
		iWidget *	apWidget
	)

pure virtual

Set the widget of an item element.

virtual iWidget* GetItemWidget	(	tU32	anColumn,
		tU32	anItem
	)		const

pure virtual

Get the widget of an item element.

virtual tBool SetItemIcon	(	tU32	anItem,
		iOverlay *	apIcon
	)

pure virtual

Set the icon of an item. {Property}.

virtual iOverlay* GetItemIcon ( tU32 anItem ) const

pure virtual

Get the icon of an item. {Property}.

virtual tBool SetItemData	(	tU32	anItem,
		iUnknown *	apData
	)

pure virtual

Set the data of an item. {Property}.

virtual iUnknown* GetItemData ( tU32 anItem ) const

pure virtual

Get the data of an item. {Property}.

virtual tBool SetSortKey ( tU32 anKeyColumn )

pure virtual

Set the sorting key column.

Parameters

anKeyColumn is the column to use as key for sorting.

Returns: If the key index is invalid sorting is disabled, and false is returned. {Property}

virtual tU32 GetSortKey ( ) const

pure virtual

Get the sorting key column.

Returns: The current sort key column index. {Property}

virtual void SetSortAscendant ( tBool abAscendant )

pure virtual

Set whether to use ascendant or descendant sorting.

Parameters

abAscendant decide the sorting Mode. {Property}

virtual tBool GetSortAscendant ( ) const

pure virtual

Get whether to use ascendant or descendant sorting. {Property}.

virtual tU32 GetItemFromText	(	tU32	anColumn,
		const achar *	aaszName
	)		const

pure virtual

Get the index of the first item that has the specified text in the specified column.

virtual void ClearSelection ( )

pure virtual

Clear the selection.

virtual tBool AddSelection ( tU32 anItem )

pure virtual

Add a selection.

virtual tBool RemoveSelection ( tU32 anItem )

pure virtual

Remove a selection.

virtual tU32 GetNumSelections ( ) const

pure virtual

Get the number of selections. {Property}.

virtual tU32 GetSelection ( tU32 anIndex ) const

pure virtual

Get the active selection at the specified index. {Property}.

virtual tBool SetSelected ( tU32 anSelection )

pure virtual

Set all selections to the selection specified.

Remarks: This will set one active selection. {Property}

virtual tU32 GetSelected ( ) const

pure virtual

Get the first selection. {Property}.

virtual tBool GetIsItemSelected ( tU32 anItem ) const

pure virtual

Check if the specified item is selected. {Property}.

virtual tBool AddSelectedItem	(	tU32	anCol,
		const achar *	aaszText
	)

pure virtual

Get the first item with the selected text in the specified column and add it to the selection.

virtual const achar* GetSelectedItemText	(	tU32	anCol,
		tU32	anIndex
	)		const

pure virtual

Get the text in the column of the selection at the specified index.

virtual iWidget* GetSelectedItemWidget	(	tU32	anCol,
		tU32	anIndex
	)		const

pure virtual

Get the widget in the column of the selection at the specified index.

virtual tBool SetSelectedItem	(	tU32	anCol,
		const achar *	aaszText
	)

pure virtual

Get the first item with the selected text in the specified column and set it as the selection. {Property}.

virtual const achar* GetSelectedItem ( tU32 anCol ) const

pure virtual

Get the text in the specified column of the first selection. {Property}.

virtual tBool SetItemHeight ( tF32 afHeight )

pure virtual

Set the height of an item. {Property}.

Remarks: This is meant to be used to define the maximum size of controls embedded in the listbox.; The height will always be >= than the font height no matter what this value is.

virtual tF32 GetItemHeight ( ) const

pure virtual

Get the height of an item. {Property}.

virtual void AutoScroll ( )

pure virtual

Auto scroll to the selection or last item if no item is selected.

virtual tBool SetItemTextColor	(	tU32	anColumn,
		tU32	anItem,
		tU32	anTextColor
	)

pure virtual

Set the color of the text of the specified column/item. Set anColumn to eInvalidHandle to set all the columns at once.

virtual tU32 GetItemTextColor	(	tU32	anColumn,
		tU32	anItem
	)		const

pure virtual

Set the color of the text of the specified column/item.

virtual void SetMaxNumItems ( tU32 anMaxItems )

pure virtual

Set the maximum number of items.

Remarks: When the maximum number of items the items at the top of the list are removed, this is meant to be used for a log window or similar. {Property}

virtual tU32 GetMaxNumItems ( ) const

pure virtual

Get the maximum number of items. {Property}.

Detailed Description

Public Member Functions

Member Function Documentation