IlvMenuItem Class Reference

Menu item class. More...

#include <ilviews/gadgets/amenu.h>

Inheritance diagram for IlvMenuItem:

List of all members.

Public Member Functions
	IlvMenuItem ()
	Constructor.
	IlvMenuItem (IlvGraphic *graphic)
	Constructor.
	IlvMenuItem (IlvBitmap *bitmap)
	Constructor.
	IlvMenuItem (const char *label)
	Constructor.
virtual void	deSelect ()
	Deselects the item.
void	detachMenu (IlBoolean destroy=IlFalse)
	Suppresses the IlvPopupMenu associated with the menu item.
virtual void	drawLabel (IlvPort *dst, IlvPalette *palette, const IlvRect &rect, const IlvTransformer *t=0, const IlvRegion *clip=0) const
	Is called to draw the item label.
IlUShort	getAcceleratorKey () const
	Returns the accelerator key of the menu item.
IlUShort	getAcceleratorModifiers () const
	Returns the combination of modifiers used with the menu item accelerator.
const char *	getAcceleratorText () const
	Returns the text describing the accelerator. This text appears to the right of the menu item.
virtual IlUInt	getBitmapMask () const
	Returns the bitmap mask of the item.
IlvGraphicCallback	getCallback () const
	Returns a pointer to the item callback.
IlSymbol *	getCallbackName () const
	Returns the symbol that represents the name of the item callback.
virtual IlvBitmap *	getCurrentBitmap () const
	Returns the bitmap that is currently displayed by the item.
virtual IlvPalette *	getInsensitivePalette () const
	Returns the palette used to draw a nonsensitive item.
IlvPopupMenu *	getMenu () const
	Returns the IlvPopupMenu displayed by the menu item.
virtual const char *	getMessage () const
	Returns the message of the item.
const char *	getToolTip () const
	Returns the message used in the tooltip associated with the menu item.
IlvMenuItemType	getType () const
	Returns the type of the menu item.
IlBoolean	isChecked () const
	Specifies whether the menu item is checked.
IlBoolean	isRadioToggle () const
	Returns the radio state of the menu item.
IlBoolean	isReadOnly () const
	Indicates whether the menu item is read-only.
virtual IlBoolean	isSelectable () const
	Indicates whether the item can be selected.
IlBoolean	isTearOff () const
	Indicates whether the menu item is a tear-off item.
IlBoolean	isToggle () const
	Indicates whether the menu item is a toggle item.
virtual void	select ()
	Selects the item.
void	setAcceleratorKey (IlUShort key)
	Sets the accelerator key of the menu item.
void	setAcceleratorModifiers (IlUShort modifiers)
	Sets the combination of modifiers used with the menu item accelerator.
void	setAcceleratorText (const char *text)
	Sets the text describing the accelerator. This text appears to the right of the menu item.
void	setCallback (IlvGraphicCallback callback)
	Sets the item callback.
void	setCallbackName (IlSymbol *callbackName)
	Sets the name of the item callback.
void	setChecked (IlBoolean value)
	Specifies whether the menu item should be checked.
void	setMenu (IlvPopupMenu *menu, IlBoolean copy=IlTrue)
	Sets the IlvPopupMenu displayed by the menu item.
void	setRadioToggle (IlBoolean value)
	Sets the radio state of the menu item.
void	setReadOnly (IlBoolean value)
	Specifies whether the menu item should be read-only.
void	setTearOff (IlBoolean value=IlTrue)
	Specifies whether the menu item should be a tear-off item.
void	setToggle (IlBoolean value)
	Specifies whether the menu item should be a toggle item.
void	setToolTip (const char *tooltip)
	Sets the message displayed by the tooltip associated with the menu item.
virtual void	sizes (IlvPalette *pal, IlvDim &width, IlvDim &height, IlBoolean margin=IlTrue) const
	Returns the size of the menu item.
Static Public Member Functions
static IlSymbol *	CheckedBitmapSymbol ()
	Returns the symbol of the checked bitmap.
Protected Member Functions
virtual void	computeSize (IlUShort &, IlUShort &) const
	Computes the item size.
Friends
class	IlvAbstractMenu
class	IlvPopupMenu

---

Detailed Description

Menu item class.

Library: ilvgadgt

The class IlvMenuItem implements the items appearing in pop-up menus (IlvPopupMenu) or in menu bars (IlvMenuBar, IlvToolBar). A menu item can display a label, a bitmap, a graphic object and can be used as a separator.

See also:

IlvAbstractMenu, IlvPopupMenu, IlvAbstractBar, IlvToolBar, IlvMenuBar

---

Constructor & Destructor Documentation

