Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.GLib.Structs.KeyFile

Contents

Exported types
Methods

Description

The GKeyFile struct contains only private data and should not be accessed directly.

Synopsis

Exported types

newtype KeyFile Source #

Constructors

KeyFile (ManagedPtr KeyFile)

Instances

BoxedObject KeyFile Source #
Methods boxedType :: KeyFile -> IO GType #
((~) * info (ResolveKeyFileMethod t KeyFile), MethodInfo * info KeyFile p) => IsLabel t (KeyFile -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> KeyFile -> p #
((~) * info (ResolveKeyFileMethod t KeyFile), MethodInfo * info KeyFile p) => IsLabelProxy t (KeyFile -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> KeyFile -> p #
HasAttributeList * KeyFile Source #

((~) * signature (m ()), MonadIO m) => MethodInfo * KeyFileUnrefMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileUnrefMethodInfo KeyFile -> signature -> s #
((~) * signature (m (Text, Word64)), MonadIO m) => MethodInfo * KeyFileToDataMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileToDataMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> Text -> m ()), MonadIO m) => MethodInfo * KeyFileSetValueMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetValueMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> Word64 -> m ()), MonadIO m) => MethodInfo * KeyFileSetUint64MethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetUint64MethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> [Text] -> Word64 -> m ()), MonadIO m) => MethodInfo * KeyFileSetStringListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetStringListMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> Text -> m ()), MonadIO m) => MethodInfo * KeyFileSetStringMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetStringMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> Text -> [Text] -> Word64 -> m ()), MonadIO m) => MethodInfo * KeyFileSetLocaleStringListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetLocaleStringListMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> Text -> Text -> m ()), MonadIO m) => MethodInfo * KeyFileSetLocaleStringMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetLocaleStringMethodInfo KeyFile -> signature -> s #
((~) * signature (Int8 -> m ()), MonadIO m) => MethodInfo * KeyFileSetListSeparatorMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetListSeparatorMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> [Int32] -> m ()), MonadIO m) => MethodInfo * KeyFileSetIntegerListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetIntegerListMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> Int32 -> m ()), MonadIO m) => MethodInfo * KeyFileSetIntegerMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetIntegerMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> Int64 -> m ()), MonadIO m) => MethodInfo * KeyFileSetInt64MethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetInt64MethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> [Double] -> m ()), MonadIO m) => MethodInfo * KeyFileSetDoubleListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetDoubleListMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> Double -> m ()), MonadIO m) => MethodInfo * KeyFileSetDoubleMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetDoubleMethodInfo KeyFile -> signature -> s #
((~) * signature (Maybe Text -> Maybe Text -> Text -> m ()), MonadIO m) => MethodInfo * KeyFileSetCommentMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetCommentMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> [Bool] -> m ()), MonadIO m) => MethodInfo * KeyFileSetBooleanListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetBooleanListMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> Bool -> m ()), MonadIO m) => MethodInfo * KeyFileSetBooleanMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetBooleanMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * KeyFileSaveToFileMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSaveToFileMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> m ()), MonadIO m) => MethodInfo * KeyFileRemoveKeyMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileRemoveKeyMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * KeyFileRemoveGroupMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileRemoveGroupMethodInfo KeyFile -> signature -> s #
((~) * signature (Maybe Text -> Maybe Text -> m ()), MonadIO m) => MethodInfo * KeyFileRemoveCommentMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileRemoveCommentMethodInfo KeyFile -> signature -> s #
((~) * signature ([Char] -> [KeyFileFlags] -> m ()), MonadIO m) => MethodInfo * KeyFileLoadFromFileMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileLoadFromFileMethodInfo KeyFile -> signature -> s #
((~) * signature ([Char] -> [[Char]] -> [KeyFileFlags] -> m [Char]), MonadIO m) => MethodInfo * KeyFileLoadFromDirsMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileLoadFromDirsMethodInfo KeyFile -> signature -> s #
((~) * signature ([Char] -> [KeyFileFlags] -> m [Char]), MonadIO m) => MethodInfo * KeyFileLoadFromDataDirsMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileLoadFromDataDirsMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Word64 -> [KeyFileFlags] -> m ()), MonadIO m) => MethodInfo * KeyFileLoadFromDataMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileLoadFromDataMethodInfo KeyFile -> signature -> s #
((~) * signature (Bytes -> [KeyFileFlags] -> m ()), MonadIO m) => MethodInfo * KeyFileLoadFromBytesMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileLoadFromBytesMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * KeyFileHasGroupMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileHasGroupMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> m Text), MonadIO m) => MethodInfo * KeyFileGetValueMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetValueMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> m Word64), MonadIO m) => MethodInfo * KeyFileGetUint64MethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetUint64MethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> m ([Text], Word64)), MonadIO m) => MethodInfo * KeyFileGetStringListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetStringListMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> m Text), MonadIO m) => MethodInfo * KeyFileGetStringMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetStringMethodInfo KeyFile -> signature -> s #
((~) * signature (m Text), MonadIO m) => MethodInfo * KeyFileGetStartGroupMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetStartGroupMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> Maybe Text -> m ([Text], Word64)), MonadIO m) => MethodInfo * KeyFileGetLocaleStringListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetLocaleStringListMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> Maybe Text -> m Text), MonadIO m) => MethodInfo * KeyFileGetLocaleStringMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetLocaleStringMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> m ([Text], Word64)), MonadIO m) => MethodInfo * KeyFileGetKeysMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetKeysMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> m [Int32]), MonadIO m) => MethodInfo * KeyFileGetIntegerListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetIntegerListMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> m Int32), MonadIO m) => MethodInfo * KeyFileGetIntegerMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetIntegerMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> m Int64), MonadIO m) => MethodInfo * KeyFileGetInt64MethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetInt64MethodInfo KeyFile -> signature -> s #
((~) * signature (m ([Text], Word64)), MonadIO m) => MethodInfo * KeyFileGetGroupsMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetGroupsMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> m [Double]), MonadIO m) => MethodInfo * KeyFileGetDoubleListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetDoubleListMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> m Double), MonadIO m) => MethodInfo * KeyFileGetDoubleMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetDoubleMethodInfo KeyFile -> signature -> s #
((~) * signature (Maybe Text -> Text -> m Text), MonadIO m) => MethodInfo * KeyFileGetCommentMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetCommentMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> m [Bool]), MonadIO m) => MethodInfo * KeyFileGetBooleanListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetBooleanListMethodInfo KeyFile -> signature -> s #
((~) * signature (Text -> Text -> m ()), MonadIO m) => MethodInfo * KeyFileGetBooleanMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetBooleanMethodInfo KeyFile -> signature -> s #
type AttributeList KeyFile Source #
type AttributeList KeyFile

