Index

Package: Display

Description

package Gdk.Display is

Gdk.Display.Gdk_Display objects purpose are two fold: * To manage and provide information about input devices (pointers and keyboards) * To manage and provide information about the available Gdk_Screens GdkDisplay objects are the GDK representation of an X Display, which can be described as *a workstation consisting of a keyboard, a pointing device (such as a mouse) and one or more screens*. It is used to open and keep track of various GdkScreen objects currently instantiated by the application. It is also used to access the keyboard(s) and mouse pointer(s) of the display.

Most of the input device handling has been factored out into the separate Gdk.Device_Manager.Gdk_Device_Manager object. Every display has a device manager, which you can obtain using gdk_display_get_device_manager.

Classes

Gdk_Display_Record

type Gdk_Display_Record is new GObject_Record with null record;

Ancestors:

Primitive operations:

Get_Default_Cursor_Size
Get_Default_Group
Get_Maximal_Cursor_Size
Get_N_Screens
Get_Window_At_Pointer
Glib.Object.Deallocate (Inherited)
Glib.Object.Get_Type (Inherited)
Glib.Object.Notify (Inherited)
Glib.Object.Ref (Inherited)
Glib.Object.Ref_Sink (Inherited)
Glib.Object.Unref (Inherited)
Keyboard_Ungrab
Notify_Startup_Complete
Pointer_Is_Grabbed
Pointer_Ungrab
Request_Selection_Notification
Set_Double_Click_Distance
Set_Double_Click_Time
Store_Clipboard
Supports_Clipboard_Persistence
Supports_Composite
Supports_Cursor_Alpha
Supports_Cursor_Color
Supports_Input_Shapes
Supports_Selection_Notification
Supports_Shapes

Types

Gdk_Display

type Gdk_Display is access all Gdk_Display_Record'Class;

Cb_Gdk_Display_Boolean_Void

type Cb_Gdk_Display_Boolean_Void is not null access procedure
     (Self     : access Gdk_Display_Record'Class;
      Is_Error : Boolean);

Cb_GObject_Boolean_Void

type Cb_GObject_Boolean_Void is not null access procedure
     (Self     : access Glib.Object.GObject_Record'Class;
      Is_Error : Boolean);

Cb_Gdk_Display_Void

