gi-gdkx11-4.0.7: GdkX11 bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.GdkX11.Objects.X11Surface

Description

No description available in the introspection data.

Synopsis

Exported types

newtype X11Surface Source #

Memory-managed wrapper type.

Constructors

X11Surface (ManagedPtr X11Surface) 

Instances

Instances details
Eq X11Surface Source # 
Instance details

Defined in GI.GdkX11.Objects.X11Surface

Methods

(==) :: X11Surface -> X11Surface -> Bool #

(/=) :: X11Surface -> X11Surface -> Bool #

GObject X11Surface Source # 
Instance details

Defined in GI.GdkX11.Objects.X11Surface

ManagedPtrNewtype X11Surface Source # 
Instance details

Defined in GI.GdkX11.Objects.X11Surface

Methods

toManagedPtr :: X11Surface -> ManagedPtr X11Surface

TypedObject X11Surface Source # 
Instance details

Defined in GI.GdkX11.Objects.X11Surface

Methods

glibType :: IO GType

HasParentTypes X11Surface Source # 
Instance details

Defined in GI.GdkX11.Objects.X11Surface

IsGValue (Maybe X11Surface) Source #

Convert X11Surface to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.GdkX11.Objects.X11Surface

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe X11Surface -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe X11Surface)

type ParentTypes X11Surface Source # 
Instance details

Defined in GI.GdkX11.Objects.X11Surface

type ParentTypes X11Surface = '[Surface, Object]

class (GObject o, IsDescendantOf X11Surface o) => IsX11Surface o Source #

Type class for types which can be safely cast to X11Surface, for instance with toX11Surface.

Instances

Instances details
(GObject o, IsDescendantOf X11Surface o) => IsX11Surface o Source # 
Instance details

Defined in GI.GdkX11.Objects.X11Surface

toX11Surface :: (MonadIO m, IsX11Surface o) => o -> m X11Surface Source #

Cast to X11Surface, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

beep, bindProperty, bindPropertyFull, createCairoContext, createGlContext, createSimilarSurface, createVulkanContext, destroy, forceFloating, freezeNotify, getv, hide, isDestroyed, isFloating, moveToCurrentDesktop, moveToDesktop, notify, notifyByPspec, queueRender, ref, refSink, requestLayout, runDispose, stealData, stealQdata, thawNotify, translateCoordinates, unref, watchClosure.

Getters

getCursor, getData, getDesktop, getDeviceCursor, getDevicePosition, getDisplay, getFrameClock, getGroup, getHeight, getMapped, getProperty, getQdata, getScaleFactor, getWidth, getXid.

Setters

setCursor, setData, setDataFull, setDeviceCursor, setFrameSyncEnabled, setGroup, setInputRegion, setOpaqueRegion, setProperty, setSkipPagerHint, setSkipTaskbarHint, setThemeVariant, setUrgencyHint, setUserTime, setUtf8Property.

getDesktop

x11SurfaceGetDesktop Source #

Arguments

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

surface: a GdkSurface

-> m Word32

Returns: the current workspace of surface

Gets the number of the workspace surface is on.

getGroup

x11SurfaceGetGroup Source #

Arguments

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

surface: The GdkSurface

-> m (Maybe Surface)

Returns: The group of this surface;

Returns the group this surface belongs to.

getXid

x11SurfaceGetXid Source #

Arguments

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

surface: a native GdkSurface.

-> m CULong

Returns: the ID of drawable’s X resource.

Returns the X resource (surface) belonging to a GdkSurface.

lookupForDisplay

x11SurfaceLookupForDisplay Source #

Arguments

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

display: the GdkDisplay corresponding to the window handle

-> CULong

window: an Xlib Window

-> m X11Surface

Returns: the GdkSurface wrapper for the native window

Looks up the GdkSurface that wraps the given native window handle.

moveToCurrentDesktop

x11SurfaceMoveToCurrentDesktop Source #

Arguments

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

surface: a GdkSurface

-> m () 

Moves the surface to the correct workspace when running under a window manager that supports multiple workspaces, as described in the Extended Window Manager Hints specification. Will not do anything if the surface is already on all workspaces.

moveToDesktop

x11SurfaceMoveToDesktop Source #

Arguments

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

surface: a GdkSurface

-> Word32

desktop: the number of the workspace to move the surface to

-> m () 

Moves the surface to the given workspace when running unde a window manager that supports multiple workspaces, as described in the Extended Window Manager Hints specification.

setFrameSyncEnabled

x11SurfaceSetFrameSyncEnabled Source #

Arguments

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

surface: a native GdkSurface

-> Bool

frameSyncEnabled: whether frame-synchronization should be enabled

-> m () 

This function can be used to disable frame synchronization for a surface. Normally frame synchronziation will be enabled or disabled based on whether the system has a compositor that supports frame synchronization, but if the surface is not directly managed by the window manager, then frame synchronziation may need to be disabled. This is the case for a surface embedded via the XEMBED protocol.

setGroup

x11SurfaceSetGroup Source #

Arguments

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

surface: a native GdkSurface

-> b

leader: a GdkSurface

-> m () 

Sets the group leader of surface to be leader. See the ICCCM for details.

setSkipPagerHint

x11SurfaceSetSkipPagerHint Source #

Arguments

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

surface: a GdkSurface

-> Bool

skipsPager: True to skip pagers

-> m () 

Sets a hint on surface that pagers should not display it. See the EWMH for details.

setSkipTaskbarHint

x11SurfaceSetSkipTaskbarHint Source #

Arguments

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

surface: a native GdkSurface

-> Bool

skipsTaskbar: True to skip taskbars

-> m () 

Sets a hint on surface that taskbars should not display it. See the EWMH for details.

setThemeVariant

x11SurfaceSetThemeVariant Source #

Arguments

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

surface: a GdkSurface

-> Text

variant: the theme variant to export

-> m () 

GTK applications can request a dark theme variant. In order to make other applications - namely window managers using GTK for themeing - aware of this choice, GTK uses this function to export the requested theme variant as _GTK_THEME_VARIANT property on toplevel surfaces.

Note that this property is automatically updated by GTK, so this function should only be used by applications which do not use GTK to create toplevel surfaces.

setUrgencyHint

x11SurfaceSetUrgencyHint Source #

Arguments

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

surface: a native GdkSurface

-> Bool

urgent: True to indicate urgenct attention needed

-> m () 

Sets a hint on surface that it needs user attention. See the ICCCM for details.

setUserTime

x11SurfaceSetUserTime Source #

Arguments

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

surface: A toplevel GdkSurface

-> Word32

timestamp: An XServer timestamp to which the property should be set

-> m () 

The application can use this call to update the _NET_WM_USER_TIME property on a toplevel surface. This property stores an Xserver time which represents the time of the last user input event received for this surface. This property may be used by the window manager to alter the focus, stacking, and/or placement behavior of surfaces when they are mapped depending on whether the new surface was created by a user action or is a "pop-up" surface activated by a timer or some other event.

Note that this property is automatically updated by GDK, so this function should only be used by applications which handle input events bypassing GDK.

setUtf8Property

x11SurfaceSetUtf8Property Source #

Arguments

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

surface: a GdkSurface

-> Text

name: Property name, will be interned as an X atom

-> Maybe Text

value: Property value, or Nothing to delete

-> m () 

This function modifies or removes an arbitrary X11 window property of type UTF8_STRING. If the given surface is not a toplevel surface, it is ignored.