Added Fl_Scroll::bbox() documentation (STR #1893)

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6654 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

2 files changed, 11 insertions, 0 deletions

diff --git a/CHANGES b/CHANGES
index 9128af1d2..12a218610 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,5 +1,6 @@
 CHANGES IN FLTK 1.3.0
 
+	- Added Fl_Scroll::bbox() documentation (STR #1893)
 	- Removed an XForms compatibility "feature" that prevented the down
 	  array of Fl_Menu_Button from drawing (STR #2141).
 	- New helper class Fl_Watch to simplify safe handling of widget
diff --git a/src/Fl_Scroll.cxx b/src/Fl_Scroll.cxx
index 160a84fbe..77c35d7a4 100644
--- a/src/Fl_Scroll.cxx
+++ b/src/Fl_Scroll.cxx
@@ -92,6 +92,16 @@ void Fl_Scroll::draw_clip(void* v,int X, int Y, int W, int H) {
   fl_pop_clip();
 }
 
+/**
+  Returns the bounding box for the interior of the scrolling area, inside
+  the scrollbars.
+  
+  Currently this is only reliable after draw(), and before any resizing of
+  the Fl_Scroll or any child widgets occur.
+  
+  \todo The visibility of the scrollbars ought to be checked/calculated
+  outside of the draw() method (STR #1895).
+*/
 void Fl_Scroll::bbox(int& X, int& Y, int& W, int& H) {
   X = x()+Fl::box_dx(box());
   Y = y()+Fl::box_dy(box());