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 |
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
.
- newtype OptionGroup = OptionGroup (ManagedPtr OptionGroup)
- noOptionGroup :: Maybe OptionGroup
- 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 #
Methods
addEntries
data OptionGroupAddEntriesMethodInfo Source #
((~) * signature (OptionEntry -> m ()), MonadIO m) => MethodInfo * OptionGroupAddEntriesMethodInfo OptionGroup signature Source # | |
optionGroupAddEntries Source #
:: (HasCallStack, MonadIO m) | |
=> OptionGroup |
|
-> OptionEntry |
|
-> m () |
Adds the options specified in entries
to group
.
Since: 2.6
free
data OptionGroupFreeMethodInfo Source #
((~) * signature (m ()), MonadIO m) => MethodInfo * OptionGroupFreeMethodInfo OptionGroup signature Source # | |
:: (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
:: (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
.
Since: 2.6
ref
data OptionGroupRefMethodInfo Source #
((~) * signature (m OptionGroup), MonadIO m) => MethodInfo * OptionGroupRefMethodInfo OptionGroup signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> OptionGroup |
|
-> m OptionGroup | Returns: a |
Increments the reference count of group
by one.
Since: 2.44
setTranslateFunc
data OptionGroupSetTranslateFuncMethodInfo Source #
((~) * signature (Maybe TranslateFunc -> m ()), MonadIO m) => MethodInfo * OptionGroupSetTranslateFuncMethodInfo OptionGroup signature Source # | |
optionGroupSetTranslateFunc Source #
:: (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 #
((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * OptionGroupSetTranslationDomainMethodInfo OptionGroup signature Source # | |
optionGroupSetTranslationDomain Source #
:: (HasCallStack, MonadIO m) | |
=> OptionGroup |
|
-> Text |
|
-> m () |
A convenience function to use gettext()
for translating
user-visible strings.
Since: 2.6
unref
data OptionGroupUnrefMethodInfo Source #
((~) * signature (m ()), MonadIO m) => MethodInfo * OptionGroupUnrefMethodInfo OptionGroup signature Source # | |
:: (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