Rogue Wave Views Gadgets Package API Reference Guide |
Rogue Wave Views Documentation Home |
Dockable utility class. More...
#include <ilviews/gadgets/dockutil.h>
Public Member Functions | |
IlvDockingConfiguration () | |
Constructor. More... | |
void | addLocation (const IlvDockingPaneLocation *loc) |
Adds the specified pane location to this configuration. More... | |
void | clean () |
Removes and deletes all the pane location of this configuration. More... | |
IlUInt | getCardinal () const |
Returns the number of pane locations this configuration has. More... | |
const IlvDockingPaneLocation * | getLocation (const char *name) const |
Returns the pane location whose name is specified. More... | |
const IlvDockingPaneLocation * | getLocation (IlUInt index) const |
Returns the pane location whose index is specified. More... | |
Dockable utility class.
Library: ilvadvgdt
The IlvDockingConfiguration
class is a collection of IlvDockingPaneLocation
objects. It is used by the IlvDockingConfigurationHandler
class to switch from one docking configuration to another.
IlvDockingConfiguration::IlvDockingConfiguration | ( | ) |
Constructor.
Initializes a new instance of the IlvDockingConfiguration
class.
void IlvDockingConfiguration::addLocation | ( | const IlvDockingPaneLocation * | loc | ) |
Adds the specified pane location to this configuration.
loc | The pane location. |
clean()
. void IlvDockingConfiguration::clean | ( | ) |
Removes and deletes all the pane location of this configuration.
addLocation()
. IlUInt IlvDockingConfiguration::getCardinal | ( | ) | const |
Returns the number of pane locations this configuration has.
const IlvDockingPaneLocation* IlvDockingConfiguration::getLocation | ( | const char * | name | ) | const |
Returns the pane location whose name is specified.
name | The name of the pane location. |
0
if no pane location has the name name in this configuration. const IlvDockingPaneLocation* IlvDockingConfiguration::getLocation | ( | IlUInt | index | ) | const |
Returns the pane location whose index is specified.
index | The index of the pane location. |
© 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.