Enums

Details

class GLib.BookmarkFileError(value)

Bases: GLib.Enum

Error codes returned by bookmark file parsing.

INVALID_URI = 0

URI was ill-formed

INVALID_VALUE = 1

a requested field was not found

APP_NOT_REGISTERED = 2

a requested application did not register a bookmark

URI_NOT_FOUND = 3

a requested URI was not found

READ = 4

document was ill formed

UNKNOWN_ENCODING = 5

the text being parsed was in an unknown encoding

WRITE = 6

an error occurred while writing

FILE_NOT_FOUND = 7

requested file was not found

class GLib.ChecksumType(value)

Bases: GLib.Enum

The hashing algorithm to be used by GLib.Checksum when performing the digest of some data.

Note that the GLib.ChecksumType enumeration may be extended at a later date to include new hashing algorithm types.

New in version 2.16.

MD5 = 0

Use the MD5 hashing algorithm

SHA1 = 1

Use the SHA-1 hashing algorithm

SHA256 = 2

Use the SHA-256 hashing algorithm

SHA512 = 3

Use the SHA-512 hashing algorithm

New in version 2.36.

SHA384 = 4

Use the SHA-384 hashing algorithm

New in version 2.51.

class GLib.ConvertError(value)

Bases: GLib.Enum

Error codes returned by character set conversion routines.

NO_CONVERSION = 0

Conversion between the requested character sets is not supported.

ILLEGAL_SEQUENCE = 1

Invalid byte sequence in conversion input; or the character sequence could not be represented in the target character set.

FAILED = 2

Conversion failed for some reason.

PARTIAL_INPUT = 3

Partial character sequence at end of input.

BAD_URI = 4

URI is invalid.

NOT_ABSOLUTE_PATH = 5

Pathname is not an absolute path.

NO_MEMORY = 6

No memory available.

New in version 2.40.

EMBEDDED_NUL = 7

An embedded NUL character is present in conversion output where a NUL-terminated string is expected.

New in version 2.56.

class GLib.DateDMY(value)

Bases: GLib.Enum

This enumeration isn’t used in the API, but may be useful if you need to mark a number as a day, month, or year.

DAY = 0

a day

MONTH = 1

a month

YEAR = 2

a year

class GLib.DateMonth(value)

Bases: GLib.Enum

Enumeration representing a month; values are GLib.DateMonth.JANUARY, GLib.DateMonth.FEBRUARY, etc. GLib.DateMonth.BAD_MONTH is the invalid value.

BAD_MONTH = 0

invalid value

JANUARY = 1

January

OCTOBER = 10

October

NOVEMBER = 11

November

DECEMBER = 12

December

FEBRUARY = 2

February

MARCH = 3

March

APRIL = 4

April

MAY = 5

May

JUNE = 6

June

JULY = 7

July

AUGUST = 8

August

SEPTEMBER = 9

September

class GLib.DateWeekday(value)

Bases: GLib.Enum

Enumeration representing a day of the week; GLib.DateWeekday.MONDAY, GLib.DateWeekday.TUESDAY, etc. GLib.DateWeekday.BAD_WEEKDAY is an invalid weekday.

BAD_WEEKDAY = 0

invalid value

MONDAY = 1

Monday

TUESDAY = 2

Tuesday

WEDNESDAY = 3

Wednesday

THURSDAY = 4

Thursday

FRIDAY = 5

Friday

SATURDAY = 6

Saturday

SUNDAY = 7

Sunday

class GLib.Enum(value)

Base type for all enum types

Parameters:

value (int) –

class GLib.ErrorType(value)

Bases: GLib.Enum

The possible errors, used in the v_error field of GLib.TokenValue, when the token is a GLib.TokenType.ERROR.

UNKNOWN = 0

unknown error

UNEXP_EOF = 1

unexpected end of file

UNEXP_EOF_IN_STRING = 2

unterminated string constant

UNEXP_EOF_IN_COMMENT = 3

unterminated comment

NON_DIGIT_IN_CONST = 4

non-digit character in a number

DIGIT_RADIX = 5

digit beyond radix in a number

FLOAT_RADIX = 6

non-decimal floating point number

FLOAT_MALFORMED = 7

malformed floating point number

class GLib.FileError(value)

Bases: GLib.Enum

Values corresponding to errno codes returned from file operations on UNIX. Unlike errno codes, GLib.FileError values are available on all systems, even Windows. The exact meaning of each code depends on what sort of file operation you were performing; the UNIX documentation gives more details. The following error code descriptions come from the GNU C Library manual, and are under the copyright of that manual.

It’s not very portable to make detailed assumptions about exactly which errors will be returned from a given operation. Some errors don’t occur on some systems, etc., sometimes there are subtle differences in when a system will report a given error, etc.

EXIST = 0

Operation not permitted; only the owner of the file (or other resource) or processes with special privileges can perform the operation.

ISDIR = 1

File is a directory; you cannot open a directory for writing, or create or remove hard links to it.

FAULT = 10

You passed in a pointer to bad memory. (GLib won’t reliably return this, don’t pass in pointers to bad memory.)

LOOP = 11

Too many levels of symbolic links were encountered in looking up a file name. This often indicates a cycle of symbolic links.

NOSPC = 12

No space left on device; write operation on a file failed because the disk is full.

NOMEM = 13

No memory available. The system cannot allocate more virtual memory because its capacity is full.

MFILE = 14

The current process has too many files open and can’t open any more. Duplicate descriptors do count toward this limit.

NFILE = 15

There are too many distinct file openings in the entire system.

BADF = 16

Bad file descriptor; for example, I/O on a descriptor that has been closed or reading from a descriptor open only for writing (or vice versa).

INVAL = 17

Invalid argument. This is used to indicate various kinds of problems with passing the wrong argument to a library function.

PIPE = 18

Broken pipe; there is no process reading from the other end of a pipe. Every library function that returns this error code also generates a ‘SIGPIPE’ signal; this signal terminates the program if not handled or blocked. Thus, your program will never actually see this code unless it has handled or blocked ‘SIGPIPE’.

AGAIN = 19

Resource temporarily unavailable; the call might work if you try again later.

ACCES = 2

Permission denied; the file permissions do not allow the attempted operation.

INTR = 20

