Index

Package: Device

Description

package Gdk.Device is

The Gdk.Device.Gdk_Device object represents a single input device, such as a keyboard, a mouse, a touchpad, etc.

See the Gdk.Device_Manager.Gdk_Device_Manager documentation for more information about the various kinds of master and slave devices, and their relationships.

Packages

Device_List (new Glib.Glist.Generic_List) 

package Device_List is new Generic_List (Gdk.Device.Gdk_Device);

Gdk_Device_Type_Properties (new Glib.Generic_Properties.Generic_Internal_Discrete_Property) 

package Gdk_Device_Type_Properties is
      new Generic_Internal_Discrete_Property (Gdk_Device_Type);

Classes

Gdk_Device_Record 

type Gdk_Device_Record is new GObject_Record with null record;

Ancestors:

Primitive operations:

Get_Associated_Device
Get_Axis_Use
Get_Device_Type
Get_Has_Cursor
Get_Window_At_Position
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)
Set_Axis_Use
Set_Source_Device

Types

Gdk_Device 

type Gdk_Device is access all Gdk_Device_Record'Class;

Gdk_Device_Type 

type Gdk_Device_Type is (
      Gdk_Device_Type_Master,
      Gdk_Device_Type_Slave,
      Gdk_Device_Type_Floating);

Property_Gdk_Device_Type 

type Property_Gdk_Device_Type is new Gdk_Device_Type_Properties.Property;

Constants & Global variables

Associated_Device_Property (Glib.Properties.Property_Boxed) 

Associated_Device_Property : constant Glib.Properties.Property_Boxed;
Type: Device Associated pointer or keyboard with this device, if any. Devices of type GDK_DEVICE_TYPE_MASTER always come in keyboard/pointer pairs. Other device types will have a null associated device.

Device_Manager_Property (Glib.Properties.Property_Boxed) 

Device_Manager_Property : constant Glib.Properties.Property_Boxed;
Type: Device_Manager The Gdk.Device_Manager.Gdk_Device_Manager the Gdk.Device.Gdk_Device pertains to.

Display_Property (Glib.Properties.Property_Boxed) 

Display_Property : constant Glib.Properties.Property_Boxed;
Type: Display The Gdk.Display.Gdk_Display the Gdk.Device.Gdk_Device pertains to.

Has_Cursor_Property (Glib.Properties.Property_Boolean) 

Has_Cursor_Property : constant Glib.Properties.Property_Boolean;
Whether the device is represented by a cursor on the screen. Devices of type Gdk.Device.Gdk_Device_Type_Master will have True here.

Input_Mode_Property (Glib.Properties.Property_Boxed) 

Input_Mode_Property : constant Glib.Properties.Property_Boxed;
Type: Input_Mode Input mode for the device.

Input_Source_Property (Glib.Properties.Property_Boxed) 

Input_Source_Property : constant Glib.Properties.Property_Boxed;
Type: Input_Source Source type for the device.

N_Axes_Property (Glib.Properties.Property_Uint) 

N_Axes_Property : constant Glib.Properties.Property_Uint;
Number of axes in the device.

Name_Property (Glib.Properties.Property_String) 

Name_Property : constant Glib.Properties.Property_String;
The device name.

The_Type_Property (Glib.Properties.Property_Boxed) 

The_Type_Property : constant Glib.Properties.Property_Boxed;
Type: Device_Type Device role in the device manager.

Signal_Changed (Glib.Signal_Name) 

