From 36e546c1c9a9bb8e778fb637c17f94390b4d23c2 Mon Sep 17 00:00:00 2001 From: Jedidiah Barber Date: Sat, 15 Feb 2025 14:29:16 +1300 Subject: Reorganising Fl / FLTK, improving enum docs --- doc/enumerations.html | 13 +++-- doc/fl.html | 123 ++++++---------------------------------- doc/fl_(fltk-event).html | 20 +++++++ doc/fl_(fltk-screen).html | 9 ++- doc/fl_(fltk-static).html | 141 +++++++++++++++++++++++++++++++++------------- doc/fl_browser_.html | 9 ++- doc/fl_file_chooser.html | 6 +- doc/fl_pack.html | 4 +- doc/fl_scroll.html | 9 ++- doc/fl_text_display.html | 25 ++++++-- doc/fl_widget.html | 10 ---- 11 files changed, 203 insertions(+), 166 deletions(-) (limited to 'doc') diff --git a/doc/enumerations.html b/doc/enumerations.html index 937a7a9..3533cd9 100644 --- a/doc/enumerations.html +++ b/doc/enumerations.html @@ -131,13 +131,18 @@ - int - Version_Number + Fl_When + Callback_Flag - Fl_When - Callback_Flag (in FLTK.Widgets) + Fl_Damage + Damage_Mask + + + + int + Version_Number diff --git a/doc/fl.html b/doc/fl.html index 7803d33..7d4d3ee 100644 --- a/doc/fl.html +++ b/doc/fl.html @@ -37,30 +37,20 @@ - enum + enum {
+ FL_MENU_INACTIVE = 1,
+ FL_MENU_TOGGLE = 2,
+ FL_MENU_VALUE = 4,
+ FL_MENU_RADIO = 8,
+ FL_MENU_INVISIBLE = 0x10,
+ FL_SUBMENU_POINTER = 0x20,
+ FL_SUBMENU = 0x40,
+ FL_MENU_DIVIDER = 0x80,
+ FL_MENU_HORIZONTAL = 0x100 }
+ Menu_Flag - - Fl_Abort_Handler -   - - - - Fl_Args_Handler -   - - - - Fl_Atclose_Handler -   - - - - Fl_Old_Idle_Handler -   - - @@ -77,34 +67,6 @@ - - - - - - - - - - - - - - - - - - -
Static Attributes
-static void (*atclose)(Fl_Window *, void *);
-
Deprecated, set the callback for the Window instead.
-static const char * const help = helpmsg + 13;
-
 
-static void (*idle)();
-
Should not be used directly.
- - - @@ -141,27 +103,6 @@ function API_Version - - - - - - - - - - - - - - - - - - - - @@ -257,6 +191,13 @@ static void delete_widget(Fl_Widget *w); + + + + + - - - - - - - - - - - - - - - @@ -397,13 +317,6 @@ function Version - - - - - + + + + + + + + + +
Static Functions and Procedures
-static int arg(int argc, char **argv, int &i);
-
 
-static int args(int argc, char **argv, int &i, Fl_Args_Handler cb=0);
-
 
-static void args(int argc, char **argv);
-
 
 static void awake(void *message=0);
 
@@ -171,13 +112,6 @@ procedure Awake;
 
   
-static int awake(Fl_Awake_Handler cb, void *message=0);
-
 
 static void cairo_autolink_context(bool alink);
 
+static void do_widget_deletion();
+
Marked as internal use only.
 static void flush();
 
@@ -327,27 +268,6 @@ function Run
 
   
-static void set_abort(Fl_Abort_Handler f);
-
Marked as backwards compatibility only.
-static void set_atclose(Fl_Atclose_Handler f);
-
Marked as backwards compatibility only.
-static void set_idle(Fl_Old_Idle_Handler cb);
-
Deprecated, use add_idle / Add_Idle instead.
 static void * thread_message();
 
-static int visual(int);
-
 
 static int wait();
 
diff --git a/doc/fl_(fltk-event).html b/doc/fl_(fltk-event).html
index 72a007c..3aaca1f 100644
--- a/doc/fl_(fltk-event).html
+++ b/doc/fl_(fltk-event).html
@@ -519,6 +519,26 @@ static int test_shortcut(Fl_Shortcut);
  
+static int visible_focus();
+
+function Has_Visible_Focus
+    return Boolean;
+
+static void visible_focus(int v);
+
+procedure Set_Visible_Focus
+       (To : in Boolean);
+
diff --git a/doc/fl_(fltk-screen).html b/doc/fl_(fltk-screen).html index fddc17d..a5f8722 100644 --- a/doc/fl_(fltk-screen).html +++ b/doc/fl_(fltk-screen).html @@ -36,7 +36,7 @@ static void display(const char *); 
-procedure Set_Display_Var
+procedure Set_Display_String
        (Value : in String);
