rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPanedContainer Class Reference

Pane container class. More...

#include <ilviews/gadgets/panecont.h>

Inheritance diagram for IlvPanedContainer:
IlvGadgetContainer IlvContainer IlvDrawingView IlvView IlvAbstractView IlvSystemPort IlvPort IlvDockableContainer IlvDockableMainWindow

List of all members.

Public Member Functions

 IlvPanedContainer (IlvDisplay *display, IlvSystemView window, IlvDirection direction)
 Constructor.
 IlvPanedContainer (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlvDirection direction, IlBoolean visible=IlTrue)
 Constructor.
 IlvPanedContainer (IlvAbstractView *parent, const IlvRect &rect, IlvDirection direction, IlBoolean visible=IlTrue)
 Constructor.
 IlvPanedContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlvDirection direction, IlUInt properties=0, IlBoolean visible=IlTrue, IlvSystemView transientFor=0)
 Constructor.
virtual void addPane (IlvPane *pane, IlUInt index=(IlUInt)-1)
 Adds a pane to the paned container at the specified index.
IlAny applyUntil (IlvApplyPane func, IlAny arg=0)
 Applies the specified function to all the panes of the paned container.
IlUInt getCardinal () const
 Returns the number of panes managed by the paned container.
IlvDirection getDirection () const
 Returns the direction of the paned container.
IlUInt getIndex (const IlvPane *pane) const
 Returns the index of the specified pane.
IlvPanegetPane (IlUInt index) const
 Returns the pane whose index is specified.
IlvPanegetPane (const char *name, IlBoolean all=IlFalse) const
 Searches the pane whose name is specified.
IlvViewPanegetViewPane () const
 Returns the view pane that encapsulates the paned container.
IlBoolean isManagingSliders () const
 Returns IlTrue if the paned container manages automatic sliders.
void manageSliders (IlBoolean value)
 Specifies whether the paned container manages sliders automatically.
void paneBBox (const IlvPane *pane, IlvRect &bbox) const
 Returns the bounding box of the specified pane.
virtual void paneGeometryChanged (IlvPane *pane)
 Is called when the geometry of the specified pane changes.
virtual void paneVisibilityChanged (IlvPane *pane)
 Is called when the specified pane is hidden or shown.
IlUInt pointToPane (const IlvPoint &point) const
 Returns the index of the pane located at the position specified by point.
virtual void removePane (IlUInt index, IlBoolean destroy=IlFalse)
 Removes the pane whose index is specified from the paned container.
void setDirection (IlvDirection direction)
 Sets the direction of the paned container.
virtual void updatePanes (IlBoolean all=IlFalse)
 Updates the position and size of all the panes.

Protected Member Functions

virtual IlvSliderPanecreateSliderPane (const char *) const
 Creates and returns a new slider pane.

Detailed Description

Pane container class.

Library: ilvadvgdt

The IlvPanedContainer class is a high-level class that lets you arrange IlvPane instances, called panes, either horizontally (from top to bottom) or vertically (from left to right). Since an IlvPane object encapsulates a view (by means of the IlvViewPane class), you can build complex structures composed of nested paned containers.

IlvPanedContainera.gif

A Vertical Paned Container with Two Panes Separated by a Slider

See also:
IlvDockableContainer, IlvGraphicPane, IlvPane, IlvSliderPane, IlvViewPane.

Constructor & Destructor Documentation

IlvPanedContainer::IlvPanedContainer ( IlvDisplay display,
const char *  name,
const char *  title,
const IlvRect rect,
IlvDirection  direction,
IlUInt  properties = 0,
IlBoolean  visible = IlTrue,
IlvSystemView  transientFor = 0 
)

Constructor.

Initializes a new instance of the IlvPanedContainer class as a top window.

