summaryrefslogtreecommitdiff
path: root/FL/Fl_Free.H
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-09-14 15:45:27 +0000
committerFabien Costantini <fabien@onepost.net>2008-09-14 15:45:27 +0000
commitce4d0fd5d86a1f725aba6093d9674b993d437d6c (patch)
tree4839ae652332f4ec80de23a21fb0ddd702a20330 /FL/Fl_Free.H
parent7f4e2867e84826d237e48f01f25de168cfdb986b (diff)
Doxygen Documentation WP4 Done. Has all documentation content but should be completed in increment 2. Registered for WP5.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6239 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Free.H')
-rw-r--r--FL/Fl_Free.H25
1 files changed, 23 insertions, 2 deletions
diff --git a/FL/Fl_Free.H b/FL/Fl_Free.H
index 4ac7af543..5b141cc86 100644
--- a/FL/Fl_Free.H
+++ b/FL/Fl_Free.H
@@ -40,6 +40,27 @@
typedef int (*FL_HANDLEPTR)(Fl_Widget *, int , float, float, char);
+/**
+ Emulation of the Forms &quot;free&quot; 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: </P>
+ <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.
+*/
class FL_EXPORT Fl_Free : public Fl_Widget {
FL_HANDLEPTR hfunc;
static void step(void *);
@@ -47,8 +68,8 @@ protected:
void draw();
public:
int handle(int);
- Fl_Free(uchar t,int x,int y,int w,int h,const char *l,FL_HANDLEPTR hdl);
- ~Fl_Free();
+ Fl_Free(uchar t,int x,int y,int w,int h,const char *l,FL_HANDLEPTR hdl);
+ ~Fl_Free();
};
// old event names for compatability: