rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvGraphicPane Class Reference

Pane class. More...

#include <ilviews/gadgets/panecont.h>

Inheritance diagram for IlvGraphicPane:
IlvPane IlvAbstractBarPane IlvDockingHandlePane IlvSeparatorPane IlvSliderPane

List of all members.

Public Member Functions

 IlvGraphicPane (const char *name, IlvGraphic *graphic, IlUShort margin=2, IlBoolean owner=IlTrue)
 Constructor.
virtual void boundingBox (IlvRect &) const
 Returns the size and position of the pane.
IlvGraphicgetObject () const
 Returns the graphic object encapsulated by the pane.
IlBoolean isDoubleBuffering () const
 Tests the pane double buffering setting.
virtual void moveResize (const IlvRect &)
 Moves and resizes the pane.
virtual void setContainer (IlvPanedContainer *cont)
 Is called when the container of the pane changes.
virtual void setDoubleBuffering (IlBoolean value)
 Sets double buffering.
virtual void setFocus (IlvEvent *event=0)
 Gives the focus to the pane.
void setObject (IlvGraphic *obj, IlBoolean owner=IlTrue)
 Sets the graphic object encapsulated by the pane.

Detailed Description

Pane class.

Library: ilvadvgdt

An IlvGraphicPane object is a pane that encapsulates an IlvGraphic object.

See also:
IlvPanedContainer, IlvViewPane.

Constructor & Destructor Documentation

IlvGraphicPane::IlvGraphicPane ( const char *  name,
IlvGraphic graphic,
IlUShort  margin = 2,
IlBoolean  owner = IlTrue 
)

Constructor.

Initializes a new instance of the IlvGraphicPane class.

Parameters:
name The name of the pane.
graphic The encapsulated graphic object.
margin The margin value of the left, right, top and bottom borders.
owner A Boolean value specifying whether the pane is the owner graphic. If owner is set to IlTrue or is omitted, deleting the graphic pane will cause the associated graphic to be deleted as well.

Member Function Documentation

virtual void IlvGraphicPane::boundingBox ( IlvRect rect  )  const [virtual]

Returns the size and position of the pane.

Puts in rect the size and position of the pane.

Parameters:
rect The returned size and position of the pane.
See also:
moveResize.

Implements IlvPane.

IlvGraphic* IlvGraphicPane::getObject (  )  const

Returns the graphic object encapsulated by the pane.

Returns:
The graphic object encapsulated by the pane.
See also:
setObject
IlBoolean IlvGraphicPane::isDoubleBuffering (  )  const

Tests the pane double buffering setting.

Returns:
The pane double buffering setting
virtual void IlvGraphicPane::moveResize ( const IlvRect rect  )  [virtual]

Moves and resizes the pane.

Parameters:
rect The new size and position of the pane.
See also:
boundingBox.

Reimplemented from IlvPane.

Reimplemented in IlvDockingHandlePane, and IlvAbstractBarPane.

virtual void IlvGraphicPane::setContainer ( IlvPanedContainer container  )  [virtual]

Is called when the container of the pane changes.

Parameters:
container The new pane container.
See also:
IlvPanedContainer::addPane, IlvPanedContainer::removePane.

Reimplemented from IlvPane.

Reimplemented in IlvAbstractBarPane.

virtual void IlvGraphicPane::setDoubleBuffering ( IlBoolean  value  )  [virtual]

Sets double buffering.

Use this member function to indicate whether or not the IlvPanedContainer instance associated with the pane should use double buffering.

Parameters:
value A Boolean value indicating if the IlvPanedContainer instance associated with the pane should use double buffering (IlTrue) or not (IlFalse).
See also:
getTopView
virtual void IlvGraphicPane::setFocus ( IlvEvent event = 0  )  [virtual]

Gives the focus to the pane.

Parameters:
event A pointer to the event that triggered the call to this method.

Implements IlvPane.

void IlvGraphicPane::setObject ( IlvGraphic obj,
IlBoolean  owner = IlTrue 
)

Sets the graphic object encapsulated by the pane.

Parameters:
graphic The encapsulated graphic object.
owner A Boolean value specifying whether the pane is the owner of graphic. If owner is IlTrue or is omitted, deleting the graphic pane will cause the associated graphic to be deleted as well.
See also:
getObject

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