Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gdk.Objects.ContentSerializer

Contents

Exported types
Methods

Description

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
type family ResolveContentSerializerMethod (t :: Symbol) o where ...
data ContentSerializerGetCancellableMethodInfo
contentSerializerGetCancellable :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m (Maybe Cancellable)
data ContentSerializerGetGtypeMethodInfo
contentSerializerGetGtype :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m GType
data ContentSerializerGetMimeTypeMethodInfo
contentSerializerGetMimeType :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m Text
data ContentSerializerGetOutputStreamMethodInfo
contentSerializerGetOutputStream :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m OutputStream
data ContentSerializerGetPriorityMethodInfo
contentSerializerGetPriority :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m Int32
data ContentSerializerGetTaskDataMethodInfo
contentSerializerGetTaskData :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m (Ptr ())
data ContentSerializerGetUserDataMethodInfo
contentSerializerGetUserData :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m (Ptr ())
data ContentSerializerGetValueMethodInfo
contentSerializerGetValue :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m GValue
data ContentSerializerReturnErrorMethodInfo
contentSerializerReturnError :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> GError -> m ()
data ContentSerializerReturnSuccessMethodInfo
contentSerializerReturnSuccess :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m ()
data ContentSerializerSetTaskDataMethodInfo
contentSerializerSetTaskData :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> Ptr () -> DestroyNotify -> m ()

Exported types

newtype ContentSerializer Source #

Memory-managed wrapper type.

Constructors

ContentSerializer (ManagedPtr ContentSerializer)

Instances

Instances details

Eq ContentSerializer Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods (==) :: ContentSerializer -> ContentSerializer -> Bool # (/=) :: ContentSerializer -> ContentSerializer -> Bool #
GObject ContentSerializer Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer
ManagedPtrNewtype ContentSerializer Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods toManagedPtr :: ContentSerializer -> ManagedPtr ContentSerializer #
TypedObject ContentSerializer Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods glibType :: IO GType #
HasParentTypes ContentSerializer Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer
HasAttributeList ContentSerializer Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer
(info ~ ResolveContentSerializerMethod t ContentSerializer, OverloadedMethod info ContentSerializer p, HasField t ContentSerializer p) => HasField (t :: Symbol) ContentSerializer (p :: Type) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods getField :: ContentSerializer -> p #
(info ~ ResolveContentSerializerMethod t ContentSerializer, OverloadedMethodInfo info ContentSerializer) => IsLabel t (MethodProxy info ContentSerializer) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods fromLabel :: MethodProxy info ContentSerializer #
(info ~ ResolveContentSerializerMethod t ContentSerializer, OverloadedMethod info ContentSerializer p) => IsLabel t (ContentSerializer -> p) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods fromLabel :: ContentSerializer -> p #
IsGValue (Maybe ContentSerializer) Source #	Convert `ContentSerializer` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe ContentSerializer -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe ContentSerializer) #
type AttributeList ContentSerializer Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer type AttributeList ContentSerializer
type ParentTypes ContentSerializer Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer type ParentTypes ContentSerializer = '[Object, AsyncResult]
type SignalList ContentSerializer Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer type SignalList ContentSerializer

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

Instances details

(GObject o, IsDescendantOf ContentSerializer o) => IsContentSerializer o Source #
Instance details 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

Expand

Equations

