Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

TDirCollection Class Reference

Simple TCollection derivative used for storing TDirEntry objects. More...

#include <stddlg.h>

Inheritance diagram for TDirCollection::

TCollection TNSCollection TStreamable TObject List of all members.

Public Methods

 TDirCollection (ccIndex aLimit, ccIndex aDelta)
TDirEntryat (ccIndex index)
virtual ccIndex indexOf (TDirEntry *item)
void remove (TDirEntry *item)
void free (TDirEntry *item)
void atInsert (ccIndex index, TDirEntry *item)
void atPut (ccIndex index, TDirEntry *item)
virtual ccIndex insert (TDirEntry *item)
TDirEntryfirstThat (ccTestFunc Test, void *arg)
TDirEntrylastThat (ccTestFunc Test, void *arg)

Static Public Methods

TStreamablebuild ()

Static Public Attributes

const char* const name

Protected Methods

 TDirCollection (StreamableInit)

Detailed Description

TDirCollection is a simple TCollection derivative used for storing TDirEntry objects.

TDirCollection is a streamable class, inheriting TStreamable from its base class TCollection.

Definition at line 995 of file stddlg.h.


Constructor & Destructor Documentation

TDirCollection::TDirCollection ( ccIndex aLimit,
ccIndex aDelta ) [inline]
 

Calls the base TCollection constructor to create a directory collection with the given limit `aLimit' and delta `aDelta'.

Definition at line 1002 of file stddlg.h.

TDirCollection::TDirCollection ( StreamableInit ) [inline, protected]
 

Undocumented.

Definition at line 1095 of file stddlg.h.


Member Function Documentation

TDirEntry * TDirCollection::at ( ccIndex index ) [inline]
 

Returns a pointer to the TDirEntry object indexed by `index' in this directory collection.

See also:
TCollection::at

Reimplemented from TNSCollection.

Definition at line 1009 of file stddlg.h.

void TDirCollection::atInsert ( ccIndex index,
TDirEntry * item ) [inline]
 

Inserts the given `item' into the collection at the given `index' and moves the following items down one position. The collection will be expanded by delta if the insertion causes the limit to be exceeded.

See also:
TCollection::atInsert

Definition at line 1038 of file stddlg.h.

void TDirCollection::atPut ( ccIndex index,
TDirEntry * item ) [inline]
 

Replaces the item at `index' with the given `item'.

See also:
TCollection::atPut

Definition at line 1044 of file stddlg.h.

TStreamable * TDirCollection::build ( ) [static]
 

Called to create an object in certain stream-reading situations.

TDirEntry * TDirCollection::firstThat ( ccTestFunc func,
void * arg ) [inline]
 

This iterator returns a pointer to the first TDirEntry object in the collection for which the `Test' function returns True.

Reimplemented from TNSCollection.

Definition at line 1129 of file stddlg.h.

void TDirCollection::free ( TDirEntry * item ) [inline]
 

Removes (deletes) the given `item' from the collection and frees the space in the collection.

See also:
TCollection::free

Definition at line 1029 of file stddlg.h.

ccIndex TDirCollection::indexOf ( TDirEntry * item ) [inline, virtual]
 

Returns the index of the given `item' in this directory collection.

See also:
TCollection::indexOf

Definition at line 1015 of file stddlg.h.

ccIndex TDirCollection::insert ( TDirEntry * item ) [inline, virtual]
 

Inserts the `item' into the collection, and adjust the other indexes if necessary. By default, insertions are made at the end of the collection. The index of the inserted item is returned.

See also:
TCollection::insert

Definition at line 1052 of file stddlg.h.

TDirEntry * TDirCollection::lastThat ( ccTestFunc func,
void * arg ) [inline]
 

This iterator scans the collection from the last TDirEntry object to first. It returns a pointer to the first (that is, the nearest to the end) item in the collection for which the `Test' function returns True.

Reimplemented from TNSCollection.

Definition at line 1134 of file stddlg.h.

void TDirCollection::remove ( TDirEntry * item ) [inline]
 

Removes (deletes) the given `item' from this collection. The space in the collection is not freed.

See also:
TCollection::remove

Definition at line 1022 of file stddlg.h.


Member Data Documentation

const char *const TDirCollection::name [static]
 

Undocumented.

Reimplemented from TCollection.

Definition at line 1100 of file stddlg.h.


The documentation for this class was generated from the following file:
Generated at Sat Sep 22 20:19:23 2001 for TVision by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001