Finished and polished FLTK.Menu_Items

author: Jed Barber <jjbarber@y7mail.com> 2018-05-04 02:07:02 +1000
committer: Jed Barber <jjbarber@y7mail.com> 2018-05-04 02:07:02 +1000
commit: 6e8b2cd87a74ac8d1366775186f35268837523e1 (patch)
tree: 418696736aa9ff94446796688fc7f3b905e2e84f /doc
parent: 6bb8375e7f8f5a888b0fa800ba09c1e5a950399d (diff)
1 files changed, 532 insertions, 0 deletions
diff --git a/doc/fl_menu_item.html b/doc/fl_menu_item.html
new file mode 100644
index 0000000..d259fb5
--- /dev/null
+++ b/doc/fl_menu_item.html
@@ -0,0 +1,532 @@
+
+<!DOCTYPE html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Fl_Menu_Item Binding Map</title>
+    <link href="map.css" rel="stylesheet">
+  </head>
+
+  <body>
+
+
+<h2>Fl_Menu_Item Binding Map</h2>
+
+
+<table class="package">
+  <tr><th colspan="2">Package name</th></tr>
+
+  <tr>
+    <td>Fl_Menu_Item</td>
+    <td>FLTK.Menu_Items</td>
+  </tr>
+
+</table>
+
+
+
+<table class="type">
+  <tr><th colspan="2">Types</th></tr>
+
+  <tr>
+    <td>Fl_Menu_Item</td>
+    <td>Menu_Item</td>
+  </tr>
+
+  <tr>
+    <td>&nbsp;</td>
+    <td>Menu_Item_Reference</td>
+  </tr>
+
+</table>
+
+
+
+<table class="function">
+  <tr><th colspan="2">Functions and Procedures</th></tr>
+
+  <tr>
+<td>N/A due to being a struct, not a class</td>
+<td><pre>
+function Create
+       (Text        : in String;
+        Action      : in FLTK.Widgets.Widget_Callback := null;
+        Shortcut    : in Key_Combo := No_Key;
+        Flags       : in Menu_Flag := Flag_Normal)
+    return Menu_Item;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void activate();
+</pre></td>
+<td><pre>
+procedure Activate
+       (Item : in out Menu_Item);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int active() const;
+</pre></td>
+<td><pre>
+function Is_Active
+       (Item : in Menu_Item)
+    return Boolean;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int activevisible() const;
+</pre></td>
+<td><pre>
+function Is_Active_And_Visible
+       (Item : in Menu_Item)
+    return Boolean;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int add(const char *, int shortcut, Fl_Callback *, void *=0, int=0);
+</pre></td>
+<td>See Fl_Menu</td>
+  </tr>
+
+  <tr>
+<td><pre>
+int add(const char *a, const char *b, Fl_Callback *c, void *d=0, int e=0);
+</pre></td>
+<td>See Fl_Menu</td>
+  </tr>
+
+  <tr>
+<td><pre>
+long argument() const;
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+void argument(long v);
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+Fl_Callback_p callback() const;
+</pre></td>
+<td><pre>
+function Get_Callback
+       (Item : in Menu_Item)
+    return FLTK.Widgets.Widget_Callback;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void callback(Fl_Callback *c, void *p);
+void callback(Fl_Callback *c);
+void callback(Fl_Callback0 *c);
+void callback(Fl_Callback1 *c, long p=0);
+</pre></td>
+<td><pre>
+procedure Set_Callback
+       (Item : in out Menu_Item;
+        Func : in     FLTK.Widgets.Widget_Callback);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void check();
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+int checkbox() const;
+</pre></td>
+<td><pre>
+function Has_Checkbox
+       (Item : in Menu_Item)
+    return Boolean;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int checked() const;
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+void clear();
+</pre></td>
+<td><pre>
+procedure Set_State
+       (Item : in out Menu_Item;
+        To   : in     Boolean);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void deactivate();
+</pre></td>
+<td><pre>
+procedure Deactivate
+       (Item : in out Menu_Item);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void do_callback(Fl_Widget *o) const;
+void do_callback(Fl_Widget *o, void *arg) const;
+void do_callback(Fl_Widget *o, long arg) const;
+</pre></td>
+<td><pre>
+procedure Do_Callback
+       (Item   : in out Menu_Item;
+        Widget : in out FLTK.Widgets.Widget'Class);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void draw(int x, int y, int w, int h, const Fl_Menu_ *, int t=0) const;
+</pre></td>
+<td>See Fl_Menu</td>
+  </tr>
+
+  <tr>
+<td><pre>
+const Fl_Menu_Item * find_shortcut(int *ip=0, const bool require_alt=false) const;
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+const Fl_Menu_Item * first() const;
+Fl_Menu_Item * first();
+</pre></td>
+<td>See Fl_Menu</td>
+  </tr>
+
+  <tr>
+<td><pre>
+void hide();
+</pre></td>
+<td><pre>
+procedure Hide
+       (Item : in out Menu_Item);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void image(Fl_Image *a);
+void image(Fl_Image &a);
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+int insert(int, const char *, int, Fl_Callback *, void *=0, int=0);
+</pre></td>
+<td>See Fl_Menu</td>
+  </tr>
+
+  <tr>
+<td><pre>
+const char * label() const;
+</pre></td>
+<td><pre>
+function Get_Label
+       (Item : in Menu_Item)
+    return String;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void label(const char *a);
+</pre></td>
+<td><pre>
+procedure Set_Label
+       (Item : in out Menu_Item;
+        Text : in     String);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void label(Fl_Labeltype a, const char *b);
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+Fl_Color labelcolor() const;
+</pre></td>
+<td><pre>
+function Get_Label_Color
+       (Item : in Menu_Item)
+    return Color;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void labelcolor(Fl_Color a);
+</pre></td>
+<td><pre>
+procedure Set_Label_Color
+       (Item : in out Menu_Item;
+        To   : in     Color);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+Fl_Font labelfont() const;
+</pre></td>
+<td><pre>
+function Get_Label_Font
+       (Item : in Menu_Item)
+    return Font_Kind;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void labelfont(Fl_Font a);
+</pre></td>
+<td><pre>
+procedure Set_Label_Font
+       (Item : in out Menu_Item;
+        To   : in     Font_Kind);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+Fl_Fontsize labelsize() const;
+</pre></td>
+<td><pre>
+function Get_Label_Size
+       (Item : in Menu_Item)
+    return Font_Size;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void labelsize(Fl_Fontsize a);
+</pre></td>
+<td><pre>
+procedure Set_Label_Size
+       (Item : in out Menu_Item;
+        To   : in     Font_Size);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+Fl_Labeltype labeltype() const;
+</pre></td>
+<td><pre>
+function Get_Label_Type
+       (Item : in Menu_Item)
+    return Label_Kind;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void labeltype(Fl_Labeltype a);
+</pre></td>
+<td><pre>
+procedure Set_Label_Type
+       (Item : in out Menu_Item;
+        To   : in     Label_Kind);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int measure(int *h, const Fl_Menu_ *) const;
+</pre></td>
+<td>See Fl_Menu</td>
+  </tr>
+
+  <tr>
+<td><pre>
+const Fl_Menu_Item * next(int=1) const;
+Fl_Menu_Item * next(int i=1);
+</pre></td>
+<td>See Fl_Menu</td>
+  </tr>
+
+  <tr>
+<td><pre>
+const Fl_Menu_Item * popup
+   (int X, int Y, const char *title=0,
+    const Fl_Menu_Item *picked=0, const Fl_Menu_*=0) const;
+</pre></td>
+<td>See Fl_Menu</td>
+  </tr>
+
+  <tr>
+<td><pre>
+const Fl_Menu_Item * pulldown
+   (int X, int Y, int W, int H,
+    const Fl_Menu_Item *picked=0, const Fl_Menu_*=0,
+    const Fl_Menu_Item *title=0, int menubar=0) const;
+</pre></td>
+<td>See Fl_Menu</td>
+  </tr>
+
+  <tr>
+<td><pre>
+int radio() const;
+</pre></td>
+<td><pre>
+function Is_Radio
+       (Item : in Menu_Item)
+    return Boolean;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void set();
+</pre></td>
+<td>See void clear();</td>
+  </tr>
+
+  <tr>
+<td><pre>
+void setonly();
+</pre></td>
+<td><pre>
+procedure Set_Only
+       (Item : in out Menu_Item);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int shortcut() const;
+</pre></td>
+<td><pre>
+function Get_Shortcut
+       (Item : in Menu_Item)
+    return Key_Combo;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void shortcut(int s);
+</pre></td>
+<td><pre>
+procedure Set_Shortcut
+       (Item : in out Menu_Item;
+        To   : in     Key_Combo);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void show();
+</pre></td>
+<td><pre>
+procedure Show
+       (Item : in out Menu_Item);
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int size() const;
+</pre></td>
+<td>See Fl_Menu</td>
+  </tr>
+
+  <tr>
+<td><pre>
+int submenu() const;
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+const Fl_Menu_Item * test_shortcut() const;
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+void uncheck();
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+void * user_data() const;
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+void user_data(void *v);
+</pre></td>
+<td>&nbsp;</td>
+  </tr>
+
+  <tr>
+<td><pre>
+int value() const;
+</pre></td>
+<td><pre>
+function Get_State
+       (Item : in Menu_Item)
+    return Boolean;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int visible() const;
+</pre></td>
+<td><pre>
+function Is_Visible
+       (Item : in Menu_Item)
+    return Boolean;
+</pre></td>
+  </tr>
+
+</table>
+
+
+  </body>
+</html>
+
author	Jed Barber <jjbarber@y7mail.com>	2018-05-04 02:07:02 +1000
committer	Jed Barber <jjbarber@y7mail.com>	2018-05-04 02:07:02 +1000
commit	6e8b2cd87a74ac8d1366775186f35268837523e1 (patch)
tree	418696736aa9ff94446796688fc7f3b905e2e84f /doc
parent	6bb8375e7f8f5a888b0fa800ba09c1e5a950399d (diff)