[email protected] wrote:
> Author: fabien
> Date: 2008-10-04 07:15:16 -0700 (Sat, 04 Oct 2008)
> New Revision: 6372
[...]
IMHO, the following change is not correct.
"The first form" is that one with only 4 arguments:
void Fl::screen_xywh(int &X, int &Y, int &W, int &H)
and is missing in the screen functions module for some reason, maybe
because it doesn't have a \relates statement or similar(?) - IIRC, it's
documented (very short) in the header file. This first form should be
documented (in the header file):
/**
Gets the bounding box for the screen the mouse pointer is in.
This is the same as calling
Fl::screen_xywh(X, Y, W, H, Fl::event_x_root(), Fl::event_y_root());
*/
... or similar.
> Modified: branches/branch-1.3/src/screen_xywh.cxx
> ===================================================================
> --- branches/branch-1.3/src/screen_xywh.cxx 2008-10-04 12:21:46 UTC (rev
> 6371)
> +++ branches/branch-1.3/src/screen_xywh.cxx 2008-10-04 14:15:16 UTC (rev
> 6372)
> @@ -151,12 +151,10 @@
> }
>
> /**
> - Gets the bounding box of a screen. The first form gets the
> - bounding box for the screen the mouse pointer is in. The second
> - form gets the bounding box for the screen that contains the
> - specified coordinates. The last form gets the bounding box for
> - the numbered screen, where n is a number from 0 to the
> - number of screens less 1.
> + Gets the bounding box of a screen
> + where the mouse pointer is in.
This should be:
+ Gets the bounding box for the screen that contains the
+ specified coordinates.
> + \param[out] X,Y,W,H the corresponding screen bounding box
> + \param[in] mx, my the mouse absolute screen position
> */
> void Fl::screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my) {
> if (!num_screens) screen_init();
> @@ -222,8 +220,10 @@
> }
>
> /**
> - Returns the screen bounding rect for the given screen.
> - See void screen_xywh(int &x, int &y, int &w, int &h, int mx, int my)
> + Gets the screen bounding rect for the given screen.
> + \param[out] X,Y,W,H the corresponding screen bounding box
> + \param[in] n the screen number (0 to Fl::screen_count() - 1)
> + \see void screen_xywh(int &x, int &y, int &w, int &h, int mx, int my)
> */
> void Fl::screen_xywh(int &X, int &Y, int &W, int &H, int n) {
> if (!num_screens) screen_init();
Fabien, if you don't want to correct this yourself, drop a note, and I
can look into it tomorrow.
Albrecht
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev
