A subclass of IlvPopupMenu defined specifically for the IlvComboBox. More...

#include <ilviews/gadgets/combo.h>

Inheritance diagram for IlvComboBox::PopupMenu:

Public Member Functions
	PopupMenu (IlvComboBox combo, IlUShort count, IlvMenuItem items, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Initializes a new `PopupMenu` instance from an array of `IlvMenuItem` objects. More...

	PopupMenu (IlvComboBox combo, IlUShort count=0, const char const labels=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette palette=0)
	Initializes a new `PopupMenu` instance from an array of labels. More...

virtual void	doIt ()
	Is called when the user selects an item from a standalone pop-up 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...

virtual void	hide ()
	Hides the pop-up menu. More...

virtual void	show (const IlvPoint &, IlBoolean=IlTrue, IlvView *=0)
	Displays the menu at the specified location. More...

Public Member Functions inherited from IlvPopupMenu
	IlvPopupMenu (IlvDisplay display, IlUShort count, IlvMenuItem items, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Constructor. More...

	IlvPopupMenu (IlvDisplay display, IlUShort count=0, const char const labels=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette palette=0)
	Constructor. More...

void	addOpenMenuCallback (IlSymbol *callbackName)
	Adds a named Open Menu callback. More...

void	addOpenMenuCallback (IlSymbol *callbackName, IlAny arg)
	Adds a named Open Menu callback. More...

void	addOpenMenuCallback (IlvGraphicCallback callback)
	Adds an Open Menu callback. More...

void	addOpenMenuCallback (IlvGraphicCallback callback, IlAny arg)
	Adds a Open Menu callback. More...

IlBoolean	autoLabelAlignment () const
	Indicates whether the automatic label alignment mode is on. More...

void	autoLabelAlignment (IlBoolean value, IlBoolean redraw=IlTrue)
	Specifies whether the automatic label alignment mode should be used. More...

virtual void	drawGadgetItem (const IlvGadgetItem , IlvPort , const IlvRect &, const IlvTransformer t=0, const IlvRegion clip=0) const
	Draws a specific gadget item. More...

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

IlShort	get (const IlvPoint &point, IlvView *parent=0)
	Displays the menu at the specified location and waits until a selection is made. More...

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

virtual IlvDim	getLabelOffset () const
	Returns the offset applied to each item label. More...

IlvGraphicCallback	getOpenMenuCallback () const
	Returns a pointer to the first unnamed callback in the Open Menu callback list. More...

IlSymbol *	getOpenMenuCallbackName () const
	Returns the name of the first named callback in the Open Menu callback list. More...

IlvContainer *	getTopView () const
	Returns a pointer to the container associated with the pop-up menu. More...

IlBoolean	hasToolTips () const
	Indicates whether the pop-up menu displays tooltips. More...

IlBoolean	isDoubleBuffering () const
	Tests the double buffering setting. More...

virtual IlBoolean	isGrabbed () const
	Checks if the pop-up menu is visible and grabbed. More...

IlBoolean	isMenuShown () const
	Indicates whether the pop-up menu is visible. More...

virtual void	itemBBox (IlUShort item, IlvRect &rect, const IlvTransformer *t=0) const
	Returns the bounding box of a menu item in the menu. More...

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

virtual void	select (IlUShort pos)
	Is called when an item has been selected. More...

virtual void	setDoubleBuffering (IlBoolean value)
	Sets double buffering. More...

void	setLabelOffset (IlvDim offset, IlBoolean redraw=IlTrue)
	Sets the label offset of the pop-up menu. More...

void	setOpenMenuCallback (IlSymbol *callbackName)
	Sets a named Open Menu callback. More...

void	setOpenMenuCallback (IlSymbol *callbackName, IlAny arg)
	Sets a named Open Menu callback. More...

void	setOpenMenuCallback (IlvGraphicCallback callback)
	Sets an Open Menu callback. More...

void	setOpenMenuCallback (IlvGraphicCallback callback, IlAny arg)
	Sets an Open Menu callback. More...

virtual void	unSelect (IlUShort pos)
	Is called when an item has been deselected. More...

void	useToolTips (IlBoolean value)
	Specifies whether the pop-up menu should display tooltips. More...

Public Member Functions inherited from IlvAbstractMenu
void	addHighlightCallback (const IlSymbol *callbackName, IlBoolean submenus=IlTrue)
	Adds a named "Highlight" callback to the menu. More...

void	addHighlightCallback (IlvGraphicCallback callback, IlBoolean submenus=IlTrue)
	Adds a "Highlight" callback to the menu. More...

void	addItem (const IlvMenuItem &item, IlShort index=-1)
	Inserts a copy of a menu item at the specified index. More...

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

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

IlvMenuItem *	getItem (IlUShort index) const
	Returns the menu item at the specified index. More...

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

IlvMenuItem const	getItems (IlUShort &count) const
	Returns an array of all the items in the menu. More...

virtual void	getLabelOrientation (IlvOrientation &orientation, IlBoolean &flip) const
	Returns the default orientation of the labels associated with the menu items. More...

virtual IlvPosition	getLabelPosition () const
	Returns the default position of the labels associated with the menu items, relative to their picture. More...

IlvPopupMenu *	getSubMenu (IlUShort pos) const
	Returns the `IlvPopupMenu` associated with the menu item at the specified index. More...

IlUShort	insertItem (IlUShort pos, const char label, const IlvPopupMenu menu=0, IlBoolean copy=IlTrue)
	Inserts a menu item that has a label. More...

IlUShort	insertItem (IlvMenuItem *item, IlShort pos=-1)
	Inserts a menu item at the specified position. More...

virtual IlBoolean	isSelectable (const IlvMenuItem *item) const
	Indicates whether the specified item can be selected. More...

virtual IlBoolean	isShowingLabel () const
	Returns `IlTrue` if the labels associated with the menu items are displayed. More...

virtual IlBoolean	isShowingPicture () const
	Indicates if the pictures associated with the menu items are displayed. More...

virtual IlShort	pointToPosition (const IlvPoint &point, const IlvTransformer *t=0) const
	Returns the index of the menu item located at the indicated position. More...

virtual IlShort	selectNext ()
	Is called when the user tries to select the next menu item using the keyboard. More...

virtual IlShort	selectPrevious ()
	Is called when the user tries to select the previous menu item using the keyboard. More...

void	setHighlightCallback (const IlSymbol *callbackName, IlBoolean submenus=IlTrue)
	Sets a named "Highlight" callback to the menu. More...

void	setHighlightCallback (IlvGraphicCallback callback, IlBoolean submenus=IlTrue)
	Sets a "Highlight" callback to the menu. More...

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

void	setItems (IlvMenuItem const items, IlUShort count)
	Replaces the entire list of items in the menu. More...

void	setLabelOrientation (IlvOrientation orientation, IlBoolean flip=IlFalse, IlBoolean redraw=IlTrue)
	Sets the default orientation of the labels associated with the menu items. More...

void	setLabelPosition (IlvPosition position, IlBoolean redraw=IlTrue)
	Sets the default position of the menu item labels, relative to their picture. More...

void	setSubMenu (IlUShort pos, IlvPopupMenu *popup, IlBoolean copy=IlTrue)
	Sets the `IlvPopupMenu` associated with the menu item at the specified index. More...

void	showLabel (IlBoolean value=IlTrue, IlBoolean redraw=IlTrue)
	Specifies whether the menu item labels should be shown or hidden. More...

void	showPicture (IlBoolean value=IlTrue, IlBoolean redraw=IlTrue)
	Specifies whether the menu item pictures should be shown or hidden. 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, IlAny)
	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...

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 indicated 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...

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
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...

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...

Additional Inherited Members
Static Public Member Functions inherited from IlvPopupMenu
static IlBoolean	AreToolTipsEnabled ()
	Indicates whether pop-up menus should display tooltips. More...

static void	EnableToolTips (IlBoolean value=IlTrue)
	Specifies whether pop-up menus should display tooltips. More...

static IlSymbol *	OpenMenuCallbackSymbol ()
	Returns the symbol of the Open Menu callback list. More...

Static Public Member Functions inherited from IlvAbstractMenu
static IlSymbol *	HighlightCBSymbol ()
	Returns the callback type for the Highlight callback. More...

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 IlvAbstractMenu
	IlvAbstractMenu (IlvDisplay display, IlUShort count, IlvMenuItem items, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Constructor. More...

	IlvAbstractMenu (IlvDisplay display, IlUShort count=0, const char const labels=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette palette=0)
	Constructor. More...

virtual void	itemActivated (IlvGadgetItem *)
	Is called when an item is activated. 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	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

A subclass of IlvPopupMenu defined specifically for the IlvComboBox.

Library: ilvgadgt

If no factory as been set by SetPopupMenuFactory(), the IlvComboBox constructor creates an instance of IlvComboBox::PopupMenu using the labels or the menu items provided as arguments.

Note: The class IlvScrolledComboBox does not use a popup menu but an IlvStringList. In this case, no IlvComboBox::PopupMenu is created.

See also: IlvComboBox::PopupMenuFactory, SetPopupMenuFactory()

Constructor & Destructor Documentation

◆ PopupMenu() [1/2]

IlvComboBox::PopupMenu::PopupMenu	(	IlvComboBox *	combo,
		IlUShort	count = `0`,
		const char const	labels = `0`,
		IlUShort	thickness = `IlvDefaultGadgetThickness`,
		IlvPalette *	palette = `0`
	)

Initializes a new PopupMenu instance from an array of labels.

Calls the constructor of IlvPopupMenu using the same arguments (except the first one).

Parameters

combo	The `IlvComboBox` object this pop-up menu is attached to.
count	The number of elements in the labels array.
labels	An array of item labels.
thickness	The thickness of the menu.
palette	The palette used to draw the menu.

◆ PopupMenu() [2/2]

IlvComboBox::PopupMenu::PopupMenu	(	IlvComboBox *	combo,
		IlUShort	count,
		IlvMenuItem *	items,
		IlUShort	thickness = `IlvDefaultGadgetThickness`,
		IlvPalette *	palette = `0`
	)

Initializes a new PopupMenu instance from an array of IlvMenuItem objects.

Calls the constructor of IlvPopupMenu using the same arguments (except the first one).

Parameters

combo	The `IlvComboBox` object this pop-up menu is attached to.
count	The number of elements in the items array.
items	An array of menu items.
thickness	The thickness of the menu.
palette	The palette used to draw the menu.

Member Function Documentation

◆ doIt()

virtual void IlvComboBox::PopupMenu::doIt ( )

virtual

Is called when the user selects an item from a standalone pop-up menu.

The default implementation calls the IlvGadgetItem::activate() method of the selected menu item, which causes the item callback to be invoked. The method does nothing if no item is selected.

See also: IlvAbstractMenu::whichSelected(), IlvGadgetItem::activate().

Reimplemented from IlvPopupMenu.

◆ getNormalTextPalette()

virtual IlvPalette* IlvComboBox::PopupMenu::getNormalTextPalette ( ) const

virtual

Returns the default palette used to draw an item.

Returns: The default palette used to draw an item.

Reimplemented from IlvAbstractMenu.

◆ getOpaquePalette()

virtual IlvPalette* IlvComboBox::PopupMenu::getOpaquePalette ( ) const

virtual

Returns the opaque palette used to draw opaque items.

Returns: The opaque palette used to draw opaque items.

Reimplemented from IlvAbstractMenu.

◆ hide()

virtual void IlvComboBox::PopupMenu::hide ( )

virtual

Hides the pop-up menu.

See also: show(), get().

Reimplemented from IlvPopupMenu.

◆ show()

virtual void IlvComboBox::PopupMenu::show	(	const IlvPoint &	point,
		IlBoolean	grab = `IlTrue`,
		IlvView *	parent = `0`
	)

virtual

Displays the menu at the specified location.

Creates and displays an IlvContainer object that contains the pop-up menu.

Parameters

point	The location where the menu is displayed.
grab	Specifies whether the events occurring in the menu container should be grabbed.
parent	The parent view for which the menu container is transient. For details on transient windows, see the `IlvView` constructors.

See also: get(), IlvView, hide().

Reimplemented from IlvPopupMenu.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PopupMenu() [1/2]

◆ PopupMenu() [2/2]

Member Function Documentation

◆ doIt()

◆ getNormalTextPalette()

◆ getOpaquePalette()

◆ hide()

◆ show()