wx.FileSys.IOStreamFSHandler Class Reference

Inheritance diagram for wx.FileSys.IOStreamFSHandler:

List of all members.

Public Member Functions
override bool	CanOpen (string location)
override string	FindFirst (string wildcard, KindOfFile kindOfFile)
override string	FindNext ()
string	GetFirstFilename (string location)
string	GetSecondFilename (string location)
	IOStreamFSHandler ()
override FSFile	OpenFile (FileSystem fs, string location)
Protected Member Functions
override void	Dispose (bool disposing)

---

Detailed Description

Class of wxWidgets file system handlers that are implemented by a System.IO.Stream. Generate an instance of this class and install this (call FileSystemHandler.AddHandler) to provide the ability to deal with the following protocols:

• file:file</c> and dotnetfile:file implemented by a FileStream.
• rs:file or rs:assembly.filename//file tries to find the provided file name in the manifest and returns (if possible) a stream over the data of a resource file. Source assembly assembly.filename will be loaded by Assembly.LoadFile(). If the source assembly is omitted, this will refer to the entry assembly. You may also use the long protocol name resource:file.
• zrs:archivefile//resourcefile loads resource resourcefile from the ZRS archive archivefile (refer to class ZipResource). Long protocol name zipresource:archivefile//resourcefile also works.

>

---

Constructor & Destructor Documentation

wx.FileSys.IOStreamFSHandler.IOStreamFSHandler

(

)

Creates a file system handler providing the ability to deal with the following protocols:

• file:file</c> and dotnetfile:file implemented by a FileStream.
• rs:file or rs:assembly.filename//file tries to find the provided file name in the manifest and returns (if possible) a stream over the data of a resource file. Source assembly assembly.filename will be loaded by Assembly.LoadFile(). If the source assembly is omitted, this will refer to the entry assembly. You may also use the long protocol name resource:file.
• zrs:archivefile//resourcefile loads resource resourcefile from the ZRS archive archivefile (refer to class ZipResource). Long protocol name zipresource:archivefile//resourcefile also works.

>

---

Member Function Documentation

override bool wx.FileSys.IOStreamFSHandler.CanOpen

(

string

location

)

[virtual]

The handler identifies himself with result true to be appropriate to deal with a file at the provided location.

Reimplemented from wx.FileSys.FileSystemHandler.

override void wx.FileSys.IOStreamFSHandler.Dispose

(

bool

disposing

)

[protected, virtual]

Reimplemented from wx.Object.

override string wx.FileSys.IOStreamFSHandler.FindFirst	(	string	wildcard,
		KindOfFile	kindOfFile
	)			[virtual]

Returns the first matching filename or an empty string if nothing matches. This will only be called if the wildcard can be opened (CanOpen()).

Reimplemented from wx.FileSys.FileSystemHandler.

override string wx.FileSys.IOStreamFSHandler.FindNext

(

)

[virtual]

Returns the next filename matching with the constraints of the previous FindFirst() or an empty string if nothing matches.

Reimplemented from wx.FileSys.FileSystemHandler.

string wx.FileSys.IOStreamFSHandler.GetFirstFilename

(

string

location

)

Returns the primary file. First and second file names complete standard wxWidgets elements of file system names (protocol, left location, right location, anchor). Both filenames are subelements of the right location spanning over the filename right from the protocol and left from the (optional) anchor. If this filename contains a double slash (//), the filename left from this separator is called first filename and the filename on the right is called second filename. The first name is optional (i.e. is empty if the whole file name is without a double slash).

string wx.FileSys.IOStreamFSHandler.GetSecondFilename

(

string

location

)

override FSFile wx.FileSys.IOStreamFSHandler.OpenFile	(	FileSystem	fs,
		string	location
	)			[virtual]

Returns an instance of FSFile that provides a stream over the data as denoted by location.

Parameters:

	location	absolute location of the desired data.
	fs	is the parent file system. The manual 2.6.3. refers to wxZipFSHandler as a reference for using this parameter but this class in the meanwhile explicitely refers to a freshly created file system to avoid infinite recursions (as the remark says). I found out that this parameter contains the path.

Implements wx.FileSys.FileSystemHandler.

---