Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
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.

Synopsis

newtype ContentSerializer = ContentSerializer (ManagedPtr ContentSerializer)
class (GObject o, IsDescendantOf ContentSerializer o) => IsContentSerializer o
toContentSerializer :: (MonadIO m, IsContentSerializer o) => o -> m ContentSerializer
noContentSerializer :: Maybe ContentSerializer
contentSerializerGetCancellable :: (HasCallStack, MonadIO m, IsContentSerializer a) => a -> m 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.

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 Methods gobjectType :: IO GType #
IsGValue ContentSerializer Source #	Convert `ContentSerializer` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Gdk.Objects.ContentSerializer Methods toGValue :: ContentSerializer -> IO GValue # fromGValue :: GValue -> IO ContentSerializer #
HasParentTypes ContentSerializer Source #
Instance details Defined in GI.Gdk.Objects.ContentSerializer
type ParentTypes ContentSerializer Source #
Instance details 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

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.

noContentSerializer :: Maybe ContentSerializer Source #

A convenience alias for Nothing :: Maybe ContentSerializer.

Methods

Overloaded methods

getCancellable

contentSerializerGetCancellable Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `ContentSerializer`
-> m Cancellable	Returns: the cancellable for the current operation

Gets the cancellable that was passed to contentSerializeAsync.

getGtype

contentSerializerGetGtype Source #

Arguments

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

Gets the GType to of the object to serialize.

getMimeType

contentSerializerGetMimeType Source #

Arguments

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

Gets the mime type to serialize to.

getOutputStream

contentSerializerGetOutputStream Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `ContentSerializer`
-> m OutputStream	Returns: the output stream for the current operation

Gets the output stream that was passed to contentSerializeAsync.

getPriority

contentSerializerGetPriority Source #

Arguments

:: (HasCallStack, MonadIO m, IsContentSerializer a)
=> a	`serializer`: a `ContentSerializer`
-> m Int32	Returns: the io priority for the current operation

Gets the io priority that was passed to contentSerializeAsync.

getTaskData

contentSerializerGetTaskData Source #

Arguments

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

Gets the data that was associated with serializer via contentSerializerSetTaskData.

getUserData

contentSerializerGetUserData Source #

Arguments

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

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

getValue

contentSerializerGetValue Source #

Arguments

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

Gets the Value to read the object to serialize from.

returnError

contentSerializerReturnError Source #

Arguments

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

Indicate that the serialization has ended with an error. This function consumes error.

returnSuccess

contentSerializerReturnSuccess Source #

Arguments

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

Indicate that the serialization has been successfully completed.

setTaskData

contentSerializerSetTaskData Source #

Arguments

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

Associate data with the current serialization operation.