Rogue Wave Views Gadgets Package API Reference Guide |
Rogue Wave Views Documentation Home |
Pane class. More...
#include <ilviews/gadgets/panecont.h>
Public Types |
Public Member Functions | |
IlvPane (const char *name) | |
Constructor. More... | |
void | addListener (IlvPaneListener *listener) |
Adds a listener to the pane. More... | |
virtual void | boundingBox (IlvRect &rect) const =0 |
Returns the size and position of the pane. More... | |
IlUShort | getBottomMargin () const |
Returns the bottom margin of the pane. More... | |
IlvPanedContainer * | getContainer () 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... | |
IlvNamedProperty * | getNamedProperty (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... | |
virtual void | moveResize (const IlvRect &rect) |
Moves and resizes the pane. 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... | |
IlvNamedProperty * | removeNamedProperty (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... | |
virtual void | setContainer (IlvPanedContainer *container) |
Is called when the container of the pane changes. More... | |
virtual void | setFocus (IlvEvent *event=0)=0 |
Gives the focus to 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... | |
IlvNamedProperty * | setNamedProperty (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... | |
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.
enum IlvPane::ResizeMode |
This enumeration defines the possible values for a resize mode of an IlvPane
object.
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. |
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.
name | The name of the pane. |
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
.
listener | The pane listener. |
IlvPaneListener
, removeListener()
, getListeners()
.
|
pure virtual |
Returns the size and position of the pane.
Puts in rect the size and position of the pane.
rect | The returned size and position of the pane. |
moveResize()
. Implemented in IlvGraphicPane, and IlvViewPane.
IlUShort IlvPane::getBottomMargin | ( | ) | const |
Returns the bottom margin of the pane.
setBottomMargin()
. IlvPanedContainer* IlvPane::getContainer | ( | ) | const |
Returns the paned container to which the pane belongs.
setContainer()
. IlUShort IlvPane::getLeftMargin | ( | ) | const |
IlvPaneListener* const* IlvPane::getListeners | ( | IlUInt & | count | ) | const |
Returns an array of all the pane listeners.
count | Return value holding the number of elements in the array returned by the method. |
IlvPaneListener
, addListener()
, removeListeners()
. IlvDim IlvPane::getMinimumSize | ( | IlvDirection | direction | ) | const |
Returns the minimum size of the pane.
direction | The direction for which the minimum size is requested. Valid values are: IlvHorizontal and IlvVertical . |
setMinimumSize()
. const char* IlvPane::getName | ( | ) | const |
Returns the name of the pane.
0
if the pane has no name. setName()
, IlvPanedContainer::getPane()
. IlvNamedProperty* IlvPane::getNamedProperty | ( | const IlSymbol * | name | ) | const |
Returns the property whose name is specified.
name | The property name. |
0
if no named property matches name. setNamedProperty()
, removeNamedProperty()
. Returns the specified object property.
key | The symbol representing the property. |
setProperty()
, removeProperty()
, hasProperty()
. int IlvPane::getResizeMode | ( | IlvDirection | direction | ) | const |
Returns the resize mode of the pane for the specified direction.
direction | The direction. |
setResizeMode()
, ResizeMode
. IlUShort IlvPane::getRightMargin | ( | ) | const |
Returns the right margin of the pane.
setRightMargin()
. IlUShort IlvPane::getTopMargin | ( | ) | const |
Specifies whether the object has the specified property.
key | The symbol representing the property. |
IlTrue
if the key property was found and IlFalse
if not. setProperty()
, removeProperty()
, getProperty()
.
|
virtual |
Hides the pane.
After calling this method, you have to call the IlvPanedContainer::updatePanes()
method to see the modifications.
show()
. IlBoolean IlvPane::isVisible | ( | ) | const |
|
virtual |
Moves and resizes the pane.
rect | The new size and position of the pane. |
boundingBox()
. Reimplemented in IlvGraphicPane, IlvViewPane, IlvAbstractBarPane, and IlvDockingHandlePane.
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.
rect | The returned size and position of the pane, including margins. |
boundingBox()
. void IlvPane::removeListener | ( | IlvPaneListener * | listener | ) |
Disconnects a listener from the pane.
The pane listener is not deleted.
listener | The pane listener. |
IlvPaneListener
, addListener()
, getListeners()
. IlvNamedProperty* IlvPane::removeNamedProperty | ( | IlSymbol * | name | ) |
Removes the specified named property from the object.
name | The property name. |
0
. getNamedProperty()
, setNamedProperty()
. Removes the specified object property.
key | The symbol representing the property. |
IlTrue
if the key property was found and IlFalse
if not. setProperty()
, getProperty()
, hasProperty()
. void IlvPane::setBottomMargin | ( | IlUShort | margin | ) |
Sets the bottom margin of the pane.
margin | The new bottom margin. |
getBottomMargin()
.
|
virtual |
Is called when the container of the pane changes.
container | The new pane container. |
Reimplemented in IlvGraphicPane, IlvViewPane, and IlvAbstractBarPane.
|
pure virtual |
Gives the focus to the pane.
event | A pointer to the event that triggered the call to this method. |
Implemented in IlvGraphicPane, and IlvViewPane.
void IlvPane::setLeftMargin | ( | IlUShort | margin | ) |
void IlvPane::setMargin | ( | IlUShort | margin | ) |
Sets all the margins of the pane.
This method sets the left, right, top, and bottom margins to margin.
margin | The new margins of the pane. |
void IlvPane::setMinimumSize | ( | IlvDirection | dir, |
IlvDim | size | ||
) |
Sets the minimum size of the pane.
dir | The direction for which the minimum size is set. Valid values are: IlvHorizontal and IlvVertical . |
size | The new minimum size. |
getMinimumSize()
. void IlvPane::setMinimumSize | ( | IlvDim | size | ) |
Sets the minimum sizes of the pane in all directions.
size | The new minimum size. |
getMinimumSize()
. void IlvPane::setName | ( | const char * | name | ) |
Sets the name of the pane.
name | The new name of the pane. |
getName()
, IlvPanedContainer::getPane()
. IlvNamedProperty* IlvPane::setNamedProperty | ( | IlvNamedProperty * | property | ) |
Sets the property whose name is specified.
property | The named property. |
0
. getNamedProperty()
, removeNamedProperty()
. Sets the specified property to the object.
key | The symbol representing the property. |
value | The new value of the property. If value equals 0 , the property is removed. |
removeProperty()
, getProperty()
, hasProperty()
. 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.
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 . |
getResizeMode()
, ResizeMode
. void IlvPane::setResizeMode | ( | int | mode | ) |
Sets the resize mode of the pane both vertically and horizontally.
mode | The new resize mode. Valid values are: IlvPane::Fixed , IlvPane::Resizable and IlvPane::Elastic . |
getResizeMode()
, ResizeMode
. void IlvPane::setRightMargin | ( | IlUShort | margin | ) |
void IlvPane::setTopMargin | ( | IlUShort | margin | ) |
|
virtual |
Shows the pane.
After calling this method, you have to call the IlvPanedContainer::updatePanes()
method to see the modifications.
hide()
. © Copyright 2016, 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.