Filled holes in FLTK, FLTK.Events, FLTK.Screen, tweaked Fl_Shortcut implementation

author: Jedidiah Barber <contact@jedbarber.id.au> 2025-02-18 12:54:42 +1300
committer: Jedidiah Barber <contact@jedbarber.id.au> 2025-02-18 12:54:42 +1300
commit: d5fd3906e62969fce7fec7f2fccdc5a7436cbdbc (patch)
tree: 3f21adf51a8ea3aa75111c6653a6c8612608c096 /doc
parent: 36e546c1c9a9bb8e778fb637c17f94390b4d23c2 (diff)
6 files changed, 209 insertions, 113 deletions
diff --git a/doc/enumerations.html b/doc/enumerations.html
index 3533cd9..6e4f521 100644
--- a/doc/enumerations.html
+++ b/doc/enumerations.html
@@ -78,9 +78,10 @@
 
   <tr>
     <td>
-      #define FL_LEFT_MOUSE 1<br />
-      #define FL_MIDDLE_MOUSE 2<br />
-      #define FL_RIGHT_MOUSE 3
+      #define FL_BUTTON1 0x01000000<br />
+      #define FL_BUTTON2 0x02000000<br />
+      #define FL_BUTTON3 0x04000000<br />
+      #define FL_BUTTONS 0x7f000000
     </td>
     <td>Mouse_Button</td>
   </tr>
diff --git a/doc/fl.html b/doc/fl.html
index 7d4d3ee..9cefff7 100644
--- a/doc/fl.html
+++ b/doc/fl.html
@@ -68,6 +68,31 @@
 
 
 <table class="function">
+  <tr><th colspan="2">Static Attributes</th></tr>
+
+  <tr>
+<td><pre>
+static char const * const clipboard_image = "image";
+</pre></td>
+<td><pre>
+Clipboard_Image : constant String;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+static char const * const clipboard_plain_text = "text/plain";
+</pre></td>
+<td><pre>
+Clipboard_Plain_Text : constant String;
+</pre></td>
+  </tr>
+
+</table>
+
+
+
+<table class="function">
   <tr><th colspan="2">Static Functions and Procedures</th></tr>
 
   <tr>
@@ -103,15 +128,6 @@ function API_Version
 
   <tr>
 <td><pre>
-static void awake(void *message=0);
-</pre></td>
-<td><pre>
-procedure Awake;
-</pre></td>
-  </tr>
-
-  <tr>
-<td><pre>
 static void cairo_autolink_context(bool alink);
 </pre></td>
 <td>&nbsp;</td>
@@ -150,6 +166,8 @@ static cairo_t * cairo_make_current(Fl_Window *w);
 static int check();
 </pre></td>
 <td><pre>
+procedure Check;
+
 function Check
     return Boolean;
 </pre></td>
@@ -164,26 +182,6 @@ static void clear_widget_pointer(Fl_Widget const *w);
 
   <tr>
 <td><pre>
-static void damage(int d);
-</pre></td>
-<td><pre>
-procedure Set_Damaged
-       (To : in Boolean);
-</pre></td>
-  </tr>
-
-  <tr>
-<td><pre>
-static int damage();
-</pre></td>
-<td><pre>
-function Is_Damaged
-    return Boolean;
-</pre></td>
-  </tr>
-
-  <tr>
-<td><pre>
 static void delete_widget(Fl_Widget *w);
 </pre></td>
 <td>Used automatically as appropriate by the binding.</td>
@@ -198,15 +196,6 @@ static void do_widget_deletion();
 
   <tr>
 <td><pre>
-static void flush();
-</pre></td>
-<td><pre>
-procedure Flush;
-</pre></td>
-  </tr>
-
-  <tr>
-<td><pre>
 static int gl_visual(int, int *alist=0);
 </pre></td>
 <td>&nbsp;</td>
@@ -214,24 +203,6 @@ static int gl_visual(int, int *alist=0);
 
   <tr>
 <td><pre>
