rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Application Framework Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Protected Member Functions
IlvDvFolderItem Class Reference

Application Framework project folder item class. More...

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

Inheritance diagram for IlvDvFolderItem:
IlvDvProjectItem IlvTreeGadgetItem IlvGadgetItem

Public Member Functions

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

Protected Member Functions

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

Detailed Description

Application Framework project folder item class.

Library: ilvappframe

IlvDvFolderItem is a subclass of IlvDvProjectItem. It is a project item used to group project items together. If extensions are specified for the folder, project file items that reference a file with a matching extension will be added to the folder.
The tree gadget item that references this item in a project view has, by default, a folder bitmap.

Constructor & Destructor Documentation

IlvDvFolderItem::IlvDvFolderItem ( IlvDisplay display,
const char *  name,
const char *  extensions 
)

Constructs an IlvDvFolderItem object.

This constructor creates an instance of IlvDvFolderItem according to the parameters display, name, and extensions. The item label is set to the name parameter.

Parameters
extensionsSpecifies the extensions of file items inserted into the folder item.

Member Function Documentation

virtual IlvDvProjectItem* IlvDvFolderItem::_duplicate ( ) const
protectedvirtual

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

virtual const IlSymbol* IlvDvFolderItem::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 from IlvDvProjectItem.

virtual IlBoolean IlvDvFolderItem::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 from IlvDvProjectItem.


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