Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Wnck.Objects.Handle

Contents

Exported types
Methods
Properties
- clientType

Description

No description available in the introspection data.

Synopsis

newtype Handle = Handle (ManagedPtr Handle)
class (GObject o, IsDescendantOf Handle o) => IsHandle o
toHandle :: (MonadIO m, IsHandle o) => o -> m Handle
handleGetApplication :: (HasCallStack, MonadIO m, IsHandle a) => a -> CULong -> m Application
handleGetClassGroup :: (HasCallStack, MonadIO m, IsHandle a) => a -> Text -> m ClassGroup
handleGetDefaultScreen :: (HasCallStack, MonadIO m, IsHandle a) => a -> m (Maybe Screen)
handleGetScreen :: (HasCallStack, MonadIO m, IsHandle a) => a -> Int32 -> m Screen
handleGetScreenForRoot :: (HasCallStack, MonadIO m, IsHandle a) => a -> CULong -> m Screen
handleGetWindow :: (HasCallStack, MonadIO m, IsHandle a) => a -> CULong -> m Window
handleNew :: (HasCallStack, MonadIO m) => ClientType -> m Handle
handleSetDefaultIconSize :: (HasCallStack, MonadIO m, IsHandle a) => a -> Word64 -> m ()
handleSetDefaultMiniIconSize :: (HasCallStack, MonadIO m, IsHandle a) => a -> Word64 -> m ()
constructHandleClientType :: (IsHandle o, MonadIO m) => ClientType -> m (GValueConstruct o)
getHandleClientType :: (MonadIO m, IsHandle o) => o -> m ClientType
setHandleClientType :: (MonadIO m, IsHandle o) => o -> ClientType -> m ()

Exported types

newtype Handle Source #

Memory-managed wrapper type.

Constructors

Handle (ManagedPtr Handle)

Instances

Instances details

Eq Handle Source #
Instance details Defined in GI.Wnck.Objects.Handle Methods (==) :: Handle -> Handle -> Bool # (/=) :: Handle -> Handle -> Bool #
GObject Handle Source #
Instance details Defined in GI.Wnck.Objects.Handle
ManagedPtrNewtype Handle Source #
Instance details Defined in GI.Wnck.Objects.Handle Methods toManagedPtr :: Handle -> ManagedPtr Handle
TypedObject Handle Source #
Instance details Defined in GI.Wnck.Objects.Handle Methods glibType :: IO GType
HasParentTypes Handle Source #
Instance details Defined in GI.Wnck.Objects.Handle
IsGValue (Maybe Handle) Source #	Convert `Handle` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Wnck.Objects.Handle Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Handle -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Handle)
type ParentTypes Handle Source #
Instance details Defined in GI.Wnck.Objects.Handle type ParentTypes Handle = '[Object]

class (GObject o, IsDescendantOf Handle o) => IsHandle o Source #

Type class for types which can be safely cast to Handle, for instance with toHandle.

Instances

Instances details

(GObject o, IsDescendantOf Handle o) => IsHandle o Source #
Instance details Defined in GI.Wnck.Objects.Handle

toHandle :: (MonadIO m, IsHandle o) => o -> m Handle Source #

Cast to Handle, 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

getApplication

handleGetApplication Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandle a)
=> a	`self`: a `Handle`
-> CULong	`xwindow`: the X window ID of a group leader.
-> m Application	Returns: the `Application` corresponding to `xwindow`, or `Nothing` if there no such `Application` could be found. The returned `Application` is owned by libwnck and must not be referenced or unreferenced.

Gets the Application corresponding to the group leader with xwindow as X window ID.

getClassGroup

handleGetClassGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandle a)
=> a	`self`: a `Handle`
-> Text	`id`: identifier name of the sought resource class.
-> m ClassGroup	Returns: the `ClassGroup` corresponding to `id`, or `Nothing` if there is no `ClassGroup` with the specified `id`. The returned `ClassGroup` is owned by libwnck and must not be referenced or unreferenced.

Gets the ClassGroup corresponding to id.

getDefaultScreen

handleGetDefaultScreen Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandle a)
=> a	`self`: a `Handle`
-> m (Maybe Screen)	Returns: the default `Screen`. The returned `Screen` is owned by `Handle` and must not be referenced or unreferenced. This can return `Nothing` if not on X11.

Gets the default Screen on the default display.

getScreen

handleGetScreen Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandle a)
=> a	`self`: a `Handle`
-> Int32	`index`: screen number, starting from 0.
-> m Screen	Returns: the `Screen` for screen `index`, or `Nothing` if no such screen exists. The returned `Screen` is owned by `Handle` and must not be referenced or unreferenced.

Gets the Screen for a given screen on the default display.

getScreenForRoot

handleGetScreenForRoot Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandle a)
=> a	`self`: a `Handle`
-> CULong	`rootWindowId`: an X window ID.
-> m Screen	Returns: the `Screen` for the root window at `rootWindowId`, or `Nothing`. The returned `Screen` is owned by `Handle` and must not be referenced or unreferenced.

Gets the Screen for the root window at rootWindowId, or Nothing if no Screen exists for this root window.

This function does not work if handleGetScreen was not called for the sought Screen before, and returns Nothing.

getWindow

handleGetWindow Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandle a)
=> a	`self`: a `Handle`
-> CULong	`xwindow`: an X window ID.
-> m Window	Returns: the `Window` for `xwindow`. The returned `Window` is owned by libwnck and must not be referenced or unreferenced.

Gets a preexisting Window for the X window xwindow. This will not create a Window if none exists. The function is robust against bogus window IDs.

new

handleNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ClientType	`clientType`: a role for the client
-> m Handle	Returns: newly created `Handle`.

Creates a new Handle object with a given clientType.

setDefaultIconSize

handleSetDefaultIconSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandle a)
=> a	`self`: a `Handle`
-> Word64	`iconSize`: the default size for windows and application standard icons.
-> m ()

The default main icon size is DEFAULT_ICON_SIZE. This function allows to change this value.

setDefaultMiniIconSize

handleSetDefaultMiniIconSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandle a)
=> a	`self`: a `Handle`
-> Word64	`iconSize`: the default size for windows and application mini icons.
-> m ()

The default main icon size is DEFAULT_MINI_ICON_SIZE. This function allows to change this value.

Properties

clientType

No description available in the introspection data.

constructHandleClientType :: (IsHandle o, MonadIO m) => ClientType -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “client-type” property. This is rarely needed directly, but it is used by new.

getHandleClientType :: (MonadIO m, IsHandle o) => o -> m ClientType Source #

Get the value of the “client-type” property. When overloading is enabled, this is equivalent to

get handle #clientType

setHandleClientType :: (MonadIO m, IsHandle o) => o -> ClientType -> m () Source #

Set the value of the “client-type” property. When overloading is enabled, this is equivalent to

set handle [ #clientType := value ]

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

getApplication

getClassGroup

getDefaultScreen

getScreen

getScreenForRoot

getWindow

new

setDefaultIconSize

setDefaultMiniIconSize

Properties

clientType