Index

Package: Window

Description

package Gdk.Window is
A Gdk_Window is the physical window that appears on the screen. This is the low-level structure known to the X server or to Win32. All the widgets are internally associated with a specific Gdk_Window, that holds attributes such as the window decoration, whether the window can be interactively resized,... On some systems, the graphic server knows how to display non-rectangular windows (this is part of the X extensions). If you simply want to create a simply window, you should instead look at the functions provided in Gtk.Window and Gtk.Widget, which are higher level than these. See also the function Gtk.Widget.Get_Window to get the Gdk_Window associated with a widget. Be aware that some of them don't have such windows! Scrolling can be implemented in several ways with GtkAda (toplevel scrolling should be done with the Gtk_Scrolled_Window widget, but you might want to handle scrolling yourself). See the function Gdk.Event.Get_Graphics_Expose for more information.

Binding from C File version 1.3.6

Binding from C File version 2.12

for some of the functions

Packages

Gdk_Window_List (new Glib.Glist.Generic_List) 

package Gdk_Window_List is new
     Glib.Glist.Generic_List (Gpointer => Gdk_Window);

Window_Type_Hint_Properties (new Glib.Generic_Properties.Generic_Internal_Discrete_Property) 

package Window_Type_Hint_Properties is new
     Generic_Internal_Discrete_Property (Gdk_Window_Type_Hint);

Gravity_Properties (new Glib.Generic_Properties.Generic_Internal_Discrete_Property) 

package Gravity_Properties is new Generic_Internal_Discrete_Property
     (Gdk_Gravity);

Types

Gdk_Window 

subtype Gdk_Window is Gdk.Gdk_Window;

Gdk_Window_Class 

type Gdk_Window_Class is (Input_Output, Input_Only);

Gdk_Window_Type 

type Gdk_Window_Type is
     (Window_Root,
      --  there is only one root window and it is initialized at startup.
      --  Creating a window of type Window_Root is an error.

      Window_Toplevel,
      --  Windows which interact with the window manager.

      Window_Child,
      --  Windows which are children of some other type of window.
      --  (Any other type of window). Most windows are child windows.

      Window_Dialog,
      --  A special kind of toplevel window which interacts with the window
      --  manager slightly differently than a regular toplevel window.
      --  Dialog windows should be used for any transient window.

      Window_Temp,
      --  ???

      Window_Foreign
      --  A window that actually belongs to another application.
     );

Gdk_Window_Attributes_Type 

type Gdk_Window_Attributes_Type is mod 2 ** 32;

Gdk_Window_Hints 

type Gdk_Window_Hints is mod 2 ** 32;
Size restriction.

Gdk_Window_Type_Hint 

type Gdk_Window_Type_Hint is
     (Window_Type_Hint_Normal,
      --  Normal toplevel window

      Window_Type_Hint_Dialog,
      --  Dialog window

      Window_Type_Hint_Menu,
      --  Window used to implement a menu.

      Window_Type_Hint_Toolbar
      --  Toolbar: Window used to implement toolbars.
     );

Gdk_Wm_Decoration 

type Gdk_Wm_Decoration is mod 2 ** 32;

Gdk_Wm_Function 

type Gdk_Wm_Function is mod 2 ** 32;

Gdk_Gravity 

type Gdk_Gravity is
     (Gravity_North_West,
      Gravity_North,
      Gravity_North_East,
      Gravity_West,
      Gravity_Center,
      Gravity_East,
      Gravity_South_West,
      Gravity_South,
      Gravity_South_East,
      Gravity_Static);

Gdk_Window_Edge 

type Gdk_Window_Edge is
     (Window_Edge_North_West,
      Window_Edge_North,
      Window_Edge_North_East,
      Window_Edge_West,
      Window_Edge_East,
      Window_Edge_South_West,
      Window_Edge_South,
      Window_Edge_South_East);

Gdk_Geometry 

