Document remaining image handlers

This commit is contained in:
Samuel Dunn
2017-06-24 11:00:56 -07:00
parent 2fd999f81e
commit cd203ca2fd
6 changed files with 199 additions and 0 deletions

31
interface/wx/imagiff.h Normal file
View File

@@ -0,0 +1,31 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagiff.h
// Purpose: interface of wxIFFHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/**
@class wxIFFHandler
This is the image handler for the IFF format.
@library{core}
@category{gdi}
@see wxImage, wxImageHandler, wxInitAllImageHandlers()
*/
class wxIFFHandler : public wxImageHandler
{
public:
/**
Default constructor for wxIFFHandler
*/
wxIFFHandler();
virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1);
virtual bool SaveFile(wxImage *image, wxOutputStream& stream, bool verbose=true);
protected:
virtual bool DoCanRead(wxInputStream& stream);
};

40
interface/wx/imagjpeg.h Normal file
View File

@@ -0,0 +1,40 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagjpeg.h
// Purpose: interface of wxJPEGHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/**
@class wxJPEGHandler
This is the image handler for the JPEG format.
@library{core}
@category{gdi}
@see wxImage, wxImageHandler, wxInitAllImageHandlers()
*/
class wxJPEGHandler : public wxImageHandler
{
public:
/**
Default constructor for wxJPEGHandler
*/
wxJPEGHandler();
/**
Retrieve the version information about the JPEG library used by this
handler.
@since 2.9.2
*/
static wxVersionInfo GetLibraryVersionInfo();
// allow the parent class's documentation through.
virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1);
virtual bool SaveFile(wxImage *image, wxOutputStream& stream, bool verbose=true);
protected:
virtual bool DoCanRead(wxInputStream& stream);
};

32
interface/wx/imagpcx.h Normal file
View File

@@ -0,0 +1,32 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagpcx.h
// Purpose: interface of wxPCXHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/**
@class wxPCXHandler
This is the image handler for the PCX format.
@library{core}
@category{gdi}
@see wxImage, wxImageHandler, wxInitAllImageHandlers()
*/
class wxPCXHandler : public wxImageHandler
{
public:
/**
Default constructor for wxPCXHandler
*/
wxPCXHandler();
// allow the parent class's documentation through.
virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1);
virtual bool SaveFile(wxImage *image, wxOutputStream& stream, bool verbose=true);
protected:
virtual bool DoCanRead(wxInputStream& stream);
};

32
interface/wx/imagpnm.h Normal file
View File

@@ -0,0 +1,32 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagpnm.h
// Purpose: interface of wxPNMHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/**
@class wxPNMHandler
This is the image handler for the PNM format.
@library{core}
@category{gdi}
@see wxImage, wxImageHandler, wxInitAllImageHandlers()
*/
class wxPNMHandler : public wxImageHandler
{
public:
/**
Default constructor for wxPNMHandler
*/
wxPNMHandler();
// allow the parent class's documentation through.
virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1);
virtual bool SaveFile(wxImage *image, wxOutputStream& stream, bool verbose=true);
protected:
virtual bool DoCanRead(wxInputStream& stream);
};

32
interface/wx/imagtga.h Normal file
View File

@@ -0,0 +1,32 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagtga.h
// Purpose: interface of wxTGAHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/**
@class wxTGAHandler
This is the image handler for the TGA format.
@library{core}
@category{gdi}
@see wxImage, wxImageHandler, wxInitAllImageHandlers()
*/
class wxTGAHandler : public wxImageHandler
{
public:
/**
Default constructor for wxTGAHandler
*/
wxTGAHandler();
// allow the parent class's documentation through.
virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1);
virtual bool SaveFile(wxImage *image, wxOutputStream& stream, bool verbose=true);
protected:
virtual bool DoCanRead(wxInputStream& stream);
};

32
interface/wx/imagxpm.h Normal file
View File

@@ -0,0 +1,32 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagxpm.h
// Purpose: interface of wxXPMHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/**
@class wxXPMHandler
This is the image handler for the XPM format.
@library{core}
@category{gdi}
@see wxImage, wxImageHandler, wxInitAllImageHandlers()
*/
class wxXPMHandler : public wxImageHandler
{
public:
/**
Default constructor for wxXPMHandler
*/
wxXPMHandler();
// allow the parent class's documentation through.
virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1);
virtual bool SaveFile(wxImage *image, wxOutputStream& stream, bool verbose=true);
protected:
virtual bool DoCanRead(wxInputStream& stream);
};