Gadget class. More...

#include <ilviews/gadgets/menu.h>

Inheritance diagram for IlvPopupMenu:

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

virtual void	hide ()
	Hides the pop-up menu. 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	show (const IlvPoint &point, IlBoolean grab=IlTrue, IlvView *parent=0)
	Displays the menu at the specified location. 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...

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

Static Public Member Functions
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...

Friends
class	IlvDefaultPopupMenuLFHandler

Additional Inherited Members
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

Gadget class.

Library: ilvgadgt

The IlvPopupMenu class handles a list of menu entries laid out vertically. These menu entries, called menu items, are instances of the IlvMenuItem class, which can store a label, a bitmap, or a graphic object of the class IlvGraphic.

A pop-up menu can be used as a submenu or as a standalone menu by calling the member functions IlvPopupMenu::show() or IlvPopupMenu::get().

- IlvPopupMenu -

A pop-up menu can be torn off and put into a floating window. A tear-off pop-up menu can be detached by selecting the dashed line appearing across its top border. The first item of a tear-off pop-up menu must be of the type IlvTearOffItem.

See also: IlvAbstractBar, IlvMenuItem, IlvOptionMenu, IlvComboBox.

Accessors\nAccessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods <tt>IlvValueInterface::queryValue()</tt>, <tt>IlvValueInterface::queryValues()</tt>, <tt>IlvValueInterface::changeValue()</tt>, <tt>IlvValueInterface::changeValues()</tt>.\n\n\nThis class inherits the accessors of its superclass \c IlvAbstractMenu and adds the following ones:

Name	Type	Equivalent methods
`autoLabelAlignment`	Boolean	`autoLabelAlignment() const`, `autoLabelAlignment(IlBoolean, IlBoolean)`
`hasToolTips`	Boolean	`hasToolTips()`, `useToolTips()`
`labelOffset`	UInt	`getLabelOffset()`, `setLabelOffset()`

Styling\nThis class supports the following CSS properties:

Graphic property	CSS property	Type
Background color	`background-color`	Color
Text color	`color`	Color

Constructor & Destructor Documentation

◆ IlvPopupMenu() [1/2]

IlvPopupMenu::IlvPopupMenu	(	IlvDisplay *	display,
		IlUShort	count = `0`,
		const char const	labels = `0`,
		IlUShort	thickness = `IlvDefaultGadgetThickness`,
		IlvPalette *	palette = `0`
	)

Constructor.

Initializes a new instance of the IlvPopupMenu class.

Parameters

display	The connection to the display.
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.

◆ IlvPopupMenu() [2/2]

IlvPopupMenu::IlvPopupMenu	(	IlvDisplay *	display,
		IlUShort	count,
		IlvMenuItem *	items,
		IlUShort	thickness = `IlvDefaultGadgetThickness`,
		IlvPalette *	palette = `0`
	)

Constructor.

Initializes a new instance of the IlvPopupMenu class. The items are copied by this constructor.

Parameters

display	The connection to the display.
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

◆ addOpenMenuCallback() [1/4]

void IlvPopupMenu::addOpenMenuCallback ( IlSymbol * callbackName )

Adds a named Open Menu callback.

Adds callbackName to the Open Menu callback list. gadget has the keyboard focus. An Open Menu callback is invoked before the pop-up menu is displayed.

Parameters

callbackName The name of the new callback.

See also: setOpenMenuCallback(), getOpenMenuCallbackName().

◆ addOpenMenuCallback() [2/4]

void IlvPopupMenu::addOpenMenuCallback	(	IlSymbol *	callbackName,
		IlAny	arg
	)

Adds a named Open Menu callback.

Adds callbackName to the Open Menu callback list. The callback function, when invoked, receives the user parameter arg.

An Open Menu callback is invoked before the pop-up menu is displayed.

Parameters

callbackName	The name of the new callback.
arg	The callback argument.

See also: setOpenMenuCallback(), getOpenMenuCallbackName().

◆ addOpenMenuCallback() [3/4]

void IlvPopupMenu::addOpenMenuCallback ( IlvGraphicCallback callback )

Adds an Open Menu callback.

Adds callback to the Open Menu callback list. An Open Menu callback is invoked before the pop-up menu is displayed.

Parameters

callback A pointer to the new callback.

See also: setOpenMenuCallback(), getOpenMenuCallback().

◆ addOpenMenuCallback() [4/4]

