Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvMenuItemPath Class Reference

Menu item class which stores a path. More...

#include <ilviews/gadgets/toolpath.h>

Inheritance diagram for IlvMenuItemPath:
IlvMenuItem IlvGadgetItem IlvValueInterface IlvStylable

Public Member Functions

 IlvMenuItemPath (const char *label)
 Constructor. More...
 
const IlPathNamegetPathName () const
 Returns the path. More...
 
void setPathName (const IlPathName &path)
 Sets the path. More...
 
- Public Member Functions inherited from IlvMenuItem
 IlvMenuItem (const char *label)
 Constructor. More...
 
 IlvMenuItem (IlvBitmap *bitmap)
 Constructor. More...
 
 IlvMenuItem (IlvGraphic *graphic)
 Constructor. More...
 
 IlvMenuItem ()
 Constructor. More...
 
virtual void deSelect ()
 Deselects the item. More...
 
void detachMenu (IlBoolean destroy=IlFalse)
 Suppresses the IlvPopupMenu associated with the menu item. More...
 
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. More...
 
IlUShort getAcceleratorKey () const
 Returns the accelerator key of the menu item. More...
 
IlUShort getAcceleratorModifiers () const
 Returns the combination of modifiers used with the menu item accelerator. More...
 
const char * getAcceleratorText () const
 Returns the text describing the accelerator. More...
 
virtual IlUInt getBitmapMask () const
 Returns the bitmap mask of the item. More...
 
IlvGraphicCallback getCallback () const
 Returns a pointer to the item callback. More...
 
IlSymbolgetCallbackName () const
 Returns the symbol that represents the name of the item callback. More...
 
virtual IlvBitmapgetCurrentBitmap () const
 Returns the bitmap that is currently displayed by the item. More...
 
virtual IlvPalettegetInsensitivePalette () const
 Returns the palette used to draw a nonsensitive item. More...
 
IlvPopupMenugetMenu () const
 Returns the IlvPopupMenu displayed by the menu item. More...
 
virtual const char * getMessage () const
 Returns the message of the item. More...
 
const char * getToolTip () const
 Returns the message used in the tooltip associated with the menu item. More...
 
IlvMenuItemType getType () const
 Returns the type of the menu item. More...
 
IlBoolean isChecked () const
 Specifies whether the menu item is checked. More...
 
IlBoolean isRadioToggle () const
 Returns the radio state of the menu item. More...
 
IlBoolean isReadOnly () const
 Indicates whether the menu item is read-only. More...
 
virtual IlBoolean isSelectable () const
 Indicates whether the item can be selected. More...
 
IlBoolean isTearOff () const
 Indicates whether the menu item is a tear-off item. More...
 
IlBoolean isToggle () const
 Indicates whether the menu item is a toggle item. More...
 
virtual void select ()
 Selects the item. More...
 
void setAcceleratorKey (IlUShort key)
 Sets the accelerator key of the menu item. More...
 
void setAcceleratorModifiers (IlUShort modifiers)
 Sets the combination of modifiers used with the menu item accelerator. More...
 
void setAcceleratorText (const char *text)
 Sets the text describing the accelerator. More...
 
void setCallback (IlvGraphicCallback callback)
 Sets the item callback. More...
 
void setCallbackName (IlSymbol *callbackName)
 Sets the name of the item callback. More...
 
void setChecked (IlBoolean value)
 Specifies whether the menu item should be checked. More...
 
void setMenu (IlvPopupMenu *menu, IlBoolean copy=IlTrue)
 Sets the IlvPopupMenu displayed by the menu item. More...
 
void setRadioToggle (IlBoolean value)
 Sets the radio state of the menu item. More...
 
void setReadOnly (IlBoolean value)
 Specifies whether the menu item should be read-only. More...
 
void setTearOff (IlBoolean value=IlTrue)
 Specifies whether the menu item should be a tear-off item. More...
 
void setToggle (IlBoolean value)
 Specifies whether the menu item should be a toggle item. More...
 
void setToolTip (const char *tooltip)
 Sets the message displayed by the tooltip associated with the menu item. More...
 
virtual void sizes (IlvPalette *pal, IlvDim &width, IlvDim &height, IlBoolean margin=IlTrue) const
 Returns the size of the menu item. More...
 
- Public Member Functions inherited from IlvGadgetItem
 IlvGadgetItem (const char *label, IlvBitmap *bitmap=0, IlvPosition position=IlvRight, IlUShort spacing=4, IlBoolean copy=IlTrue)
 Constructor. More...
 
 IlvGadgetItem (const char *label, IlvGraphic *graphic, IlvPosition position=IlvRight, IlUShort spacing=4, IlBoolean copy=IlTrue)
 Constructor. More...
 
 IlvGadgetItem (IlvGraphic *graphic)
 Constructor. More...
 
 IlvGadgetItem (IlvBitmap *bitmap)
 Constructor. More...
 
