Moved docs for fail() from prototype in Fl_Image.H -> implementation in Fl_Image.cxx.

Also added coded example to assist app programmers in usage. (Matt: feel free to modify
the example code as needed)



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10734 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Greg Ercolano 2015-05-24 18:19:24 +00:00
parent 9632e422d3
commit 42b4db0801
2 changed files with 26 additions and 7 deletions

View File

@ -129,13 +129,6 @@ public:
Use the count() method to find the size of the data array.
*/
const char * const *data() const {return data_;}
/**
Returns a value that is not 0 if there is currently no image
available.
\return ERR_NO_IMAGE if no image was found
\return ERR_FILE_ACCESS if there was a file access related error (errno should be set)
\return ERR_FORMAT if image decoding failed.
*/
int fail();
Fl_Image(int W, int H, int D);
virtual ~Fl_Image();

View File

@ -140,6 +140,32 @@ void Fl_Image::label(Fl_Menu_Item* m) {
m->label(_FL_IMAGE_LABEL, (const char*)this);
}
/**
Returns a value that is not 0 if there is currently no image
available.
Example use:
\code
[..]
Fl_Box box(X,Y,W,H);
Fl_JPEG_Image jpg("/tmp/foo.jpg");
switch ( jpg.fail() ) {
case Fl_Image::ERR_NO_IMAGE:
case Fl_Image::ERR_FILE_ACCESS:
fl_alert("/tmp/foo.jpg: %s", strerror(errno)); // shows actual os error to user
exit(1);
case Fl_Image::ERR_FORMAT:
fl_alert("/tmp/foo.jpg: couldn't decode image");
exit(1);
}
box.image(jpg);
[..]
\endcode
\return ERR_NO_IMAGE if no image was found
\return ERR_FILE_ACCESS if there was a file access related error (errno should be set)
\return ERR_FORMAT if image decoding failed.
*/
int Fl_Image::fail()
{
// if no image exists, ld_ may contain a simple error code