void IlvPopupMenu::addOpenMenuCallback	(	IlvGraphicCallback	callback,
		IlAny	arg
	)

Adds a Open Menu callback.

Adds callback to the Open Menu callback list. The callback function, when invoked, receives the user parameter arg.

An Open Menu callback is invoked before the pop-up menu is displayed.

Parameters

callback	A pointer to the new callback.
arg	The callback argument.

See also: setOpenMenuCallback(), getOpenMenuCallback().

◆ AreToolTipsEnabled()

static IlBoolean IlvPopupMenu::AreToolTipsEnabled ( )

static

Indicates whether pop-up menus should display tooltips.

Returns: IlTrue if tooltips are allowed for pop-up menus, IlFalse otherwise.

See also: hasToolTips(), EnableToolTips().

◆ autoLabelAlignment() [1/2]

IlBoolean IlvPopupMenu::autoLabelAlignment ( ) const

Indicates whether the automatic label alignment mode is on.

Returns: IlTrue if the automatic label alignment mode is on and IlFalse otherwise.

See also: autoLabelAlignment(IlBoolean, IlBoolean), setLabelOffset().

◆ autoLabelAlignment() [2/2]

void IlvPopupMenu::autoLabelAlignment	(	IlBoolean	value,
		IlBoolean	redraw = `IlTrue`
	)

Specifies whether the automatic label alignment mode should be used.

When the automatic label alignment mode is enabled (the default), a label offset is automatically computed to ensure that all the item pictures are visible and all the item labels are aligned.

Parameters

value	Specifies whether the automatic alignment mode should be used.
redraw	Specifies whether the pop-up menu should be redrawn.

See also: setLabelOffset, autoLabelAlignment().

◆ doIt()

virtual void IlvPopupMenu::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 in IlvComboBox::PopupMenu.

◆ drawGadgetItem()

virtual void IlvPopupMenu::drawGadgetItem	(	const IlvGadgetItem *	item,
		IlvPort *	port,
		const IlvRect &	rect,
		const IlvTransformer *	t = `0`,
		const IlvRegion *	clip = `0`
	)		const

virtual

Draws a specific gadget item.

Redraws item in port at the location specified by rect using the clipping area clip. This method simply calls IlvGadgetItem::draw() using the item instance.

Parameters

item	The item to be redrawn.
port	The destination drawing port.
rect	The bounding box of the item.
t	The transformer used to draw the item. Not used.
clip	The clipping area.

See also: IlvGadgetItem::draw().

Reimplemented from IlvGadgetItemHolder.

◆ empty()

virtual void IlvPopupMenu::empty ( )

virtual

Empties the list.

See also: setItems(), removeItem().

Reimplemented from IlvAbstractMenu.

◆ EnableToolTips()

static void IlvPopupMenu::EnableToolTips ( IlBoolean value = IlTrue )

static

Specifies whether pop-up menus should display tooltips.

Use this setting to enable or disable tooltips at the class level.

Parameters

value Specifies whether pop-up menus of the application should display tooltips (IlTrue) or not (IlFalse). If value is IlTrue, then each instance of pop-up menu will choose whether to display tooltips or not by using the value set by IlvPopupMenu::useToolTips(). If value is IlFalse, tooltips are disabled for all the pop-up menus of the application.

See also: useToolTips(), AreToolTipsEnabled().

◆ get()

IlShort IlvPopupMenu::get	(	const IlvPoint &	point,
		IlvView *	parent = `0`
	)

Displays the menu at the specified location and waits until a selection is made.

Calls IlvPopupMenu::show(), enters a modal loop, and waits until the pop-up menu is hidden.

Parameters

point	The location where the menu is displayed.
parent	The parent view for which the menu container is transient. For details on transient windows, see the `IlvView` constructors.

Returns: The index of the selected item or -1 if there is no selected item.

See also: show(), hide().

◆ getHighlightTextPalette()

virtual IlvPalette* IlvPopupMenu::getHighlightTextPalette ( ) const

virtual

Returns the highlight palette used to draw the label of highlighted items.

Returns: The palette used to draw the label of highlighted items.

Reimplemented from IlvGadgetItemHolder.

◆ getLabelOffset()

virtual IlvDim IlvPopupMenu::getLabelOffset ( ) const

virtual

Returns the offset applied to each item label.

Returns: The offset applied to each item label or 0 if no offset has been defined.

See also: setLabelOffset(), autoLabelAlignment(IlBoolean, IlBoolean)().