@@ -178,6 +178,13 @@ procedure Work_Area 
+static int visual(int);
+
+  + + + +
 static int w();
 
diff --git a/doc/fl_(fltk-static).html b/doc/fl_(fltk-static).html
index 031ff3f..3afc53a 100644
--- a/doc/fl_(fltk-static).html
+++ b/doc/fl_(fltk-static).html
@@ -32,13 +32,23 @@
   Types
 
   
-    Fl_Awake_Handler
-    Awake_Handler
+    Fl_Abort_Handler
+     
   
 
   
-    Fl_Timeout_Handler
-    Timeout_Handler
+    Fl_Args_Handler
+     
+  
+
+  
+    Fl_Atclose_Handler
+     
+  
+
+  
+    Fl_Awake_Handler
+    Awake_Handler
   
 
   
@@ -46,6 +56,21 @@
     Idle_Handler
   
 
+  
+    Fl_Old_Idle_Handler
+     
+  
+
+  
+    Fl_System_Handler
+     
+  
+
+  
+    Fl_Timeout_Handler
+    Timeout_Handler
+  
+
   
     int
     Buffer_Kind
@@ -91,11 +116,6 @@
     Option
   
 
-  
-    Fl_System_Handler
-     
-  
-
 
 
 
@@ -105,6 +125,13 @@
 
   
 
+static void (*atclose)(Fl_Window *, void *);
+

+Deprecated, set the callback for the Window instead.
+  
+
+  
+
 static char const * const clipboard_image = "image";
 

  
@@ -117,6 +144,20 @@ static char const * const clipboard_plain_text = "text/plain";
  
   
 
+  
+
+static const char * const help = helpmsg + 13;
+

+ 
+  
+
+  
+
+static void (*idle)();
+

+Should not be used directly.
+  
+
 
 
 
@@ -191,7 +232,8 @@ procedure Add_Idle
 
   
 
-static void add_system_handler(Fl_System_Handler h, void *data);
+static void add_system_handler(Fl_System_Handler h,
+    void *data);
 

  
   
@@ -210,6 +252,35 @@ procedure Add_Timeout
 
   
 
+static int arg(int argc, char **argv, int &i);
+

+ 
+  
+
+  
+
+static int args(int argc, char **argv, int &i,
+    Fl_Args_Handler cb=0);
+

+ 
+  
+
+  
+
+static void args(int argc, char **argv);
+

+ 
+  
+
+  
+
+static int awake(Fl_Awake_Handler cb, void *message=0);
+

+ 
+  
+
+  
+
 static void background(uchar, uchar, uchar);
 

 
@@ -349,15 +420,6 @@ procedure Set_Drag_Drop_Text_Support
 
   
 
-static void do_widget_deletion();
-

-
-procedure Do_Widget_Deletion;
-

-  
-
-  
-
 static int draw_box_active();
 

 
@@ -781,6 +843,20 @@ static void selection_owner(Fl_Widget *);
 
   
 
+static void set_abort(Fl_Abort_Handler f);
+

+Marked as backwards compatibility only.
+  
+
+  
+
+static void set_atclose(Fl_Atclose_Handler f);
+

+Marked as backwards compatibility only.
+  
+
+  
+
 static void set_box_color(Fl_Color);
 

  
@@ -788,7 +864,8 @@ static void set_box_color(Fl_Color);
 
   
 
-static void set_boxtype(Fl_Boxtype, Fl_Box_Draw_F *, uchar, uchar, uchar, uchar);
+static void set_boxtype(Fl_Boxtype, Fl_Box_Draw_F *,
+    uchar, uchar, uchar, uchar);
 

  
   
@@ -851,36 +928,24 @@ procedure Setup_Fonts
 
   
 
-static void set_labeltype(Fl_Labeltype, Fl_Label_Draw_F *, FL_Label_Measure_F *);
+static void set_idle(Fl_Old_Idle_Handler cb);
 

- 
+Deprecated, use add_idle / Add_Idle instead.
   
 
   
 
-static void set_labeltype(Fl_Labeltype, Fl_Labeltype from);
+static void set_labeltype(Fl_Labeltype, Fl_Label_Draw_F *,
+    FL_Label_Measure_F *);
 

  
   
 
   
 
-static int visible_focus();
-

-
-function Has_Visible_Focus
-    return Boolean;
-

-  
-
-  
-
-static void visible_focus(int v);
-

-
-procedure Set_Visible_Focus
-       (To : in Boolean);
+static void set_labeltype(Fl_Labeltype, Fl_Labeltype from);
 

