fl_text_extents(): added example, included reference to fl_font() and fl_measure().

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12543 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Greg Ercolano 2017-11-05 04:18:44 +00:00
parent a20d472faf
commit f47c0e9e51

View File

@ -566,7 +566,8 @@ inline double fl_width(const char* txt, int n) {return fl_graphics_driver->width
\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);}
/** Determines the minimum pixel dimensions of a nul-terminated string.
/** Determines the minimum pixel dimensions of a nul-terminated string
using the current fl_font().
Usage: given a string "txt" drawn using fl_draw(txt, x, y) you would determine
its pixel extents on the display using fl_text_extents(txt, dx, dy, wo, ho)
@ -574,10 +575,27 @@ inline double fl_width(unsigned int c) {return fl_graphics_driver->width(c);}
fl_rect(x+dx, y+dy, wo, ho). Note the dx, dy values hold the offset of the first
"colored in" pixel of the string, from the draw origin.
Note the desired font and font size must be set with fl_font() before calling
this function.
This differs slightly from fl_measure() in that the dx/dy values are also
returned.
No FLTK symbol expansion will be performed.
Example use:
\code
:
int dx,dy,W,H;
fl_font(FL_HELVETICA, 12); // set font face+size first
fl_text_extents("Some text",dx,dy,W,H); // get width and height of string
printf("text's width=%d, height=%d\n", W,H);
:
\endcode
*/
FL_EXPORT void fl_text_extents(const char*, int& dx, int& dy, int& w, int& h); // NO fltk symbol expansion will be performed
/** Determines the minimum pixel dimensions of a sequence of \p n characters.
/** Determines the minimum pixel dimensions of a sequence of \p n characters
using the current fl_font().
\see fl_text_extents(const char*, int& dx, int& dy, int& w, int& h)
*/
inline void fl_text_extents(const char *t, int n, int& dx, int& dy, int& w, int& h)