noKeyFile :: Maybe KeyFile Source #

Methods

errorQuark

keyFileErrorQuark :: (HasCallStack, MonadIO m) => m Word32 Source #

No description available in the introspection data.

getBoolean

data KeyFileGetBooleanMethodInfo Source #

Instances

((~) * signature (Text -> Text -> m ()), MonadIO m) => MethodInfo * KeyFileGetBooleanMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetBooleanMethodInfo KeyFile -> signature -> s #

keyFileGetBoolean Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> m ()	(Can throw `GError`)

Returns the value associated with key under groupName as a boolean.

If key cannot be found then False is returned and error is set to G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated with key cannot be interpreted as a boolean then False is returned and error is set to G_KEY_FILE_ERROR_INVALID_VALUE.

Since: 2.6

getBooleanList

data KeyFileGetBooleanListMethodInfo Source #

Instances

((~) * signature (Text -> Text -> m [Bool]), MonadIO m) => MethodInfo * KeyFileGetBooleanListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetBooleanListMethodInfo KeyFile -> signature -> s #

keyFileGetBooleanList Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> m [Bool]	Returns: the values associated with the key as a list of booleans, or `Nothing` if the key was not found or could not be parsed. The returned list of booleans should be freed with `free` when no longer needed. (Can throw `GError`)

Returns the values associated with key under groupName as booleans.

If key cannot be found then Nothing is returned and error is set to G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated with key cannot be interpreted as booleans then Nothing is returned and error is set to G_KEY_FILE_ERROR_INVALID_VALUE.

Since: 2.6

getComment

data KeyFileGetCommentMethodInfo Source #

Instances

