diff options
Diffstat (limited to 'doc/fl_menu_item.html')
| -rw-r--r-- | doc/fl_menu_item.html | 262 |
1 files changed, 196 insertions, 66 deletions
diff --git a/doc/fl_menu_item.html b/doc/fl_menu_item.html index cca7528..a09cfe7 100644 --- a/doc/fl_menu_item.html +++ b/doc/fl_menu_item.html @@ -1,4 +1,3 @@ - <!DOCTYPE html> <html lang="en"> @@ -14,6 +13,9 @@ <h2>Fl_Menu_Item Binding Map</h2> +<a href="index.html">Back to Index</a> + + <table class="package"> <tr><th colspan="2">Package name</th></tr> @@ -39,15 +41,90 @@ <td>Menu_Item_Reference</td> </tr> + <tr> + <td>Fl_Menu_Item *</td> + <td>Menu_Item_Array</td> + </tr> + </table> <table class="function"> - <tr><th colspan="2">Functions and Procedures</th></tr> + <tr><th colspan="2">Attributes</th></tr> + + <tr> +<td><pre> +Fl_Callback * callback_; +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + + <tr> +<td><pre> +int flags; +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + + <tr> +<td><pre> +Fl_Color labelcolor_; +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + + <tr> +<td><pre> +Fl_Font labelfont_; +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + + <tr> +<td><pre> +Fl_Fontsize labelsize_; +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + + <tr> +<td><pre> +uchar labeltype_; +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + + <tr> +<td><pre> +int shortcut_; +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + + <tr> +<td><pre> +const char * text; +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + + <tr> +<td><pre> +void * user_data_; +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + +</table> + + + +<table class="function"> + <tr><th colspan="2">Constructors</th></tr> <tr> -<td>N/A due to being a struct, not a class</td> +<td>Initialize manually as per any other struct.</td> <td><pre> function Create (Text : in String; @@ -58,13 +135,20 @@ function Create </pre></td> </tr> +</table> + + + +<table class="function"> + <tr><th colspan="2">Functions and Procedures</th></tr> + <tr> <td><pre> void activate(); </pre></td> <td><pre> procedure Activate - (Item : in out Menu_Item); + (This : in out Menu_Item); </pre></td> </tr> @@ -74,7 +158,7 @@ int active() const; </pre></td> <td><pre> function Is_Active - (Item : in Menu_Item) + (This : in Menu_Item) return Boolean; </pre></td> </tr> @@ -85,37 +169,39 @@ int activevisible() const; </pre></td> <td><pre> function Is_Active_And_Visible - (Item : in Menu_Item) + (This : in Menu_Item) return Boolean; </pre></td> </tr> <tr> <td><pre> -int add(const char *, int shortcut, Fl_Callback *, void *=0, int=0); +int add(const char *, int shortcut, Fl_Callback *, + void *=0, int=0); </pre></td> -<td>See Add procedure in FLTK.Widgets.Menus</td> +<td>Use the Add subprograms in FLTK.Widgets.Menus instead.</td> </tr> <tr> <td><pre> -int add(const char *a, const char *b, Fl_Callback *c, void *d=0, int e=0); +int add(const char *a, const char *b, Fl_Callback *c, + void *d=0, int e=0); </pre></td> -<td> </td> +<td>Use the Add subprograms in FLTK.Widgets.Menus instead.</td> </tr> <tr> <td><pre> long argument() const; </pre></td> -<td> </td> +<td>Not used in public API.</td> </tr> <tr> <td><pre> void argument(long v); </pre></td> -<td> </td> +<td>Not used in public API.</td> </tr> <tr> @@ -124,7 +210,7 @@ Fl_Callback_p callback() const; </pre></td> <td><pre> function Get_Callback - (Item : in Menu_Item) + (This : in Menu_Item) return FLTK.Widgets.Widget_Callback; </pre></td> </tr> @@ -132,13 +218,16 @@ function Get_Callback <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; + (This : in out Menu_Item; Func : in FLTK.Widgets.Widget_Callback); </pre></td> </tr> @@ -147,7 +236,7 @@ procedure Set_Callback <td><pre> void check(); </pre></td> -<td> </td> +<td>Marked as deprecated.</td> </tr> <tr> @@ -156,7 +245,7 @@ int checkbox() const; </pre></td> <td><pre> function Has_Checkbox - (Item : in Menu_Item) + (This : in Menu_Item) return Boolean; </pre></td> </tr> @@ -165,7 +254,7 @@ function Has_Checkbox <td><pre> int checked() const; </pre></td> -<td> </td> +<td>Marked as deprecated.</td> </tr> <tr> @@ -173,9 +262,8 @@ int checked() const; void clear(); </pre></td> <td><pre> -procedure Set_State - (Item : in out Menu_Item; - To : in Boolean); +procedure Clear + (This : in out Menu_Item); </pre></td> </tr> @@ -185,59 +273,64 @@ void deactivate(); </pre></td> <td><pre> procedure Deactivate - (Item : in out Menu_Item); + (This : 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; + (This : 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; +void draw(int x, int y, int w, int h, const Fl_Menu_ *, + int t=0) const; </pre></td> -<td>See Draw_Item procedure in FLTK.Widgets.Menus</td> +<td>See Draw_Item in FLTK.Widgets.Menus.</td> </tr> <tr> <td><pre> -const Fl_Menu_Item * find_shortcut(int *ip=0, const bool require_alt=false) const; +const Fl_Menu_Item * find_shortcut(int *ip=0, + const bool require_alt=false) const; </pre></td> -<td> </td> +<td>See Find_Shortcut in FLTK.Widgets.Menus.</td> </tr> <tr> <td><pre> const Fl_Menu_Item * first() const; + Fl_Menu_Item * first(); </pre></td> -<td>Use FLTK.Widgets.Menus iterators instead</td> +<td>Iterate through FLTK.Widgets.Menus instead.</td> </tr> <tr> -<td>See Fl_Menu_ int mode(int i) const;</td> +<td>Access the flags attribute directly.</td> <td><pre> function Get_Flags - (Item : in Menu_Item) + (This : in Menu_Item) return Menu_Flag; </pre></td> </tr> <tr> -<td>See Fl_Menu_ void mode(int i, int fl);</td> +<td>Assign to the flags attribute directly.</td> <td><pre> procedure Set_Flags - (Item : in out Menu_Item; + (This : in out Menu_Item; To : in Menu_Flag); </pre></td> </tr> @@ -248,23 +341,38 @@ void hide(); </pre></td> <td><pre> procedure Hide - (Item : in out Menu_Item); + (This : in out Menu_Item); +</pre></td> + </tr> + + <tr> +<td>Fl_Menu_Item is missing a method for getting the image set to it.</td> +<td><pre> +function Get_Image + (This : in Menu_Item) + return access FLTK.Images.Image'Class; </pre></td> </tr> <tr> <td><pre> void image(Fl_Image *a); + void image(Fl_Image &a); </pre></td> -<td> </td> +<td><pre> +procedure Set_Image + (This : in out Menu_Item; + Pict : in out FLTK.Images.Image'Class); +</pre></td> </tr> <tr> <td><pre> -int insert(int, const char *, int, Fl_Callback *, void *=0, int=0); +int insert(int, const char *, int, Fl_Callback *, + void *=0, int=0); </pre></td> -<td>See Insert procedure in FLTK.Widgets.Menus</td> +<td>Use the Insert subprograms in FLTK.Widgets.Menus instead.</td> </tr> <tr> @@ -273,7 +381,7 @@ const char * label() const; </pre></td> <td><pre> function Get_Label - (Item : in Menu_Item) + (This : in Menu_Item) return String; </pre></td> </tr> @@ -284,7 +392,7 @@ void label(const char *a); </pre></td> <td><pre> procedure Set_Label - (Item : in out Menu_Item; + (This : in out Menu_Item; Text : in String); </pre></td> </tr> @@ -293,7 +401,12 @@ procedure Set_Label <td><pre> void label(Fl_Labeltype a, const char *b); </pre></td> -<td> </td> +<td><pre> +procedure Set_Label + (This : in out Menu_Item; + Kind : in Label_Kind; + Text : in String); +</pre></td> </tr> <tr> @@ -302,7 +415,7 @@ Fl_Color labelcolor() const; </pre></td> <td><pre> function Get_Label_Color - (Item : in Menu_Item) + (This : in Menu_Item) return Color; </pre></td> </tr> @@ -313,7 +426,7 @@ void labelcolor(Fl_Color a); </pre></td> <td><pre> procedure Set_Label_Color - (Item : in out Menu_Item; + (This : in out Menu_Item; To : in Color); </pre></td> </tr> @@ -324,7 +437,7 @@ Fl_Font labelfont() const; </pre></td> <td><pre> function Get_Label_Font - (Item : in Menu_Item) + (This : in Menu_Item) return Font_Kind; </pre></td> </tr> @@ -335,7 +448,7 @@ void labelfont(Fl_Font a); </pre></td> <td><pre> procedure Set_Label_Font - (Item : in out Menu_Item; + (This : in out Menu_Item; To : in Font_Kind); </pre></td> </tr> @@ -346,7 +459,7 @@ Fl_Fontsize labelsize() const; </pre></td> <td><pre> function Get_Label_Size - (Item : in Menu_Item) + (This : in Menu_Item) return Font_Size; </pre></td> </tr> @@ -357,7 +470,7 @@ void labelsize(Fl_Fontsize a); </pre></td> <td><pre> procedure Set_Label_Size - (Item : in out Menu_Item; + (This : in out Menu_Item; To : in Font_Size); </pre></td> </tr> @@ -367,8 +480,8 @@ procedure Set_Label_Size Fl_Labeltype labeltype() const; </pre></td> <td><pre> -function Get_Label_Type - (Item : in Menu_Item) +function Get_Label_Kind + (This : in Menu_Item) return Label_Kind; </pre></td> </tr> @@ -378,8 +491,8 @@ function Get_Label_Type void labeltype(Fl_Labeltype a); </pre></td> <td><pre> -procedure Set_Label_Type - (Item : in out Menu_Item; +procedure Set_Label_Kind + (This : in out Menu_Item; To : in Label_Kind); </pre></td> </tr> @@ -388,15 +501,16 @@ procedure Set_Label_Type <td><pre> int measure(int *h, const Fl_Menu_ *) const; </pre></td> -<td>See Measure_Item procedure in FLTK.Widgets.Menus</td> +<td>See Measure_Item in FLTK.Widgets.Menus.</td> </tr> <tr> <td><pre> const Fl_Menu_Item * next(int=1) const; + Fl_Menu_Item * next(int i=1); </pre></td> -<td>Use FLTK.Widgets.Menus iterators instead</td> +<td>Iterate through FLTK.Widgets.Menus instead.</td> </tr> <tr> @@ -405,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; </pre></td> -<td>See Popup function in FLTK.Widgets.Menus</td> +<td>See Popup in FLTK.Widgets.Menus.</td> </tr> <tr> @@ -415,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; </pre></td> -<td>See Pulldown function in FLTK.Widgets.Menus</td> +<td>See Pulldown in FLTK.Widgets.Menus.</td> </tr> <tr> @@ -424,7 +538,7 @@ int radio() const; </pre></td> <td><pre> function Is_Radio - (Item : in Menu_Item) + (This : in Menu_Item) return Boolean; </pre></td> </tr> @@ -433,7 +547,10 @@ function Is_Radio <td><pre> void set(); </pre></td> -<td>See void clear();</td> +<td><pre> +procedure Set + (This : in out Menu_Item); +</pre></td> </tr> <tr> @@ -442,7 +559,7 @@ void setonly(); </pre></td> <td><pre> procedure Set_Only - (Item : in out Menu_Item); + (This : in out Menu_Item); </pre></td> </tr> @@ -452,7 +569,7 @@ int shortcut() const; </pre></td> <td><pre> function Get_Shortcut - (Item : in Menu_Item) + (This : in Menu_Item) return Key_Combo; </pre></td> </tr> @@ -463,7 +580,7 @@ void shortcut(int s); </pre></td> <td><pre> procedure Set_Shortcut - (Item : in out Menu_Item; + (This : in out Menu_Item; To : in Key_Combo); </pre></td> </tr> @@ -474,7 +591,7 @@ void show(); </pre></td> <td><pre> procedure Show - (Item : in out Menu_Item); + (This : in out Menu_Item); </pre></td> </tr> @@ -482,42 +599,46 @@ procedure Show <td><pre> int size() const; </pre></td> -<td>See Number_Of_Items function in FLTK.Widgets.Menus</td> +<td>Use the Number_Of_Items function in FLTK.Widgets.Menus instead.</td> </tr> <tr> <td><pre> int submenu() const; </pre></td> -<td> </td> +<td><pre> +function Is_Submenu + (This : in Menu_Item) + return Boolean; +</pre></td> </tr> <tr> <td><pre> const Fl_Menu_Item * test_shortcut() const; </pre></td> -<td> </td> +<td>Use the Test_Shortcut function in FLTK.Widgets.Menus instead.</td> </tr> <tr> <td><pre> void uncheck(); </pre></td> -<td> </td> +<td>Marked as deprecated.</td> </tr> <tr> <td><pre> void * user_data() const; </pre></td> -<td> </td> +<td>Not used in public API.</td> </tr> <tr> <td><pre> void user_data(void *v); </pre></td> -<td> </td> +<td>Not used in public API.</td> </tr> <tr> @@ -526,18 +647,27 @@ int value() const; </pre></td> <td><pre> function Get_State - (Item : in Menu_Item) + (This : in Menu_Item) return Boolean; </pre></td> </tr> <tr> +<td>Use set or clear methods.</td> +<td><pre> +procedure Set_State + (This : in out Menu_Item; + To : in Boolean); +</pre></td> + </tr> + + <tr> <td><pre> int visible() const; </pre></td> <td><pre> function Is_Visible - (Item : in Menu_Item) + (This : in Menu_Item) return Boolean; </pre></td> </tr> |