#include <OgreArchive.h>
Public Member Functions | |
| Archive (const String &name, const String &archType) | |
| Constructor - don't call direct, used by ArchiveFactory. | |
| virtual | ~Archive () |
| Default destructor. | |
| const String & | getName (void) const |
| Get the name of this archive. | |
| virtual bool | isCaseSensitive (void) const =0 |
| Returns whether this archive is case sensitive in the way it matches files. | |
| virtual void | load ()=0 |
| Loads the archive. | |
| virtual void | unload ()=0 |
| Unloads the archive. | |
| virtual DataStreamPtr | open (const String &filename) const =0 |
| Open a stream on a given file. | |
| virtual StringVectorPtr | list (bool recursive=true, bool dirs=false)=0 |
| List all file names in the archive. | |
| virtual FileInfoListPtr | listFileInfo (bool recursive=true, bool dirs=false)=0 |
| List all files in the archive with accompanying information. | |
| virtual StringVectorPtr | find (const String &pattern, bool recursive=true, bool dirs=false)=0 |
| Find all file or directory names matching a given pattern in this archive. | |
| virtual bool | exists (const String &filename)=0 |
| Find out if the named file exists (note: fully qualified filename required). | |
| virtual FileInfoListPtr | findFileInfo (const String &pattern, bool recursive=true, bool dirs=false)=0 |
| Find all files or directories matching a given pattern in this archive and get some detailed information about them. | |
| const String & | getType (void) const |
| Return the type code of this Archive. | |
Protected Attributes | |
| String | mName |
| Archive name. | |
| String | mType |
| Archive type code. | |
Definition at line 80 of file OgreArchive.h.
Constructor - don't call direct, used by ArchiveFactory.
Definition at line 92 of file OgreArchive.h.
| virtual Ogre::Archive::~Archive | ( | ) | [virtual] |
| const String& Ogre::Archive::getName | ( | void | ) | const |
| virtual bool Ogre::Archive::isCaseSensitive | ( | void | ) | const [pure virtual] |
Returns whether this archive is case sensitive in the way it matches files.
Implemented in Ogre::FileSystemArchive, and Ogre::ZipArchive.
| virtual void Ogre::Archive::load | ( | ) | [pure virtual] |
Loads the archive.
Implemented in Ogre::FileSystemArchive, and Ogre::ZipArchive.
| virtual void Ogre::Archive::unload | ( | ) | [pure virtual] |
Unloads the archive.
Implemented in Ogre::FileSystemArchive, and Ogre::ZipArchive.
| virtual DataStreamPtr Ogre::Archive::open | ( | const String & | filename | ) | const [pure virtual] |
Open a stream on a given file.
| filename | The fully qualified name of the file |
Implemented in Ogre::FileSystemArchive, and Ogre::ZipArchive.
| virtual StringVectorPtr Ogre::Archive::list | ( | bool | recursive = true, |
|
| bool | dirs = false | |||
| ) | [pure virtual] |
List all file names in the archive.
| recursive | Whether all paths of the archive are searched (if the archive has a concept of that) | |
| dirs | Set to true if you want the directories to be listed instead of files |
Implemented in Ogre::FileSystemArchive, and Ogre::ZipArchive.
| virtual FileInfoListPtr Ogre::Archive::listFileInfo | ( | bool | recursive = true, |
|
| bool | dirs = false | |||
| ) | [pure virtual] |
List all files in the archive with accompanying information.
| recursive | Whether all paths of the archive are searched (if the archive has a concept of that) | |
| dirs | Set to true if you want the directories to be listed instead of files |
Implemented in Ogre::FileSystemArchive, and Ogre::ZipArchive.
| virtual StringVectorPtr Ogre::Archive::find | ( | const String & | pattern, | |
| bool | recursive = true, |
|||
| bool | dirs = false | |||
| ) | [pure virtual] |
Find all file or directory names matching a given pattern in this archive.
| pattern | The pattern to search for; wildcards (*) are allowed | |
| recursive | Whether all paths of the archive are searched (if the archive has a concept of that) | |
| dirs | Set to true if you want the directories to be listed instead of files |
Implemented in Ogre::FileSystemArchive, and Ogre::ZipArchive.
| virtual bool Ogre::Archive::exists | ( | const String & | filename | ) | [pure virtual] |
Find out if the named file exists (note: fully qualified filename required).
Implemented in Ogre::FileSystemArchive, and Ogre::ZipArchive.
| virtual FileInfoListPtr Ogre::Archive::findFileInfo | ( | const String & | pattern, | |
| bool | recursive = true, |
|||
| bool | dirs = false | |||
| ) | [pure virtual] |
Find all files or directories matching a given pattern in this archive and get some detailed information about them.
| pattern | The pattern to search for; wildcards (*) are allowed | |
| recursive | Whether all paths of the archive are searched (if the archive has a concept of that) | |
| dirs | Set to true if you want the directories to be listed instead of files |
Implemented in Ogre::FileSystemArchive, and Ogre::ZipArchive.
| const String& Ogre::Archive::getType | ( | void | ) | const |
String Ogre::Archive::mName [protected] |
String Ogre::Archive::mType [protected] |
Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:49:08 2008