Methods

Gets the modifier mask.

The modifier mask determines which modifiers are considered significant for keyboard accelerators. This includes all keyboard modifiers except for ModifierTypeLockMask.

Converts an accelerator keyval and modifier mask into a string which can be used to represent the accelerator to the user.

Converts an accelerator keyval and modifier mask into a string that can be displayed to the user.

The string may be translated.

This function is similar to acceleratorGetLabel, but handling keycodes. This is only useful for system-level components, applications should use acceleratorGetLabel instead.

Converts an accelerator keyval and modifier mask into a string parseable by acceleratorParse.

For example, if you pass in KEY_q and ModifierTypeControlMask, this function returns <Control>q.

If you need to display accelerators in the user interface, see acceleratorGetLabel.

Converts an accelerator keyval and modifier mask into a string parseable by acceleratorParseWithKeycode.

This is similar to acceleratorName but handling keycodes. This is only useful for system-level components, applications should use acceleratorName instead.

Parses a string representing an accelerator.

The format looks like “<Control>a” or “<Shift><Alt>F1”.

The parser is fairly liberal and allows lower or upper case, and also abbreviations such as “<Ctl>” and “<Ctrl>”.

Key names are parsed using keyvalFromName. For character keys the name is not the symbol, but the lowercase name, e.g. one would use “<Ctrl>minus” instead of “<Ctrl>-”.

Modifiers are enclosed in angular brackets <>, and match the [flagsgdk.ModifierType] mask:

• <Shift> for GDK_SHIFT_MASK
• <Ctrl> for GDK_CONTROL_MASK
• <Alt> for GDK_ALT_MASK
• <Meta> for GDK_META_MASK
• <Super> for GDK_SUPER_MASK
• <Hyper> for GDK_HYPER_MASK

If the parse operation fails, acceleratorKey and acceleratorMods will be set to 0 (zero).

Parses a string representing an accelerator.

This is similar to acceleratorParse but handles keycodes as well. This is only useful for system-level components, applications should use acceleratorParse instead.

If acceleratorCodes is given and the result stored in it is non-Nothing, the result must be freed with free.

If a keycode is present in the accelerator and no acceleratorCodes is given, the parse will fail.

If the parse fails, acceleratorKey, acceleratorMods and acceleratorCodes will be set to 0 (zero).

Determines whether a given keyval and modifier mask constitute a valid keyboard accelerator.

For example, the KEY_a keyval plus ModifierTypeControlMask mark is valid, and matches the “Ctrl+a” accelerator. But, you can't, for instance, use the KEY_Control_L keyval as an accelerator.

Checks that the GTK library in use is compatible with the given version.

Generally you would pass in the constants MAJOR_VERSION, MINOR_VERSION, MICRO_VERSION as the three arguments to this function; that produces a check that the library in use is compatible with the version of GTK the application or module was compiled against.

Compatibility is defined by two things: first the version of the running library is newer than the version requiredMajor.required_minor.requiredMicro. Second the running library must be binary compatible with the version requiredMajor.required_minor.requiredMicro (same major version.)

This function is primarily for GTK modules; the module can call this function to check that it wasn’t loaded into an incompatible version of GTK. However, such a check isn’t completely reliable, since the module may be linked against an old version of GTK and calling the old version of checkVersion, but still get loaded into an application using a newer version of GTK.

No description available in the introspection data.

No description available in the introspection data.

Prevents init and initCheck from automatically calling setlocale (LC_ALL, "").

You would want to use this function if you wanted to set the locale for your program to something other than the user’s locale, or if you wanted to set different values for different locale categories.

Most programs should not need to call this function.

Distributes extraSpace to child sizes by bringing smaller children up to natural size first.

The remaining space will be added to the minimumSize member of the GtkRequestedSize struct. If all sizes reach their natural size then the remaining space is returned.

Calls a function for all GtkPrinters.

If func returns True, the enumeration is stopped.

Returns the binary age as passed to libtool.

If libtool means nothing to you, don't worry about it.

Returns the GTK debug flags that are currently active.

This function is intended for GTK modules that want to adjust their debug output based on GTK debug flags.

Returns the PangoLanguage for the default language currently in effect.

Note that this can change over the life of an application.

The default language is derived from the current locale. It determines, for example, whether GTK uses the right-to-left or left-to-right text direction.

This function is equivalent to [funcpango.Language.get_default]. See that function for details.

Returns the interface age as passed to libtool.

If libtool means nothing to you, don't worry about it.

Get the direction of the current locale. This is the expected reading direction for text and UI.

This function depends on the current locale being set with setlocale() and will default to setting the TextDirectionLtr direction otherwise. TextDirectionNone will never be returned.

GTK sets the default text direction according to the locale during init, and you should normally use widgetGetDirection or widgetGetDefaultDirection to obtain the current direction.

This function is only needed rare cases when the locale is changed after GTK has already been initialized. In this case, you can use it to update the default text direction as follows:

C code

#include <locale.h>

static void
update_locale (const char *new_locale)
{
  setlocale (LC_ALL, new_locale);
  GtkTextDirection direction = gtk_get_locale_direction ();
  gtk_widget_set_default_direction (direction);
}

Returns the major version number of the GTK library.

For example, in GTK version 3.1.5 this is 3.

This function is in the library, so it represents the GTK library your code is running against. Contrast with the MAJOR_VERSION macro, which represents the major version of the GTK headers you have included when compiling your code.

