mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reorganization of the Doxygen docs of some Fl_Image class functions.

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8338 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Manolo Gouy 2011-01-30 09:24:40 +00:00
parent 5850cc1334
commit d4ad141d4d
1 changed files with 26 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
FL/Fl_Image.H
View File

@ -3,7 +3,7 @@
// //
// Image header file for the Fast Light Tool Kit (FLTK). // Image header file for the Fast Light Tool Kit (FLTK).
// //
// Copyright 1998-2010 by Bill Spitzak and others. // Copyright 1998-2011 by Bill Spitzak and others.
// //
// This library is free software; you can redistribute it and/or // This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public // modify it under the terms of the GNU Library General Public
@ -59,33 +59,24 @@ class FL_EXPORT Fl_Image {
protected: protected:
/** /**
The first form of the w() method returns the current Sets the current image width in pixels.
image width in pixels.</P>
<P>The second form is a protected method that sets the current
image width.
*/ */
void w(int W) {w_ = W;} void w(int W) {w_ = W;}
/** /**
The first form of the h() method returns the current Sets the current image height in pixels.
image height in pixels.</P>
<P>The second form is a protected method that sets the current
image height.
*/ */
void h(int H) {h_ = H;} void h(int H) {h_ = H;}
/** /**
The first form of the d() method returns the current Sets the current image depth.
image depth. The return value will be 0 for bitmaps, 1 for
pixmaps, and 1 to 4 for color images.</P>
<P>The second form is a protected method that sets the current
image depth.
*/ */
void d(int D) {d_ = D;} void d(int D) {d_ = D;}
/** See int ld() */ /**
Sets the current line data size in bytes.
*/
void ld(int LD) {ld_ = LD;} void ld(int LD) {ld_ = LD;}
/** See const char * const *data() */ /**
Sets the current array pointer and count of pointers in the array.
*/
void data(const char * const *p, int c) {data_ = p; count_ = c;} void data(const char * const *p, int c) {data_ = p; count_ = c;}
void draw_empty(int X, int Y); void draw_empty(int X, int Y);
@ -94,26 +85,23 @@ class FL_EXPORT Fl_Image {
public: public:
/** See void Fl_Image::w(int) */ /**
Returns the current image width in pixels.
*/
int w() const {return w_;} int w() const {return w_;}
/** See void Fl_Image::h(int) */ /** Returns the current image height in pixels.
*/
int h() const {return h_;} int h() const {return h_;}
/** /**
The first form of the d() method returns the current Returns the current image depth.
image depth. The return value will be 0 for bitmaps, 1 for The return value will be 0 for bitmaps, 1 for
pixmaps, and 1 to 4 for color images.</P> pixmaps, and 1 to 4 for color images.</P>
<P>The second form is a protected method that sets the current
image depth.
*/ */
int d() const {return d_;} int d() const {return d_;}
/** /**
The first form of the ld() method returns the current Returns the current line data size in bytes.
line data size in bytes. Line data is extra data that is included Line data is extra data that is included
after each line of color image data and is normally not present.</P> after each line of color image data and is normally not present.
<P>The second form is a protected method that sets the current
line data size in bytes.
*/ */
int ld() const {return ld_;} int ld() const {return ld_;}
/** /**
@ -124,12 +112,8 @@ class FL_EXPORT Fl_Image {
*/ */
int count() const {return count_;} int count() const {return count_;}
/** /**
The first form of the data() method returns a Returns a pointer to the current image data array.
pointer to the current image data array. Use the Use the count() method to find the size of the data array.
count() method to find the size of the data array.</P>
<P>The second form is a protected method that sets the current
array pointer and count of pointers in the array.
*/ */
const char * const *data() const {return data_;} const char * const *data() const {return data_;}
@ -162,15 +146,16 @@ class FL_EXPORT Fl_Image {
virtual void label(Fl_Widget*w); virtual void label(Fl_Widget*w);
virtual void label(Fl_Menu_Item*m); virtual void label(Fl_Menu_Item*m);
/** /**
The draw() methods draw the image. This form specifies Draws the image with a bounding box.
This form specifies
a bounding box for the image, with the origin a bounding box for the image, with the origin
(upper-lefthand corner) of the image offset by the cx (upper-lefthand corner) of the image offset by the cx
and cy arguments. and cy arguments.
*/ */
virtual void draw(int X, int Y, int W, int H, int cx=0, int cy=0); // platform dependent virtual void draw(int X, int Y, int W, int H, int cx=0, int cy=0); // platform dependent
/** /**
The draw() methods draw the image. This form Draws the image.
specifies the upper-lefthand corner of the image This form specifies the upper-lefthand corner of the image.
*/ */
void draw(int X, int Y) {draw(X, Y, w(), h(), 0, 0);} // platform dependent void draw(int X, int Y) {draw(X, Y, w(), h(), 0, 0);} // platform dependent
virtual void uncache(); virtual void uncache();