Author: AlbrechtS
Date: 2009-07-25 05:56:16 -0700 (Sat, 25 Jul 2009)
New Revision: 6836
Log:
Added comments about removing widgets from their parent group or window
before deleting them with delete or Fl_Widget::delete_widget(). This is not
necessary any more, but it was necessary in FLTK 1.1.
Modified:
branches/branch-1.3/src/Fl.cxx
Modified: branches/branch-1.3/src/Fl.cxx
===================================================================
--- branches/branch-1.3/src/Fl.cxx 2009-07-25 09:56:24 UTC (rev 6835)
+++ branches/branch-1.3/src/Fl.cxx 2009-07-25 12:56:16 UTC (rev 6836)
@@ -1493,13 +1493,23 @@
/**
Schedules a widget for deletion at the next call to the event loop.
- Use this method to delete a widget inside a callback function.
- To avoid early deletion of widgets, this function
- should be called toward the end of a callback and only after any call
- to the event loop (Fl:wait(), Fl::flush(), fl_ask(), etc).
+ Use this method to delete a widget inside a callback function.
+ To avoid early deletion of widgets, this function should be called
+ toward the end of a callback and only after any call to the event
+ loop (Fl::wait(), Fl::flush(), Fl::check(), fl_ask(), etc.).
+
When deleting groups or windows, you must only delete the group or
window widget and not the individual child widgets.
+
+ \since FLTK 1.3 it is not necessary to remove widgets from their parent
+ groups or windows before calling this, because it will be done in the
+ widget's destructor, but it is not a failure to do this nevertheless.
+
+ \note In FLTK 1.1 you \b must remove widgets from their parent group
+ (or window) before deleting them.
+
+ \see Fl_Widget::~Fl_Widget()
*/
void Fl::delete_widget(Fl_Widget *wi) {
if (!wi) return;
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
