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.Structs.ContentFormatsBuilder

Contents

Exported types
Methods

Description

A ContentFormatsBuilder struct is an opaque struct. It is meant to not be kept around and only be used to create new ContentFormats objects.

Synopsis

newtype ContentFormatsBuilder = ContentFormatsBuilder (ManagedPtr ContentFormatsBuilder)
noContentFormatsBuilder :: Maybe ContentFormatsBuilder
contentFormatsBuilderAddFormats :: (HasCallStack, MonadIO m) => ContentFormatsBuilder -> ContentFormats -> m ()
contentFormatsBuilderAddGtype :: (HasCallStack, MonadIO m) => ContentFormatsBuilder -> GType -> m ()
contentFormatsBuilderAddMimeType :: (HasCallStack, MonadIO m) => ContentFormatsBuilder -> Text -> m ()
contentFormatsBuilderNew :: (HasCallStack, MonadIO m) => m ContentFormatsBuilder
contentFormatsBuilderRef :: (HasCallStack, MonadIO m) => ContentFormatsBuilder -> m ContentFormatsBuilder
contentFormatsBuilderToFormats :: (HasCallStack, MonadIO m) => ContentFormatsBuilder -> m ContentFormats
contentFormatsBuilderUnref :: (HasCallStack, MonadIO m) => ContentFormatsBuilder -> m ()

Exported types

newtype ContentFormatsBuilder Source #

Memory-managed wrapper type.

Constructors

ContentFormatsBuilder (ManagedPtr ContentFormatsBuilder)

Instances

Instances details

Eq ContentFormatsBuilder Source #
Instance details Defined in GI.Gdk.Structs.ContentFormatsBuilder Methods (==) :: ContentFormatsBuilder -> ContentFormatsBuilder -> Bool # (/=) :: ContentFormatsBuilder -> ContentFormatsBuilder -> Bool #
BoxedObject ContentFormatsBuilder Source #
Instance details Defined in GI.Gdk.Structs.ContentFormatsBuilder Methods boxedType :: ContentFormatsBuilder -> IO GType #
IsGValue ContentFormatsBuilder Source #	Convert `ContentFormatsBuilder` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Gdk.Structs.ContentFormatsBuilder Methods toGValue :: ContentFormatsBuilder -> IO GValue # fromGValue :: GValue -> IO ContentFormatsBuilder #

noContentFormatsBuilder :: Maybe ContentFormatsBuilder Source #

A convenience alias for Nothing :: Maybe ContentFormatsBuilder.

Methods

Overloaded methods

addFormats

contentFormatsBuilderAddFormats Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ContentFormatsBuilder	`builder`: a `ContentFormatsBuilder`
-> ContentFormats	`formats`: the formats to add
-> m ()

Appends all formats from formats to builder, skipping those that already exist.

addGtype

contentFormatsBuilderAddGtype Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ContentFormatsBuilder	`builder`: a `ContentFormatsBuilder`
-> GType	`type`: a `GType`
-> m ()

Appends gtype to builder if it has not already been added.

addMimeType

contentFormatsBuilderAddMimeType Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ContentFormatsBuilder	`builder`: a `ContentFormatsBuilder`
-> Text	`mimeType`: a mime type
-> m ()

Appends mimeType to builder if it has not already been added.

new

contentFormatsBuilderNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m ContentFormatsBuilder	Returns: a new `ContentFormatsBuilder`

Create a new ContentFormatsBuilder object. The resulting builder would create an empty ContentFormats. Use addition functions to add types to it.

ref

contentFormatsBuilderRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ContentFormatsBuilder	`builder`: a `ContentFormatsBuilder`
-> m ContentFormatsBuilder	Returns: the given `ContentFormatsBuilder` with its reference count increased

Acquires a reference on the given builder.

This function is intended primarily for bindings. ContentFormatsBuilder objects should not be kept around.

toFormats

contentFormatsBuilderToFormats Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ContentFormatsBuilder	`builder`: a `ContentFormatsBuilder`
-> m ContentFormats	Returns: the newly created `ContentFormats` with all the formats added to `builder`

Creates a new ContentFormats from the given builder.

The given ContentFormatsBuilder is reset once this function returns; you cannot call this function multiple times on the same builder instance.

This function is intended primarily for bindings. C code should use gdk_content_formats_builder_free_to_formats().

unref

contentFormatsBuilderUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ContentFormatsBuilder	`builder`: a `ContentFormatsBuilder`
-> m ()

Releases a reference on the given builder.