IlvMenuItem::IlvMenuItem

(

const char *

label

)

Constructor.

Initializes a new instance of the IlvMenuItem class.

Parameters:

label

The label of the menu item.

IlvMenuItem::IlvMenuItem

(

IlvBitmap *

bitmap

)

Constructor.

Initializes a new instance of the IlvMenuItem class.

Parameters:

bitmap

The bitmap displayed by the menu item. The bitmap provided is used as the sensitive bitmap of the menu item. For more details, see IlvGadget::setBitmap. The bitmap is locked.

IlvMenuItem::IlvMenuItem

(

IlvGraphic *

graphic

)

Constructor.

Initializes a new instance of the IlvMenuItem class.

Parameters:

graphic

The graphic object displayed by the menu item.

IlvMenuItem::IlvMenuItem

(

)

Constructor.

Initializes a new instance of the IlvMenuItem class. This constructor creates a menu item that serves as a separator.

---

Member Function Documentation

static IlSymbol* IlvMenuItem::CheckedBitmapSymbol

(

)

[static]

Returns the symbol of the checked bitmap.

Returns:

The symbol used to reference the checked bitmap of a menu item.

See also:

IlvGadgetItem::setBitmap

virtual void IlvMenuItem::computeSize	(	IlUShort &	width,
		IlUShort &	height
	)			const [protected, virtual]

Computes the item size.

Computes the size of the item using the member function IlvGadgetItem::computeRects, which specifies the location of the label and picture parts. If you want to change the item size, you can override this member function in a subclass.

Parameters:

	width	The returned item width.
	height	The returned item height.

See also:

computeRects, recomputeSize, getWidth, getHeight

Reimplemented from IlvGadgetItem.

virtual void IlvMenuItem::deSelect

(

)

[virtual]

Deselects the item.

The default implementation deselects and redraws the item, then it calls the holder method IlvGadgetItemHolder::itemDeSelected.

See also:

isSelected, select, SelectedBitmapSymbol

Reimplemented from IlvGadgetItem.

void IlvMenuItem::detachMenu

(

IlBoolean

destroy = IlFalse

)

Suppresses the IlvPopupMenu associated with the menu item.

Parameters:

destroy

A Boolean value specifying whether the suppressed pop-up menu should be destroyed.

See also:

setMenu

virtual void IlvMenuItem::drawLabel	(	IlvPort *	dst,
		IlvPalette *	palette,
		const IlvRect &	rect,
		const IlvTransformer *	t = 0,
		const IlvRegion *	clip = 0
	)			const [virtual]

Is called to draw the item label.

You can override this method to modify the way the item is drawn.

Parameters:

	dst	The destination drawing port.
	palette	The palette used to draw the item label.
	rect	The rectangle where to the item label will be drawn.
	t	The transformer used to draw the item label.
	clip	The clipping area.

See also:

draw, drawPicture, itemRect

Reimplemented from IlvGadgetItem.

IlUShort IlvMenuItem::getAcceleratorKey

(

)

const

Returns the accelerator key of the menu item.

Returns:

The accelerator key. Used in combination with the modifier keys it provides a quick access to the callback attached to the menu item.

See also:

setAcceleratorKey, getAcceleratorModifiers, getAcceleratorText

IlUShort IlvMenuItem::getAcceleratorModifiers

(

)

const

Returns the combination of modifiers used with the menu item accelerator.

Returns:

The combination of modifiers, such as IlvCtrlModifier or IlvShiftModifier, that should be used in combination with the accelerator key to invoke the menu item callback (see IlvEvent::modifiers).

See also:

setAcceleratorKey, getAcceleratorKey, getAcceleratorText.

const char* IlvMenuItem::getAcceleratorText

(

)

const

Returns the text describing the accelerator. This text appears to the right of the menu item.

Returns:

The text that is shown on the menu item to describe the accelerator when the item is located in an IlvPopupMenu.

See also:

setAcceleratorText, getAcceleratorModifiers, getAcceleratorKey.

virtual IlUInt IlvMenuItem::getBitmapMask

(

)

const [virtual]

Returns the bitmap mask of the item.

The bitmap mask lets you know which bitmap indexes the item is handling. If the i^th bit of the return value is set, it means that the item uses the bitmap of index i. You can get the associated symbol using the static member function GetItemBitmapSymbol.

Returns:

The bitmap mask of the item.

See also:

GetItemBitmapSymbol, getBitmap(IlUShort)

Reimplemented from IlvGadgetItem.

IlvGraphicCallback IlvMenuItem::getCallback

(

)

const

Returns a pointer to the item callback.

Returns:

A pointer to the callback associated with the menu item or 0 if there is none.