virtual void activate ()
 Activates the item. More...
 
virtual IlvGadgetItemcopy () const
 Copies this object. More...
 
virtual void draw (IlvPort *dst, const IlvRect &rect, const IlvTransformer *t=0, const IlvRegion *clip=0) const
 Is called to draw the item. More...
 
virtual void drawPicture (IlvPort *dst, const IlvRect &rect, const IlvTransformer *t=0, const IlvRegion *clip=0) const
 Is called to draw the item picture. More...
 
virtual void edit ()
 Edits the item label. More...
 
IlvBitmapgetBitmap (IlUShort index=(IlUShort) 0) const
 Returns the bitmap whose index is specified. More...
 
IlvBitmapgetBitmap (const IlSymbol *symbol) const
 Returns the bitmap corresponding to the specified symbol. More...
 
IlUShort getBitmapCount () const
 Returns the number of bitmaps used by this item. More...
 
IlAny getClientData () const
 Returns the client data of the item. More...
 
IlvGraphicgetGraphic () const
 Returns the IlvGraphic object associated with this item. More...
 
virtual IlUShort getHeight () const
 Returns the item height. More...
 
virtual IlvPalettegetHighlightTextPalette () const
 Returns the palette used to draw the label of highlighted items. More...
 
IlvGadgetItemHoldergetHolder () const
 Returns the item holder. More...
 
const char * getLabel () const
 Returns the item label. More...
 
IlvAlignment getLabelAlignment () const
 Returns the label alignment. More...
 
void getLabelOrientation (IlvOrientation &orientation, IlBoolean &flip) const
 Returns the orientation of the item label. More...
 
IlvPosition getLabelPosition () const
 Returns the position of the label relative to the picture. More...
 
char getMnemonic () const
 Returns the mnemonic letter associated with the item. More...
 
const char * getName () const
 Returns the item name. More...
 
IlvNamedPropertygetNamedProperty (const IlSymbol *name) const
 Returns the property whose name is specified. More...
 
virtual IlvPalettegetNormalTextPalette () const
 Returns the default palette used to draw an item. More...
 
virtual IlvPalettegetOpaquePalette () const
 Returns the palette that is used to draw opaque items. More...
 
IlAny getProperty (const IlSymbol *key) const
 Returns the object property whose symbol is provided as the parameter. More...
 
virtual IlvPalettegetSelectionPalette () const
 Returns the palette used to draw selected items. More...
 
virtual IlvPalettegetSelectionTextPalette () const
 Returns the palette used to draw the label of selected items. More...
 
IlUShort getSpacing () const
 Returns the spacing between the label and the picture of the item. More...
 
virtual IlUShort getWidth () const
 Returns the item width. More...
 
IlBoolean hasProperty (const IlSymbol *key) const
 Indicates whether the item has the property whose symbol is specified. More...
 
virtual void highlight (IlBoolean value=IlTrue)
 Highlights the item. More...
 
IlBoolean isDragDropTarget () const
 Indicates whether the item is the target of a drag-and-drop operation. More...
 
IlBoolean isEditable () const
 Indicates whether the item can be edited. More...
 
IlBoolean isHighlighted () const
 Indicates whether the item is highlighted. More...
 
IlBoolean isOpaque () const
 Indicates whether the item is opaque. More...
 
IlBoolean isSelected () const
 Indicates whether the item is selected. More...
 
IlBoolean isSensitive () const
 Indicates whether the item is sensitive. More...
 
IlBoolean isShowingLabel () const
 Indicates whether the item label is visible. More...
 
IlBoolean isShowingPicture () const
 Indicates whether the item picture is visible. More...
 
virtual void itemRect (IlvRect &rect, const IlvRect &bbox) const
 Returns the item bounding bbox. More...
 
virtual void labelRect (IlvRect &rect, const IlvRect &bbox) const
 Returns the bounding box of the item label. More...
 
virtual void pictureRect (IlvRect &rect, const IlvRect &bbox) const
 Returns the bounding bbox of the item picture. More...
 
virtual void recomputeSize (IlBoolean redraw=IlTrue)
 Recomputes the item geometry. More...
 
void removeAllBitmaps ()
 Removes all the bitmaps associated with the item. More...
 
IlvNamedPropertyremoveNamedProperty (IlSymbol *name)
 Removes the specified named property from the object. More...
 
IlBoolean removeProperty (const IlSymbol *key)
 Removes a property from the object. More...
 
virtual void selectionRect (IlvRect &rect, const IlvRect &bbox) const
 Returns the bounding box of the item selection. More...
 
void setBitmap (IlUShort index, IlvBitmap *bitmap)
 Sets the specified bitmap to the item at the specified index. More...
 
