rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvViewPane Class Reference

Pane class. More...

#include <ilviews/gadgets/panecont.h>

Inheritance diagram for IlvViewPane:
IlvPane

List of all members.

Public Member Functions

 IlvViewPane (const char *name, IlvView *view, IlBoolean owner=IlTrue)
 Constructor.
virtual void boundingBox (IlvRect &) const
 Returns the size and position of the pane.
IlvViewgetView () const
 Returns the view object that the pane encapsulates.
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 setFocus (IlvEvent *event=0)
 Gives the focus to the pane.
void setView (IlvView *view, IlBoolean owner=IlTrue)
 Sets the view object that the pane encapsulates.

Static Public Member Functions

static IlvViewPaneGet (const IlvView *view)
 Returns the view pane connected to the specified view.

Detailed Description

Pane class.

Library: ilvadvgdt

An IlvViewPane object is a pane that encapsulates an IlvView object.

See also:
IlvGraphicPane, IlvPanedContainer.

Constructor & Destructor Documentation

IlvViewPane::IlvViewPane ( const char *  name,
IlvView view,
IlBoolean  owner = IlTrue 
)

Constructor.

Initializes a new instance of the IlvViewPane class.

Parameters:
name The name of the pane.
view The encapsulated view.
owner A Boolean value specifying whether the pane is the owner of view. If owner is set to IlTrue or is omitted, deleting the view pane will cause the associated view to be deleted as well.

Member Function Documentation

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

static IlvViewPane* IlvViewPane::Get ( const IlvView view  )  [static]

Returns the view pane connected to the specified view.

Parameters:
view The View.
Returns:
The view pane object connected to view, or 0 if no view pane is connected with view.
See also:
setView, IlvPanedContainer:getViewPane
IlvView* IlvViewPane::getView (  )  const

Returns the view object that the pane encapsulates.

Returns:
The view object that the pane encapsulates or 0 if no view has been attached to the pane.
See also:
setView
virtual void IlvViewPane::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.

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

virtual void IlvViewPane::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 IlvViewPane::setView ( IlvView view,
IlBoolean  owner = IlTrue 
)

Sets the view object that the pane encapsulates.

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

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