-static int handle(int, Fl_Window *);
-
-static int handle_(int, Fl_Window *);
-</pre></td>
-<td>&nbsp;</td>
-  </tr>
-
-  <tr>
-<td><pre>
-static int lock();
-</pre></td>
-<td><pre>
-procedure Lock;
-</pre></td>
-  </tr>
-
-  <tr>
-<td><pre>
 static int ready();
 </pre></td>
 <td><pre>
@@ -242,15 +213,6 @@ function Ready
 
   <tr>
 <td><pre>
-static void redraw();
-</pre></td>
-<td><pre>
-procedure Redraw;
-</pre></td>
-  </tr>
-
-  <tr>
-<td><pre>
 static void release_widget_pointer(Fl_Widget *&w);
 </pre></td>
 <td>Marked as internal use only.</td>
@@ -268,22 +230,6 @@ function Run
 
   <tr>
 <td><pre>
-static void * thread_message();
-</pre></td>
-<td>&nbsp;</td>
-  </tr>
-
-  <tr>
-<td><pre>
-static void unlock();
-</pre></td>
-<td><pre>
-procedure Unlock;
-</pre></td>
-  </tr>
-
-  <tr>
-<td><pre>
 static void use_high_res_GL(int val);
 </pre></td>
 <td>&nbsp;</td>
diff --git a/doc/fl_(fltk-event).html b/doc/fl_(fltk-events).html
index 3aaca1f..c9846fd 100644
--- a/doc/fl_(fltk-event).html
+++ b/doc/fl_(fltk-events).html
@@ -3,14 +3,14 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-    <title>Fl (FLTK.Event) Binding Map</title>
+    <title>Fl (FLTK.Events) Binding Map</title>
     <link href="map.css" rel="stylesheet">
   </head>
 
   <body>
 
 
-<h2>Fl (FLTK.Event) Binding Map</h2>
+<h2>Fl (FLTK.Events) Binding Map</h2>
 
 
 <a href="index.html">Back to Index</a>
@@ -21,7 +21,7 @@
 
   <tr>
     <td>Fl</td>
-    <td>FLTK.Event</td>
+    <td>FLTK.Events</td>
   </tr>
 
 </table>
@@ -38,7 +38,7 @@
 
   <tr>
     <td>Fl_Event_Dispatch</td>
-    <td>&nbsp;</td>
+    <td>Event_Dispatch</td>
   </tr>
 
 </table>
@@ -160,9 +160,32 @@ function Mouse_Right
 
   <tr>
 <td><pre>
+static int event_button4();
+</pre></td>
+<td><pre>
+function Mouse_Back
+    return Boolean;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+static int event_button5();
+</pre></td>
+<td><pre>
+function Mouse_Forward
+    return Boolean;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
 static int event_buttons();
 </pre></td>
-<td>&nbsp;</td>
+<td><pre>
+procedure Mouse_Buttons
+       (Left, Middle, Right, Back, Forward : out Boolean);
+</pre></td>
   </tr>
 
   <tr>
@@ -172,6 +195,9 @@ static int event_clicks();
 <td><pre>
 function Is_Multi_Click
     return Boolean;
+
+function Get_Clicks
+    return Natural;
 </pre></td>
   </tr>
 
@@ -189,14 +215,20 @@ procedure Set_Clicks
 <td><pre>
 static void * event_clipboard();
 </pre></td>
-<td>&nbsp;</td>
+<td><pre>
+function Clipboard_Text
+    return String;
+</pre></td>
   </tr>
 
   <tr>
 <td><pre>
 static const char * event_clipboard_type();
 </pre></td>
-<td>&nbsp;</td>
+<td><pre>
+function Clipboard_Kind
+    return String;
+</pre></td>
   </tr>
 
   <tr>
@@ -223,14 +255,20 @@ function Key_Ctrl
 <td><pre>
 static Fl_Event_Dispatch event_dispatch();
 </pre></td>
