gi-gdk-4.0.4: Gdk bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gdk.Structs.ContentFormatsBuilder

Description

A GdkContentFormatsBuilder is an auxiliary struct used to create new GdkContentFormats, and should not be kept around.

Synopsis

Exported types

Methods

Click to display all available methods, including inherited ones

Expand

Methods

addFormats, addGtype, addMimeType, ref, toFormats, unref.

Getters

None.

Setters

None.

addFormats

contentFormatsBuilderAddFormats Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ContentFormatsBuilder

builder: a GdkContentFormatsBuilder

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

-> GType

type: a GType

-> m () 

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

addMimeType

contentFormatsBuilderAddMimeType Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ContentFormatsBuilder

builder: a GdkContentFormatsBuilder

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

Create a new GdkContentFormatsBuilder object.

The resulting builder would create an empty GdkContentFormats. Use addition functions to add types to it.

ref

contentFormatsBuilderRef Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ContentFormatsBuilder

builder: a GdkContentFormatsBuilder

-> m ContentFormatsBuilder

Returns: the given GdkContentFormatsBuilder with its reference count increased

Acquires a reference on the given builder.

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

toFormats

contentFormatsBuilderToFormats Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ContentFormatsBuilder

builder: a GdkContentFormatsBuilder

-> m ContentFormats

Returns: the newly created GdkContentFormats with all the formats added to builder

Creates a new GdkContentFormats from the given builder.

The given GdkContentFormatsBuilder 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 ContentFormatsBuilder.free_to_formats().

unref

contentFormatsBuilderUnref Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ContentFormatsBuilder

builder: a GdkContentFormatsBuilder

-> m () 

Releases a reference on the given builder.