IlvDvFrameAndBarHandler Class Reference

Application Framework pane or frame handler. More...

#include <ilviews/appframe/framebar.h>

Inheritance diagram for IlvDvFrameAndBarHandler:

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...

Detailed Description

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.

Constructor & Destructor Documentation

IlvDvFrameAndBarHandler()

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.

Member Function Documentation

getDocViewFactory()

IlvDvDocumentViewFactory* IlvDvFrameAndBarHandler::getDocViewFactory ( ) const

virtual

Gets the document view factory of the container factory.

Returns

The document view factory of the container factory.

Implements IlvDvContainerHandler.

readOptions()

virtual void IlvDvFrameAndBarHandler::readOptions ( IlvDvOptions *  options )

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.

setDocViewFactory()

void IlvDvFrameAndBarHandler::setDocViewFactory ( IlvDvDocumentViewFactory *  factory )

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.

See also

getDocViewFactory

Implements IlvDvContainerHandler.

updateOptions()

virtual void IlvDvFrameAndBarHandler::updateOptions ( IlvDvOptions *  options )

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.