Views
Gadgets Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvToolBarPath Class Reference

ToolBar class which displays a path like a set of pop-up menus. More...

#include <ilviews/gadgets/toolpath.h>

Inheritance diagram for IlvToolBarPath:
IlvToolBar IlvAbstractBar IlvAbstractMenu IlvGadget IlvListGadgetItemHolder IlvSimpleGraphic IlvStylable IlvGadgetItemHolder IlvGraphic IlvValueInterface

Public Member Functions

 IlvToolBarPath (IlvDisplay *display, const IlvRect &rect)
 Constructor. More...
 
virtual void changeDir (const IlPathName &path)
 Called when the user selects a new path. More...
 
virtual IlvPopupMenucreateDeviceMenu (const IlString &current)
 Creates a device pop-up menu. More...
 
virtual IlvPopupMenucreateDirectoryMenu (const IlPathName &path)
 Creates a directory pop-up menu. More...
 
virtual IlvMenuItemPathcreateMenuItem (const IlString &label, const IlPathName &path, IlvPopupMenu *submenu=0)
 Creates a menu item. More...
 
const char * getPath () const
 Returns the path. More...
 
virtual void rewindDir (const IlPathName &path)
 Called when the user selects a directory in the path. More...
 
void setChangeDirCallback (IlvToolBarPathCallback cb, IlAny arg=0)
 Sets the callback invoked when the user selects a new path. More...
 
virtual void setPath (const IlPathName &path)
 Sets the path. More...
 
void setRewindCallback (IlvToolBarPathCallback cb, IlAny arg=0)
 Sets the callback invoked when the user selects a directory in the path. More...
 
