Gadget class. More...

#include <ilviews/gadgets/optmenu.h>

Inheritance diagram for IlvOptionMenu:

Public Member Functions
	IlvOptionMenu (IlvDisplay display, const IlvPoint &point, const char const labels=0, IlUShort count=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette palette=0)
	Constructor. More...

	IlvOptionMenu (IlvDisplay display, const IlvRect &rect, const char const labels=0, IlUShort count=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette palette=0)
	Constructor. More...

virtual IlvGadgetItem *	createItem (const char label, IlvGraphic g=0, IlvBitmap bitmap=0, IlvBitmap sbitmap=0, IlBoolean copy=IlTrue) const
	Returns a new gadget item. More...

virtual void	doIt ()
	Is called when an item is selected in the option menu. More...

virtual void	empty ()
	Empties the list. More...

const char *	getLabel () const
	Returns the label displayed in the option menu. More...

virtual IlvPalette *	getNormalTextPalette () const
	Returns the default palette used to draw an item. More...

virtual IlvPalette *	getOpaquePalette () const
	Returns the opaque palette used to draw opaque items. More...

IlvPopupMenu *	getSubMenu () const
	Returns a pointer to the menu object used by the option menu. More...

virtual void	recomputeAllItems ()
	Recomputes the size of all the items managed by the holder. More...

void	setSelected (IlShort index, IlBoolean redraw=IlFalse)
	Sets the selected item of the option menu. More...

IlShort	whichSelected () const
	Returns the index of the selected item. More...

Public Member Functions inherited from IlvListGadgetItemHolder
virtual void	addLabel (const char *label, IlAny data=0)
	Adds an item with a label to the holder list. More...

virtual IlvGadgetItem *	applyToItems (IlvApplyGadgetItem func, IlAny arg)
	Applies the specified function to all the items of the holder. More...

virtual int	compareItems (const char string1, const char string2, IlAny value1, IlAny value2)
	Compares a pair of items. More...

virtual void	deSelectAll ()
	Deselects all the items. More...

IlUShort	getCardinal () const
	Returns the number of items stored in this holder. More...

IlShort	getFirstSelectedItem () const
	Returns the index of the first selected item. More...

IlShort	getIndex (const IlvGadgetItem *item, IlUShort start=0, IlUShort stop=(IlUShort)-1) const
	Returns the index of the specified item in the holder list. More...

IlvGadgetItem *	getItem (IlUShort index) const
	Returns an item from its position in the holder. More...

IlAny	getItemData (IlUShort index) const
	Returns an item user data. More...

IlvGadgetItem const	getItems (IlUShort &count) const
	Returns the array of all the items. More...

const char *	getLabel (IlUShort index) const
	Returns the `i`^th label of the list. More...

const char const	getLabels (IlUShort &count) const
	Returns an array of all the items labels. More...

IlShort	getPosition (const char *label, IlUShort start=0) const
	Returns the position of an item using its label. More...

virtual const char *	getSelection () const
	Returns the first selected item label. More...

IlUShort const *	getSelectionIndices (IlUShort &count) const
	Returns an array containing the indexes of the selected item. More...

const char const	getSelections (IlUShort &count) const
	Returns an array of the selected items. More...

IlAny const *	getUserDataArray (IlUShort &count) const
	Returns an array of all the user data for the items. More...

IlUShort	insertBitmap (IlvBitmap *bitmap, IlShort pos=-1)
	Inserts an item with a bitmap at the given position in the holder list. More...

IlUShort	insertGraphic (IlvGraphic *graphic, IlShort pos=-1)
	Inserts an item with a graphic as picture at a given position in the holder list. More...

IlUShort	insertItem (IlvGadgetItem *item, IlShort index=-1)
	Inserts an item at a given position in the holder's list. More...

virtual void	insertLabel (IlUShort pos, const char *label, IlAny data=0)
	Inserts an item with a label at a given position in the holder list. More...

IlBoolean	isSelected (IlUShort index) const
	Specifies whether the item whose position is specified is selected. More...

void	removeItem (IlUShort index, IlBoolean destroy=IlTrue)
	Removes an item from the holder. More...

void	removeLabel (IlUShort index)
	Removes and destroys an item. More...

void	setItemData (IlUShort index, IlAny itemData)
	Sets an item user data. More...

virtual void	setItems (IlvGadgetItem const items, IlUShort count)
	Replaces the entire list of items. More...

void	setLabel (IlUShort index, const char *label, IlBoolean copy)
	Modifies the label of an item. More...

virtual void	setLabels (const char const labels, IlAny const *itemData, IlUShort count, IlBoolean copy=IlTrue)
	Replaces the entire list of items. More...

