class: GtkApi

[225:14] static extends: object

Generated low-level function wrappers for namespace Gtk.

Members

• lib

Methods

• getLib ()

• accelerator_get_accessible_label (int accelerator_key, string accelerator_mods)

  Generates an accessible description of an accelerator. This function is similar to [func@Gtk.accelerator_get_label] but it is meant for accessibility layers labels rather than user-facing labels. The output of this function is fit for [enum@Gtk.AccessibleProperty.KEY_SHORTCUTS]. For more information, see the WAI-ARIA reference.

  • @p accelerator_key is accelerator keyval.
  • @p accelerator_mods is accelerator modifier mask.

• accelerator_get_default_mod_mask ()

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

• accelerator_get_label (int accelerator_key, string accelerator_mods)

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

  • @p accelerator_key is accelerator keyval.
  • @p accelerator_mods is accelerator modifier mask.

• accelerator_get_label_with_keycode (object display, int accelerator_key, int keycode, string accelerator_mods)

  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 [func@Gtk.accelerator_get_label], but handling keycodes. This is only useful for system-level components, applications should use [func@Gtk.accelerator_get_label] instead.

  • @p display is a GdkDisplay.
  • @p accelerator_key is accelerator keyval.
  • @p keycode is accelerator keycode.
  • @p accelerator_mods is accelerator modifier mask.

• accelerator_name (int accelerator_key, string accelerator_mods)

  Converts an accelerator keyval and modifier mask into a string that can be parsed by [func@Gtk.accelerator_parse]. For example, if you pass in GDK_KEY_q and GDK_CONTROL_MASK, this function returns <Control>q. If you need to display accelerators in the user interface, see [func@Gtk.accelerator_get_label].

  • @p accelerator_key is accelerator keyval.
  • @p accelerator_mods is accelerator modifier mask.

• accelerator_name_with_keycode (object display, int accelerator_key, int keycode, string accelerator_mods)

  Converts an accelerator keyval and modifier mask into a string that can be parsed by [func@Gtk.accelerator_parse_with_keycode]. This is similar to [func@Gtk.accelerator_name] but handling keycodes. This is only useful for system-level components, applications should use [func@Gtk.accelerator_name] instead.

  • @p display is a GdkDisplay.
  • @p accelerator_key is accelerator keyval.
  • @p keycode is accelerator keycode.
  • @p accelerator_mods is accelerator modifier mask.

• accelerator_valid (int keyval, string modifiers)

  Determines whether a given keyval and modifier mask constitute a valid keyboard accelerator. For example, the GDK_KEY_a keyval plus GDK_CONTROL_MASK mask is valid, and matches the “Ctrl+a” accelerator. But, you can't, for instance, use the GDK_KEY_Control_L keyval as an accelerator.

  • @p keyval is a GDK keyval.
  • @p modifiers is modifier mask.

• accessible_property_init_value (string property, object value)

  Initializes @value with the appropriate type for the @property. This function is mostly meant for language bindings, in conjunction with gtk_accessible_update_property_value().

  • @p property is a GtkAccessibleProperty.
  • @p value is an uninitialized GValue.
  • @r None.

• accessible_relation_init_value (string relation, object value)

  Initializes @value with the appropriate type for the @relation. This function is mostly meant for language bindings, in conjunction with gtk_accessible_update_relation_value().

  • @p relation is a GtkAccessibleRelation.
  • @p value is an uninitialized GValue.
  • @r None.

• accessible_state_init_value (string state, object value)

  Initializes @value with the appropriate type for the @state. This function is mostly meant for language bindings, in conjunction with gtk_accessible_update_relation_state().

  • @p state is a GtkAccessibleState.
  • @p value is an uninitialized GValue.
  • @r None.

