rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Friends
IlvMenuBar Class Reference

Gadget class. More...

#include <ilviews/gadgets/menubar.h>

Inheritance diagram for IlvMenuBar:
IlvAbstractBar IlvAbstractMenu IlvGadget IlvListGadgetItemHolder IlvSimpleGraphic IlvGadgetItemHolder IlvGraphic

Public Member Functions

 IlvMenuBar (IlvDisplay *display, const IlvPoint &point, const char *const *labels=0, IlUShort count=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
 IlvMenuBar (IlvDisplay *display, const IlvRect &rect, const char *const *labels=0, IlUShort count=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
 IlvMenuBar (IlvDisplay *display, const IlvPoint &point, IlvMenuItem *items, IlUShort count, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
 IlvMenuBar (IlvDisplay *display, const IlvRect &rect, IlvMenuItem *items, IlUShort count, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
virtual void drawGadgetItem (const IlvGadgetItem *, IlvPort *port, const IlvRect &rect, const IlvTransformer *t=0, const IlvRegion *clip=0) const
 Draws a specific gadget item. More...
 
void internalBBox (IlvRect &, const IlvTransformer *t=0) const
 Returns the internal bounding box of the bar. More...
 
- Public Member Functions inherited from IlvAbstractBar
 IlvAbstractBar (IlvDisplay *display, const IlvPoint &point, const char *const *labels=0, IlUShort count=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
 IlvAbstractBar (IlvDisplay *display, const IlvRect &rect, const char *const *labels=0, IlUShort count=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
 IlvAbstractBar (IlvDisplay *display, const IlvPoint &point, IlvMenuItem *items, IlUShort count, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
 IlvAbstractBar (IlvDisplay *display, const IlvRect &rect, IlvMenuItem *items, IlUShort count, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
virtual void geometryChanged (const IlvRect &rect)
 Is called when the bar geometry has changed. More...
 
void getDefaultItemSize (IlvDim &width, IlvDim &height) const
 Returns the default item size. More...
 
virtual IlvDirection getOrientation () const
 Returns the orientation of the bar. More...
 
IlvDim getSpacing () const
 Returns the spacing between two items. More...
 
IlBoolean isFlushingRight () const
 Indicates whether the bar is flush-right. 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 orientationChanged ()
 Is called when the bar orientation has changed. More...
 
virtual void select (IlUShort pos)
 Is called when an item has been selected. More...
 
void setConstraintMode (IlBoolean value)
 Sets the constraint mode of the bar. More...
 
void setDefaultItemSize (IlvDim width, IlvDim height, IlBoolean redraw=IlTrue)
 Sets the default item size. More...
 
void setFlushingRight (IlBoolean value)
 Specifies whether the bar should be flush-right. More...
 
void setHeight (IlvDim height)
 Sets the height of the bar. More...
 
void setOrientation (IlvDirection orientation)
 Sets the orientation of the bar. More...
 
void setSpacing (IlvDim spacing)
 Sets the spacing between two items. More...
 
void setWidth (IlvDim width)
 Sets the bar width. More...
 
virtual void unSelect (IlUShort pos)
 Is called when an item has been deselected. More...
 
IlBoolean useConstraintMode () const
 Indicates whether the bar is in constraint mode. More...
 
- Public Member Functions inherited from IlvAbstractMenu
void addHighlightCallback (IlvGraphicCallback callback, IlBoolean sub=IlTrue)
 Adds a "Highlight" callback to the menu. More...
 
void addHighlightCallback (const IlSymbol *callbackName, IlBoolean submenus=IlTrue)
 Adds a named "Highlight" callback to the menu. More...
 
virtual IlvGadgetItemcreateItem (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...
 
virtual void empty ()
 Empties the list. More...
 
virtual IlvGadgetItemgetItemByName (const char *) 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 IlvPalettegetNormalTextPalette () const
 Returns the default palette used to draw an item. More...
 
virtual IlvPalettegetOpaquePalette () const
 Returns the opaque palette used to draw opaque items. More...
 
IlUShort insertItem (IlvMenuItem *item, IlShort pos=-1)
 Inserts a menu item at the specified position. More...
 
IlUShort insertItem (IlUShort pos, const char *label, const IlvPopupMenu *menu=0, IlBoolean copy=IlTrue)
 Inserts a menu item that has a label. 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
 Returns IlTrue 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 position indicated by point. More...
 
virtual void recomputeAllItems ()
 Recomputes the size of all the items managed by the holder. 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 (IlvGraphicCallback callback, IlBoolean submenus=IlTrue)
 Sets a "Highlight" callback to the menu. More...
 
void setHighlightCallback (const IlSymbol *callbackName, IlBoolean submenus=IlTrue)
 Sets a named "Highlight" callback to the menu. More...
 
void setItems (IlvMenuItem *const *items, IlUShort count)
 Replaces the entire list of items in the menu. More...
 
virtual void setItems (IlvGadgetItem *const *items, IlUShort count)
 Replaces the entire list of items. 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 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 IlvGadgetItemapplyToItems (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...
 
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...
 
IlvGadgetItemgetItem (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 ith 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
IlvGadgetItemgetCallbackItem () const
 Returns the item that triggered a callback. More...
 
IlvGadgetItemgetDragDropTarget () const
 Returns the target item of a drag-and-drop operation. More...
 
IlvGraphicgetDraggedImage () const
 Returns the graphic object used to draw the ghost image during a drag-and-drop operation. More...
 
IlvGadgetItemgetDraggedItem () const
 Returns the item that is being dragged during a drag-and-drop operation. More...
 
IlvGadgetItemgetEditedItem () const
 Returns the item that is being edited. More...
 
virtual IlvPalettegetHighlightTextPalette () const
 Returns the highlight palette used to draw the label of highlighted items. More...
 
IlvGadgetItemgetToolTipItem () 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 IlvDefaultMenuBarLFHandler
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvAbstractBar
static IlSymbolGeometryChangedCallbackType ()
 Returns the callback type for the Geometry Changed callback. More...
 
static IlSymbolOrientationChangedCallbackType ()
 Returns the callback type for the Orientation Changed callback. More...
 
- Protected Member Functions inherited from IlvAbstractMenu
 IlvAbstractMenu (IlvDisplay *display, IlUShort count=0, const char *const *labels=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
 IlvAbstractMenu (IlvDisplay *display, IlUShort count, IlvMenuItem *items, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
virtual void itemActivated (IlvGadgetItem *)
 Is called when an item is activated. More...
 

Detailed Description

Gadget class.

Library: ilvgadgt

The IlvMenuBar class defines a typical menu bar.

- IlvMenuBar -

A menu bar is composed of a number of items that provide access to menus from which the user can select a command.

See Also
IlvMenuItem, IlvPopupMenu, IlvToolBar

Constructor & Destructor Documentation

IlvMenuBar::IlvMenuBar ( 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 IlvMenuBar class. The size of the object is computed by calling the IlvGadget::fitToContents method. If you want the menu bar to have a specific size, use a constructor that takes an IlvRect reference instead of an IlvPoint object as parameter. The labels are copied.

Parameters
displayThe connection to the display.
pointThe position of the menu bar.
labelsAn array of predefined labels.
countThe number of elements in the labels array.
thicknessThe thickness of the menu bar.
paletteThe palette used to draw the menu bar.
IlvMenuBar::IlvMenuBar ( 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 IlvMenuBar class. The labels are copied.

Parameters
displayThe connection to the display.
rectThe size and position of the menu bar.
labelsAn array of predefined labels.
countThe number of elements in the labels array.
thicknessThe thickness of the menu bar.
paletteThe palette used to draw the menu bar.
IlvMenuBar::IlvMenuBar ( IlvDisplay display,
const IlvPoint point,
IlvMenuItem items,
IlUShort  count,
IlUShort  thickness = IlvDefaultGadgetThickness,
IlvPalette palette = 0 
)

Constructor.

Initializes a new instance of the IlvMenuBar class. The size of the object is computed by calling the IlvGadget::fitToContents method. If you want to give the menu bar a specific size, use a constructor that takes an IlvRect reference instead of an IlvPoint object as parameter. The items are copied.

Parameters
displayThe connection to the display.
pointThe position of the menu bar.
itemsAn array of predefined items.
countThe number of elements in the items array.
thicknessThe thickness of the menu bar.
paletteThe palette used to draw the menu bar.
IlvMenuBar::IlvMenuBar ( IlvDisplay display,
const IlvRect rect,
IlvMenuItem items,
IlUShort  count,
IlUShort  thickness = IlvDefaultGadgetThickness,
IlvPalette palette = 0 
)

Constructor.

Initializes a new instance of the IlvMenuBar class. The items are copied.

Parameters
displayThe display connection.
rectThe size and position of the menu bar.
itemsAn array of predefined items.
countThe number of elements in the items array.
thicknessThe thickness of the menu bar.
paletteThe palette used by the menu bar.

Member Function Documentation

virtual void IlvMenuBar::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
itemThe item to be redrawn.
portThe destination drawing port.
rectThe bounding box of the item.
tThe transformer used to draw the item. Not used.
clipThe clipping area.
See Also
IlvGadgetItem::draw.

Reimplemented from IlvAbstractBar.

void IlvMenuBar::internalBBox ( IlvRect rect,
const IlvTransformer t = 0 
) const
virtual

Returns the internal bounding box of the bar.

Uses rect to return the internal bounding box of the bar when the object is computed with the transformer t. The internal bounding box delimits the area within which the bar items are drawn. You can override this member function in a subclass to change the internal bounding box.

Parameters
rectThe internal bounding box of the bar.
tThe transformer used to compute the internal bounding box.

Reimplemented from IlvAbstractBar.


© Copyright 2012, 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.