Signal_Changed : constant Glib.Signal_Name := "changed";
The ::changed signal is emitted either when the Gdk.Device.Gdk_Device has changed the number of either axes or keys. For example In X this will normally happen when the slave device routing events through the master device changes (for example, user switches from the USB mouse to a tablet), in that case the master device will change to reflect the new slave device axes and keys. procedure Handler (Self : access Gdk_Device_Record'Class)

Subprograms & Entries

Convert 

function Convert 
(R: Gdk.Device.Gdk_Device) return System.Address;

Convert 

function Convert 
(R: System.Address) return Gdk.Device.Gdk_Device;

Get_Type 

function Get_Type return Glib.GType;

Get_Associated_Device 

function Get_Associated_Device 
(Self: not null access Gdk_Device_Record) return Gdk_Device;
Returns the associated device to Device, if Device is of type Gdk.Device.Gdk_Device_Type_Master, it will return the paired pointer or keyboard. If Device is of type Gdk.Device.Gdk_Device_Type_Slave, it will return the master device to which Device is attached to. If Device is of type Gdk.Device.Gdk_Device_Type_Floating, null will be returned, as there is no associated device. Since: gtk+ 3.0

Get_Axis_Use 

function Get_Axis_Use 
(Self: not null access Gdk_Device_Record;
Index: Guint) return Gdk_Axis_Use;
Returns the axis use for Index_. Since: gtk+ 2.20 "index_": the index of the axis.

Set_Axis_Use 

procedure Set_Axis_Use 
(Self: not null access Gdk_Device_Record;
Index: Guint;
GUse: Gdk_Axis_Use);
Specifies how an axis of a device is used. "index_": the index of the axis "use": specifies how the axis is used

Get_Device_Type 

function Get_Device_Type 
(Self: not null access Gdk_Device_Record) return Gdk_Device_Type;
Returns the device type for Device. Since: gtk+ 3.0

Get_Display 

function Get_Display 
(Self: not null access Gdk_Device_Record) return Gdk.Display.Gdk_Display;
Returns the Gdk.Display.Gdk_Display to which Device pertains. Since: gtk+ 3.0

Get_Has_Cursor 

function Get_Has_Cursor 
(Self: not null access Gdk_Device_Record) return Boolean;
Determines whether the pointer follows device motion. Since: gtk+ 2.20

Get_Mode 

function Get_Mode 
(Self: not null access Gdk_Device_Record) return Gdk_Input_Mode;
Determines the mode of the device. Since: gtk+ 2.20

Set_Mode 

function Set_Mode 
(Self: not null access Gdk_Device_Record;
Mode: Gdk_Input_Mode) return Boolean;
Sets a the mode of an input device. The mode controls if the device is active and whether the device's range is mapped to the entire screen or to a single window. "mode": the input mode.

Get_N_Axes 

function Get_N_Axes 
(Self: not null access Gdk_Device_Record) return Gint;
Returns the number of axes the device currently has. Since: gtk+ 3.0

Get_N_Keys 

function Get_N_Keys 
(Self: not null access Gdk_Device_Record) return Gint;
Returns the number of keys the device currently has. Since: gtk+ 2.24

Get_Name 

function Get_Name 
(Self: not null access Gdk_Device_Record) return UTF8_String;
Determines the name of the device. Since: gtk+ 2.20

Get_Source 

function Get_Source 
(Self: not null access Gdk_Device_Record) return Gdk_Input_Source;
Determines the type of the device. Since: gtk+ 2.20

Get_State 

procedure Get_State 
(Self: not null access Gdk_Device_Record;
Window: Gdk.Gdk_Window;
Axes: in out Gdouble;
Mask: in out Gdk.Types.Gdk_Modifier_Type);
Gets the current state of a pointer device relative to Window. As a slave device coordinates are those of its master pointer, This function may not be called on devices of type Gdk.Device.Gdk_Device_Type_Slave, unless there is an ongoing grab on them, see Gdk.Device.Grab. "window": a Gdk.Gdk_Window. "axes": an array of doubles to store the values of the axes of Device in, or null. "mask": location to store the modifiers, or null.

Grab 

function Grab 
(Self: not null access Gdk_Device_Record;
Window: Gdk.Gdk_Window;
Grab_Ownership: Gdk_Grab_Ownership;
Owner_Events: Boolean;
Event_Mask: Gdk.Event.Gdk_Event_Mask;
Cursor: Gdk.Gdk_Cursor;
Time: Guint32) return Gdk_Grab_Status;
Grabs the device so that all events coming from this device are passed to this application until the device is ungrabbed with Gdk.Device.Ungrab, or the window becomes unviewable. This overrides any previous grab on the device by this client. Device grabs are used for operations which need complete control over the given device events (either pointer or keyboard). For example in GTK+ this is used for Drag and Drop operations, popup menus and such. Note that if the event mask of an X window has selected both button press and button release events, then a button press event will cause an automatic pointer grab until the button is released. X does this automatically since most applications expect to receive button press and release events in pairs. It is equivalent to a pointer grab on the window with Owner_Events set to True. If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the Gdk.Event.Gdk_Event_Grab_Broken events that are emitted when the grab ends unvoluntarily. Since: gtk+ 3.0 "window": the Gdk.Gdk_Window which will own the grab (the grab window) "grab_ownership": specifies the grab ownership. "owner_events": if False then all device events are reported with respect to Window and are only reported if selected by Event_Mask. If True then pointer events for this application are reported as normal, but pointer events outside this application are reported with respect to Window and only if selected by Event_Mask. In either mode, unreported events are discarded. "event_mask": specifies the event mask, which is used in accordance with Owner_Events. "cursor": the cursor to display while the grab is active if the device is a pointer. If this is null then the normal cursors are used for Window and its descendants, and the cursor for Window is used elsewhere. "time_": the timestamp of the event which led to this pointer grab. This usually comes from the Gdk.Event.Gdk_Event struct, though GDK_CURRENT_TIME can be used if the time isn't known.

Set_Key 

procedure Set_Key 
(Self: not null access Gdk_Device_Record;
Index: Guint;
Keyval: Guint;
Modifiers: Gdk.Types.Gdk_Modifier_Type);
Specifies the X key event to generate when a macro button of a device is pressed. "index_": the index of the macro button to set "keyval": the keyval to generate "modifiers": the modifiers to set

Ungrab 

procedure Ungrab 
(Self: not null access Gdk_Device_Record;
Time: Guint32);
Release any grab on Device. Since: gtk+ 3.0 "time_": a timestap (e.g. GDK_CURRENT_TIME).

Warp 

procedure Warp 
(Self: not null access Gdk_Device_Record;
Screen: not null access Gdk.Screen.Gdk_Screen_Record'Class;
X: Gint;
Y: Gint);
Warps Device in Display to the point X,Y on the screen Screen, unless the device is confined to a window by a grab, in which case it will be moved as far as allowed by the grab. Warping the pointer creates events as if the user had moved the mouse instantaneously to the destination. Note that the pointer should normally be under the control of the user. This function was added to cover some rare use cases like keyboard navigation support for the color picker in the Gtk.Color_Selection_Dialog.Gtk_Color_Selection_Dialog. Since: gtk+ 3.0 "screen": the screen to warp Device to. "x": the X coordinate of the destination. "y": the Y coordinate of the destination.

Get_Window_At_Position 

procedure Get_Window_At_Position 
(Self: not null access Gdk_Device_Record;
Win_X: out Gint;
Win_Y: out Gint;
Window: out Gdk.Gdk_Window);
Obtains the window underneath Device, returning the location of the device in Win_X and Win_Y. Returns null if the window tree under Device is not known to GDK (for example, belongs to another application). As a slave device coordinates are those of its master pointer, This function may not be called on devices of type Gdk.Device.Gdk_Device_Type_Slave, unless there is an ongoing grab on them, see Gdk.Device.Grab. Since: gtk+ 3.0 "win_x": return location for the X coordinate of the device location, relative to the window origin, or null. "win_y": return location for the Y coordinate of the device location, relative to the window origin, or null.

Set_Device 

procedure Set_Device 
(Event: Gdk.Event.Gdk_Event;
Device: not null access Gdk_Device_Record);
Sets the device for Event to Device. The event must have been allocated by GTK+, for instance, by gdk_event_copy().

Set_Source_Device 

procedure Set_Source_Device 
(Event: Gdk.Event.Gdk_Event;
Device: not null access Gdk_Device_Record);
Sets the slave device for Event to Device. The event must have been allocated by GTK+, for instance by gdk_event_copy().