| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gio.Objects.DBusObjectProxy
Description
A DBusObjectProxy is an object used to represent a remote object
with one or more D-Bus interfaces. Normally, you don't instantiate
a DBusObjectProxy yourself - typically DBusObjectManagerClient
is used to obtain it.
Since: 2.30
Synopsis
- newtype DBusObjectProxy = DBusObjectProxy (ManagedPtr DBusObjectProxy)
- class GObject o => IsDBusObjectProxy o
- toDBusObjectProxy :: (MonadIO m, IsDBusObjectProxy o) => o -> m DBusObjectProxy
- noDBusObjectProxy :: Maybe DBusObjectProxy
- dBusObjectProxyGetConnection :: (HasCallStack, MonadIO m, IsDBusObjectProxy a) => a -> m DBusConnection
- dBusObjectProxyNew :: (HasCallStack, MonadIO m, IsDBusConnection a) => a -> Text -> m DBusObjectProxy
- constructDBusObjectProxyGConnection :: (IsDBusObjectProxy o, IsDBusConnection a) => a -> IO (GValueConstruct o)
- getDBusObjectProxyGConnection :: (MonadIO m, IsDBusObjectProxy o) => o -> m (Maybe DBusConnection)
- constructDBusObjectProxyGObjectPath :: IsDBusObjectProxy o => Text -> IO (GValueConstruct o)
- getDBusObjectProxyGObjectPath :: (MonadIO m, IsDBusObjectProxy o) => o -> m (Maybe Text)
Exported types
newtype DBusObjectProxy Source #
Memory-managed wrapper type.
Constructors
| DBusObjectProxy (ManagedPtr DBusObjectProxy) |
Instances
| GObject DBusObjectProxy Source # | |
Defined in GI.Gio.Objects.DBusObjectProxy Methods gobjectType :: DBusObjectProxy -> IO GType # | |
| IsObject DBusObjectProxy Source # | |
Defined in GI.Gio.Objects.DBusObjectProxy | |
| IsDBusObject DBusObjectProxy Source # | |
Defined in GI.Gio.Objects.DBusObjectProxy | |
| IsDBusObjectProxy DBusObjectProxy Source # | |
Defined in GI.Gio.Objects.DBusObjectProxy | |
class GObject o => IsDBusObjectProxy o Source #
Type class for types which can be safely cast to DBusObjectProxy, for instance with toDBusObjectProxy.
Instances
| (GObject a, (UnknownAncestorError DBusObjectProxy a :: Constraint)) => IsDBusObjectProxy a Source # | |
Defined in GI.Gio.Objects.DBusObjectProxy | |
| IsDBusObjectProxy DBusObjectProxy Source # | |
Defined in GI.Gio.Objects.DBusObjectProxy | |
toDBusObjectProxy :: (MonadIO m, IsDBusObjectProxy o) => o -> m DBusObjectProxy Source #
Cast to DBusObjectProxy, for types for which this is known to be safe. For general casts, use castTo.
noDBusObjectProxy :: Maybe DBusObjectProxy Source #
A convenience alias for Nothing :: Maybe DBusObjectProxy.
Methods
getConnection
dBusObjectProxyGetConnection Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDBusObjectProxy a) | |
| => a |
|
| -> m DBusConnection | Returns: A |
Gets the connection that proxy is for.
Since: 2.30
new
Arguments
| :: (HasCallStack, MonadIO m, IsDBusConnection a) | |
| => a |
|
| -> Text |
|
| -> m DBusObjectProxy | Returns: a new |
Creates a new DBusObjectProxy for the given connection and
object path.
Since: 2.30
Properties
gConnection
The connection of the proxy.
Since: 2.30
constructDBusObjectProxyGConnection :: (IsDBusObjectProxy o, IsDBusConnection a) => a -> IO (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “g-connection” property. This is rarely needed directly, but it is used by new.
getDBusObjectProxyGConnection :: (MonadIO m, IsDBusObjectProxy o) => o -> m (Maybe DBusConnection) Source #
Get the value of the “g-connection” property.
When overloading is enabled, this is equivalent to
get dBusObjectProxy #gConnection
gObjectPath
The object path of the proxy.
Since: 2.30
constructDBusObjectProxyGObjectPath :: IsDBusObjectProxy o => Text -> IO (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “g-object-path” property. This is rarely needed directly, but it is used by new.
getDBusObjectProxyGObjectPath :: (MonadIO m, IsDBusObjectProxy o) => o -> m (Maybe Text) Source #
Get the value of the “g-object-path” property.
When overloading is enabled, this is equivalent to
get dBusObjectProxy #gObjectPath