((~) * signature (Maybe Text -> Text -> m Text), MonadIO m) => MethodInfo * KeyFileGetCommentMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetCommentMethodInfo KeyFile -> signature -> s #

keyFileGetComment Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Maybe Text	`groupName`: a group name, or `Nothing`
-> Text	`key`: a key
-> m Text	Returns: a comment that should be freed with `free` (Can throw `GError`)

Retrieves a comment above key from groupName. If key is Nothing then comment will be read from above groupName. If both key and groupName are Nothing, then comment will be read from above the first group in the file.

Note that the returned string includes the '#' comment markers.

Since: 2.6

getDouble

data KeyFileGetDoubleMethodInfo Source #

Instances

((~) * signature (Text -> Text -> m Double), MonadIO m) => MethodInfo * KeyFileGetDoubleMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetDoubleMethodInfo KeyFile -> signature -> s #

keyFileGetDouble Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> m Double	Returns: the value associated with the key as a double, or 0.0 if the key was not found or could not be parsed. (Can throw `GError`)

Returns the value associated with key under groupName as a double. If groupName is Nothing, the start_group is used.

If key cannot be found then 0.0 is returned and error is set to G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated with key cannot be interpreted as a double then 0.0 is returned and error is set to G_KEY_FILE_ERROR_INVALID_VALUE.

Since: 2.12

getDoubleList

data KeyFileGetDoubleListMethodInfo Source #

Instances

((~) * signature (Text -> Text -> m [Double]), MonadIO m) => MethodInfo * KeyFileGetDoubleListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetDoubleListMethodInfo KeyFile -> signature -> s #

keyFileGetDoubleList Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> m [Double]	Returns: the values associated with the key as a list of doubles, or `Nothing` if the key was not found or could not be parsed. The returned list of doubles should be freed with `free` when no longer needed. (Can throw `GError`)

Returns the values associated with key under groupName as doubles.

If key cannot be found then Nothing is returned and error is set to G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated with key cannot be interpreted as doubles then Nothing is returned and error is set to G_KEY_FILE_ERROR_INVALID_VALUE.

Since: 2.12

getGroups

data KeyFileGetGroupsMethodInfo Source #

Instances

((~) * signature (m ([Text], Word64)), MonadIO m) => MethodInfo * KeyFileGetGroupsMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetGroupsMethodInfo KeyFile -> signature -> s #

keyFileGetGroups Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> m ([Text], Word64)	Returns: a newly-allocated `Nothing`-terminated array of strings. Use `strfreev` to free it.

Returns all groups in the key file loaded with keyFile. The array of returned groups will be Nothing-terminated, so length may optionally be Nothing.

Since: 2.6

getInt64

data KeyFileGetInt64MethodInfo Source #

Instances

((~) * signature (Text -> Text -> m Int64), MonadIO m) => MethodInfo * KeyFileGetInt64MethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetInt64MethodInfo KeyFile -> signature -> s #

keyFileGetInt64 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a non-`Nothing` `KeyFile`
-> Text	`groupName`: a non-`Nothing` group name
-> Text	`key`: a non-`Nothing` key
-> m Int64	Returns: the value associated with the key as a signed 64-bit integer, or 0 if the key was not found or could not be parsed. (Can throw `GError`)

Returns the value associated with key under groupName as a signed 64-bit integer. This is similar to keyFileGetInteger but can return 64-bit results without truncation.

Since: 2.26

getInteger

data KeyFileGetIntegerMethodInfo Source #

Instances

((~) * signature (Text -> Text -> m Int32), MonadIO m) => MethodInfo * KeyFileGetIntegerMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetIntegerMethodInfo KeyFile -> signature -> s #

keyFileGetInteger Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> m Int32	Returns: the value associated with the key as an integer, or 0 if the key was not found or could not be parsed. (Can throw `GError`)

Returns the value associated with key under groupName as an integer.

If key cannot be found then 0 is returned and error is set to G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated with key cannot be interpreted as an integer then 0 is returned and error is set to G_KEY_FILE_ERROR_INVALID_VALUE.

Since: 2.6

getIntegerList

data KeyFileGetIntegerListMethodInfo Source #

Instances

((~) * signature (Text -> Text -> m [Int32]), MonadIO m) => MethodInfo * KeyFileGetIntegerListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetIntegerListMethodInfo KeyFile -> signature -> s #