+ 
   
 
 
diff --git a/doc/fl_browser_.html b/doc/fl_browser_.html
index 1ee2a6a..a09e2e4 100644
--- a/doc/fl_browser_.html
+++ b/doc/fl_browser_.html
@@ -47,7 +47,14 @@ already extended from it.

   
 
   
-    enum mode
+    enum {

+    HORIZONTAL = 1,

+    VERTICAL = 2,

+    BOTH = 3,

+    ALWAYS_ON = 4,

+    HORIZONTAL_ALWAYS = 5,

+    VERTICAL_ALWAYS = 6,

+    BOTH_ALWAYS = 7 }
     Scrollbar_Mode
   
 
diff --git a/doc/fl_file_chooser.html b/doc/fl_file_chooser.html
index 24bd6d8..f186ca4 100644
--- a/doc/fl_file_chooser.html
+++ b/doc/fl_file_chooser.html
@@ -45,7 +45,11 @@ See Fl_Ask for related symbols that are not members of the Fl_File_Chooser class
   
 
   
-    enum {SINGLE=0, MULTI=1, CREATE=2, DIRECTORY=4}
+    enum {

+    SINGLE = 0,

+    MULTI = 1,

+    CREATE = 2,

+    DIRECTORY = 4 }
     Chooser_Kind
   
 
diff --git a/doc/fl_pack.html b/doc/fl_pack.html
index 1a7a887..f850557 100644
--- a/doc/fl_pack.html
+++ b/doc/fl_pack.html
@@ -42,7 +42,9 @@
   
 
   
-    enum { VERTICAL = 0, HORIZONTAL = 1 }
+    enum {

+    VERTICAL = 0,

+    HORIZONTAL = 1 }
     Pack_Kind
   
 
diff --git a/doc/fl_scroll.html b/doc/fl_scroll.html
index c55dba5..4c8977b 100644
--- a/doc/fl_scroll.html
+++ b/doc/fl_scroll.html
@@ -42,7 +42,14 @@
   
 
   
-    enum { HORIZONTAL = 1, VERTICAL = 2, BOTH = 3, ALWAYS_ON = 4, HORIZONTAL_ALWAYS = 5, VERTICAL_ALWAYS = 6, BOTH_ALWAYS = 7 }
+    enum {

+    HORIZONTAL = 1,

+    VERTICAL = 2,

+    BOTH = 3,

+    ALWAYS_ON = 4,

+    HORIZONTAL_ALWAYS = 5,

+    VERTICAL_ALWAYS = 6,

+    BOTH_ALWAYS = 7 }
     Scroll_Kind
   
 
diff --git a/doc/fl_text_display.html b/doc/fl_text_display.html
index 8d0d20a..54b2f54 100644
--- a/doc/fl_text_display.html
+++ b/doc/fl_text_display.html
@@ -42,22 +42,39 @@
   
 
   
-    enum { NORMAL_CURSOR, CARET_CURSOR, DIM_CURSOR, BLOCK_CURSOR, HEAVY_CURSOR, SIMPLE_CURSOR }
+    enum {

+    NORMAL_CURSOR,

+    CARET_CURSOR,

+    DIM_CURSOR,

+    BLOCK_CURSOR,

+    HEAVY_CURSOR,

+    SIMPLE_CURSOR }
     Cursor_Style
   
 
   
-    enum { CURSOR_POS, CHARACTER_POS }
+    enum {

+    CURSOR_POS,

+    CHARACTER_POS }
     Position_Kind
   
 
   
-    enum { DRAG_NONE = -2, DRAG_START_DND = -1, DRAG_CHAR = 0, DRAG_WORD = 1, DRAG_LINE = 2 }
+    enum {

+    DRAG_NONE = -2,

+    DRAG_START_DND = -1,

+    DRAG_CHAR = 0,

+    DRAG_WORD = 1,

+    DRAG_LINE = 2 }
      
   
 
   
-    enum { WRAP_NONE, WRAP_AT_COLUMN, WRAP_AT_PIXEL, WRAP_AT_BOUNDS }
+    enum {

+    WRAP_NONE,

+    WRAP_AT_COLUMN,

+    WRAP_AT_PIXEL,

+    WRAP_AT_BOUNDS }
     Wrap_Mode
   
 
diff --git a/doc/fl_widget.html b/doc/fl_widget.html
index c5c2f16..0552325 100644
--- a/doc/fl_widget.html
+++ b/doc/fl_widget.html
@@ -46,16 +46,6 @@
     Widget_Callback
   
 
-  
-    Fl_When (in Enumerations)
-    Callback_Flag
-  
-
-  
-    uchar
-    Damage_Mask
-  
-
 
 
 
-- 
cgit