Reimplemented from IlvListGadgetItemHolder.

◆ getOpenMenuCallback()

IlvGraphicCallback IlvPopupMenu::getOpenMenuCallback ( ) const

Returns a pointer to the first unnamed callback in the Open Menu callback list.

Returns: The function pointer to the first unnamed callback in the Open Menu callback list.

See also: setOpenMenuCallback(), addOpenMenuCallback().

◆ getOpenMenuCallbackName()

IlSymbol* IlvPopupMenu::getOpenMenuCallbackName ( ) const

Returns the name of the first named callback in the Open Menu callback list.

Returns: Returns a symbol representing the name of the first named callback in the Open Menu callback list.

See also: setOpenMenuCallbackName(), getOpenMenuCallback().

◆ getTopView()

IlvContainer* IlvPopupMenu::getTopView ( ) const

Returns a pointer to the container associated with the pop-up menu.

When a pop-up menu is shown using IlvPopupMenu::show() or IlvPopupMenu::get(), an instance of the IlvContainer class is created to display the pop-up menu.

Returns: A pointer to the container associated with the pop-up menu. If the menu has never been shown, the method returns 0.

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

◆ hasToolTips()

IlBoolean IlvPopupMenu::hasToolTips ( ) const

virtual

Indicates whether the pop-up menu displays tooltips.

Returns: IlTrue if the pop-up menu handles tooltips and IlFalse if it does not.

See also: useToolTips(), EnableToolTips().

Reimplemented from IlvGadgetItemHolder.

◆ hide()

virtual void IlvPopupMenu::hide ( )

virtual

Hides the pop-up menu.

See also: show(), get().

Reimplemented in IlvComboBox::PopupMenu.

◆ isDoubleBuffering()

IlBoolean IlvPopupMenu::isDoubleBuffering ( ) const

Tests the double buffering setting.

Returns: Whether (IlTrue) or not (IlFalse) the container associated with the pop-up menu is using double buffering.

◆ isGrabbed()

virtual IlBoolean IlvPopupMenu::isGrabbed ( ) const

virtual

Checks if the pop-up menu is visible and grabbed.

Returns: IlTrue if the pop-up menu is visible and grabbed and IlFalse otherwise.

See also: show(), get().

Implements IlvAbstractMenu.

◆ isMenuShown()

IlBoolean IlvPopupMenu::isMenuShown ( ) const

Indicates whether the pop-up menu is visible.

Returns: IlTrue if the pop-up menu is visible and IlFalse otherwise.

See also: show(), hide().

◆ itemBBox()

virtual void IlvPopupMenu::itemBBox	(	IlUShort	index,
		IlvRect &	bbox,
		const IlvTransformer *	t = `0`
	)		const

virtual

Returns the bounding box of a menu item in the menu.

Uses bbox to return the bounding box of the item specified by index when the object is displayed with the transformer t.

Parameters

index	The index of the item.
bbox	The returned menu item's bounding box.
t	The transformer used to compute the item's bounding box.

Implements IlvAbstractMenu.

◆ OpenMenuCallbackSymbol()

static IlSymbol* IlvPopupMenu::OpenMenuCallbackSymbol ( )

static

Returns the symbol of the Open Menu callback list.

Returns: The symbol of the Open Menu callback list.

See also: setOpenMenuCallback(), IlvGraphic::setCallback().

◆ recomputeAllItems()

virtual void IlvPopupMenu::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 IlvAbstractMenu.

◆ select()

virtual void IlvPopupMenu::select ( IlUShort pos )

virtual

Is called when an item has been selected.

Parameters

pos	The index of the selected item.

See also: unSelect().

Reimplemented from IlvAbstractMenu.

◆ setDoubleBuffering()

virtual void IlvPopupMenu::setDoubleBuffering ( IlBoolean value )

virtual

Sets double buffering.

Use this member function to indicate whether or not the container associated with the pop-up menu should use double buffering.

Parameters

value Specifies whether the container associated with the pop-up menu should use double buffering (IlTrue) or not (IlFalse).

See also: getTopView().

◆ setLabelOffset()

void IlvPopupMenu::setLabelOffset	(	IlvDim	offset,
		IlBoolean	redraw = `IlTrue`
	)

Sets the label offset of the pop-up menu.

When a label offset is defined, all the item labels are aligned using this offset. Calling this method disables the automatic alignment mode.

Parameters

