compatibility changes: WXWIN_COMPATIBILITY_EVENT_TYPES and DECLARE_EVENT_TABLE_ENTRY...

[wxWidgets.git] / include / wx / gifdecod.h

diff --git a/include/wx/gifdecod.h b/include/wx/gifdecod.h
index 09a8927f9959d9482b726be0221f61bff045371e..769169fd4c2f5e6599a650ff52fddda659b3eb9e 100644 (file)
--- a/include/wx/gifdecod.h
+++ b/include/wx/gifdecod.h
@@ -24,10 +24,26 @@
 
 
 // --------------------------------------------------------------------------
-// constants
+// Constants
 // --------------------------------------------------------------------------
 
-// disposal method
+// Error codes:
+//  Note that the error code wxGIF_TRUNCATED means that the image itself
+//  is most probably OK, but the decoder didn't reach the end of the data
+//  stream; this means that if it was not reading directly from file,
+//  the stream will not be correctly positioned. the
+//
+enum
+{
+    wxGIF_OK = 0,                   /* everything was OK */
+    wxGIF_INVFORMAT,                /* error in gif header */
+    wxGIF_MEMERR,                   /* error allocating memory */
+    wxGIF_TRUNCATED                 /* file appears to be truncated */
+};
+
+// Disposal method
+//  Experimental; subject to change.
+//
 enum
 {
     wxGIF_D_UNSPECIFIED = -1,       /* not specified */
@@ -36,13 +52,6 @@ enum
     wxGIF_D_TOPREVIOUS = 2          /* restore to previous image */
 };
 
-// error codes
-enum
-{
-    wxGIF_OK = 0,                   /* everything was OK */
-    wxGIF_INVFORMAT = 1,            /* error in gif header */
-    wxGIF_MEMERR = 2                /* error allocating memory */
-};
 
 #define MAX_BLOCK_SIZE 256          /* max. block size */