Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

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

Pane class. More...

#include <ilviews/gadgets/panecont.h>

Inheritance diagram for IlvViewPane:
IlvPane

Public Member Functions

 IlvViewPane (const char *name, IlvView *view, IlBoolean owner=IlTrue)
 Constructor. More...
 
virtual void boundingBox (IlvRect &) const
 Returns the size and position of the pane. More...
 
IlvViewgetView () const
 Returns the view object that the pane encapsulates. More...
 
virtual void moveResize (const IlvRect &)
 Moves and resizes the pane. More...
 
virtual void setContainer (IlvPanedContainer *cont)
 Is called when the container of the pane changes. More...
 
virtual void setFocus (IlvEvent *event=0)
 Gives the focus to the pane. More...
 
void setView (IlvView *view, IlBoolean owner=IlTrue)
 Sets the view object that the pane encapsulates. More...
 
- Public Member Functions inherited from IlvPane
 IlvPane (const char *name)
 Constructor. More...
 
void addListener (IlvPaneListener *listener)
 Adds a listener to the pane. More...
 
IlUShort getBottomMargin () const
 Returns the bottom margin of the pane. More...
 
IlvPanedContainergetContainer () const
 Returns the paned container to which the pane belongs. More...
 
IlUShort getLeftMargin () const
 Returns the left margin of the pane. More...
 
IlvPaneListener *const * getListeners (IlUInt &count) const
 Returns an array of all the pane listeners. More...
 
IlvDim getMinimumSize (IlvDirection direction) const
 Returns the minimum size of the pane. More...
 
const char * getName () const
 Returns the name of the pane. More...
 
IlvNamedPropertygetNamedProperty (const IlSymbol *name) const
 Returns the property whose name is specified. More...
 
IlAny getProperty (const IlSymbol *key) const
 Returns the specified object property. More...
 
int getResizeMode (IlvDirection direction) const
 Returns the resize mode of the pane for the specified direction. More...
 
IlUShort getRightMargin () const
 Returns the right margin of the pane. More...
 
IlUShort getTopMargin () const
 Returns the top margin of the pane. More...
 
IlBoolean hasProperty (const IlSymbol *key) const
 Specifies whether the object has the specified property. More...
 
virtual void hide ()
 Hides the pane. More...
 
IlBoolean isVisible () const
 Specifies whether the pane is visible. More...
 
void paneBBox (IlvRect &rect) const
 Returns the size and position of the pane, including margins. More...
 
void removeListener (IlvPaneListener *listener)
 Disconnects a listener from the pane. More...
 
IlvNamedPropertyremoveNamedProperty (IlSymbol *name)
 Removes the specified named property from the object. More...
 
IlBoolean removeProperty (const IlSymbol *key)
 Removes the specified object property. More...
 
void setBottomMargin (IlUShort margin)
 Sets the bottom margin of the pane. More...
 
void setLeftMargin (IlUShort margin)
 Sets the left margin of the pane. More...
 
void setMargin (IlUShort margin)
 Sets all the margins of the pane. More...
 
void setMinimumSize (IlvDirection dir, IlvDim size)
 Sets the minimum size of the pane. More...
 
void setMinimumSize (IlvDim size)
 Sets the minimum sizes of the pane in all directions. More...
 
void setName (const char *name)
 Sets the name of the pane. More...
 
IlvNamedPropertysetNamedProperty (IlvNamedProperty *property)
 Sets the property whose name is specified. More...
 
void setProperty (const IlSymbol *key, IlAny value)
 Sets the specified property to the object. More...
 
void setResizeMode (IlvDirection direction, int mode)
 Sets the resize mode of the pane for the specified direction. More...
 
void setResizeMode (int mode)
 Sets the resize mode of the pane both vertically and horizontally. More...
 
void setRightMargin (IlUShort margin)
 Sets the right margin of the pane. More...
 
void setTopMargin (IlUShort margin)
 Sets the top margin of the pane. More...
 
virtual void show ()
 Shows the pane. More...
 

Static Public Member Functions

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

Additional Inherited Members

- Public Types inherited from IlvPane
enum  ResizeMode { Fixed, Resizable, Elastic }
 This enumeration defines the possible values for a resize mode of an IlvPane object. More...
 

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::IlvViewPane ( const char *  name,
IlvView view,
IlBoolean  owner = IlTrue 
)

Constructor.

Initializes a new instance of the IlvViewPane class.

Parameters
nameThe name of the pane.
viewThe encapsulated view.
ownerA 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

§ boundingBox()

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
rectThe returned size and position of the pane.
See also
moveResize().

Implements IlvPane.

§ Get()

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

Returns the view pane connected to the specified view.

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

§ getView()

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().

§ moveResize()

virtual void IlvViewPane::moveResize ( const IlvRect rect)
virtual

Moves and resizes the pane.

Parameters
rectThe new size and position of the pane.
See also
boundingBox().

Reimplemented from IlvPane.

§ setContainer()

virtual void IlvViewPane::setContainer ( IlvPanedContainer container)
virtual

Is called when the container of the pane changes.

Parameters
containerThe new pane container.
See also
IlvPanedContainer::addPane(), IlvPanedContainer::removePane().

Reimplemented from IlvPane.

§ setFocus()

virtual void IlvViewPane::setFocus ( IlvEvent event = 0)
virtual

Gives the focus to the pane.

Parameters
eventA pointer to the event that triggered the call to this method.

Implements IlvPane.

§ setView()

void IlvViewPane::setView ( IlvView view,
IlBoolean  owner = IlTrue 
)

Sets the view object that the pane encapsulates.

Parameters
viewThe new view object.
ownerA 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 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.