GI.GLib.Constants

Documentation

pattern WIN32_MSG_HANDLE :: Int32

No description available in the introspection data.

pattern VERSION_MIN_REQUIRED :: Int32

A macro that should be defined by the user prior to including the glib.h header. The definition should be one of the predefined GLib version macros: GLIB_VERSION_2_26, GLIB_VERSION_2_28,...

This macro defines the earliest version of GLib that the package is required to be able to compile against.

If the compiler is configured to warn about the use of deprecated functions, then using functions that were deprecated in version VERSION_MIN_REQUIRED or earlier will cause warnings (but using functions deprecated in later releases will not).

Since: 2.32

pattern VA_COPY_AS_ARRAY :: Int32

No description available in the introspection data.

pattern USEC_PER_SEC :: Int32

Number of microseconds in one second (1 million). This macro is provided for code readability.

pattern URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS :: Text

Subcomponent delimiter characters as defined in RFC 3986. Includes "!$&'()*+,;=".

pattern URI_RESERVED_CHARS_GENERIC_DELIMITERS :: Text

Generic delimiters characters as defined in RFC 3986. Includes ":/?#[]@".

pattern UNICHAR_MAX_DECOMPOSITION_LENGTH :: Int32

The maximum length (in codepoints) of a compatibility or canonical decomposition of a single Unicode character.

This is as defined by Unicode 6.1.

Since: 2.32

pattern TIME_SPAN_SECOND :: Int64

Evaluates to a time span of one second.

Since: 2.26

pattern TIME_SPAN_MINUTE :: Int64

Evaluates to a time span of one minute.

Since: 2.26

pattern TIME_SPAN_MILLISECOND :: Int64

Evaluates to a time span of one millisecond.

Since: 2.26

pattern TIME_SPAN_HOUR :: Int64

Evaluates to a time span of one hour.

Since: 2.26

pattern TIME_SPAN_DAY :: Int64

Evaluates to a time span of one day.

Since: 2.26

pattern TEST_OPTION_ISOLATE_DIRS :: Text

Creates a unique temporary directory for each unit test and uses g_set_user_dirs() to set XDG directories to point into subdirectories of it for the duration of the unit test. The directory tree is cleaned up after the test finishes successfully. Note that this doesn’t take effect until testRun is called, so calls to (for example) g_get_user_home_dir() will return the system-wide value when made in a test program’s main() function.

The following functions will return subdirectories of the temporary directory when this option is used. The specific subdirectory paths in use are not guaranteed to be stable API — always use a getter function to retrieve them.

• getHomeDir
• getUserCacheDir
• getSystemConfigDirs
• getUserConfigDir
• getSystemDataDirs
• getUserDataDir
• getUserRuntimeDir

The subdirectories may not be created by the test harness; as with normal calls to functions like getUserCacheDir, the caller must be prepared to create the directory if it doesn’t exist.

Since: 2.60

pattern SYSDEF_MSG_PEEK :: Int32

No description available in the introspection data.

pattern SYSDEF_MSG_OOB :: Int32

No description available in the introspection data.

pattern SYSDEF_MSG_DONTROUTE :: Int32

No description available in the introspection data.

pattern SYSDEF_AF_UNIX :: Int32

No description available in the introspection data.

pattern SYSDEF_AF_INET6 :: Int32

No description available in the introspection data.

pattern SYSDEF_AF_INET :: Int32

No description available in the introspection data.

pattern STR_DELIMITERS :: Text

The standard delimiters, used in strdelimit.

pattern SQRT2 :: Double

The square root of two.

pattern SOURCE_REMOVE :: Bool

Use this macro as the return value of a SourceFunc to remove the Source from the main loop.

Since: 2.32

pattern SOURCE_CONTINUE :: Bool

Use this macro as the return value of a SourceFunc to leave the Source in the main loop.

Since: 2.32

pattern SIZEOF_VOID_P :: Int32

No description available in the introspection data.

pattern SIZEOF_SSIZE_T :: Int32

