Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype AsyncProgress = AsyncProgress (ManagedPtr AsyncProgress)
- class (GObject o, IsDescendantOf AsyncProgress o) => IsAsyncProgress o
- toAsyncProgress :: (MonadIO m, IsAsyncProgress o) => o -> m AsyncProgress
- asyncProgressCopyState :: (HasCallStack, MonadIO m, IsAsyncProgress a, IsAsyncProgress b) => a -> b -> m ()
- asyncProgressFinish :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> m ()
- asyncProgressGetStatus :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> m (Maybe Text)
- asyncProgressGetUint :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Text -> m Word32
- asyncProgressGetUint64 :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Text -> m Word64
- asyncProgressGetVariant :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Text -> m (Maybe GVariant)
- asyncProgressNew :: (HasCallStack, MonadIO m) => m AsyncProgress
- asyncProgressNewAndConnect :: (HasCallStack, MonadIO m) => Ptr () -> Ptr () -> m AsyncProgress
- asyncProgressSetStatus :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Maybe Text -> m ()
- asyncProgressSetUint :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Text -> Word32 -> m ()
- asyncProgressSetUint64 :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Text -> Word64 -> m ()
- asyncProgressSetVariant :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Text -> GVariant -> m ()
- type AsyncProgressChangedCallback = IO ()
- type C_AsyncProgressChangedCallback = Ptr () -> Ptr () -> IO ()
- afterAsyncProgressChanged :: (IsAsyncProgress a, MonadIO m) => a -> AsyncProgressChangedCallback -> m SignalHandlerId
- genClosure_AsyncProgressChanged :: MonadIO m => AsyncProgressChangedCallback -> m (GClosure C_AsyncProgressChangedCallback)
- mk_AsyncProgressChangedCallback :: C_AsyncProgressChangedCallback -> IO (FunPtr C_AsyncProgressChangedCallback)
- noAsyncProgressChangedCallback :: Maybe AsyncProgressChangedCallback
- onAsyncProgressChanged :: (IsAsyncProgress a, MonadIO m) => a -> AsyncProgressChangedCallback -> m SignalHandlerId
- wrap_AsyncProgressChangedCallback :: AsyncProgressChangedCallback -> C_AsyncProgressChangedCallback
Exported types
newtype AsyncProgress Source #
Memory-managed wrapper type.
AsyncProgress (ManagedPtr AsyncProgress) |
Instances
Eq AsyncProgress Source # | |
Defined in GI.OSTree.Objects.AsyncProgress (==) :: AsyncProgress -> AsyncProgress -> Bool # (/=) :: AsyncProgress -> AsyncProgress -> Bool # | |
GObject AsyncProgress Source # | |
Defined in GI.OSTree.Objects.AsyncProgress | |
ManagedPtrNewtype AsyncProgress Source # | |
Defined in GI.OSTree.Objects.AsyncProgress toManagedPtr :: AsyncProgress -> ManagedPtr AsyncProgress | |
TypedObject AsyncProgress Source # | |
Defined in GI.OSTree.Objects.AsyncProgress | |
HasParentTypes AsyncProgress Source # | |
Defined in GI.OSTree.Objects.AsyncProgress | |
IsGValue (Maybe AsyncProgress) Source # | Convert |
Defined in GI.OSTree.Objects.AsyncProgress gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe AsyncProgress -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe AsyncProgress) | |
type ParentTypes AsyncProgress Source # | |
Defined in GI.OSTree.Objects.AsyncProgress |
class (GObject o, IsDescendantOf AsyncProgress o) => IsAsyncProgress o Source #
Type class for types which can be safely cast to AsyncProgress
, for instance with toAsyncProgress
.
Instances
(GObject o, IsDescendantOf AsyncProgress o) => IsAsyncProgress o Source # | |
Defined in GI.OSTree.Objects.AsyncProgress |
toAsyncProgress :: (MonadIO m, IsAsyncProgress o) => o -> m AsyncProgress Source #
Cast to AsyncProgress
, 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, copyState, finish, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getProperty, getQdata, getStatus, getUint, getUint64, getVariant.
Setters
setData, setDataFull, setProperty, setStatus, setUint, setUint64, setVariant.
copyState
asyncProgressCopyState Source #
:: (HasCallStack, MonadIO m, IsAsyncProgress a, IsAsyncProgress b) | |
=> a |
|
-> b |
|
-> m () |
Atomically copies all the state from self
to dest
, without invoking the
callback.
This is used for proxying progress objects across different GMainContexts
.
Since: 2019.6
finish
:: (HasCallStack, MonadIO m, IsAsyncProgress a) | |
=> a |
|
-> m () |
Process any pending signals, ensuring the main context is cleared of sources used by this object. Also ensures that no further events will be queued.
getStatus
asyncProgressGetStatus Source #
:: (HasCallStack, MonadIO m, IsAsyncProgress a) | |
=> a |
|
-> m (Maybe Text) | Returns: the current status, or |
Get the human-readable status string from the AsyncProgress
. This
operation is thread-safe. The retuned value may be Nothing
if no status is
set.
This is a convenience function to get the well-known status
key.
Since: 2017.6
getUint
asyncProgressGetUint :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Text -> m Word32 Source #
No description available in the introspection data.
getUint64
asyncProgressGetUint64 :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Text -> m Word64 Source #
No description available in the introspection data.
getVariant
asyncProgressGetVariant Source #
:: (HasCallStack, MonadIO m, IsAsyncProgress a) | |
=> a |
|
-> Text |
|
-> m (Maybe GVariant) | Returns: value for the given |
Look up a key in the AsyncProgress
and return the GVariant
associated
with it. The lookup is thread-safe.
Since: 2017.6
new
:: (HasCallStack, MonadIO m) | |
=> m AsyncProgress | Returns: A new progress object |
No description available in the introspection data.
newAndConnect
asyncProgressNewAndConnect :: (HasCallStack, MonadIO m) => Ptr () -> Ptr () -> m AsyncProgress Source #
No description available in the introspection data.
setStatus
asyncProgressSetStatus Source #
:: (HasCallStack, MonadIO m, IsAsyncProgress a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Set the human-readable status string for the AsyncProgress
. This
operation is thread-safe. Nothing
may be passed to clear the status.
This is a convenience function to set the well-known status
key.
Since: 2017.6
setUint
asyncProgressSetUint :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Text -> Word32 -> m () Source #
No description available in the introspection data.
setUint64
asyncProgressSetUint64 :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Text -> Word64 -> m () Source #
No description available in the introspection data.
setVariant
asyncProgressSetVariant Source #
:: (HasCallStack, MonadIO m, IsAsyncProgress a) | |
=> a |
|
-> Text |
|
-> GVariant |
|
-> m () |
Assign a new value
to the given key
, replacing any existing value. The
operation is thread-safe. value
may be a floating reference;
variantRefSink
will be called on it.
Any watchers of the AsyncProgress
will be notified of the change if
value
differs from the existing value for key
.
Since: 2017.6
Signals
changed
type AsyncProgressChangedCallback = IO () Source #
Emitted when self
has been changed.
type C_AsyncProgressChangedCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
afterAsyncProgressChanged :: (IsAsyncProgress a, MonadIO m) => a -> AsyncProgressChangedCallback -> m SignalHandlerId Source #
Connect a signal handler for the changed signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
asyncProgress #changed callback
genClosure_AsyncProgressChanged :: MonadIO m => AsyncProgressChangedCallback -> m (GClosure C_AsyncProgressChangedCallback) Source #
Wrap the callback into a GClosure
.
mk_AsyncProgressChangedCallback :: C_AsyncProgressChangedCallback -> IO (FunPtr C_AsyncProgressChangedCallback) Source #
Generate a function pointer callable from C code, from a C_AsyncProgressChangedCallback
.
noAsyncProgressChangedCallback :: Maybe AsyncProgressChangedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
AsyncProgressChangedCallback
onAsyncProgressChanged :: (IsAsyncProgress a, MonadIO m) => a -> AsyncProgressChangedCallback -> m SignalHandlerId Source #
Connect a signal handler for the changed signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
asyncProgress #changed callback