offset	The new label offset.
redraw	Specifies whether the pop-up menu should be redrawn.

See also: getLabelOffset(), autoLabelAlignment(IlBoolean, IlBoolean).

◆ setOpenMenuCallback() [1/4]

void IlvPopupMenu::setOpenMenuCallback ( IlSymbol * callbackName )

Sets a named Open Menu callback.

Removes all the existing Open Menu callbacks before adding callbackName to the Open Menu callback list.

An Open Menu callback is invoked before the pop-up menu is displayed.

Parameters

callbackName The name of the new callback.

See also: addOpenMenuCallback(), getOpenMenuCallbackName().

◆ setOpenMenuCallback() [2/4]

void IlvPopupMenu::setOpenMenuCallback	(	IlSymbol *	callbackName,
		IlAny	arg
	)

Sets a named Open Menu callback.

Removes all the existing Open Menu callbacks before adding callbackName to the Open Menu callback list. The callback function, when invoked, receives the user parameter arg.

An Open Menu callback is invoked before the pop-up menu is displayed.

Parameters

callbackName	The name of the new callback.
arg	The callback argument.

See also: addOpenMenuCallback(), getOpenMenuCallbackName().

◆ setOpenMenuCallback() [3/4]

void IlvPopupMenu::setOpenMenuCallback ( IlvGraphicCallback callback )

Sets an Open Menu callback.

Removes all the existing Open Menu callbacks before adding callback to the Open Menu callback list.

An Open Menu callback is invoked before the pop-up menu is displayed.

Parameters

callback A pointer to the new callback.

See also: OpenMenu(), addOpenMenuCallback(), getOpenMenuCallback().

◆ setOpenMenuCallback() [4/4]

void IlvPopupMenu::setOpenMenuCallback	(	IlvGraphicCallback	callback,
		IlAny	arg
	)

Sets an Open Menu callback.

Removes all the existing Open Menu callbacks before adding callback to the Open Menu callback list. The callback function, when invoked, receives the user parameter arg.

An Open Menu callback is invoked before the pop-up menu is displayed.

Parameters

callback	A pointer to the new callback.
arg	The callback argument.

See also: addOpenMenuCallback(), getOpenMenuCallback().

◆ show()

virtual void IlvPopupMenu::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 in IlvComboBox::PopupMenu.

◆ unSelect()

virtual void IlvPopupMenu::unSelect ( IlUShort pos )

virtual

Is called when an item has been deselected.

Parameters

pos	The index of the unselected item.

See also: select().

Reimplemented from IlvAbstractMenu.

◆ useToolTips()

void IlvPopupMenu::useToolTips ( IlBoolean value )

Specifies whether the pop-up menu should display tooltips.

The tooltips associated with menu items are displayed when the mouse remains over the items for a short period of time. For details on how to set tooltips to menu items, see IlvMenuItem::setToolTip().

Parameters

value Specifies whether the pop-up menu should display tooltips (IlTrue) or not (IlFalse).

See also: hasToolTips(), IlvMenuItem::setToolTip().

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Styling\nThis class supports the following CSS properties:

Constructor & Destructor Documentation

◆ IlvPopupMenu() [1/2]

◆ IlvPopupMenu() [2/2]

Member Function Documentation

◆ addOpenMenuCallback() [1/4]

◆ addOpenMenuCallback() [2/4]

◆ addOpenMenuCallback() [3/4]

◆ addOpenMenuCallback() [4/4]

◆ AreToolTipsEnabled()

◆ autoLabelAlignment() [1/2]

◆ autoLabelAlignment() [2/2]

◆ doIt()

◆ drawGadgetItem()

◆ empty()

◆ EnableToolTips()

◆ get()

◆ getHighlightTextPalette()

◆ getLabelOffset()

◆ getOpenMenuCallback()

◆ getOpenMenuCallbackName()

◆ getTopView()

◆ hasToolTips()

◆ hide()

◆ isDoubleBuffering()

◆ isGrabbed()

◆ isMenuShown()

◆ itemBBox()

◆ OpenMenuCallbackSymbol()

◆ recomputeAllItems()

◆ select()

◆ setDoubleBuffering()

◆ setLabelOffset()

◆ setOpenMenuCallback() [1/4]

◆ setOpenMenuCallback() [2/4]

◆ setOpenMenuCallback() [3/4]

◆ setOpenMenuCallback() [4/4]

◆ show()

◆ unSelect()

◆ useToolTips()