IlSymbol* IlvMenuItem::getCallbackName

(

)

const

Returns the symbol that represents the name of the item callback.

Returns:

The symbol that represents the name of the item callback or 0 if there is none.

See also:

setCallbackName, getCallback

virtual IlvBitmap* IlvMenuItem::getCurrentBitmap

(

)

const [virtual]

Returns the bitmap that is currently displayed by the item.

Returns:

The bitmap that is currently displayed, depending on the item state. If you want to display a specific bitmap, you can override this member function is a subclass.

See also:

getBitmap

Reimplemented from IlvGadgetItem.

virtual IlvPalette* IlvMenuItem::getInsensitivePalette

(

)

const [virtual]

Returns the palette used to draw a nonsensitive item.

By default, an item uses the palette of its holder. Therefore, this method simply calls IlvGadgetItemHolder::getInsensitivePalette.

Returns:

The palette used to draw a nonsensitive item.

See also:

IlvGadgetItemHolder::getInsensitivePalette

Reimplemented from IlvGadgetItem.

IlvPopupMenu* IlvMenuItem::getMenu

(

)

const

Returns the IlvPopupMenu displayed by the menu item.

Returns:

The submenu associated with this menu item or 0 if there is none.

See also:

setMenu

virtual const char* IlvMenuItem::getMessage

(

)

const [virtual]

Returns the message of the item.

Returns:

The message string with which the item label is associated in the display database. If the item label has no associated message string, the method returns the item label.

See also:

getLabel

Reimplemented from IlvGadgetItem.

const char* IlvMenuItem::getToolTip

(

)

const

Returns the message used in the tooltip associated with the menu item.

Returns:

The message used in the tooltip associated with this menu item or 0 if there is none.

See also:

setToolTip

IlvMenuItemType IlvMenuItem::getType

(

)

const

Returns the type of the menu item.

Returns:

The type of menu entry. This method is obsolete since a menu item now displays both a picture and a label. Only the following two return values are meaningful: IlvSeparatorItem and IlvTearOffItem.

See also:

IlvMenuItemType

IlBoolean IlvMenuItem::isChecked

(

)

const

Specifies whether the menu item is checked.

Returns:

IlTrue if the menu item is checked. In this case, if the menu item is part of an IlvPopupMenu, a small check mark appears to the left side of the menu item. It returns IlFalse if the menu item is not checked.

See also:

setChecked

IlBoolean IlvMenuItem::isRadioToggle

(

)

const

Returns the radio state of the menu item.

Returns:

IlTrue if the menu item is radio. When an item is radio and is located in an IlvPopupMenu, a radio toggle check mark appears next to it, whether the item is checked or not.

Warning:

[note] A radio toggle appears as a diamond under Motif and as a circle under Windows/Windows 95/ViewsX.

See also:

setRadioToggle, IlvPopupMenu.

IlBoolean IlvMenuItem::isReadOnly

(

)

const

Indicates whether the menu item is read-only.

A menu entry can be read-only. A read-only menu item cannot be selected.

Returns:

IlTrue if the menu item is read-only and IlFalse otherwise.

See also:

setReadOnly

virtual IlBoolean IlvMenuItem::isSelectable

(

)

const [virtual]

Indicates whether the item can be selected.

Is called when an item is about to be selected. You can redefine this member function to filter item selection.

Returns:

IlTrue if the item can be selected, and IlFalse otherwise.

See also:

select, deSelect, isSelected

Reimplemented from IlvGadgetItem.

IlBoolean IlvMenuItem::isTearOff

(

)

const

Indicates whether the menu item is a tear-off item.

Returns:

IlTrue if the menu item is a tear-off item.

See also:

setTearOff, getType

IlBoolean IlvMenuItem::isToggle

(

)

const

Indicates whether the menu item is a toggle item.

Returns:

IlTrue if the menu item is a toggle item. In this case, a check mark appears next to the item whether it is checked or not.

See also:

setToggle

virtual void IlvMenuItem::select

(

)

[virtual]

Selects the item.

The default implementation selects and redraws the item, then it calls the holder method IlvGadgetItemHolder::itemSelected.

See also:

isSelected, deSelect, SelectedBitmapSymbol

Reimplemented from IlvGadgetItem.

void IlvMenuItem::setAcceleratorKey

(

IlUShort

key

)

Sets the accelerator key of the menu item.

Sets key as the accelerator key. Used in combination with the modifier keys, it provides a quick access to the callback attached to the menu item.

Parameters:

key

The new accelerator key.

See also:

getAcceleratorKey, setAcceleratorText, setAcceleratorModifiers.

