gi-glib-2.0.13: GLib bindings

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

GI.GLib.Flags

Contents

Description

# Exported types

Specifies which nodes are visited during several of the tree functions, including g_node_traverse() and g_node_find().

Constructors

 TraverseFlagsLeaves only leaf nodes should be visited. This name has been introduced in 2.6, for older version use TraverseFlagsLeafs. TraverseFlagsNonLeaves only non-leaf nodes should be visited. This name has been introduced in 2.6, for older version use TraverseFlagsNonLeafs. TraverseFlagsAll all nodes should be visited. TraverseFlagsMask a mask of all traverse flags. TraverseFlagsLeafs identical to TraverseFlagsLeaves. TraverseFlagsNonLeafs identical to TraverseFlagsNonLeaves. AnotherTraverseFlags Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [TraverseFlags] -> ShowS # Source #

Deprecated: TestTrapFlags is used only with testTrapFork,which is deprecated. testTrapSubprocess usesGTestTrapSubprocessFlags.

Test traps are guards around forked tests. These flags determine what traps to set.

Constructors

 TestTrapFlagsSilenceStdout Redirect stdout of the test child to /dev/null so it cannot be observed on the console during test runs. The actual output is still captured though to allow later tests with g_test_trap_assert_stdout(). TestTrapFlagsSilenceStderr Redirect stderr of the test child to /dev/null so it cannot be observed on the console during test runs. The actual output is still captured though to allow later tests with g_test_trap_assert_stderr(). TestTrapFlagsInheritStdin If this flag is given, stdin of the child process is shared with stdin of its parent process. It is redirected to /dev/null otherwise. AnotherTestTrapFlags Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [TestTrapFlags] -> ShowS # Source #

Flags to pass to testTrapSubprocess to control input and output.

Note that in contrast with testTrapFork, the default is to not show stdout and stderr.

Constructors

 TestSubprocessFlagsStdin If this flag is given, the child process will inherit the parent's stdin. Otherwise, the child's stdin is redirected to /dev/null. TestSubprocessFlagsStdout If this flag is given, the child process will inherit the parent's stdout. Otherwise, the child's stdout will not be visible, but it will be captured to allow later tests with g_test_trap_assert_stdout(). TestSubprocessFlagsStderr If this flag is given, the child process will inherit the parent's stderr. Otherwise, the child's stderr will not be visible, but it will be captured to allow later tests with g_test_trap_assert_stderr(). AnotherTestSubprocessFlags Int Catch-all for unknown values

Instances

 Source # Source # Methods Source # Methods Source # Methods Source #

Flags passed to spawnSync, spawnAsync and spawnAsyncWithPipes.

