Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvFrame Class Reference

Gadget class. More...

#include <ilviews/gadgets/frame.h>

Inheritance diagram for IlvFrame:
IlvMessageLabel IlvGadget IlvGadgetItemHolder IlvSimpleGraphic IlvStylable IlvGraphic IlvValueInterface

Public Member Functions

 IlvFrame (IlvDisplay *display, const char *message, const IlvRect &size, IlUShort thickness=0, IlvPalette *palette=0, IlBoolean copy=IlTrue)
 Constructor. More...
 
 IlvFrame (IlvDisplay *display, const IlvPoint &point, const char *message, IlUShort thickness=0, IlvPalette *palette=0, IlBoolean copy=IlTrue)
 Constructor. More...
 
virtual void drawGadgetItem (const IlvGadgetItem *, IlvPort *, const IlvRect &, const IlvTransformer *=0, const IlvRegion *=0) const
 Draws a specific gadget item. 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 IlvGadgetItemapplyToItems (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...
 
IlvBitmapgetBitmap () const
 Returns the bitmap associated with the message label. More...
 
IlvBitmapgetInsensitiveBitmap () 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 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 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 IlvGadgetItemcreateItem (const char *label, IlvGraphic *graphic=0, IlvBitmap *bitmap=0, IlvBitmap *selbitmap=0, IlBoolean copy=IlTrue) const
 Returns a new gadget item. More...
 
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...
 
virtual IlvGadgetItemgetItemByName (const char *name) const
 Returns the item whose name is specified. More...
 
IlvGadgetItemgetToolTipItem () 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 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 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...
 

Detailed Description

Gadget class.

Library: ilvgadgt

The IlvFrame class is a gadget class that draws a frame with a label. The label of the frame is drawn using the main palette of the gadget and the frame is drawn using its top shadow and bottom shadow palettes.

- IlvFrame -

Styling

This class supports the following CSS properties:

Graphic property CSS property Type
Background color background-colorColor
Text color color Color

Constructor & Destructor Documentation

§ IlvFrame() [1/2]

IlvFrame::IlvFrame ( IlvDisplay display,
const char *  message,
const IlvRect size,
IlUShort  thickness = 0,
IlvPalette palette = 0,
IlBoolean  copy = IlTrue 
)

Constructor.

Initializes a new instance of the IlvFrame class.

Parameters
displayThe connection to the display.
messageThe label of the frame.
sizeThe size and position of the frame.
thicknessThe thickness of the frame.
paletteThe palette used by the frame.
copySpecifies whether a message should be copied. If the value is IlFalse, then you must allocate some memory for the message because in any case the message characters are deleted from the memory by the IlvFrame.

§ IlvFrame() [2/2]

IlvFrame::IlvFrame ( IlvDisplay display,
const IlvPoint point,
const char *  message,
IlUShort  thickness = 0,
IlvPalette palette = 0,
IlBoolean  copy = IlTrue 
)

Constructor.

Initializes a new instance of the IlvFrame class. The size of the frame is computed using the message parameter.

Parameters
displayThe connection to the display.
pointThe position of the frame.
messageThe label of the frame.
thicknessThe thickness of the frame.
paletteThe palette used by the frame.
copySpecifies whether a message should be copied. If the value is IlFalse, then you must allocate some memory for the message because in any case the message characters are deleted by the IlvFrame.

Member Function Documentation

§ drawGadgetItem()

virtual void IlvFrame::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 IlvGadgetItemHolder.


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