Version: 3.0.4
wxFilterClassFactory Class Referenceabstract

#include <wx/stream.h>

+ Inheritance diagram for wxFilterClassFactory:

Detailed Description

Allows the creation of filter streams to handle compression formats such as gzip and bzip2.

For example, given a filename you can search for a factory that will handle it and create a stream to decompress it:

if (factory)
stream = factory->NewStream(new wxFFileInputStream(filename));

wxFilterClassFactory::Find can also search for a factory by MIME type, HTTP encoding or by wxFileSystem protocol. The available factories can be enumerated using wxFilterClassFactory::GetFirst() and wxFilterClassFactory::GetNext().

Library:  wxBase
Category:  Streams
See also
wxFilterInputStream, wxFilterOutputStream, wxArchiveClassFactory, Archive Formats
const wxFilterClassFactoryGetNext () const
 GetFirst and GetNext can be used to enumerate the available factories. More...
 
static const wxFilterClassFactoryGetFirst ()
 GetFirst and GetNext can be used to enumerate the available factories. More...
 

Public Member Functions

bool CanHandle (const wxString &protocol, wxStreamProtocolType type=wxSTREAM_PROTOCOL) const
 Returns true if this factory can handle the given protocol, MIME type, HTTP encoding or file extension. More...
 
wxString GetProtocol () const
 Returns the wxFileSystem protocol supported by this factory. More...
 
virtual const wxChar *const * GetProtocols (wxStreamProtocolType type=wxSTREAM_PROTOCOL) const =0
 Returns the protocols, MIME types, HTTP encodings or file extensions supported by this factory, as an array of null terminated strings. More...
 
wxString PopExtension (const wxString &location) const
 Remove the file extension of location if it is one of the file extensions handled by this factory. More...
 
void PushFront ()
 Adds this class factory to the list returned by GetFirst()/GetNext(). More...
 
void Remove ()
 Removes this class factory from the list returned by GetFirst()/GetNext(). More...
 
virtual wxFilterInputStreamNewStream (wxInputStream &stream) const =0
 Create a new input or output stream to decompress or compress a given stream. More...
 
virtual wxFilterOutputStreamNewStream (wxOutputStream &stream) const =0
 Create a new input or output stream to decompress or compress a given stream. More...
 
virtual wxFilterInputStreamNewStream (wxInputStream *stream) const =0
 Create a new input or output stream to decompress or compress a given stream. More...
 
virtual wxFilterOutputStreamNewStream (wxOutputStream *stream) const =0
 Create a new input or output stream to decompress or compress a given stream. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Static Public Member Functions

static const wxFilterClassFactoryFind (const wxString &protocol, wxStreamProtocolType type=wxSTREAM_PROTOCOL)
 A static member that finds a factory that can handle a given protocol, MIME type, HTTP encoding or file extension. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Member Function Documentation

bool wxFilterClassFactory::CanHandle ( const wxString protocol,
wxStreamProtocolType  type = wxSTREAM_PROTOCOL 
) const

Returns true if this factory can handle the given protocol, MIME type, HTTP encoding or file extension.

When using wxSTREAM_FILEEXT for the second parameter, the first parameter can be a complete filename rather than just an extension.

static const wxFilterClassFactory* wxFilterClassFactory::Find ( const wxString protocol,
wxStreamProtocolType  type = wxSTREAM_PROTOCOL 
)
static

A static member that finds a factory that can handle a given protocol, MIME type, HTTP encoding or file extension.

Returns a pointer to the class factory if found, or NULL otherwise. It does not give away ownership of the factory.

When using wxSTREAM_FILEEXT for the second parameter, the first parameter can be a complete filename rather than just an extension.

static const wxFilterClassFactory* wxFilterClassFactory::GetFirst ( )
static

GetFirst and GetNext can be used to enumerate the available factories.

For example, to list them:

wxString list;
while (factory) {
list << factory->GetProtocol() << wxT("\n");
factory = factory->GetNext();
}

GetFirst()/GetNext() return a pointer to a factory or NULL if no more are available. They do not give away ownership of the factory.

const wxFilterClassFactory* wxFilterClassFactory::GetNext ( ) const

GetFirst and GetNext can be used to enumerate the available factories.

For example, to list them:

wxString list;
while (factory) {
list << factory->GetProtocol() << wxT("\n");
factory = factory->GetNext();
}

GetFirst()/GetNext() return a pointer to a factory or NULL if no more are available. They do not give away ownership of the factory.

wxString wxFilterClassFactory::GetProtocol ( ) const

Returns the wxFileSystem protocol supported by this factory.

Equivalent to

.

virtual const wxChar* const* wxFilterClassFactory::GetProtocols ( wxStreamProtocolType  type = wxSTREAM_PROTOCOL) const
pure virtual

Returns the protocols, MIME types, HTTP encodings or file extensions supported by this factory, as an array of null terminated strings.

It does not give away ownership of the array or strings.

For example, to list the file extensions a factory supports:

wxString list;
const wxChar *const *p;
for (p = factory->GetProtocols(wxSTREAM_FILEEXT); *p; p++)
list << *p << wxT("\n");
virtual wxFilterInputStream* wxFilterClassFactory::NewStream ( wxInputStream stream) const
pure virtual

Create a new input or output stream to decompress or compress a given stream.

If the parent stream is passed as a pointer then the new filter stream takes ownership of it. If it is passed by reference then it does not.

virtual wxFilterOutputStream* wxFilterClassFactory::NewStream ( wxOutputStream stream) const
pure virtual

Create a new input or output stream to decompress or compress a given stream.

If the parent stream is passed as a pointer then the new filter stream takes ownership of it. If it is passed by reference then it does not.

virtual wxFilterInputStream* wxFilterClassFactory::NewStream ( wxInputStream stream) const
pure virtual

Create a new input or output stream to decompress or compress a given stream.

If the parent stream is passed as a pointer then the new filter stream takes ownership of it. If it is passed by reference then it does not.

virtual wxFilterOutputStream* wxFilterClassFactory::NewStream ( wxOutputStream stream) const
pure virtual

Create a new input or output stream to decompress or compress a given stream.

If the parent stream is passed as a pointer then the new filter stream takes ownership of it. If it is passed by reference then it does not.

wxString wxFilterClassFactory::PopExtension ( const wxString location) const

Remove the file extension of location if it is one of the file extensions handled by this factory.

void wxFilterClassFactory::PushFront ( )

Adds this class factory to the list returned by GetFirst()/GetNext().

It is not necessary to do this to use the filter streams. It is usually used when implementing streams, typically the implementation will add a static instance of its factory class.

It can also be used to change the order of a factory already in the list, bringing it to the front. This isn't a thread safe operation so can't be done when other threads are running that will be using the list.

The list does not take ownership of the factory.

void wxFilterClassFactory::Remove ( )

Removes this class factory from the list returned by GetFirst()/GetNext().

Removing from the list isn't a thread safe operation so can't be done when other threads are running that will be using the list.

The list does not own the factories, so removing a factory does not delete it.