diff options
| author | Albrecht Schlosser <albrechts.fltk@online.de> | 2024-11-17 19:44:11 +0100 |
|---|---|---|
| committer | Albrecht Schlosser <albrechts.fltk@online.de> | 2024-11-17 20:01:46 +0100 |
| commit | 6c6f6b7dd9391c184d3bc44be261da875cde746d (patch) | |
| tree | ec40fec74ae89f24060d22c1293ef0ad862edf55 /src/screen_xywh.cxx | |
| parent | 7b9af35847e443147ffa0bd45564ae25862429b3 (diff) | |
Finish release 1.4.0
1) Improve and clarify documentation:
- update, reformat, and reorder parts of CREDITS.txt
- make sure that documentation appears in doxygen docs
- add '\since 1.4.0' to documentation of new methods and functions
- remove doxygen's '\brief' where not required (we're using
JAVADOC_AUTOBRIEF = YES)
- clarify screen scaling, scaling factor, and related stuff
- add more info about backwards compatibility for X11 specific code
2) Update dependencies
Diffstat (limited to 'src/screen_xywh.cxx')
| -rw-r--r-- | src/screen_xywh.cxx | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/src/screen_xywh.cxx b/src/screen_xywh.cxx index 604611d6b..60ad00287 100644 --- a/src/screen_xywh.cxx +++ b/src/screen_xywh.cxx @@ -1,7 +1,7 @@ // // Screen/monitor bounding box API for the Fast Light Tool Kit (FLTK). // -// Copyright 1998-2018 by Bill Spitzak and others. +// Copyright 1998-2024 by Bill Spitzak and others. // // This library is free software. Distribution and use rights are outlined in // the file "COPYING" which should have been included with this file. If this @@ -57,7 +57,7 @@ int Fl::h() /** Gets the total count of available screens. - \note Screen numbers range from 0 to Fl::screen_count()-1 in the FLTK API. + \note Screen numbers range from 0 to Fl::screen_count() - 1 in the FLTK API. */ int Fl::screen_count() { @@ -133,13 +133,16 @@ void Fl::screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my, int mw, int /** - Gets the screen number of a screen - that contains the specified screen position \p x, \p y + Gets the screen number of a screen that contains the specified + screen position \p x, \p y. + \param[in] x, y the absolute screen position \return a screen number ∈ [0 , Fl::screen_count()-1] - \attention When the running system contains screens with different scaling factor values, this API - may become ambiguous because a given value pair (\p x, \p y) may belong to distinct screens. - In that situation, other APIs should be preferred, e.g., Fl_Window::screen_num() and Fl::screen_scale(int). + + \attention When the running system contains screens with different scaling + factors, this API may become ambiguous because a given value pair (\p x, \p y) + may belong to distinct screens. In that situation other APIs should be + preferred, e.g. Fl_Window::screen_num() and Fl::screen_scale(int). */ int Fl::screen_num(int x, int y) { @@ -148,12 +151,13 @@ int Fl::screen_num(int x, int y) /** - Gets the screen number for the screen - which intersects the most with the rectangle - defined by \p x, \p y, \p w, \p h. + Gets the screen number of the screen which intersects the most with + the rectangle defined by \p x, \p y, \p w, \p h. + \param[in] x, y, w, h the rectangle to search for intersection with + \return a screen number ∈ [0 , Fl::screen_count()-1] - */ +*/ int Fl::screen_num(int x, int y, int w, int h) { return screen_driver()->screen_num(x, y, w, h); |
