From 106316bcedec72c5380a7544c27be6a5c117e57a Mon Sep 17 00:00:00 2001 From: Jedidiah Barber Date: Wed, 15 Jan 2025 23:52:50 +1300 Subject: Filled holes in Fl_Menu_ and Fl_Menu_Item bound APIs, fixed a few irritating bugs, damn the treacherous C++ API --- doc/fl_menu_item.html | 150 +++++++++++++++++++++++++++++++------------------- 1 file changed, 94 insertions(+), 56 deletions(-) (limited to 'doc/fl_menu_item.html') diff --git a/doc/fl_menu_item.html b/doc/fl_menu_item.html index e64aec7..1fb05b3 100644 --- a/doc/fl_menu_item.html +++ b/doc/fl_menu_item.html @@ -41,6 +41,11 @@ Menu_Item_Reference + + Fl_Menu_Item * + Menu_Item_Array + + @@ -143,7 +148,7 @@ void activate(); 
 procedure Activate
-       (Item : in out Menu_Item);
+       (This : in out Menu_Item);
@@ -153,7 +158,7 @@ int active() const; 
 function Is_Active
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return Boolean;
@@ -164,7 +169,7 @@ int activevisible() const; 
 function Is_Active_And_Visible
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return Boolean;
@@ -174,7 +179,7 @@ function Is_Active_And_Visible int add(const char *, int shortcut, Fl_Callback *, void *=0, int=0); -See Add procedure in FLTK.Widgets.Menus +Use the Add subprograms in FLTK.Widgets.Menus instead. @@ -182,21 +187,21 @@ int add(const char *, int shortcut, Fl_Callback *, int add(const char *a, const char *b, Fl_Callback *c, void *d=0, int e=0); -  +Use the Add subprograms in FLTK.Widgets.Menus instead. 
 long argument() const;
-  +Not used in public API. 
 void argument(long v);
-  +Not used in public API. @@ -205,7 +210,7 @@ Fl_Callback_p callback() const; 
 function Get_Callback
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return FLTK.Widgets.Widget_Callback;
@@ -222,7 +227,7 @@ void callback(Fl_Callback1 *c, long p=0); 
 procedure Set_Callback
-       (Item : in out Menu_Item;
+       (This : in out Menu_Item;
         Func : in     FLTK.Widgets.Widget_Callback);
@@ -231,7 +236,7 @@ procedure Set_Callback 
 void check();
-  +Marked as deprecated. @@ -240,7 +245,7 @@ int checkbox() const; 
 function Has_Checkbox
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return Boolean;
@@ -249,7 +254,7 @@ function Has_Checkbox 
 int checked() const;
-  +Marked as deprecated. @@ -257,9 +262,8 @@ int checked() const; void clear(); 
-procedure Set_State
-       (Item : in out Menu_Item;
-        To   : in     Boolean);
+procedure Clear
+       (This : in out Menu_Item);
@@ -269,7 +273,7 @@ void deactivate(); 
 procedure Deactivate
-       (Item : in out Menu_Item);
+       (This : in out Menu_Item);
@@ -283,7 +287,7 @@ void do_callback(Fl_Widget *o, long arg) const; 
 procedure Do_Callback
-       (Item   : in out Menu_Item;
+       (This   : in out Menu_Item;
         Widget : in out FLTK.Widgets.Widget'Class);
@@ -293,7 +297,7 @@ procedure Do_Callback void draw(int x, int y, int w, int h, const Fl_Menu_ *, int t=0) const; -See Draw_Item procedure in FLTK.Widgets.Menus +See Draw_Item in FLTK.Widgets.Menus. @@ -301,7 +305,7 @@ void draw(int x, int y, int w, int h, const Fl_Menu_ *, const Fl_Menu_Item * find_shortcut(int *ip=0, const bool require_alt=false) const; -  +See Find_Shortcut in FLTK.Widgets.Menus. @@ -310,23 +314,23 @@ const Fl_Menu_Item * first() const; Fl_Menu_Item * first(); -Use FLTK.Widgets.Menus iterators instead +Iterate through FLTK.Widgets.Menus instead. -See Fl_Menu_ int mode(int i) const; +Access the flags attribute directly. 
 function Get_Flags
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return Menu_Flag;
-See Fl_Menu_ void mode(int i, int fl); +Assign to the flags attribute directly. 
 procedure Set_Flags
-       (Item : in out Menu_Item;
+       (This : in out Menu_Item;
         To   : in     Menu_Flag);
@@ -337,7 +341,16 @@ void hide(); 
 procedure Hide
-       (Item : in out Menu_Item);
+       (This : in out Menu_Item);
+
+ + + +Fl_Menu_Item is missing a method for getting the image set to it. +
+function Get_Image
+       (This : in Menu_Item)
+    return access FLTK.Images.Image'Class;
@@ -347,7 +360,11 @@ void image(Fl_Image *a); void image(Fl_Image &a); -  +
+procedure Set_Image
+       (This : in out Menu_Item;
+        Pict : in out FLTK.Images.Image'Class);
+
@@ -355,7 +372,7 @@ void image(Fl_Image &a); int insert(int, const char *, int, Fl_Callback *, void *=0, int=0); -See Insert procedure in FLTK.Widgets.Menus +Use the Insert subprograms in FLTK.Widgets.Menus instead. @@ -364,7 +381,7 @@ const char * label() const; 
 function Get_Label
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return String;
@@ -375,7 +392,7 @@ void label(const char *a); 
 procedure Set_Label
-       (Item : in out Menu_Item;
+       (This : in out Menu_Item;
         Text : in     String);
@@ -384,7 +401,12 @@ procedure Set_Label 
 void label(Fl_Labeltype a, const char *b);
-  +
+procedure Set_Label
+       (This : in out Menu_Item;
+        Kind : in     Label_Kind;
+        Text : in     String);
+
@@ -393,7 +415,7 @@ Fl_Color labelcolor() const; 
 function Get_Label_Color
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return Color;
@@ -404,7 +426,7 @@ void labelcolor(Fl_Color a); 
 procedure Set_Label_Color
-       (Item : in out Menu_Item;
+       (This : in out Menu_Item;
         To   : in     Color);
@@ -415,7 +437,7 @@ Fl_Font labelfont() const; 
 function Get_Label_Font
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return Font_Kind;
@@ -426,7 +448,7 @@ void labelfont(Fl_Font a); 
 procedure Set_Label_Font
-       (Item : in out Menu_Item;
+       (This : in out Menu_Item;
         To   : in     Font_Kind);
@@ -437,7 +459,7 @@ Fl_Fontsize labelsize() const; 
 function Get_Label_Size
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return Font_Size;
@@ -448,7 +470,7 @@ void labelsize(Fl_Fontsize a); 
 procedure Set_Label_Size
-       (Item : in out Menu_Item;
+       (This : in out Menu_Item;
         To   : in     Font_Size);
@@ -459,7 +481,7 @@ Fl_Labeltype labeltype() const; 
 function Get_Label_Type
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return Label_Kind;
@@ -470,7 +492,7 @@ void labeltype(Fl_Labeltype a); 
 procedure Set_Label_Type
-       (Item : in out Menu_Item;
+       (This : in out Menu_Item;
         To   : in     Label_Kind);
@@ -479,7 +501,7 @@ procedure Set_Label_Type 
 int measure(int *h, const Fl_Menu_ *) const;
-See Measure_Item procedure in FLTK.Widgets.Menus +See Measure_Item in FLTK.Widgets.Menus. @@ -488,7 +510,7 @@ const Fl_Menu_Item * next(int=1) const; Fl_Menu_Item * next(int i=1); -Use FLTK.Widgets.Menus iterators instead +Iterate through FLTK.Widgets.Menus instead. @@ -497,7 +519,7 @@ const Fl_Menu_Item * popup (int X, int Y, const char *title=0, const Fl_Menu_Item *picked=0, const Fl_Menu_*=0) const; -See Popup function in FLTK.Widgets.Menus +See Popup in FLTK.Widgets.Menus. @@ -507,7 +529,7 @@ const Fl_Menu_Item * pulldown const Fl_Menu_Item *picked=0, const Fl_Menu_*=0, const Fl_Menu_Item *title=0, int menubar=0) const; -See Pulldown function in FLTK.Widgets.Menus +See Pulldown in FLTK.Widgets.Menus. @@ -516,7 +538,7 @@ int radio() const; 
 function Is_Radio
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return Boolean;
@@ -525,7 +547,10 @@ function Is_Radio 
 void set();
-See void clear(); +
+procedure Set
+       (This : in out Menu_Item);
+
@@ -534,7 +559,7 @@ void setonly(); 
 procedure Set_Only
-       (Item : in out Menu_Item);
+       (This : in out Menu_Item);
@@ -544,7 +569,7 @@ int shortcut() const; 
 function Get_Shortcut
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return Key_Combo;
@@ -555,7 +580,7 @@ void shortcut(int s); 
 procedure Set_Shortcut
-       (Item : in out Menu_Item;
+       (This : in out Menu_Item;
         To   : in     Key_Combo);
@@ -566,7 +591,7 @@ void show(); 
 procedure Show
-       (Item : in out Menu_Item);
+       (This : in out Menu_Item);
@@ -574,42 +599,46 @@ procedure Show 
 int size() const;
-See Number_Of_Items function in FLTK.Widgets.Menus +Use the Number_Of_Items function in FLTK.Widgets.Menus instead. 
 int submenu() const;
-  +
+function Is_Submenu
+       (This : in Menu_Item)
+    return Boolean;
+
 const Fl_Menu_Item * test_shortcut() const;
-  +Use the Test_Shortcut function in FLTK.Widgets.Menus instead. 
 void uncheck();
-  +Marked as deprecated. 
 void * user_data() const;
-  +Not used in public API. 
 void user_data(void *v);
-  +Not used in public API. @@ -618,18 +647,27 @@ int value() const; 
 function Get_State
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return Boolean;
+ +Use set or clear methods. +
+procedure Set_State
+       (This : in out Menu_Item;
+        To   : in     Boolean);
+
+ + 
 int visible() const;
 
 function Is_Visible
-       (Item : in Menu_Item)
+       (This : in Menu_Item)
     return Boolean;
-- cgit