| 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.OptionContext
Contents
- Exported types
- Methods
- optionContextAddGroup
- optionContextAddMainEntries
- optionContextFree
- optionContextGetDescription
- optionContextGetHelp
- optionContextGetHelpEnabled
- optionContextGetIgnoreUnknownOptions
- optionContextGetMainGroup
- optionContextGetStrictPosix
- optionContextGetSummary
- optionContextParse
- optionContextParseStrv
- optionContextSetDescription
- optionContextSetHelpEnabled
- optionContextSetIgnoreUnknownOptions
- optionContextSetMainGroup
- optionContextSetStrictPosix
- optionContextSetSummary
- optionContextSetTranslateFunc
- optionContextSetTranslationDomain
Description
A GOptionContext struct defines which options
are accepted by the commandline option parser. The struct has only private
fields and should not be directly accessed.
- newtype OptionContext = OptionContext (ForeignPtr OptionContext)
- noOptionContext :: Maybe OptionContext
- data OptionContextAddGroupMethodInfo
- optionContextAddGroup :: MonadIO m => OptionContext -> OptionGroup -> m ()
- data OptionContextAddMainEntriesMethodInfo
- optionContextAddMainEntries :: MonadIO m => OptionContext -> OptionEntry -> Maybe Text -> m ()
- data OptionContextFreeMethodInfo
- optionContextFree :: MonadIO m => OptionContext -> m ()
- data OptionContextGetDescriptionMethodInfo
- optionContextGetDescription :: MonadIO m => OptionContext -> m Text
- data OptionContextGetHelpMethodInfo
- optionContextGetHelp :: MonadIO m => OptionContext -> Bool -> Maybe OptionGroup -> m Text
- data OptionContextGetHelpEnabledMethodInfo
- optionContextGetHelpEnabled :: MonadIO m => OptionContext -> m Bool
- data OptionContextGetIgnoreUnknownOptionsMethodInfo
- optionContextGetIgnoreUnknownOptions :: MonadIO m => OptionContext -> m Bool
- data OptionContextGetMainGroupMethodInfo
- optionContextGetMainGroup :: MonadIO m => OptionContext -> m OptionGroup
- data OptionContextGetStrictPosixMethodInfo
- optionContextGetStrictPosix :: MonadIO m => OptionContext -> m Bool
- data OptionContextGetSummaryMethodInfo
- optionContextGetSummary :: MonadIO m => OptionContext -> m Text
- data OptionContextParseMethodInfo
- optionContextParse :: MonadIO m => OptionContext -> Maybe [Text] -> m (Maybe [Text])
- data OptionContextParseStrvMethodInfo
- optionContextParseStrv :: MonadIO m => OptionContext -> Ptr CString -> m (Ptr CString)
- data OptionContextSetDescriptionMethodInfo
- optionContextSetDescription :: MonadIO m => OptionContext -> Maybe Text -> m ()
- data OptionContextSetHelpEnabledMethodInfo
- optionContextSetHelpEnabled :: MonadIO m => OptionContext -> Bool -> m ()
- data OptionContextSetIgnoreUnknownOptionsMethodInfo
- optionContextSetIgnoreUnknownOptions :: MonadIO m => OptionContext -> Bool -> m ()
- data OptionContextSetMainGroupMethodInfo
- optionContextSetMainGroup :: MonadIO m => OptionContext -> OptionGroup -> m ()
- data OptionContextSetStrictPosixMethodInfo
- optionContextSetStrictPosix :: MonadIO m => OptionContext -> Bool -> m ()
- data OptionContextSetSummaryMethodInfo
- optionContextSetSummary :: MonadIO m => OptionContext -> Maybe Text -> m ()
- data OptionContextSetTranslateFuncMethodInfo
- optionContextSetTranslateFunc :: MonadIO m => OptionContext -> Maybe TranslateFunc -> m ()
- data OptionContextSetTranslationDomainMethodInfo
- optionContextSetTranslationDomain :: MonadIO m => OptionContext -> Text -> m ()
Exported types
newtype OptionContext Source
Constructors
| OptionContext (ForeignPtr OptionContext) |
Instances
Methods
optionContextAddGroup
data OptionContextAddGroupMethodInfo Source
Instances
| ((~) * signature (OptionGroup -> m ()), MonadIO m) => MethodInfo * OptionContextAddGroupMethodInfo OptionContext signature |
optionContextAddGroup :: MonadIO m => OptionContext -> OptionGroup -> m () Source
optionContextAddMainEntries
data OptionContextAddMainEntriesMethodInfo Source
Instances
| ((~) * signature (OptionEntry -> Maybe Text -> m ()), MonadIO m) => MethodInfo * OptionContextAddMainEntriesMethodInfo OptionContext signature |
optionContextAddMainEntries :: MonadIO m => OptionContext -> OptionEntry -> Maybe Text -> m () Source
optionContextFree
data OptionContextFreeMethodInfo Source
Instances
| ((~) * signature (m ()), MonadIO m) => MethodInfo * OptionContextFreeMethodInfo OptionContext signature |
optionContextFree :: MonadIO m => OptionContext -> m () Source
optionContextGetDescription
data OptionContextGetDescriptionMethodInfo Source
Instances
| ((~) * signature (m Text), MonadIO m) => MethodInfo * OptionContextGetDescriptionMethodInfo OptionContext signature |
optionContextGetDescription :: MonadIO m => OptionContext -> m Text Source
optionContextGetHelp
data OptionContextGetHelpMethodInfo Source
Instances
| ((~) * signature (Bool -> Maybe OptionGroup -> m Text), MonadIO m) => MethodInfo * OptionContextGetHelpMethodInfo OptionContext signature |
optionContextGetHelp :: MonadIO m => OptionContext -> Bool -> Maybe OptionGroup -> m Text Source
optionContextGetHelpEnabled
data OptionContextGetHelpEnabledMethodInfo Source
Instances
| ((~) * signature (m Bool), MonadIO m) => MethodInfo * OptionContextGetHelpEnabledMethodInfo OptionContext signature |
optionContextGetHelpEnabled :: MonadIO m => OptionContext -> m Bool Source
optionContextGetIgnoreUnknownOptions
data OptionContextGetIgnoreUnknownOptionsMethodInfo Source
Instances
| ((~) * signature (m Bool), MonadIO m) => MethodInfo * OptionContextGetIgnoreUnknownOptionsMethodInfo OptionContext signature |
optionContextGetIgnoreUnknownOptions :: MonadIO m => OptionContext -> m Bool Source
optionContextGetMainGroup
data OptionContextGetMainGroupMethodInfo Source
Instances
| ((~) * signature (m OptionGroup), MonadIO m) => MethodInfo * OptionContextGetMainGroupMethodInfo OptionContext signature |
optionContextGetMainGroup :: MonadIO m => OptionContext -> m OptionGroup Source
optionContextGetStrictPosix
data OptionContextGetStrictPosixMethodInfo Source
Instances
| ((~) * signature (m Bool), MonadIO m) => MethodInfo * OptionContextGetStrictPosixMethodInfo OptionContext signature |
optionContextGetStrictPosix :: MonadIO m => OptionContext -> m Bool Source
optionContextGetSummary
data OptionContextGetSummaryMethodInfo Source
Instances
| ((~) * signature (m Text), MonadIO m) => MethodInfo * OptionContextGetSummaryMethodInfo OptionContext signature |
optionContextGetSummary :: MonadIO m => OptionContext -> m Text Source
optionContextParse
data OptionContextParseMethodInfo Source
Instances
| ((~) * signature (Maybe [Text] -> m (Maybe [Text])), MonadIO m) => MethodInfo * OptionContextParseMethodInfo OptionContext signature |
optionContextParse :: MonadIO m => OptionContext -> Maybe [Text] -> m (Maybe [Text]) Source
optionContextParseStrv
data OptionContextParseStrvMethodInfo Source
Instances
| ((~) * signature (Ptr CString -> m (Ptr CString)), MonadIO m) => MethodInfo * OptionContextParseStrvMethodInfo OptionContext signature |
optionContextParseStrv :: MonadIO m => OptionContext -> Ptr CString -> m (Ptr CString) Source
optionContextSetDescription
data OptionContextSetDescriptionMethodInfo Source
Instances
| ((~) * signature (Maybe Text -> m ()), MonadIO m) => MethodInfo * OptionContextSetDescriptionMethodInfo OptionContext signature |
optionContextSetDescription :: MonadIO m => OptionContext -> Maybe Text -> m () Source
optionContextSetHelpEnabled
data OptionContextSetHelpEnabledMethodInfo Source
Instances
| ((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * OptionContextSetHelpEnabledMethodInfo OptionContext signature |
optionContextSetHelpEnabled :: MonadIO m => OptionContext -> Bool -> m () Source
optionContextSetIgnoreUnknownOptions
data OptionContextSetIgnoreUnknownOptionsMethodInfo Source
Instances
| ((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * OptionContextSetIgnoreUnknownOptionsMethodInfo OptionContext signature |
optionContextSetIgnoreUnknownOptions :: MonadIO m => OptionContext -> Bool -> m () Source
optionContextSetMainGroup
data OptionContextSetMainGroupMethodInfo Source
Instances
| ((~) * signature (OptionGroup -> m ()), MonadIO m) => MethodInfo * OptionContextSetMainGroupMethodInfo OptionContext signature |
optionContextSetMainGroup :: MonadIO m => OptionContext -> OptionGroup -> m () Source
optionContextSetStrictPosix
data OptionContextSetStrictPosixMethodInfo Source
Instances
| ((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * OptionContextSetStrictPosixMethodInfo OptionContext signature |
optionContextSetStrictPosix :: MonadIO m => OptionContext -> Bool -> m () Source
optionContextSetSummary
data OptionContextSetSummaryMethodInfo Source
Instances
| ((~) * signature (Maybe Text -> m ()), MonadIO m) => MethodInfo * OptionContextSetSummaryMethodInfo OptionContext signature |
optionContextSetSummary :: MonadIO m => OptionContext -> Maybe Text -> m () Source
optionContextSetTranslateFunc
data OptionContextSetTranslateFuncMethodInfo Source
Instances
| ((~) * signature (Maybe TranslateFunc -> m ()), MonadIO m) => MethodInfo * OptionContextSetTranslateFuncMethodInfo OptionContext signature |
optionContextSetTranslateFunc :: MonadIO m => OptionContext -> Maybe TranslateFunc -> m () Source
optionContextSetTranslationDomain
data OptionContextSetTranslationDomainMethodInfo Source
Instances
| ((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * OptionContextSetTranslationDomainMethodInfo OptionContext signature |
optionContextSetTranslationDomain :: MonadIO m => OptionContext -> Text -> m () Source