Rogue Wave Views 5.6
Rogue Wave Views
Gadgets Package API Reference Guide
Rogue Wave Views
Documentation Home
Rogue Wave Views 5.6 |
Rogue Wave Views |
Rogue Wave Views Documentation Home |
Item holder class. More...
#include <ilviews/gadgets/itemgdt.h>
Public Member Functions | |
| virtual IlvGadgetItem * | applyToItems (IlvApplyGadgetItem func, IlAny arg) |
| Applies the specified function to all the items of the holder. | |
| virtual IlvGadgetItem * | createItem (const char *label, IlvGraphic *graphic=0, IlvBitmap *bitmap=0, IlvBitmap *selbitmap=0, IlBoolean copy=IlTrue) const |
| Returns a new gadget item. | |
| virtual void | drawGadgetItem (const IlvGadgetItem *item, IlvPort *port, const IlvRect &rect, const IlvTransformer *t=0, const IlvRegion *clip=0) const |
| Draws a specific gadget item. | |
| IlvGadgetItem * | getCallbackItem () const |
| Returns the item that triggered a callback. | |
| IlvGadgetItem * | getDragDropTarget () const |
| Returns the target item of a drag-and-drop operation. | |
| IlvGraphic * | getDraggedImage () const |
| Returns the graphic object used to draw the ghost image during a drag-and-drop operation. | |
| IlvGadgetItem * | getDraggedItem () const |
| Returns the item that is being dragged during a drag-and-drop operation. | |
| IlvGadgetItem * | getEditedItem () const |
| Returns the item that is being edited. | |
| virtual IlvPalette * | getHighlightTextPalette () const |
| Returns the highlight palette used to draw the label of highlighted items. | |
| virtual IlvPalette * | getInsensitivePalette () const =0 |
| Returns the palette used to draw an item that is not sensitive. | |
| virtual IlvGadgetItem * | getItemByName (const char *name) const |
| Returns the item whose name is specified. | |
| virtual IlvPalette * | getNormalTextPalette () const =0 |
| Returns the default palette used to draw an item. | |
| virtual IlvPalette * | getOpaquePalette () const |
| Returns the opaque palette used to draw opaque items. | |
| virtual IlvPalette * | getSelectionPalette () const =0 |
| Returns the selection palette used to draw selected items. | |
| virtual IlvPalette * | getSelectionTextPalette () const =0 |
| Returns the selection palette used to draw the label of selected items. | |
| IlvGadgetItem * | getToolTipItem () const |
| Returns the item that is displaying a tooltip. | |
| virtual void | initReDrawItems () |
| Begins a redraw session. | |
| virtual void | recomputeAllItems () |
| Recomputes the size of all the items managed by the holder. | |
| virtual void | reDrawItems () |
| Ends a redraw session. | |
| void | setDragDropTarget (IlvGadgetItem *item) |
| Sets the target item of a drag-and-drop operation. | |
| void | setDraggedImage (IlvGraphic *graphic) |
| Sets the graphic object used to draw the ghost image during a drag-and-drop operation. | |
| void | setDraggedItem (IlvGadgetItem *item) |
| Sets the dragged item. | |
Static Public Member Functions | |
| static IlSymbol * | AbortDragItemCallbackType () |
| Returns the callback type of the Abort Drag callback. | |
| static IlSymbol * | AbortEditItemCallbackType () |
| Returns the callback type of the Abort Edit callback. | |
| static IlSymbol * | ActivateCallbackType () |
| Returns the callback type of the Activate callback. | |
| static IlSymbol * | DragItemCallbackType () |
| Returns the callback type of the Drag Item callback. | |
| static IlSymbol * | EndDragItemCallbackType () |
| Returns the callback type of the End Drag callback. | |
| static IlSymbol * | EndEditItemCallbackType () |
| Returns the callback type of the End Edit callback. | |
| static IlSymbol * | StartDragItemCallbackType () |
| Returns the callback type of the Start Drag callback. | |
| static IlSymbol * | StartEditItemCallbackType () |
| Returns the callback type of the Start Edit callback. | |
Protected Member Functions | |
| virtual void | abortDragItem () |
| Is called when a drag-and-drop operation is aborted. | |
| virtual void | abortEdit (IlvGadgetItem *item) |
| Is called when the editing of the specified item is aborted. | |
| virtual void | drawDraggedImage (const IlvPoint &point, const IlvTransformer *t) |
| Is called to draw the ghost image during a drag-and-drop operation. | |
| virtual void | endDragItem (const IlvPoint &point) |
| Is called when a drag-and-drop operation is finished. | |
| virtual void | endEdit (IlvGadgetItem *item) |
| Is called after an item has been edited. | |
| virtual void | itemActivated (IlvGadgetItem *item) |
| Is called when an item is activated. | |
| virtual void | itemDeSelected (IlvGadgetItem *item) |
| Is called when an item is deselected. | |
| virtual void | itemDragged (const IlvPoint &point) |
| Is called each time the user moves the mouse during a drag-and-drop operation. | |
| virtual void | itemHighlighted (IlvGadgetItem *item) |
| Is called when an item is highlighted or unhighlighted. | |
| virtual void | itemSelected (IlvGadgetItem *item) |
| Is called when an item is selected. | |
| virtual void | startDragItem (IlvGadgetItem *item) |
| Is called when a drag-and-drop operation begins. | |
| virtual void | startEdit (IlvGadgetItem *item) |
| Is called when an item is edited. | |
Friends | |
| class | IlvGadgetItem |
Item holder class.
Library: ilvgadgt
IlvGadgetItemHolder is an abstract class used to manage IlvGadgetItem objects.
IlvGadgetItem, IlvListGadgetItemHolder. | virtual void IlvGadgetItemHolder::abortDragItem | ( | ) | [protected, virtual] |
Is called when a drag-and-drop operation is aborted.
This member function is called when the users cancels a drag-and-drop operation by pressing the Escape key. Its default implementation calls the Abort Drag callback.
| static IlSymbol* IlvGadgetItemHolder::AbortDragItemCallbackType | ( | ) | [static] |
Returns the callback type of the Abort Drag callback.
The Abort Drag callback is invoked when the use presses the Escape key during a drag-and-drop operation.
| virtual void IlvGadgetItemHolder::abortEdit | ( | IlvGadgetItem * | item | ) | [protected, virtual] |
Is called when the editing of the specified item is aborted.
This member function is called when the users cancels editing by pressing the Escape key. Its default implementation calls the Abort Edit callback.
| item | The edited gadget item. |
| static IlSymbol* IlvGadgetItemHolder::AbortEditItemCallbackType | ( | ) | [static] |
Returns the callback type of the Abort Edit callback.
The Abort Edit callback is invoked when the use presses the Escape key while editing an item.
StartEditItemCallbackType, EndEditItemCallbackType. | static IlSymbol* IlvGadgetItemHolder::ActivateCallbackType | ( | ) | [static] |
Returns the callback type of the Activate callback.
The Activate callback is invoked when an item is activated.
| virtual IlvGadgetItem* IlvGadgetItemHolder::applyToItems | ( | IlvApplyGadgetItem | func, | |
| IlAny | arg | |||
| ) | [virtual] |
Applies the specified function to all the items of the holder.
| func | The function to be applied. | |
| arg | The argument that will be passed to the function func. |
IlvApplyGadgetItem for details. IlvApplyGadgetItem, recomputeAllItems, getItemByName. Reimplemented in IlvListGadgetItemHolder, IlvMatrix, IlvMessageLabel, IlvNotebook, and IlvTreeGadgetItemHolder.
| virtual IlvGadgetItem* IlvGadgetItemHolder::createItem | ( | const char * | label, | |
| IlvGraphic * | graphic = 0, |
|||
| IlvBitmap * | bitmap = 0, |
|||
| IlvBitmap * | selbitmap = 0, |
|||
| IlBoolean | copy = IlTrue | |||
| ) | const [virtual] |
Returns a new gadget item.
You can override this member function in a subclass to create your own items.
| label | The item label. | |
| graphic | The IlvGraphic object representing the picture associated with the item. | |
| bitmap | The IlvBitmap object representing the picture associated with the item. | |
| selbitmap | The IlvBitmap object representing the picture of the item when it is selected. | |
| copy | A Boolean value specifying whether a label should be copied. If the value is IlFalse |
[note] If both the second and third parameters are not null, only the second parameter is used. The created gadget item. Reimplemented in IlvAbstractMenu, IlvComboBox, IlvFileChooserTree, IlvFileChooserSheet, IlvNotebook, IlvOptionMenu, IlvTreeGadgetItemHolder, and IlvTreeGadget.
| static IlSymbol* IlvGadgetItemHolder::DragItemCallbackType | ( | ) | [static] |
Returns the callback type of the Drag Item callback.
The Drag Item callback is invoked each time the user moves the mouse during a drag-and-drop operation.
| virtual void IlvGadgetItemHolder::drawDraggedImage | ( | const IlvPoint & | point, | |
| const IlvTransformer * | t | |||
| ) | [protected, virtual] |
Is called to draw the ghost image during a drag-and-drop operation.
The drawing takes place at the location specified by point.
| point | The location where the ghost image is drawn, expressed in global coordinates. | |
| t | Not used. |
| virtual void IlvGadgetItemHolder::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.
| item | The item to be redrawn. | |
| port | The destination drawing port. | |
| rect | The bounding box of the item. | |
| t | The transformer used to draw the item. Not used. | |
| clip | The clipping area. |
IlvGadgetItem::draw. Reimplemented in IlvAbstractBar, IlvButton, IlvFrame, IlvPopupMenu, IlvMenuBar, IlvStringList, IlvToolBar, and IlvTreeGadget.
| virtual void IlvGadgetItemHolder::endDragItem | ( | const IlvPoint & | point | ) | [protected, virtual] |
Is called when a drag-and-drop operation is finished.
The default implementation invokes the End Drag callback.
| point | The location where the dragged item is dropped expressed in global coordinates. |
| static IlSymbol* IlvGadgetItemHolder::EndDragItemCallbackType | ( | ) | [static] |
Returns the callback type of the End Drag callback.
The End Drag callback is invoked at the end of a drag-and-drop operation.
| virtual void IlvGadgetItemHolder::endEdit | ( | IlvGadgetItem * | item | ) | [protected, virtual] |
Is called after an item has been edited.
The default implementation calls the End Edit callback.
| item | The edited gadget item. |
Reimplemented in IlvMatrix.
| static IlSymbol* IlvGadgetItemHolder::EndEditItemCallbackType | ( | ) | [static] |
Returns the callback type of the End Edit callback.
The End Edit callback is invoked just after the item is edited.
StartEditItemCallbackType., AbortEditItemCallbackType. | IlvGadgetItem* IlvGadgetItemHolder::getCallbackItem | ( | ) | const |
Returns the item that triggered a callback.
Reimplemented in IlvTreeGadget.
| IlvGadgetItem* IlvGadgetItemHolder::getDragDropTarget | ( | ) | const |
Returns the target item of a drag-and-drop operation.
setDragDropTarget. | IlvGraphic* IlvGadgetItemHolder::getDraggedImage | ( | ) | const |
Returns the graphic object used to draw the ghost image during a drag-and-drop operation.
setDraggedImage. | IlvGadgetItem* IlvGadgetItemHolder::getDraggedItem | ( | ) | const |
Returns the item that is being dragged during a drag-and-drop operation.
setDraggedItem. | IlvGadgetItem* IlvGadgetItemHolder::getEditedItem | ( | ) | const |
Returns the item that is being edited.
0 if no item is being edited. | virtual IlvPalette* IlvGadgetItemHolder::getHighlightTextPalette | ( | ) | const [virtual] |
Returns the highlight palette used to draw the label of highlighted items.
Reimplemented in IlvPopupMenu.
| virtual IlvPalette* IlvGadgetItemHolder::getInsensitivePalette | ( | ) | const [pure virtual] |
Returns the palette used to draw an item that is not sensitive.
Implemented in IlvMatrix.
| virtual IlvGadgetItem* IlvGadgetItemHolder::getItemByName | ( | const char * | name | ) | const [virtual] |
Returns the item whose name is specified.
| name | The name of the item. |
0 if the specified item cannot be found. IlvGadgetItem::setName, applyToItems. Reimplemented in IlvAbstractMenu.
| virtual IlvPalette* IlvGadgetItemHolder::getNormalTextPalette | ( | ) | const [pure virtual] |
Returns the default palette used to draw an item.
Implemented in IlvAbstractMenu, IlvComboBox, IlvMatrix, IlvMessageLabel, IlvNotebook, IlvOptionMenu, IlvStringList, and IlvTreeGadget.
| virtual IlvPalette* IlvGadgetItemHolder::getOpaquePalette | ( | ) | const [virtual] |
Returns the opaque palette used to draw opaque items.
Reimplemented in IlvAbstractMenu, IlvComboBox, IlvMatrix, IlvMessageLabel, IlvNotebook, IlvOptionMenu, IlvStringList, and IlvTreeGadget.
| virtual IlvPalette* IlvGadgetItemHolder::getSelectionPalette | ( | ) | const [pure virtual] |
Returns the selection palette used to draw selected items.
Implemented in IlvMatrix.
| virtual IlvPalette* IlvGadgetItemHolder::getSelectionTextPalette | ( | ) | const [pure virtual] |
Returns the selection palette used to draw the label of selected items.
Implemented in IlvMatrix.
| IlvGadgetItem* IlvGadgetItemHolder::getToolTipItem | ( | ) | const |
Returns the item that is displaying a tooltip.
0 if no tooltip is displayed. | virtual void IlvGadgetItemHolder::initReDrawItems | ( | ) | [virtual] |
Begins a redraw session.
Redrawing is performed with the member function IlvGadgetItemHolder::reDrawItems, which allows you to group drawing operations. Calls to IlvGadgetItemHolder::initRedrawsItems can be nested.
reDrawItems. | virtual void IlvGadgetItemHolder::itemActivated | ( | IlvGadgetItem * | item | ) | [protected, virtual] |
Is called when an item is activated.
The default implementation calls the Activate callback.
| item | The activated gadget item. |
Reimplemented in IlvAbstractMenu, IlvMatrix, and IlvTreeGadget.
| virtual void IlvGadgetItemHolder::itemDeSelected | ( | IlvGadgetItem * | item | ) | [protected, virtual] |
Is called when an item is deselected.
The default implementation does nothing.
| item | The deselected gadget item. |
Reimplemented in IlvTreeGadget.
| virtual void IlvGadgetItemHolder::itemDragged | ( | const IlvPoint & | point | ) | [protected, virtual] |
Is called each time the user moves the mouse during a drag-and-drop operation.
The default implementation invokes the Drag Item callback.
| point | The location where the item is dragged, in global coordinates. |
| virtual void IlvGadgetItemHolder::itemHighlighted | ( | IlvGadgetItem * | item | ) | [protected, virtual] |
Is called when an item is highlighted or unhighlighted.
The default implementation does nothing.
| item | The highlighted gadget item. |
| virtual void IlvGadgetItemHolder::itemSelected | ( | IlvGadgetItem * | item | ) | [protected, virtual] |
Is called when an item is selected.
The default implementation does nothing.
| item | The selected gadget item. |
Reimplemented in IlvTreeGadget.
| virtual void IlvGadgetItemHolder::recomputeAllItems | ( | ) | [virtual] |
Recomputes the size of all the items managed by the holder.
Calls the IlvGadgetItem::recomputeSize member function for all the items managed by this holder.
IlvGadgetItem::recomputeSize, applyToItems. Reimplemented in IlvAbstractMenu, IlvPopupMenu, IlvNotebook, IlvOptionMenu, IlvStringList, and IlvTreeGadget.
| virtual void IlvGadgetItemHolder::reDrawItems | ( | ) | [virtual] |
Ends a redraw session.
Redraws invalidated items after a call to initRedrawsItems.
initRedrawsItems. | void IlvGadgetItemHolder::setDragDropTarget | ( | IlvGadgetItem * | item | ) |
Sets the target item of a drag-and-drop operation.
Sets item as the target item of a drag-and-drop operation. Note that the target of a drag-and-drop operation is not automatically set when dragging an item. Setting an item as the target of a drag-and-drop operation simply modifies the way it is drawn by making it appear as if it were selected. This feature can be used to give a feedback to the user during a drag-and- drop operation.
| item | The new target item. |
getDragDropTarget. | void IlvGadgetItemHolder::setDraggedImage | ( | IlvGraphic * | graphic | ) |
Sets the graphic object used to draw the ghost image during a drag-and-drop operation.
If you do not provide a ghost image, a default ghost image is used. Note that if there was already a graphic object used to draw the ghost image, this object is deleted.
| graphic | The new graphic object used to draw the ghost image. |
getDraggedImage. | void IlvGadgetItemHolder::setDraggedItem | ( | IlvGadgetItem * | item | ) |
Sets the dragged item.
Changes the item that is being dragged. Usually, you do not have to call this member function, except for stopping a drag-and-drop operation. In this case, call it with 0 as its parameter.
| item | The new dragged item. |
getDraggedItem. | virtual void IlvGadgetItemHolder::startDragItem | ( | IlvGadgetItem * | item | ) | [protected, virtual] |
Is called when a drag-and-drop operation begins.
The default implementation invokes the Start Drag callback.
| item | The dragged item. |
| static IlSymbol* IlvGadgetItemHolder::StartDragItemCallbackType | ( | ) | [static] |
Returns the callback type of the Start Drag callback.
The Start Drag callbak is invoked at the beginning of a drag-and-drop operation.
| virtual void IlvGadgetItemHolder::startEdit | ( | IlvGadgetItem * | item | ) | [protected, virtual] |
Is called when an item is edited.
The default implementation calls the Start Edit callback.
| item | The edited gadget item. |
| static IlSymbol* IlvGadgetItemHolder::StartEditItemCallbackType | ( | ) | [static] |
Returns the callback type of the Start Edit callback.
The Start Edit callback is invoked just before the item is edited.
EndEditItemCallbackType, AbortEditItemCallbackType. © 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.