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 | |
IlvDockingConfigurationHandler () | |
Constructor. More... | |
void | getCurrentDockingConfiguration (IlvDockingConfiguration &conf) const |
Returns the current docking configuration. More... | |
virtual IlvPane * | getDockingPane (IlUInt index) const =0 |
Returns the pane whose index is specified. More... | |
virtual IlUInt | getDockingPanesCount () const =0 |
Returns the total number of panes managed by this handler. More... | |
virtual IlvDockableMainWindow * | getMainWindow () const =0 |
Returns the IlvDockableMainWindow object this handler points to. More... | |
void | setCurrentDockingConfiguration (const IlvDockingConfiguration &conf, IlBoolean update=IlTrue) |
Sets the specified docking configuration as the current one. More... | |
Dockable utility class.
Library: ilvadvgdt
The IlvDockingConfigurationHandler
class handles the switching between one docking configuration and another docking configuration in a IlvDockableMainWindow
container. It is an abstract class and, therefore, needs to be subclassed.
IlvDockingConfigurationHandler::IlvDockingConfigurationHandler | ( | ) |
Constructor.
Initializes a new instance of the IlvDockingConfigurationHandler
class.
void IlvDockingConfigurationHandler::getCurrentDockingConfiguration | ( | IlvDockingConfiguration & | conf | ) | const |
Returns the current docking configuration.
This method fills conf with the current docking configuration.
conf | The returned docking configuration. |
setCurrentDockingConfiguration()
. Returns the pane whose index is specified.
This method is pure and, therefore, needs to be redefined in subclasses.
index | The index of the pane. |
|
pure virtual |
Returns the total number of panes managed by this handler.
This method is pure and, therefore, needs to be redefined in subclasses.
|
pure virtual |
Returns the IlvDockableMainWindow
object this handler points to.
This is a pure virtual method. It needs to be redefined in subclasses.
IlvDockableMainWindow
object this handler points to. void IlvDockingConfigurationHandler::setCurrentDockingConfiguration | ( | const IlvDockingConfiguration & | conf, |
IlBoolean | update = IlTrue |
||
) |
Sets the specified docking configuration as the current one.
This method moves the panes to match the configuration specified by conf.
conf | The new docking configuration. |
update | A Boolean value specifying whether the modified panes should be redrawn or not. |
getCurrentDockingConfiguration()
. © 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.