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.Application

Contents

Exported types
Methods
Signals
- iconChanged
- nameChanged

Description

The Application struct contains only private fields and should not be directly accessed.

Synopsis

newtype Application = Application (ManagedPtr Application)
class (GObject o, IsDescendantOf Application o) => IsApplication o
toApplication :: (MonadIO m, IsApplication o) => o -> m Application
applicationGet :: (HasCallStack, MonadIO m) => CULong -> m Application
applicationGetIcon :: (HasCallStack, MonadIO m, IsApplication a) => a -> m Pixbuf
applicationGetIconIsFallback :: (HasCallStack, MonadIO m, IsApplication a) => a -> m Bool
applicationGetIconName :: (HasCallStack, MonadIO m, IsApplication a) => a -> m Text
applicationGetIconSurface :: (HasCallStack, MonadIO m, IsApplication a) => a -> m Surface
applicationGetMiniIcon :: (HasCallStack, MonadIO m, IsApplication a) => a -> m Pixbuf
applicationGetMiniIconSurface :: (HasCallStack, MonadIO m, IsApplication a) => a -> m Surface
applicationGetNWindows :: (HasCallStack, MonadIO m, IsApplication a) => a -> m Int32
applicationGetName :: (HasCallStack, MonadIO m, IsApplication a) => a -> m Text
applicationGetPid :: (HasCallStack, MonadIO m, IsApplication a) => a -> m Int32
applicationGetStartupId :: (HasCallStack, MonadIO m, IsApplication a) => a -> m Text
applicationGetWindows :: (HasCallStack, MonadIO m, IsApplication a) => a -> m [Window]
applicationGetXid :: (HasCallStack, MonadIO m, IsApplication a) => a -> m CULong
type ApplicationIconChangedCallback = IO ()
afterApplicationIconChanged :: (IsApplication a, MonadIO m) => a -> ((?self :: a) => ApplicationIconChangedCallback) -> m SignalHandlerId
onApplicationIconChanged :: (IsApplication a, MonadIO m) => a -> ((?self :: a) => ApplicationIconChangedCallback) -> m SignalHandlerId
type ApplicationNameChangedCallback = IO ()
afterApplicationNameChanged :: (IsApplication a, MonadIO m) => a -> ((?self :: a) => ApplicationNameChangedCallback) -> m SignalHandlerId
onApplicationNameChanged :: (IsApplication a, MonadIO m) => a -> ((?self :: a) => ApplicationNameChangedCallback) -> m SignalHandlerId

Exported types

newtype Application Source #

Memory-managed wrapper type.

Constructors

Application (ManagedPtr Application)

Instances

Instances details

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

class (GObject o, IsDescendantOf Application o) => IsApplication o Source #

Type class for types which can be safely cast to Application, for instance with toApplication.

Instances

Instances details

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

toApplication :: (MonadIO m, IsApplication o) => o -> m Application Source #

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

get

applicationGet Source #

Arguments

:: (HasCallStack, MonadIO m)
=> 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.

getIcon

applicationGetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)
=> a	`app`: a `Application`.
-> m Pixbuf	Returns: the icon for `app`. The caller should reference the returned <classname>GdkPixbuf</classname> if it needs to keep the icon around.

Deprecated: (Since version 41.0)Use applicationGetIconSurface instead.

Gets the icon to be used for app. If no icon is set for app, a suboptimal heuristic is used to find an appropriate icon. If no icon was found, a fallback icon is used.

getIconIsFallback

applicationGetIconIsFallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)
=> a	`app`: a `Application`
-> m Bool	Returns: `True` if the icon for `app` is a fallback, `False` otherwise.

Gets whether a default fallback icon is used for app (because none was set on app).

getIconName

applicationGetIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)
=> a	`app`: a `Application`
-> m Text	Returns: the icon name of `app`, or a fallback icon name if no icon name is available.

Gets the icon name of app (to be used when app is minimized). Since there is no way to properly find this name, various suboptimal heuristics are used to find it.

getIconSurface

