From e2e5000c329fb4a4882f4808b3eb2db1a64176b9 Mon Sep 17 00:00:00 2001
From: Samuel Dunn <samuel@mesalu.com>
Date: Thu, 22 Jun 2017 21:00:25 -0700
Subject: [PATCH] Add wxTIFFHandler documentation, and start of wxGIFHandler's
 documentation.

---
 interface/wx/imaggif.h  | 55 +++++++++++++++++++++++++++++++++++++++++
 interface/wx/imagtiff.h | 50 +++++++++++++++++++++++++++++++++++++
 2 files changed, 105 insertions(+)
 create mode 100644 interface/wx/imaggif.h
 create mode 100644 interface/wx/imagtiff.h

diff --git a/interface/wx/imaggif.h b/interface/wx/imaggif.h
new file mode 100644
index 0000000000..c23c218d5b
--- /dev/null
+++ b/interface/wx/imaggif.h
@@ -0,0 +1,55 @@
+///////////////////////////////////////////////////////////////////////////// 
+// Name:        imaggif.h 
+// Purpose:     interface of wxGIFHandler 
+// Author:      Samuel Dunn 
+// Licence:     wxWindows licence 
+//////////////////////////////////////////////////////////////////////////// 
+
+#define wxIMAGE_OPTION_GIF_COMMENT wxT("GifComment")
+
+/**
+    @class wxGIFHandler
+
+    This is the image handler for the GIF format.
+
+    @library{core}
+    @category{gdi}
+
+    @see wxImage, wxImageHandler, wxInitAllImageHandlers()
+*/
+class wxGIFHandler : public wxImageHandler
+{
+public:
+    /**
+    Default constructor for wxGIFHandler
+    */
+    wxGIFHandler();
+
+    virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose = true, 
+                            int index = -1);
+    virtual bool SaveFile(wxImage *image, wxOutputStream& stream, bool verbose=true);
+
+    /**
+        Save the animated gif.
+        
+        @param images
+            The image array object which is to be affected by this operation.
+        @param stream
+            Opened output stream for writing the data.
+        @param verbose
+            If set to @true, errors reported by the image handler will produce wxLogMessages
+
+        @return @true if the operation was successful, @false otherwise
+    */
+    bool SaveAnimation(const wxImageArray& images, wxOutputStream *stream,
+                        bool verbose = true, int delayMilliSecs = 1000);
+
+protected:
+    virtual int DoGetImageCount(wxInputStream& stream);
+    virtual bool DoCanRead(wxInputStream& stream);
+
+    bool DoSaveFile(const wxImage&, wxOutputStream *, bool verbose,
+        bool first, int delayMilliSecs, bool loop,
+        const wxRGB *pal, int palCount,
+        int mask_index);
+};
\ No newline at end of file
diff --git a/interface/wx/imagtiff.h b/interface/wx/imagtiff.h
new file mode 100644
index 0000000000..409249dc4f
--- /dev/null
+++ b/interface/wx/imagtiff.h
@@ -0,0 +1,50 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        imagtiff.h
+// Purpose:     interface of wxTIFFHandler
+// Author:      Samuel Dunn
+// Licence:     wxWindows licence
+////////////////////////////////////////////////////////////////////////////
+
+#define wxIMAGE_OPTION_TIFF_BITSPERSAMPLE           wxString("BitsPerSample")
+#define wxIMAGE_OPTION_TIFF_SAMPLESPERPIXEL         wxString("SamplesPerPixel")
+#define wxIMAGE_OPTION_TIFF_COMPRESSION             wxString("Compression")
+#define wxIMAGE_OPTION_TIFF_PHOTOMETRIC             wxString("Photometric")
+#define wxIMAGE_OPTION_TIFF_IMAGEDESCRIPTOR         wxString("ImageDescriptor")
+
+
+// todo: confirm library and category, and generate some real body documentation
+/**
+    @class wxTIFFHandler
+    
+    This is the image handler for the TIFF format.
+    
+    @library{wxcore}
+    @category{gdi}
+    
+    @see wxImage, wxImageHandler, wxInitAllImageHandlers()
+*/
+class wxTIFFHandler : public wxImageHandler
+{
+public:
+    /**
+    Default constructor for wxTIFFHandler
+    */
+    wxTIFFHandler();
+    
+    /**
+        Retrieve the version information about the TIFF library used by this
+        handler.
+
+        @since 2.9.2
+    */
+    static wxVersionInfo GetLibraryVersionInfo();
+    
+    // let the parent class' (wxImageHandler) documentation through for these methods
+    virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1);
+    
+protected:
+    virtual bool SaveFile(wxImage *image, wxOutputStream& stream, bool verbose=true);
+    virtual int DoGetImageCount(wxInputStream& stream);
+    virutal bool DoCanRead(wxInputStream& stream);
+};
+