| 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.GES.Objects.DiscovererManager
Description
No description available in the introspection data.
Since: 1.24
Synopsis
- newtype DiscovererManager = DiscovererManager (ManagedPtr DiscovererManager)
- class (GObject o, IsDescendantOf DiscovererManager o) => IsDiscovererManager o
- toDiscovererManager :: (MonadIO m, IsDiscovererManager o) => o -> m DiscovererManager
- discovererManagerGetDefault :: (HasCallStack, MonadIO m) => m DiscovererManager
- discovererManagerGetTimeout :: (HasCallStack, MonadIO m, IsDiscovererManager a) => a -> m Word64
- discovererManagerGetUseCache :: (HasCallStack, MonadIO m, IsDiscovererManager a) => a -> m Bool
- discovererManagerSetTimeout :: (HasCallStack, MonadIO m, IsDiscovererManager a) => a -> Word64 -> m ()
- discovererManagerSetUseCache :: (HasCallStack, MonadIO m, IsDiscovererManager a) => a -> Bool -> m ()
- constructDiscovererManagerTimeout :: (IsDiscovererManager o, MonadIO m) => Word64 -> m (GValueConstruct o)
- getDiscovererManagerTimeout :: (MonadIO m, IsDiscovererManager o) => o -> m Word64
- setDiscovererManagerTimeout :: (MonadIO m, IsDiscovererManager o) => o -> Word64 -> m ()
- constructDiscovererManagerUseCache :: (IsDiscovererManager o, MonadIO m) => Bool -> m (GValueConstruct o)
- getDiscovererManagerUseCache :: (MonadIO m, IsDiscovererManager o) => o -> m Bool
- setDiscovererManagerUseCache :: (MonadIO m, IsDiscovererManager o) => o -> Bool -> m ()
- type DiscovererManagerDiscoveredCallback = DiscovererInfo -> Maybe GError -> IO ()
- afterDiscovererManagerDiscovered :: (IsDiscovererManager a, MonadIO m) => a -> ((?self :: a) => DiscovererManagerDiscoveredCallback) -> m SignalHandlerId
- onDiscovererManagerDiscovered :: (IsDiscovererManager a, MonadIO m) => a -> ((?self :: a) => DiscovererManagerDiscoveredCallback) -> m SignalHandlerId
- type DiscovererManagerLoadSerializedInfoCallback = Text -> IO (Maybe DiscovererInfo)
- afterDiscovererManagerLoadSerializedInfo :: (IsDiscovererManager a, MonadIO m) => a -> ((?self :: a) => DiscovererManagerLoadSerializedInfoCallback) -> m SignalHandlerId
- onDiscovererManagerLoadSerializedInfo :: (IsDiscovererManager a, MonadIO m) => a -> ((?self :: a) => DiscovererManagerLoadSerializedInfoCallback) -> m SignalHandlerId
- type DiscovererManagerSourceSetupCallback = Element -> IO ()
- afterDiscovererManagerSourceSetup :: (IsDiscovererManager a, MonadIO m) => a -> ((?self :: a) => DiscovererManagerSourceSetupCallback) -> m SignalHandlerId
- onDiscovererManagerSourceSetup :: (IsDiscovererManager a, MonadIO m) => a -> ((?self :: a) => DiscovererManagerSourceSetupCallback) -> m SignalHandlerId
Exported types
newtype DiscovererManager Source #
Memory-managed wrapper type.
Constructors
| DiscovererManager (ManagedPtr DiscovererManager) |
Instances
class (GObject o, IsDescendantOf DiscovererManager o) => IsDiscovererManager o Source #
Type class for types which can be safely cast to DiscovererManager, for instance with toDiscovererManager.
Instances
| (GObject o, IsDescendantOf DiscovererManager o) => IsDiscovererManager o Source # | |
Defined in GI.GES.Objects.DiscovererManager | |
toDiscovererManager :: (MonadIO m, IsDiscovererManager o) => o -> m DiscovererManager Source #
Cast to DiscovererManager, 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
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getProperty, getQdata, getTimeout, getUseCache.
Setters
getDefault
discovererManagerGetDefault Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m DiscovererManager | Returns: The default |
No description available in the introspection data.
Since: 1.24
getTimeout
discovererManagerGetTimeout Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDiscovererManager a) | |
| => a |
|
| -> m Word64 | Returns: The timeout to use for the discoverer |
No description available in the introspection data.
Since: 1.24
getUseCache
discovererManagerGetUseCache Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDiscovererManager a) | |
| => a |
|
| -> m Bool | Returns: Whether to use the cache or not |
No description available in the introspection data.
Since: 1.24
setTimeout
discovererManagerSetTimeout Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDiscovererManager a) | |
| => a |
|
| -> Word64 |
|
| -> m () |
Sets the timeout to use for the discoverer
Since: 1.24
setUseCache
discovererManagerSetUseCache Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDiscovererManager a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether to use the cache or not
Since: 1.24
Properties
timeout
The timeout (in milliseconds) for the Discoverer operations
Since: 1.24
constructDiscovererManagerTimeout :: (IsDiscovererManager o, MonadIO m) => Word64 -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “timeout” property. This is rarely needed directly, but it is used by new.
getDiscovererManagerTimeout :: (MonadIO m, IsDiscovererManager o) => o -> m Word64 Source #
Get the value of the “timeout” property.
When overloading is enabled, this is equivalent to
get discovererManager #timeout
setDiscovererManagerTimeout :: (MonadIO m, IsDiscovererManager o) => o -> Word64 -> m () Source #
Set the value of the “timeout” property.
When overloading is enabled, this is equivalent to
setdiscovererManager [ #timeout:=value ]
useCache
No description available in the introspection data.
constructDiscovererManagerUseCache :: (IsDiscovererManager o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “use-cache” property. This is rarely needed directly, but it is used by new.
getDiscovererManagerUseCache :: (MonadIO m, IsDiscovererManager o) => o -> m Bool Source #
Get the value of the “use-cache” property.
When overloading is enabled, this is equivalent to
get discovererManager #useCache
setDiscovererManagerUseCache :: (MonadIO m, IsDiscovererManager o) => o -> Bool -> m () Source #
Set the value of the “use-cache” property.
When overloading is enabled, this is equivalent to
setdiscovererManager [ #useCache:=value ]
Signals
discovered
type DiscovererManagerDiscoveredCallback Source #
Arguments
| = DiscovererInfo |
|
| -> Maybe GError |
|
| -> IO () |
No description available in the introspection data.
Since: 1.24
afterDiscovererManagerDiscovered :: (IsDiscovererManager a, MonadIO m) => a -> ((?self :: a) => DiscovererManagerDiscoveredCallback) -> m SignalHandlerId Source #
Connect a signal handler for the discovered signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after discovererManager #discovered 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.
onDiscovererManagerDiscovered :: (IsDiscovererManager a, MonadIO m) => a -> ((?self :: a) => DiscovererManagerDiscoveredCallback) -> m SignalHandlerId Source #
Connect a signal handler for the discovered signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on discovererManager #discovered callback
loadSerializedInfo
type DiscovererManagerLoadSerializedInfoCallback Source #
Arguments
| = Text |
|
| -> IO (Maybe DiscovererInfo) | Returns: The |
Retrieves information about a URI from and external source of information, like a cache file. This is used by the discoverer to speed up the discovery.
Since: 1.24
afterDiscovererManagerLoadSerializedInfo :: (IsDiscovererManager a, MonadIO m) => a -> ((?self :: a) => DiscovererManagerLoadSerializedInfoCallback) -> m SignalHandlerId Source #
Connect a signal handler for the loadSerializedInfo signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after discovererManager #loadSerializedInfo 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.
onDiscovererManagerLoadSerializedInfo :: (IsDiscovererManager a, MonadIO m) => a -> ((?self :: a) => DiscovererManagerLoadSerializedInfoCallback) -> m SignalHandlerId Source #
Connect a signal handler for the loadSerializedInfo signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on discovererManager #loadSerializedInfo callback
sourceSetup
type DiscovererManagerSourceSetupCallback Source #
Allows to setup the source element before the discoverer runs.
Since: 1.24
afterDiscovererManagerSourceSetup :: (IsDiscovererManager a, MonadIO m) => a -> ((?self :: a) => DiscovererManagerSourceSetupCallback) -> m SignalHandlerId Source #
Connect a signal handler for the sourceSetup signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after discovererManager #sourceSetup 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.
onDiscovererManagerSourceSetup :: (IsDiscovererManager a, MonadIO m) => a -> ((?self :: a) => DiscovererManagerSourceSetupCallback) -> m SignalHandlerId Source #
Connect a signal handler for the sourceSetup signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on discovererManager #sourceSetup callback