 |
Rogue Wave Views Gadgets Package API Reference Guide |
Rogue Wave Views Documentation Home |
|
Rogue Wave Views Gadgets Package API Reference Guide |
Rogue Wave Views Documentation Home |
ToolBar class which displays a path like a set of pop-up menus. More...
#include <ilviews/gadgets/toolpath.h>
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 IlvPopupMenu * | createDeviceMenu (const IlString ¤t) |
| Creates a device pop-up menu. More... | |
| virtual IlvPopupMenu * | createDirectoryMenu (const IlPathName &path) |
| Creates a directory pop-up menu. More... | |
| virtual IlvMenuItemPath * | createMenuItem (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 IlvRect &rect, 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, 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... | |
| IlvMenuItem * | getFocusItem () 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 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 submenus=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... | |
| 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 (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 | 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 (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 | 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... | |
| virtual IlvPalette * | getHighlightTextPalette () const |
| Returns the highlight palette used to draw the label of highlighted items. 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... | |
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 IlSymbol * | GeometryChangedCallbackType () |
| Returns the callback type for the Geometry Changed callback. More... | |
| static IlSymbol * | OrientationChangedCallbackType () |
| Returns the callback type for the Orientation Changed callback. 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... | |
| 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... | |
| 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... | |
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.
| IlvToolBarPath::IlvToolBarPath | ( | IlvDisplay * | display, |
| const IlvRect & | rect | ||
| ) |
Constructor.
Initializes a new instance of the IlvToolBarPath class.
| display | The connection to the display. |
| rect | The size and position of the toolbar. |
|
virtual |
Called when the user selects a new path.
Called when the user selects a new path from a pop-up menu.
| path | The path which corresponds to the selection. |
|
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.
| current | The current device of the current 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.
| path | The path |
|
virtual |
Creates a menu item.
Creates a new menu item.
| label | The label of the menu item. |
| path | The path associated with the menu item. |
| submenu | The list of directories. |
| const char* IlvToolBarPath::getPath | ( | ) | const |
Returns the 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.
| path | The path which corresponds to the selection. |
| 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.
| cb | The callback. |
| arg | The user parameter that was provided to the member function that calls this function. |
|
virtual |
Sets the path.
Sets the full path to display as a set of buttons and pop-up menus.
| path | The path. |
| 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.
| cb | The callback. |
| arg | The user parameter that was provided to the member function that calls this function. |
© Copyright 2016, 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.
