diff options
Diffstat (limited to 'doc/fl_group.html')
| -rw-r--r-- | doc/fl_group.html | 206 |
1 files changed, 164 insertions, 42 deletions
diff --git a/doc/fl_group.html b/doc/fl_group.html index 123e05b..80f9406 100644 --- a/doc/fl_group.html +++ b/doc/fl_group.html @@ -1,4 +1,3 @@ - <!DOCTYPE html> <html lang="en"> @@ -14,6 +13,9 @@ <h2>Fl_Group Binding Map</h2> +<a href="index.html">Back to Index</a> + + <table class="package"> <tr><th colspan="2">Package name</th></tr> @@ -24,6 +26,11 @@ </table> +<p><b>Note:</b><br /><br /> +Groups automatically have end / End_Current called on them as part of their construction. +This is because otherwise the usual begin/end behaviour would get confusing with the style +of declaration this binding uses.</p> + <table class="type"> @@ -40,16 +47,21 @@ </tr> <tr> - <td> </td> + <td>int</td> <td>Index</td> </tr> <tr> - <td> </td> + <td>int</td> <td>Extended_Index</td> </tr> <tr> + <td>int</td> + <td>Clip_Mode</td> + </tr> + + <tr> <td> </td> <td>Cursor</td> </tr> @@ -59,7 +71,7 @@ <table class="function"> - <tr><th colspan="2">Functions and Procedures</th></tr> + <tr><th colspan="2">Constructors</th></tr> <tr> <td><pre> @@ -68,21 +80,68 @@ Fl_Group(int, int, int, int, const char *=0); <td><pre> function Create (X, Y, W, H : in Integer; - Text : in String) + Text : in String := "") return Group; </pre></td> </tr> <tr> +<td>Rely on the automatic use of begin when a group is created, or use begin/end +explicitly, or add each widget to its intended parent group manually.</td> +<td><pre> +function Create + (Parent : in out Group'Class; + X, Y, W, H : in Integer; + Text : in String := "") + return Group; +</pre></td> + </tr> + +</table> + + + +<table class="function"> + <tr><th colspan="2">Static Functions and Procedures</th></tr> + + <tr> +<td><pre> +static Fl_Group * current(); +</pre></td> +<td><pre> +function Get_Current + return access Group'Class; +</pre></td> + </tr> + + <tr> +<td><pre> +static void current(Fl_Group *g); +</pre></td> +<td><pre> +procedure Set_Current + (To : in Group'Class); +</pre></td> + </tr> + +</table> + + + +<table class="function"> + <tr><th colspan="2">Functions and Procedures</th></tr> + + <tr> <td><pre> Fl_Widget *& _ddfdesign_kludge(); </pre></td> -<td> </td> +<td>Intentionally left unbound.</td> </tr> <tr> <td><pre> void add(Fl_Widget &); + void add(Fl_Widget *o); </pre></td> <td><pre> @@ -96,32 +155,39 @@ procedure Add <td><pre> void add_resizable(Fl_Widget &o); </pre></td> -<td> </td> +<td><pre> +procedure Add_Resizable + (This : in out Group; + Item : in out Widget'Class); +</pre></td> </tr> <tr> <td><pre> Fl_Widget * const * array() const; </pre></td> -<td>Use iterators instead</td> +<td>Use iterators instead.</td> </tr> <tr> <td><pre> virtual Fl_Group * as_group(); </pre></td> -<td>Use runtime tag checks and view conversions instead</td> +<td>Use runtime tag checks and view conversions instead.</td> </tr> <tr> <td><pre> void begin(); </pre></td> -<td> </td> +<td><pre> +procedure Begin_Current + (This : in out Group); +</pre></td> </tr> <tr> -<td> </td> +<td>Check if the index value is in range manually.</td> <td><pre> function Has_Child (This : in Group; @@ -147,7 +213,8 @@ Fl_Widget * child(int n) const; function Child (This : in Group; Place : in Index) - return Widget_Reference; + return Widget_Reference +with Pre => This.Has_Child (Place); </pre></td> </tr> @@ -184,25 +251,23 @@ procedure Clear <tr> <td><pre> -void clip_children(int c); +unsigned int clip_children(); </pre></td> -<td>TBA</td> - </tr> - - <tr> <td><pre> -unsigned int clip_children(); +function Get_Clip_Mode + (This : in Group) + return Clip_Mode; </pre></td> -<td>TBA</td> </tr> <tr> <td><pre> -void draw(); +void clip_children(int c); </pre></td> <td><pre> -procedure Draw - (This : in out Group); +procedure Set_Clip_Mode + (This : in out Group; + Mode : in Clip_Mode := Clip); </pre></td> </tr> @@ -210,19 +275,23 @@ procedure Draw <td><pre> void end(); </pre></td> -<td> </td> +<td><pre> +procedure End_Current + (This : in out Group); +</pre></td> </tr> <tr> <td><pre> int find(const Fl_Widget *) const; + int find(const Fl_Widget &o) const; </pre></td> <td><pre> function Find - (This : in Group; - Item : in out Widget'Class) - return Index; + (This : in Group; + Item : in Widget'Class) + return Extended_Index; </pre></td> </tr> @@ -230,14 +299,14 @@ function Find <td><pre> void focus(Fl_Widget *W); </pre></td> -<td> </td> +<td>Deprecated, see take_focus / Take_Focus in Fl_Widget.</td> </tr> <tr> <td><pre> void forms_end(); </pre></td> -<td> </td> +<td>Intentionally left unbound.</td> </tr> <tr> @@ -257,7 +326,7 @@ function Handle void init_sizes(); </pre></td> <td><pre> -procedure Reset_Initial_Sizes +procedure Reset_Sizes (This : in out Group); </pre></td> </tr> @@ -287,7 +356,7 @@ procedure Insert </tr> <tr> -<td> </td> +<td>Use a for loop to iterate over the group's children.</td> <td><pre> function Iterate (This : in Group) @@ -309,6 +378,7 @@ procedure Remove <tr> <td><pre> void remove(Fl_Widget &); + void remove(Fl_Widget *o); </pre></td> <td><pre> @@ -320,7 +390,19 @@ procedure Remove <tr> <td><pre> +Fl_Widget * resizable() const; +</pre></td> +<td><pre> +function Get_Resizable + (This : in Group) + return access Widget'Class; +</pre></td> + </tr> + + <tr> +<td><pre> void resizable(Fl_Widget &o); + void resizable(Fl_Widget *o); </pre></td> <td><pre> @@ -332,39 +414,79 @@ procedure Set_Resizable <tr> <td><pre> -Fl_Widget * resizable() const; +void resize(int, int, int, int); </pre></td> <td><pre> -function Get_Resizable - (This : in Group) - return access Widget'Class; +procedure Resize + (This : in out Group; + X, Y, W, H : in Integer); </pre></td> </tr> +</table> + + + +<table class="function"> + <tr><th colspan="2">Protected Functions and Procedures</th></tr> + <tr> <td><pre> -void resize(int, int, int, int); +void draw(); +</pre></td> +<td><pre> +procedure Draw + (This : in out Group); </pre></td> -<td> </td> </tr> <tr> <td><pre> -static Fl_Group * current(); +void draw_child(Fl_Widget &widget) const; </pre></td> <td><pre> -function Get_Current - return access Group'Class; +procedure Draw_Child + (This : in out Group; + Item : in out Widget'Class); </pre></td> </tr> <tr> <td><pre> -static void current(Fl_Group *g); +void draw_children(); </pre></td> <td><pre> -procedure Set_Current - (To : in Group'Class); +procedure Draw_Children + (This : in out Group); +</pre></td> + </tr> + + <tr> +<td><pre> +void draw_outside_label(const Fl_Widget &widget) const; +</pre></td> +<td><pre> +procedure Draw_Outside_Label + (This : in out Group; + Item : in out Widget'Class); +</pre></td> + </tr> + + <tr> +<td><pre> +int * sizes(); +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + + <tr> +<td><pre> +void update_child(Fl_Widget &widget) const; +</pre></td> +<td><pre> +procedure Update_Child + (This : in out Group; + Item : in out Widget'Class); </pre></td> </tr> |