gi-wnck-3.0.4: Wnck bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Wnck.Objects.Application

Contents

Description

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

Synopsis

Exported types

newtype Application Source #

Memory-managed wrapper type.

Constructors

Application (ManagedPtr Application) 
Instances
GObject Application Source # 
Instance details

Defined in GI.Wnck.Objects.Application

Methods

gobjectType :: IO GType

HasParentTypes Application Source # 
Instance details

Defined in GI.Wnck.Objects.Application

type ParentTypes Application Source # 
Instance details

Defined in GI.Wnck.Objects.Application

type ParentTypes Application = Object ': ([] :: [Type])

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

noApplication :: Maybe Application Source #

A convenience alias for Nothing :: Maybe Application.

Methods

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.

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.

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.

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.

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.

type C_ApplicationIconChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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

Connect a signal handler for the “icon-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after application #iconChanged callback

genClosure_ApplicationIconChanged :: MonadIO m => ApplicationIconChangedCallback -> m (GClosure C_ApplicationIconChangedCallback) Source #

Wrap the callback into a GClosure.

mk_ApplicationIconChangedCallback :: C_ApplicationIconChangedCallback -> IO (FunPtr C_ApplicationIconChangedCallback) Source #

Generate a function pointer callable from C code, from a C_ApplicationIconChangedCallback.

noApplicationIconChangedCallback :: Maybe ApplicationIconChangedCallback Source #

A convenience synonym for Nothing :: Maybe ApplicationIconChangedCallback.

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

Connect a signal handler for the “icon-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on application #iconChanged callback

wrap_ApplicationIconChangedCallback :: ApplicationIconChangedCallback -> C_ApplicationIconChangedCallback Source #

Wrap a ApplicationIconChangedCallback into a C_ApplicationIconChangedCallback.

nameChanged

type ApplicationNameChangedCallback = IO () Source #

Emitted when the name of app changes.

type C_ApplicationNameChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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

Connect a signal handler for the “name-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after application #nameChanged callback

genClosure_ApplicationNameChanged :: MonadIO m => ApplicationNameChangedCallback -> m (GClosure C_ApplicationNameChangedCallback) Source #

Wrap the callback into a GClosure.

mk_ApplicationNameChangedCallback :: C_ApplicationNameChangedCallback -> IO (FunPtr C_ApplicationNameChangedCallback) Source #

Generate a function pointer callable from C code, from a C_ApplicationNameChangedCallback.

noApplicationNameChangedCallback :: Maybe ApplicationNameChangedCallback Source #

A convenience synonym for Nothing :: Maybe ApplicationNameChangedCallback.

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

Connect a signal handler for the “name-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on application #nameChanged callback

wrap_ApplicationNameChangedCallback :: ApplicationNameChangedCallback -> C_ApplicationNameChangedCallback Source #

Wrap a ApplicationNameChangedCallback into a C_ApplicationNameChangedCallback.