PrimoBurner(tm) for C++  4.6
CD, DVD and Blu-ray Software Development Kit
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Pages
DataFileList Class Referenceabstract

Represents a collection of DataFile objects. More...

#include <PrimoBurnerAPI.h>

Public Member Functions

virtual bool_t add (DataFile *item)=0
 Adds a new DataFile object to the list. More...
 
virtual DataFileat (int32_t index) const =0
 Gets the element at the specified index. More...
 
virtual void clear ()=0
 Removes all items from the list.
 
virtual int32_t count () const =0
 Gets the number of elements in the list. More...
 
virtual int32_t indexOf (const DataFile *item) const =0
 Determines the index of a specific item in the list. More...
 
virtual bool_t insert (int32_t index, DataFile *item)=0
 Inserts an element at the specified position in the list. More...
 
virtual void remove (int32_t index)=0
 Removes the element at the specified index. More...
 
virtual bool_t setAt (int32_t index, DataFile *item)=0
 Sets the element at the specified index. More...
 

Detailed Description

Represents a collection of DataFile objects.

See Also
DataFile

Member Function Documentation

virtual bool_t add ( DataFile item)
pure virtual

Adds a new DataFile object to the list.

This automatically makes the parent DataFile object a directory.

Parameters
item[in] An DataFile object that should be added to the list. See DataFile for more details.
Returns
1 Success
0 The item has a parent already.
See Also
DataFile
virtual DataFile* at ( int32_t  index) const
pure virtual

Gets the element at the specified index.

Parameters
index[in] The zero-based index of the element to get.
Returns
An DataFile instance, or NULL if the index is out of range.
virtual int32_t count ( ) const
pure virtual

Gets the number of elements in the list.

Returns
number of elements
virtual int32_t indexOf ( const DataFile item) const
pure virtual

Determines the index of a specific item in the list.

Parameters
item[in] The item to be searched in the list.
Returns
The index of item if found in the list; otherwise, -1.
virtual bool_t insert ( int32_t  index,
DataFile item 
)
pure virtual

Inserts an element at the specified position in the list.

Parameters
index[in] The zero-based index in the list where the new element should be inserted.
item[in] The new DataFile object that should be inserted in the list.
Returns
1 Success
0 The index is out of range.
0 The item has a parent already.
virtual void remove ( int32_t  index)
pure virtual

Removes the element at the specified index.

Parameters
index[in] The zero-based index of the element to remove.
virtual bool_t setAt ( int32_t  index,
DataFile item 
)
pure virtual

Sets the element at the specified index.

Parameters
index[in] The zero-based index of the element to set.
item[in] The new DataFile object.
Returns
1 Success
0 The index is out of range.
0 The item has a parent already.