Interrupted function call; an asynchronous signal occurred and prevented completion of the call. When this happens, you should try the call again.

IO = 21

Input/output error; usually used for physical read or write errors. i.e. the disk or other physical device hardware is returning errors.

PERM = 22

Operation not permitted; only the owner of the file (or other resource) or processes with special privileges can perform the operation.

NOSYS = 23

Function not implemented; this indicates that the system is missing some functionality.

FAILED = 24

Does not correspond to a UNIX error code; this is the standard “failed for unspecified reason” error code present in all GLib.Error error code enumerations. Returned if no specific code applies.

NAMETOOLONG = 3

Filename too long.

NOENT = 4

No such file or directory. This is a “file doesn’t exist” error for ordinary files that are referenced in contexts where they are expected to already exist.

NOTDIR = 5

A file that isn’t a directory was specified when a directory is required.

NXIO = 6

No such device or address. The system tried to use the device represented by a file you specified, and it couldn’t find the device. This can mean that the device file was installed incorrectly, or that the physical device is missing or not correctly attached to the computer.

NODEV = 7

The underlying file system of the specified file does not support memory mapping.

ROFS = 8

The directory containing the new link can’t be modified because it’s on a read-only file system.

TXTBSY = 9

Text file busy.

class GLib.IOChannelError(value)

Bases: GLib.Enum

Error codes returned by GLib.IOChannel operations.

FBIG = 0

File too large.

INVAL = 1

Invalid argument.

IO = 2

IO error.

ISDIR = 3

File is a directory.

NOSPC = 4

No space left on device.

NXIO = 5

No such device or address.

OVERFLOW = 6

Value too large for defined datatype.

PIPE = 7

Broken pipe.

FAILED = 8

Some other error.

class GLib.IOError(value)

Bases: GLib.Enum

GLib.IOError is only used by the deprecated functions GLib.IOChannel.read(), GLib.IOChannel.write(), and GLib.IOChannel.seek().

NONE = 0

no error

AGAIN = 1

an EAGAIN error occurred

INVAL = 2

an EINVAL error occurred

UNKNOWN = 3

another error occurred

class GLib.IOStatus(value)

Bases: GLib.Enum

Statuses returned by most of the GLib.IOFuncs functions.

ERROR = 0

An error occurred.

NORMAL = 1

Success.

EOF = 2

End of file.

AGAIN = 3

Resource temporarily unavailable.

class GLib.KeyFileError(value)

Bases: GLib.Enum

Error codes returned by key file parsing.

UNKNOWN_ENCODING = 0

the text being parsed was in an unknown encoding

PARSE = 1

document was ill-formed

NOT_FOUND = 2

the file was not found

KEY_NOT_FOUND = 3

a requested key was not found

GROUP_NOT_FOUND = 4

a requested group was not found

INVALID_VALUE = 5

a value could not be parsed

class GLib.LogWriterOutput(value)

Bases: GLib.Enum

Return values from GLib.LogWriterFuncs to indicate whether the given log entry was successfully handled by the writer, or whether there was an error in handling it (and hence a fallback writer should be used).

If a GLib.LogWriterFunc ignores a log entry, it should return GLib.LogWriterOutput.HANDLED.

New in version 2.50.

UNHANDLED = 0

Log writer could not handle the log entry.

HANDLED = 1

Log writer has handled the log entry.

class GLib.MarkupError(value)

Bases: GLib.Enum

Error codes returned by markup parsing.

BAD_UTF8 = 0

text being parsed was not valid UTF-8

EMPTY = 1

document contained nothing, or only whitespace

PARSE = 2

document was ill-formed

UNKNOWN_ELEMENT = 3

error should be set by GLib.MarkupParser functions; element wasn’t known

UNKNOWN_ATTRIBUTE = 4

error should be set by GLib.MarkupParser functions; attribute wasn’t known

INVALID_CONTENT = 5

error should be set by GLib.MarkupParser functions; content was invalid

MISSING_ATTRIBUTE = 6

error should be set by GLib.MarkupParser functions; a required attribute was missing

class GLib.NormalizeMode(value)

Bases: GObject.GEnum

Defines how a Unicode string is transformed in a canonical form, standardizing such issues as whether a character with an accent is represented as a base character and combining accent or as a single precomposed character. Unicode strings should generally be normalized before comparing them.

DEFAULT = 0

standardize differences that do not affect the text content, such as the above-mentioned accent representation

NFD = 0

another name for GLib.NormalizeMode.DEFAULT

DEFAULT_COMPOSE = 1

like GLib.NormalizeMode.DEFAULT, but with composed forms rather than a maximally decomposed form

NFC = 1

another name for GLib.NormalizeMode.DEFAULT_COMPOSE

ALL = 2

beyond GLib.NormalizeMode.DEFAULT also standardize the “compatibility” characters in Unicode, such as SUPERSCRIPT THREE to the standard forms (in this case DIGIT THREE). Formatting information may be lost but for most text operations such characters should be considered the same

NFKD = 2

another name for GLib.NormalizeMode.ALL

ALL_COMPOSE = 3

like GLib.NormalizeMode.ALL, but with composed forms rather than a maximally decomposed form

NFKC = 3

another name for GLib.NormalizeMode.ALL_COMPOSE

class GLib.NumberParserError(value)

Bases: GLib.Enum

Error codes returned by functions converting a string to a number.

New in version 2.54.

INVALID = 0

string was not a valid number

OUT_OF_BOUNDS = 1

string was a number, but out of bounds

class GLib.OnceStatus(value)

Bases: GLib.Enum

The possible statuses of a one-time initialization function controlled by a GLib.Once struct.

New in version 2.4.

NOTCALLED = 0

the function has not been called yet.

PROGRESS = 1

the function call is currently in progress.

READY = 2

the function has been called.

class GLib.OptionArg(value)

Bases: GLib.Enum

The GLib.OptionArg enum values determine which type of extra argument the options expect to find. If an option expects an extra argument, it can be specified in several ways; with a short option: -x arg, with a long option: --name arg or combined in a single argument: --name=arg.

NONE = 0

No extra argument. This is useful for simple flags or booleans.

STRING = 1

The option takes a UTF-8 string argument.

INT = 2

The option takes an integer argument.

CALLBACK = 3

The option provides a callback (of type GLib.OptionArgFunc) to parse the extra argument.