No description available in the introspection data.

pattern SIZEOF_SIZE_T :: Int32

No description available in the introspection data.

pattern SIZEOF_LONG :: Int32

No description available in the introspection data.

pattern SEARCHPATH_SEPARATOR_S :: Text

The search path separator as a string. This is ":" on UNIX machines and ";" under Windows.

pattern SEARCHPATH_SEPARATOR :: Int32

The search path separator character. This is ':' on UNIX machines and ';' under Windows.

pattern PRIORITY_LOW :: Int32

Use this for very low priority background tasks.

It is not used within GLib or GTK+.

pattern PRIORITY_HIGH_IDLE :: Int32

Use this for high priority idle functions.

GTK+ uses PRIORITY_HIGH_IDLE + 10 for resizing operations, and PRIORITY_HIGH_IDLE + 20 for redrawing operations. (This is done to ensure that any pending resizes are processed before any pending redraws, so that widgets are not redrawn twice unnecessarily.)

pattern PRIORITY_HIGH :: Int32

Use this for high priority event sources.

It is not used within GLib or GTK+.

pattern PRIORITY_DEFAULT_IDLE :: Int32

Use this for default priority idle functions.

In GLib this priority is used when adding idle functions with g_idle_add().

pattern PRIORITY_DEFAULT :: Int32

Use this for default priority event sources.

In GLib this priority is used when adding timeout functions with g_timeout_add(). In GDK this priority is used for events from the X server.

pattern POLLFD_FORMAT :: Text

A format specifier that can be used in printf()-style format strings when printing the fd member of a PollFD.

pattern PI_4 :: Double

Pi divided by 4.

pattern PI_2 :: Double

Pi divided by 2.

pattern PID_FORMAT :: Text

A format specifier that can be used in printf()-style format strings when printing a GPid.

Since: 2.50

pattern PI :: Double

