Add wxTIFFHandler documentation, and start of wxGIFHandler's documentation.
This commit is contained in:
parent
9b9f8ac468
commit
e2e5000c32
55
interface/wx/imaggif.h
Normal file
55
interface/wx/imaggif.h
Normal file
@ -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);
|
||||
};
|
50
interface/wx/imagtiff.h
Normal file
50
interface/wx/imagtiff.h
Normal file
@ -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);
|
||||
};
|
||||
|
Loading…
Reference in New Issue
Block a user