diff options
author | Jedidiah Barber <contact@jedbarber.id.au> | 2025-02-15 14:29:16 +1300 |
---|---|---|
committer | Jedidiah Barber <contact@jedbarber.id.au> | 2025-02-15 14:29:16 +1300 |
commit | 36e546c1c9a9bb8e778fb637c17f94390b4d23c2 (patch) | |
tree | 8f633a9c7439d099039432da167a882c7dddc3a7 /doc | |
parent | 446989277ad276e9820e54ea1fb4ed550b93e998 (diff) |
Reorganising Fl / FLTK, improving enum docs
Diffstat (limited to 'doc')
-rw-r--r-- | doc/enumerations.html | 13 | ||||
-rw-r--r-- | doc/fl.html | 123 | ||||
-rw-r--r-- | doc/fl_(fltk-event).html | 20 | ||||
-rw-r--r-- | doc/fl_(fltk-screen).html | 9 | ||||
-rw-r--r-- | doc/fl_(fltk-static).html | 141 | ||||
-rw-r--r-- | doc/fl_browser_.html | 9 | ||||
-rw-r--r-- | doc/fl_file_chooser.html | 6 | ||||
-rw-r--r-- | doc/fl_pack.html | 4 | ||||
-rw-r--r-- | doc/fl_scroll.html | 9 | ||||
-rw-r--r-- | doc/fl_text_display.html | 25 | ||||
-rw-r--r-- | doc/fl_widget.html | 10 |
11 files changed, 203 insertions, 166 deletions
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 @@ </tr> <tr> - <td>int</td> - <td>Version_Number</td> + <td>Fl_When</td> + <td>Callback_Flag</td> </tr> <tr> - <td>Fl_When</td> - <td>Callback_Flag (in FLTK.Widgets)</td> + <td>Fl_Damage</td> + <td>Damage_Mask</td> + </tr> + + <tr> + <td>int</td> + <td>Version_Number</td> </tr> </table> 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 @@ </tr> <tr> - <td>enum</td> + <td>enum {<br /> + FL_MENU_INACTIVE = 1,<br /> + FL_MENU_TOGGLE = 2,<br /> + FL_MENU_VALUE = 4,<br /> + FL_MENU_RADIO = 8,<br /> + FL_MENU_INVISIBLE = 0x10,<br /> + FL_SUBMENU_POINTER = 0x20,<br /> + FL_SUBMENU = 0x40,<br /> + FL_MENU_DIVIDER = 0x80,<br /> + FL_MENU_HORIZONTAL = 0x100 }<br /> + </td> <td>Menu_Flag</td> </tr> - <tr> - <td>Fl_Abort_Handler</td> - <td> </td> - </tr> - - <tr> - <td>Fl_Args_Handler</td> - <td> </td> - </tr> - - <tr> - <td>Fl_Atclose_Handler</td> - <td> </td> - </tr> - - <tr> - <td>Fl_Old_Idle_Handler</td> - <td> </td> - </tr> - </table> @@ -78,34 +68,6 @@ <table class="function"> - <tr><th colspan="2">Static Attributes</th></tr> - - <tr> -<td><pre> -static void (*atclose)(Fl_Window *, void *); -</pre></td> -<td>Deprecated, set the callback for the Window instead.</td> - </tr> - - <tr> -<td><pre> -static const char * const help = helpmsg + 13; -</pre></td> -<td> </td> - </tr> - - <tr> -<td><pre> -static void (*idle)(); -</pre></td> -<td>Should not be used directly.</td> - </tr> - -</table> - - - -<table class="function"> <tr><th colspan="2">Static Functions and Procedures</th></tr> <tr> @@ -141,27 +103,6 @@ function API_Version <tr> <td><pre> -static int arg(int argc, char **argv, int &i); -</pre></td> -<td> </td> - </tr> - - <tr> -<td><pre> -static int args(int argc, char **argv, int &i, Fl_Args_Handler cb=0); -</pre></td> -<td> </td> - </tr> - - <tr> -<td><pre> -static void args(int argc, char **argv); -</pre></td> -<td> </td> - </tr> - - <tr> -<td><pre> static void awake(void *message=0); </pre></td> <td><pre> @@ -171,13 +112,6 @@ procedure Awake; <tr> <td><pre> -static int awake(Fl_Awake_Handler cb, void *message=0); -</pre></td> -<td> </td> - </tr> - - <tr> -<td><pre> static void cairo_autolink_context(bool alink); </pre></td> <td> </td> @@ -257,6 +191,13 @@ static void delete_widget(Fl_Widget *w); <tr> <td><pre> +static void do_widget_deletion(); +</pre></td> +<td>Marked as internal use only.</td> + </tr> + + <tr> +<td><pre> static void flush(); </pre></td> <td><pre> @@ -327,27 +268,6 @@ function Run <tr> <td><pre> -static void set_abort(Fl_Abort_Handler f); -</pre></td> -<td>Marked as backwards compatibility only.</td> - </tr> - - <tr> -<td><pre> -static void set_atclose(Fl_Atclose_Handler f); -</pre></td> -<td>Marked as backwards compatibility only.</td> - </tr> - - <tr> -<td><pre> -static void set_idle(Fl_Old_Idle_Handler cb); -</pre></td> -<td>Deprecated, use add_idle / Add_Idle instead.</td> - </tr> - - <tr> -<td><pre> static void * thread_message(); </pre></td> <td> </td> @@ -397,13 +317,6 @@ function Version <tr> <td><pre> -static int visual(int); -</pre></td> -<td> </td> - </tr> - - <tr> -<td><pre> static int wait(); </pre></td> <td><pre> 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); <td> </td> </tr> + <tr> +<td><pre> +static int visible_focus(); +</pre></td> +<td><pre> +function Has_Visible_Focus + return Boolean; +</pre></td> + </tr> + + <tr> +<td><pre> +static void visible_focus(int v); +</pre></td> +<td><pre> +procedure Set_Visible_Focus + (To : in Boolean); +</pre></td> + </tr> + </table> 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 *); </pre></td> <td><pre> -procedure Set_Display_Var +procedure Set_Display_String (Value : in String); </pre></td> </tr> @@ -178,6 +178,13 @@ procedure Work_Area <tr> <td><pre> +static int visual(int); +</pre></td> +<td> </td> + </tr> + + <tr> +<td><pre> static int w(); </pre></td> <td><pre> 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 @@ <tr><th colspan="2">Types</th></tr> <tr> - <td>Fl_Awake_Handler</td> - <td>Awake_Handler</td> + <td>Fl_Abort_Handler</td> + <td> </td> </tr> <tr> - <td>Fl_Timeout_Handler</td> - <td>Timeout_Handler</td> + <td>Fl_Args_Handler</td> + <td> </td> + </tr> + + <tr> + <td>Fl_Atclose_Handler</td> + <td> </td> + </tr> + + <tr> + <td>Fl_Awake_Handler</td> + <td>Awake_Handler</td> </tr> <tr> @@ -47,6 +57,21 @@ </tr> <tr> + <td>Fl_Old_Idle_Handler</td> + <td> </td> + </tr> + + <tr> + <td>Fl_System_Handler</td> + <td> </td> + </tr> + + <tr> + <td>Fl_Timeout_Handler</td> + <td>Timeout_Handler</td> + </tr> + + <tr> <td>int</td> <td>Buffer_Kind</td> </tr> @@ -91,11 +116,6 @@ <td>Option</td> </tr> - <tr> - <td>Fl_System_Handler</td> - <td> </td> - </tr> - </table> @@ -105,6 +125,13 @@ <tr> <td><pre> +static void (*atclose)(Fl_Window *, void *); +</pre></td> +<td>Deprecated, set the callback for the Window instead.</td> + </tr> + + <tr> +<td><pre> static char const * const clipboard_image = "image"; </pre></td> <td> </td> @@ -117,6 +144,20 @@ static char const * const clipboard_plain_text = "text/plain"; <td> </td> </tr> + <tr> +<td><pre> +static const char * const help = helpmsg + 13; +</pre></td> +<td> </td> + </tr> + + <tr> +<td><pre> +static void (*idle)(); +</pre></td> +<td>Should not be used directly.</td> + </tr> + </table> @@ -191,7 +232,8 @@ procedure Add_Idle <tr> <td><pre> -static void add_system_handler(Fl_System_Handler h, void *data); +static void add_system_handler(Fl_System_Handler h, + void *data); </pre></td> <td> </td> </tr> @@ -210,6 +252,35 @@ procedure Add_Timeout <tr> <td><pre> +static int arg(int argc, char **argv, int &i); +</pre></td> +<td> </td> + </tr> + + <tr> +<td><pre> +static int args(int argc, char **argv, int &i, + Fl_Args_Handler cb=0); +</pre></td> +<td> </td> + </tr> + + <tr> +<td><pre> +static void args(int argc, char **argv); +</pre></td> +<td> </td> + </tr> + + <tr> +<td><pre> +static int awake(Fl_Awake_Handler cb, void *message=0); +</pre></td> +<td> </td> + </tr> + + <tr> +<td><pre> static void background(uchar, uchar, uchar); </pre></td> <td><pre> @@ -349,15 +420,6 @@ procedure Set_Drag_Drop_Text_Support <tr> <td><pre> -static void do_widget_deletion(); -</pre></td> -<td><pre> -procedure Do_Widget_Deletion; -</pre></td> - </tr> - - <tr> -<td><pre> static int draw_box_active(); </pre></td> <td><pre> @@ -781,6 +843,20 @@ static void selection_owner(Fl_Widget *); <tr> <td><pre> +static void set_abort(Fl_Abort_Handler f); +</pre></td> +<td>Marked as backwards compatibility only.</td> + </tr> + + <tr> +<td><pre> +static void set_atclose(Fl_Atclose_Handler f); +</pre></td> +<td>Marked as backwards compatibility only.</td> + </tr> + + <tr> +<td><pre> static void set_box_color(Fl_Color); </pre></td> <td> </td> @@ -788,7 +864,8 @@ static void set_box_color(Fl_Color); <tr> <td><pre> -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); </pre></td> <td> </td> </tr> @@ -851,36 +928,24 @@ procedure Setup_Fonts <tr> <td><pre> -static void set_labeltype(Fl_Labeltype, Fl_Label_Draw_F *, FL_Label_Measure_F *); +static void set_idle(Fl_Old_Idle_Handler cb); </pre></td> -<td> </td> +<td>Deprecated, use add_idle / Add_Idle instead.</td> </tr> <tr> <td><pre> -static void set_labeltype(Fl_Labeltype, Fl_Labeltype from); +static void set_labeltype(Fl_Labeltype, Fl_Label_Draw_F *, + FL_Label_Measure_F *); </pre></td> <td> </td> </tr> <tr> <td><pre> -static int visible_focus(); -</pre></td> -<td><pre> -function Has_Visible_Focus - return Boolean; -</pre></td> - </tr> - - <tr> -<td><pre> -static void visible_focus(int v); -</pre></td> -<td><pre> -procedure Set_Visible_Focus - (To : in Boolean); +static void set_labeltype(Fl_Labeltype, Fl_Labeltype from); </pre></td> +<td> </td> </tr> </table> 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.</p> </tr> <tr> - <td>enum mode</td> + <td>enum {<br /> + HORIZONTAL = 1,<br /> + VERTICAL = 2,<br /> + BOTH = 3,<br /> + ALWAYS_ON = 4,<br /> + HORIZONTAL_ALWAYS = 5,<br /> + VERTICAL_ALWAYS = 6,<br /> + BOTH_ALWAYS = 7 }</td> <td>Scrollbar_Mode</td> </tr> 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 </tr> <tr> - <td>enum {SINGLE=0, MULTI=1, CREATE=2, DIRECTORY=4}</td> + <td>enum {<br /> + SINGLE = 0,<br /> + MULTI = 1,<br /> + CREATE = 2,<br /> + DIRECTORY = 4 }</td> <td>Chooser_Kind</td> </tr> 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 @@ </tr> <tr> - <td>enum { VERTICAL = 0, HORIZONTAL = 1 }</td> + <td>enum {<br /> + VERTICAL = 0,<br /> + HORIZONTAL = 1 }</td> <td>Pack_Kind</td> </tr> 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 @@ </tr> <tr> - <td>enum { HORIZONTAL = 1, VERTICAL = 2, BOTH = 3, ALWAYS_ON = 4, HORIZONTAL_ALWAYS = 5, VERTICAL_ALWAYS = 6, BOTH_ALWAYS = 7 } + <td>enum {<br /> + HORIZONTAL = 1,<br /> + VERTICAL = 2,<br /> + BOTH = 3,<br /> + ALWAYS_ON = 4,<br /> + HORIZONTAL_ALWAYS = 5,<br /> + VERTICAL_ALWAYS = 6,<br /> + BOTH_ALWAYS = 7 } <td>Scroll_Kind</td> </tr> 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 @@ </tr> <tr> - <td>enum { NORMAL_CURSOR, CARET_CURSOR, DIM_CURSOR, BLOCK_CURSOR, HEAVY_CURSOR, SIMPLE_CURSOR }</td> + <td>enum {<br /> + NORMAL_CURSOR,<br /> + CARET_CURSOR,<br /> + DIM_CURSOR,<br /> + BLOCK_CURSOR,<br /> + HEAVY_CURSOR,<br /> + SIMPLE_CURSOR }</td> <td>Cursor_Style</td> </tr> <tr> - <td>enum { CURSOR_POS, CHARACTER_POS }</td> + <td>enum {<br /> + CURSOR_POS,<br /> + CHARACTER_POS }</td> <td>Position_Kind</td> </tr> <tr> - <td>enum { DRAG_NONE = -2, DRAG_START_DND = -1, DRAG_CHAR = 0, DRAG_WORD = 1, DRAG_LINE = 2 }</td> + <td>enum {<br /> + DRAG_NONE = -2,<br /> + DRAG_START_DND = -1,<br /> + DRAG_CHAR = 0,<br /> + DRAG_WORD = 1,<br /> + DRAG_LINE = 2 }</td> <td> </td> </tr> <tr> - <td>enum { WRAP_NONE, WRAP_AT_COLUMN, WRAP_AT_PIXEL, WRAP_AT_BOUNDS }</td> + <td>enum {<br /> + WRAP_NONE,<br /> + WRAP_AT_COLUMN,<br /> + WRAP_AT_PIXEL,<br /> + WRAP_AT_BOUNDS }</td> <td>Wrap_Mode</td> </tr> 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 @@ <td>Widget_Callback</td> </tr> - <tr> - <td>Fl_When (in Enumerations)</td> - <td>Callback_Flag</td> - </tr> - - <tr> - <td>uchar</td> - <td>Damage_Mask</td> - </tr> - </table> |