gi-ibus-1.5.8: IBus bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.IBus.Objects.Proxy

Description

An IBusProxy is the base of all proxy objects, which communicate the corresponding IBusServices on the other end of IBusConnection. For example, IBus clients (such as editors, web browsers) invoke the proxy object, IBusInputContext to communicate with the InputContext service of the ibus-daemon.

Almost all services have corresponding proxies, except very simple services.

Synopsis

Exported types

newtype Proxy Source #

Memory-managed wrapper type.

Constructors

Proxy (ManagedPtr Proxy) 

Instances

Instances details
Eq Proxy Source # 
Instance details

Defined in GI.IBus.Objects.Proxy

Methods

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

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

GObject Proxy Source # 
Instance details

Defined in GI.IBus.Objects.Proxy

ManagedPtrNewtype Proxy Source # 
Instance details

Defined in GI.IBus.Objects.Proxy

Methods

toManagedPtr :: Proxy -> ManagedPtr Proxy

TypedObject Proxy Source # 
Instance details

Defined in GI.IBus.Objects.Proxy

Methods

glibType :: IO GType

HasParentTypes Proxy Source # 
Instance details

Defined in GI.IBus.Objects.Proxy

IsGValue (Maybe Proxy) Source #

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

Instance details

Defined in GI.IBus.Objects.Proxy

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Proxy Source # 
Instance details

Defined in GI.IBus.Objects.Proxy

type ParentTypes Proxy = '[DBusProxy, Object, AsyncInitable, DBusInterface, Initable]

class (GObject o, IsDescendantOf Proxy o) => IsProxy o Source #

Type class for types which can be safely cast to Proxy, for instance with toProxy.

Instances

Instances details
(GObject o, IsDescendantOf Proxy o) => IsProxy o Source # 
Instance details

Defined in GI.IBus.Objects.Proxy

toProxy :: (MonadIO m, IsProxy o) => o -> m Proxy Source #

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

Methods

destroy

proxyDestroy Source #

Arguments

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

proxy: An Proxy

-> m () 

Dispose the proxy object. If the dbus connection is alive and the own variable above is TRUE (which is the default), org.freedesktop.IBus.Service.Destroy method will be called. Note that "destroy" signal might be emitted when ibus_proxy_destroy is called or the underlying dbus connection for the proxy is terminated. In the callback of the destroy signal, you might have to call something like 'g_object_unref(the_proxy);'.

Signals

destroy

type ProxyDestroyCallback = IO () Source #

Destroy and free an IBusProxy

See also: proxyDestroy.

<note><para>Argument userData is ignored in this function.</para></note>

afterProxyDestroy :: (IsProxy a, MonadIO m) => a -> ((?self :: a) => ProxyDestroyCallback) -> m SignalHandlerId Source #

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

after proxy #destroy 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.

onProxyDestroy :: (IsProxy a, MonadIO m) => a -> ((?self :: a) => ProxyDestroyCallback) -> m SignalHandlerId Source #

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

on proxy #destroy callback