Returns the micro version number of the GTK library.

For example, in GTK version 3.1.5 this is 5.

This function is in the library, so it represents the GTK library your code is are running against. Contrast with the MICRO_VERSION macro, which represents the micro version of the GTK headers you have included when compiling your code.

Returns the minor version number of the GTK library.

For example, in GTK version 3.1.5 this is 1.

This function is in the library, so it represents the GTK library your code is are running against. Contrast with the MINOR_VERSION macro, which represents the minor version of the GTK headers you have included when compiling your code.

Converts a color from HSV space to RGB.

Input values must be in the [0.0, 1.0] range; output values will be in the same range.

Call this function before using any other GTK functions in your GUI applications. It will initialize everything needed to operate the toolkit.

If you are using GtkApplication, you don't have to call init or initCheck; the GApplication::startup handler does it for you.

This function will terminate your program if it was unable to initialize the windowing system for some reason. If you want your program to fall back to a textual interface you want to call initCheck instead.

GTK calls signal (SIGPIPE, SIG_IGN) during initialization, to ignore SIGPIPE signals, since these are almost never wanted in graphical applications. If you do need to handle SIGPIPE for some reason, reset the handler after init, but notice that other libraries (e.g. libdbus or gvfs) might do similar things.

This function does the same work as init with only a single change: It does not terminate the program if the windowing system can’t be initialized. Instead it returns False on failure.

This way the application can fall back to some other means of communication with the user - for example a curses or command line interface.

Use this function to check if GTK has been initialized with init or initCheck.

Creates a new GParamSpec instance for a property holding a GtkExpression.

See g_param_spec_internal() for details on the property strings.

Runs a page setup dialog, letting the user modify the values from pageSetup. If the user cancels the dialog, the returned GtkPageSetup is identical to the passed in pageSetup, otherwise it contains the modifications done in the dialog.

Note that this function may use a recursive mainloop to show the page setup dialog. See printRunPageSetupDialogAsync if this is a problem.

Runs a page setup dialog, letting the user modify the values from pageSetup.

In contrast to printRunPageSetupDialog, this function returns after showing the page setup dialog on platforms that support this, and calls doneCb from a signal handler for the response signal of the dialog.

Renders an activity indicator (such as in GtkSpinner). The state StateFlagsChecked determines whether there is activity going on.

Renders an arrow pointing to angle.

Typical arrow rendering at 0, 1⁄2 π;, π; and 3⁄2 π:

Renders the background of an element.

Typical background rendering, showing the effect of background-image, border-width and border-radius:

Renders a checkmark (as in a GtkCheckButton).

The StateFlagsChecked state determines whether the check is on or off, and StateFlagsInconsistent determines whether it should be marked as undefined.

Typical checkmark rendering:

Renders an expander (as used in GtkTreeView and GtkExpander) in the area defined by x, y, width, height. The state StateFlagsChecked determines whether the expander is collapsed or expanded.

Typical expander rendering:

Renders a focus indicator on the rectangle determined by x, y, width, height.

Typical focus rendering:

Renders a frame around the rectangle defined by x, y, width, height.

Examples of frame rendering, showing the effect of border-image, border-color, border-width, border-radius and junctions:

Renders a handle (as in GtkPaned and GtkWindow’s resize grip), in the rectangle determined by x, y, width, height.

Handles rendered for the paned and grip classes:

Renders the icon in texture at the specified x and y coordinates.

This function will render the icon in texture at exactly its size, regardless of scaling factors, which may not be appropriate when drawing on displays with high pixel densities.

Renders layout on the coordinates x, y

Renders a line from (x0, y0) to (x1, y1).

Renders an option mark (as in a radio button), the StateFlagsChecked state will determine whether the option is on or off, and StateFlagsInconsistent whether it should be marked as undefined.

Typical option mark rendering:

Converts a color from RGB space to HSV.

Input values must be in the [0.0, 1.0] range; output values will be in the same range.

Sets the GTK debug flags.

This function launches the default application for showing a given uri, or shows an error dialog if that fails.

This function launches the default application for showing a given uri.

The callback will be called when the launch is completed. It should call showUriFullFinish to obtain the result.

This is the recommended call to be used as it passes information necessary for sandbox helpers to parent their dialogs properly.

Finishes the showUri call and returns the result of the operation.

No description available in the introspection data.

Checks whether the GtkAccessible has property set.

Checks whether the GtkAccessible has relation set.

Checks whether the GtkAccessible:accessible-role of the accessible is role.

Checks whether the GtkAccessible has state set.

Return the type ids that have been registered after calling testRegisterAllTypes.

Force registration of all core GTK object types.

This allows to refer to any of those object types via typeFromName after calling this function.

Enters the main loop and waits for widget to be “drawn”.

In this context that means it waits for the frame clock of widget to have run a full styling, layout and drawing cycle.

This function is intended to be used for syncing with actions that depend on widget relayouting or on interaction with the display server.

Creates a content provider for dragging path from treeModel.

Obtains a treeModel and path from value of target type GTK_TYPE_TREE_ROW_DATA.

The returned path must be freed with treePathFree.

Retrieves the GtkExpression stored inside the given value, and acquires a reference to it.

Retrieves the GtkExpression stored inside the given value.

Stores the given GtkExpression inside value.

The GValue will acquire a reference to the expression.

Stores the given GtkExpression inside value.

This function transfers the ownership of the expression to the GValue.