 |
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 |
Gadget class. More...
#include <ilviews/gadgets/arrowb.h>
Public Member Functions | |
| IlvArrowButton (IlvDisplay *display, const IlvRect &rect, IlvDirection direction, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) | |
| Constructor. More... | |
| IlvArrowButton (IlvDisplay *display, const IlvPoint &at, IlvDirection direction, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) | |
| Constructor. More... | |
| IlvOrientation | getDirection () const |
| Returns the direction of the arrow. More... | |
| void | setDirection (IlvOrientation direction, IlBoolean redraw=IlFalse) |
| Sets the direction of the arrow. More... | |
 Public Member Functions inherited from IlvButton | |
| IlvButton (IlvDisplay *display, const char *label, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) | |
| Constructor. More... | |
| IlvButton (IlvDisplay *display, const IlvPoint &point, const char *label, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) | |
| Constructor. More... | |
| IlvButton (IlvDisplay *display, IlvBitmap *bitmap, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) | |
| Constructor. More... | |
| IlvButton (IlvDisplay *display, const IlvPoint &point, IlvBitmap *bitmap, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) | |
| Constructor. More... | |
| virtual void | activate () |
| Is called when the button is released after having been pressed. More... | |
| virtual void | drawGadgetItem (const IlvGadgetItem *, IlvPort *, const IlvRect &, const IlvTransformer *=0, const IlvRegion *=0) const |
| Draws a specific gadget item. More... | |
| IlvBitmap * | getHighlightedBitmap () const |
| Returns the bitmap associated with the highlighted state of the button. More... | |
| IlUInt | getPeriod () const |
| Returns the repeat period of the button. More... | |
| IlvBitmap * | getSelectedBitmap () const |
| Returns the bitmap associated with the selected state of the button. More... | |
| IlBoolean | isRepeat () const |
| Indicates whether the button is in auto-repeat mode. More... | |
| void | setHighlightedBitmap (IlvBitmap *bitmap) |
| Sets the highlighted bitmap of the button. More... | |
| void | setPeriod (IlUInt period) |
| Sets the repeat period of the button. More... | |
| void | setRepeat (IlBoolean value) |
| Specifies whether the button should be in auto-repeat mode. More... | |
| void | setSelectedBitmap (IlvBitmap *bitmap) |
| Sets the selected bitmap of the button. More... | |
| Public Member Functions inherited from IlvMessageLabel | |
| IlvMessageLabel (IlvDisplay *display, const char *message, const IlvRect &rect, IlvAlignment alignment=IlvLeft, IlUShort thickness=0, IlvPalette *palette=0, IlBoolean copy=IlTrue) | |
| Constructor. More... | |
| IlvMessageLabel (IlvDisplay *display, const IlvPoint &at, const char *message, IlvAlignment alignment=IlvLeft, IlUShort thickness=0, IlvPalette *palette=0, IlBoolean copy=IlTrue) | |
| Constructor. More... | |
| virtual IlvGadgetItem * | applyToItems (IlvApplyGadgetItem f, IlAny arg) |
| Applies the specified function to all the items of the holder. More... | |
| IlvAlignment | getAlignment () const |
| Returns the alignment of the message label. More... | |
| IlvBitmap * | getBitmap () const |
| Returns the bitmap associated with the message label. More... | |
| IlvBitmap * | getInsensitiveBitmap () const |
| Returns the insensitive bitmap of the message label. More... | |
| const char * | getLabel () const |
| Returns the label stored in the message label. More... | |
| virtual void | getLabelOrientation (IlvOrientation &orientation, IlBoolean &flip) const |
| Returns the orientation of the label. More... | |
| virtual IlvPosition | getLabelPosition () const |
| Returns the position of the label relative to the bitmap of the message label. More... | |
| const char * | getMessage () const |
| Returns the translated message of the message label. More... | |
| char | getMnemonic () const |
| Returns the mnemonic associated with the message label. 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... | |
| IlUShort | getSpacing () const |
| Returns the spacing between the label and the bitmap of the message label. More... | |
| void | setAlignment (IlvAlignment alignment) |
| Sets the alignment of this message label. More... | |
| void | setBitmap (IlvBitmap *bitmap) |
| Sets the bitmap of the message label. More... | |
| void | setInsensitiveBitmap (IlvBitmap *bitmap) |
| Sets the insensitive bitmap of the message label. More... | |
| void | setLabel (const char *label, IlBoolean copy=IlTrue) |
| Sets the label of the message label. More... | |
| void | setLabelOrientation (IlvOrientation orientation, IlBoolean flip=IlFalse, IlBoolean redraw=IlTrue) |
| Sets the orientation of the label. More... | |
| void | setLabelPosition (IlvPosition pos, IlBoolean redraw=IlTrue) |
| Sets the position of the label relative to the bitmap of the message label. More... | |
| void | setSpacing (IlUShort spacing, IlBoolean redraw=IlTrue) |
| Sets the spacing between the label and the bitmap of the message label. More... | |
| Public Member Functions inherited from IlvGadgetItemHolder | |
| 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... | |
| 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... | |
| virtual IlvGadgetItem * | getItemByName (const char *name) const |
| Returns the item whose name is specified. More... | |
| IlvGadgetItem * | getToolTipItem () const |
| Returns the item that is displaying a tooltip. More... | |
| virtual void | initReDrawItems () |
| Begins a redraw session. More... | |
| virtual void | recomputeAllItems () |
| Recomputes the size of all the items managed by the holder. 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 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 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 | itemActivated (IlvGadgetItem *item) |
| Is called when an item is activated. 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... | |
Gadget class.
Library: ilvadvgdt
The IlvArrowButton class is a subclass of IlvButton that displays an arrow.
- IlvArrowButton -
IlvSpinBox.Accessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods IlvValueInterface::queryValue(), IlvValueInterface::queryValues(), IlvValueInterface::changeValue(), IlvValueInterface::changeValues(). This class inherits the accessors of its superclass IlvButton and adds the following ones:
| Name | Type | Equivalent methods |
|---|---|---|
arrowDirection | Direction | getDirection(), setDirection() |
This class supports the following CSS properties:
| Graphic property | CSS property | Type |
|---|---|---|
| Background color | background-color | Color |
| Foreground color | color | Color |
| IlvArrowButton::IlvArrowButton | ( | IlvDisplay * | display, |
| const IlvRect & | rect, | ||
| IlvDirection | direction, | ||
| IlUShort | thickness = IlvDefaultGadgetThickness, |
||
| IlvPalette * | palette = 0 |
||
| ) |
Constructor.
Initializes a new instance of the IlvArrowButton class.
| display | The connection to the display. |
| rect | The size and position of the button. |
| direction | The orientation of the arrow. |
| thickness | The thickness of the button. |
| palette | The palette used by the button. |
| IlvArrowButton::IlvArrowButton | ( | IlvDisplay * | display, |
| const IlvPoint & | at, | ||
| IlvDirection | direction, | ||
| IlUShort | thickness = IlvDefaultGadgetThickness, |
||
| IlvPalette * | palette = 0 |
||
| ) |
Constructor.
Initializes a new instance of the IlvArrowButton class.
| display | The connection to the display. |
| at | The position of the button. |
| direction | The orientation of the arrow. |
| thickness | The thickness of the button. |
| palette | The palette used by the button. |
| IlvOrientation IlvArrowButton::getDirection | ( | ) | const |
| void IlvArrowButton::setDirection | ( | IlvOrientation | direction, |
| IlBoolean | redraw = IlFalse |
||
| ) |
Sets the direction of the arrow.
| direction | The new direction of the arrow. Valid values are: IlvRight, IlvLeft, IlvTop, and IlvBottom. |
| redraw | Specifies whether the button should be redrawn. |
© Copyright 2017, 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.