Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
A GdkContentSerializer
is used to serialize content for
inter-application data transfers.
The GdkContentSerializer
transforms an object that is identified
by a GType into a serialized form (i.e. a byte stream) that is
identified by a mime type.
GTK provides serializers and deserializers for common data types
such as text, colors, images or file lists. To register your own
serialization functions, use contentRegisterSerializer
.
Also see ContentDeserializer
.
Synopsis
- newtype ContentSerializer = ContentSerializer (ManagedPtr ContentSerializer)
- class (GObject o, IsDescendantOf ContentSerializer o) => IsContentSerializer o
- toContentSerializer :: (MonadIO m, IsContentSerializer o) => o -> m ContentSerializer
- contentSerializerGetCancellable :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m (Maybe Cancellable)
- contentSerializerGetGtype :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m GType
- contentSerializerGetMimeType :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m Text
- contentSerializerGetOutputStream :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m OutputStream
- contentSerializerGetPriority :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m Int32
- contentSerializerGetTaskData :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m (Ptr ())
- contentSerializerGetUserData :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m (Ptr ())
- contentSerializerGetValue :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m GValue
- contentSerializerReturnError :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> GError -> m ()
- contentSerializerReturnSuccess :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m ()
- contentSerializerSetTaskData :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> Ptr () -> DestroyNotify -> m ()
Exported types
newtype ContentSerializer Source #
Memory-managed wrapper type.
Instances
Eq ContentSerializer Source # | |
Defined in GI.Gdk.Objects.ContentSerializer (==) :: ContentSerializer -> ContentSerializer -> Bool # (/=) :: ContentSerializer -> ContentSerializer -> Bool # | |
GObject ContentSerializer Source # | |
Defined in GI.Gdk.Objects.ContentSerializer | |
ManagedPtrNewtype ContentSerializer Source # | |
TypedObject ContentSerializer Source # | |
Defined in GI.Gdk.Objects.ContentSerializer | |
HasParentTypes ContentSerializer Source # | |
Defined in GI.Gdk.Objects.ContentSerializer | |
IsGValue (Maybe ContentSerializer) Source # | Convert |
Defined in GI.Gdk.Objects.ContentSerializer gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe ContentSerializer -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe ContentSerializer) # | |
type ParentTypes ContentSerializer Source # | |
Defined in GI.Gdk.Objects.ContentSerializer type ParentTypes ContentSerializer = '[Object, AsyncResult] |
class (GObject o, IsDescendantOf ContentSerializer o) => IsContentSerializer o Source #
Type class for types which can be safely cast to ContentSerializer
, for instance with toContentSerializer
.
Instances
(GObject o, IsDescendantOf ContentSerializer o) => IsContentSerializer o Source # | |
Defined in GI.Gdk.Objects.ContentSerializer |
toContentSerializer :: (MonadIO m, IsContentSerializer o) => o -> m ContentSerializer Source #
Cast to ContentSerializer
, 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, isTagged, legacyPropagateError, notify, notifyByPspec, ref, refSink, returnError, returnSuccess, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getCancellable, getData, getGtype, getMimeType, getOutputStream, getPriority, getProperty, getQdata, getSourceObject, getTaskData, getUserData, getValue.
Setters
getCancellable
contentSerializerGetCancellable Source #
:: (HasCallStack, MonadIO m, IsContentSerializer a) | |
=> a |
|
-> m (Maybe Cancellable) | Returns: the cancellable for the current operation |
Gets the cancellable for the current operation.
This is the GCancellable
that was passed to [funccontentSerializeAsync
].
getGtype
contentSerializerGetGtype Source #
:: (HasCallStack, MonadIO m, IsContentSerializer a) | |
=> a |
|
-> m GType | Returns: the |
Gets the GType
to of the object to serialize.
getMimeType
contentSerializerGetMimeType Source #
:: (HasCallStack, MonadIO m, IsContentSerializer a) | |
=> a |
|
-> m Text | Returns: the mime type for the current operation |
Gets the mime type to serialize to.
getOutputStream
contentSerializerGetOutputStream Source #
:: (HasCallStack, MonadIO m, IsContentSerializer a) | |
=> a |
|
-> m OutputStream | Returns: the output stream for the current operation |
Gets the output stream for the current operation.
This is the stream that was passed to [funccontentSerializeAsync
].
getPriority
contentSerializerGetPriority Source #
:: (HasCallStack, MonadIO m, IsContentSerializer a) | |
=> a |
|
-> m Int32 | Returns: the I/O priority for the current operation |
Gets the I/O priority for the current operation.
This is the priority that was passed to [funccontentSerializeAsync
].
getTaskData
contentSerializerGetTaskData Source #
:: (HasCallStack, MonadIO m, IsContentSerializer a) | |
=> a |
|
-> m (Ptr ()) | Returns: the task data for |
Gets the data that was associated with the current operation.
getUserData
contentSerializerGetUserData Source #
:: (HasCallStack, MonadIO m, IsContentSerializer a) | |
=> a |
|
-> m (Ptr ()) | Returns: the user data for this serializer |
Gets the user data that was passed when the serializer was registered.
getValue
contentSerializerGetValue Source #
:: (HasCallStack, MonadIO m, IsContentSerializer a) | |
=> a |
|
-> m GValue | Returns: the |
Gets the GValue
to read the object to serialize from.
returnError
contentSerializerReturnError Source #
:: (HasCallStack, MonadIO m, IsContentSerializer a) | |
=> a |
|
-> GError |
|
-> m () |
Indicate that the serialization has ended with an error.
This function consumes error
.
returnSuccess
contentSerializerReturnSuccess Source #
:: (HasCallStack, MonadIO m, IsContentSerializer a) | |
=> a |
|
-> m () |
Indicate that the serialization has been successfully completed.
setTaskData
contentSerializerSetTaskData Source #
:: (HasCallStack, MonadIO m, IsContentSerializer a) | |
=> a |
|
-> Ptr () |
|
-> DestroyNotify |
|
-> m () |
Associate data with the current serialization operation.