IlvDvProjectView Class Reference

Application Framework project view class. More...

#include <ilviews/appframe/project/prjview.h>

Inheritance diagram for IlvDvProjectView:

Public Member Functions
	IlvDvProjectView (IlvDisplay *display)
	Constructs an IlvDvProjectView object. More...
IlvDvProjectDocument *	getProjectDocument () const
	Returns the associated project document. More...
virtual void	initializeView ()
	Initializes the project view. More...
Public Member Functions inherited from IlvDvTreeView
	IlvDvTreeView (IlvDisplay *display)
	Constructs an IlvDvTreeView object. More...
virtual IlvGraphic *	getGraphic ()
	Gets the graphic object of the document view. More...
Public Member Functions inherited from IlvDvDocViewInterface
IlvDvDocument *	getDocument () const
	Gets the document associated with the view. More...
IlvDvApplication *	getDvApplication () const
	Gets the application in which the document view is displayed. More...
virtual IlvAbstractView *	getDvView ()
	Gets the IlvAbstractView of the document view. More...
IlvDvViewContainerInterface *	getViewContainer () const
	Gets the document view container that owns the view. More...
virtual void	serialize (IlvDvStream &)
	Serializes the object in the stream stream. Typically, the body of the method has the following form: More...
Public Member Functions inherited from IlvDvInterface
IlBoolean	callMethod (const IlSymbol *methodName, IlvDvValue *returnedValue,...)
	Generic method for calling a method that is exported in a class interface. More...
IlvDvValue &	getFieldValue (const IlSymbol *fieldName, IlvDvValue &value) const
	Gets a field value. More...
virtual IlBoolean	isProcessingAction (const IlSymbol *methodName) const
	Returns IlTrue if the given action can be processed by the class. More...
virtual IlBoolean	processAction (const IlSymbol *actionName)
	Processes an action. More...
virtual IlBoolean	refreshAction (const IlSymbol *actionName, IlvDvActionDescriptor *desc) const
	Refresh all the menu items that reference the action given by the parameter actionName. More...
void	setFieldValue (const IlSymbol *fieldName, const IlvDvValue &value)
	Sets a field value. More...

Protected Member Functions
virtual void	activateSelection ()
	Activates the selected items. More...
virtual IlBoolean	canInsertFile () const
	Returns IlTrue if a file can be inserted. More...
virtual IlBoolean	canInsertFolder () const
	Returns IlTrue if a folder can be inserted. More...
virtual void	deleteSelection ()
	Deletes the selected items. More...
virtual const IlSymbol *	getPopupMenuResourceId (const IlvTreeGadgetItem *item) const
	Returns the resource id of the popup menu for a given item. More...
IlvDvProjectItem *	getProjectItem (const IlvTreeGadgetItem *item) const
	Retrieves the project item corresponding to the tree gadget item item. More...
IlvTreeGadgetItem *	getSelectedItems (IlArray &items) const
	Gets the selected tree gadget items and stores them in the items parameter. More...
IlvDvProjectItem *	getSelectedProjectItem () const
	Retrieves the project item that corresponds to the last selected tree gadget item. More...
virtual void	insertFile ()
	Inserts a file into the project document. More...
virtual void	insertFolder ()
	Inserts a folder into the project document. More...
Protected Member Functions inherited from IlvDvTreeView
virtual IlvPopupMenu *	getPopupMenuForItem (const IlvTreeGadgetItem *item)
	Returns the popup menu shown when a right-click occurs on the item item. More...
virtual void	rightClickOnItem (IlvTreeGadgetItem *item, const IlvPoint &pt)
	Called when the user right-clicks a tree gadget item. More...

Detailed Description

Application Framework project view class.

Library: ilvappframe

IlvDvProjectView is a subclass of IlvDvTreeView. It edits project documents whose class must be derived from IlvDvProjectDocument. When initializing, it creates tree gadget items. These items are built according to project items owned by the associated project document, in the same order.
The IlvDvProjectView class provides interfaces for adding and removing files or folders.

