From a4b6a06f372923fb38ae4d3c7e0429ce93ea7748 Mon Sep 17 00:00:00 2001 From: Jed Barber Date: Sun, 15 Apr 2018 19:41:33 +1000 Subject: Started process of polishing packages --- doc/blank_template.html | 55 +++++++++ doc/fl_box.html | 85 +++++++++++++ doc/fl_button.html | 203 +++++++++++++++++++++++++++++++ doc/fl_check_button.html | 83 +++++++++++++ doc/fl_light_button.html | 87 ++++++++++++++ doc/fl_radio_button.html | 83 +++++++++++++ doc/fl_radio_light_button.html | 83 +++++++++++++ doc/fl_radio_round_button.html | 83 +++++++++++++ doc/fl_repeat_button.html | 85 +++++++++++++ doc/fl_return_button.html | 87 ++++++++++++++ doc/fl_round_button.html | 83 +++++++++++++ doc/fl_toggle_button.html | 83 +++++++++++++ doc/fl_tooltip.html | 265 +++++++++++++++++++++++++++++++++++++++++ doc/map.css | 38 ++++++ 14 files changed, 1403 insertions(+) create mode 100644 doc/blank_template.html create mode 100644 doc/fl_box.html create mode 100644 doc/fl_button.html create mode 100644 doc/fl_check_button.html create mode 100644 doc/fl_light_button.html create mode 100644 doc/fl_radio_button.html create mode 100644 doc/fl_radio_light_button.html create mode 100644 doc/fl_radio_round_button.html create mode 100644 doc/fl_repeat_button.html create mode 100644 doc/fl_return_button.html create mode 100644 doc/fl_round_button.html create mode 100644 doc/fl_toggle_button.html create mode 100644 doc/fl_tooltip.html create mode 100644 doc/map.css (limited to 'doc') diff --git a/doc/blank_template.html b/doc/blank_template.html new file mode 100644 index 0000000..256c469 --- /dev/null +++ b/doc/blank_template.html @@ -0,0 +1,55 @@ + + + + + + + Binding Map + + + + + + +

Binding Map

+ + + + + + + + +
Package name
+ + + + + + + + + + +
Types
+ + + + + + + + + + + +
Functions and Procedures
+
+
+
+
+ + + + + diff --git a/doc/fl_box.html b/doc/fl_box.html new file mode 100644 index 0000000..3f5c5f8 --- /dev/null +++ b/doc/fl_box.html @@ -0,0 +1,85 @@ + + + + + + + Fl_Box Binding Map + + + + + + +

Fl_Box Binding Map

+ + + + + + + + + +
Package name
Fl_BoxFLTK.Widgets.Boxes
+ + + + + + + + + + + + + + + +
Types
Fl_BoxBox
 Box_Reference
+ + + + + + + + + + + + + + + + + + + + +
Functions and Procedures
+Fl_Box (int X, int Y, int W, int H, const char *l=0);
+
+function Create
+       (X, Y, W, H : in Integer;
+        Text       : in String)
+    return Box;
+
+virtual int handle(int);
+
+function Handle
+       (This  : in out Box;
+        Event : in     Event_Kind)
+    return Event_Outcome;
+
+void draw();
+
+procedure Draw
+       (This : in out Box);
+
+ + + + + diff --git a/doc/fl_button.html b/doc/fl_button.html new file mode 100644 index 0000000..be21c60 --- /dev/null +++ b/doc/fl_button.html @@ -0,0 +1,203 @@ + + + + + + + Fl_Button Binding Map + + + + + + +

Fl_Button Binding Map

+ + + + + + + + + +
Package name
Fl_ButtonFLTK.Widgets.Buttons
+ + + + + + + + + + + + + + + + + + + + + +
Types
Fl_ButtonButton
 Button_Reference
 State
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Functions and Procedures
+Fl_Button(int X, int Y, int W, int H, const char *L=0);
+
+function Create
+       (X, Y, W, H : in Integer;
+        Text       : in String)
+    return Button;
+
+int clear();
+
See int value();
+Fl_Boxtype down_box() const;
+
+function Get_Down_Box
+       (This : in Button)
+    return Box_Kind;
+
+void down_box(Fl_Boxtype b);
+
+procedure Set_Down_Box
+       (This : in out Button;
+        To   : in     Box_Kind);
+
+Fl_Color down_color() const;
+
 
+void down_color(unsigned c);
+
 