FILENAME = 4

The option takes a filename as argument, which will be in the GLib filename encoding rather than UTF-8.

STRING_ARRAY = 5

The option takes a string argument, multiple uses of the option are collected into an array of strings.

FILENAME_ARRAY = 6

The option takes a filename as argument, multiple uses of the option are collected into an array of strings.

DOUBLE = 7

The option takes a double argument. The argument can be formatted either for the user’s locale or for the “C” locale.

New in version 2.12.

INT64 = 8

The option takes a 64-bit integer. Like GLib.OptionArg.INT but for larger numbers. The number can be in decimal base, or in hexadecimal (when prefixed with 0x, for example, 0xffffffff).

New in version 2.12.

class GLib.OptionError(value)

Bases: GLib.Enum

Error codes returned by option parsing.

UNKNOWN_OPTION = 0

An option was not known to the parser. This error will only be reported, if the parser hasn’t been instructed to ignore unknown options, see GLib.OptionContext.set_ignore_unknown_options().

BAD_VALUE = 1

A value couldn’t be parsed.

FAILED = 2

A GLib.OptionArgFunc callback failed.

class GLib.RegexError(value)

Bases: GLib.Enum

Error codes returned by regular expressions functions.

New in version 2.14.

COMPILE = 0

Compilation of the regular expression failed.

OPTIMIZE = 1

Optimization of the regular expression failed.

STRAY_BACKSLASH = 101

“\\” at end of pattern.

New in version 2.16.

MISSING_CONTROL_CHAR = 102

“\\c” at end of pattern.

New in version 2.16.

UNRECOGNIZED_ESCAPE = 103

Unrecognized character follows “\\”.

New in version 2.16.

QUANTIFIERS_OUT_OF_ORDER = 104

Numbers out of order in “{}” quantifier.

New in version 2.16.

QUANTIFIER_TOO_BIG = 105

Number too big in “{}” quantifier.

New in version 2.16.

UNTERMINATED_CHARACTER_CLASS = 106

Missing terminating “]” for character class.

New in version 2.16.

INVALID_ESCAPE_IN_CHARACTER_CLASS = 107

Invalid escape sequence in character class.

New in version 2.16.

RANGE_OUT_OF_ORDER = 108

Range out of order in character class.

New in version 2.16.

NOTHING_TO_REPEAT = 109

Nothing to repeat.

New in version 2.16.

UNRECOGNIZED_CHARACTER = 112

