diff options
| author | Matthias Melcher <fltk@matthiasm.com> | 2006-09-06 07:29:20 +0000 |
|---|---|---|
| committer | Matthias Melcher <fltk@matthiasm.com> | 2006-09-06 07:29:20 +0000 |
| commit | 7ac3b8e5b9cd4920c954cb3ba9011d07c4fb6b3d (patch) | |
| tree | 1d0678bc5554f3a59a647033e8c19ab3349cc387 | |
| parent | c989ca4bdf1241553a32ec57a68ea20bc89c8f5d (diff) | |
Updated documentation on Fl::box_dx and friends.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5424 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
| -rw-r--r-- | CHANGES | 1 | ||||
| -rw-r--r-- | documentation/Fl.html | 24 |
2 files changed, 25 insertions, 0 deletions
@@ -1,5 +1,6 @@ CHANGES IN FLTK 1.1.8 + - Updated documentation (STR #1420, STR #1421) - Fixed font caching issue (STR #1415) - Fixed crash in fl_file_chooser (STR #1410) - Fixed Fluid hotspot bug (STR #1416) diff --git a/documentation/Fl.html b/documentation/Fl.html index a20e913d4..701e9c314 100644 --- a/documentation/Fl.html +++ b/documentation/Fl.html @@ -424,19 +424,43 @@ handle()</tt>). <H4><A NAME="Fl.box_dh">int box_dh(Fl_Boxtype);</A></H4> <P>Returns the height offset for the given boxtype. +See <tt><a href="#Fl.box_dy">box_dy</a></tt>. <H4><A NAME="Fl.box_dw">int box_dw(Fl_Boxtype);</A></H4> <P>Returns the width offset for the given boxtype. +See <tt><a href="#Fl.box_dy">box_dy</a></tt>. <H4><A NAME="Fl.box_dx">int box_dx(Fl_Boxtype);</A></H4> <P>Returns the X offset for the given boxtype. +See <tt><a href="#Fl.box_dy">box_dy</a></tt>. <H4><A NAME="Fl.box_dy">int box_dy(Fl_Boxtype);</A></H4> <P>Returns the Y offset for the given boxtype. +<P>These functions return the offset values necessary for a given +boxtype, useful for computing the area inside a box's borders, to +prevent overdrawing the borders. + +<P>For instance, in the case of a boxtype like <tt>FL_DOWN_BOX</tt> +where the border width might be 2 pixels all around, the above +functions would return 2, 2, 4, and 4 for <tt>box_dx</tt>, +<tt>box_dy</tt>, <tt>box_dw</tt>, and <tt>box_dh</tt> +respectively. + +<P>An example to compute the area inside a widget's box(): +<pre> + int X = yourwidget->x() + Fl::box_dx(yourwidget->box()); + int Y = yourwidget->y() + Fl::box_dy(yourwidget->box()); + int W = yourwidget->w() - Fl::box_dw(yourwidget->box()); + int H = yourwidget->h() - Fl::box_dh(yourwidget->box()); +</pre> +<P>These functions are mainly useful in the <tt>draw()</tt> code +for deriving custom widgets, where one wants to avoid drawing +over the widget's own border <tt>box()</tt>. + <H4><A NAME="Fl.check">int check();</A></H4> <P>Same as <tt>Fl::wait(0)</tt>. Calling this during a big calculation |