GI.Gio.Objects.CharsetConverter

CharsetConverter is an implementation of Converter based on GIConv.

Exported types

newtype CharsetConverter

Memory-managed wrapper type.

Constructors

CharsetConverter (ManagedPtr CharsetConverter)

Instances

GObject CharsetConverter

Defined in GI.Gio.Objects.CharsetConverter

Methods

gobjectType :: IO GType

HasParentTypes CharsetConverter

Defined in GI.Gio.Objects.CharsetConverter

type ParentTypes CharsetConverter

Defined in GI.Gio.Objects.CharsetConverter

type ParentTypes CharsetConverter = Object ': (Converter ': (Initable ': ([] :: [Type])))

class (GObject o, IsDescendantOf CharsetConverter o) => IsCharsetConverter o

Type class for types which can be safely cast to CharsetConverter, for instance with toCharsetConverter.

Instances

(GObject o, IsDescendantOf CharsetConverter o) => IsCharsetConverter o

Defined in GI.Gio.Objects.CharsetConverter

toCharsetConverter :: (MonadIO m, IsCharsetConverter o) => o -> m CharsetConverter

Cast to CharsetConverter, for types for which this is known to be safe. For general casts, use castTo.

noCharsetConverter :: Maybe CharsetConverter

A convenience alias for Nothing :: Maybe CharsetConverter.

Methods

getNumFallbacks

charsetConverterGetNumFallbacks

Arguments

:: (HasCallStack, MonadIO m, IsCharsetConverter a)

=> a

converter: a CharsetConverter

-> m Word32

Returns: the number of fallbacks that converter has applied

Gets the number of fallbacks that converter has applied so far.

Since: 2.24

getUseFallback

charsetConverterGetUseFallback

Arguments

:: (HasCallStack, MonadIO m, IsCharsetConverter a)

=> a

converter: a CharsetConverter

-> m Bool

Returns: True if fallbacks are used by converter

Gets the CharsetConverter:use-fallback property.

Since: 2.24

new

charsetConverterNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

toCharset: destination charset

-> Text

fromCharset: source charset

-> m CharsetConverter

Returns: a new CharsetConverter or Nothing on error. (Can throw GError)

Creates a new CharsetConverter.

Since: 2.24

setUseFallback

charsetConverterSetUseFallback

Arguments

:: (HasCallStack, MonadIO m, IsCharsetConverter a)

=> a

converter: a CharsetConverter

-> Bool

useFallback: True to use fallbacks

-> m ()

Sets the CharsetConverter:use-fallback property.

Since: 2.24

Properties

fromCharset

No description available in the introspection data.

constructCharsetConverterFromCharset :: IsCharsetConverter o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “from-charset” property. This is rarely needed directly, but it is used by new.

getCharsetConverterFromCharset :: (MonadIO m, IsCharsetConverter o) => o -> m (Maybe Text)

Get the value of the “from-charset” property. When overloading is enabled, this is equivalent to

get charsetConverter #fromCharset

toCharset

No description available in the introspection data.

constructCharsetConverterToCharset :: IsCharsetConverter o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “to-charset” property. This is rarely needed directly, but it is used by new.

getCharsetConverterToCharset :: (MonadIO m, IsCharsetConverter o) => o -> m (Maybe Text)

Get the value of the “to-charset” property. When overloading is enabled, this is equivalent to

get charsetConverter #toCharset

useFallback

No description available in the introspection data.

constructCharsetConverterUseFallback :: IsCharsetConverter o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “use-fallback” property. This is rarely needed directly, but it is used by new.

getCharsetConverterUseFallback :: (MonadIO m, IsCharsetConverter o) => o -> m Bool

Get the value of the “use-fallback” property. When overloading is enabled, this is equivalent to

get charsetConverter #useFallback

setCharsetConverterUseFallback :: (MonadIO m, IsCharsetConverter o) => o -> Bool -> m ()

Set the value of the “use-fallback” property. When overloading is enabled, this is equivalent to

set charsetConverter [ #useFallback := value ]