rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Application Framework Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvDvProjectItem Class Reference

Application Framework project item class. More...

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

Inheritance diagram for IlvDvProjectItem:
IlvTreeGadgetItem IlvGadgetItem IlvDvDocumentProjectItem IlvDvFileItem IlvDvFolderItem

List of all members.

Public Member Functions

 IlvDvProjectItem (const char *label, IlvBitmap *bitmap=0, IlvPosition position=IlvRight, IlUShort spacing=IlvDefaultGadgetItemSpacing)
 Constructs an IlvDvProjectItem object.
void addChild (IlvDvProjectItem *item)
 Adds a project item as a child of this item.
virtual const IlSymbolgetPopupMenuResouceId () const
 Returns a menu resource identifier.
virtual IlBoolean isFile () const
 Returns IlTrue if the class is derived from the IlvDvFileItem class.
virtual IlBoolean isFolder () const
 Returns IlTrue if the class is derived from the IlvDvFolderItem class.
virtual IlBoolean removeChild (IlvDvProjectItem *item)
 Removes a child from this item.

Protected Member Functions

virtual IlvDvProjectItem_duplicate () const
 Returns a copy of the object.

Detailed Description

Application Framework project item class.

Library: ilvappframe

IlvDvProjectItem is a subclass of IlvTreeGadgetItem. It is the base class for items that are stored by the project document. All its graphical attributes inherited from the IlvTreeGadgetItem class are used to create corresponding tree gadget items in the tree project view.
Derived classes usually used are IlvDvFileItem and IlvDvFolderItem for items that represent files and file folders respectively.


Constructor & Destructor Documentation

IlvDvProjectItem::IlvDvProjectItem ( const char *  label,
IlvBitmap bitmap = 0,
IlvPosition  position = IlvRight,
IlUShort  spacing = IlvDefaultGadgetItemSpacing 
)

Constructs an IlvDvProjectItem object.

This constructor creates an instance of IlvDvProjectItem, whose label, bitmap, position, and spacing are provided by the parameters label, bitmap, code, and spacing respectively.


Member Function Documentation

virtual IlvDvProjectItem* IlvDvProjectItem::_duplicate (  )  const [protected, virtual]

Returns a copy of the object.

This method is only used by the duplicate method for duplicating the object without duplicating its child items. This method must be redefined by all the derived classes.

Returns:
A copy of the object.

Reimplemented in IlvDvFileItem, IlvDvFolderItem, and IlvDvDocumentProjectItem.

void IlvDvProjectItem::addChild ( IlvDvProjectItem item  ) 

Adds a project item as a child of this item.

Adds the project item given by the parameter item as the last child of this item.

virtual const IlSymbol* IlvDvProjectItem::getPopupMenuResouceId (  )  const [virtual]

Returns a menu resource identifier.

Returns the resource identifier of the popup menu shown when a right-click occurs on the item.

Returns:
The popup menu resource identifier.

Reimplemented in IlvDvFileItem, IlvDvFolderItem, and IlvDvDocumentProjectItem.

virtual IlBoolean IlvDvProjectItem::isFile (  )  const [virtual]

Returns IlTrue if the class is derived from the IlvDvFileItem class.

Returns:
IlTrue if the class is derived from the IlvDvFileItem class.

Reimplemented in IlvDvFileItem.

virtual IlBoolean IlvDvProjectItem::isFolder (  )  const [virtual]

Returns IlTrue if the class is derived from the IlvDvFolderItem class.

Returns:
IlTrue if the class is derived from the IlvDvFolderItem class.

Reimplemented in IlvDvFolderItem, and IlvDvDocumentProjectItem.

virtual IlBoolean IlvDvProjectItem::removeChild ( IlvDvProjectItem item  )  [virtual]

Removes a child from this item.

Removes the project item given by the parameter item from the child items.

Returns:
IlTrue if the given item was found among the child items.

© Copyright 2012, 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.