From 7028cbe09c688437910a25623098762bf0fa592d Mon Sep 17 00:00:00 2001 From: David Walter Seikel Date: Mon, 28 Mar 2016 22:28:34 +1000 Subject: Move Irrlicht to src/others. --- .../doc/html/classirr_1_1io_1_1_i_file_list.html | 474 +++++++++++++++++++++ 1 file changed, 474 insertions(+) create mode 100644 src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_list.html (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_list.html') diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_list.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_list.html new file mode 100644 index 0000000..377a89c --- /dev/null +++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_list.html @@ -0,0 +1,474 @@ + + + + +Irrlicht 3D Engine: irr::io::IFileList Class Reference + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + +
+
Irrlicht 3D Engine + +
+ +
+ + + + + + +
+
+
+ + + + +
+
+ +
+
+
+ +
+
+
+Public Member Functions
+
+
irr::io::IFileList Class Reference
+
+
+ +

Provides a list of files and folders. + More...

+ +

#include <IFileList.h>

+
+ + Inheritance diagram for irr::io::IFileList:
+
+
+ + +

List of all members.

+

+Public Member Functions

+ +

Detailed Description

+

Provides a list of files and folders.

+

File lists usually contain a list of all files in a given folder, but can also contain a complete directory structure.

+ +

Definition at line 19 of file IFileList.h.

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual u32 irr::io::IFileList::addItem (const io::path & fullPath,
u32 offset,
u32 size,
bool isDirectory,
u32 id = 0 
) [pure virtual]
+
+
+ +

Add as a file or folder to the list.

+
Parameters:
+ + + + + + +
fullPathThe file name including path, from the root of the file list.
isDirectoryTrue if this is a directory rather than a file.
offsetThe file offset inside an archive
sizeThe size of the file in bytes.
idThe ID of the file in the archive which owns it
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
virtual s32 irr::io::IFileList::findFile (const io::path & filename,
bool isFolder = false 
) const [pure virtual]
+
+
+ +

Searches for a file or folder in the list.

+

Searches for a file by name

+
Parameters:
+ + + +
filenameThe name of the file to search for.
isFolderTrue if you are searching for a directory path, false if you are searching for a file
+
+
+
Returns:
Returns the index of the file in the file list, or -1 if no matching name name was found.
+ +
+
+ +
+
+ + + + + + + +
virtual u32 irr::io::IFileList::getFileCount () const [pure virtual]
+
+
+ +

Get the number of files in the filelist.

+
Returns:
Amount of files and directories in the file list.
+ +
+
+ +
+
+ + + + + + + + +
virtual const io::path& irr::io::IFileList::getFileName (u32 index) const [pure virtual]
+
+
+ +

Gets the name of a file in the list, based on an index.

+

The path is not included in this name. Use getFullFileName for this.

+
Parameters:
+ + +
indexis the zero based index of the file which name should be returned. The index must be less than the amount getFileCount() returns.
+
+
+
Returns:
File name of the file. Returns 0, if an error occured.
+ +
+
+ +
+
+ + + + + + + + +
virtual u32 irr::io::IFileList::getFileOffset (u32 index) const [pure virtual]
+
+
+ +

Returns the file offset of a file in the file list, based on an index.

+
Parameters:
+ + +
indexis the zero based index of the file which should be returned. The index must be less than the amount getFileCount() returns.
+
+
+
Returns:
The offset of the file in bytes.
+ +
+
+ +
+
+ + + + + + + + +
virtual u32 irr::io::IFileList::getFileSize (u32 index) const [pure virtual]
+
+
+ +

Returns the size of a file in the file list, based on an index.

+
Parameters:
+ + +
indexis the zero based index of the file which should be returned. The index must be less than the amount getFileCount() returns.
+
+
+
Returns:
The size of the file in bytes.
+ +
+
+ +
+
+ + + + + + + + +
virtual const io::path& irr::io::IFileList::getFullFileName (u32 index) const [pure virtual]
+
+
+ +

Gets the full name of a file in the list including the path, based on an index.

+
Parameters:
+ + +
indexis the zero based index of the file which name should be returned. The index must be less than the amount getFileCount() returns.
+
+
+
Returns:
File name of the file. Returns 0 if an error occured.
+ +
+
+ +
+
+ + + + + + + + +
virtual u32 irr::io::IFileList::getID (u32 index) const [pure virtual]
+
+
+ +

Returns the ID of a file in the file list, based on an index.

+

This optional ID can be used to link the file list entry to information held elsewhere. For example this could be an index in an IFileArchive, linking the entry to its data offset, uncompressed size and CRC.

+
Parameters:
+ + +
indexis the zero based index of the file which should be returned. The index must be less than the amount getFileCount() returns.
+
+
+
Returns:
The ID of the file.
+ +
+
+ +
+
+ + + + + + + +
virtual const io::path& irr::io::IFileList::getPath () const [pure virtual]
+
+
+ +

Returns the base path of the file list.

+ +
+
+ +
+
+ + + + + + + + +
virtual bool irr::io::IFileList::isDirectory (u32 index) const [pure virtual]
+
+
+ +

Check if the file is a directory.

+
Parameters:
+ + +
indexThe zero based index which will be checked. The index must be less than the amount getFileCount() returns.
+
+
+
Returns:
True if the file is a directory, else false.
+ +
+
+ +
+
+ + + + + + + +
virtual void irr::io::IFileList::sort () [pure virtual]
+
+
+ +

Sorts the file list. You should call this after adding any items to the file list.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + + -- cgit v1.1