- Public Member Functions inherited from IlvToolBar
 IlvToolBar (IlvDisplay *display, const IlvPoint &point, const char *const *labels=0, IlUShort count=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
 IlvToolBar (IlvDisplay *display, const IlvPoint &point, IlvMenuItem *items, IlUShort count, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
 IlvToolBar (IlvDisplay *display, const IlvRect &rect, const char *const *labels=0, IlUShort count=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Constructor. More...
 
 IlvToolBar (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...
 
virtual void empty ()
 Empties the list. More...
 
IlvMenuItemgetFocusItem () const
 Returns the menu item in the toolbar that has the keyboard focus. More...
 
IlBoolean hasToolTips () const
 Indicates whether the toolbar displays tooltips. More...
 
virtual void internalBBox (IlvRect &, const IlvTransformer *t=0) const
 Returns the internal bounding box of the bar. More...
 
virtual IlBoolean isSelectable (const IlvMenuItem *) const
 Indicates whether the specified item can be selected. More...
 
void setFocusItem (IlvMenuItem *item)
 Gives the keyboard focus to the specified toolbar item. More...
 
void setItemSelected (IlUShort index, IlBoolean value=IlTrue)
 Specifies whether the specified menu item should be selected. More...
 
void useToolTips (IlBoolean value)
 Specifies whether the toolbar should display tooltips. 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 IlvPoint &point, IlvMenuItem *items, IlUShort count, 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 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 (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 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...
 
IlvMenuItemgetItem (IlUShort index) const
 Returns the menu item at the specified index. More...
 
virtual IlvGadgetItemgetItemByName (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 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...
 
IlvPopupMenugetSubMenu (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 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 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 (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 IlvGadgetItemapplyToItems (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...
 
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 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
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...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvToolBar
static IlBoolean AreToolTipsEnabled ()
 Indicates whether pop-up menus should display tooltips. More...
 
static void EnableToolTips (IlBoolean value=IlTrue)
 Specifies whether toolbars should display tooltips. More...
 
- 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...
 
- Static Public Member Functions inherited from IlvAbstractMenu
static IlSymbolHighlightCBSymbol ()
 Returns the callback type for the Highlight callback. More...
 
- Static Public Member Functions inherited from IlvGadgetItemHolder
static IlSymbolAbortDragItemCallbackType ()
 Returns the callback type of the Abort Drag callback. More...
 
static IlSymbolAbortEditItemCallbackType ()
 Returns the callback type of the Abort Edit callback. More...
 
static IlSymbolActivateCallbackType ()
 Returns the callback type of the Activate callback. More...
 
static IlSymbolDragItemCallbackType ()
 Returns the callback type of the Drag Item callback. More...
 
static IlSymbolEndDragItemCallbackType ()
 Returns the callback type of the End Drag callback. More...
 
static IlSymbolEndEditItemCallbackType ()
 Returns the callback type of the End Edit callback. More...
 
static IlSymbolStartDragItemCallbackType ()
 Returns the callback type of the Start Drag callback. More...
 
static IlSymbolStartEditItemCallbackType ()
 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

ToolBar class which displays a path like a set of pop-up menus.

Library: ilvadvgdt

This toolbar class displays a path as a set of pop-up menus. Each directory of the path becomes a button of the toolbar. Between each button, a pop-up menu displays the directory list from the same level as the path associated with the button. When the user clicks a button or chooses a menu entry, a callback is invoked with the path chosen by the user. Note: This class has been designed for the IlvFileChooser dialog. It cannot be saved into an Ilv file.

See also
IlvMenuItemPath, IlvFileChooser

Constructor & Destructor Documentation

◆ IlvToolBarPath()

IlvToolBarPath::IlvToolBarPath ( IlvDisplay display,
const IlvRect rect 
)

Constructor.

Initializes a new instance of the IlvToolBarPath class.

Parameters
displayThe connection to the display.
rectThe size and position of the toolbar.

Member Function Documentation

◆ changeDir()

virtual void IlvToolBarPath::changeDir ( const IlPathName path)
virtual

Called when the user selects a new path.

Called when the user selects a new path from a pop-up menu.

Parameters
pathThe path which corresponds to the selection.

◆ createDeviceMenu()

virtual IlvPopupMenu* IlvToolBarPath::createDeviceMenu ( const IlString current)
virtual

Creates a device pop-up menu.

Returns a new pop-up menu whichs contains the different devices. On Unix platforms, this method returns 0 because the devices are specific to Windows.

Parameters
currentThe current device of the current path.
Returns
A new pop-up menu which contains the different devices.

◆ createDirectoryMenu()

virtual IlvPopupMenu* IlvToolBarPath::createDirectoryMenu ( const IlPathName path)
virtual

Creates a directory pop-up menu.

Returns a new pop-up menu whichs contains the directories in the path. The directories named . and .. are ignored.

Parameters
pathThe path
Returns
A new pop-up menu whichs contains the directories in the path.

◆ createMenuItem()

virtual IlvMenuItemPath* IlvToolBarPath::createMenuItem ( const IlString label,
const IlPathName path,
IlvPopupMenu submenu = 0 
)
virtual

Creates a menu item.

Creates a new menu item.

Parameters
labelThe label of the menu item.
pathThe path associated with the menu item.
submenuThe list of directories.
Returns
A new menu item.

◆ getPath()

const char* IlvToolBarPath::getPath ( ) const

Returns the path.

Returns
The full path displayed by the toolbar.

◆ rewindDir()

virtual void IlvToolBarPath::rewindDir ( const IlPathName path)
virtual

Called when the user selects a directory in the path.

Called when the user selects a directory or the device of the current path.

Parameters
pathThe path which corresponds to the selection.

◆ setChangeDirCallback()

void IlvToolBarPath::setChangeDirCallback ( IlvToolBarPathCallback  cb,
IlAny  arg = 0 
)

Sets the callback invoked when the user selects a new path.

Sets the callback invoked when the user selects a new path from a pop-up menu.

Parameters
cbThe callback.
argThe user parameter that was provided to the member function that calls this function.

◆ setPath()

virtual void IlvToolBarPath::setPath ( const IlPathName path)
virtual

Sets the path.

Sets the full path to display as a set of buttons and pop-up menus.

Parameters
pathThe path.

◆ setRewindCallback()

void IlvToolBarPath::setRewindCallback ( IlvToolBarPathCallback  cb,
IlAny  arg = 0 
)

Sets the callback invoked when the user selects a directory in the path.

Sets the callback invoked when the user selects a directory or the device of the current path.

Parameters
cbThe callback.
argThe user parameter that was provided to the member function that calls this function.