ResolveContentSerializerMethod "bindProperty" o = ObjectBindPropertyMethodInfo
ResolveContentSerializerMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo
ResolveContentSerializerMethod "forceFloating" o = ObjectForceFloatingMethodInfo
ResolveContentSerializerMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo
ResolveContentSerializerMethod "getv" o = ObjectGetvMethodInfo
ResolveContentSerializerMethod "isFloating" o = ObjectIsFloatingMethodInfo
ResolveContentSerializerMethod "isTagged" o = AsyncResultIsTaggedMethodInfo
ResolveContentSerializerMethod "legacyPropagateError" o = AsyncResultLegacyPropagateErrorMethodInfo
ResolveContentSerializerMethod "notify" o = ObjectNotifyMethodInfo
ResolveContentSerializerMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo
ResolveContentSerializerMethod "ref" o = ObjectRefMethodInfo
ResolveContentSerializerMethod "refSink" o = ObjectRefSinkMethodInfo
ResolveContentSerializerMethod "returnError" o = ContentSerializerReturnErrorMethodInfo
ResolveContentSerializerMethod "returnSuccess" o = ContentSerializerReturnSuccessMethodInfo
ResolveContentSerializerMethod "runDispose" o = ObjectRunDisposeMethodInfo
ResolveContentSerializerMethod "stealData" o = ObjectStealDataMethodInfo
ResolveContentSerializerMethod "stealQdata" o = ObjectStealQdataMethodInfo
ResolveContentSerializerMethod "thawNotify" o = ObjectThawNotifyMethodInfo
ResolveContentSerializerMethod "unref" o = ObjectUnrefMethodInfo
ResolveContentSerializerMethod "watchClosure" o = ObjectWatchClosureMethodInfo
ResolveContentSerializerMethod "getCancellable" o = ContentSerializerGetCancellableMethodInfo
ResolveContentSerializerMethod "getData" o = ObjectGetDataMethodInfo
ResolveContentSerializerMethod "getGtype" o = ContentSerializerGetGtypeMethodInfo
ResolveContentSerializerMethod "getMimeType" o = ContentSerializerGetMimeTypeMethodInfo
ResolveContentSerializerMethod "getOutputStream" o = ContentSerializerGetOutputStreamMethodInfo
ResolveContentSerializerMethod "getPriority" o = ContentSerializerGetPriorityMethodInfo
ResolveContentSerializerMethod "getProperty" o = ObjectGetPropertyMethodInfo
ResolveContentSerializerMethod "getQdata" o = ObjectGetQdataMethodInfo
ResolveContentSerializerMethod "getSourceObject" o = AsyncResultGetSourceObjectMethodInfo
ResolveContentSerializerMethod "getTaskData" o = ContentSerializerGetTaskDataMethodInfo
ResolveContentSerializerMethod "getUserData" o = ContentSerializerGetUserDataMethodInfo
ResolveContentSerializerMethod "getValue" o = ContentSerializerGetValueMethodInfo
ResolveContentSerializerMethod "setData" o = ObjectSetDataMethodInfo
ResolveContentSerializerMethod "setDataFull" o = ObjectSetDataFullMethodInfo
ResolveContentSerializerMethod "setProperty" o = ObjectSetPropertyMethodInfo
ResolveContentSerializerMethod "setTaskData" o = ContentSerializerSetTaskDataMethodInfo
ResolveContentSerializerMethod l o = MethodResolutionFailed l o :: Type

getCancellable

data ContentSerializerGetCancellableMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Cancellable), MonadIO m, IsContentSerializer a) => OverloadedMethod ContentSerializerGetCancellableMethodInfo a signature Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo ContentSerializerGetCancellableMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

contentSerializerGetCancellable Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `GdkContentSerializer`
-> 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

data ContentSerializerGetGtypeMethodInfo Source #

Instances

Instances details

(signature ~ m GType, MonadIO m, IsContentSerializer a) => OverloadedMethod ContentSerializerGetGtypeMethodInfo a signature Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo ContentSerializerGetGtypeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

contentSerializerGetGtype Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `GdkContentSerializer`
-> m GType	Returns: the `GType` for the current operation

Gets the GType to of the object to serialize.

getMimeType

data ContentSerializerGetMimeTypeMethodInfo Source #

Instances

Instances details

(signature ~ m Text, MonadIO m, IsContentSerializer a) => OverloadedMethod ContentSerializerGetMimeTypeMethodInfo a signature Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo ContentSerializerGetMimeTypeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

contentSerializerGetMimeType Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `GdkContentSerializer`
-> m Text	Returns: the mime type for the current operation

