Rogue Wave Views Application Framework Package API Reference Guide |
Rogue Wave Views Documentation Home |
Application Framework pane or frame handler. More...
#include <ilviews/appframe/framebar.h>
Public Member Functions | |
IlvDvFrameAndBarHandler (IlvDvDockableMainWindow *mainWindow, IlvDvDocTemplate *docTemplate, ContainerType mode=MDIChild, IlBoolean isMaximizing=IlFalse, IlUInt viewTemplateIndex=0) | |
Constructs an IlvDvFrameAndBarHandler object. More... | |
virtual IlvDvViewContainerInterface * | createContainer () |
Creates a document view container. | |
IlvDvDocumentViewFactory * | getDocViewFactory () const |
Gets the document view factory of the container factory. More... | |
virtual void | readOptions (IlvDvOptions *options) |
Reads parameters from options. More... | |
void | setDocViewFactory (IlvDvDocumentViewFactory *) |
This method sets the document view factory factory to the container handler. More... | |
virtual void | updateOptions (IlvDvOptions *options) |
Updates the options with the object data. More... | |
Application Framework pane or frame handler.
Library: ilvappframe
IlvDvFrameAndBarHandler
is a subclass of IlvDvContainerHandler
. It is used by document templates to create document view containers, used for inserting document views. Depending on its creation mode, containers can be dockable bars (IlvDvViewPane
objects) or view frames (IlvDvViewFrame
objects).
This class is the default container handler provided by the Application Framework library for creating document view containers. It is instantiated by the IlvDvDockableMainWindow
windows by invoking the IlvDvDockableMainWindow::createContainerHandler
method.
IlvDvFrameAndBarHandler::IlvDvFrameAndBarHandler | ( | IlvDvDockableMainWindow * | mainWindow, |
IlvDvDocTemplate * | docTemplate, | ||
ContainerType | mode = MDIChild , |
||
IlBoolean | isMaximizing = IlFalse , |
||
IlUInt | viewTemplateIndex = 0 |
||
) |
Constructs an IlvDvFrameAndBarHandler
object.
This constructor creates an instance of IlvDvFrameAndBarHandler
, whose main window, template name, initial container creation mode, and maximization mode are provided by the parameters mainWindow, templateName, mode, and isMaximizing respectively.
|
virtual |
Gets the document view factory of the container factory.
Implements IlvDvContainerHandler.
|
virtual |
Reads parameters from options.
This method is called to make the object read its data from options given as the parameter options.
Implements IlvDvContainerHandler.
|
virtual |
This method sets the document view factory factory to the container handler.
This container handler will use this factory to create document views that it will attach to the views container it creates. The container handler is given the responsibility of destroying the given factory.
Implements IlvDvContainerHandler.
|
virtual |
Updates the options with the object data.
This method is called to update the options, given as the parameter options, corresponding to the object data.
Implements IlvDvContainerHandler.
© 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.