virtual void	setLabels (const char const labels, IlUShort count, IlBoolean copy=IlTrue)
	Replaces the entire list of items. More...

virtual void	sort (IlvListCompareFunction func=0)
	Sorts the items. More...

Public Member Functions inherited from IlvGadgetItemHolder
virtual void	drawGadgetItem (const IlvGadgetItem item, IlvPort port, const IlvRect &rect, const IlvTransformer t=0, const IlvRegion clip=0) const
	Draws a specific gadget item. More...

IlvGadgetItem *	getCallbackItem () const
	Returns the item that triggered a callback. More...

IlvGadgetItem *	getDragDropTarget () const
	Returns the target item of a drag-and-drop operation. More...

IlvGraphic *	getDraggedImage () const
	Returns the graphic object used to draw the ghost image during a drag-and-drop operation. More...

IlvGadgetItem *	getDraggedItem () const
	Returns the item that is being dragged during a drag-and-drop operation. More...

IlvGadgetItem *	getEditedItem () const
	Returns the item that is being edited. More...

virtual IlvPalette *	getHighlightTextPalette () const
	Returns the highlight palette used to draw the label of highlighted items. More...

virtual IlvGadgetItem *	getItemByName (const char *name) const
	Returns the item whose name is specified. More...

IlvGadgetItem *	getToolTipItem () const
	Returns the item that is displaying a tooltip. More...

virtual void	initReDrawItems ()
	Begins a redraw session. More...

virtual void	reDrawItems ()
	Ends a redraw session. More...

void	setDragDropTarget (IlvGadgetItem *item)
	Sets the target item of a drag-and-drop operation. More...

void	setDraggedImage (IlvGraphic *graphic)
	Sets the graphic object used to draw the ghost image during a drag-and-drop operation. More...

void	setDraggedItem (IlvGadgetItem *item)
	Sets the dragged item. More...

Friends
class	IlvDefaultOptionMenuLFHandler

class	IlvOptionMenuWLFHandler

Additional Inherited Members
Static Public Member Functions inherited from IlvGadgetItemHolder
static IlSymbol *	AbortDragItemCallbackType ()
	Returns the callback type of the Abort Drag callback. More...

static IlSymbol *	AbortEditItemCallbackType ()
	Returns the callback type of the Abort Edit callback. More...

static IlSymbol *	ActivateCallbackType ()
	Returns the callback type of the Activate callback. More...

static IlSymbol *	DragItemCallbackType ()
	Returns the callback type of the Drag Item callback. More...

static IlSymbol *	EndDragItemCallbackType ()
	Returns the callback type of the End Drag callback. More...

static IlSymbol *	EndEditItemCallbackType ()
	Returns the callback type of the End Edit callback. More...

static IlSymbol *	StartDragItemCallbackType ()
	Returns the callback type of the Start Drag callback. More...

static IlSymbol *	StartEditItemCallbackType ()
	Returns the callback type of the Start Edit callback. More...

Protected Member Functions inherited from IlvGadgetItemHolder
virtual void	abortDragItem ()
	Is called when a drag-and-drop operation is aborted. More...

virtual void	abortEdit (IlvGadgetItem *item)
	Is called when the editing of the specified item is aborted. More...

virtual void	drawDraggedImage (const IlvPoint &point, const IlvTransformer *t)
	Is called to draw the ghost image during a drag-and-drop operation. More...

virtual void	endDragItem (const IlvPoint &point)
	Is called when a drag-and-drop operation is finished. More...

virtual void	endEdit (IlvGadgetItem *item)
	Is called after an item has been edited. More...

virtual void	itemActivated (IlvGadgetItem *item)
	Is called when an item is activated. More...

virtual void	itemDeSelected (IlvGadgetItem *item)
	Is called when an item is deselected. More...

virtual void	itemDragged (const IlvPoint &point)
	Is called each time the user moves the mouse during a drag-and-drop operation. More...

virtual void	itemHighlighted (IlvGadgetItem *item)
	Is called when an item is highlighted or unhighlighted. More...

virtual void	itemSelected (IlvGadgetItem *item)
	Is called when an item is selected. More...

virtual void	startDragItem (IlvGadgetItem *item)
	Is called when a drag-and-drop operation begins. More...

virtual void	startEdit (IlvGadgetItem *item)
	Is called when an item is edited. More...

Detailed Description

Gadget class.

Library: ilvadvgdt

The IlvOptionMenu class defines a drop-down list of items from which the user can choose.

- IlvOptionMenu -

See Also: IlvMenuItem, IlvPopupMenu, IlvComboBox