Unrecognized character after “(?”, “(?<” or “(?P”.

New in version 2.16.

POSIX_NAMED_CLASS_OUTSIDE_CLASS = 113

POSIX named classes are supported only within a class.

New in version 2.16.

UNMATCHED_PARENTHESIS = 114

Missing terminating “)” or “)” without opening “(“.

New in version 2.16.

INEXISTENT_SUBPATTERN_REFERENCE = 115

Reference to non-existent subpattern.

New in version 2.16.

UNTERMINATED_COMMENT = 118

Missing terminating “)” after comment.

New in version 2.16.

EXPRESSION_TOO_LARGE = 120

Regular expression too large.

New in version 2.16.

MEMORY_ERROR = 121

Failed to get memory.

New in version 2.16.

VARIABLE_LENGTH_LOOKBEHIND = 125

Lookbehind assertion is not fixed length.

New in version 2.16.

MALFORMED_CONDITION = 126

Malformed number or name after “(?(“.

New in version 2.16.

TOO_MANY_CONDITIONAL_BRANCHES = 127

Conditional group contains more than two branches.

New in version 2.16.

ASSERTION_EXPECTED = 128

Assertion expected after “(?(“.

New in version 2.16.

UNKNOWN_POSIX_CLASS_NAME = 130

Unknown POSIX class name.

New in version 2.16.

POSIX_COLLATING_ELEMENTS_NOT_SUPPORTED = 131

POSIX collating elements are not supported.

New in version 2.16.

HEX_CODE_TOO_LARGE = 134

Character value in “\\x{…}” sequence is too large.

New in version 2.16.

INVALID_CONDITION = 135

Invalid condition “(?(0)”.

New in version 2.16.

SINGLE_BYTE_MATCH_IN_LOOKBEHIND = 136

\\C not allowed in lookbehind assertion.

New in version 2.16.

INFINITE_LOOP = 140

Recursive call could loop indefinitely.

New in version 2.16.

MISSING_SUBPATTERN_NAME_TERMINATOR = 142

Missing terminator in subpattern name.

New in version 2.16.

DUPLICATE_SUBPATTERN_NAME = 143

Two named subpatterns have the same name.

New in version 2.16.

MALFORMED_PROPERTY = 146

Malformed “\\P” or “\\p” sequence.

New in version 2.16.

UNKNOWN_PROPERTY = 147

Unknown property name after “\\P” or “\\p”.

New in version 2.16.

SUBPATTERN_NAME_TOO_LONG = 148

Subpattern name is too long (maximum 32 characters).

New in version 2.16.

TOO_MANY_SUBPATTERNS = 149

Too many named subpatterns (maximum 10,000).

New in version 2.16.

INVALID_OCTAL_VALUE = 151

Octal value is greater than “\\377”.

New in version 2.16.

TOO_MANY_BRANCHES_IN_DEFINE = 154

“DEFINE” group contains more than one branch.

New in version 2.16.

DEFINE_REPETION = 155

Repeating a “DEFINE” group is not allowed. This error is never raised. Since: 2.16 Deprecated: 2.34

INCONSISTENT_NEWLINE_OPTIONS = 156

Inconsistent newline options.

New in version 2.16.

MISSING_BACK_REFERENCE = 157

“\\g” is not followed by a braced, angle-bracketed, or quoted name or number, or by a plain number.

New in version 2.16.

INVALID_RELATIVE_REFERENCE = 158

relative reference must not be zero.

New in version 2.34.

BACKTRACKING_CONTROL_VERB_ARGUMENT_FORBIDDEN = 159

the backtracing control verb used does not allow an argument.

New in version 2.34.

UNKNOWN_BACKTRACKING_CONTROL_VERB = 160

unknown backtracing control verb.

New in version 2.34.

NUMBER_TOO_BIG = 161

number is too big in escape sequence.

New in version 2.34.

MISSING_SUBPATTERN_NAME = 162

Missing subpattern name.

New in version 2.34.

MISSING_DIGIT = 163

Missing digit.

New in version 2.34.

INVALID_DATA_CHARACTER = 164

In JavaScript compatibility mode, “[” is an invalid data character.

New in version 2.34.

EXTRA_SUBPATTERN_NAME = 165

different names for subpatterns of the same number are not allowed.

New in version 2.34.

BACKTRACKING_CONTROL_VERB_ARGUMENT_REQUIRED = 166

the backtracing control verb requires an argument.

New in version 2.34.

INVALID_CONTROL_CHAR = 168

“\\c” must be followed by an ASCII character.

New in version 2.34.

MISSING_NAME = 169

“\\k” is not followed by a braced, angle-bracketed, or quoted name.

New in version 2.34.

NOT_SUPPORTED_IN_CLASS = 171

“\\N” is not supported in a class.

New in version 2.34.

TOO_MANY_FORWARD_REFERENCES = 172

too many forward references.

New in version 2.34.

NAME_TOO_LONG = 175

the name is too long in “(*MARK)”, “(*PRUNE)”, “(*SKIP)”, or “(*THEN)”.

New in version 2.34.

CHARACTER_VALUE_TOO_LARGE = 176

the character value in the \\u sequence is too large.

New in version 2.34.

REPLACE = 2

Replacement failed due to an ill-formed replacement string.

MATCH = 3

The match process failed.

INTERNAL = 4

Internal error of the regular expression engine.

New in version 2.16.

class GLib.SeekType(value)

Bases: GLib.Enum

An enumeration specifying the base position for a GLib.IOChannel.seek_position() operation.

CUR = 0

the current position in the file.

SET = 1

the start of the file.

END = 2

the end of the file.

class GLib.ShellError(value)

Bases: GLib.Enum

Error codes returned by shell functions.

BAD_QUOTING = 0

Mismatched or otherwise mangled quoting.

EMPTY_STRING = 1

String to be parsed was empty.

FAILED = 2

Some other error.

class GLib.SliceConfig(value)

Bases: GLib.Enum

ALWAYS_MALLOC = 1
BYPASS_MAGAZINES = 2
WORKING_SET_MSECS = 3
COLOR_INCREMENT = 4
CHUNK_SIZES = 5
CONTENTION_COUNTER = 6
class GLib.SpawnError(value)

Bases: GLib.Enum

Error codes returned by spawning processes.

FORK = 0

Fork failed due to lack of memory.

READ = 1

Read or select on pipes failed.

NOTDIR = 10

execv() returned ENOTDIR

LOOP = 11

execv() returned ELOOP

TXTBUSY = 12

execv() returned ETXTBUSY

IO = 13

execv() returned EIO

NFILE = 14

execv() returned ENFILE

MFILE = 15

execv() returned EMFILE

INVAL = 16

execv() returned EINVAL

ISDIR = 17

execv() returned EISDIR

LIBBAD = 18

execv() returned ELIBBAD

FAILED = 19

Some other fatal failure, error->message should explain.

CHDIR = 2

Changing to working directory failed.

ACCES = 3

execv() returned EACCES

PERM = 4

execv() returned EPERM

2BIG = 5
TOO_BIG = 5

execv() returned E2BIG

_2BIG = 5

deprecated alias for GLib.SpawnError.TOO_BIG (deprecated since GLib 2.32)

NOEXEC = 6

execv() returned ENOEXEC

NAMETOOLONG = 7

execv() returned ENAMETOOLONG

NOENT = 8

execv() returned ENOENT

NOMEM = 9

execv() returned ENOMEM

class GLib.TestFileType(value)

Bases: GLib.Enum

The type of file to return the filename for, when used with g_test_build_filename().

These two options correspond rather directly to the ‘dist’ and ‘built’ terminology that automake uses and are explicitly used to distinguish between the ‘srcdir’ and ‘builddir’ being separate. All files in your project should either be dist (in the EXTRA_DIST or dist_schema_DATA sense, in which case they will always be in the srcdir) or built (in the BUILT_SOURCES sense, in which case they will always be in the builddir).

Note: as a general rule of automake, files that are generated only as part of the build-from-git process (but then are distributed with the tarball) always go in srcdir (even if doing a srcdir != builddir build from git) and are considered as distributed files.

New in version 2.38.

DIST = 0

a file that was included in the distribution tarball

BUILT = 1

a file that was built on the compiling machine

class GLib.TestLogType(value)

Bases: GLib.Enum

NONE = 0
ERROR = 1
START_SUITE = 10
STOP_SUITE = 11
START_BINARY = 2
LIST_CASE = 3
SKIP_CASE = 4
START_CASE = 5
STOP_CASE = 6
MIN_RESULT = 7
MAX_RESULT = 8
MESSAGE = 9
class GLib.TestResult(value)

Bases: GLib.Enum

SUCCESS = 0
SKIPPED = 1
FAILURE = 2
INCOMPLETE = 3
class GLib.ThreadError(value)

Bases: GLib.Enum

Possible errors of thread related functions.

THREAD_ERROR_AGAIN = 0

a thread couldn’t be created due to resource shortage. Try again later.

class GLib.TimeType(value)

Bases: GLib.Enum

Disambiguates a given time in two ways.

First, specifies if the given time is in universal or local time.

Second, if the time is in local time, specifies if it is local standard time or local daylight time. This is important for the case where the same local time occurs twice (during daylight savings time transitions, for example).

STANDARD = 0

the time is in local standard time

DAYLIGHT = 1

the time is in local daylight time

UNIVERSAL = 2

the time is in UTC

class GLib.TokenType(value)

Bases: GLib.Enum

The possible types of token returned from each GLib.Scanner.get_next_token() call.

EOF = 0

the end of the file

LEFT_CURLY = 123

a ‘{’ character

RIGHT_CURLY = 125

a ‘}’ character

NONE = 256

not a token

ERROR = 257

an error occurred

CHAR = 258

a character

BINARY = 259

a binary integer

OCTAL = 260

an octal integer

INT = 261

an integer

HEX = 262

a hex integer

FLOAT = 263

a floating point number

STRING = 264

a string

SYMBOL = 265

a symbol

IDENTIFIER = 266

an identifier

IDENTIFIER_NULL = 267

a null identifier

COMMENT_SINGLE = 268

one line comment

COMMENT_MULTI = 269

multi line comment

LEFT_PAREN = 40

a ‘(’ character

RIGHT_PAREN = 41

a ‘)’ character

COMMA = 44

a ‘,’ character

EQUAL_SIGN = 61

a ‘=’ character

LEFT_BRACE = 91

a ‘[’ character

RIGHT_BRACE = 93

a ‘]’ character

class GLib.TraverseType(value)

Bases: GLib.Enum

Specifies the type of traversal performed by GLib.Tree.traverse(), GLib.Node.traverse() and g_node_find(). The different orders are illustrated here:

  • In order: A, B, C, D, E, F, G, H, I

  • Pre order: F, B, A, D, C, E, G, I, H

  • Post order: A, C, E, D, B, H, I, G, F

  • Level order: F, B, G, A, D, I, C, E, H

IN_ORDER = 0

vists a node’s left child first, then the node itself, then its right child. This is the one to use if you want the output sorted according to the compare function.

PRE_ORDER = 1

visits a node, then its children.

POST_ORDER = 2

visits the node’s children, then the node itself.

LEVEL_ORDER = 3

is not implemented for balanced binary trees. For n-ary trees, it vists the root node first, then its children, then its grandchildren, and so on. Note that this is less efficient than the other orders.

class GLib.UnicodeBreakType(value)

Bases: GObject.GEnum

These are the possible line break classifications.

Since new Unicode versions may add new types here, applications should be ready to handle unknown values. They may be regarded as GLib.UnicodeBreakType.UNKNOWN.

See Unicode Line Breaking Algorithm.

MANDATORY = 0

Mandatory Break (BK)

CARRIAGE_RETURN = 1

Carriage Return (CR)

AFTER = 10

Break Opportunity After (BA)

BEFORE = 11

Break Opportunity Before (BB)

BEFORE_AND_AFTER = 12

Break Opportunity Before and After (B2)

HYPHEN = 13

Hyphen (HY)

NON_STARTER = 14

Nonstarter (NS)

OPEN_PUNCTUATION = 15

Opening Punctuation (OP)

CLOSE_PUNCTUATION = 16

Closing Punctuation (CL)

QUOTATION = 17

Ambiguous Quotation (QU)

EXCLAMATION = 18

Exclamation/Interrogation (EX)

IDEOGRAPHIC = 19

Ideographic (ID)

LINE_FEED = 2

Line Feed (LF)

NUMERIC = 20

Numeric (NU)

INFIX_SEPARATOR = 21

Infix Separator (Numeric) (IS)

SYMBOL = 22

Symbols Allowing Break After (SY)

ALPHABETIC = 23

Ordinary Alphabetic and Symbol Characters (AL)

PREFIX = 24

Prefix (Numeric) (PR)

POSTFIX = 25

Postfix (Numeric) (PO)

COMPLEX_CONTEXT = 26

Complex Content Dependent (South East Asian) (SA)

AMBIGUOUS = 27

Ambiguous (Alphabetic or Ideographic) (AI)

UNKNOWN = 28

Unknown (XX)

NEXT_LINE = 29

Next Line (NL)

COMBINING_MARK = 3

Attached Characters and Combining Marks (CM)

WORD_JOINER = 30

Word Joiner (WJ)

HANGUL_L_JAMO = 31

Hangul L Jamo (JL)

HANGUL_V_JAMO = 32

Hangul V Jamo (JV)

HANGUL_T_JAMO = 33

Hangul T Jamo (JT)

HANGUL_LV_SYLLABLE = 34

Hangul LV Syllable (H2)

HANGUL_LVT_SYLLABLE = 35

Hangul LVT Syllable (H3)

CLOSE_PARANTHESIS = 36

Closing Parenthesis (CP).Deprecated: 2.70: Use GLib.UnicodeBreakType.CLOSE_PARENTHESIS instead.

New in version 2.28.

CLOSE_PARENTHESIS = 36

Closing Parenthesis (CP).

New in version 2.70.

CONDITIONAL_JAPANESE_STARTER = 37

Conditional Japanese Starter (CJ).

New in version 2.32.

HEBREW_LETTER = 38

Hebrew Letter (HL).

New in version 2.32.

REGIONAL_INDICATOR = 39

Regional Indicator (RI).

New in version 2.36.

SURROGATE = 4

Surrogates (SG)

EMOJI_BASE = 40

Emoji Base (EB).

New in version 2.50.

EMOJI_MODIFIER = 41

Emoji Modifier (EM).

New in version 2.50.

ZERO_WIDTH_JOINER = 42

Zero Width Joiner (ZWJ).

New in version 2.50.

AKSARA = 43

Aksara (AK).:obj:GLib.UnicodeBreakType.AKSARA_PRE_BASE (AP).:obj:GLib.UnicodeBreakType.AKSARA_START (AS).:obj:GLib.UnicodeBreakType.VIRAMA_FINAL (VF).:obj:GLib.UnicodeBreakType.VIRAMA (VI).

New in version 2.80.

AKSARA_PRE_BASE = 44
AKSARA_START = 45
VIRAMA_FINAL = 46
VIRAMA = 47
ZERO_WIDTH_SPACE = 5

Zero Width Space (ZW)

INSEPARABLE = 6

Inseparable (IN)

NON_BREAKING_GLUE = 7

Non-breaking (“Glue”) (GL)

CONTINGENT = 8

Contingent Break Opportunity (CB)

SPACE = 9

Space (SP)

class GLib.UnicodeScript(value)

Bases: GObject.GEnum

The GLib.UnicodeScript enumeration identifies different writing systems. The values correspond to the names as defined in the Unicode standard. The enumeration has been added in GLib 2.14, and is interchangeable with #PangoScript.

Note that new types may be added in the future. Applications should be ready to handle unknown values. See Unicode Standard Annex #24: Script names.

classmethod from_iso15924(iso15924)[source]
Parameters:

iso15924 (int) – a Unicode script

Returns:

the Unicode script for iso15924, or of GLib.UnicodeScript.INVALID_CODE if iso15924 is zero and GLib.UnicodeScript.UNKNOWN if iso15924 is unknown.

Return type:

GLib.UnicodeScript

Looks up the Unicode script for iso15924. ISO 15924 assigns four-letter codes to scripts. For example, the code for Arabic is ‘Arab’. This function accepts four letter codes encoded as a guint32 in a big-endian fashion. That is, the code expected for Arabic is 0x41726162 (0x41 is ASCII code for ‘A’, 0x72 is ASCII code for ‘r’, etc).

See Codes for the representation of names of scripts for details.

New in version 2.30.

classmethod to_iso15924(script)[source]
Parameters:

script (GLib.UnicodeScript) – a Unicode script

Returns:

the ISO 15924 code for script, encoded as an integer, of zero if script is GLib.UnicodeScript.INVALID_CODE or ISO 15924 code ‘Zzzz’ (script code for UNKNOWN) if script is not understood.

Return type:

int

Looks up the ISO 15924 code for script. ISO 15924 assigns four-letter codes to scripts. For example, the code for Arabic is ‘Arab’. The four letter codes are encoded as a guint32 by this function in a big-endian fashion. That is, the code returned for Arabic is 0x41726162 (0x41 is ASCII code for ‘A’, 0x72 is ASCII code for ‘r’, etc).

See Codes for the representation of names of scripts for details.

New in version 2.30.

INVALID_CODE = -1

a value never returned from GLib.unichar_get_script()

COMMON = 0

a character used by multiple different scripts

INHERITED = 1

a mark glyph that takes its script from the base glyph to which it is attached

DEVANAGARI = 10

Devanagari

SHARADA = 100

Sharada.

New in version 2.32.

SORA_SOMPENG = 101

Sora Sompeng.

New in version 2.32.

TAKRI = 102

Takri.

New in version 2.32.

BASSA_VAH = 103

Bassa.

New in version 2.42.

CAUCASIAN_ALBANIAN = 104

Caucasian Albanian.

New in version 2.42.

DUPLOYAN = 105

Duployan.

New in version 2.42.

ELBASAN = 106

Elbasan.

New in version 2.42.

GRANTHA = 107

Grantha.

New in version 2.42.

KHOJKI = 108

Kjohki.

New in version 2.42.

KHUDAWADI = 109

Khudawadi, Sindhi.

New in version 2.42.

ETHIOPIC = 11

Ethiopic

LINEAR_A = 110

Linear A.

New in version 2.42.

MAHAJANI = 111

Mahajani.

New in version 2.42.

MANICHAEAN = 112

Manichaean.

New in version 2.42.

MENDE_KIKAKUI = 113

Mende Kikakui.

New in version 2.42.

MODI = 114

Modi.

New in version 2.42.

MRO = 115

Mro.

New in version 2.42.

NABATAEAN = 116

Nabataean.

New in version 2.42.

OLD_NORTH_ARABIAN = 117

Old North Arabian.

New in version 2.42.

OLD_PERMIC = 118

Old Permic.

New in version 2.42.

PAHAWH_HMONG = 119

Pahawh Hmong.

New in version 2.42.

GEORGIAN = 12

Georgian

PALMYRENE = 120

Palmyrene.

New in version 2.42.

PAU_CIN_HAU = 121

Pau Cin Hau.

New in version 2.42.

PSALTER_PAHLAVI = 122

Psalter Pahlavi.

New in version 2.42.

SIDDHAM = 123

Siddham.

New in version 2.42.

TIRHUTA = 124

Tirhuta.

New in version 2.42.

WARANG_CITI = 125

Warang Citi.

New in version 2.42.

AHOM = 126

Ahom.

New in version 2.48.

ANATOLIAN_HIEROGLYPHS = 127

Anatolian Hieroglyphs.

New in version 2.48.

HATRAN = 128

Hatran.

New in version 2.48.

MULTANI = 129

Multani.

New in version 2.48.

GOTHIC = 13

Gothic

OLD_HUNGARIAN = 130

Old Hungarian.

New in version 2.48.

SIGNWRITING = 131

Signwriting.

New in version 2.48.

ADLAM = 132

Adlam.

New in version 2.50.

BHAIKSUKI = 133

Bhaiksuki.

New in version 2.50.

MARCHEN = 134

Marchen.

New in version 2.50.

NEWA = 135

Newa.

New in version 2.50.

OSAGE = 136

Osage.

New in version 2.50.

TANGUT = 137

Tangut.

New in version 2.50.

MASARAM_GONDI = 138

Masaram Gondi.

New in version 2.54.

NUSHU = 139

Nushu.

New in version 2.54.

GREEK = 14

Greek

SOYOMBO = 140

Soyombo.

New in version 2.54.

ZANABAZAR_SQUARE = 141

Zanabazar Square.

New in version 2.54.

DOGRA = 142

Dogra.

New in version 2.58.

GUNJALA_GONDI = 143

Gunjala Gondi.

New in version 2.58.

HANIFI_ROHINGYA = 144

Hanifi Rohingya.

New in version 2.58.

MAKASAR = 145

Makasar.

New in version 2.58.

MEDEFAIDRIN = 146

Medefaidrin.

New in version 2.58.

OLD_SOGDIAN = 147

Old Sogdian.

New in version 2.58.

SOGDIAN = 148

Sogdian.

New in version 2.58.

ELYMAIC = 149

Elym.

New in version 2.62.

GUJARATI = 15

Gujarati

NANDINAGARI = 150

Nand.

New in version 2.62.

NYIAKENG_PUACHUE_HMONG = 151

Rohg.

New in version 2.62.

WANCHO = 152

Wcho.

New in version 2.62.

CHORASMIAN = 153

Chorasmian.

New in version 2.66.

DIVES_AKURU = 154

Dives Akuru.

New in version 2.66.

KHITAN_SMALL_SCRIPT = 155

Khitan small script.

New in version 2.66.

YEZIDI = 156

Yezidi.

New in version 2.66.

CYPRO_MINOAN = 157

Cypro-Minoan.

New in version 2.72.

OLD_UYGHUR = 158

Old Uyghur.

New in version 2.72.

TANGSA = 159

Tangsa.

New in version 2.72.

GURMUKHI = 16

Gurmukhi

TOTO = 160

Toto.

New in version 2.72.

VITHKUQI = 161

Vithkuqi.

New in version 2.72.

MATH = 162

Mathematical notation.

New in version 2.72.

KAWI = 163

Kawi.

New in version 2.74.

NAG_MUNDARI = 164

Nag Mundari.

New in version 2.74.

HAN = 17

Han

HANGUL = 18

Hangul

HEBREW = 19

Hebrew

ARABIC = 2

Arabic

HIRAGANA = 20

Hiragana

KANNADA = 21

Kannada

KATAKANA = 22

Katakana

KHMER = 23

Khmer

LAO = 24

Lao

LATIN = 25

Latin

MALAYALAM = 26

Malayalam

MONGOLIAN = 27

Mongolian

MYANMAR = 28

Myanmar

OGHAM = 29

Ogham

ARMENIAN = 3

Armenian

OLD_ITALIC = 30

Old Italic

ORIYA = 31

Oriya

RUNIC = 32

Runic

SINHALA = 33

Sinhala

SYRIAC = 34

Syriac

TAMIL = 35

Tamil

TELUGU = 36

Telugu

THAANA = 37

Thaana

THAI = 38

Thai

TIBETAN = 39

Tibetan

BENGALI = 4

Bengali

CANADIAN_ABORIGINAL = 40

Canadian Aboriginal

YI = 41

Yi

TAGALOG = 42

Tagalog

HANUNOO = 43

Hanunoo

BUHID = 44

Buhid

TAGBANWA = 45

Tagbanwa

BRAILLE = 46

Braille

CYPRIOT = 47

Cypriot

LIMBU = 48

Limbu

OSMANYA = 49

Osmanya

BOPOMOFO = 5

Bopomofo

SHAVIAN = 50

Shavian

LINEAR_B = 51

Linear B

TAI_LE = 52

Tai Le

UGARITIC = 53

Ugaritic

NEW_TAI_LUE = 54

New Tai Lue

BUGINESE = 55

Buginese

GLAGOLITIC = 56

Glagolitic

TIFINAGH = 57

Tifinagh

SYLOTI_NAGRI = 58

Syloti Nagri

OLD_PERSIAN = 59

Old Persian

CHEROKEE = 6

Cherokee

KHAROSHTHI = 60

Kharoshthi

UNKNOWN = 61

an unassigned code point

BALINESE = 62

Balinese

CUNEIFORM = 63

Cuneiform

PHOENICIAN = 64

Phoenician

PHAGS_PA = 65

Phags-pa

NKO = 66

N’Ko

KAYAH_LI = 67

Kayah Li.

New in version 2.16.3.

LEPCHA = 68

Lepcha.

New in version 2.16.3.

REJANG = 69

Rejang.

New in version 2.16.3.

COPTIC = 7

Coptic

SUNDANESE = 70

Sundanese.

New in version 2.16.3.

SAURASHTRA = 71

Saurashtra.

New in version 2.16.3.

CHAM = 72

Cham.

New in version 2.16.3.

OL_CHIKI = 73

Ol Chiki.

New in version 2.16.3.

VAI = 74

Vai.

New in version 2.16.3.

CARIAN = 75

Carian.

New in version 2.16.3.

LYCIAN = 76

Lycian.

New in version 2.16.3.

LYDIAN = 77

Lydian.

New in version 2.16.3.

AVESTAN = 78

Avestan.

New in version 2.26.

BAMUM = 79

Bamum.

New in version 2.26.

CYRILLIC = 8

Cyrillic

EGYPTIAN_HIEROGLYPHS = 80

Egyptian Hieroglpyhs.

New in version 2.26.

IMPERIAL_ARAMAIC = 81

Imperial Aramaic.

New in version 2.26.

INSCRIPTIONAL_PAHLAVI = 82

Inscriptional Pahlavi.

New in version 2.26.

INSCRIPTIONAL_PARTHIAN = 83

Inscriptional Parthian.

New in version 2.26.

JAVANESE = 84

Javanese.

New in version 2.26.

KAITHI = 85

Kaithi.

New in version 2.26.

LISU = 86

Lisu.

New in version 2.26.

MEETEI_MAYEK = 87

Meetei Mayek.

New in version 2.26.

OLD_SOUTH_ARABIAN = 88

Old South Arabian.

New in version 2.26.

OLD_TURKIC = 89

Old Turkic.

New in version 2.28.

DESERET = 9

Deseret

SAMARITAN = 90

Samaritan.

New in version 2.26.

TAI_THAM = 91

Tai Tham.

New in version 2.26.

TAI_VIET = 92

Tai Viet.

New in version 2.26.

BATAK = 93

Batak.

New in version 2.28.

BRAHMI = 94

Brahmi.

New in version 2.28.

MANDAIC = 95

Mandaic.

New in version 2.28.

CHAKMA = 96

Chakma.

New in version 2.32.

MEROITIC_CURSIVE = 97

Meroitic Cursive.

New in version 2.32.

MEROITIC_HIEROGLYPHS = 98

Meroitic Hieroglyphs.

New in version 2.32.

MIAO = 99

Miao.

New in version 2.32.

class GLib.UnicodeType(value)

Bases: GObject.GEnum

These are the possible character classifications from the Unicode specification. See Unicode Character Database.

CONTROL = 0

General category “Other, Control” (Cc)

FORMAT = 1

General category “Other, Format” (Cf)

SPACING_MARK = 10

General category “Mark, Spacing” (Mc)

ENCLOSING_MARK = 11

General category “Mark, Enclosing” (Me)

NON_SPACING_MARK = 12

General category “Mark, Nonspacing” (Mn)

DECIMAL_NUMBER = 13

General category “Number, Decimal Digit” (Nd)

LETTER_NUMBER = 14

General category “Number, Letter” (Nl)

OTHER_NUMBER = 15

General category “Number, Other” (No)

CONNECT_PUNCTUATION = 16

General category “Punctuation, Connector” (Pc)

DASH_PUNCTUATION = 17

General category “Punctuation, Dash” (Pd)

CLOSE_PUNCTUATION = 18

General category “Punctuation, Close” (Pe)

FINAL_PUNCTUATION = 19

General category “Punctuation, Final quote” (Pf)

UNASSIGNED = 2

General category “Other, Not Assigned” (Cn)

INITIAL_PUNCTUATION = 20

General category “Punctuation, Initial quote” (Pi)

OTHER_PUNCTUATION = 21

General category “Punctuation, Other” (Po)

OPEN_PUNCTUATION = 22

General category “Punctuation, Open” (Ps)

CURRENCY_SYMBOL = 23

General category “Symbol, Currency” (Sc)

MODIFIER_SYMBOL = 24

General category “Symbol, Modifier” (Sk)

MATH_SYMBOL = 25

General category “Symbol, Math” (Sm)

OTHER_SYMBOL = 26

General category “Symbol, Other” (So)

LINE_SEPARATOR = 27

General category “Separator, Line” (Zl)

PARAGRAPH_SEPARATOR = 28

General category “Separator, Paragraph” (Zp)

SPACE_SEPARATOR = 29

General category “Separator, Space” (Zs)

PRIVATE_USE = 3

General category “Other, Private Use” (Co)

SURROGATE = 4

General category “Other, Surrogate” (Cs)

LOWERCASE_LETTER = 5

General category “Letter, Lowercase” (Ll)

MODIFIER_LETTER = 6

General category “Letter, Modifier” (Lm)

OTHER_LETTER = 7

General category “Letter, Other” (Lo)

TITLECASE_LETTER = 8

General category “Letter, Titlecase” (Lt)

UPPERCASE_LETTER = 9

General category “Letter, Uppercase” (Lu)

class GLib.UnixPipeEnd(value)

Bases: GLib.Enum

Mnemonic constants for the ends of a Unix pipe.

New in version 2.80.

READ = 0

The readable file descriptor 0

WRITE = 1

The writable file descriptor 1

class GLib.UriError(value)

Bases: GLib.Enum

Error codes returned by GLib.Uri methods.

New in version 2.66.

FAILED = 0

Generic error if no more specific error is available. See the error message for details.

BAD_SCHEME = 1

The scheme of a URI could not be parsed.

BAD_USER = 2

The user/userinfo of a URI could not be parsed.

BAD_PASSWORD = 3

The password of a URI could not be parsed.

BAD_AUTH_PARAMS = 4

The authentication parameters of a URI could not be parsed.

BAD_HOST = 5

The host of a URI could not be parsed.

BAD_PORT = 6

The port of a URI could not be parsed.

BAD_PATH = 7

The path of a URI could not be parsed.

BAD_QUERY = 8

The query of a URI could not be parsed.

BAD_FRAGMENT = 9

The fragment of a URI could not be parsed.

class GLib.UserDirectory(value)

Bases: GLib.Enum

These are logical ids for special directories which are defined depending on the platform used. You should use GLib.get_user_special_dir() to retrieve the full path associated to the logical id.

The GLib.UserDirectory enumeration can be extended at later date. Not every platform has a directory for every logical id in this enumeration.

New in version 2.14.

DIRECTORY_DESKTOP = 0

the user’s Desktop directory

DIRECTORY_DOCUMENTS = 1

the user’s Documents directory

DIRECTORY_DOWNLOAD = 2

the user’s Downloads directory

DIRECTORY_MUSIC = 3

the user’s Music directory

DIRECTORY_PICTURES = 4

the user’s Pictures directory

DIRECTORY_PUBLIC_SHARE = 5

the user’s shared directory

DIRECTORY_TEMPLATES = 6

the user’s Templates directory

DIRECTORY_VIDEOS = 7

the user’s Movies directory

N_DIRECTORIES = 8

the number of enum values

class GLib.VariantClass(value)

Bases: GLib.Enum

The range of possible top-level types of GLib.Variant instances.

New in version 2.24.

DOUBLE = 100

The GLib.Variant is a double precision floating point value.

SIGNATURE = 103

The GLib.Variant is a D-Bus signature string.

HANDLE = 104

The GLib.Variant is a file handle index.

INT32 = 105

The GLib.Variant is a signed 32 bit integer.

MAYBE = 109

The GLib.Variant is a maybe-typed value.

INT16 = 110

The GLib.Variant is a signed 16 bit integer.

OBJECT_PATH = 111

The GLib.Variant is a D-Bus object path string.

UINT16 = 113

The GLib.Variant is an unsigned 16 bit integer.

STRING = 115

The GLib.Variant is a normal string.

UINT64 = 116

The GLib.Variant is an unsigned 64 bit integer.

UINT32 = 117

The GLib.Variant is an unsigned 32 bit integer.

VARIANT = 118

The GLib.Variant is a variant.

INT64 = 120

The GLib.Variant is a signed 64 bit integer.

BYTE = 121

The GLib.Variant is a byte.

DICT_ENTRY = 123

The GLib.Variant is a dictionary entry.

TUPLE = 40

The GLib.Variant is a tuple.

ARRAY = 97

The GLib.Variant is an array.

BOOLEAN = 98

The GLib.Variant is a boolean.

class GLib.VariantParseError(value)

Bases: GLib.Enum

Error codes returned by parsing text-format GVariants.

FAILED = 0

generic error (unused)

BASIC_TYPE_EXPECTED = 1

a non-basic GLib.VariantType was given where a basic type was expected

NO_COMMON_TYPE = 10

could not find a common type for array entries

NUMBER_OUT_OF_RANGE = 11

the numerical value is out of range of the given type

NUMBER_TOO_BIG = 12

the numerical value is out of range for any type

TYPE_ERROR = 13

cannot parse as variant of the specified type

UNEXPECTED_TOKEN = 14

an unexpected token was encountered

UNKNOWN_KEYWORD = 15

an unknown keyword was encountered

UNTERMINATED_STRING_CONSTANT = 16

unterminated string constant

VALUE_EXPECTED = 17

no value given

RECURSION = 18

variant was too deeply nested; GLib.Variant is only guaranteed to handle nesting up to 64 levels

New in version 2.64.

CANNOT_INFER_TYPE = 2

cannot infer the GLib.VariantType

DEFINITE_TYPE_EXPECTED = 3

an indefinite GLib.VariantType was given where a definite type was expected

INPUT_NOT_AT_END = 4

extra data after parsing finished

INVALID_CHARACTER = 5

invalid character in number or unicode escape

INVALID_FORMAT_STRING = 6

not a valid GLib.Variant format string

INVALID_OBJECT_PATH = 7

not a valid object path

INVALID_SIGNATURE = 8

not a valid type signature

INVALID_TYPE_STRING = 9

not a valid GLib.Variant type string