Add wxTIFFHandler documentation, and start of wxGIFHandler's documentation.
This commit is contained in:
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);
|
||||
};
|
||||
|
Reference in New Issue
Block a user