+virtual void draw();
+
+procedure Draw
+       (This : in out Button);
+
+virtual int handle(int);
+
+function Handle
+       (This  : in out Button;
+        Event : in     Event_Kind)
+    return Event_Outcome;
+
+int set();
+
See int value();
+void setonly();
+
+procedure Set_Only
+       (This : in out Button);
+
+int shortcut() const;
+
+function Get_Shortcut
+       (This : in Button)
+    return Shortcut_Key;
+
+void shortcut(int s);
+
+procedure Set_Shortcut
+       (This : in out Button;
+        Key  : in     Shortcut_Key);
+
+void shortcut(const char *s);
+
See void shortcut(int s);
+int value(int v);
+
+procedure Set_State
+       (This : in out Button;
+        St   : in     State);
+
+char value() const;
+
+function Get_State
+       (This : in Button)
+    return State;
+
+ + + + + diff --git a/doc/fl_check_button.html b/doc/fl_check_button.html new file mode 100644 index 0000000..22405bd --- /dev/null +++ b/doc/fl_check_button.html @@ -0,0 +1,83 @@ + + + + + + + Fl_Check_Button Binding Map + + + + + + +

Fl_Check_Button Binding Map

+ + + + + + + + + +
Package name
Fl_Check_ButtonFLTK.Widgets.Buttons.Light.Check
+ + + + + + + + + + + + + + + + +
Types
Fl_Check_ButtonCheck_Button
 Check_Button_Reference
+ + + + + + + + + + + + + + + + + + + + + +
Functions and Procedures
+Fl_Check_Button(int X, int Y, int W, int H, const char *L=0);
+
+function Create
+       (X, Y, W, H : in Integer;
+        Text       : in String)
+    return Check_Button;
+
 
+procedure Draw
+       (This : in out Check_Button);
+
 
+function Handle
+       (This  : in out Check_Button;
+        Event : in     Event_Kind)
+    return Event_Outcome;
+
+ + + + + diff --git a/doc/fl_light_button.html b/doc/fl_light_button.html new file mode 100644 index 0000000..521d1be --- /dev/null +++ b/doc/fl_light_button.html @@ -0,0 +1,87 @@ + + + + + + + Fl_Light_Button Binding Map + + + + + + +

Fl_Light_Button Binding Map

+ + + + + + + + + +
Package name
Fl_Light_ButtonFLTK.Widgets.Buttons.Light
+ + + + + + + + + + + + + + + + +
Types
Fl_Light_ButtonLight_Button
 Light_Button_Reference
+ + + + + + + + + + + + + + + + + + + + + +
Functions and Procedures
+Fl_Light_Button(int X, int Y, int W, int H, const char *L=0);
+
+function Create
+       (X, Y, W, H : in Integer;
+        Text       : in String)
+    return Light_Button;
+
+void draw();
+
+procedure Draw
+       (This : in out Light_Button);
+
+int handle(int);
+
+function Handle
+       (This  : in out Light_Button;
+        Event : in     Event_Kind)
+    return Event_Outcome;
+
+ + + + + diff --git a/doc/fl_radio_button.html b/doc/fl_radio_button.html new file mode 100644 index 0000000..03f2f92 --- /dev/null +++ b/doc/fl_radio_button.html @@ -0,0 +1,83 @@ + + + + + + + Fl_Radio_Button Binding Map + + + + + + +

Fl_Radio_Button Binding Map

+ + + + + + + + + +
Package name
Fl_Radio_ButtonFLTK.Widgets.Buttons.Radio
+ + + + + + + + + + + + + + + + +
Types
Fl_Radio_ButtonRadio_Button
 Radio_Button_Reference
+ + + + + + + + + + + + + + + + + + + + + +
Functions and Procedures
+Fl_Radio_Button(int X, int Y, int W, int H, const char *L=0);
+
+function Create
+       (X, Y, W, H : in Integer;
+        Text       : in String)
+    return Radio_Button;
+
 
+procedure Draw
+       (This : in out Radio_Button);
+
 
+function Handle
+       (This  : in out Radio_Button;
+        Event : in     Event_Kind)
+    return Event_Outcome;
+
+ + + + + diff --git a/doc/fl_radio_light_button.html b/doc/fl_radio_light_button.html new file mode 100644 index 0000000..bde57e4 --- /dev/null +++ b/doc/fl_radio_light_button.html @@ -0,0 +1,83 @@ + + + + + + + Fl_Radio_Light_Button Binding Map + + + + + + +

Fl_Radio_Light_Button Binding Map

+ + + + + + + + + +
Package name
Fl_Radio_Light_ButtonFLTK.Widgets.Buttons.Light.Radio
+ + + + + + + + + + + + + + + + +
Types
Fl_Radio_Light_ButtonRadio_Light_Button
 Radio_Light_Button_Reference
+ + + + + + + + + + + + + + + + + + + + + +
Functions and Procedures
+Fl_Radio_Light_Button(int X, int Y, int W, int H, const char *L=0);
+
+function Create
+       (X, Y, W, H : in Integer;
+        Text       : in String)
+    return Radio_Light_Button;
+
 
