Fl_Widget::handle() doco update (STR #399)

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@3434 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
fltk · Jun 1, 2004 · c3fea65 · c3fea65
1 parent 213be08
commit c3fea65
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/CHANGES b/CHANGES
@@ -1,6 +1,6 @@
 CHANGES IN FLTK 1.1.5rc2
 
-	- Documentation updates (STR #365)
+	- Documentation updates (STR #365, STR #399)
 	- FLTK now builds with the current release of MinGW (STR
 	  #325, STR #401, STR #402)
 	- FLTK now honors the numlock key state (STR #369)

diff --git a/documentation/Fl_Widget.html b/documentation/Fl_Widget.html
@@ -300,7 +300,11 @@ <H4><A name="Fl_Widget.handle">virtual int Fl_Widget::handle(int event)</A></H4>
 
 <P>Handles the specified event. You normally don't call this
 method directly, but instead let FLTK do it when the user
-interacts with the widget.
+interacts with the widget.</p>
+
+<p>When implemented in a new widget, this function must return 0
+if the widget does not use the event or 1 if it uses the
+event.</p>
 
 
 <H4><A name="Fl_Widget.image">Fl_Image* Fl_Widget::image()</A><BR>