void setBitmap (const IlSymbol *symbol, IlvBitmap *bitmap)
 Sets the specified bitmap to the item using the specified symbol. More...
 
void setBitmap (IlvBitmap *bitmap)
 Sets the sensitive bitmap of the item. More...
 
void setClientData (IlAny data)
 Sets the new client data for this item. More...
 
void setEditable (IlBoolean value)
 Specifies whether the item should be editable. More...
 
void setGraphic (IlvGraphic *graphic)
 Specifies the graphic object associated with this item. More...
 
virtual void setHighlightTextPalette (IlvPalette *palette)
 Sets the palette used to draw the label of highlighted items. More...
 
void setLabel (const char *label, IlBoolean copy=IlTrue)
 Sets the item label. More...
 
void setLabelAlignment (IlvAlignment alignment)
 Sets the label alignment. More...
 
void setLabelOrientation (IlvOrientation orientation, IlBoolean flip=IlFalse)
 Sets the orientation of the item label. More...
 
void setLabelPosition (IlvPosition position)
 Sets the label position relative to the picture. More...
 
void setName (const char *name)
 Sets the item name. More...
 
IlvNamedPropertysetNamedProperty (IlvNamedProperty *property)
 Sets the specified named property to the object. More...
 
virtual void setNormalTextPalette (IlvPalette *palette)
 Sets the default palette used to draw an item. More...
 
void setOpaque (IlBoolean value)
 Specifies whether the item should be opaque. More...
 
virtual void setOpaquePalette (IlvPalette *palette)
 Sets the palette used to draw opaque items. More...
 
void setProperty (const IlSymbol *key, IlAny value)
 Sets the property whose symbol is specified to the item. More...
 
virtual void setSelectionTextPalette (IlvPalette *palette)
 Sets the palette used to draw the label of selected items. More...
 
void setSensitive (IlBoolean value)
 Specifies whether the item should be sensitive or not. More...
 
void setSpacing (IlUShort spacing)
 Sets the spacing between the label and the picture of the item. More...
 
void showLabel (IlBoolean value=IlTrue)
 Specifies whether the item label should be shown. More...
 
void showPicture (IlBoolean value=IlTrue)
 Specifies whether the item picture should be shown. More...
 
virtual void write (IlvOutputFile &file) const
 Writes an object description to a file. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvMenuItem
static IlSymbolCheckedBitmapSymbol ()
 Returns the symbol of the checked bitmap. More...
 
- Static Public Member Functions inherited from IlvGadgetItem
static void AddItemBitmapSymbol (const IlSymbol *symbol, IlUShort index)
 Links a new bitmap symbol with the specified index. More...
 
static IlSymbolBitmapSymbol ()
 Returns the symbol associated with the sensitive bitmap. More...
 
static IlShort GetItemBitmapIndex (const IlSymbol *symbol)
 Returns the index corresponding to the specified symbol. More...
 
static IlSymbolGetItemBitmapSymbol (IlUShort index)
 Returns the symbol corresponding to the specified index. More...
 
static IlSymbolHighlightedBitmapSymbol ()
 Returns the symbol associated with the highlighted bitmap. More...
 
static IlSymbolInsensitiveBitmapSymbol ()
 Returns the symbol associated with the nonsensitive bitmap. More...
 
static IlvGadgetItemreadItem (IlvInputFile &file, IlvDisplay *display)
 Reads an object description from a file. More...
 
static IlSymbolSelectedBitmapSymbol ()
 Returns the symbol associated with the selected bitmap. More...
 
- Protected Member Functions inherited from IlvMenuItem
virtual void computeSize (IlUShort &, IlUShort &) const
 Computes the item size. More...
 
- Protected Member Functions inherited from IlvGadgetItem
virtual void computeRects (IlvRect &labelRect, IlvRect &pictureRect) const
 Computes the label and picture bounding boxes. More...
 

Detailed Description

Menu item class which stores a path.

Library: ilvadvgdt

This menu item class is used by the IlvToolBarPath objects to store a path for each item of the toolbar and of the pop-up menus.

See also
IlvToolBarPath, IlvMenuItem

Constructor & Destructor Documentation

§ IlvMenuItemPath()

IlvMenuItemPath::IlvMenuItemPath ( const char *  label)

Constructor.

Initializes a new instance of the IlvMenuItem class.

Parameters
labelThe label of the menu item.

Member Function Documentation

§ getPathName()

const IlPathName& IlvMenuItemPath::getPathName ( ) const

Returns the path.

Returns
The full path which corresponds to the label of the menu item.

§ setPathName()

void IlvMenuItemPath::setPathName ( const IlPathName path)

Sets the path.

Sets the full path which corresponds to the label of the menu item.

Parameters
pathThe path.

© Copyright 2018, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.