| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.GLib.Structs.OptionGroup
Description
A GOptionGroup struct defines the options in a single
group. The struct has only private fields and should not be directly accessed.
All options in a group share the same translation function. Libraries which
need to parse commandline options are expected to provide a function for
getting a GOptionGroup holding their options, which
the application can then add to its OptionContext.
Synopsis
- newtype OptionGroup = OptionGroup (ManagedPtr OptionGroup)
- type family ResolveOptionGroupMethod (t :: Symbol) o where ...
- data OptionGroupAddEntriesMethodInfo
- optionGroupAddEntries :: (HasCallStack, MonadIO m) => OptionGroup -> [OptionEntry] -> m ()
- data OptionGroupFreeMethodInfo
- optionGroupFree :: (HasCallStack, MonadIO m) => OptionGroup -> m ()
- optionGroupNew :: (HasCallStack, MonadIO m) => Text -> Text -> Text -> Ptr () -> Maybe DestroyNotify -> m OptionGroup
- data OptionGroupRefMethodInfo
- optionGroupRef :: (HasCallStack, MonadIO m) => OptionGroup -> m OptionGroup
- data OptionGroupSetTranslateFuncMethodInfo
- optionGroupSetTranslateFunc :: (HasCallStack, MonadIO m) => OptionGroup -> Maybe TranslateFunc -> m ()
- data OptionGroupSetTranslationDomainMethodInfo
- optionGroupSetTranslationDomain :: (HasCallStack, MonadIO m) => OptionGroup -> Text -> m ()
- data OptionGroupUnrefMethodInfo
- optionGroupUnref :: (HasCallStack, MonadIO m) => OptionGroup -> m ()
Exported types
newtype OptionGroup Source #
Memory-managed wrapper type.
Constructors
| OptionGroup (ManagedPtr OptionGroup) |
Instances
Methods
Click to display all available methods, including inherited ones
type family ResolveOptionGroupMethod (t :: Symbol) o where ... Source #
Equations
| ResolveOptionGroupMethod "addEntries" o = OptionGroupAddEntriesMethodInfo | |
| ResolveOptionGroupMethod "free" o = OptionGroupFreeMethodInfo | |
| ResolveOptionGroupMethod "ref" o = OptionGroupRefMethodInfo | |
| ResolveOptionGroupMethod "unref" o = OptionGroupUnrefMethodInfo | |
| ResolveOptionGroupMethod "setTranslateFunc" o = OptionGroupSetTranslateFuncMethodInfo | |
| ResolveOptionGroupMethod "setTranslationDomain" o = OptionGroupSetTranslationDomainMethodInfo | |
| ResolveOptionGroupMethod l o = MethodResolutionFailed l o :: Type |
addEntries
data OptionGroupAddEntriesMethodInfo Source #
Instances
| (signature ~ ([OptionEntry] -> m ()), MonadIO m) => OverloadedMethod OptionGroupAddEntriesMethodInfo OptionGroup signature Source # | |
Defined in GI.GLib.Structs.OptionGroup Methods overloadedMethod :: OptionGroup -> signature # | |
| OverloadedMethodInfo OptionGroupAddEntriesMethodInfo OptionGroup Source # | |
Defined in GI.GLib.Structs.OptionGroup Methods | |
optionGroupAddEntries Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => OptionGroup |
|
| -> [OptionEntry] |
|
| -> m () |
Adds the options specified in entries to group.
Since: 2.6
free
data OptionGroupFreeMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod OptionGroupFreeMethodInfo OptionGroup signature Source # | |
Defined in GI.GLib.Structs.OptionGroup Methods overloadedMethod :: OptionGroup -> signature # | |
| OverloadedMethodInfo OptionGroupFreeMethodInfo OptionGroup Source # | |
Defined in GI.GLib.Structs.OptionGroup Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => OptionGroup |
|
| -> m () |
Deprecated: (Since version 2.44)Use optionGroupUnref instead.
Frees a OptionGroup. Note that you must not free groups
which have been added to a OptionContext.
Since: 2.6
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Text |
|
| -> Text |
|
| -> Text |
|
| -> Ptr () |
|
| -> Maybe DestroyNotify |
|
| -> m OptionGroup | Returns: a newly created option group. It should be added
to a |
Creates a new OptionGroup.
description is typically used to provide a title for the group. If so, it
is recommended that it’s written in title case, and has a trailing colon so
that it matches the style of built-in GLib group titles such as
‘Application Options:’.
Since: 2.6
ref
data OptionGroupRefMethodInfo Source #
Instances
| (signature ~ m OptionGroup, MonadIO m) => OverloadedMethod OptionGroupRefMethodInfo OptionGroup signature Source # | |
Defined in GI.GLib.Structs.OptionGroup Methods overloadedMethod :: OptionGroup -> signature # | |
| OverloadedMethodInfo OptionGroupRefMethodInfo OptionGroup Source # | |
Defined in GI.GLib.Structs.OptionGroup Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => OptionGroup |
|
| -> m OptionGroup | Returns: a |
Increments the reference count of group by one.
Since: 2.44
setTranslateFunc
data OptionGroupSetTranslateFuncMethodInfo Source #
Instances
| (signature ~ (Maybe TranslateFunc -> m ()), MonadIO m) => OverloadedMethod OptionGroupSetTranslateFuncMethodInfo OptionGroup signature Source # | |
Defined in GI.GLib.Structs.OptionGroup Methods overloadedMethod :: OptionGroup -> signature # | |
| OverloadedMethodInfo OptionGroupSetTranslateFuncMethodInfo OptionGroup Source # | |
Defined in GI.GLib.Structs.OptionGroup Methods | |
optionGroupSetTranslateFunc Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => OptionGroup |
|
| -> Maybe TranslateFunc |
|
| -> m () |
Sets the function which is used to translate user-visible strings,
for --help output. Different groups can use different
GTranslateFuncs. If func is Nothing, strings are not translated.
If you are using gettext(), you only need to set the translation
domain, see optionGroupSetTranslationDomain.
Since: 2.6
setTranslationDomain
data OptionGroupSetTranslationDomainMethodInfo Source #
Instances
| (signature ~ (Text -> m ()), MonadIO m) => OverloadedMethod OptionGroupSetTranslationDomainMethodInfo OptionGroup signature Source # | |
Defined in GI.GLib.Structs.OptionGroup Methods overloadedMethod :: OptionGroup -> signature # | |
| OverloadedMethodInfo OptionGroupSetTranslationDomainMethodInfo OptionGroup Source # | |
Defined in GI.GLib.Structs.OptionGroup Methods | |
optionGroupSetTranslationDomain Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => OptionGroup |
|
| -> Text |
|
| -> m () |
A convenience function to use gettext() for translating
user-visible strings.
Since: 2.6
unref
data OptionGroupUnrefMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod OptionGroupUnrefMethodInfo OptionGroup signature Source # | |
Defined in GI.GLib.Structs.OptionGroup Methods overloadedMethod :: OptionGroup -> signature # | |
| OverloadedMethodInfo OptionGroupUnrefMethodInfo OptionGroup Source # | |
Defined in GI.GLib.Structs.OptionGroup Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => OptionGroup |
|
| -> m () |
Decrements the reference count of group by one.
If the reference count drops to 0, the group will be freed.
and all memory allocated by the group is released.
Since: 2.44