Gets the mime type to serialize to.

getOutputStream

data ContentSerializerGetOutputStreamMethodInfo Source #

Instances

Instances details

(signature ~ m OutputStream, MonadIO m, IsContentSerializer a) => OverloadedMethod ContentSerializerGetOutputStreamMethodInfo a signature Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo ContentSerializerGetOutputStreamMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

contentSerializerGetOutputStream Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `GdkContentSerializer`
-> 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

data ContentSerializerGetPriorityMethodInfo Source #

Instances

Instances details

(signature ~ m Int32, MonadIO m, IsContentSerializer a) => OverloadedMethod ContentSerializerGetPriorityMethodInfo a signature Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo ContentSerializerGetPriorityMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

contentSerializerGetPriority Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `GdkContentSerializer`
-> 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

data ContentSerializerGetTaskDataMethodInfo Source #

Instances

Instances details

(signature ~ m (Ptr ()), MonadIO m, IsContentSerializer a) => OverloadedMethod ContentSerializerGetTaskDataMethodInfo a signature Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo ContentSerializerGetTaskDataMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

contentSerializerGetTaskData Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `GdkContentSerializer`
-> m (Ptr ())	Returns: the task data for `serializer`

Gets the data that was associated with the current operation.

See contentSerializerSetTaskData.

getUserData

data ContentSerializerGetUserDataMethodInfo Source #

Instances

Instances details

(signature ~ m (Ptr ()), MonadIO m, IsContentSerializer a) => OverloadedMethod ContentSerializerGetUserDataMethodInfo a signature Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo ContentSerializerGetUserDataMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

contentSerializerGetUserData Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `GdkContentSerializer`
-> m (Ptr ())	Returns: the user data for this serializer

Gets the user data that was passed when the serializer was registered.

getValue

data ContentSerializerGetValueMethodInfo Source #

Instances

Instances details

(signature ~ m GValue, MonadIO m, IsContentSerializer a) => OverloadedMethod ContentSerializerGetValueMethodInfo a signature Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo ContentSerializerGetValueMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

contentSerializerGetValue Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `GdkContentSerializer`
-> m GValue	Returns: the `GValue` for the current operation

Gets the GValue to read the object to serialize from.

returnError

data ContentSerializerReturnErrorMethodInfo Source #

Instances

Instances details

(signature ~ (GError -> m ()), MonadIO m, IsContentSerializer a) => OverloadedMethod ContentSerializerReturnErrorMethodInfo a signature Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo ContentSerializerReturnErrorMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

contentSerializerReturnError Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `GdkContentSerializer`
-> GError	`error`: a `GError`
-> m ()

Indicate that the serialization has ended with an error.

This function consumes error.

returnSuccess

data ContentSerializerReturnSuccessMethodInfo Source #

Instances

Instances details

(signature ~ m (), MonadIO m, IsContentSerializer a) => OverloadedMethod ContentSerializerReturnSuccessMethodInfo a signature Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo ContentSerializerReturnSuccessMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

contentSerializerReturnSuccess Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `GdkContentSerializer`
-> m ()

Indicate that the serialization has been successfully completed.

setTaskData

data ContentSerializerSetTaskDataMethodInfo Source #

Instances

Instances details

(signature ~ (Ptr () -> DestroyNotify -> m ()), MonadIO m, IsContentSerializer a) => OverloadedMethod ContentSerializerSetTaskDataMethodInfo a signature Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo ContentSerializerSetTaskDataMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

contentSerializerSetTaskData Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `GdkContentSerializer`
-> Ptr ()	`data`: data to associate with this operation
-> DestroyNotify	`notify`: destroy notify for `data`
-> m ()

Associate data with the current serialization operation.

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

getCancellable

Instances

getGtype

Instances

getMimeType

Instances

getOutputStream

Instances

getPriority

Instances

getTaskData

Instances

getUserData

Instances

getValue

Instances

returnError

Instances

returnSuccess

Instances

setTaskData

Instances