diff options
Diffstat (limited to 'doc/fl_window.html')
| -rw-r--r-- | doc/fl_window.html | 369 |
1 files changed, 289 insertions, 80 deletions
diff --git a/doc/fl_window.html b/doc/fl_window.html index a1a5bb8..4f246b3 100644 --- a/doc/fl_window.html +++ b/doc/fl_window.html @@ -1,4 +1,3 @@ - <!DOCTYPE html> <html lang="en"> @@ -14,6 +13,9 @@ <h2>Fl_Window Binding Map</h2> +<a href="index.html">Back to Index</a> + + <table class="package"> <tr><th colspan="2">Package name</th></tr> @@ -41,17 +43,35 @@ <tr> <td> </td> - <td>Border_State</td> + <td>Modal_State</td> </tr> +</table> + + + +<table class="function"> + <tr><th colspan="2">Static Protected Attributes</th></tr> + <tr> - <td> </td> - <td>Modal_State</td> +<td><pre> +static Fl_Window * current_; +</pre></td> +<td>Intentionally left unbound.</td> </tr> +</table> + + + +<table class="function"> + <tr><th colspan="2">Protected Attributes</th></tr> + <tr> - <td> </td> - <td>Cursor</td> +<td><pre> +shape_data_type * shape_data_; +</pre></td> +<td>Intentionally left unbound.</td> </tr> </table> @@ -59,7 +79,7 @@ <table class="function"> - <tr><th colspan="2">Functions and Procedures</th></tr> + <tr><th colspan="2">Constructors</th></tr> <tr> <td><pre> @@ -68,7 +88,19 @@ Fl_Window(int w, int h, const char *title=0); <td><pre> function Create (W, H : in Integer; - Text : in String) + Text : in String := "") + return Window; +</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 Groups.Group'Class; + W, H : in Integer; + Text : in String := "") return Window; </pre></td> </tr> @@ -80,72 +112,153 @@ Fl_Window(int x, int y, int w, int h, const char *title=0); <td><pre> function Create (X, Y, W, H : in Integer; - Text : in String) + Text : in String := "") return Window; </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> -virtual Fl_Window * as_window(); +function Create + (Parent : in out Groups.Group'Class; + X, Y, W, H : in Integer; + Text : in String := "") + return Window; </pre></td> -<td>Use view conversion and tag membership tests instead</td> </tr> +</table> + + + +<table class="function"> + <tr><th colspan="2">Static Functions and Procedures</th></tr> + <tr> <td><pre> -void border(int b); +static Fl_Window * current(); </pre></td> <td><pre> -procedure Set_Border_State - (This : in out Window; - To : in Border_State); +function Last_Made_Current + return access Window'Class; </pre></td> </tr> <tr> <td><pre> +static void default_callback(Fl_Window *, void *v); +</pre></td> +<td>Back compatibility only, see default_atclose / Default_Window_Close in FLTK.</td> + </tr> + + <tr> +<td><pre> +static void default_icon(const Fl_RGB_Image *); +</pre></td> +<td><pre> +procedure Set_Default_Icon + (Pic : in FLTK.Images.RGB.RGB_Image'Class); +</pre></td> + </tr> + + <tr> +<td><pre> +static void default_icons(const Fl_RGB_Image *[], int); +</pre></td> +<td><pre> +procedure Set_Default_Icons + (Pics : in FLTK.Images.RGB.RGB_Image_Array); + +procedure Reset_Default_Icons; +</pre></td> + </tr> + + <tr> +<td><pre> +static const char * default_xclass(); +</pre></td> +<td><pre> +function Get_Default_X_Class + return String; +</pre></td> + </tr> + + <tr> +<td><pre> +static void default_xclass(const char *); +</pre></td> +<td><pre> +procedure Set_Default_X_Class + (Value : in String); +</pre></td> + </tr> + +</table> + + + +<table class="function"> + <tr><th colspan="2">Functions and Procedures</th></tr> + + <tr> +<td><pre> +virtual Fl_Window * as_window(); +</pre></td> +<td>Use view conversion and tag membership tests instead.</td> + </tr> + + <tr> +<td><pre> unsigned int border() const; </pre></td> <td><pre> -function Get_Border_State +function Has_Border (This : in Window) - return Border_State; + return Boolean; </pre></td> </tr> <tr> <td><pre> -void clear_border(); +void border(int b); +</pre></td> +<td><pre> +procedure Set_Border + (This : in out Window; + Value : in Boolean := True); </pre></td> -<td> </td> </tr> <tr> <td><pre> -void clear_modal_states(); +void clear_border(); </pre></td> <td><pre> -procedure Set_Modal_State - (This : in out Window; - To : in Modal_State); +procedure Clear_Border + (This : in out Window); </pre></td> </tr> <tr> <td><pre> -void copy_label(const char *a); +void clear_modal_states(); +</pre></td> +<td><pre> +procedure Clear_Modal_State + (This : in out Window); </pre></td> -<td> </td> </tr> <tr> <td><pre> -static Fl_Window * current(); +void copy_label(const char *a); </pre></td> <td><pre> -function Last_Made_Current - return access Window'Class; +procedure Set_Label + (This : in out Window; + Text : in String); </pre></td> </tr> @@ -156,7 +269,7 @@ void cursor(Fl_Cursor); <td><pre> procedure Set_Cursor (This : in out Window; - To : in Cursor); + To : in Mouse_Cursor); </pre></td> </tr> @@ -167,7 +280,7 @@ void cursor(const Fl_RGB_Image *, int, int); <td><pre> procedure Set_Cursor (This : in out Window; - Pic : in out FLTK.Images.RGB.RGB_Image'Class; + Pic : in FLTK.Images.RGB.RGB_Image'Class; Hot_X, Hot_Y : in Integer); </pre></td> </tr> @@ -176,7 +289,7 @@ procedure Set_Cursor <td><pre> void cursor(Fl_Cursor c, Fl_Color, Fl_Color=FL_WHITE); </pre></td> -<td> </td> +<td>Use cursor(Fl_Cursor) / Set_Cursor instead.</td> </tr> <tr> @@ -208,7 +321,7 @@ void default_cursor(Fl_Cursor); <td><pre> procedure Set_Default_Cursor (This : in out Window; - To : in Cursor); + To : in Mouse_Cursor); </pre></td> </tr> @@ -216,37 +329,14 @@ procedure Set_Default_Cursor <td><pre> void default_cursor(Fl_Cursor c, Fl_Color, Fl_Color=FL_WHITE); </pre></td> -<td> </td> - </tr> - - <tr> -<td><pre> -static void default_icon(const Fl_RGB_Image *); -</pre></td> -<td><pre> -procedure Set_Default_Icon - (Pic : in out FLTK.Images.RGB.RGB_Image'Class); -</pre></td> - </tr> - - <tr> -<td><pre> -virtual void draw(); -</pre></td> -<td><pre> -procedure Draw - (This : in out Window); -</pre></td> +<td>Use default_cursor(Fl_Cursor) / Set_Default_Cursor instead.</td> </tr> <tr> <td><pre> void free_position(); </pre></td> -<td><pre> -procedure Free_Position - (This : in out Window); -</pre></td> +<td>Marked as deprecated.</td> </tr> <tr> @@ -339,6 +429,7 @@ procedure Hotspot <tr> <td><pre> void hotspot(const Fl_Widget *, int offscreen=0); + void hotspot(const Fl_Widget &p, int offscreen=0); </pre></td> <td><pre> @@ -356,7 +447,7 @@ void icon(const Fl_RGB_Image *); <td><pre> procedure Set_Icon (This : in out Window; - Pic : in out FLTK.Images.RGB.RGB_Image'Class); + Pic : in FLTK.Images.RGB.RGB_Image'Class); </pre></td> </tr> @@ -364,14 +455,14 @@ procedure Set_Icon <td><pre> const void * icon() const; </pre></td> -<td> </td> +<td>Marked as deprecated.</td> </tr> <tr> <td><pre> void icon(const void *ic); </pre></td> -<td> </td> +<td>Marked as deprecated.</td> </tr> <tr> @@ -410,7 +501,14 @@ procedure Set_Icon_Label <td><pre> void icons(const Fl_RGB_Image *[], int); </pre></td> -<td> </td> +<td><pre> +procedure Set_Icons + (This : in out Window; + Pics : in FLTK.Images.RGB.RGB_Image_Array); + +procedure Reset_Icons + (This : in out Window); +</pre></td> </tr> <tr> @@ -428,18 +526,20 @@ function Get_Label <td><pre> void label(const char *); </pre></td> -<td><pre> -procedure Set_Label - (This : in out Window; - Text : in String); -</pre></td> +<td>Due to the marshalling between String and char * using +this method would be pointless, so its functionality is +subsumed by copy_label / Set_Label.</td> </tr> <tr> <td><pre> void label(const char *label, const char *iconlabel); </pre></td> -<td> </td> +<td><pre> +procedure Set_Labels + (This : in out Window; + Text, Icon_Text : in String); +</pre></td> </tr> <tr> @@ -456,7 +556,11 @@ procedure Make_Current <td><pre> unsigned int menu_window() const; </pre></td> -<td>Use tag membership tests instead</td> +<td><pre> +function Is_Menu_Window + (This : in Window) + return Boolean; +</pre></td> </tr> <tr> @@ -464,6 +568,15 @@ unsigned int menu_window() const; unsigned int modal() const; </pre></td> <td><pre> +function Is_Modal + (This : in Window) + return Boolean; +</pre></td> + </tr> + + <tr> +<td>Use modal, non_modal as appropriate.</td> +<td><pre> function Get_Modal_State (This : in Window) return Modal_State; @@ -474,7 +587,11 @@ function Get_Modal_State <td><pre> unsigned int non_modal() const; </pre></td> -<td>See unsigned int modal() const;</td> +<td><pre> +function Is_Non_Modal + (This : in Window) + return Boolean; +</pre></td> </tr> <tr> @@ -492,28 +609,47 @@ function Is_Override <td><pre> virtual void resize(int X, int Y, int W, int H); </pre></td> -<td> </td> +<td><pre> +procedure Resize + (This : in out Window; + X, Y, W, H : in Integer); +</pre></td> </tr> <tr> <td><pre> void set_menu_window(); </pre></td> -<td> </td> +<td>Intended for internal use only.</td> </tr> <tr> <td><pre> void set_modal(); </pre></td> -<td>See void clear_modal_states();</td> +<td><pre> +procedure Set_Modal + (This : in out Window); +</pre></td> + </tr> + + <tr> +<td>Use clear_modal_states, set_modal, set_non_modal as appropriate.</td> +<td><pre> +procedure Set_Modal_State + (This : in out Window; + Value : in Modal_State); +</pre></td> </tr> <tr> <td><pre> void set_non_modal(); </pre></td> -<td>See void clear_modal_states();</td> +<td><pre> +procedure Set_Non_Modal + (This : in out Window); +</pre></td> </tr> <tr> @@ -530,18 +666,19 @@ procedure Set_Override <td><pre> void set_tooltip_window(); </pre></td> -<td> </td> +<td>Intended for internal use only.</td> </tr> <tr> <td><pre> void shape(const Fl_Image *img); + void shape(const Fl_Image &b); </pre></td> <td><pre> procedure Shape (This : in out Window; - Pic : in out FLTK.Images.Image'Class); + Pic : in FLTK.Images.Image'Class); </pre></td> </tr> @@ -559,7 +696,10 @@ procedure Show <td><pre> void show(int argc, char **argv); </pre></td> -<td> </td> +<td><pre> +procedure Show_With_Args + (This : in out Window); +</pre></td> </tr> <tr> @@ -575,7 +715,8 @@ function Is_Shown <tr> <td><pre> -void size_range(int minw, int minh, int maxw=0, int maxh=0, int dw=0, int dh=0, int aspect=0); +void size_range(int minw, int minh, int maxw=0, int maxh=0, + int dw=0, int dh=0, int aspect=0); </pre></td> <td><pre> procedure Set_Size_Range @@ -590,7 +731,11 @@ procedure Set_Size_Range <td><pre> unsigned int tooltip_window() const; </pre></td> -<td> </td> +<td><pre> +function Is_Tooltip_Window + (This : in Window) + return Boolean; +</pre></td> </tr> <tr> @@ -618,14 +763,22 @@ function Get_X_Root <td><pre> const char * xclass() const; </pre></td> -<td> </td> +<td><pre> +function Get_X_Class + (This : in Window) + return String; +</pre></td> </tr> <tr> <td><pre> void xclass(const char *c); </pre></td> -<td> </td> +<td><pre> +procedure Set_X_Class + (This : in out Window; + Value : in String); +</pre></td> </tr> <tr> @@ -642,6 +795,62 @@ function Get_Y_Root </table> + +<table class="function"> + <tr><th colspan="2">Protected Functions and Procedures</th></tr> + + <tr> +<td><pre> +virtual void draw(); +</pre></td> +<td><pre> +procedure Draw + (This : in out Window); +</pre></td> + </tr> + + <tr> +<td><pre> +virtual void flush(); +</pre></td> +<td><pre> +procedure Flush + (This : in out Window); +</pre></td> + </tr> + + <tr> +<td><pre> +int force_position() const; +</pre></td> +<td><pre> +function Is_Position_Forced + (This : in Window) + return Boolean; +</pre></td> + </tr> + + <tr> +<td><pre> +void force_position(int force); +</pre></td> +<td><pre> +procedure Force_Position + (This : in out Window; + State : in Boolean := True); +</pre></td> + </tr> + + <tr> +<td><pre> +void free_icons(); +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + +</table> + + </body> </html> |