The value of pi (ratio of circle's circumference to its diameter).

pattern PDP_ENDIAN :: Int32

Specifies one of the possible types of byte order (currently unused). See G_BYTE_ORDER.

pattern OPTION_REMAINING :: Text

If a long option in the main group has this name, it is not treated as a regular option. Instead it collects all non-option arguments which would otherwise be left in argv. The option must be of type OptionArgCallback, OptionArgStringArray or OptionArgFilenameArray.

Using OPTION_REMAINING instead of simply scanning argv for leftover arguments has the advantage that GOption takes care of necessary encoding conversions for strings or filenames.

Since: 2.6

pattern MODULE_SUFFIX :: Text

No description available in the introspection data.

pattern MINOR_VERSION :: Int32

The minor version number of the GLib library.

Like gtk_minor_version, but from the headers used at application compile time, rather than from the library linked against at application run time.

pattern MININT8 :: Int8

The minimum value which can be held in a gint8.

Since: 2.4

pattern MININT64 :: Int64

The minimum value which can be held in a gint64.

pattern MININT32 :: Int32

The minimum value which can be held in a gint32.

Since: 2.4

pattern MININT16 :: Int16

The minimum value which can be held in a gint16.

Since: 2.4

pattern MICRO_VERSION :: Int32

The micro version number of the GLib library.

Like gtk_micro_version, but from the headers used at application compile time, rather than from the library linked against at application run time.

pattern MAXUINT8 :: Word8

The maximum value which can be held in a guint8.

Since: 2.4

pattern MAXUINT64 :: Word64

The maximum value which can be held in a guint64.

pattern MAXUINT32 :: Word32

The maximum value which can be held in a guint32.

Since: 2.4

pattern MAXUINT16 :: Word16

The maximum value which can be held in a guint16.

Since: 2.4

pattern MAXINT8 :: Int8

The maximum value which can be held in a gint8.

Since: 2.4

pattern MAXINT64 :: Int64

The maximum value which can be held in a gint64.

pattern MAXINT32 :: Int32

The maximum value which can be held in a gint32.

Since: 2.4

pattern MAXINT16 :: Int16

The maximum value which can be held in a gint16.

Since: 2.4

pattern MAJOR_VERSION :: Int32

The major version number of the GLib library.

Like glib_major_version, but from the headers used at application compile time, rather than from the library linked against at application run time.

pattern LOG_LEVEL_USER_SHIFT :: Int32

Log levels below 1<<G_LOG_LEVEL_USER_SHIFT are used by GLib. Higher bits can be used for user-defined log levels.

pattern LOG_FATAL_MASK :: Int32

GLib log levels that are considered fatal by default.

This is not used if structured logging is enabled; see [Using Structured Logging][using-structured-logging].

pattern LOG_DOMAIN :: Int8

Defines the log domain. See Log Domains.

Libraries should define this so that any messages which they log can be differentiated from messages from other libraries and application code. But be careful not to define it in any public header files.

Log domains must be unique, and it is recommended that they are the application or library name, optionally followed by a hyphen and a sub-domain name. For example, bloatpad or bloatpad-io.

If undefined, it defaults to the default Nothing (or "") log domain; this is not advisable, as it cannot be filtered against using the G_MESSAGES_DEBUG environment variable.

For example, GTK+ uses this in its Makefile.am: > >AM_CPPFLAGS = -DG_LOG_DOMAIN="Gtk"

Applications can choose to leave it as the default Nothing (or "") domain. However, defining the domain offers the same advantages as above.

pattern LOG_2_BASE_10 :: Double

Multiplying the base 2 exponent by this number yields the base 10 exponent.

pattern LN2 :: Double

The natural logarithm of 2.

pattern LN10 :: Double

The natural logarithm of 10.

pattern LITTLE_ENDIAN :: Int32

Specifies one of the possible types of byte order. See G_BYTE_ORDER.

pattern KEY_FILE_DESKTOP_TYPE_LINK :: Text

The value of the KEY_FILE_DESKTOP_KEY_TYPE, key for desktop entries representing links to documents.

Since: 2.14

pattern KEY_FILE_DESKTOP_TYPE_DIRECTORY :: Text

The value of the KEY_FILE_DESKTOP_KEY_TYPE, key for desktop entries representing directories.

Since: 2.14

pattern KEY_FILE_DESKTOP_TYPE_APPLICATION :: Text

The value of the KEY_FILE_DESKTOP_KEY_TYPE, key for desktop entries representing applications.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_VERSION :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a string giving the version of the Desktop Entry Specification used for the desktop entry file.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_URL :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a string giving the URL to access. It is only valid for desktop entries with the Link type.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_TYPE :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a string giving the type of the desktop entry. Usually KEY_FILE_DESKTOP_TYPE_APPLICATION, KEY_FILE_DESKTOP_TYPE_LINK, or KEY_FILE_DESKTOP_TYPE_DIRECTORY.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_TRY_EXEC :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a string giving the file name of a binary on disk used to determine if the program is actually installed. It is only valid for desktop entries with the Application type.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_TERMINAL :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a boolean stating whether the program should be run in a terminal window. It is only valid for desktop entries with the Application type.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is string identifying the WM class or name hint of a window that the application will create, which can be used to emulate Startup Notification with older applications.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a boolean stating whether the application supports the Startup Notification Protocol Specification.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_PATH :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a string containing the working directory to run the program in. It is only valid for desktop entries with the Application type.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a list of strings identifying the environments that should display the desktop entry.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_NO_DISPLAY :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a boolean stating whether the desktop entry should be shown in menus.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a list of strings identifying the environments that should not display the desktop entry.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_NAME :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a localized string giving the specific name of the desktop entry.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_MIME_TYPE :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a list of strings giving the MIME types supported by this desktop entry.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_ICON :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a localized string giving the name of the icon to be displayed for the desktop entry.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_HIDDEN :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a boolean stating whether the desktop entry has been deleted by the user.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_GENERIC_NAME :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a localized string giving the generic name of the desktop entry.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_EXEC :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a string giving the command line to execute. It is only valid for desktop entries with the Application type.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a boolean set to true if the application is D-Bus activatable.

Since: 2.38

pattern KEY_FILE_DESKTOP_KEY_COMMENT :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a localized string giving the tooltip for the desktop entry.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_CATEGORIES :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a list of strings giving the categories in which the desktop entry should be shown in a menu.

Since: 2.14

pattern KEY_FILE_DESKTOP_KEY_ACTIONS :: Text

A key under KEY_FILE_DESKTOP_GROUP, whose value is a string list giving the available application actions.

Since: 2.38

pattern KEY_FILE_DESKTOP_GROUP :: Text

The name of the main group of a desktop entry file, as defined in the Desktop Entry Specification. Consult the specification for more details about the meanings of the keys below.

Since: 2.14

pattern IEEE754_FLOAT_BIAS :: Int32

The bias by which exponents in single-precision floats are offset.

pattern IEEE754_DOUBLE_BIAS :: Int32

The bias by which exponents in double-precision floats are offset.

pattern HOOK_FLAG_USER_SHIFT :: Int32

The position of the first bit which is not reserved for internal use be the Hook implementation, i.e. 1 << G_HOOK_FLAG_USER_SHIFT is the first bit which can be used for application-defined flags.

pattern HAVE_ISO_VARARGS :: Int32

No description available in the introspection data.

pattern HAVE_GROWING_STACK :: Int32

No description available in the introspection data.

pattern HAVE_GNUC_VISIBILITY :: Int32

Defined to 1 if gcc-style visibility handling is supported.

pattern HAVE_GNUC_VARARGS :: Int32

No description available in the introspection data.

pattern HAVE_GINT64 :: Int32

No description available in the introspection data.

pattern GUINTPTR_FORMAT :: Text

This is the platform dependent conversion specifier for scanning and printing values of type guintptr.

Since: 2.22

pattern GUINT64_FORMAT :: Text

This is the platform dependent conversion specifier for scanning and printing values of type guint64. See also GINT16_FORMAT.

Some platforms do not support scanning and printing 64-bit integers, even though the types are supported. On such platforms GUINT64_FORMAT is not defined. Note that scanf() may not support 64-bit integers, even if GINT64_FORMAT is defined. Due to its weak error handling, scanf() is not recommended for parsing anyway; consider using asciiStrtoull instead.

pattern GUINT32_FORMAT :: Text

This is the platform dependent conversion specifier for scanning and printing values of type guint32. See also GINT16_FORMAT.

pattern GUINT16_FORMAT :: Text

This is the platform dependent conversion specifier for scanning and printing values of type guint16. See also GINT16_FORMAT

pattern GSSIZE_MODIFIER :: Text

The platform dependent length modifier for conversion specifiers for scanning and printing values of type gssize. It is a string literal.

Since: 2.6

pattern GSSIZE_FORMAT :: Text

This is the platform dependent conversion specifier for scanning and printing values of type gssize. See also GINT16_FORMAT.

Since: 2.6

pattern GSIZE_MODIFIER :: Text

The platform dependent length modifier for conversion specifiers for scanning and printing values of type gsize. It is a string literal.

Since: 2.6

pattern GSIZE_FORMAT :: Text

This is the platform dependent conversion specifier for scanning and printing values of type gsize. See also GINT16_FORMAT.

Since: 2.6

pattern GNUC_PRETTY_FUNCTION :: Text

Deprecated: (Since version 2.16)Use G_STRFUNC() instead

Expands to "" on all modern compilers, and to PRETTY_FUNCTION on gcc version 2.x. Don't use it.

pattern GNUC_FUNCTION :: Text

Deprecated: (Since version 2.16)Use G_STRFUNC() instead

Expands to "" on all modern compilers, and to FUNCTION on gcc version 2.x. Don't use it.

pattern GINTPTR_MODIFIER :: Text

The platform dependent length modifier for conversion specifiers for scanning and printing values of type gintptr or guintptr. It is a string literal.

Since: 2.22

pattern GINTPTR_FORMAT :: Text

This is the platform dependent conversion specifier for scanning and printing values of type gintptr.

Since: 2.22

pattern GINT64_MODIFIER :: Text

The platform dependent length modifier for conversion specifiers for scanning and printing values of type gint64 or guint64. It is a string literal.

Some platforms do not support printing 64-bit integers, even though the types are supported. On such platforms GINT64_MODIFIER is not defined.

Since: 2.4

pattern GINT64_FORMAT :: Text

This is the platform dependent conversion specifier for scanning and printing values of type gint64. See also GINT16_FORMAT.

Some platforms do not support scanning and printing 64-bit integers, even though the types are supported. On such platforms GINT64_FORMAT is not defined. Note that scanf() may not support 64-bit integers, even if GINT64_FORMAT is defined. Due to its weak error handling, scanf() is not recommended for parsing anyway; consider using asciiStrtoull instead.

pattern GINT32_MODIFIER :: Text

The platform dependent length modifier for conversion specifiers for scanning and printing values of type gint32 or guint32. It is a string literal. See also GINT16_MODIFIER.

Since: 2.4

pattern GINT32_FORMAT :: Text

This is the platform dependent conversion specifier for scanning and printing values of type gint32. See also GINT16_FORMAT.

pattern GINT16_MODIFIER :: Text

The platform dependent length modifier for conversion specifiers for scanning and printing values of type gint16 or guint16. It is a string literal, but doesn't include the percent-sign, such that you can add precision and length modifiers between percent-sign and conversion specifier and append a conversion specifier.

The following example prints "0x7b";

C code

gint16 value = 123;
g_print ("%#" G_GINT16_MODIFIER "x", value);

Since: 2.4

pattern GINT16_FORMAT :: Text

This is the platform dependent conversion specifier for scanning and printing values of type gint16. It is a string literal, but doesn't include the percent-sign, such that you can add precision and length modifiers between percent-sign and conversion specifier.

C code

gint16 in;
gint32 out;
sscanf ("42", "%" G_GINT16_FORMAT, &in)
out = in * 1000;
g_print ("%" G_GINT32_FORMAT, out);

pattern E :: Double

The base of natural logarithms.

pattern DIR_SEPARATOR_S :: Text

The directory separator as a string. This is "/" on UNIX machines and "\" under Windows.

pattern DIR_SEPARATOR :: Int32

The directory separator character. This is '/' on UNIX machines and '\' under Windows.

pattern DATE_BAD_YEAR :: Int32

Represents an invalid year.

pattern DATE_BAD_JULIAN :: Int32

Represents an invalid Julian day number.

pattern DATE_BAD_DAY :: Int32

Represents an invalid GDateDay.

pattern DATALIST_FLAGS_MASK :: Int32

A bitmask that restricts the possible flags passed to datalistSetFlags. Passing a flags value where flags & ~G_DATALIST_FLAGS_MASK != 0 is an error.

pattern CSET_a_2_z :: Text

The set of lowercase ASCII alphabet characters. Used for specifying valid identifier characters in ScannerConfig.

pattern CSET_DIGITS :: Text

The set of ASCII digits. Used for specifying valid identifier characters in ScannerConfig.

pattern CSET_A_2_Z :: Text

The set of uppercase ASCII alphabet characters. Used for specifying valid identifier characters in ScannerConfig.

pattern BIG_ENDIAN :: Int32

Specifies one of the possible types of byte order. See G_BYTE_ORDER.

pattern ASCII_DTOSTR_BUF_SIZE :: Int32

A good size for a buffer to be passed into asciiDtostr. It is guaranteed to be enough for all output of that function on systems with 64bit IEEE-compatible doubles.

The typical usage would be something like:

C code

 char buf[G_ASCII_DTOSTR_BUF_SIZE];

 fprintf (out, "value=%s\n", g_ascii_dtostr (buf, sizeof (buf), value));

pattern ANALYZER_ANALYZING :: Int32

No description available in the introspection data.