rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPane Class Reference

Pane class. More...

#include <ilviews/gadgets/panecont.h>

Inheritance diagram for IlvPane:
IlvGraphicPane IlvViewPane IlvAbstractBarPane IlvDockingHandlePane IlvSeparatorPane IlvSliderPane

List of all members.

Public Types

enum  ResizeMode { Fixed, Resizable, Elastic }
 

This enumeration defines the possible values for a resize mode of an IlvPane object.

More...

Public Member Functions

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

Detailed Description

Pane class.

Library: ilvadvgdt

The class IlvPane is an abstract class that defines a graphic component, called a pane, which can be added to a container of the type IlvPanedContainer. It has two subclasses: IlvGraphicPane, which encapsulates an IlvGraphic object, and IlvViewPane, which encapsulates an IlvView object. A pane can be fixed, elastic, be resizable, and can have a minimum size.

See also:
IlvGraphicPane, IlvPanedContainer, IlvSeparatorPane, IlvSliderPane, IlvViewPane, IlvDockable.

Member Enumeration Documentation

This enumeration defines the possible values for a resize mode of an IlvPane object.

See also:
IlvPane::setResizeMode.
Enumerator:
Fixed 

Fixed panes are never resized.

Resizable 

Resizable panes are resized only if their container does not have elastic panes.

Elastic 

Elastic panes are always resized.


Constructor & Destructor Documentation

IlvPane::IlvPane ( const char *  name  ) 

Constructor.

Initializes a new instance of the IlvPane class. Creates a new pane with the specified name. The minimum size of the created pane is 1, both vertically and horizontally. Its resize mode is IlvPane::Fixed in both directions, which means that it cannot be resized. The left, right, top, and bottom margins of the pane are set to 0.

Parameters:
name The name of the pane.

Member Function Documentation

void IlvPane::addListener ( IlvPaneListener listener  ) 

Adds a listener to the pane.

Each pane maintains a list of listeners for the class IlvPaneListener. The pane listeners are notified when a specific method is invoked for the pane. For more details, see the IlvPaneListener.