applicationGetIconSurface Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)
=> a	`app`: a `Application`.
-> m Surface	Returns: a reference to the icon-surface for `app`. The caller should unreference the <classname>cairo_surface_t</classname> once done with it.

Gets the icon-surface to be used for app. If no icon-surfaceis set for app, a suboptimal heuristic is used to find an appropriate icon. If no icon-surface was found, a fallback icon-surface is used.

getMiniIcon

applicationGetMiniIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)
=> a	`app`: a `Application`.
-> m Pixbuf	Returns: the mini-icon for `app`. The caller should reference the returned <classname>GdkPixbuf</classname> if it needs to keep the mini-icon around.

Deprecated: (Since version 41.0)Use applicationGetMiniIconSurface instead.

Gets the mini-icon to be used for app. If no mini-icon is set for app, a suboptimal heuristic is used to find an appropriate icon. If no mini-icon was found, a fallback mini-icon is used.

getMiniIconSurface

applicationGetMiniIconSurface Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)
=> a	`app`: a `Application`.
-> m Surface	Returns: a reference to the mini-icon-surface for `app`. The caller should unreference the <classname>cairo_surface_t</classname> once done with it.

Gets the mini-icon-surface to be used for app. If no mini-icon-surfaceis set for app, a suboptimal heuristic is used to find an appropriate icon. If no mini-icon-surface was found, a fallback mini-icon-surface is used.

getNWindows

applicationGetNWindows Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)
=> a	`app`: a `Application`.
-> m Int32	Returns: the number of `Window` belonging to `app`.

Gets the number of Window belonging to app.

getName

applicationGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)
=> a	`app`: a `Application`.
-> m Text	Returns: the name of `app`, or a fallback name if no name is available.

Gets the name of app. Since there is no way to properly find this name, various suboptimal heuristics are used to find it. GTK+ should probably have a function to allow applications to set the _NET_WM_NAME property on the group leader as the application name, and the <ulink url="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html">EWMH</ulink> should say that this is where the application name goes.

getPid

applicationGetPid Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)
=> a	`app`: a `Application`.
-> m Int32	Returns: the process ID of `app`, or 0 if none is available.

Gets the process ID of app.

getStartupId

applicationGetStartupId Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)
=> a	`app`: a `Application`.
-> m Text	Returns: the startup sequence ID used for startup notification of `app`, or `Nothing` if none is available.

Gets the startup sequence ID used for startup notification of app.

Since: 2.2

getWindows

applicationGetWindows Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)
=> a	`app`: a `Application`.
-> m [Window]	Returns: the list of `Window` belonging to `app`, or `Nothing` if the application contains no window. The list should not be modified nor freed, as it is owned by `app`.

Gets the list of Window belonging to app.

getXid

applicationGetXid Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)
=> a	`app`: a `Application`.
-> m CULong	Returns: the X window ID of the group leader window for `app`.

Gets the X window ID of the group leader window for app.

Signals

iconChanged

type ApplicationIconChangedCallback = IO () Source #

Emitted when the icon of app changes.

afterApplicationIconChanged :: (IsApplication a, MonadIO m) => a -> ((?self :: a) => ApplicationIconChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the iconChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after application #iconChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onApplicationIconChanged :: (IsApplication a, MonadIO m) => a -> ((?self :: a) => ApplicationIconChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the iconChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on application #iconChanged callback

nameChanged

type ApplicationNameChangedCallback = IO () Source #

Emitted when the name of app changes.

afterApplicationNameChanged :: (IsApplication a, MonadIO m) => a -> ((?self :: a) => ApplicationNameChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the nameChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after application #nameChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onApplicationNameChanged :: (IsApplication a, MonadIO m) => a -> ((?self :: a) => ApplicationNameChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the nameChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on application #nameChanged callback

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

get

getIcon

getIconIsFallback

getIconName

getIconSurface

getMiniIcon

getMiniIconSurface

getNWindows

getName

getPid

getStartupId

getWindows

getXid

Signals

iconChanged

nameChanged