wxFSInputStream Class Reference

#include <wx/filesys.h>

Inheritance diagram for wxFSInputStream:

Detailed Description

Input stream for virtual file stream files.

The stream reads data from wxFSFile obtained from wxFileSystem. It is especially useful to allow using virtual files with other wxWidgets functions and classes working with streams, e.g. for loading images or animations from virtual files and not only physical ones.

Library:  wxBase

Category:  Streams

See Also

wxWrapperInputStream, wxFSFile

Since

2.9.4

Public Member Functions
	wxFileInputStream (const wxString &filename, int flags=0)
	Create a stream associated with the data of the given virtual file system file.
bool	IsOk () const
	Returns true if the stream is initialized and ready.
Public Member Functions inherited from wxWrapperInputStream
	wxWrapperInputStream (wxInputStream &stream)
	Initializes a wrapper stream.
	wxWrapperInputStream (wxInputStream *stream)
	Initializes a wrapper stream.
Public Member Functions inherited from wxFilterInputStream
	wxFilterInputStream (wxInputStream &stream)
	Initializes a "filter" stream.
	wxFilterInputStream (wxInputStream *stream)
	Initializes a "filter" stream.
Public Member Functions inherited from wxInputStream
	wxInputStream ()
	Creates a dummy input stream.
virtual	~wxInputStream ()
	Destructor.
virtual bool	CanRead () const
	Returns true if some data is available in the stream right now, so that calling Read() wouldn't block.
virtual bool	Eof () const
	Returns true after an attempt has been made to read past the end of the stream.
int	GetC ()
	Returns the first character in the input queue and removes it, blocking until it appears if necessary.
virtual size_t	LastRead () const
	Returns the last number of bytes read.
virtual char	Peek ()
	Returns the first character in the input queue without removing it.
virtual wxInputStream &	Read (void *buffer, size_t size)
	Reads the specified amount of bytes and stores the data in buffer.
wxInputStream &	Read (wxOutputStream &stream_out)
	Reads data from the input queue and stores it in the specified output stream.
bool	ReadAll (void *buffer, size_t size)
	Reads exactly the specified number of bytes into the buffer.
virtual wxFileOffset	SeekI (wxFileOffset pos, wxSeekMode mode=wxFromStart)
	Changes the stream current position.
virtual wxFileOffset	TellI () const
	Returns the current stream position or wxInvalidOffset if it's not available (e.g.
size_t	Ungetch (const void *buffer, size_t size)
	This function is only useful in read mode.
bool	Ungetch (char c)
	This function acts like the previous one except that it takes only one character: it is sometimes shorter to use than the generic function.
Public Member Functions inherited from wxStreamBase
	wxStreamBase ()
	Creates a dummy stream object.
virtual	~wxStreamBase ()
	Destructor.
wxStreamError	GetLastError () const
	This function returns the last error.
virtual wxFileOffset	GetLength () const
	Returns the length of the stream in bytes.
virtual size_t	GetSize () const
	This function returns the size of the stream.
virtual bool	IsSeekable () const
	Returns true if the stream supports seeking to arbitrary offsets.
void	Reset (wxStreamError error=wxSTREAM_NO_ERROR)
	Resets the stream state.
bool	operator! () const
	Returns the opposite of IsOk().

Additional Inherited Members
Protected Member Functions inherited from wxWrapperInputStream
	wxWrapperInputStream ()
	Default constructor, use InitParentStream() to finish initialization.
void	InitParentStream (wxInputStream &stream)
	Set up the wrapped stream for an object initialized using the default constructor.
void	InitParentStream (wxInputStream *stream)
	Set up the wrapped stream for an object initialized using the default constructor.

Member Function Documentation

bool wxFSInputStream::IsOk ( ) const

virtual

Returns true if the stream is initialized and ready.

Reimplemented from wxStreamBase.

wxFSInputStream::wxFileInputStream	(	const wxString &	filename,
		int	flags = 0
	)

Create a stream associated with the data of the given virtual file system file.

Parameters

filename	The name of the input file passed to wxFileSystem::OpenFile().
flags	Combination of flags from wxFileSystemOpenFlags. wxFS_READ is implied, i.e. it is always added to the flags value.

Use wxStreamBase::IsOk() to verify if the constructor succeeded.