Parameters:
listener The pane listener.
See also:
IlvPaneListener, removeListener, getListeners
virtual void IlvPane::boundingBox ( IlvRect rect  )  const [pure 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.

Implemented in IlvViewPane, and IlvGraphicPane.

IlUShort IlvPane::getBottomMargin (  )  const

Returns the bottom margin of the pane.

Returns:
The bottom margin of the pane.
See also:
setBottomMargin
IlvPanedContainer* IlvPane::getContainer (  )  const

Returns the paned container to which the pane belongs.

Returns:
The paned container to which the pane belongs or 0 if it does not belong to any paned container.
See also:
setContainer.
IlUShort IlvPane::getLeftMargin (  )  const

Returns the left margin of the pane.

Returns:
The left margin of the pane.
See also:
setLeftMargin
IlvPaneListener* const* IlvPane::getListeners ( IlUInt count  )  const

Returns an array of all the pane listeners.

Parameters:
listener The pane listener.
Returns:
An array of count elements containing pointers to the pane listeners. The returned array should never be modified nor deleted.
See also:
IlvPaneListener, addListener, removeListeners
IlvDim IlvPane::getMinimumSize ( IlvDirection  direction  )  const

Returns the minimum size of the pane.

Parameters:
direction The direction for which the minimum size is requested. Valid values are: IlvHorizontal and IlvVertical.
Returns:
The minimum size of the pane for the specified direction.
See also:
setMinimumSize.
const char* IlvPane::getName (  )  const

Returns the name of the pane.

Returns:
The name of the pane or 0 if the pane has no name.
See also:
setName, IlvPanedContainer::getPane.
IlvNamedProperty* IlvPane::getNamedProperty ( const IlSymbol name  )  const

Returns the property whose name is specified.

Parameters:
name The property name.
Returns:
A pointer to property object specified by name. It returns 0 if no named property matches name.
See also:
setNamedProperty, removeNamedProperty
IlAny IlvPane::getProperty ( const IlSymbol key  )  const

Returns the specified object property.

Parameters:
key The symbol representing the property.
Returns:
The specified property value when it can be found. It returns 0 when no property name matches the key parameter.
See also:
setProperty, removeProperty, hasProperty
int IlvPane::getResizeMode ( IlvDirection  direction  )  const

Returns the resize mode of the pane for the specified direction.

Parameters:
direction The direction.
Returns:
The resize mode of the pane for the specified direction.
See also:
setResizeMode, ResizeMode.
IlUShort IlvPane::getRightMargin (  )  const

Returns the right margin of the pane.

Returns:
The right margin of the pane.
See also:
setRightMargin
IlUShort IlvPane::getTopMargin (  )  const

Returns the top margin of the pane.

Returns:
The top margin of the pane.
See also:
setTopMargin
IlBoolean IlvPane::hasProperty ( const IlSymbol key  )  const

Specifies whether the object has the specified property.

Parameters:
key The symbol representing the property.
Returns:
IlTrue if the key property was found and IlFalse if not.
See also:
setProperty, removeProperty, getProperty
virtual void IlvPane::hide (  )  [virtual]

Hides the pane.

After calling this method, you have to call the IlvPanedContainer::updatePanes method to see the modifications.

See also:
show.
IlBoolean IlvPane::isVisible (  )  const

Specifies whether the pane is visible.

Returns:
IlTrue if the pane is visible.
See also:
show, hide.
virtual void IlvPane::moveResize ( const IlvRect rect  )  [virtual]

Moves and resizes the pane.

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

Reimplemented in IlvDockingHandlePane, IlvAbstractBarPane, IlvViewPane, and IlvGraphicPane.

void IlvPane::paneBBox ( IlvRect rect  )  const

Returns the size and position of the pane, including margins.

Puts in rect the size and position of the pane, including margins.

Parameters:
rect The returned size and position of the pane, including margins.
See also:
boundingBox.
void IlvPane::removeListener ( IlvPaneListener listener  ) 

Disconnects a listener from the pane.

The pane listener is not deleted.

Parameters:
listener The pane listener.
See also:
IlvPaneListener, addListener, getListeners
IlvNamedProperty* IlvPane::removeNamedProperty ( IlSymbol name  ) 

Removes the specified named property from the object.

Parameters:
name The property name.
Returns:
The named property with the same name that was previously associated with this object. You can delete it or keep it for further handling. If no named property with the same name was previously associated with this object, this member function returns 0.
See also:
getNamedProperty, setNamedProperty
IlBoolean IlvPane::removeProperty ( const IlSymbol key  ) 

Removes the specified object property.

Parameters:
key The symbol representing the property.
Returns:
IlTrue if the key property was found and IlFalse if not.
See also:
setProperty, getProperty, hasProperty
void IlvPane::setBottomMargin ( IlUShort  margin  ) 

Sets the bottom margin of the pane.

Parameters:
margin The new bottom margin.
See also:
getBottomMargin
virtual void IlvPane::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 in IlvAbstractBarPane, IlvViewPane, and IlvGraphicPane.

virtual void IlvPane::setFocus ( IlvEvent event = 0  )  [pure virtual]

Gives the focus to the pane.

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

Implemented in IlvViewPane, and IlvGraphicPane.

void IlvPane::setLeftMargin ( IlUShort  margin  ) 

Sets the left margin of the pane.

Parameters:
margin The new left margin.
See also:
getLeftMargin
void IlvPane::setMargin ( IlUShort  margin  ) 

Sets all the margins of the pane.

This method sets the left, right, top, and bottom margins to margin.

Parameters:
margin The new margins of the pane.
See also:
getLeftMargin, getRightMargin, getTopMargin, getBottomMargin
void IlvPane::setMinimumSize ( IlvDim  size  ) 

Sets the minimum sizes of the pane in all directions.

Parameters:
size The new minimum size.
See also:
getMinimumSize.
void IlvPane::setMinimumSize ( IlvDirection  ,
IlvDim  size 
)

Sets the minimum size of the pane.

Parameters:
direction The direction for which the minimum size is set. Valid values are: IlvHorizontal and IlvVertical.
size The new minimum size.
See also:
getMinimumSize.
void IlvPane::setName ( const char *  name  ) 

Sets the name of the pane.

Parameters:
name The new name of the pane.
See also:
getName, IlvPanedContainer::getPane.
IlvNamedProperty* IlvPane::setNamedProperty ( IlvNamedProperty property  ) 

Sets the property whose name is specified.

Parameters:
property The named property.
Returns:
The named property with the same name that was previously associated with the object. You can delete it or keep it for further handling. If no named property with the same name was associated with this object, this member function returns 0.
See also:
getNamedProperty, removeNamedProperty
void IlvPane::setProperty ( const IlSymbol key,
IlAny  value 
)

Sets the specified property to the object.

Parameters:
key The symbol representing the property.
value The new value of the property. If value equals 0, the property is removed.
See also:
removeProperty, getProperty, hasProperty
void IlvPane::setResizeMode ( int  mode  ) 

Sets the resize mode of the pane both vertically and horizontally.

Parameters:
mode The new resize mode. Valid values are: IlvPane::Fixed , IlvPane::Resizable, and IlvPane::Elastic .
See also:
getResizeMode, ResizeMode
void IlvPane::setResizeMode ( IlvDirection  direction,
int  mode 
)

Sets the resize mode of the pane for the specified direction.

The container of a pane uses the resize mode in effect when its size changes to determine whether the pane should be resized. A pane is resized depending on its type:

  • A fixed pane is never resized.

  • A resizable pane is resized only if its container does not have an elastic pane.

  • An elastic pane is always resized.

Typically, an application contains a few fixed panes, many resizable panes, and only one elastic pane that serves as the "working area". See the IlvDockableMainWindow class for details.

Parameters:
direction The direction of the pane. Valid values are: IlvVertical and IlvHorizontal.
mode The new resize mode. Valid values are: IlvPane::Fixed , IlvPane::Resizable, and IlvPane::Elastic.
See also:
getResizeMode, ResizeMode
void IlvPane::setRightMargin ( IlUShort  margin  ) 

Sets the right margin of the pane.

Parameters:
margin The new right margin.
See also:
getRightMargin
void IlvPane::setTopMargin ( IlUShort  margin  ) 

Sets the top margin of the pane.

Parameters:
margin The new top margin.
See also:
getTopMargin
virtual void IlvPane::show (  )  [virtual]

Shows the pane.

After calling this method, you have to call the IlvPanedContainer::updatePanes method to see the modifications.

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