keyFileGetIntegerList Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> m [Int32]	Returns: the values associated with the key as a list of integers, or `Nothing` if the key was not found or could not be parsed. The returned list of integers should be freed with `free` when no longer needed. (Can throw `GError`)

Returns the values associated with key under groupName as integers.

If key cannot be found then Nothing is returned and error is set to G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated with key cannot be interpreted as integers then Nothing is returned and error is set to G_KEY_FILE_ERROR_INVALID_VALUE.

Since: 2.6

getKeys

data KeyFileGetKeysMethodInfo Source #

Instances

((~) * signature (Text -> m ([Text], Word64)), MonadIO m) => MethodInfo * KeyFileGetKeysMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetKeysMethodInfo KeyFile -> signature -> s #

keyFileGetKeys Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> m ([Text], Word64)	Returns: a newly-allocated `Nothing`-terminated array of strings. Use `strfreev` to free it. (Can throw `GError`)

Returns all keys for the group name groupName. The array of returned keys will be Nothing-terminated, so length may optionally be Nothing. In the event that the groupName cannot be found, Nothing is returned and error is set to G_KEY_FILE_ERROR_GROUP_NOT_FOUND.

Since: 2.6

getLocaleString

data KeyFileGetLocaleStringMethodInfo Source #

Instances

((~) * signature (Text -> Text -> Maybe Text -> m Text), MonadIO m) => MethodInfo * KeyFileGetLocaleStringMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetLocaleStringMethodInfo KeyFile -> signature -> s #

keyFileGetLocaleString Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> Maybe Text	`locale`: a locale identifier or `Nothing`
-> m Text	Returns: a newly allocated string or `Nothing` if the specified key cannot be found. (Can throw `GError`)

Returns the value associated with key under groupName translated in the given locale if available. If locale is Nothing then the current locale is assumed.

If key cannot be found then Nothing is returned and error is set to G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the value associated with key cannot be interpreted or no suitable translation can be found then the untranslated value is returned.

Since: 2.6

getLocaleStringList

data KeyFileGetLocaleStringListMethodInfo Source #

Instances

((~) * signature (Text -> Text -> Maybe Text -> m ([Text], Word64)), MonadIO m) => MethodInfo * KeyFileGetLocaleStringListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetLocaleStringListMethodInfo KeyFile -> signature -> s #

keyFileGetLocaleStringList Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> Maybe Text	`locale`: a locale identifier or `Nothing`
-> m ([Text], Word64)	Returns: a newly allocated `Nothing`-terminated string array or `Nothing` if the key isn't found. The string array should be freed with `strfreev`. (Can throw `GError`)

Returns the values associated with key under groupName translated in the given locale if available. If locale is Nothing then the current locale is assumed.

If key cannot be found then Nothing is returned and error is set to G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated with key cannot be interpreted or no suitable translations can be found then the untranslated values are returned. The returned array is Nothing-terminated, so length may optionally be Nothing.

Since: 2.6

getStartGroup

data KeyFileGetStartGroupMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * KeyFileGetStartGroupMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetStartGroupMethodInfo KeyFile -> signature -> s #

keyFileGetStartGroup Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> m Text	Returns: The start group of the key file.

Returns the name of the start group of the file.

Since: 2.6

getString

data KeyFileGetStringMethodInfo Source #

Instances

((~) * signature (Text -> Text -> m Text), MonadIO m) => MethodInfo * KeyFileGetStringMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetStringMethodInfo KeyFile -> signature -> s #

keyFileGetString Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> m Text	Returns: a newly allocated string or `Nothing` if the specified key cannot be found. (Can throw `GError`)

Returns the string value associated with key under groupName. Unlike keyFileGetValue, this function handles escape sequences like \s.

In the event the key cannot be found, Nothing is returned and error is set to G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the event that the groupName cannot be found, Nothing is returned and error is set to G_KEY_FILE_ERROR_GROUP_NOT_FOUND.

Since: 2.6

getStringList

data KeyFileGetStringListMethodInfo Source #

Instances

((~) * signature (Text -> Text -> m ([Text], Word64)), MonadIO m) => MethodInfo * KeyFileGetStringListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetStringListMethodInfo KeyFile -> signature -> s #

