summaryrefslogtreecommitdiff
path: root/FL
diff options
context:
space:
mode:
authorGreg Ercolano <erco@seriss.com>2014-09-18 15:25:55 +0000
committerGreg Ercolano <erco@seriss.com>2014-09-18 15:25:55 +0000
commitd5698e8ed9adcff51f31e8ddbcce30bf370128f9 (patch)
treec1398d8ce8ee2ef2331781be58de1ed085e26353 /FL
parent36b1ad056a44f40077948e2872e579a9f1716315 (diff)
Documentation: clarification of fl_width()'s dependence on the current font face/size.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10320 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL')
-rw-r--r--FL/fl_draw.H9
1 files changed, 6 insertions, 3 deletions
diff --git a/FL/fl_draw.H b/FL/fl_draw.H
index 30a3eb5f8..71dc2224d 100644
--- a/FL/fl_draw.H
+++ b/FL/fl_draw.H
@@ -531,11 +531,14 @@ FL_EXPORT int fl_height(int font, int size);
draw the text at so it looks centered vertically in that box.
*/
inline int fl_descent() {return fl_graphics_driver->descent();}
-/** Returns the typographical width of a nul-terminated string */
+/** Returns the typographical width of a nul-terminated string
+ using the current font face and size. */
FL_EXPORT double fl_width(const char* txt);
-/** Returns the typographical width of a sequence of \p n characters */
+/** Returns the typographical width of a sequence of \p n characters
+ using the current font face and size. */
inline double fl_width(const char* txt, int n) {return fl_graphics_driver->width(txt, n);}
-/** Returns the typographical width of a single character.
+/** Returns the typographical width of a single character
+ using the current font face and size.
\note if a valid fl_gc is NOT found then it uses the first window gc,
or the screen gc if no fltk window is available when called. */
inline double fl_width(unsigned int c) {return fl_graphics_driver->width(c);}