+procedure Draw
+       (This : in out Radio_Light_Button);
+
 
+function Handle
+       (This  : in out Radio_Light_Button;
+        Event : in     Event_Kind)
+    return Event_Outcome;
+
+ + + + + diff --git a/doc/fl_radio_round_button.html b/doc/fl_radio_round_button.html new file mode 100644 index 0000000..3cd67dd --- /dev/null +++ b/doc/fl_radio_round_button.html @@ -0,0 +1,83 @@ + + + + + + + Fl_Radio_Round_Button Binding Map + + + + + + +

Fl_Radio_Round_Button Binding Map

+ + + + + + + + + +
Package name
Fl_Radio_Round_ButtonFLTK.Widgets.Buttons.Light.Round.Radio
+ + + + + + + + + + + + + + + + +
Types
Fl_Radio_Round_ButtonRadio_Round_Button
 Radio_Round_Button_Reference
+ + + + + + + + + + + + + + + + + + + + + +
Functions and Procedures
+Fl_Radio_Round_Button(int X, int Y, int W, int H, const char *L=0);
+
+function Create
+       (X, Y, W, H : in Integer;
+        Text       : in String)
+    return Radio_Round_Button;
+
 
+procedure Draw
+       (This : in out Radio_Round_Button);
+
 
+function Handle
+       (This  : in out Radio_Round_Button;
+        Event : in     Event_Kind)
+    return Event_Outcome;
+
+ + + + + diff --git a/doc/fl_repeat_button.html b/doc/fl_repeat_button.html new file mode 100644 index 0000000..852a1ce --- /dev/null +++ b/doc/fl_repeat_button.html @@ -0,0 +1,85 @@ + + + + + + + Fl_Repeat_Button Binding Map + + + + + + +

Fl_Repeat_Button Binding Map

+ + + + + + + + + +
Package name
Fl_Repeat_ButtonFLTK.Widgets.Buttons.Repeat
+ + + + + + + + + + + + + + + + +
Types
Fl_Repeat_ButtonRepeat_Button
 Repeat_Button_Reference
+ + + + + + + + + + + + + + + + + + + + + +
Functions and Procedures
+Fl_Repeat_Button(int X, int Y, int W, int H, const char *L=0);
+
+function Create
+       (X, Y, W, H : in Integer;
+        Text       : in String)
+    return Repeat_Button;
+
 
+procedure Draw
+       (This : in out Repeat_Button);
+
+int handle(int);
+
+function Handle
+       (This  : in out Repeat_Button;
+        Event : in     Event_Kind)
+    return Event_Outcome;
+
+ + + + + diff --git a/doc/fl_return_button.html b/doc/fl_return_button.html new file mode 100644 index 0000000..2bbfac0 --- /dev/null +++ b/doc/fl_return_button.html @@ -0,0 +1,87 @@ + + + + + + + Fl_Return_Button Binding Map + + + + + + +

Fl_Return_Button Binding Map

+ + + + + + + + + +
Package name
Fl_Return_ButtonFLTK.Widgets.Buttons.Enter
+ + + + + + + + + + + + + + + + +
Types
Fl_Return_ButtonEnter_Button
 Enter_Button_Reference
+ + + + + + + + + + + + + + + + + + + + + +
Functions and Procedures
+Fl_Return_Button(int X, int Y, int W, int H, const char *L=0);
+
+function Create
+       (X, Y, W, H : in Integer;
+        Text       : in String)
+    return Enter_Button;
+
+void draw();
+
+procedure Draw
+       (This : in out Enter_Button);
+
+int handle(int);
+
+function Handle
+       (This  : in out Enter_Button;
+        Event : in     Event_Kind)
+    return Event_Outcome;
+
+ + + + + diff --git a/doc/fl_round_button.html b/doc/fl_round_button.html new file mode 100644 index 0000000..cc780f7 --- /dev/null +++ b/doc/fl_round_button.html @@ -0,0 +1,83 @@ + + + + + + + Fl_Round_Button Binding Map + + + + + + +

Fl_Round_Button Binding Map

+ + + + + + + + + +
Package name
Fl_Round_ButtonFLTK.Widgets.Buttons.Light.Round
+ + + + + + + + + + + + + + + + +
Types
Fl_Round_ButtonRound_Button
 Round_Button_Reference
+ + + + + + + + + + + + + + + + + + + + + +
Functions and Procedures
+Fl_Round_Button(int X, int Y, int W, int H, const char *L=0);
+
+function Create
+       (X, Y, W, H : in Integer;
+        Text       : in String)
+    return Round_Button;
+
 
+procedure Draw
+       (This : in out Round_Button);
+
 