keyFileGetStringList Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> m ([Text], Word64)	Returns: a `Nothing`-terminated string array or `Nothing` if the specified key cannot be found. The array should be freed with `strfreev`. (Can throw `GError`)

Returns the values associated with key under groupName.

In the event the key cannot be found, Nothing is returned and error is set to G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the event that the groupName cannot be found, Nothing is returned and error is set to G_KEY_FILE_ERROR_GROUP_NOT_FOUND.

Since: 2.6

getUint64

data KeyFileGetUint64MethodInfo Source #

Instances

((~) * signature (Text -> Text -> m Word64), MonadIO m) => MethodInfo * KeyFileGetUint64MethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetUint64MethodInfo KeyFile -> signature -> s #

keyFileGetUint64 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a non-`Nothing` `KeyFile`
-> Text	`groupName`: a non-`Nothing` group name
-> Text	`key`: a non-`Nothing` key
-> m Word64	Returns: the value associated with the key as an unsigned 64-bit integer, or 0 if the key was not found or could not be parsed. (Can throw `GError`)

Returns the value associated with key under groupName as an unsigned 64-bit integer. This is similar to keyFileGetInteger but can return large positive results without truncation.

Since: 2.26

getValue

data KeyFileGetValueMethodInfo Source #

Instances

((~) * signature (Text -> Text -> m Text), MonadIO m) => MethodInfo * KeyFileGetValueMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileGetValueMethodInfo KeyFile -> signature -> s #

keyFileGetValue Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> m Text	Returns: a newly allocated string or `Nothing` if the specified key cannot be found. (Can throw `GError`)

Returns the raw value associated with key under groupName. Use keyFileGetString to retrieve an unescaped UTF-8 string.

In the event the key cannot be found, Nothing is returned and error is set to G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the event that the groupName cannot be found, Nothing is returned and error is set to G_KEY_FILE_ERROR_GROUP_NOT_FOUND.

Since: 2.6

hasGroup

data KeyFileHasGroupMethodInfo Source #

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * KeyFileHasGroupMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileHasGroupMethodInfo KeyFile -> signature -> s #

keyFileHasGroup Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> m Bool	Returns: `True` if `groupName` is a part of `keyFile`, `False` otherwise.

Looks whether the key file has the group groupName.

Since: 2.6

loadFromBytes

data KeyFileLoadFromBytesMethodInfo Source #

Instances

((~) * signature (Bytes -> [KeyFileFlags] -> m ()), MonadIO m) => MethodInfo * KeyFileLoadFromBytesMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileLoadFromBytesMethodInfo KeyFile -> signature -> s #

keyFileLoadFromBytes Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: an empty `KeyFile` struct
-> Bytes	`bytes`: a `Bytes`
-> [KeyFileFlags]	`flags`: flags from `KeyFileFlags`
-> m ()	(Can throw `GError`)

Loads a key file from the data in bytes into an empty KeyFile structure. If the object cannot be created then error is set to a KeyFileError.

Since: 2.50

loadFromData

data KeyFileLoadFromDataMethodInfo Source #

Instances

((~) * signature (Text -> Word64 -> [KeyFileFlags] -> m ()), MonadIO m) => MethodInfo * KeyFileLoadFromDataMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileLoadFromDataMethodInfo KeyFile -> signature -> s #

keyFileLoadFromData Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: an empty `KeyFile` struct
-> Text	`data`: key file loaded in memory
-> Word64	`length`: the length of `data` in bytes (or (gsize)-1 if data is nul-terminated)
-> [KeyFileFlags]	`flags`: flags from `KeyFileFlags`
-> m ()	(Can throw `GError`)

Loads a key file from memory into an empty KeyFile structure. If the object cannot be created then error is set to a KeyFileError.

Since: 2.6

loadFromDataDirs

data KeyFileLoadFromDataDirsMethodInfo Source #

Instances

((~) * signature ([Char] -> [KeyFileFlags] -> m [Char]), MonadIO m) => MethodInfo * KeyFileLoadFromDataDirsMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileLoadFromDataDirsMethodInfo KeyFile -> signature -> s #

