gi-gdkx11-4.0.1: GdkX11 bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.GdkX11.Functions

Description

 
Synopsis

Methods

disableMultidevice

disableMultidevice :: (HasCallStack, MonadIO m) => m () Source #

Disables multidevice support in GDKs X11 backend. This call must happen prior to displayOpen, gtk_init() or gtk_init_check() in order to take effect.

Most common GTK+ applications won’t ever need to call this. Only applications that do mixed GDK/Xlib calls could want to disable multidevice support if such Xlib code deals with input devices in any way and doesn’t observe the presence of XInput 2.

x11AtomToXatomForDisplay

x11AtomToXatomForDisplay Source #

Arguments

:: (HasCallStack, MonadIO m, IsX11Display a) 
=> a

display: A Display

-> Text

atom: A GdkAtom, or Nothing

-> m CULong

Returns: the X atom corresponding to atom, or None

Converts from a GdkAtom to the X atom for a Display with the same string value. The special value Nothing is converted to None.

x11DeviceGetId

x11DeviceGetId Source #

Arguments

:: (HasCallStack, MonadIO m, IsX11DeviceCore a) 
=> a

device: a Device

-> m Int32

Returns: the XInput2 device ID.

Returns the device ID as seen by XInput2.

If 'GI.GdkX11.Functions.disableMultidevice' has been called, this function
will respectively return 2\/3 for the core pointer and keyboard,
(matching the IDs for the Virtual Core Pointer and Keyboard in
XInput 2), but calling this function on any slave devices (i.e.
those managed via XInput 1.x), will return 0.

x11DeviceManagerLookup

x11DeviceManagerLookup Source #

Arguments

:: (HasCallStack, MonadIO m, IsX11DeviceManagerCore a) 
=> a

deviceManager: a GdkDeviceManager

-> Int32

deviceId: a device ID, as understood by the XInput2 protocol

-> m (Maybe X11DeviceCore)

Returns: The Device wrapping the device ID, or Nothing if the given ID doesn’t currently represent a device.

Returns the Device that wraps the given device ID.

x11FreeCompoundText

x11FreeCompoundText Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Word8

ctext: The pointer stored in ctext from a call to x11DisplayStringToCompoundText.

-> m () 

Frees the data returned from x11DisplayStringToCompoundText.

x11FreeTextList

x11FreeTextList Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

list: the value stored in the list parameter by a call to x11DisplayTextPropertyToTextList.

-> m () 

Frees the array of strings created by x11DisplayTextPropertyToTextList.

x11GetServerTime

x11GetServerTime Source #

Arguments

:: (HasCallStack, MonadIO m, IsX11Surface a) 
=> a

surface: a Surface, used for communication with the server. The surface must have GDK_PROPERTY_CHANGE_MASK in its events mask or a hang will result.

-> m Word32

Returns: the time stamp.

Routine to get the current X server time stamp.

x11GetXatomByNameForDisplay

x11GetXatomByNameForDisplay Source #

Arguments

:: (HasCallStack, MonadIO m, IsX11Display a) 
=> a

display: a Display

-> Text

atomName: a string

-> m CULong

Returns: a X atom for a Display

Returns the X atom for a Display corresponding to atomName. This function caches the result, so if called repeatedly it is much faster than XInternAtom(), which is a round trip to the server each time.

x11GetXatomNameForDisplay

x11GetXatomNameForDisplay Source #

Arguments

:: (HasCallStack, MonadIO m, IsX11Display a) 
=> a

display: the Display where xatom is defined

-> CULong

xatom: an X atom

-> m Text

Returns: name of the X atom; this string is owned by GDK, so it shouldn’t be modifed or freed.

Returns the name of an X atom for its display. This function is meant mainly for debugging, so for convenience, unlike XAtomName() and the result doesn’t need to be freed.

x11LookupXdisplay

x11LookupXdisplay Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Display

xdisplay: a pointer to an X Display

-> m X11Display

Returns: the Display, if found, otherwise Nothing.

Find the Display corresponding to xdisplay, if any exists.

x11RegisterStandardEventType

x11RegisterStandardEventType Source #

Arguments

:: (HasCallStack, MonadIO m, IsX11Display a) 
=> a

display: a Display

-> Int32

eventBase: first event type code to register

-> Int32

nEvents: number of event type codes to register

-> m () 

Registers interest in receiving extension events with type codes between eventBase and event_base + n_events - 1. The registered events must have the window field in the same place as core X events (this is not the case for e.g. XKB extension events).

GDK may register the events of some X extensions on its own.

This function should only be needed in unusual circumstances, e.g. when filtering XInput extension events on the root window.

x11SetSmClientId

x11SetSmClientId Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Maybe Text

smClientId: the client id assigned by the session manager when the connection was opened, or Nothing to remove the property.

-> m () 

Sets the SM_CLIENT_ID property on the application’s leader window so that the window manager can save the application’s state using the X11R6 ICCCM session management protocol.

See the X Session Management Library documentation for more information on session management and the Inter-Client Communication Conventions Manual

x11XatomToAtomForDisplay

x11XatomToAtomForDisplay Source #

Arguments

:: (HasCallStack, MonadIO m, IsX11Display a) 
=> a

display: A Display

-> CULong

xatom: an X atom

-> m Text

Returns: the corresponding GdkAtom.

Convert from an X atom for a Display to the corresponding GdkAtom.