+function Handle
+       (This  : in out Round_Button;
+        Event : in     Event_Kind)
+    return Event_Outcome;
+
+ + + + + diff --git a/doc/fl_toggle_button.html b/doc/fl_toggle_button.html new file mode 100644 index 0000000..1696895 --- /dev/null +++ b/doc/fl_toggle_button.html @@ -0,0 +1,83 @@ + + + + + + + Fl_Toggle_Button Binding Map + + + + + + +

Fl_Toggle_Button Binding Map

+ + + + + + + + + +
Package name
Fl_Toggle_ButtonFLTK.Widgets.Buttons.Toggle
+ + + + + + + + + + + + + + + + +
Types
Fl_Toggle_ButtonToggle_Button
 Toggle_Button_Reference
+ + + + + + + + + + + + + + + + + + + + + +
Functions and Procedures
+Fl_Toggle_Button(int X, int Y, int W, int H, const char *L=0);
+
+function Create
+       (X, Y, W, H : in Integer;
+        Text       : in String)
+    return Toggle_Button;
+
 
+procedure Draw
+       (This : in out Toggle_Button);
+
 
+function Handle
+       (This  : in out Toggle_Button;
+        Event : in     Event_Kind)
+    return Event_Outcome;
+
+ + + + + diff --git a/doc/fl_tooltip.html b/doc/fl_tooltip.html new file mode 100644 index 0000000..9c72207 --- /dev/null +++ b/doc/fl_tooltip.html @@ -0,0 +1,265 @@ + + + + + + + Fl_Tooltip Binding Map + + + + + + +

Fl_Tooltip Binding Map

+ + + + + + + + + +
Package name
Fl_TooltipFLTK.Tooltips
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Functions and Procedures
+static Fl_Color color();
+
+function Get_Background_Color
+    return Color;
+
+static void color(Fl_Color c);
+
+procedure Set_Background_Color
+       (To : in Color);
+
+static Fl_Widget * current();
+
+function Get_Target
+    return access FLTK.Widgets.Widget'Class;
+
+static void current(Fl_Widget *);
+
+procedure Set_Target
+       (To : in FLTK.Widgets.Widget'Class);
+
+static float delay();
+
+function Get_Delay
+    return Float;
+
+static void delay(float f);
+
+procedure Set_Delay
+       (To : in Float);
+
+static void disable();
+
See static void enable(int b=1);
+static void enable(int b=1);
+
+procedure Set_Enabled
+       (To : in Boolean);
+
+static int enabled();
+
+function Is_Enabled
+    return Boolean;
+
+static void enter_area(Fl_Widget *w, int X, int Y, int W, int H, const char *tip);
+
+procedure Enter_Area
+       (Item       : in FLTK.Widgets.Widget'Class;
+        X, Y, W, H : in Integer;
+        Tip        : in String);
+
+static Fl_Font font();
+
+function Get_Text_Font
+    return Font_Kind;
+
+static void font(Fl_Font i);
+
+procedure Set_Text_Font
+       (To : in Font_Kind);
+
+static float hoverdelay();
+
+function Get_Hover_Delay
+    return Float;
+
+static void hoverdelay(float f);
+
+procedure Set_Hover_Delay
+       (To : in Float);
+
+static int margin_height();
+
+function Get_Margin_Height
+    return Natural;
+
+static void margin_height(int v);
+
Disabled pending ABI version check bugfix in FLTK
+static int margin_width();
+
+function Get_Margin_Width
+    return Natural;
+
+static void margin_width(int v);
+
Disabled pending ABI version check bugfix in FLTK
+static Fl_Fontsize size();
+
+function Get_Text_Size
+    return Font_Size;
+
+static void size(Fl_Fontsize s);
+
+procedure Set_Text_Size
+       (To : in Font_Size);
+
+static Fl_Color textcolor();
+
+function Get_Text_Color
+    return Color;
+
+static void textcolor(Fl_Color c);
+
+procedure Set_Text_Color
+       (To : in Color);
+
+static int wrap_width();
+
+function Get_Wrap_Width
+    return Natural;
+
+static void wrap_width(int v);
+
Disabled pending ABI version check bugfix in FLTK
+ + + + + diff --git a/doc/map.css b/doc/map.css new file mode 100644 index 0000000..98513fe --- /dev/null +++ b/doc/map.css @@ -0,0 +1,38 @@ + + +body { + width: 90%; + margin-left: 2em; + margin-right: 2em; +} + + +table.package, table.type { + min-width: 30%; +} + +table.function { + min-width: 60%; +} + +table { + margin-top: 4em; + margin-bottom: 4em; + border: 1px solid black; +} + + +th { + padding-top: 0.5em; + padding-bottom: 0.5em; + border: 1px solid black; +} + + +td { + width: 50%; + padding: 0.5em 0.5em 0.5em 0.5em; + border: 1px solid black; +} + + -- cgit