keyFileLoadFromDataDirs Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: an empty `KeyFile` struct
-> [Char]	`file`: a relative path to a filename to open and parse
-> [KeyFileFlags]	`flags`: flags from `KeyFileFlags`
-> m [Char]	(Can throw `GError`)

This function looks for a key file named file in the paths returned from getUserDataDir and getSystemDataDirs, loads the file into keyFile and returns the file's full path in fullPath. If the file could not be loaded then an error is set to either a FileError or KeyFileError.

Since: 2.6

loadFromDirs

data KeyFileLoadFromDirsMethodInfo Source #

Instances

((~) * signature ([Char] -> [[Char]] -> [KeyFileFlags] -> m [Char]), MonadIO m) => MethodInfo * KeyFileLoadFromDirsMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileLoadFromDirsMethodInfo KeyFile -> signature -> s #

keyFileLoadFromDirs Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: an empty `KeyFile` struct
-> [Char]	`file`: a relative path to a filename to open and parse
-> [[Char]]	`searchDirs`: `Nothing`-terminated array of directories to search
-> [KeyFileFlags]	`flags`: flags from `KeyFileFlags`
-> m [Char]	(Can throw `GError`)

This function looks for a key file named file in the paths specified in searchDirs, loads the file into keyFile and returns the file's full path in fullPath. If the file could not be loaded then an error is set to either a FileError or KeyFileError.

Since: 2.14

loadFromFile

data KeyFileLoadFromFileMethodInfo Source #

Instances

((~) * signature ([Char] -> [KeyFileFlags] -> m ()), MonadIO m) => MethodInfo * KeyFileLoadFromFileMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileLoadFromFileMethodInfo KeyFile -> signature -> s #

keyFileLoadFromFile Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: an empty `KeyFile` struct
-> [Char]	`file`: the path of a filename to load, in the GLib filename encoding
-> [KeyFileFlags]	`flags`: flags from `KeyFileFlags`
-> m ()	(Can throw `GError`)

Loads a key file into an empty KeyFile structure. If the file could not be loaded then error is set to either a FileError or KeyFileError.

Since: 2.6

new

keyFileNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m KeyFile	Returns: an empty `KeyFile`.

Creates a new empty KeyFile object. Use keyFileLoadFromFile, keyFileLoadFromData, keyFileLoadFromDirs or keyFileLoadFromDataDirs to read an existing key file.

Since: 2.6

removeComment

data KeyFileRemoveCommentMethodInfo Source #

Instances

((~) * signature (Maybe Text -> Maybe Text -> m ()), MonadIO m) => MethodInfo * KeyFileRemoveCommentMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileRemoveCommentMethodInfo KeyFile -> signature -> s #

keyFileRemoveComment Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Maybe Text	`groupName`: a group name, or `Nothing`
-> Maybe Text	`key`: a key
-> m ()	(Can throw `GError`)

Removes a comment above key from groupName. If key is Nothing then comment will be removed above groupName. If both key and groupName are Nothing, then comment will be removed above the first group in the file.

Since: 2.6

removeGroup

data KeyFileRemoveGroupMethodInfo Source #

Instances

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * KeyFileRemoveGroupMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileRemoveGroupMethodInfo KeyFile -> signature -> s #

keyFileRemoveGroup Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> m ()	(Can throw `GError`)

Removes the specified group, groupName, from the key file.

Since: 2.6

removeKey

data KeyFileRemoveKeyMethodInfo Source #

Instances

((~) * signature (Text -> Text -> m ()), MonadIO m) => MethodInfo * KeyFileRemoveKeyMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileRemoveKeyMethodInfo KeyFile -> signature -> s #

keyFileRemoveKey Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key name to remove
-> m ()	(Can throw `GError`)

Removes key in groupName from the key file.

Since: 2.6

saveToFile

data KeyFileSaveToFileMethodInfo Source #

Instances

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * KeyFileSaveToFileMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSaveToFileMethodInfo KeyFile -> signature -> s #

keyFileSaveToFile Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`filename`: the name of the file to write to
-> m ()	(Can throw `GError`)

Writes the contents of keyFile to filename using fileSetContents.

This function can fail for any of the reasons that fileSetContents may fail.

Since: 2.40

setBoolean

data KeyFileSetBooleanMethodInfo Source #

Instances

