diff options
| author | Michael R Sweet <michael.r.sweet@gmail.com> | 1998-12-29 14:21:17 +0000 |
|---|---|---|
| committer | Michael R Sweet <michael.r.sweet@gmail.com> | 1998-12-29 14:21:17 +0000 |
| commit | 87dd7f0d23eba5c09e71ec6efeb34c6844f5e95f (patch) | |
| tree | ecd25b3fbecdd2d1c6abf106d0c94ac2b1e9926e /documentation/Fl_Free.html | |
| parent | 20adb6834b22523e9d1fecdb7bb8a117f7b6179a (diff) | |
Revised documentation files.
git-svn-id: file:///fltk/svn/fltk/trunk@177 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/Fl_Free.html')
| -rw-r--r-- | documentation/Fl_Free.html | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/documentation/Fl_Free.html b/documentation/Fl_Free.html new file mode 100644 index 000000000..55616cb30 --- /dev/null +++ b/documentation/Fl_Free.html @@ -0,0 +1,87 @@ +<html> +<body> + +<hr break> + +<h2><a name="Fl_Free">class Fl_Free</a></h2> + +<hr> + +<h3>Class Hierarchy</h3> + +<ul><pre> +<a href="#Fl_Widget">Fl_Widget</a> + | + +----<b>Fl_Free</b> +</pre></ul> + +<h3>Include Files</h3> + +<ul><pre> +#include <FL/Fl_Free.H> +</pre></ul> + +<h3>Description</h3> + +Emulation of the Forms "free" widget. This emulation allows the free +demo to run, and appears to be useful for porting programs written in +Forms which use the free widget or make subclasses of the Forms widgets. + +<p>There are five types of free, which determine when the handle +function is called: + +<ul><pre> +#define FL_NORMAL_FREE 1 +#define FL_SLEEPING_FREE 2 +#define FL_INPUT_FREE 3 +#define FL_CONTINUOUS_FREE 4 +#define FL_ALL_FREE 5 +</pre></ul> + +<p>An FL_INPUT_FREE accepts FL_FOCUS events. A FL_CONTINUOUS_FREE +sets a timeout callback 100 times a second and provides a FL_STEP +event, this has obvious detrimental effects on machine performance. +FL_ALL_FREE does both. FL_SLEEPING_FREE are deactivated. + +<h3>Methods</h3> + +<ul> + <li><a href="#Fl_Free.Fl_Free">Fl_Free</a> + <li><a href="#Fl_Free.~Fl_Free">~Fl_Free</a> +</ul> + +<h4><a name="Fl_Free.Fl_Free">Fl_Free(uchar type, int, int, int, int, const char*l, FL_HANDLEPTR hdl)</a></h4> + +The constructor takes both the <tt>type</tt> and the <tt>handle</tt> function. +The handle function should be declared as follows: + +<ul><pre> +int +handle_function(Fl_Widget *w, + int event, + float event_x, + float event_y, + char key) +</pre></ul> + +This function is called from the the <tt>handle()</tt> method in +response to most events, and is called by the <tt>draw()</tt> method. +The <tt>event</tt> argument contains the event type: + +<ul><pre> +// old event names for compatability: +#define FL_MOUSE FL_DRAG +#define FL_DRAW 0 +#define FL_STEP 9 +#define FL_FREEMEM 12 +#define FL_FREEZE FL_UNMAP +#define FL_THAW FL_MAP +</pre></ul> + +<h4><a name="Fl_Free.~Fl_Free">virtual Fl_Free::~Fl_Free()</a></h4> + +The destructor will call the handle function with the event +<tt>FL_FREE_MEM</tt>. + +</body> +</html> |