wx.Archive.ArchiveInput Class Reference

Inheritance diagram for wx.Archive.ArchiveInput:

List of all members.

Public Member Functions
	ArchiveInput (Uri fileUri, ArchiveEntry.ArchiveType type)
	ArchiveInput (Uri fileUri)
	ArchiveInput (wxString filename, ArchiveEntry.ArchiveType type)
	ArchiveInput (string filename, ArchiveEntry.ArchiveType type)
	ArchiveInput (string filename)
	ArchiveInput (Stream inputStream)
	ArchiveInput (Stream inputStream, ArchiveEntry.ArchiveType type)
void	Close ()
override void	Dispose ()
string	GetInternalName (string localFilename)
ArchiveEntry	GetNextEntry ()
bool	OpenEntry (ArchiveEntry entry)
Properties
Stream	In [get]
bool	IsOk [get]
ArchiveEntry.ArchiveType	Type [get]
Classes
class	ZipInStream

---

Detailed Description

Reading from an archive file type supported by wxWidgets. wxWidgets supports reading, analyzing, and writing archive files. Currently only ZIP archives are supported. Corresponding features are only partially supported by the standard .NET framework since 2.0.

The interface of this class differs strongly from the wxWidgets API since this API shall be extendable to use standard .NET framework classes where possible.

---

Constructor & Destructor Documentation

wx.Archive.ArchiveInput.ArchiveInput	(	Stream	inputStream,
		ArchiveEntry.ArchiveType	type
	)

Generate an instance reading compressed data from the provided stream.

wx.Archive.ArchiveInput.ArchiveInput

(

Stream

inputStream

)

Generate an instance reading compressed data from the provided stream. By default this will interpret the data as a ZIP archive.

wx.Archive.ArchiveInput.ArchiveInput

(

string

filename

)

wx.Archive.ArchiveInput.ArchiveInput	(	string	filename,
		ArchiveEntry.ArchiveType	type
	)

wx.Archive.ArchiveInput.ArchiveInput	(	wxString	filename,
		ArchiveEntry.ArchiveType	type
	)

wx.Archive.ArchiveInput.ArchiveInput

(

Uri

fileUri

)

This consumes an URI pointing at a local file. Raises currently an ArgumentException if the argument is not a local file name.

wx.Archive.ArchiveInput.ArchiveInput	(	Uri	fileUri,
		ArchiveEntry.ArchiveType	type
	)

This consumes an URI pointing at a local file. Raises currently an ArgumentException if the argument is not a local file name.

---

Member Function Documentation

void wx.Archive.ArchiveInput.Close

(

)

This closes In() if we have an open entry.

override void wx.Archive.ArchiveInput.Dispose

(

)

[virtual]

Reimplemented from wx.Object.

string wx.Archive.ArchiveInput.GetInternalName

(

string

localFilename

)

Returns the internal representation of localFilename in the current type of archive. Note, that instances of this class may wrap archives of different type, so the internal representation depends on the archive type.

ArchiveEntry wx.Archive.ArchiveInput.GetNextEntry

(

)

* Closes the current entry if one is open, then reads the meta-data for the next entry and returns it in a wxArchiveEntry object, giving away ownership. Reading this wx.ArchiveInput.In then returns the entry's data.

bool wx.Archive.ArchiveInput.OpenEntry

(

ArchiveEntry

entry

)

* Closes the current entry if one is open, then opens the entry specified by the wxArchiveEntry object.

entry must be from the same archive file that this wx.ArchiveInput is reading, and it must be reading it from a seekable stream.

Looking up an archive entry by name

---

Property Documentation

Stream wx.Archive.ArchiveInput.In [get]

This is the stream to read the current entry from. This is null if all entries are closed (none has been opened).

bool wx.Archive.ArchiveInput.IsOk [get]

ArchiveEntry.ArchiveType wx.Archive.ArchiveInput.Type [get]

---