((~) * signature (Text -> Text -> Bool -> m ()), MonadIO m) => MethodInfo * KeyFileSetBooleanMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetBooleanMethodInfo KeyFile -> signature -> s #

keyFileSetBoolean Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> Bool	`value`: `True` or `False`
-> m ()

Associates a new boolean value with key under groupName. If key cannot be found then it is created.

Since: 2.6

setBooleanList

data KeyFileSetBooleanListMethodInfo Source #

Instances

((~) * signature (Text -> Text -> [Bool] -> m ()), MonadIO m) => MethodInfo * KeyFileSetBooleanListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetBooleanListMethodInfo KeyFile -> signature -> s #

keyFileSetBooleanList Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> [Bool]	`list`: an array of boolean values
-> m ()

Associates a list of boolean values with key under groupName. If key cannot be found then it is created. If groupName is Nothing, the start_group is used.

Since: 2.6

setComment

data KeyFileSetCommentMethodInfo Source #

Instances

((~) * signature (Maybe Text -> Maybe Text -> Text -> m ()), MonadIO m) => MethodInfo * KeyFileSetCommentMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetCommentMethodInfo KeyFile -> signature -> s #

keyFileSetComment Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Maybe Text	`groupName`: a group name, or `Nothing`
-> Maybe Text	`key`: a key
-> Text	`comment`: a comment
-> m ()	(Can throw `GError`)

Places a comment above key from groupName.

If key is Nothing then comment will be written above groupName. If both key and groupName are Nothing, then comment will be written above the first group in the file.

Note that this function prepends a '#' comment marker to each line of comment.

Since: 2.6

setDouble

data KeyFileSetDoubleMethodInfo Source #

Instances

((~) * signature (Text -> Text -> Double -> m ()), MonadIO m) => MethodInfo * KeyFileSetDoubleMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetDoubleMethodInfo KeyFile -> signature -> s #

keyFileSetDouble Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> Double	`value`: an double value
-> m ()

Associates a new double value with key under groupName. If key cannot be found then it is created.

Since: 2.12

setDoubleList

data KeyFileSetDoubleListMethodInfo Source #

Instances

((~) * signature (Text -> Text -> [Double] -> m ()), MonadIO m) => MethodInfo * KeyFileSetDoubleListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetDoubleListMethodInfo KeyFile -> signature -> s #

keyFileSetDoubleList Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> [Double]	`list`: an array of double values
-> m ()

Associates a list of double values with key under groupName. If key cannot be found then it is created.

Since: 2.12

setInt64

data KeyFileSetInt64MethodInfo Source #

Instances

((~) * signature (Text -> Text -> Int64 -> m ()), MonadIO m) => MethodInfo * KeyFileSetInt64MethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetInt64MethodInfo KeyFile -> signature -> s #

keyFileSetInt64 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> Int64	`value`: an integer value
-> m ()

Associates a new integer value with key under groupName. If key cannot be found then it is created.

Since: 2.26

setInteger

data KeyFileSetIntegerMethodInfo Source #

Instances

((~) * signature (Text -> Text -> Int32 -> m ()), MonadIO m) => MethodInfo * KeyFileSetIntegerMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetIntegerMethodInfo KeyFile -> signature -> s #

keyFileSetInteger Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> Int32	`value`: an integer value
-> m ()

Associates a new integer value with key under groupName. If key cannot be found then it is created.

Since: 2.6

setIntegerList

data KeyFileSetIntegerListMethodInfo Source #

Instances

((~) * signature (Text -> Text -> [Int32] -> m ()), MonadIO m) => MethodInfo * KeyFileSetIntegerListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetIntegerListMethodInfo KeyFile -> signature -> s #

keyFileSetIntegerList Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> [Int32]	`list`: an array of integer values
-> m ()

Associates a list of integer values with key under groupName. If key cannot be found then it is created.

Since: 2.6

setListSeparator

data KeyFileSetListSeparatorMethodInfo Source #

Instances

((~) * signature (Int8 -> m ()), MonadIO m) => MethodInfo * KeyFileSetListSeparatorMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetListSeparatorMethodInfo KeyFile -> signature -> s #

keyFileSetListSeparator Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Int8	`separator`: the separator
-> m ()

Sets the character which is used to separate values in lists. Typically ';' or ',' are used as separators. The default list separator is ';'.