Constructors

 SpawnFlagsDefault no flags, default behaviour SpawnFlagsLeaveDescriptorsOpen the parent's open file descriptors will be inherited by the child; otherwise all descriptors except stdin, stdout and stderr will be closed before calling exec() in the child. SpawnFlagsDoNotReapChild the child will not be automatically reaped; you must use g_child_watch_add() yourself (or call waitpid() or handle SIGCHLD yourself), or the child will become a zombie. SpawnFlagsSearchPath argv[0] need not be an absolute path, it will be looked for in the user's PATH. SpawnFlagsStdoutToDevNull the child's standard output will be discarded, instead of going to the same location as the parent's standard output. SpawnFlagsStderrToDevNull the child's standard error will be discarded. SpawnFlagsChildInheritsStdin the child will inherit the parent's standard input (by default, the child's standard input is attached to /dev/null). SpawnFlagsFileAndArgvZero the first element of argv is the file to execute, while the remaining elements are the actual argument vector to pass to the file. Normally spawnAsyncWithPipes uses argv[0] as the file to execute, and passes all of argv to the child. SpawnFlagsSearchPathFromEnvp if argv[0] is not an abolute path, it will be looked for in the PATH from the passed child environment. Since: 2.34 SpawnFlagsCloexecPipes create all pipes with the O_CLOEXEC flag set. Since: 2.40 AnotherSpawnFlags Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [SpawnFlags] -> ShowS # Source #

Flags specifying match-time options.

Since: 2.14

Constructors

 RegexMatchFlagsAnchored The pattern is forced to be "anchored", that is, it is constrained to match only at the first matching point in the string that is being searched. This effect can also be achieved by appropriate constructs in the pattern itself such as the "^" metacharater. RegexMatchFlagsNotbol Specifies that first character of the string is not the beginning of a line, so the circumflex metacharacter should not match before it. Setting this without G_REGEX_MULTILINE (at compile time) causes circumflex never to match. This option affects only the behaviour of the circumflex metacharacter, it does not affect "\A". RegexMatchFlagsNoteol Specifies that the end of the subject string is not the end of a line, so the dollar metacharacter should not match it nor (except in multiline mode) a newline immediately before it. Setting this without G_REGEX_MULTILINE (at compile time) causes dollar never to match. This option affects only the behaviour of the dollar metacharacter, it does not affect "\Z" or "\z". RegexMatchFlagsNotempty An empty string is not considered to be a valid match if this option is set. If there are alternatives in the pattern, they are tried. If all the alternatives match the empty string, the entire match fails. For example, if the pattern "a?b?" is applied to a string not beginning with "a" or "b", it matches the empty string at the start of the string. With this flag set, this match is not valid, so GRegex searches further into the string for occurrences of "a" or "b". RegexMatchFlagsPartial Turns on the partial matching feature, for more documentation on partial matching see matchInfoIsPartialMatch. RegexMatchFlagsNewlineCr Overrides the newline definition set when creating a new Regex, setting the '\r' character as line terminator. RegexMatchFlagsNewlineLf Overrides the newline definition set when creating a new Regex, setting the '\n' character as line terminator. RegexMatchFlagsNewlineCrlf Overrides the newline definition set when creating a new Regex, setting the '\r\n' characters sequence as line terminator. RegexMatchFlagsNewlineAny Overrides the newline definition set when creating a new Regex, any Unicode newline sequence is recognised as a newline. These are '\r', '\n' and '\rn', and the single characters U+000B LINE TABULATION, U+000C FORM FEED (FF), U+0085 NEXT LINE (NEL), U+2028 LINE SEPARATOR and U+2029 PARAGRAPH SEPARATOR. RegexMatchFlagsNewlineAnycrlf Overrides the newline definition set when creating a new Regex; any '\r', '\n', or '\r\n' character sequence is recognized as a newline. Since: 2.34 RegexMatchFlagsBsrAnycrlf Overrides the newline definition for "\R" set when creating a new Regex; only '\r', '\n', or '\r\n' character sequences are recognized as a newline by "\R". Since: 2.34 RegexMatchFlagsBsrAny Overrides the newline definition for "\R" set when creating a new Regex; any Unicode newline character or character sequence are recognized as a newline by "\R". These are '\r', '\n' and '\rn', and the single characters U+000B LINE TABULATION, U+000C FORM FEED (FF), U+0085 NEXT LINE (NEL), U+2028 LINE SEPARATOR and U+2029 PARAGRAPH SEPARATOR. Since: 2.34 RegexMatchFlagsPartialSoft An alias for G_REGEX_MATCH_PARTIAL. Since: 2.34 RegexMatchFlagsPartialHard Turns on the partial matching feature. In contrast to to G_REGEX_MATCH_PARTIAL_SOFT, this stops matching as soon as a partial match is found, without continuing to search for a possible complete match. See matchInfoIsPartialMatch for more information. Since: 2.34 RegexMatchFlagsNotemptyAtstart Like G_REGEX_MATCH_NOTEMPTY, but only applied to the start of the matched string. For anchored patterns this can only happen for pattern containing "\K". Since: 2.34 AnotherRegexMatchFlags Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [RegexMatchFlags] -> ShowS # Source #

Flags specifying compile-time options.

Since: 2.14

Constructors

 RegexCompileFlagsCaseless Letters in the pattern match both upper- and lowercase letters. This option can be changed within a pattern by a "(?i)" option setting. RegexCompileFlagsMultiline By default, GRegex treats the strings as consisting of a single line of characters (even if it actually contains newlines). The "start of line" metacharacter ("^") matches only at the start of the string, while the "end of line" metacharacter ("$") matches only at the end of the string, or before a terminating newline (unless G_REGEX_DOLLAR_ENDONLY is set). When G_REGEX_MULTILINE is set, the "start of line" and "end of line" constructs match immediately following or immediately before any newline in the string, respectively, as well as at the very start and end. This can be changed within a pattern by a "(?m)" option setting. RegexCompileFlagsDotall A dot metacharater (".") in the pattern matches all characters, including newlines. Without it, newlines are excluded. This option can be changed within a pattern by a ("?s") option setting. RegexCompileFlagsExtended Whitespace data characters in the pattern are totally ignored except when escaped or inside a character class. Whitespace does not include the VT character (code 11). In addition, characters between an unescaped "#" outside a character class and the next newline character, inclusive, are also ignored. This can be changed within a pattern by a "(?x)" option setting. RegexCompileFlagsAnchored The pattern is forced to be "anchored", that is, it is constrained to match only at the first matching point in the string that is being searched. This effect can also be achieved by appropriate constructs in the pattern itself such as the "^" metacharater. RegexCompileFlagsDollarEndonly A dollar metacharacter ("$") in the pattern matches only at the end of the string. Without this option, a dollar also matches immediately before the final character if it is a newline (but not before any other newlines). This option is ignored if G_REGEX_MULTILINE is set. RegexCompileFlagsUngreedy Inverts the "greediness" of the quantifiers so that they are not greedy by default, but become greedy if followed by "?". It can also be set by a "(?U)" option setting within the pattern. RegexCompileFlagsRaw Usually strings must be valid UTF-8 strings, using this flag they are considered as a raw sequence of bytes. RegexCompileFlagsNoAutoCapture Disables the use of numbered capturing parentheses in the pattern. Any opening parenthesis that is not followed by "?" behaves as if it were followed by "?:" but named parentheses can still be used for capturing (and they acquire numbers in the usual way). RegexCompileFlagsOptimize Optimize the regular expression. If the pattern will be used many times, then it may be worth the effort to optimize it to improve the speed of matches. RegexCompileFlagsFirstline Limits an unanchored pattern to match before (or at) the first newline. Since: 2.34 RegexCompileFlagsDupnames Names used to identify capturing subpatterns need not be unique. This can be helpful for certain types of pattern when it is known that only one instance of the named subpattern can ever be matched. RegexCompileFlagsNewlineCr Usually any newline character or character sequence is recognized. If this option is set, the only recognized newline character is '\r'. RegexCompileFlagsNewlineLf Usually any newline character or character sequence is recognized. If this option is set, the only recognized newline character is '\n'. RegexCompileFlagsNewlineCrlf Usually any newline character or character sequence is recognized. If this option is set, the only recognized newline character sequence is '\r\n'. RegexCompileFlagsNewlineAnycrlf Usually any newline character or character sequence is recognized. If this option is set, the only recognized newline character sequences are '\r', '\n', and '\r\n'. Since: 2.34 RegexCompileFlagsBsrAnycrlf Usually any newline character or character sequence is recognised. If this option is set, then "\R" only recognizes the newline characters '\r', '\n' and '\r\n'. Since: 2.34 RegexCompileFlagsJavascriptCompat Changes behaviour so that it is compatible with JavaScript rather than PCRE. Since: 2.34 AnotherRegexCompileFlags Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [RegexCompileFlags] -> ShowS # Source #

Flags which modify individual options.

Constructors

 OptionFlagsNone No flags. Since: 2.42. OptionFlagsHidden The option doesn't appear in --help output. OptionFlagsInMain The option appears in the main section of the --help output, even if it is defined in a group. OptionFlagsReverse For options of the OptionArgNone kind, this flag indicates that the sense of the option is reversed. OptionFlagsNoArg For options of the OptionArgCallback kind, this flag indicates that the callback does not take any argument (like a OptionArgNone option). Since 2.8 OptionFlagsFilename For options of the OptionArgCallback kind, this flag indicates that the argument should be passed to the callback in the GLib filename encoding rather than UTF-8. Since 2.8 OptionFlagsOptionalArg For options of the OptionArgCallback kind, this flag indicates that the argument supply is optional. If no argument is given then data of GOptionParseFunc will be set to NULL. Since 2.8 OptionFlagsNoalias This flag turns off the automatic conflict resolution which prefixes long option names with groupname- if there is a conflict. This option should only be used in situations where aliasing is necessary to model some legacy commandline interface. It is not safe to use this option, unless all option groups are under your direct control. Since 2.8. AnotherOptionFlags Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [OptionFlags] -> ShowS # Source #

Flags that affect the behaviour of the parser.

Constructors

 MarkupParseFlagsDoNotUseThisUnsupportedFlag flag you should not use MarkupParseFlagsTreatCdataAsText When this flag is set, CDATA marked sections are not passed literally to the passthrough function of the parser. Instead, the content of the section (without the ) is passed to the text function. This flag was added in GLib 2.12 MarkupParseFlagsPrefixErrorPosition Normally errors caught by GMarkup itself have line/column information prefixed to them to let the caller know the location of the error. When this flag is set the location information is also prefixed to errors generated by the MarkupParser implementation functions MarkupParseFlagsIgnoreQualified Ignore (don't report) qualified attributes and tags, along with their contents. A qualified attribute or tag is one that contains ':' in its name (ie: is in another namespace). Since: 2.40. AnotherMarkupParseFlags Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [MarkupParseFlags] -> ShowS # Source #

A mixed enumerated type and flags field. You must specify one type (string, strdup, boolean, tristate). Additionally, you may optionally bitwise OR the type with the flag MarkupCollectTypeOptional.

It is likely that this enum will be extended in the future to support other types.

Constructors

 MarkupCollectTypeInvalid used to terminate the list of attributes to collect MarkupCollectTypeString collect the string pointer directly from the attribute_values[] array. Expects a parameter of type (const char **). If MarkupCollectTypeOptional is specified and the attribute isn't present then the pointer will be set to Nothing MarkupCollectTypeStrdup as with MarkupCollectTypeString, but expects a parameter of type (char **) and strdups the returned pointer. The pointer must be freed with free MarkupCollectTypeBoolean expects a parameter of type (gboolean *) and parses the attribute value as a boolean. Sets False if the attribute isn't present. Valid boolean values consist of (case-insensitive) "false", "f", "no", "n", "0" and "true", "t", "yes", "y", "1" MarkupCollectTypeTristate as with MarkupCollectTypeBoolean, but in the case of a missing attribute a value is set that compares equal to neither False nor True G_MARKUP_COLLECT_OPTIONAL is implied MarkupCollectTypeOptional can be bitwise ORed with the other fields. If present, allows the attribute not to appear. A default value is set depending on what value type is used AnotherMarkupCollectType Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [MarkupCollectType] -> ShowS # Source #

Flags specifying the level of log messages.

It is possible to change how GLib treats messages of the various levels using g_log_set_handler() and logSetFatalMask.

Constructors

 LogLevelFlagsFlagRecursion internal flag LogLevelFlagsFlagFatal internal flag LogLevelFlagsLevelError log level for errors, see g_error(). This level is also used for messages produced by g_assert(). LogLevelFlagsLevelCritical log level for critical warning messages, see g_critical(). This level is also used for messages produced by g_return_if_fail() and g_return_val_if_fail(). LogLevelFlagsLevelWarning log level for warnings, see g_warning() LogLevelFlagsLevelMessage log level for messages, see g_message() LogLevelFlagsLevelInfo log level for informational messages, see g_info() LogLevelFlagsLevelDebug log level for debug messages, see g_debug() LogLevelFlagsLevelMask a mask including all log levels AnotherLogLevelFlags Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [LogLevelFlags] -> ShowS # Source #

Flags which influence the parsing.

Constructors

 KeyFileFlagsNone No flags, default behaviour KeyFileFlagsKeepComments Use this flag if you plan to write the (possibly modified) contents of the key file back to a file; otherwise all comments will be lost when the key file is written back. KeyFileFlagsKeepTranslations Use this flag if you plan to write the (possibly modified) contents of the key file back to a file; otherwise only the translations for the current language will be written back. AnotherKeyFileFlags Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [KeyFileFlags] -> ShowS # Source #

data IOFlags Source #

Specifies properties of a IOChannel. Some of the flags can only be read with iOChannelGetFlags, but not changed with iOChannelSetFlags.

Constructors

 IOFlagsAppend turns on append mode, corresponds to O_APPEND (see the documentation of the UNIX open() syscall) IOFlagsNonblock turns on nonblocking mode, corresponds to O_NONBLOCK/O_NDELAY (see the documentation of the UNIX open() syscall) IOFlagsIsReadable indicates that the io channel is readable. This flag cannot be changed. IOFlagsIsWritable indicates that the io channel is writable. This flag cannot be changed. IOFlagsIsWriteable a misspelled version of gIOFLAGISWRITABLE that existed before the spelling was fixed in GLib 2.30. It is kept here for compatibility reasons. Deprecated since 2.30 IOFlagsIsSeekable indicates that the io channel is seekable, i.e. that iOChannelSeekPosition can be used on it. This flag cannot be changed. IOFlagsMask the mask that specifies all the valid flags. IOFlagsGetMask the mask of the flags that are returned from iOChannelGetFlags IOFlagsSetMask the mask of the flags that the user can modify with iOChannelSetFlags AnotherIOFlags Int Catch-all for unknown values

Instances

 Source # MethodsenumFrom :: IOFlags -> [IOFlags] #enumFromThen :: IOFlags -> IOFlags -> [IOFlags] #enumFromTo :: IOFlags -> IOFlags -> [IOFlags] #enumFromThenTo :: IOFlags -> IOFlags -> IOFlags -> [IOFlags] # Source # Methods(==) :: IOFlags -> IOFlags -> Bool #(/=) :: IOFlags -> IOFlags -> Bool # Source # Methods(<) :: IOFlags -> IOFlags -> Bool #(<=) :: IOFlags -> IOFlags -> Bool #(>) :: IOFlags -> IOFlags -> Bool #(>=) :: IOFlags -> IOFlags -> Bool # Source # MethodsshowList :: [IOFlags] -> ShowS # Source #

A bitwise combination representing a condition to watch for on an event source.

Constructors

 IOConditionIn There is data to read. IOConditionOut Data can be written (without blocking). IOConditionPri There is urgent data to read. IOConditionErr Error condition. IOConditionHup Hung up (the connection has been broken, usually for pipes and sockets). IOConditionNval Invalid request. The file descriptor is not open. AnotherIOCondition Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [IOCondition] -> ShowS # Source # Methods Source #

Flags used internally in the Hook implementation.

Constructors

 HookFlagMaskActive set if the hook has not been destroyed HookFlagMaskInCall set if the hook is currently being run HookFlagMaskMask A mask covering all bits reserved for hook flags; see HOOK_FLAG_USER_SHIFT AnotherHookFlagMask Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [HookFlagMask] -> ShowS # Source #

Flags to modify the format of the string returned by formatSizeFull.

Constructors

 FormatSizeFlagsDefault behave the same as formatSize FormatSizeFlagsLongFormat include the exact number of bytes as part of the returned string. For example, "45.6 kB (45,612 bytes)". FormatSizeFlagsIecUnits use IEC (base 1024) units with "KiB"-style suffixes. IEC units should only be used for reporting things with a strong "power of 2" basis, like RAM sizes or RAID stripe sizes. Network and storage sizes should be reported in the normal SI units. AnotherFormatSizeFlags Int Catch-all for unknown values

Instances

 Source # Methods Source # Methods Source # Methods Source # MethodsshowList :: [FormatSizeFlags] -> ShowS # Source #

data FileTest Source #

A test to perform on a file using fileTest.

Constructors

 FileTestIsRegular True if the file is a regular file (not a directory). Note that this test will also return True if the tested file is a symlink to a regular file. FileTestIsSymlink True if the file is a symlink. FileTestIsDir True if the file is a directory. FileTestIsExecutable True if the file is executable. FileTestExists True if the file exists. It may or may not be a regular file. AnotherFileTest Int Catch-all for unknown values

Instances

 Source # MethodsenumFrom :: FileTest -> [FileTest] #enumFromTo :: FileTest -> FileTest -> [FileTest] # Source # Methods Source # Methods(<) :: FileTest -> FileTest -> Bool #(>) :: FileTest -> FileTest -> Bool # Source # MethodsshowList :: [FileTest] -> ShowS # Source #

data AsciiType Source #

No description available in the introspection data.

Constructors

 AsciiTypeAlnum No description available in the introspection data. AsciiTypeAlpha No description available in the introspection data. AsciiTypeCntrl No description available in the introspection data. AsciiTypeDigit No description available in the introspection data. AsciiTypeGraph No description available in the introspection data. AsciiTypeLower No description available in the introspection data. AsciiTypePrint No description available in the introspection data. AsciiTypePunct No description available in the introspection data. AsciiTypeSpace No description available in the introspection data. AsciiTypeUpper No description available in the introspection data. AsciiTypeXdigit No description available in the introspection data. AnotherAsciiType Int Catch-all for unknown values

Instances

 Source # MethodsenumFrom :: AsciiType -> [AsciiType] # Source # Methods Source # Methods Source # MethodsshowList :: [AsciiType] -> ShowS # Source #