type Cb_Gdk_Display_Void is not null access procedure (Self : access Gdk_Display_Record'Class);

Cb_GObject_Void

type Cb_GObject_Void is not null access procedure
     (Self : access Glib.Object.GObject_Record'Class);

Constants & Global variables

Signal_Closed (Glib.Signal_Name)

Signal_Closed : constant Glib.Signal_Name := "closed";

Signal_Opened (Glib.Signal_Name)

Signal_Opened : constant Glib.Signal_Name := "opened";

Subprograms & Entries

Get_Type

function Get_Type return Glib.GType;

Beep

procedure Beep 
(Self: not null access Gdk_Display_Record);
Emits a short beep on Display Since: gtk+ 2.2

Close

procedure Close 
(Self: not null access Gdk_Display_Record);
Closes the connection to the windowing system for the given display, and cleans up associated resources. Since: gtk+ 2.2

Flush

procedure Flush 
(Self: not null access Gdk_Display_Record);
Flushes any requests queued for the windowing system; this happens automatically when the main loop blocks waiting for new events, but if your application is drawing without returning control to the main loop, you may need to call this function explicitely. A common case where this function needs to be called is when an application is executing drawing commands from a thread other than the thread where the main loop is running. This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing. Since: gtk+ 2.4

Get_Default_Cursor_Size

function Get_Default_Cursor_Size 
(Self: not null access Gdk_Display_Record) return Guint;
Returns the default size to use for cursors on Display. Since: gtk+ 2.4

Get_Default_Group

function Get_Default_Group 
(Self: not null access Gdk_Display_Record) return Gdk.Gdk_Window;
Returns the default group leader window for all toplevel windows on Display. This window is implicitly created by GDK. See Gdk.Window.Set_Group. Since: gtk+ 2.4

Get_Event

function Get_Event 
(Self: not null access Gdk_Display_Record) return Gdk.Event.Gdk_Event;
Gets the next Gdk.Event.Gdk_Event to be processed for Display, fetching events from the windowing system if necessary. Since: gtk+ 2.2

Get_Maximal_Cursor_Size

procedure Get_Maximal_Cursor_Size 
(Self: not null access Gdk_Display_Record;
Width: out Guint;
Height: out Guint);
Gets the maximal size to use for cursors on Display. Since: gtk+ 2.4 "width": the return location for the maximal cursor width "height": the return location for the maximal cursor height

Get_N_Screens

function Get_N_Screens 
(Self: not null access Gdk_Display_Record) return Gint;
Gets the number of screen managed by the Display. Since: gtk+ 2.2

Get_Name

function Get_Name 
(Self: not null access Gdk_Display_Record) return UTF8_String;
Gets the name of the display. Since: gtk+ 2.2

Has_Pending

function Has_Pending 
(Self: not null access Gdk_Display_Record) return Boolean;
Returns whether the display has events that are waiting to be processed. Since: gtk+ 3.0

Is_Closed

function Is_Closed 
(Self: not null access Gdk_Display_Record) return Boolean;
Finds out if the display has been closed. Since: gtk+ 2.22

Keyboard_Ungrab

procedure Keyboard_Ungrab 
(Self: not null access Gdk_Display_Record;
Time: Guint32);

Notify_Startup_Complete

procedure Notify_Startup_Complete 
(Self: not null access Gdk_Display_Record;
Startup_Id: UTF8_String);
Indicates to the GUI environment that the application has finished loading, using a given identifier. GTK+ will call this function automatically for Gtk.Window.Gtk_Window with custom startup-notification identifier unless Gtk.Window.Set_Auto_Startup_Notification is called to disable that feature. Since: gtk+ 3.0 "startup_id": a startup-notification identifier, for which notification process should be completed

Peek_Event

function Peek_Event 
(Self: not null access Gdk_Display_Record) return Gdk.Event.Gdk_Event;
Gets a copy of the first Gdk.Event.Gdk_Event in the Display's event queue, without removing the event from the queue. (Note that this function will not get more events from the windowing system. It only checks the events that have already been moved to the GDK event queue.) Since: gtk+ 2.2

Pointer_Is_Grabbed

function Pointer_Is_Grabbed 
(Self: not null access Gdk_Display_Record) return Boolean;

Pointer_Ungrab

procedure Pointer_Ungrab 
(Self: not null access Gdk_Display_Record;
Time: Guint32);

Put_Event

procedure Put_Event 
(Self: not null access Gdk_Display_Record;
Event: Gdk.Event.Gdk_Event);
Appends a copy of the given event onto the front of the event queue for Display. Since: gtk+ 2.2 "event": a Gdk.Event.Gdk_Event.

Request_Selection_Notification

function Request_Selection_Notification 
(Self: not null access Gdk_Display_Record;
Selection: Gdk.Types.Gdk_Atom) return Boolean;
Request Gdk.Event.Gdk_Event_Owner_Change events for ownership changes of the selection named by the given atom. Since: gtk+ 2.6 "selection": the Gdk.Types.Gdk_Atom naming the selection for which ownership change notification is requested

Set_Double_Click_Distance

procedure Set_Double_Click_Distance 
(Self: not null access Gdk_Display_Record;
Distance: Guint);
Sets the double click distance (two clicks within this distance count as a double click and result in a GDK_2_BUTTON_PRESS event). See also Gdk.Display.Set_Double_Click_Time. Applications should *not* set this, it is a global user-configured setting. Since: gtk+ 2.4 "distance": distance in pixels

Set_Double_Click_Time

procedure Set_Double_Click_Time 
(Self: not null access Gdk_Display_Record;
Msec: Guint);
Sets the double click time (two clicks within this time interval count as a double click and result in a GDK_2_BUTTON_PRESS event). Applications should *not* set this, it is a global user-configured setting. Since: gtk+ 2.2 "msec": double click time in milliseconds (thousandths of a second)

Supports_Clipboard_Persistence

function Supports_Clipboard_Persistence 
(Self: not null access Gdk_Display_Record) return Boolean;
Returns whether the speicifed display supports clipboard persistance; i.e. if it's possible to store the clipboard data after an application has quit. On X11 this checks if a clipboard daemon is running. Since: gtk+ 2.6

Supports_Composite

function Supports_Composite 
(Self: not null access Gdk_Display_Record) return Boolean;
Returns True if Gdk.Window.Set_Composited can be used to redirect drawing on the window using compositing. Currently this only works on X11 with XComposite and XDamage extensions available. Since: gtk+ 2.12

Supports_Cursor_Alpha

function Supports_Cursor_Alpha 
(Self: not null access Gdk_Display_Record) return Boolean;
Returns True if cursors can use an 8bit alpha channel on Display. Otherwise, cursors are restricted to bilevel alpha (i.e. a mask). Since: gtk+ 2.4

Supports_Cursor_Color

function Supports_Cursor_Color 
(Self: not null access Gdk_Display_Record) return Boolean;
Returns True if multicolored cursors are supported on Display. Otherwise, cursors have only a forground and a background color. Since: gtk+ 2.4

Supports_Input_Shapes

function Supports_Input_Shapes 
(Self: not null access Gdk_Display_Record) return Boolean;
Returns True if gdk_window_input_shape_combine_mask can be used to modify the input shape of windows on Display. Since: gtk+ 2.10

Supports_Selection_Notification

function Supports_Selection_Notification 
(Self: not null access Gdk_Display_Record) return Boolean;
Returns whether Gdk.Event.Gdk_Event_Owner_Change events will be sent when the owner of a selection changes. Since: gtk+ 2.6

Supports_Shapes

function Supports_Shapes 
(Self: not null access Gdk_Display_Record) return Boolean;
Returns True if gdk_window_shape_combine_mask can be used to create shaped windows on Display. Since: gtk+ 2.10

Sync

procedure Sync 
(Self: not null access Gdk_Display_Record);
Flushes any requests queued for the windowing system and waits until all requests have been handled. This is often used for making sure that the display is synchronized with the current state of the program. Calling Gdk.Display.Sync before gdk_error_trap_pop makes sure that any errors generated from earlier requests are handled before the error trap is removed. This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing. Since: gtk+ 2.2

Store_Clipboard

procedure Store_Clipboard 
(Display: not null access Gdk_Display_Record;
Clipboard_Window: Gdk.Gdk_Window;
Time: Guint32;
Targets: Gdk.Types.Gdk_Atom_Array);
Issues a request to the clipboard manager to store the clipboard data. On X11, this is a special program that works according to the freedesktop clipboard specification, available at <ulink url="http://www.freedesktop.org/Standards/clipboard-manager-spec"> http://www.freedesktop.org/Standards/clipboard-manager-spec</ulink>>. Since: gtk+ 2.6 "clipboard_window": a Gdk.Gdk_Window belonging to the clipboard owner "time_": a timestamp "targets": an array of targets that should be saved, or null if all available targets should be saved. "n_targets": length of the Targets array

Get_Window_At_Pointer

procedure Get_Window_At_Pointer 
(Display: access Gdk_Display_Record;
Win_X: out Glib.Gint;
Win_Y: out Glib.Gint;
Win: out Gdk.Gdk_Window);
Obtains the window underneath the mouse pointer, returning the location of that window in Win_X, Win_Y. Returns nullif the window under the mouse pointer is not known to GDK (for example, belongs to another application). (Win_X, Win_Y) are relative to the origin of the window under the pointer. Obsolescent: use Gdk.Device.Get_Window_At_Position instead.

Get_Default

function Get_Default return Gdk_Display;
Gets the default Gdk.Display.Gdk_Display. This is a convenience function for 'gdk_display_manager_get_default_display (gdk_display_manager_get ())'. Since: gtk+ 2.2

Open

function Open 
(Display_Name: UTF8_String) return Gdk_Display;
Opens a display. Since: gtk+ 2.2 "display_name": the name of the display to open

Open_Default_Libgtk_Only

function Open_Default_Libgtk_Only return Gdk_Display;
Opens the default display specified by command line arguments or environment variables, sets it as the default display, and returns it. gdk_parse_args must have been called first. If the default display has previously been set, simply returns that. An internal function that should not be used by applications.

On_Closed

procedure On_Closed 
(Self: not null access Gdk_Display_Record;
Call: Cb_Gdk_Display_Boolean_Void;
After: Boolean := False);

On_Closed

procedure On_Closed 
(Self: not null access Gdk_Display_Record;
Call: Cb_GObject_Boolean_Void;
Slot: not null access Glib.Object.GObject_Record'Class;
After: Boolean := False);
The ::closed signal is emitted when the connection to the windowing system for Display is closed.

On_Opened

procedure On_Opened 
(Self: not null access Gdk_Display_Record;
Call: Cb_Gdk_Display_Void;
After: Boolean := False);

On_Opened

procedure On_Opened 
(Self: not null access Gdk_Display_Record;
Call: Cb_GObject_Void;
Slot: not null access Glib.Object.GObject_Record'Class;
After: Boolean := False);
The ::opened signal is emitted when the connection to the windowing system for Display is opened.