Since: 2.6

setLocaleString

data KeyFileSetLocaleStringMethodInfo Source #

Instances

((~) * signature (Text -> Text -> Text -> Text -> m ()), MonadIO m) => MethodInfo * KeyFileSetLocaleStringMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetLocaleStringMethodInfo KeyFile -> signature -> s #

keyFileSetLocaleString Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> Text	`locale`: a locale identifier
-> Text	`string`: a string
-> m ()

Associates a string value for key and locale under groupName. If the translation for key cannot be found then it is created.

Since: 2.6

setLocaleStringList

data KeyFileSetLocaleStringListMethodInfo Source #

Instances

((~) * signature (Text -> Text -> Text -> [Text] -> Word64 -> m ()), MonadIO m) => MethodInfo * KeyFileSetLocaleStringListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetLocaleStringListMethodInfo KeyFile -> signature -> s #

keyFileSetLocaleStringList Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> Text	`locale`: a locale identifier
-> [Text]	`list`: a `Nothing`-terminated array of locale string values
-> Word64	`length`: the length of `list`
-> m ()

Associates a list of string values for key and locale under groupName. If the translation for key cannot be found then it is created.

Since: 2.6

setString

data KeyFileSetStringMethodInfo Source #

Instances

((~) * signature (Text -> Text -> Text -> m ()), MonadIO m) => MethodInfo * KeyFileSetStringMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetStringMethodInfo KeyFile -> signature -> s #

keyFileSetString Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> Text	`string`: a string
-> m ()

Associates a new string value with key under groupName. If key cannot be found then it is created. If groupName cannot be found then it is created. Unlike keyFileSetValue, this function handles characters that need escaping, such as newlines.

Since: 2.6

setStringList

data KeyFileSetStringListMethodInfo Source #

Instances

((~) * signature (Text -> Text -> [Text] -> Word64 -> m ()), MonadIO m) => MethodInfo * KeyFileSetStringListMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetStringListMethodInfo KeyFile -> signature -> s #

keyFileSetStringList Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> [Text]	`list`: an array of string values
-> Word64	`length`: number of string values in `list`
-> m ()

Associates a list of string values for key under groupName. If key cannot be found then it is created. If groupName cannot be found then it is created.

Since: 2.6

setUint64

data KeyFileSetUint64MethodInfo Source #

Instances

((~) * signature (Text -> Text -> Word64 -> m ()), MonadIO m) => MethodInfo * KeyFileSetUint64MethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetUint64MethodInfo KeyFile -> signature -> s #

keyFileSetUint64 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> Word64	`value`: an integer value
-> m ()

Associates a new integer value with key under groupName. If key cannot be found then it is created.

Since: 2.26

setValue

data KeyFileSetValueMethodInfo Source #

Instances

((~) * signature (Text -> Text -> Text -> m ()), MonadIO m) => MethodInfo * KeyFileSetValueMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileSetValueMethodInfo KeyFile -> signature -> s #

keyFileSetValue Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> Text	`groupName`: a group name
-> Text	`key`: a key
-> Text	`value`: a string
-> m ()

Associates a new value with key under groupName.

If key cannot be found then it is created. If groupName cannot be found then it is created. To set an UTF-8 string which may contain characters that need escaping (such as newlines or spaces), use keyFileSetString.

Since: 2.6

toData

data KeyFileToDataMethodInfo Source #

Instances

((~) * signature (m (Text, Word64)), MonadIO m) => MethodInfo * KeyFileToDataMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileToDataMethodInfo KeyFile -> signature -> s #

keyFileToData Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> m (Text, Word64)	Returns: a newly allocated string holding the contents of the `KeyFile` (Can throw `GError`)

This function outputs keyFile as a string.

Note that this function never reports an error, so it is safe to pass Nothing as error.

Since: 2.6

unref

data KeyFileUnrefMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * KeyFileUnrefMethodInfo KeyFile signature Source #
Methods overloadedMethod :: MethodProxy KeyFileUnrefMethodInfo KeyFile -> signature -> s #

keyFileUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> KeyFile	`keyFile`: a `KeyFile`
-> m ()

Decreases the reference count of keyFile by 1. If the reference count reaches zero, frees the key file and all its allocated memory.

Since: 2.32