rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvFrame Class Reference

Gadget class. More...

#include <ilviews/gadgets/frame.h>

Inheritance diagram for IlvFrame:
IlvMessageLabel IlvGadget IlvGadgetItemHolder IlvSimpleGraphic IlvGraphic

List of all members.

Public Member Functions

 IlvFrame (IlvDisplay *display, const IlvPoint &point, const char *message, IlUShort thickness=0, IlvPalette *palette=0, IlBoolean copy=IlTrue)
 Constructor.
 IlvFrame (IlvDisplay *display, const char *message, const IlvRect &size, IlUShort thickness=0, IlvPalette *palette=0, IlBoolean copy=IlTrue)
 Constructor.
virtual void drawGadgetItem (const IlvGadgetItem *, IlvPort *port, const IlvRect &rect, const IlvTransformer *t=0, const IlvRegion *clip=0) const
 Draws a specific gadget item.

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.

IlvFramea.gif

- IlvFrame -


Constructor & Destructor Documentation

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:
display The connection to the display.
message The label of the frame.
rect The size and position of the frame.
thickness The thickness of the frame.
palette The palette used by the frame.
copy A Boolean value specifying 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::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:
display The connection to the display.
point The position of the frame.
message The label of the frame.
thickness The thickness of the frame.
palette The palette used by the frame.
copy A Boolean value specifying 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.

Member Function Documentation

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:
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.
See also:
IlvGadgetItem::draw.

Reimplemented from IlvGadgetItemHolder.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

© 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.