Constructor & Destructor Documentation

IlvOptionMenu::IlvOptionMenu	(	IlvDisplay *	display,
		const IlvPoint &	point,
		const char const	labels = `0`,
		IlUShort	count = `0`,
		IlUShort	thickness = `IlvDefaultGadgetThickness`,
		IlvPalette *	palette = `0`
	)

Constructor.

Initializes a new instance of the class IlvOptionMenu. The size of the object is computed from the first label of the labels array. If you want to specify its size, use the other constructor. The labels are copied.

Parameters

display	The connection to the display.
point	The position of the option menu.
labels	An array containing the predefined labels of the option menu.
count	The number of elements in the labels array.
thickness	The thickness of the option menu.
palette	The palette used by the option menu.

IlvOptionMenu::IlvOptionMenu	(	IlvDisplay *	display,
		const IlvRect &	rect,
		const char const	labels = `0`,
		IlUShort	count = `0`,
		IlUShort	thickness = `IlvDefaultGadgetThickness`,
		IlvPalette *	palette = `0`
	)

Constructor.

Initializes a new instance of the class IlvOptionMenu. The labels are copied.

Parameters

display	The connection to the display.
rect	The size and position of the option menu.
labels	An array containing the predefined labels of the option menu.
count	The number of elements in the labels array.
thickness	The thickness of the option menu.
palette	The palette used by the option menu.

Member Function Documentation

virtual IlvGadgetItem* IlvOptionMenu::createItem	(	const char *	label,
		IlvGraphic *	graphic = `0`,
		IlvBitmap *	bitmap = `0`,
		IlvBitmap *	selbitmap = `0`,
		IlBoolean	copy = `IlTrue`
	)		const

virtual

Returns a new gadget item.

You can override this member function in a subclass to create your own items.

Parameters

label	The item label.
graphic	The `IlvGraphic` object representing the picture associated with the item.
bitmap	The `IlvBitmap` object representing the picture associated with the item.
selbitmap	The `IlvBitmap` object representing the picture of the item when it is selected.
copy	A Boolean value specifying whether a label should be copied. If the value is `IlFalse, then you must allocate some memory for the label because in any case the label characters are deleted from the memory by the IlvGadgetItem.`

Warning: [note] If both the second and third parameters are not null, only the second parameter is used.

Returns: The created gadget item.

Reimplemented from IlvGadgetItemHolder.

virtual void IlvOptionMenu::doIt ( )

virtual

Is called when an item is selected in the option menu.

Is called whether the selection changes or not. The default implementation calls the main callback of the option menu.

virtual void IlvOptionMenu::empty ( )

virtual

Empties the list.

See Also: setItems, removeItem

Implements IlvListGadgetItemHolder.

const char* IlvOptionMenu::getLabel ( ) const

Returns the label displayed in the option menu.

Returns: The label displayed in the option menu. If the selected item has no label, it returns 0.

See Also: setSelected

virtual IlvPalette* IlvOptionMenu::getNormalTextPalette ( ) const

virtual

Returns the default palette used to draw an item.

Returns: The default palette used to draw an item.

Implements IlvGadgetItemHolder.

virtual IlvPalette* IlvOptionMenu::getOpaquePalette ( ) const

virtual

Returns the opaque palette used to draw opaque items.

Returns: The opaque palette used to draw opaque items.

Reimplemented from IlvGadgetItemHolder.

IlvPopupMenu* IlvOptionMenu::getSubMenu ( ) const

Returns a pointer to the menu object used by the option menu.

Returns: A pointer to the menu object used by the option menu. The IlvPopupMenu class handles lists of items that can be selected.

See Also: IlvPopupMenu

virtual void IlvOptionMenu::recomputeAllItems ( )

virtual

Recomputes the size of all the items managed by the holder.

Calls the IlvGadgetItem::recomputeSize member function for all the items managed by this holder.

See Also: IlvGadgetItem::recomputeSize, applyToItems.

Reimplemented from IlvGadgetItemHolder.

void IlvOptionMenu::setSelected	(	IlShort	index,
		IlBoolean	redraw = `IlFalse`
	)

Sets the selected item of the option menu.

Parameters

index	The index of the selected item.
redraw	A Boolean value specifying whether the object should be redrawn.

See Also: whichSelected, getLabel

IlShort IlvOptionMenu::whichSelected ( ) const

Returns the index of the selected item.

Returns: The index of the selected item. The first item has an index of 0. If no item is selected, it returns -1.

See Also: setSelected, getLabel

Rogue Wave ViewsGadgets Package API Reference Guide

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Rogue Wave Views
Gadgets Package API Reference Guide