From cd203ca2fd5b1ffbdaa381726fbd85b8f60dd71a Mon Sep 17 00:00:00 2001 From: Samuel Dunn Date: Sat, 24 Jun 2017 11:00:56 -0700 Subject: [PATCH] Document remaining image handlers --- interface/wx/imagiff.h | 31 +++++++++++++++++++++++++++++++ interface/wx/imagjpeg.h | 40 ++++++++++++++++++++++++++++++++++++++++ interface/wx/imagpcx.h | 32 ++++++++++++++++++++++++++++++++ interface/wx/imagpnm.h | 32 ++++++++++++++++++++++++++++++++ interface/wx/imagtga.h | 32 ++++++++++++++++++++++++++++++++ interface/wx/imagxpm.h | 32 ++++++++++++++++++++++++++++++++ 6 files changed, 199 insertions(+) create mode 100644 interface/wx/imagiff.h create mode 100644 interface/wx/imagjpeg.h create mode 100644 interface/wx/imagpcx.h create mode 100644 interface/wx/imagpnm.h create mode 100644 interface/wx/imagtga.h create mode 100644 interface/wx/imagxpm.h diff --git a/interface/wx/imagiff.h b/interface/wx/imagiff.h new file mode 100644 index 0000000000..c96b5649a1 --- /dev/null +++ b/interface/wx/imagiff.h @@ -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); +}; \ No newline at end of file diff --git a/interface/wx/imagjpeg.h b/interface/wx/imagjpeg.h new file mode 100644 index 0000000000..0d727e4b7e --- /dev/null +++ b/interface/wx/imagjpeg.h @@ -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); +}; \ No newline at end of file diff --git a/interface/wx/imagpcx.h b/interface/wx/imagpcx.h new file mode 100644 index 0000000000..ebd1736742 --- /dev/null +++ b/interface/wx/imagpcx.h @@ -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); +}; \ No newline at end of file diff --git a/interface/wx/imagpnm.h b/interface/wx/imagpnm.h new file mode 100644 index 0000000000..8c28a87efd --- /dev/null +++ b/interface/wx/imagpnm.h @@ -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); +}; \ No newline at end of file diff --git a/interface/wx/imagtga.h b/interface/wx/imagtga.h new file mode 100644 index 0000000000..cef1392532 --- /dev/null +++ b/interface/wx/imagtga.h @@ -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); +}; \ No newline at end of file diff --git a/interface/wx/imagxpm.h b/interface/wx/imagxpm.h new file mode 100644 index 0000000000..03e6b5fc3c --- /dev/null +++ b/interface/wx/imagxpm.h @@ -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); +}; \ No newline at end of file