• check_version (int required_major, int required_minor, int required_micro)

  Checks that the GTK library in use is compatible with the given version. Generally you would pass in the constants %GTK_MAJOR_VERSION, %GTK_MINOR_VERSION, %GTK_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

  • @required_major.required_minor.@required_micro. Second the running library must be binary compatible with the version
  • @required_major.required_minor.@required_micro (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 gtk_check_version(), but still get loaded into an application using a newer version of GTK.
  • @p required_major is the required major version.
  • @p required_minor is the required minor version.
  • @p required_micro is the required micro version.

• disable_portal_interfaces (list portal_interfaces)

  Prevents GTK from using the specified portals. This should only be used in portal implementations, apps must not call it.

  • @p portal_interfaces is a %NULL-terminated array of portal interface names to disable.
  • @r None.

• disable_portals ()

  Prevents GTK from using portals. This is equivalent to setting GDK_DEBUG=no-portals in the environment. This should only be used in portal implementations, apps must not call it.

  • @r None.

• disable_setlocale ()

  Prevents [func@Gtk.init] and [func@Gtk.init_check] from calling setlocale(). 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.

  • @r None.

• editable_delegate_get_property (object object, int prop_id, object value, object pspec)

  Gets a property of the GtkEditable delegate for @object. This is helper function that should be called in the get_property function of your GtkEditable implementation, before handling your own properties.

  • @p object is a GObject.
  • @p prop_id is a property ID.
  • @p value is value to set.
  • @p pspec is the GParamSpec for the property.

• editable_delegate_set_property (object object, int prop_id, object value, object pspec)

  Sets a property on the GtkEditable delegate for @object. This is a helper function that should be called in the set_property function of your GtkEditable implementation, before handling your own properties.

  • @p object is a GObject.
  • @p prop_id is a property ID.
  • @p value is value to set.
  • @p pspec is the GParamSpec for the property.

• editable_install_properties (object object_class, int first_prop)

  Overrides the GtkEditable properties for @class. This is a helper function that should be called in class_init, after installing your own properties. Note that your class must have "text", "cursor-position", "selection-bound", "editable", "width-chars", "max-width-chars", "xalign" and "enable-undo" properties for this function to work. To handle the properties in your set_property and get_property functions, you can either use [func@Gtk.Editable.delegate_set_property] and [func@Gtk.Editable.delegate_get_property] (if you are using a delegate), or remember the @first_prop offset and add it to the values in the [enum@Gtk.EditableProperties] enumeration to get the property IDs for these properties.

  • @p object_class is a GObjectClass.
  • @p first_prop is property ID to use for the first property.

• get_binary_age ()

  Returns the binary age as passed to libtool. If libtool means nothing to you, don't worry about it.

• get_debug_flags ()

  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.

• get_default_language ()

  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 [func@Pango.Language.get_default]. See that function for details.

• get_interface_age ()

  Returns the interface age as passed to libtool. If libtool means nothing to you, don't worry about it.

• get_locale_direction ()

  Gets 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 GTK_TEXT_DIR_LTR direction otherwise. GTK_TEXT_DIR_NONE will never be returned. GTK sets the default text direction according to the locale during [func@Gtk.init], and you should normally use [method@Gtk.Widget.get_direction] or [func@Gtk.Widget.get_default_direction] 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 #include <locale.h> static void update_locale (const char *new_locale) { setlocale (LC_ALL, new_locale); gtk_widget_set_default_direction (gtk_get_locale_direction ()); }

• get_major_version ()

  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 %GTK_MAJOR_VERSION macro, which represents the major version of the GTK headers you have included when compiling your code.

• get_micro_version ()

  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 %GTK_MICRO_VERSION macro, which represents the micro version of the GTK headers you have included when compiling your code.

• get_minor_version ()

  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 %GTK_MINOR_VERSION macro, which represents the minor version of the GTK headers you have included when compiling your code.

• init ()

  Initializes GTK. This function must be called before using any other GTK functions in your GUI applications. It will initialize everything needed to operate the toolkit. In particular, it will open the default display (see [func@Gdk.Display.get_default]). If you are using [class@Gtk.Application], you usually don't have to call this function; the [vfunc@Gio.Application.startup] handler does it for you. Though, if you are using GApplication methods that will be invoked before startup, such as local_command_line, you may need to initialize GTK explicitly. 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, call [func@Gtk.init_check] 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 gtk_init(), but notice that other libraries (e.g. libdbus or gvfs) might do similar things.

  • @r None.

• init_check ()

  Initializes GTK. This function does the same work as [func@Gtk.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.

• is_initialized ()

  Returns whether GTK has been initialized. See [func@Gtk.init].

• native_get_for_surface (object surface)

  Finds the GtkNative associated with the surface.

  • @p surface is a GdkSurface.

• ordering_from_cmpfunc (int cmpfunc_result)

  Converts the result of a GCompareFunc like strcmp() to a GtkOrdering value.

  • @p cmpfunc_result is Result of a comparison function.

• paper_size_get_default ()

  Returns the name of the default paper size, which depends on the current locale.

• paper_size_get_paper_sizes (bool include_custom)

  Creates a list of known paper sizes.

  • @p include_custom is whether to include custom paper sizes as defined in the page setup dialog.

• param_spec_expression (string name, string nick, string blurb, string flags)

  Creates a new GParamSpec instance for a property holding a GtkExpression. See g_param_spec_internal() for details on the property strings.

  • @p name is canonical name of the property.
  • @p nick is a user-readable name for the property.
  • @p blurb is a user-readable description of the property.
  • @p flags is flags for the property.

• print_run_page_setup_dialog (object parent, object page_setup, object settings)

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

  • @page_setup. If the user cancels the dialog, the returned GtkPageSetup is identical to the passed in @page_setup, 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 [func@Gtk.print_run_page_setup_dialog_async] if this is a problem.
  • @p parent is transient parent.
  • @p page_setup is an existing GtkPageSetup.
  • @p settings is a GtkPrintSettings.

• render_activity (object context, object cr, double x, double y, double width, double height)

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

  • @p context is a GtkStyleContext.
  • @p cr is a cairo_t.
  • @p x is X origin of the rectangle.
  • @p y is Y origin of the rectangle.
  • @p width is rectangle width.
  • @p height is rectangle height.
  • @r None.

• render_arrow (object context, object cr, double angle, double x, double y, double size)

  Renders an arrow pointing to @angle. Typical arrow rendering at 0, 1⁄2 π;, π; and 3⁄2 π:

  • @p context is a GtkStyleContext.
  • @p cr is a cairo_t.
  • @p angle is arrow angle from 0 to 2 * %G_PI, being 0 the arrow pointing to the north.
  • @p x is X origin of the render area.
  • @p y is Y origin of the render area.
  • @p size is square side for render area.
  • @r None.

• render_background (object context, object cr, double x, double y, double width, double height)

  Renders the background of an element. Typical background rendering, showing the effect of background-image, border-width and border-radius:

  • @p context is a GtkStyleContext.
  • @p cr is a cairo_t.
  • @p x is X origin of the rectangle.
  • @p y is Y origin of the rectangle.
  • @p width is rectangle width.
  • @p height is rectangle height.
  • @r None.

• render_check (object context, object cr, double x, double y, double width, double height)

  Renders a checkmark (as in a GtkCheckButton). The %GTK_STATE_FLAG_CHECKED state determines whether the check is on or off, and %GTK_STATE_FLAG_INCONSISTENT determines whether it should be marked as undefined. Typical checkmark rendering:

  • @p context is a GtkStyleContext.
  • @p cr is a cairo_t.
  • @p x is X origin of the rectangle.
  • @p y is Y origin of the rectangle.
  • @p width is rectangle width.
  • @p height is rectangle height.
  • @r None.

• render_expander (object context, object cr, double x, double y, double width, double height)

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

  • @p context is a GtkStyleContext.
  • @p cr is a cairo_t.
  • @p x is X origin of the rectangle.
  • @p y is Y origin of the rectangle.
  • @p width is rectangle width.
  • @p height is rectangle height.
  • @r None.

• render_focus (object context, object cr, double x, double y, double width, double height)

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

  • @height. Typical focus rendering:
  • @p context is a GtkStyleContext.
  • @p cr is a cairo_t.
  • @p x is X origin of the rectangle.
  • @p y is Y origin of the rectangle.
  • @p width is rectangle width.
  • @p height is rectangle height.
  • @r None.

• render_frame (object context, object cr, double x, double y, double width, double height)

  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:

  • @p context is a GtkStyleContext.
  • @p cr is a cairo_t.
  • @p x is X origin of the rectangle.
  • @p y is Y origin of the rectangle.
  • @p width is rectangle width.
  • @p height is rectangle height.
  • @r None.

• render_handle (object context, object cr, double x, double y, double width, double height)

  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:

  • @p context is a GtkStyleContext.
  • @p cr is a cairo_t.
  • @p x is X origin of the rectangle.
  • @p y is Y origin of the rectangle.
  • @p width is rectangle width.
  • @p height is rectangle height.
  • @r None.

• render_icon (object context, object cr, object texture, double x, double y)

  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.

  • @p context is a GtkStyleContext.
  • @p cr is a cairo_t.
  • @p texture is a GdkTexture containing the icon to draw.
  • @p x is X position for the @texture.
  • @p y is Y position for the @texture.
  • @r None.

• render_layout (object context, object cr, double x, double y, object layout)

  Renders @layout on the coordinates @x, @y

  • @p context is a GtkStyleContext.
  • @p cr is a cairo_t.
  • @p x is X origin.
  • @p y is Y origin.
  • @p layout is the PangoLayout to render.
  • @r None.

• render_line (object context, object cr, double x0, double y0, double x1, double y1)

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

  • @p context is a GtkStyleContext.
  • @p cr is a cairo_t.
  • @p x0 is X coordinate for the origin of the line.
  • @p y0 is Y coordinate for the origin of the line.
  • @p x1 is X coordinate for the end of the line.
  • @p y1 is Y coordinate for the end of the line.
  • @r None.

• render_option (object context, object cr, double x, double y, double width, double height)

  Renders an option mark (as in a radio button), the %GTK_STATE_FLAG_CHECKED state will determine whether the option is on or off, and %GTK_STATE_FLAG_INCONSISTENT whether it should be marked as undefined. Typical option mark rendering:

  • @p context is a GtkStyleContext.
  • @p cr is a cairo_t.
  • @p x is X origin of the rectangle.
  • @p y is Y origin of the rectangle.
  • @p width is rectangle width.
  • @p height is rectangle height.
  • @r None.

• set_debug_flags (string flags)

  Sets the GTK debug flags.

  • @p flags is the debug flags to set.
  • @r None.

• show_uri_full_finish (object parent, object result)

  Finishes the gtk_show_uri() call and returns the result of the operation.

  • @p parent is the GtkWindow passed to gtk_show_uri().
  • @p result is GAsyncResult that was passed to @callback.

• svg_error_get_attribute (object error)

  Returns context information about what XML attribute the parsing error occurred in.

  • @p error is an error in the [error@Gtk.SvgError] domain.

• svg_error_get_element (object error)

  Returns context information about what XML element the parsing error occurred in.

  • @p error is an error in the [error@Gtk.SvgError] domain.

• svg_error_get_end (object error)

  Returns context information about the end position in the document where the parsing error occurred.

  • @p error is an error in the [error@Gtk.SvgError] domain.

• svg_error_get_input (object error)

  Returns a string describing the input source that the parsing error occurred in.

  • @p error is an error in the [error@Gtk.SvgError] domain.

• svg_error_get_start (object error)

  Returns context information about the start position in the document where the parsing error occurred.

  • @p error is an error in the [error@Gtk.SvgError] domain.

• test_accessible_assertion_message_role (string domain, string file, int line, string func, string expr, object accessible, string expected_role, string actual_role)

  Prints an assertion message for gtk_test_accessible_assert_role().

  • @p domain is a domain.
  • @p file is a file name.
  • @p line is the line in @file.
  • @p func is a function name in @file.
  • @p expr is the expression being tested.
  • @p accessible is a GtkAccessible.
  • @p expected_role is the expected GtkAccessibleRole.
  • @p actual_role is the actual GtkAccessibleRole.
  • @r None.

• test_accessible_has_property (object accessible, string property)

  Checks whether the GtkAccessible has @property set.

  • @p accessible is a GtkAccessible.
  • @p property is a GtkAccessibleProperty.

• test_accessible_has_relation (object accessible, string relation)

  Checks whether the GtkAccessible has @relation set.

  • @p accessible is a GtkAccessible.
  • @p relation is a GtkAccessibleRelation.

• test_accessible_has_role (object accessible, string role)

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

  • @role. ``
  • @p accessible is a GtkAccessible.
  • @p role is a GtkAccessibleRole.

• test_accessible_has_state (object accessible, string state)

  Checks whether the GtkAccessible has @state set.

  • @p accessible is a GtkAccessible.
  • @p state is a GtkAccessibleState.

• test_register_all_types ()

  Force registration of all core GTK object types. This allows to refer to any of those object types via g_type_from_name() after calling this function.

  • @r None.

• test_widget_wait_for_draw (object widget)

  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.

  • @p widget is the widget to wait for.
  • @r None.

• tree_create_row_drag_content (object tree_model, object path)

  Creates a content provider for dragging @path from @tree_model.

  • @p tree_model is a GtkTreeModel.
  • @p path is a row in @tree_model.

• tree_row_reference_deleted (object proxy, object path)

  Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the ::row-deleted signal.

  • @p proxy is a GObject.
  • @p path is the path position that was deleted.
  • @r None.

• tree_row_reference_inserted (object proxy, object path)

  Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the ::row-inserted signal.

  • @p proxy is a GObject.
  • @p path is the row position that was inserted.
  • @r None.

• tree_row_reference_reordered (object proxy, object path, iter, list new_order)

  Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the ::rows-reordered signal.

  • @p proxy is a GObject.
  • @p path is the parent path of the reordered signal.
  • @p iter is the iter pointing to the parent of the reordered.
  • @p new_order is the new order of rows.
  • @r None.

• value_dup_expression (object value)

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

  • @p value is a GValue initialized with type GTK_TYPE_EXPRESSION.

• value_get_expression (object value)

  Retrieves the GtkExpression stored inside the given value.

  • @p value is a GValue initialized with type GTK_TYPE_EXPRESSION.

• value_set_expression (object value, object expression)

  Stores the given GtkExpression inside value. The GValue will acquire a reference to the expression.

  • @p value is a GValue initialized with type GTK_TYPE_EXPRESSION.
  • @p expression is a GtkExpression.
  • @r None.

• value_take_expression (object value, object expression)

  Stores the given GtkExpression inside value. This function transfers the ownership of the expression to the GValue.

  • @p value is a GValue initialized with type GTK_TYPE_EXPRESSION.
  • @p expression is a GtkExpression.
  • @r None.