GI.OSTree.Objects.AsyncProgress

No description available in the introspection data.

Exported types

newtype AsyncProgress

Memory-managed wrapper type.

Constructors

AsyncProgress (ManagedPtr AsyncProgress)

Instances

Eq AsyncProgress

Defined in GI.OSTree.Objects.AsyncProgress

Methods

(==) :: AsyncProgress -> AsyncProgress -> Bool

(/=) :: AsyncProgress -> AsyncProgress -> Bool

GObject AsyncProgress

Defined in GI.OSTree.Objects.AsyncProgress

ManagedPtrNewtype AsyncProgress

Defined in GI.OSTree.Objects.AsyncProgress

Methods

toManagedPtr :: AsyncProgress -> ManagedPtr AsyncProgress

TypedObject AsyncProgress

Defined in GI.OSTree.Objects.AsyncProgress

Methods

glibType :: IO GType

HasParentTypes AsyncProgress

Defined in GI.OSTree.Objects.AsyncProgress

IsGValue (Maybe AsyncProgress)

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

Defined in GI.OSTree.Objects.AsyncProgress

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes AsyncProgress

Defined in GI.OSTree.Objects.AsyncProgress

type ParentTypes AsyncProgress = '[Object]

class (GObject o, IsDescendantOf AsyncProgress o) => IsAsyncProgress o

Type class for types which can be safely cast to AsyncProgress, for instance with toAsyncProgress.

Instances

(GObject o, IsDescendantOf AsyncProgress o) => IsAsyncProgress o

Defined in GI.OSTree.Objects.AsyncProgress

toAsyncProgress :: (MonadIO m, IsAsyncProgress o) => o -> m AsyncProgress

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

Arguments

:: (HasCallStack, MonadIO m, IsAsyncProgress a, IsAsyncProgress b)

=> a

self: An AsyncProgress to copy from

-> b

dest: An AsyncProgress to copy to

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

asyncProgressFinish

Arguments

:: (HasCallStack, MonadIO m, IsAsyncProgress a)

=> a

self: Self

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

Arguments

:: (HasCallStack, MonadIO m, IsAsyncProgress a)

=> a

self: an AsyncProgress

-> m (Maybe Text)

Returns: the current status, or Nothing if none is set

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

No description available in the introspection data.

getUint64

asyncProgressGetUint64 :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Text -> m Word64

No description available in the introspection data.

getVariant

asyncProgressGetVariant

Arguments

:: (HasCallStack, MonadIO m, IsAsyncProgress a)

=> a

self: an AsyncProgress

-> Text

key: a key to look up

-> m (Maybe GVariant)

Returns: value for the given key, or Nothing if it was not set

Look up a key in the AsyncProgress and return the GVariant associated with it. The lookup is thread-safe.

Since: 2017.6

new

asyncProgressNew

Arguments

:: (HasCallStack, MonadIO m)

=> m AsyncProgress

Returns: A new progress object

No description available in the introspection data.

setStatus

asyncProgressSetStatus

Arguments

:: (HasCallStack, MonadIO m, IsAsyncProgress a)

=> a

self: an AsyncProgress

-> Maybe Text

status: new status string, or Nothing to clear the status

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

No description available in the introspection data.

setUint64

asyncProgressSetUint64 :: (HasCallStack, MonadIO m, IsAsyncProgress a) => a -> Text -> Word64 -> m ()

No description available in the introspection data.

setVariant

asyncProgressSetVariant

Arguments

:: (HasCallStack, MonadIO m, IsAsyncProgress a)

=> a

self: an AsyncProgress

-> Text

key: a key to set

-> GVariant

value: the value to assign to key

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

Emitted when self has been changed.

afterAsyncProgressChanged :: (IsAsyncProgress a, MonadIO m) => a -> ((?self :: a) => AsyncProgressChangedCallback) -> m SignalHandlerId

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

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.

onAsyncProgressChanged :: (IsAsyncProgress a, MonadIO m) => a -> ((?self :: a) => AsyncProgressChangedCallback) -> m SignalHandlerId

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