-<td>TBA</td>
+<td><pre>
+function Get_Dispatch
+    return Event_Dispatch;
+</pre></td>
   </tr>
 
   <tr>
 <td><pre>
 static void event_dispatch(Fl_Event_Dispatch d);
 </pre></td>
-<td>&nbsp;</td>
+<td><pre>
+procedure Set_Dispatch
+       (Func : in Event_Dispatch);
+</pre></td>
   </tr>
 
   <tr>
@@ -257,7 +295,11 @@ function Mouse_DY
 <td><pre>
 static int event_inside(const Fl_Widget *);
 </pre></td>
-<td>&nbsp;</td>
+<td><pre>
+function Is_Inside
+       (Child : in FLTK.Widgets.Widget'Class)
+    return Boolean;
+</pre></td>
   </tr>
 
   <tr>
@@ -285,7 +327,9 @@ function Is_Click
 <td><pre>
 static void event_is_click(int i);
 </pre></td>
-<td>See static void event_clicks(int i);</td>
+<td><pre>
+procedure Clear_Click;
+</pre></td>
   </tr>
 
   <tr>
@@ -475,6 +519,30 @@ procedure Set_Grab
 
   <tr>
 <td><pre>
+static int handle(int, Fl_Window *);
+</pre></td>
+<td><pre>
+function Handle_Dispatch
+       (Event  : in     Event_Kind;
+        Origin : in out FLTK.Widgets.Groups.Windows.Window'Class)
+    return Event_Outcome;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+static int handle_(int, Fl_Window *);
+</pre></td>
+<td><pre>
+function Handle
+       (Event  : in     Event_Kind;
+        Origin : in out FLTK.Widgets.Groups.Windows.Window'Class)
+    return Event_Outcome;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
 static Fl_Widget * pushed();
 </pre></td>
 <td><pre>
@@ -516,7 +584,11 @@ procedure Remove_Handler
 <td><pre>
 static int test_shortcut(Fl_Shortcut);
 </pre></td>
-<td>&nbsp;</td>
+<td><pre>
+function Test_Shortcut
+       (Shortcut : in Key_Combo)
+    return Boolean;
+</pre></td>
   </tr>
 
   <tr>
diff --git a/doc/fl_(fltk-screen).html b/doc/fl_(fltk-screen).html
index a5f8722..7d44273 100644
--- a/doc/fl_(fltk-screen).html
+++ b/doc/fl_(fltk-screen).html
@@ -28,11 +28,43 @@
 
 
 
+<table class="type">
+  <tr><th colspan="2">Types</th></tr>
+
+  <tr>
+    <td>Fl_Mode</td>
+    <td>Visual_Mode</td>
+  </tr>
+
+</table>
+
+
+
 <table class="function">
   <tr><th colspan="2">Static Functions and Procedures</th></tr>
 
   <tr>
 <td><pre>
+static int damage();
+</pre></td>
+<td><pre>
+function Is_Damaged
+    return Boolean;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+static void damage(int d);
+</pre></td>
+<td><pre>
+procedure Set_Damaged
+       (To : in Boolean);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
 static void display(const char *);
 </pre></td>
 <td><pre>
@@ -43,6 +75,15 @@ procedure Set_Display_String
 
   <tr>
 <td><pre>
+static void flush();
+</pre></td>
+<td><pre>
+procedure Flush;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
 static int h();
 </pre></td>
 <td><pre>
@@ -53,6 +94,15 @@ function Get_H
 
   <tr>
 <td><pre>
+static void redraw();
+</pre></td>
+<td><pre>
+procedure Redraw;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
 static int screen_count();
 </pre></td>
 <td><pre>
@@ -180,7 +230,14 @@ procedure Work_Area
 <td><pre>
 static int visual(int);
 </pre></td>
-<td>&nbsp;</td>
+<td><pre>
+procedure Set_Visual_Mode
+       (Value : in Visual_Mode);
+
+function Set_Visual_Mode
+       (Value : in Visual_Mode)
+    return Boolean;
+</pre></td>
   </tr>
 
   <tr>
diff --git a/doc/fl_(fltk-static).html b/doc/fl_(fltk-static).html
index 3afc53a..ac47474 100644
--- a/doc/fl_(fltk-static).html
+++ b/doc/fl_(fltk-static).html
@@ -132,20 +132,6 @@ static void (*atclose)(Fl_Window *, void *);
 
   <tr>
 <td><pre>
-static char const * const clipboard_image = "image";
-</pre></td>
-<td>&nbsp;</td>
-  </tr>
-
-  <tr>
-<td><pre>
-static char const * const clipboard_plain_text = "text/plain";
-</pre></td>
-<td>&nbsp;</td>
-  </tr>
-
-  <tr>
-<td><pre>
 static const char * const help = helpmsg + 13;
 </pre></td>
 <td>&nbsp;</td>
@@ -281,6 +267,15 @@ static int awake(Fl_Awake_Handler cb, void *message=0);
 
   <tr>
 <td><pre>
+static void awake(void *message=0);
+</pre></td>
+<td><pre>
+procedure Awake;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
 static void background(uchar, uchar, uchar);
 </pre></td>
 <td><pre>
@@ -603,6 +598,15 @@ function Is_Scheme
 
   <tr>
 <td><pre>
+static int lock();
+</pre></td>
+<td><pre>
+procedure Lock;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
 static Fl_Window * modal();
 </pre></td>
 <td><pre>
@@ -948,6 +952,22 @@ static void set_labeltype(Fl_Labeltype, Fl_Labeltype from);
 <td>&nbsp;</td>
   </tr>
 
+  <tr>
+<td><pre>
+static void * thread_message();
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+static void unlock();
+</pre></td>
+<td><pre>
+procedure Unlock;
+</pre></td>
+  </tr>
+
 </table>
 
 
diff --git a/doc/index.html b/doc/index.html
index 57ff15c..af2faf1 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -20,7 +20,7 @@
   <li><a href="filename.html">Filename</a></li>
   <li><a href="fl.html">Fl</a></li>
   <li><a href="fl_(fltk-errors).html">Fl (FLTK.Errors)</a></li>
-  <li><a href="fl_(fltk-event).html">Fl (FLTK.Event)</a></li>
+  <li><a href="fl_(fltk-events).html">Fl (FLTK.Events)</a></li>
   <li><a href="fl_(fltk-screen).html">Fl (FLTK.Screen)</a></li>
   <li><a href="fl_(fltk-static).html">Fl (FLTK.Static)</a></li>
   <li><a href="fl_adjuster.html">Fl_Adjuster</a></li>
@@ -161,7 +161,7 @@
   <li><a href="fl_draw.html">FLTK.Draw</a></li>
   <li><a href="fl_preferences.html">FLTK.Environment</a></li>
   <li><a href="fl_(fltk-errors).html">FLTK.Errors</a></li>
-  <li><a href="fl_(fltk-event).html">FLTK.Event</a></li>
+  <li><a href="fl_(fltk-events).html">FLTK.Events</a></li>
   <li><a href="fl_file_chooser.html">FLTK.File_Choosers</a></li>
   <li><a href="filename.html">FLTK.Filenames</a></li>
   <li><a href="fl_help_dialog.html">FLTK.Help_Dialogs</a></li>
author	Jedidiah Barber <contact@jedbarber.id.au>	2025-02-18 12:54:42 +1300
committer	Jedidiah Barber <contact@jedbarber.id.au>	2025-02-18 12:54:42 +1300
commit	d5fd3906e62969fce7fec7f2fccdc5a7436cbdbc (patch)
tree	3f21adf51a8ea3aa75111c6653a6c8612608c096 /doc
parent	36e546c1c9a9bb8e778fb637c17f94390b4d23c2 (diff)