type Gdk_Geometry is record
      Min_Width   : Gint;
      Min_Height  : Gint;
      Max_Width   : Gint;
      Max_Height  : Gint;
      Base_Width  : Gint;
      Base_Height : Gint;
      Width_Inc   : Gint;
      Height_Inc  : Gint;
      Min_Aspect  : Gdouble;
      Max_Aspect  : Gdouble;
      Win_Gravity : Gdk_Gravity;
   end record;

Gdk_Filter_Return 

type Gdk_Filter_Return is
     (Continue,  --  Event not handled, continue processing
      Translate, --  Translated event stored
      Remove);

Gdk_Filter_Func 

type Gdk_Filter_Func is access function
     (System_Event : C_Proxy;
      Event        : Gdk.Event.Gdk_Event;
      Data         : System.Address) return Gdk_Filter_Return;

Property_Window_Type_Hint 

type Property_Window_Type_Hint  is new Window_Type_Hint_Properties.Property;

Property_Gravity 

type Property_Gravity           is new Gravity_Properties.Property;

Constants & Global variables

Null_Window (Gdk_Window) 

Null_Window : constant Gdk_Window;

Wa_Title (Gdk_Window_Attributes_Type) 

Wa_Title    : constant Gdk_Window_Attributes_Type := 2 ** 1;

Wa_X (Gdk_Window_Attributes_Type) 

Wa_X        : constant Gdk_Window_Attributes_Type := 2 ** 2;

Wa_Y (Gdk_Window_Attributes_Type) 

Wa_Y        : constant Gdk_Window_Attributes_Type := 2 ** 3;

Wa_Cursor (Gdk_Window_Attributes_Type) 

Wa_Cursor   : constant Gdk_Window_Attributes_Type := 2 ** 4;

Wa_Colormap (Gdk_Window_Attributes_Type) 

Wa_Colormap : constant Gdk_Window_Attributes_Type := 2 ** 5;

Wa_Visual (Gdk_Window_Attributes_Type) 

Wa_Visual   : constant Gdk_Window_Attributes_Type := 2 ** 6;

Wa_Wmclass (Gdk_Window_Attributes_Type) 

Wa_Wmclass  : constant Gdk_Window_Attributes_Type := 2 ** 7;

Wa_Noredir (Gdk_Window_Attributes_Type) 

Wa_Noredir  : constant Gdk_Window_Attributes_Type := 2 ** 8;

Gdk_Hint_Pos (Gdk_Window_Hints) 

Gdk_Hint_Pos        : constant Gdk_Window_Hints := 2 ** 0;
Size restriction.

Gdk_Hint_Min_Size (Gdk_Window_Hints) 

Gdk_Hint_Min_Size   : constant Gdk_Window_Hints := 2 ** 1;

Gdk_Hint_Max_Size (Gdk_Window_Hints) 

Gdk_Hint_Max_Size   : constant Gdk_Window_Hints := 2 ** 2;

Gdk_Hint_Base_Size (Gdk_Window_Hints) 

Gdk_Hint_Base_Size  : constant Gdk_Window_Hints := 2 ** 3;

Gdk_Hint_Aspect (Gdk_Window_Hints) 

Gdk_Hint_Aspect     : constant Gdk_Window_Hints := 2 ** 4;

Gdk_Hint_Resize_Inc (Gdk_Window_Hints) 

Gdk_Hint_Resize_Inc : constant Gdk_Window_Hints := 2 ** 5;

Decor_All (Gdk_Wm_Decoration) 

Decor_All      : constant Gdk_Wm_Decoration := 2 ** 0;

Decor_Border (Gdk_Wm_Decoration) 

Decor_Border   : constant Gdk_Wm_Decoration := 2 ** 1;

Decor_Resize_H (Gdk_Wm_Decoration) 

Decor_Resize_H : constant Gdk_Wm_Decoration := 2 ** 2;

Decor_Title (Gdk_Wm_Decoration) 

Decor_Title    : constant Gdk_Wm_Decoration := 2 ** 3;

Decor_Menu (Gdk_Wm_Decoration) 

Decor_Menu     : constant Gdk_Wm_Decoration := 2 ** 4;

Decor_Minimize (Gdk_Wm_Decoration) 

Decor_Minimize : constant Gdk_Wm_Decoration := 2 ** 5;

