<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Fl_Window Binding Map</title>
<link href="map.css" rel="stylesheet">
</head>
<body>
<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>
<tr>
<td>Fl_Window</td>
<td>FLTK.Widgets.Groups.Windows</td>
</tr>
</table>
<table class="type">
<tr><th colspan="2">Types</th></tr>
<tr>
<td>Fl_Window</td>
<td>Window</td>
</tr>
<tr>
<td> </td>
<td>Window_Reference</td>
</tr>
<tr>
<td> </td>
<td>Modal_State</td>
</tr>
</table>
<table class="function">
<tr><th colspan="2">Static Protected Attributes</th></tr>
<tr>
<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><pre>
shape_data_type * shape_data_;
</pre></td>
<td>Intentionally left unbound.</td>
</tr>
</table>
<table class="function">
<tr><th colspan="2">Constructors</th></tr>
<tr>
<td><pre>
Fl_Window(int w, int h, const char *title=0);
</pre></td>
<td><pre>
function Create
(W, H : in Integer;
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>
<tr>
<td><pre>
Fl_Window(int x, int y, int w, int h, const char *title=0);
</pre></td>
<td><pre>
function Create
(X, Y, W, H : in Integer;
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;
X, Y, W, H : in Integer;
Text : in String := "")
return Window;
</pre></td>
</tr>
</table>
<table class="function">
<tr><th colspan="2">Static Functions and Procedures</th></tr>
<tr>
<td><pre>
static Fl_Window * current();
</pre></td>
<td><pre>
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 Has_Border
(This : in Window)
return Boolean;
</pre></td>
</tr>
<tr>
<td><pre>
void border(int b);
</pre></td>
<td><pre>
procedure Set_Border
(This : in out Window;
Value : in Boolean := True);
</pre></td>
</tr>
<tr>
<td><pre>
void clear_border();
</pre></td>
<td><pre>
procedure Clear_Border
(This : in out Window);
</pre></td>
</tr>
<tr>
<td><pre>
void clear_modal_states();
</pre></td>
<td><pre>
procedure Clear_Modal_State
(This : in out Window);
</pre></td>
</tr>
<tr>
<td><pre>
void copy_label(const char *a);
</pre></td>
<td><pre>
procedure Set_Label
(This : in out Window;
Text : in String);
</pre></td>
</tr>
<tr>
<td><pre>
void cursor(Fl_Cursor);
</pre></td>
<td><pre>
procedure Set_Cursor
(This : in out Window;
To : in Mouse_Cursor);
</pre></td>
</tr>
<tr>
<td><pre>
void cursor(const Fl_RGB_Image *, int, int);
</pre></td>
<td><pre>
procedure Set_Cursor
(This : in out Window;
Pic : in FLTK.Images.RGB.RGB_Image'Class;
Hot_X, Hot_Y : in Integer);
</pre></td>
</tr>
<tr>
<td><pre>
void cursor(Fl_Cursor c, Fl_Color, Fl_Color=FL_WHITE);
</pre></td>
<td>Use cursor(Fl_Cursor) / Set_Cursor instead.</td>
</tr>
<tr>
<td><pre>
int decorated_h();
</pre></td>
<td><pre>
function Get_Decorated_H
(This : in Window)
return Integer;
</pre></td>
</tr>
<tr>
<td><pre>
int decorated_w();
</pre></td>
<td><pre>
function Get_Decorated_W
(This : in Window)
return Integer;
</pre></td>
</tr>
<tr>
<td><pre>
void default_cursor(Fl_Cursor);
</pre></td>
<td><pre>
procedure Set_Default_Cursor
(This : in out Window;
To : in Mouse_Cursor);
</pre></td>
</tr>
<tr>
<td><pre>
void default_cursor(Fl_Cursor c, Fl_Color, Fl_Color=FL_WHITE);
</pre></td>
<td>Use default_cursor(Fl_Cursor) / Set_Default_Cursor instead.</td>
</tr>
<tr>
<td><pre>
void free_position();
</pre></td>
<td>Marked as deprecated.</td>
</tr>
<tr>
<td><pre>
void fullscreen();
</pre></td>
<td><pre>
procedure Fullscreen_On
(This : in out Window);
</pre></td>
</tr>
<tr>
<td><pre>
unsigned int fullscreen_active() const;
</pre></td>
<td><pre>
function Is_Fullscreen
(This : in Window)
return Boolean;
</pre></td>
</tr>
<tr>
<td><pre>
void fullscreen_off();
</pre></td>
<td><pre>
procedure Fullscreen_Off
(This : in out Window);
</pre></td>
</tr>
<tr>
<td><pre>
void fullscreen_off(int X, int Y, int W, int H);
</pre></td>
<td><pre>
procedure Fullscreen_Off
(This : in out Window;
X, Y, W, H : in Integer);
</pre></td>
</tr>
<tr>
<td><pre>
void fullscreen_screens(int top, int bottom, int left, int right);
</pre></td>
<td><pre>
procedure Fullscreen_Screens
(This : in out Window;
Top, Bottom, Left, Right : in Natural);
</pre></td>
</tr>
<tr>
<td><pre>
virtual int handle(int);
</pre></td>
<td><pre>
function Handle
(This : in out Window;
Event : in Event_Kind)
return Event_Outcome;
</pre></td>
</tr>
<tr>
<td><pre>
virtual void hide();
</pre></td>
<td><pre>
procedure Hide
(This : in out Window);
</pre></td>
</tr>
<tr>
<td><pre>
void hotspot(int x, int y, int offscreen=0);
</pre></td>
<td><pre>
procedure Hotspot
(This : in out Window;
X, Y : in Integer;
Offscreen : in Boolean := False);
</pre></td>
</tr>
<tr>
<td><pre>
void hotspot(const Fl_Widget *, int offscreen=0);
void hotspot(const Fl_Widget &p, int offscreen=0);
</pre></td>
<td><pre>
procedure Hotspot
(This : in out Window;
Item : in Widget'Class;
Offscreen : in Boolean := False);
</pre></td>
</tr>
<tr>
<td><pre>
void icon(const Fl_RGB_Image *);
</pre></td>
<td><pre>
procedure Set_Icon
(This : in out Window;
Pic : in FLTK.Images.RGB.RGB_Image'Class);
</pre></td>
</tr>
<tr>
<td><pre>
const void * icon() const;
</pre></td>
<td>Marked as deprecated.</td>
</tr>
<tr>
<td><pre>
void icon(const void *ic);
</pre></td>
<td>Marked as deprecated.</td>
</tr>
<tr>
<td><pre>
void iconize();
</pre></td>
<td><pre>
procedure Iconify
(This : in out Window);
</pre></td>
</tr>
<tr>
<td><pre>
const char * iconlabel() const;
</pre></td>
<td><pre>
function Get_Icon_Label
(This : in Window)
return String;
</pre></td>
</tr>
<tr>
<td><pre>
void iconlabel(const char *);
</pre></td>
<td><pre>
procedure Set_Icon_Label
(This : in out Window;
To : in String);
</pre></td>
</tr>
<tr>
<td><pre>
void icons(const Fl_RGB_Image *[], int);
</pre></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>
<td><pre>
const char * label() const;
</pre></td>
<td><pre>
function Get_Label
(This : in Window)
return String;
</pre></td>
</tr>
<tr>
<td><pre>
void label(const char *);
</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><pre>
procedure Set_Labels
(This : in out Window;
Text, Icon_Text : in String);
</pre></td>
</tr>
<tr>
<td><pre>
void make_current();
</pre></td>
<td><pre>
procedure Make_Current
(This : in out Window);
</pre></td>
</tr>
<tr>
<td><pre>
unsigned int menu_window() const;
</pre></td>
<td><pre>
function Is_Menu_Window
(This : in Window)
return Boolean;
</pre></td>
</tr>
<tr>
<td><pre>
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;
</pre></td>
</tr>
<tr>
<td><pre>
unsigned int non_modal() const;
</pre></td>
<td><pre>
function Is_Non_Modal
(This : in Window)
return Boolean;
</pre></td>
</tr>
<tr>
<td><pre>
unsigned int override() const;
</pre></td>
<td><pre>
function Is_Override
(This : in Window)
return Boolean;
</pre></td>
</tr>
<tr>
<td><pre>
virtual void resize(int X, int Y, int W, int H);
</pre></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>Intended for internal use only.</td>
</tr>
<tr>
<td><pre>
void set_modal();
</pre></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><pre>
procedure Set_Non_Modal
(This : in out Window);
</pre></td>
</tr>
<tr>
<td><pre>
void set_override();
</pre></td>
<td><pre>
procedure Set_Override
(This : in out Window);
</pre></td>
</tr>
<tr>
<td><pre>
void set_tooltip_window();
</pre></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 FLTK.Images.Image'Class);
</pre></td>
</tr>
<tr>
<td><pre>
virtual void show();
</pre></td>
<td><pre>
procedure Show
(This : in out Window);
</pre></td>
</tr>
<tr>
<td><pre>
void show(int argc, char **argv);
</pre></td>
<td><pre>
procedure Show_With_Args
(This : in out Window);
</pre></td>
</tr>
<tr>
<td><pre>
int shown();
</pre></td>
<td><pre>
function Is_Shown
(This : in Window)
return Boolean;
</pre></td>
</tr>
<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);
</pre></td>
<td><pre>
procedure Set_Size_Range
(This : in out Window;
Min_W, Min_H : in Integer;
Max_W, Max_H, Incre_W, Incre_H : in Integer := 0;
Keep_Aspect : in Boolean := False);
</pre></td>
</tr>
<tr>
<td><pre>
unsigned int tooltip_window() const;
</pre></td>
<td><pre>
function Is_Tooltip_Window
(This : in Window)
return Boolean;
</pre></td>
</tr>
<tr>
<td><pre>
void wait_for_expose();
</pre></td>
<td><pre>
procedure Wait_For_Expose
(This : in out Window);
</pre></td>
</tr>
<tr>
<td><pre>
int x_root() const;
</pre></td>
<td><pre>
function Get_X_Root
(This : in Window)
return Integer;
</pre></td>
</tr>
<tr>
<td><pre>
const char * xclass() const;
</pre></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><pre>
procedure Set_X_Class
(This : in out Window;
Value : in String);
</pre></td>
</tr>
<tr>
<td><pre>
int y_root() const;
</pre></td>
<td><pre>
function Get_Y_Root
(This : in Window)
return Integer;
</pre></td>
</tr>
</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>