IlvDvViewContainerInterface Class Reference

The IlvDvViewContainerInterface class is an interface for windows that own document views. More...

#include <ilviews/appframe/viewcont.h>

Inheritance diagram for IlvDvViewContainerInterface:

List of all members.

Public Member Functions
virtual IlBoolean	attachDocViews (IlvDvDocViewInterface **views, IlUInt viewsCount)
	Attaches the document views views to the container.
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 =0
	Gets the container handler that handles this container.
virtual IlUInt	getContainerNumber () const =0
	Gets the container number.
virtual const char *	getContainerTitle () const =0
	Gets the title of the container.
IlvDvDocViewInterface *	getDocView (IlUInt index) const
	Gets the document view located at the position index.
IlUInt	getDocViewsCount () const
	Gets the document views count.
virtual IlvDvApplication *	getDvApplication () const =0
	Gets the application in which the container is created.
virtual IlBoolean	isContainerVisible () const =0
	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	setActiveDocView (IlvDvDocViewInterface *activeView, IlBoolean notify=IlTrue)
	Sets the active document view to the parameter activeView.
virtual void	setContainerNumber (IlUInt n, IlBoolean update=IlFalse)=0
	Sets the container number.
virtual void	setDvApplication (IlvDvApplication *app)=0
	Sets the application in which the container is created to the parameter app.
virtual void	updateTitle ()=0
	Updates the container title.
Protected Member Functions
virtual IlvArray &	getViewsArray ()=0
	Gets the array of document views owned by the container.
virtual IlBoolean	isUsingMask () const =0
	Returns IlTrue if the container uses an .ilv mask when attaching its document views.
virtual const IlvString &	makeTitle (IlvString &title) const
	Creates a title for the container, according to the title of the associated document, its modification state, and the window number of the container. These parameters are joined together as follows to create the container title: <DocumentTitle>[:<ContainerNumber>] [*].
virtual void	setUsingMask (IlBoolean useMask)=0
	Specifies whether the container uses an .ilv mask when adding its document views.
virtual void	storeActiveDocView (IlvDvDocViewInterface *activeView)=0
	Stores the document view activeView as the active view.

---

Detailed Description

The IlvDvViewContainerInterface class is an interface for windows that own document views.

Library: ilvappframe

Document view containers are created and handled by the document templates. The Application Framework package provides two types of document view containers that inherit from the IlvDvViewContainerInterface interface:

• View frames, defined by the IlvDvViewFrame class.
• Dockable bars, defined by the IlvDvViewPane class.

---

Member Function Documentation

virtual IlBoolean IlvDvViewContainerInterface::attachDocViews	(	IlvDvDocViewInterface **	views,
		IlUInt	viewsCount
	)			[virtual]

Attaches the document views views to the container.

The given views are created and given by the document template. If an .ilv mask file was specified, objects from the client container with the names View0, View1, and so on, are replaced by the document views views[0], views[1], until viewsCount.

Returns:

IlTrue if the document views are attached to the container.

virtual IlvDvDocViewInterface* IlvDvViewContainerInterface::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 in IlvDvViewPane.

virtual IlvGadgetContainer* IlvDvViewContainerInterface::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 in IlvDvViewPane.

virtual IlUInt IlvDvViewContainerInterface::getContainerNumber

(

)

const [pure 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.

Implemented in IlvDvViewPane.

virtual const char* IlvDvViewContainerInterface::getContainerTitle

(

)

const [pure virtual]

Gets the title of the container.

Returns:

The title of the container.

Implemented in IlvDvViewPane.

IlUInt IlvDvViewContainerInterface::getDocViewsCount

(

)

const

Gets the document views count.

Returns:

The document views count.

virtual IlvDvApplication* IlvDvViewContainerInterface::getDvApplication

(

)

const [pure 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.

Implemented in IlvDvViewPane.

virtual IlvArray& IlvDvViewContainerInterface::getViewsArray

(

)

[protected, pure virtual]

Gets the array of document views owned by the container.

Returns:

The array of document views owned by the container.

Implemented in IlvDvViewPane.

virtual IlBoolean IlvDvViewContainerInterface::isContainerVisible

(

)

const [pure virtual]

Gets the visibility state of the container.

Returns:

IlTrue if the container is visible.

Implemented in IlvDvViewPane.

virtual IlBoolean IlvDvViewContainerInterface::isUsingMask

(

)

const [protected, pure 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.

Implemented in IlvDvViewPane.

virtual const IlvString& IlvDvViewContainerInterface::makeTitle

(

IlvString &

title

)

const [protected, virtual]

Creates a title for the container, according to the title of the associated document, its modification state, and the window number of the container. These parameters are joined together as follows to create the container title:
<DocumentTitle>[:<ContainerNumber>] [*].

Parameters:

title

Gets the title of the container.

Returns:

The title parameter.

virtual IlBoolean IlvDvViewContainerInterface::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 in IlvDvViewPane.

virtual void IlvDvViewContainerInterface::setActiveDocView	(	IlvDvDocViewInterface *	activeView,
		IlBoolean	notify = IlTrue
	)			[virtual]

Sets the active document view to the parameter activeView.

Parameters:

notify

If IlTrue, the activeView parameter is notified that it is becoming active. It is notified by calling its method setActive.

virtual void IlvDvViewContainerInterface::setContainerNumber	(	IlUInt	n,
		IlBoolean	update = IlFalse
	)			[pure 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.

Implemented in IlvDvViewPane.

virtual void IlvDvViewContainerInterface::setUsingMask

(

IlBoolean

useMask

)

[protected, pure 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.

Implemented in IlvDvViewPane.

virtual void IlvDvViewContainerInterface::updateTitle

(

)

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

Implemented in IlvDvViewPane.