gi-gtksource-3.0.26: GtkSource bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.GtkSource.Structs.Encoding

Description

No description available in the introspection data.

Synopsis

Exported types

newtype Encoding Source #

Memory-managed wrapper type.

Constructors

Encoding (ManagedPtr Encoding) 

Instances

Instances details
Eq Encoding Source # 
Instance details

Defined in GI.GtkSource.Structs.Encoding

GBoxed Encoding Source # 
Instance details

Defined in GI.GtkSource.Structs.Encoding

ManagedPtrNewtype Encoding Source # 
Instance details

Defined in GI.GtkSource.Structs.Encoding

Methods

toManagedPtr :: Encoding -> ManagedPtr Encoding

TypedObject Encoding Source # 
Instance details

Defined in GI.GtkSource.Structs.Encoding

Methods

glibType :: IO GType

HasParentTypes Encoding Source # 
Instance details

Defined in GI.GtkSource.Structs.Encoding

IsGValue (Maybe Encoding) Source #

Convert Encoding to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.GtkSource.Structs.Encoding

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Encoding -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Encoding)

type ParentTypes Encoding Source # 
Instance details

Defined in GI.GtkSource.Structs.Encoding

type ParentTypes Encoding = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

copy, free, toString.

Getters

getCharset, getName.

Setters

None.

copy

encodingCopy Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Encoding

enc: a Encoding.

-> m Encoding

Returns: a copy of enc.

Used by language bindings.

Since: 3.14

free

encodingFree Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Encoding

enc: a Encoding.

-> m () 

Used by language bindings.

Since: 3.14

getAll

encodingGetAll Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m [Encoding]

Returns: a list of all Encoding's. Free with g_slist_free().

Gets all encodings.

Since: 3.14

getCharset

encodingGetCharset Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Encoding

enc: a Encoding.

-> m Text

Returns: the character set of the Encoding.

Gets the character set of the Encoding, such as "UTF-8" or "ISO-8859-1".

Since: 3.14

getCurrent

encodingGetCurrent Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m Encoding

Returns: the current locale encoding.

Gets the Encoding for the current locale. See also getCharset.

Since: 3.14

getDefaultCandidates

encodingGetDefaultCandidates Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m [Encoding]

Returns: the list of default candidate encodings. Free with g_slist_free().

Gets the list of default candidate encodings to try when loading a file. See fileLoaderSetCandidateEncodings.

This function returns a different list depending on the current locale (i.e. language, country and default encoding). The UTF-8 encoding and the current locale encoding are guaranteed to be present in the returned list.

Since: 3.18

getFromCharset

encodingGetFromCharset Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

charset: a character set.

-> m (Maybe Encoding)

Returns: the corresponding Encoding, or Nothing if not found.

Gets a Encoding from a character set such as "UTF-8" or "ISO-8859-1".

Since: 3.14

getName

encodingGetName Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Encoding

enc: a Encoding.

-> m Text

Returns: the name of the Encoding.

Gets the name of the Encoding such as "Unicode" or "Western".

Since: 3.14

getUtf8

encodingGetUtf8 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m Encoding

Returns: the UTF-8 encoding.

No description available in the introspection data.

Since: 3.14

toString

encodingToString Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Encoding

enc: a Encoding.

-> m Text

Returns: a string representation. Free with free when no longer needed.

No description available in the introspection data.

Since: 3.14