Parameters:
display The connection to the display.
name The name of the paned container.
title The title of the paned container.
rect The size and position of the paned container.
direction The direction of the paned container. Valid values are: IlvVertical (panes are arranged from top to bottom), and IlvHorizontal (panes are arranged from left to right).
properties Properties of the paned container. See the IlvView constructors for more details.
visible A Boolean value specifying whether the paned container should be visible (IlTrue).
transientFor The system view for which the dockable container is transient. See the IlvView constructors for more details.
IlvPanedContainer::IlvPanedContainer ( IlvAbstractView parent,
const IlvRect rect,
IlvDirection  direction,
IlBoolean  visible = IlTrue 
)

Constructor.

Initializes a new instance of the IlvPanedContainer class as a child view of parent.

Parameters:
parent The parent view of the paned container.
rect The size and position of the paned container.
direction The direction of the paned container. Valid values are: IlvVertical (panes are arranged from top to bottom), and IlvHorizontal (panes are arranged from left to right). See IlvPanedContainer constructors for more details.
visible A Boolean value specifying whether the dockable container should be visible (IlTrue).
IlvPanedContainer::IlvPanedContainer ( IlvDisplay display,
IlvSystemView  parent,
const IlvRect rect,
IlvDirection  direction,
IlBoolean  visible = IlTrue 
)

Constructor.

Initializes a new instance of the IlvPanedContainer class as a child view of the system view specified by parent.

Parameters:
display The connection to the display.
parent The parent view of the paned container.
rect The size and position of the paned container.
direction The direction of the paned container. Valid values are: IlvVertical (panes are arranged from top to bottom), and IlvHorizontal (panes are arranged from left to right).
visible A Boolean value specifying whether the paned container should be visible (IlTrue).
IlvPanedContainer::IlvPanedContainer ( IlvDisplay display,
IlvSystemView  window,
IlvDirection  direction 
)

Constructor.

Initializes a new instance of the IlvPanedContainer class mapped to the existing system view window.

Parameters:
display The connection to the display.
window The system view to which the paned container will be mapped.
direction The direction of the paned container. Valid values are: IlvVertical (panes are arranged from top to bottom), and IlvHorizontal (panes are arranged from left to right).
visible A Boolean value specifying whether the paned container should be visible (IlTrue).

Member Function Documentation

virtual void IlvPanedContainer::addPane ( IlvPane pane,
IlUInt  index = (IlUInt)-1 
) [virtual]

Adds a pane to the paned container at the specified index.

Parameters:
pane The pane to be added.
index The position where the pane should be inserted. If index is -1, the pane is added at the last position.
See also:
removePane, getPane
IlAny IlvPanedContainer::applyUntil ( IlvApplyPane  func,
IlAny  arg = 0 
)

Applies the specified function to all the panes of the paned container.

This member function is recursive, and thus, all the panes contained into sub-paned containers will also be crossed. Note that if the function func returns a non-zero value, the process will be stopped, and applyUntil will return.

Parameters:
func The function to be applied.
arg The argument that will be passed to the function func.
Returns:
The result of the function that stopped the operation, or 0 if nothing stopped the operation.
See also:
IlvApplyPane
virtual IlvSliderPane* IlvPanedContainer::createSliderPane ( const char *   )  const [protected, virtual]

Creates and returns a new slider pane.

Returns:
The instance of the IlvSliderPane class that is inserted between two resizable panes when the paned container is set to manage sliders automatically. You may want to override this method to create your subclass of IlvSliderPane.
See also:
manageSliders
IlUInt IlvPanedContainer::getCardinal (  )  const

Returns the number of panes managed by the paned container.

Returns:
The number of panes managed by this paned container.
See also:
addPane, removePane, getPane

Reimplemented from IlvContainer.

IlvDirection IlvPanedContainer::getDirection (  )  const

Returns the direction of the paned container.

Returns:
The direction of the paned container.
See also:
setDirection
IlUInt IlvPanedContainer::getIndex ( const IlvPane pane  )  const

Returns the index of the specified pane.

Parameters:
pane The pane whose index is searched for.
Returns:
The index of the specified pane in this paned container or -1 if the specified pane does not belong to the paned container.
See also:
getPane
IlvPane* IlvPanedContainer::getPane ( IlUInt  index  )  const

Returns the pane whose index is specified.