Constructor & Destructor Documentation

IlvDvProjectView()

IlvDvProjectView::IlvDvProjectView

(

IlvDisplay *

display

)

Constructs an IlvDvProjectView object.

This constructor creates an instance of IlvDvProjectView, using the display parameter, to initialize the superclass IlvDvTreeView.

Member Function Documentation

activateSelection()

virtual void IlvDvProjectView::activateSelection ( )

protectedvirtual

Activates the selected items.

It calls the activateItems method of the associated project document giving the selected items as the parameter.

Reimplemented from IlvDvTreeView.

canInsertFile()

virtual IlBoolean IlvDvProjectView::canInsertFile ( ) const

protectedvirtual

Returns IlTrue if a file can be inserted.

This depends on the type to the current selection. By default, it returns IlFalse if there are no selections or if the selected project item can not contain child items, such as project file items.

Returns

Returns IlTrue if a file can be inserted.

canInsertFolder()

virtual IlBoolean IlvDvProjectView::canInsertFolder ( ) const

protectedvirtual

Returns IlTrue if a folder can be inserted.

This depends on the type of the current selection. By default, it returns IlFalse if there are no selections or if the selected project item can not contain child items, such as a project file item.

Returns

IlTrue if a folder can be inserted.

deleteSelection()

virtual void IlvDvProjectView::deleteSelection ( )

protectedvirtual

Deletes the selected items.

Called when the Delete action is invoked. By default, it notifies the associated project document to delete all the project items that correspond to its selected tree gadget items.

getPopupMenuResourceId()

virtual const IlSymbol* IlvDvProjectView::getPopupMenuResourceId ( const IlvTreeGadgetItem *  item ) const

protectedvirtual

Returns the resource id of the popup menu for a given item.

Returns the popup menu resource id that will allow you to construct the popup menu shown when a right-click occurs on the item item.
By default, it retrieves the project item corresponding to the item item and it calls the method getPopupMenuResouceId of the project item.

Parameters

item	The item under the right-click.

See also

IlvDvTreeView::getPopupMenuResourceId

IlvDvProjectItem::getPopupMenuResouceId

Reimplemented from IlvDvTreeView.

getProjectDocument()

IlvDvProjectDocument* IlvDvProjectView::getProjectDocument

(

)

const

Returns the associated project document.

Returns

The associated project document.

getProjectItem()

IlvDvProjectItem* IlvDvProjectView::getProjectItem ( const IlvTreeGadgetItem *  item ) const

protected

Retrieves the project item corresponding to the tree gadget item item.

Returns

The project item that corresponds to the given item.

getSelectedItems()

IlvTreeGadgetItem* IlvDvProjectView::getSelectedItems ( IlArray &  items ) const

protected

Gets the selected tree gadget items and stores them in the items parameter.

Returns

The last selected tree gadget item.

getSelectedProjectItem()

IlvDvProjectItem* IlvDvProjectView::getSelectedProjectItem ( ) const

protected

Retrieves the project item that corresponds to the last selected tree gadget item.

Returns

The project item that corresponds to the selected tree item. If no tree item is selected, it returns 0.

initializeView()

virtual void IlvDvProjectView::initializeView ( )

virtual

Initializes the project view.

It fills the tree with tree gadget items. These items are built according to project items owned by the associated project document, in the same order.

Reimplemented from IlvDvDocViewInterface.

insertFile()

virtual void IlvDvProjectView::insertFile ( )

protectedvirtual

Inserts a file into the project document.

It prompts the user for a file. Then, it calls the insertFile method of the project document, giving the parent project item and the file name selected by the user as parameters.

insertFolder()

virtual void IlvDvProjectView::insertFolder ( )

protectedvirtual

Inserts a folder into the project document.

It prompts the user for a folder name and for folder extensions. Then, it calls the insertFolder method of the project document, giving the parent project item, the specified folder name, and the optional extensions of the folder as parameters.