void IlvMenuItem::setAcceleratorModifiers

(

IlUShort

modifiers

)

Sets the combination of modifiers used with the menu item accelerator.

Sets the combination of modifiers, such as IlvCtrlModifier or IlvShiftModifier), that is to be used in combination with the accelerator key to call the menu item callback (see IlvEvent::modifiers).

Parameters:

modifiers

The new modifiers to be used with the accelerator.

See also:

getAcceleratorModifiers, setAcceleratorKey, setAcceleratorText

void IlvMenuItem::setAcceleratorText

(

const char *

text

)

Sets the text describing the accelerator. This text appears to the right of the menu item.

Sets text as the text that appears in the menu item to describe the accelerator when the item is located in an IlvPopupMenu.

Parameters:

text

The new text for the accelerator.

See also:

getAcceleratorText, setAcceleratorModifiers, setAcceleratorKey.

void IlvMenuItem::setCallback

(

IlvGraphicCallback

callback

)

Sets the item callback.

Sets the callback associated with the menu item to callback.

Parameters:

callback

A pointer to the new item callback.

See also:

getCallback, setCallbackName

void IlvMenuItem::setCallbackName

(

IlSymbol *

callbackName

)

Sets the name of the item callback.

Sets the name of the item callback to callbackName. The item callback is triggered when the item is activated.

Parameters:

callbackName

The name of the callback.

See also:

getCallbackName, setCallback

void IlvMenuItem::setChecked

(

IlBoolean

value

)

Specifies whether the menu item should be checked.

If the item has a sensitive bitmap, and if no checked bitmap has been provided, a default checked bitmap is automatically computed the first time the item is checked.

Parameters:

value

A Boolean value specifying whether the menu item should be checked.

See also:

isChecked, IlvGadgetItem::setBitmap, CheckedBitmapSymbol

void IlvMenuItem::setMenu	(	IlvPopupMenu *	menu,
		IlBoolean	copy = IlTrue
	)

Sets the IlvPopupMenu displayed by the menu item.

Sets a submenu to this menu item. A small arrow is displayed on the right side of the entry when the item is located in an IlvPopupMenu. If there was already a submenu, then it is deleted.

Parameters:

	menu	The new submenu.
	copy	A Boolean value specifying whether menu should be copied.

See also:

getMenu

void IlvMenuItem::setRadioToggle

(

IlBoolean

value

)

Sets the radio state of the menu item.

Sets the menu item to be a radio toggle, if value is IlTrue.

Parameters:

value

A Boolean specifying whether the menu item should be a radio item.

See also:

isRadioToggle

void IlvMenuItem::setReadOnly

(

IlBoolean

value

)

Specifies whether the menu item should be read-only.

Sets the menu item to the read-only mode. If value is IlTrue, the menu item cannot be selected.

Parameters:

value

A Boolean value specifying whether the menu item should be read- only.

See also:

isReadOnly

void IlvMenuItem::setTearOff

(

IlBoolean

value = IlTrue

)

Specifies whether the menu item should be a tear-off item.

A tear-off menu item is represented by a dashed line when it is located in an IlvPopupMenu. When selected, a tear-off menu item creates a top window in which a copy of the pop-up menu that contains it is put.

Parameters:

value

A Boolean value specifying the tear-off state of the menu item.

See also:

setTearOff, getType

void IlvMenuItem::setToggle

(

IlBoolean

value

)

Specifies whether the menu item should be a toggle item.

Sets the menu item to be a toggle item. A toggle item located in an IlvPopupMenu has a check mark displayed next to it only when using the Motif look-and-feel.
If the toggle item is located in an IlvToolBar, then the item has a toggle behavior.

Parameters:

value

A Boolean value specifying whether the menu item should be a toggle item.

See also:

isToggle, IlvToolBar, IlvPopupMenu.

void IlvMenuItem::setToolTip

(

const char *

tooltip

)

Sets the message displayed by the tooltip associated with the menu item.

Sets the message displayed by the tooltip associated with this menu item. Tooltips attached to menu items are only active when the items belong to an IlvToolBar object.

Parameters:

tooltip

The message to be displayed by the tooltip.

See also:

getToolTip, IlvToolBar

virtual void IlvMenuItem::sizes	(	IlvPalette *	pal,
		IlvDim &	width,
		IlvDim &	height,
		IlBoolean	margin = IlTrue
	)			const [virtual]

Returns the size of the menu item.

Returns in width and height the size of the menu item.

Parameters:

	pal	This parameter is not obsolete.
	width	The width of the menu item.
	height	The height of the menu item.

See also:

IlvGadgetItem::getWidth, IlvGadgetItem::getHeight