Decor_Maximize (Gdk_Wm_Decoration) 

Decor_Maximize : constant Gdk_Wm_Decoration := 2 ** 6;

Func_All (Gdk_Wm_Function) 

Func_All      : constant Gdk_Wm_Function := 2 ** 0;

Func_Resize (Gdk_Wm_Function) 

Func_Resize   : constant Gdk_Wm_Function := 2 ** 1;

Func_Move (Gdk_Wm_Function) 

Func_Move     : constant Gdk_Wm_Function := 2 ** 2;

Func_Minimize (Gdk_Wm_Function) 

Func_Minimize : constant Gdk_Wm_Function := 2 ** 3;

Func_Maximize (Gdk_Wm_Function) 

Func_Maximize : constant Gdk_Wm_Function := 2 ** 4;

Func_Close (Gdk_Wm_Function) 

Func_Close    : constant Gdk_Wm_Function := 2 ** 5;

Subprograms & Entries

Gdk_New 

procedure Gdk_New 
(Window: out Gdk_Window;
Parent: Gdk_Window;
Attributes: Gdk_Window_Attr;
Attributes_Mask: Gdk_Window_Attributes_Type);
Creates a new gdk_window. There are few reasons for creating such windows yourself, and almost none if you are not creating a new widget. One nice thing with using such a window (rather than drawing directly on a gtk_widget is that you can get separate Events for this window (Expose, Button_Press, ...) without having do detect yourself where the event applied. Note that you should almost always call Set_User_Data on the newly created window, so that events are redirected to a specific widget. You cannot pass a null value for Attributes. Attributes_Mask indicates which fields are relevant in Attributes. Some of the fields are always taken into account, and thus do not have an associated mask. See the package Gdk.Window_Attr for more information on window attributes. Changing the background color of the window can be done through Gtk.Style.Set_Background

Set_User_Data 

procedure Set_User_Data 
(Window: Gdk.Gdk_Window;
Widget: access Glib.Object.GObject_Record'Class);
Sets a special field in the window. All the events reported by the Xserver (or the Windows server) for Window will be redirected to Widget through the standard signals "expose_event", "button_press_event", ... You almost always need to call this function after creating a new Gdk_Window yourself, or you won't be able to handle the events.

Get_User_Data 

function Get_User_Data 
(Window: Gdk.Gdk_Window) return Glib.Object.GObject;
Return the widget to which events are reported when they happen on Window. This is the widget that was set through the call to Set_User_data.

Get_Type 

function Get_Type return Glib.GType;
Return the internal lue associated with Gdk_Window.

Destroy 

procedure Destroy 
(Window: in out Gdk_Window);
Destroy a window and all its children.

Add_Filter 

procedure Add_Filter 
(Window: Gdk.Gdk_Window;
Filter: Gdk_Filter_Func;
Data: System.Address);
Add an event filter to Window, allowing you to intercept events before they reach GDK. This is a low-level operation and makes it easy to break GDK and/or GTK+, so you have to know what you're doing. Pass null for Window to get all events for all windows, instead of events for a specific window. This can be used for a temporary keyboard grab, although you should consider using Gdk.Main.Keyboard_Grab instead.

Remove_Filter 

procedure Remove_Filter 
(Window: Gdk.Gdk_Window;
Filter: Gdk_Filter_Func;
Data: System.Address);
Removing the filter that was previously associated with Filter and Data

Get_Window_Type 

function Get_Window_Type 
(Window: Gdk_Window) return Gdk_Window_Type;

Window_At_Pointer 

procedure Window_At_Pointer 
(Win_X: out Gint;
Win_Y: out Gint;
Window: out Gdk_Window);
Return the window and the coordinates corresponding to the current position of the cursor.

Show 

procedure Show 
(Window: Gdk_Window);

Show_Unraised 

procedure Show_Unraised 
(Window: Gdk_Window);
Show Window on screen, but does not modify its stacking order. In contrast, Show will raise the window to the top of the window stack.

Hide 

procedure Hide 
(Window: Gdk_Window);

Withdraw 

procedure Withdraw 
(Window: Gdk_Window);

Move 

procedure Move 
(Window: Gdk_Window;
X: Gint;
Y: Gint);

Resize 

procedure Resize 
(Window: Gdk_Window;
Width: Gint;
Height: Gint);

Move_Resize 

procedure Move_Resize 
(Window: Gdk_Window;
X: Gint;
Y: Gint;
Width: Gint;
Height: Gint);

Reparent 

procedure Reparent 
(Window: Gdk_Window;
New_Parent: Gdk_Window;
X: Gint;
Y: Gint);

Clear 

procedure Clear 
(Window: Gdk_Window);

Clear_Area 

procedure Clear_Area 
(Window: Gdk_Window;
X: Gint;
Y: Gint;
Width: Gint;
Height: Gint);
Does not generate an expose event.

Clear_Area_E 

procedure Clear_Area_E 
(Window: Gdk_Window;
X: Gint;
Y: Gint;
Width: Gint;
Height: Gint);
Same as Clear_Area, but generates an expose event.

Copy_Area 

procedure Copy_Area 
(Window: Gdk_Window;
Gc: Gdk.Gdk_GC;
X: Gint;
Y: Gint;
Source_Window: Gdk_Window;
Source_X: Gint;
Source_Y: Gint;
Width: Gint;
Height: Gint);
Obsolete. Use Gdk.Drawable.Draw_Drawable instead.

Create_Similar_Surface 

function Create_Similar_Surface 
(Window: Gdk_Window;
Content: Cairo.Cairo_Content;
Width: Glib.Gint;
Height: Glib.Gint) return Cairo.Cairo_Surface;
Same as Cairo.Surface.Create_Similar, using Windows as similar surface.

Gdk_Raise 

procedure Gdk_Raise 
(Window: Gdk_Window);

Lower 

procedure Lower 
(Window: Gdk_Window);

Focus 

procedure Focus 
(Window: Gdk_Window;
Timestamp: Guint32);

Set_Override_Redirect 

procedure Set_Override_Redirect 
(Window: Gdk_Window;
Override_Redirect: Boolean := True);

Scroll 

procedure Scroll 
(Window: Gdk_Window;
Dx, Dy: Gint);

Shape_Combine_Mask 

procedure Shape_Combine_Mask 
(Window: Gdk_Window;
Shape_Mask: Gdk.Gdk_Bitmap;
Offset_X: Gint;
Offset_Y: Gint);
Allow for making shaped (partially transparent) windows. This featureis needed for Drag and Drop for example. Shape_Mask can be the mask from Gdk.Pixmap.Create_From_Xpm.

Shape_Combine_Region 

procedure Shape_Combine_Region 
(Window: Gdk_Window;
Shape_Region: Gdk.Gdk_Region;
Offset_X: Gint;
Offset_Y: Gint);

Set_Child_Shapes 

procedure Set_Child_Shapes 
(Window: Gdk_Window);
Quickly take the shapes of all the child windows of a window and use their shapes as the shape mask for this window - useful for container windows that do not want to look like a big box.

Merge_Child_Shapes 

procedure Merge_Child_Shapes 
(Window: Gdk_Window);
Merge (ie add) child shapes to your own window's shape keeping its current shape and adding the child shapes to it.

Is_Visible 

function Is_Visible 
(Window: Gdk_Window) return Boolean;

Is_Viewable 

function Is_Viewable 
(Window: Gdk_Window) return Boolean;

Get_State 

function Get_State 
(Window: Gdk_Window) return Gdk.Event.Gdk_Window_State;
Return the current state of the Windows. See Gdk.Event.Gdk_Window_State for more details.

Set_Static_Gravities 

function Set_Static_Gravities 
(Window: Gdk_Window;
Use_Static: Boolean) return Boolean;

Set_Hints 

procedure Set_Hints 
(Window: Gdk_Window;
X: Gint;
Y: Gint;
Min_Width: Gint;
Min_Height: Gint;
Max_Width: Gint;
Max_Height: Gint;
Flags: Gdk_Window_Hints);

Set_Type_Hint 

procedure Set_Type_Hint 
(Window: Gdk_Window;
Hint: Gdk_Window_Type_Hint);

Set_Modal_Hint 

procedure Set_Modal_Hint 
(Window: Gdk_Window;
Modal: Boolean);

Set_Geometry_Hints 

procedure Set_Geometry_Hints 
(Window: Gdk_Window;
Geometry: in out Gdk_Geometry;
Flags: Gdk_Window_Hints);

Set_Title 

procedure Set_Title 
(Window: Gdk_Window;
Title: UTF8_String);

Set_Role 

procedure Set_Role 
(Window: Gdk_Window;
Role: String);

Set_Transient_For 

procedure Set_Transient_For 
(Window: Gdk_Window;
Leader: Gdk_Window);

Set_Opacity 

procedure Set_Opacity 
(Window: Gdk_Window;
Opacity: Gdouble);
Request the windowing system to make Window partially transparent, with opacity 0.0 being fully transparent and 1.0 fully opaque (Values of the opacity parameter are clamped to the [0,1] range). On X11, this works only on X screens with a compositing manager running (see Gdk.Screen.Is_Composited) For setting up per-pixel alpha, see Gdk.Screen.Get_Rgba_Colormap For making non-toplevel windows translucent, see Set_Composited Since: gtk+ 2.12

Set_Composited 

procedure Set_Composited 
(Window: Gdk_Window;
Composited: Boolean);
Sets Window as composited, or unsets it. Composited windows do not automatically have their contents drawn to the screen. Drawing is redirected to an offscreen buffer and an expose event is emitted on the parent of the composited window. It is the responsibility of the parent's expose handler to manually merge the off-screen content onto the screen in whatever way it sees fit. It only makes sense for child windows to be composited; see Set_Opacity if you need translucent toplevel windows. An additional effect of this call is that the area of this window is no longer clipped from regions marked for invalidation on its parent. Draws done on the parent window are also no longer clipped by the child. This call is only supported on some systems (currently, only X11 with new enough Xcomposite and Xdamage extensions). You must call gdk_display_supports_composite() to check if setting a window as composited is supported before attempting to do so. Since: 2.12

Set_Background 

procedure Set_Background 
(Window: Gdk_Window;
Color: Gdk.Color.Gdk_Color);

Set_Back_Pixmap 

procedure Set_Back_Pixmap 
(Window: Gdk_Window;
Pixmap: Gdk.Gdk_Pixmap;
Parent_Relative: Boolean);

Set_Cursor 

procedure Set_Cursor 
(Window: Gdk_Window;
Cursor: Gdk.Cursor.Gdk_Cursor);
Note: the window must be realized first, ie have an associated X11/Win32 window.

Get_Geometry 

procedure Get_Geometry 
(Window: Gdk_Window;
X: out Gint;
Y: out Gint;
Width: out Gint;
Height: out Gint;
Depth: out Gint);
You can get the size of the root window (ie the size of the screen) simply by giving Null_Window as the first argument to this procedure.

Get_Position 

procedure Get_Position 
(Window: Gdk_Window;
X: out Gint;
Y: out Gint);

Get_Origin 

procedure Get_Origin 
(Window: Gdk_Window;
X: out Gint;
Y: out Gint;
Success: out Boolean);
Obtains the position of a window in root window coordinates. (Compare with Get_Position and Get_Geometry which return the position of a window relative to its parent window)

Get_Desk_Relative_Origin 

procedure Get_Desk_Relative_Origin 
(Window: Gdk_Window;
X: out Gint;
Y: out Gint;
Success: out Boolean);

Get_Root_Origin 

procedure Get_Root_Origin 
(Window: Gdk_Window;
X: out Gint;
Y: out Gint);
Obtains the top-left corner of the window manager frame in root window coordinates.

Get_Frame_Extents 

procedure Get_Frame_Extents 
(Window: Gdk_Window;
Rect: Gdk.Rectangle.Gdk_Rectangle);

Get_Pointer 

procedure Get_Pointer 
(Window: Gdk_Window;
X: out Gint;
Y: out Gint;
Mask: out Gdk.Types.Gdk_Modifier_Type;
Result: out Gdk_Window);

Get_Parent 

function Get_Parent 
(Window: Gdk_Window) return Gdk_Window;

Get_Toplevel 

function Get_Toplevel 
(Window: Gdk_Window) return Gdk_Window;

Convert 

function Convert is new Unchecked_Conversion 
(Gdk_Window, System.Address);
Gdk_Window_List

Convert 

function Convert is new Unchecked_Conversion 
(System.Address, Gdk_Window);

Get_Children 

function Get_Children 
(Window: Gdk_Window) return Gdk_Window_List.Glist;

Peek_Children 

function Peek_Children 
(Window: Gdk_Window) return Gdk_Window_List.Glist;

Get_Events 

function Get_Events 
(Window: Gdk_Window) return Gdk.Event.Gdk_Event_Mask;

Set_Events 

procedure Set_Events 
(Window: Gdk_Window;
Event_Mask: Gdk.Event.Gdk_Event_Mask);

Set_Icon 

procedure Set_Icon 
(Window: Gdk_Window;
Icon_Window: Gdk_Window;
Pixmap: Gdk_Pixmap;
Mask: Gdk_Bitmap);
Currently not supported under Windows

Set_Icon_Name 

procedure Set_Icon_Name 
(Window: Gdk_Window;
Name: UTF8_String);

Set_Group 

procedure Set_Group 
(Window: Gdk_Window;
Leader: Gdk_Window);
Sets the group leader window for window. By default, GDK sets the group leader for all toplevel windows to a global window implicitly created by GDK. With this function you can override this default. The group leader window allows the window manager to distinguish all windows that belong to a single application. It may for example allow users to minimize/unminimize all windows belonging to an application at once. You should only set a non-default group window if your application pretends to be multiple applications.

Set_Decorations 

procedure Set_Decorations 
(Window: Gdk_Window;
Decorations: Gdk_Wm_Decoration);

Get_Decorations 

procedure Get_Decorations 
(Window: Gdk_Window;
Decorations: out Gdk_Wm_Decoration;
Success: out Boolean);

Set_Functions 

procedure Set_Functions 
(Window: Gdk_Window;
Functions: Gdk_Wm_Function);

Invalidate_Rect 

procedure Invalidate_Rect 
(Window: Gdk_Window;
Rectangle: Gdk.Rectangle.Gdk_Rectangle;
Invalidate_Children: Boolean);

Get_Toplevels 

function Get_Toplevels return Gdk_Window_List.Glist;
The returned list must be freed by calling Gdk_Window_List.Free. Consider using Gtk.Window.List_Toplevels instead.

Iconify 

procedure Iconify 
(Window: Gdk_Window);

Deiconify 

procedure Deiconify 
(Window: Gdk_Window);

Stick 

procedure Stick 
(Window: Gdk_Window);

Unstick 

procedure Unstick 
(Window: Gdk_Window);

Maximize 

procedure Maximize 
(Window: Gdk_Window);

Unmaximize 

procedure Unmaximize 
(Window: Gdk_Window);

Register_Dnd 

procedure Register_Dnd 
(Window: Gdk_Window);

Get_Update_Area 

function Get_Update_Area 
(Window: Gdk_Window) return Gdk_Region;

Freeze_Updates 

procedure Freeze_Updates 
(Window: Gdk_Window);

Thaw_Updates 

procedure Thaw_Updates 
(Window: Gdk_Window);

Process_All_Updates 

procedure Process_All_Updates;

Process_Updates 

procedure Process_Updates 
(Window: Gdk_Window;
Update_Children: Boolean := True);

Set_Debug_Updates 

procedure Set_Debug_Updates 
(Setting: Boolean := True);

Ref 

procedure Ref 
(Window: Gdk_Window);
Increment the reference counter associated with window.

Unref 

procedure Unref 
(Window: Gdk_Window);
Decrement the reference counter associated with window.

Get_Window_Id 

function Get_Window_Id 
(Window: Gdk_Window) return System.Address;
Return the target specific window id. Under Windows, this returns a HWND object. Under X, this returns a Window object.