gobject Constants

gobject Constants — the built-in constants of the gobject module

Synopsis

GObject IO Condition Constants
GObject Param Flag Constants
GObject Priority Constants
GObject Signal Flag Constants
GObject Spawn Flag Constants
GObject Built-in Type Constants
GObject Version Constants

Description

GObject IO Condition Constants

The IO Condition constants are a set of bit-flags that specify a condition to watch for on an event source.

gobject.IO_INThere is data to read
gobject.IO_OUTData can be written (without blocking).
gobject.IO_PRIThere is urgent data to read.
gobject.IO_ERRError condition.
gobject.IO_HUPHung up (the connection has been broken, usually for pipes and sockets).
gobject.IO_NVALInvalid request. The file descriptor is not open.

GObject Param Flag Constants

The Param Flag constants are a set of bit-flags that specify certain aspects of parameters that can be configured.

gobject.PARAM_READABLEThe parameter is readable
gobject.PARAM_WRITABLEThe parameter is writable
gobject.PARAM_CONSTRUCTThe parameter will be set upon object construction
gobject.PARAM_CONSTRUCT_ONLYThe parameter will only be set upon object construction
gobject.PARAM_LAX_VALIDATIONUpon parameter conversion strict validation is not required

GObject Priority Constants

The Priority constants specify

gobject.PRIORITY_HIGHUse this for high priority event sources.
gobject.PRIORITY_DEFAULTUse this for default priority event sources. This priority is used when adding timeout functions with the gobject.timeout_add() function. This priority is also used for events from the X server.
gobject.PRIORITY_HIGH_IDLEUse this for high priority idle functions. For example, gobject.PRIORITY_HIGH_IDLE + 10 is used for resizing operations; and, gobject.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.)
gobject.PRIORITY_DEFAULT_IDLEUse this for default priority idle functions. This priority is used when adding idle functions with the gobject.idle_add() function.
gobject.PRIORITY_LOWUse this for very low priority background tasks.

GObject Signal Flag Constants

The Signal Flag constants are a set of bit-flags that specify a signal's behavior. The overall signal description outlines how especially the RUN flags control the stages of a signal emission.

gobject.SIGNAL_RUN_FIRSTInvoke the object method handler in the first emission stage.
gobject.SIGNAL_RUN_LASTInvoke the object method handler in the third emission stage.
gobject.SIGNAL_RUN_CLEANUPInvoke the object method handler in the last emission stage.
gobject.SIGNAL_NO_RECURSESignals being emitted for an object while currently being in emission for this very object will not be emitted recursively, but instead cause the first emission to be restarted.
gobject.SIGNAL_DETAILEDThis signal supports "::detail" appendices to the signal name upon handler connections and emissions.
gobject.SIGNAL_ACTIONAction signals are signals that may freely be emitted on alive objects from user code via the gobject.emit() method and friends, without the need of being embedded into extra code that performs pre or post emission adjustments on the object. They can also be thought of as object methods which can be called generically by third-party code.
gobject.SIGNAL_NO_HOOKSNo emissions hooks are supported for this signal.

GObject Spawn Flag Constants

The Spawn Flag constants are a set of bit-flags that can be passed to the gobject.spawn_async() function.

gobject.SPAWN_LEAVE_DESCRIPTORS_OPENthe parent's open file descriptors will be inherited by the child; otherwise all descriptors except stdin/stdout/stderr will be closed before calling exec() in the child.
gobject.SPAWN_DO_NOT_REAP_CHILDthe child will not be automatically reaped; you must call waitpid() or handle SIGCHLD yourself, or the child will become a zombie.
gobject.SPAWN_SEARCH_PATHargv[0] need not be an absolute path, it will be looked for in the user's PATH.
gobject.SPAWN_STDOUT_TO_DEV_NULLthe child's standard output will be discarded, instead of going to the same location as the parent's standard output.
gobject.SPAWN_STDERR_TO_DEV_NULLthe child's standard error will be discarded.
gobject.SPAWN_CHILD_INHERITS_STDINthe child will inherit the parent's standard input (by default, the child's standard input is attached to /dev/null).
gobject.SPAWN_FILE_AND_ARGV_ZEROthe first element of argv is the file to execute, while the remaining elements are the actual argument vector to pass to the file. Normally gobject.spawn_async() uses argv[0] as the file to execute, and passes all of argv to the child.

GObject Built-in Type Constants

The Built-in Type constants specify the pre-defined types used by gobject.

gobject.TYPE_INVALIDAn invalid type, used as error return value in some functions.
gobject.TYPE_NONEA fundamental type indicating no type.
gobject.TYPE_INTERFACEThe fundamental type from which all interfaces are derived.
gobject.TYPE_CHARThe fundamental type corresponding to a character. This maps to a string in Python.
gobject.TYPE_UCHARThe fundamental type corresponding to an unsigned character. This maps to a string in Python.
gobject.TYPE_BOOLEANThe fundamental type corresponding to a True or False value. This maps to an integer in Python.
gobject.TYPE_INTThe fundamental type corresponding to an integer. This maps to an integer in Python.
gobject.TYPE_UINThe fundamental type corresponding to an unsigned integer. This maps to an integer in Python.
gobject.TYPE_LONGThe fundamental type corresponding to a long integer. This maps to an integer in Python.
gobject.TYPE_ULONGThe fundamental type corresponding to an unsigned integer. This maps to an integer in Python.
gobject.TYPE_INT64The fundamental type corresponding to an long long integer. This maps to a long integer in Python.
gobject.TYPE_UINT64The fundamental type corresponding to an unsigned long long integer. This maps to a long integer in Python.
gobject.TYPE_ENUMThe fundamental type corresponding to an enumeration type. This maps to an integer in Python.
gobject.TYPE_FLAGSThe fundamental type corresponding to a flag type. This maps to an integer in Python.
gobject.TYPE_FLOATThe fundamental type corresponding to a floating point number. This maps to a float in Python.
gobject.TYPE_DOUBLEThe fundamental type corresponding to a double floating point number. This maps to a float in Python.
gobject.TYPE_STRINGThe fundamental type corresponding to a string.
gobject.TYPE_POINTERThe fundamental type corresponding to a pointer to an anonymous type. This has no corresponding Python type.
gobject.TYPE_BOXEDThe fundamental type corresponding to a boxed object type.
gobject.TYPE_PARAMThe fundamental type corresponding to a GParamSpec type.
gobject.TYPE_OBJECTThe fundamental type corresponding to a GObject type.
gobject.TYPE_PYOBJECTThe fundamental type corresponding to a Python Object type.

GObject Version Constants

The Version constants specify the version of GLIB used by PyGTK as a 3-tuple containing the major, minor and patch release numbers.

gobject.glib_versionA 3-tuple containing (major, minor, patch) release numbers.