Parameters:
index The index of the pane. The index should be a valid value.
Returns:
The pane whose index is specified.
See also:
addPane, removePane
IlvPane* IlvPanedContainer::getPane ( const char *  name,
IlBoolean  all = IlFalse 
) const

Searches the pane whose name is specified.

Parameters:
name The name of the pane.
all A Boolean value specifying whether the search should be recursive. If all is set to IlTrue, the pane is searched for recursively in each view pane of the paned container that encapsulates an IlvPanedContainer object.
Returns:
The specified pane or 0 if this pane does not exist.
See also:
IlvPane::setName
IlvViewPane* IlvPanedContainer::getViewPane (  )  const

Returns the view pane that encapsulates the paned container.

Returns:
The view pane that encapsulates the paned container or 0 if there is none.
See also:
IlvViewPane, IlvViewPane::Get
IlBoolean IlvPanedContainer::isManagingSliders (  )  const

Returns IlTrue if the paned container manages automatic sliders.

Returns:
IlTrue if the paned container creates sliders between two resizable panes automatically.
See also:
manageSliders
void IlvPanedContainer::manageSliders ( IlBoolean  value  ) 

Specifies whether the paned container manages sliders automatically.

A slider is a special IlvPane object that you can use to resize panes that are located on both sides of it. For details, see the class IlvSliderPane. When the manage sliders mode is enabled (the default), calling IlvPanedContainer::updatePanes automatically creates a slider between two resizable panes. A resizable pane is a pane whose resize mode is IlvPane::Resizable or IlvPane::Elastic.

Parameters:
value A Boolean value specifying whether the paned container should creates sliders between two resizable panes automatically.
See also:
isManagingSliders, ResizeMode
void IlvPanedContainer::paneBBox ( const IlvPane pane,
IlvRect bbox 
) const

Returns the bounding box of the specified pane.

Parameters:
pane The pane.
bbox The returned bounding box of the pane, including the pane margins.
See also:
pointToPane, IlvPane::setMargin
virtual void IlvPanedContainer::paneGeometryChanged ( IlvPane pane  )  [virtual]

Is called when the geometry of the specified pane changes.

The default implementation does nothing.

Parameters:
pane The modified pane.
See also:
IlvPaneListener::paneGeometryChanged
virtual void IlvPanedContainer::paneVisibilityChanged ( IlvPane pane  )  [virtual]

Is called when the specified pane is hidden or shown.

The default implementation does nothing.

Parameters:
pane The modified pane.
See also:
IlvPaneListener::paneVisibilityChanged
IlUInt IlvPanedContainer::pointToPane ( const IlvPoint point  )  const

Returns the index of the pane located at the position specified by point.

Parameters:
point The point where the pane is located.
Returns:
The index of the pane located at the position specified by point.
See also:
IlvPane::moveResize, IlvPane::boundingBox, paneBBox
virtual void IlvPanedContainer::removePane ( IlUInt  index,
IlBoolean  destroy = IlFalse 
) [virtual]

Removes the pane whose index is specified from the paned container.

Parameters:
index The index of the pane to be removed.
destroy A Boolean value specifying whether the removed pane should be destroyed.
See also:
addPane, getPane

Reimplemented in IlvDockableContainer.

void IlvPanedContainer::setDirection ( IlvDirection  direction  ) 

Sets the direction of the paned container.

Parameters:
direction The new direction of the paned container. Valid values are IlvVertical and IlvHorizontal. When a paned container is vertical, panes are arranged from top to bottom. When it is horizontal, panes are arranged from left to right.
See also:
getDirection
virtual void IlvPanedContainer::updatePanes ( IlBoolean  all = IlFalse  )  [virtual]

Updates the position and size of all the panes.

This member function must be called after the content of the paned container is modified, that is, after panes are added, removed, hidden, or shown.

Parameters:
all A Boolean value specifying whether the method should be recursive. If all is IlTrue, each paned container that is encapsulated in a view pane of this paned container is also updated recursively.
See also:
addPane, removePane, IlvPane::show, IlvPane::hide

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