IlvDvViewPane Class Reference

Application Framework view pane. More...

#include <ilviews/appframe/viewpane.h>

Inheritance diagram for IlvDvViewPane:

List of all members.

Public Member Functions
	IlvDvViewPane (IlvDvFrameAndBarHandler *paneHandler, const char *name)
	Constructs an IlvDvViewPane object.
virtual IlvDvDocViewInterface *	getActiveDocView () const
	Gets the active view for the container.
virtual IlvGadgetContainer *	getClientContainer (IlBoolean create=IlFalse)
	Gets the client container.
virtual IlvDvContainerHandler *	getContainerHandler () const
	Gets the container handler that handles this container.
virtual IlUInt	getContainerNumber () const
	Gets the container number.
virtual const char *	getContainerTitle () const
	Gets the title of the container.
virtual IlvDvApplication *	getDvApplication () const
	Gets the application in which the container is created.
IlvPane *	getPane () const
	Gets the IlvPane object created by the container.
void	hide ()
	Hides the associated pane.
virtual IlBoolean	isContainerVisible () const
	Gets the visibility state of the container.
virtual IlBoolean	readMask (const char *pathName)
	Called to read the given pathName .ilv file as a mask for the container.
virtual void	setContainerNumber (IlUInt n, IlBoolean update=IlFalse)
	Sets the container number.
virtual void	setDvApplication (IlvDvApplication *app)
	Sets the application in which the container is created to the parameter app.
virtual void	updateTitle ()
	Updates the container title.
Protected Member Functions
virtual IlvArray &	getViewsArray ()
	Gets the array of document views owned by the container.
virtual IlBoolean	isUsingMask () const
	Returns IlTrue if the container uses an .ilv mask when attaching its document views.
virtual void	setUsingMask (IlBoolean)
	Specifies whether the container uses an .ilv mask when adding its document views.
virtual void	storeActiveDocView (IlvDvDocViewInterface *activeView)
	Stores the document view activeView as the active view.

---

Detailed Description

Application Framework view pane.

Library: ilvappframe

IlvDvViewPane implements the IlvDvViewContainerInterface interface so that it can be used by a document template to store document views.
When initializing, it creates an IlvPane object that contains the attached document views.

---

Constructor & Destructor Documentation

IlvDvViewPane::IlvDvViewPane	(	IlvDvFrameAndBarHandler *	paneHandler,
		const char *	name
	)

Constructs an IlvDvViewPane object.

This constructor creates an instance of IlvDvViewPane, whose pane handler is given by the parameter paneHandler, and whose name is given by the name parameter.

---

Member Function Documentation

virtual IlvDvDocViewInterface* IlvDvViewPane::getActiveDocView

(

)

const [virtual]

Gets the active view for the container.

Returns the last document view that received the focus inside the container. The active view is set by a call to the method setActiveDocView.

Reimplemented from IlvDvViewContainerInterface.

virtual IlvGadgetContainer* IlvDvViewPane::getClientContainer

(

IlBoolean

create = IlFalse

)

[virtual]

Gets the client container.

Parameters:

create

If IlTrue, the client container is created (if it did not already exist).

Returns:

The gadget container owned by the views container.

Reimplemented from IlvDvViewContainerInterface.

virtual IlUInt IlvDvViewPane::getContainerNumber

(

)

const [virtual]

Gets the container number.

Returns the number set by the document template by calling the method setContainerNumber. This number is used to build different window titles for windows that contain views associated with the same document. For example, two windows that show the same document titled Document1 may have titles Document1 and Document1:2.

Implements IlvDvViewContainerInterface.

virtual const char* IlvDvViewPane::getContainerTitle

(

)

const [virtual]

Gets the title of the container.

Returns:

The title of the container.

Implements IlvDvViewContainerInterface.

virtual IlvDvApplication* IlvDvViewPane::getDvApplication

(

)

const [virtual]

Gets the application in which the container is created.

The application is set by a call to the method setDvApplication.

Returns:

The current application.

Implements IlvDvViewContainerInterface.

IlvPane* IlvDvViewPane::getPane

(

)

const

Gets the IlvPane object created by the container.

Returns:

The IlvPane object created by the container.

virtual IlvArray& IlvDvViewPane::getViewsArray

(

)

[protected, virtual]

Gets the array of document views owned by the container.

Returns:

The array of document views owned by the container.

Implements IlvDvViewContainerInterface.

virtual IlBoolean IlvDvViewPane::isContainerVisible

(

)

const [virtual]

Gets the visibility state of the container.

Returns:

IlTrue if the container is visible.

Implements IlvDvViewContainerInterface.

virtual IlBoolean IlvDvViewPane::isUsingMask

(

)

const [protected, virtual]

Returns IlTrue if the container uses an .ilv mask when attaching its document views.

This flag is set when method setUsingMask is called.

Returns:

IlTrue if the container uses an .ilv mask when attaching its document views.

Implements IlvDvViewContainerInterface.

virtual IlBoolean IlvDvViewPane::readMask

(

const char *

pathName

)

[virtual]

Called to read the given pathName .ilv file as a mask for the container.

This file is read by the client container and added document views replace client container objects of name View[nView].

Reimplemented from IlvDvViewContainerInterface.

virtual void IlvDvViewPane::setContainerNumber	(	IlUInt	n,
		IlBoolean	update = IlFalse
	)			[virtual]

Sets the container number.

Called to set the container number to the given n parameter. This method is usually called when the document associated with the owned document views has its title changed.

Parameters:

update

If param is IlTrue, the updateTitle method is called.

Implements IlvDvViewContainerInterface.

virtual void IlvDvViewPane::setUsingMask

(

IlBoolean

useMask

)

[protected, virtual]

Specifies whether the container uses an .ilv mask when adding its document views.

The parameter useMask specifies if the container uses an .ilv mask when adding its document views. This method is called by the readFile method, with the useMask parameter set to IlTrue if the file is valid. This file name was set previously by calling the readMask method.

Implements IlvDvViewContainerInterface.

virtual void IlvDvViewPane::updateTitle

(

)

[virtual]

Updates the container title.

Called when the title of the container needs to be updated. This usually occurs when the title of the document attached to the document view container changes.

Implements IlvDvViewContainerInterface.