Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: GtkApi

[3493: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.
    • @r a newly-allocated string representing the accelerator.

  • 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.

    • @r the modifier mask for accelerators.

  • 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.
    • @r a newly-allocated string representing the accelerator.

  • 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.
    • @r a newly-allocated string representing the accelerator.

  • 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.
    • @r a newly-allocated accelerator name.

  • 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.
    • @r a newly allocated accelerator name..

  • accelerator_parse (string accelerator)

    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 [func@Gdk.keyval_from_name]. 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 [flags@Gdk.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, @accelerator_key and @accelerator_mods will be set to 0 (zero).

    • @p accelerator is string representing an accelerator.
    • @p accelerator_key is return location for accelerator keyval.
    • @p accelerator_mods is return location for accelerator modifier mask.
    • @r whether parsing succeeded.

  • 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.
    • @r true if the accelerator is valid.

  • 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.

  • bitset_iter_init_at (object set, int target)

    Initializes @iter to point to @target. If @target is not found, finds the next value after it. If no value >= @target exists in @set, this function returns %FALSE.

    • @p iter is a pointer to an uninitialized GtkBitsetIter.
    • @p set is a GtkBitset.
    • @p target is target value to start iterating at.
    • @p value is Set to the found value in @set.
    • @r %TRUE if a value was found..

  • bitset_iter_init_first (object set)

    Initializes an iterator for @set and points it to the first value in

    • @set. If @set is empty, %FALSE is returned and @value is set to %G_MAXUINT.
    • @p iter is a pointer to an uninitialized GtkBitsetIter.
    • @p set is a GtkBitset.
    • @p value is Set to the first value in @set.
    • @r %TRUE if @set isn't empty..

  • bitset_iter_init_last (object set)

    Initializes an iterator for @set and points it to the last value in @set. If @set is empty, %FALSE is returned.

    • @p iter is a pointer to an uninitialized GtkBitsetIter.
    • @p set is a GtkBitset.
    • @p value is Set to the last value in @set.
    • @r %TRUE if @set isn't empty..

  • 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.
    • @r %NULL if the GTK library is compatible with the given version, or a string describing the version mismatch. The returned string is owned by GTK and should not be modified or freed..

  • 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.

  • distribute_natural_allocation (int extra_space, list sizes)

    Distributes @extra_space to child @sizes by bringing smaller children up to natural size first. The remaining space will be added to the

    • @minimum_size member of the GtkRequestedSize struct. If all sizes reach their natural size then the remaining space is returned.
    • @p extra_space is Extra space to redistribute among children after subtracting minimum sizes and any child padding from the overall allocation.
    • @p n_requested_sizes is Number of requests to fit into the allocation.
    • @p sizes is An array of structs with a client pointer and a minimum/natural size in the orientation of the allocation..
    • @r The remainder of @extra_space after redistributing space to @sizes..

  • 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.
    • @r %TRUE if the property was found.

  • 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.
    • @r %TRUE if the property was found.

  • 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.
    • @r the number of properties that were installed.

  • enumerate_printers (object func, bool wait)

    Calls a function for all printers that are known to GTK. If @func returns true, the enumeration is stopped.

    • @p func is a function to call for each printer.
    • @p data is user data to pass to @func.
    • @p destroy is function to call if @data is no longer needed.
    • @p wait is if true, wait in a recursive mainloop until all printers are enumerated; otherwise return early.
    • @r None.

  • get_binary_age ()

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

    • @r the binary age of the GTK library.

  • 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.

    • @r the 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.

    • @r the default language.

  • get_interface_age ()

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

    • @r the interface age of the GTK library.

  • 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 ()); }

    • @r the direction of the current locale.

  • 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.

    • @r the major version number of the GTK library.

  • 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.

    • @r the micro version number of the GTK library.

  • 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.

    • @r the minor version number of the GTK library.

  • hsv_to_rgb (double h, double s, double v)

    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.

    • @p h is Hue.
    • @p s is Saturation.
    • @p v is Value.
    • @p r is Return value for the red component.
    • @p g is Return value for the green component.
    • @p b is Return value for the blue component.
    • @r None.

  • 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.

    • @r true if the windowing system has been successfully initialized, false otherwise.

  • is_initialized ()

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

    • @r the initialization status.

  • native_get_for_surface (object surface)

    Finds the GtkNative associated with the surface.

    • @p surface is a GdkSurface.
    • @r the GtkNative that is associated with @surface.

  • 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.
    • @r the corresponding GtkOrdering.

  • paper_size_get_default ()

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

    • @r the name of the default paper size. The string is owned by GTK and should not be modified..

  • 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.
    • @r a newly allocated list of newly allocated GtkPaperSize objects.

  • 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.
    • @r a newly created property specification.

  • 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.
    • @r a new GtkPageSetup.

  • print_run_page_setup_dialog_async (object parent, object page_setup, object settings, object done_cb)

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

    • @page_setup. In contrast to [func@Gtk.print_run_page_setup_dialog], this function returns after showing the page setup dialog on platforms that support this, and calls @done_cb from a signal handler for the ::response signal of the dialog.
    • @p parent is transient parent.
    • @p page_setup is an existing GtkPageSetup.
    • @p settings is a GtkPrintSettings.
    • @p done_cb is a function to call when the user saves the modified page setup.
    • @p data is user data to pass to @done_cb.
    • @r None.

  • 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.

  • rgb_to_hsv (double r, double g, double b)

    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.

    • @p r is Red.
    • @p g is Green.
    • @p b is Blue.
    • @p h is Return value for the hue component.
    • @p s is Return value for the saturation component.
    • @p v is Return value for the value component.
    • @r None.

  • set_debug_flags (string flags)

    Sets the GTK debug flags.

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

  • show_about_dialog (object parent, string first_property_name, list varargs)

    A convenience function for showing an application’s about dialog. The constructed dialog is associated with the parent window and reused for future invocations of this function.

    • @p parent is the parent top-level window.
    • @p first_property_name is the name of the first property.
    • @p ... is value of first property, followed by more pairs of property name and value, NULL-terminated.
    • @r None.

  • show_uri (object parent, string uri, int timestamp)

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

    • @p parent is parent window.
    • @p uri is the uri to show.
    • @p timestamp is timestamp from the event that triggered this call, or %GDK_CURRENT_TIME.
    • @r None.

  • show_uri_full (object parent, string uri, int timestamp, object cancellable, object arg4Callback)

    This function launches the default application for showing a given uri. The @callback will be called when the launch is completed. This is the recommended call to be used as it passes information necessary for sandbox helpers to parent their dialogs properly.

    • @p parent is parent window.
    • @p uri is the uri to show.
    • @p timestamp is timestamp from the event that triggered this call, or %GDK_CURRENT_TIME.
    • @p cancellable is a GCancellable to cancel the launch.
    • @p callback is a callback to call when the action is complete.
    • @p user_data is data to pass to @callback.
    • @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.
    • @r %TRUE if the URI was shown successfully. Otherwise, %FALSE is returned and @error is set.

  • 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.
    • @r the attribute name.

  • 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.
    • @r the element name.

  • 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.
    • @r the [struct@Gtk.SvgLocation].

  • 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.
    • @r the input source.

  • 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.
    • @r the [struct@Gtk.SvgLocation].

  • 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_check_property (object accessible, string property, list varargs)

    Checks whether the accessible @property of @accessible is set to a specific value.

    • @p accessible is a GtkAccessible.
    • @p property is a GtkAccessibleProperty.
    • @p ... is the expected value of @property.
    • @r the value of the accessible property.

  • test_accessible_check_relation (object accessible, string relation, list varargs)

    Checks whether the accessible @relation of @accessible is set to a specific value.

    • @p accessible is a GtkAccessible.
    • @p relation is a GtkAccessibleRelation.
    • @p ... is the expected value of @relation.
    • @r the value of the accessible relation.

  • test_accessible_check_state (object accessible, string state, list varargs)

    Checks whether the accessible @state of @accessible is set to a specific value.

    • @p accessible is a GtkAccessible.
    • @p state is a GtkAccessibleState.
    • @p ... is the expected value of @state.
    • @r the value of the accessible state.

  • 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.
    • @r %TRUE if the @property is set in the @accessible.

  • 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.
    • @r %TRUE if the @relation is set in the @accessible.

  • 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.
    • @r %TRUE if the role matches.

  • 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.
    • @r %TRUE if the @state is set in the @accessible.

  • test_init (int argcp, list varargs)

    This function is used to initialize a GTK test program. It will in turn call g_test_init() and gtk_init() to properly initialize the testing framework and graphical toolkit. It’ll also set the program’s locale to “C”. This is done to make test program environments as deterministic as possible. Like gtk_init() and g_test_init(), any known arguments will be processed and stripped from @argc and @argv.

    • @p argcp is Address of the argc parameter of the main() function. Changed if any arguments were handled..
    • @p argvp is Address of the argv parameter of main(). Any parameters understood by g_test_init() or gtk_init() are stripped before return..
    • @p ... is currently unused.
    • @r None.

  • test_list_all_types ()

    Return the type ids that have been registered after calling gtk_test_register_all_types().

    • @p n_types is location to store number of types.
    • @r 0-terminated array of type ids.

  • 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.
    • @r a new GdkContentProvider.

  • tree_get_row_drag_data (object value)

    Obtains a @tree_model and @path from value of target type %GTK_TYPE_TREE_ROW_DATA. The returned path must be freed with gtk_tree_path_free().

    • @p value is a GValue.
    • @p tree_model is a GtkTreeModel.
    • @p path is row in @tree_model.
    • @r %TRUE if @selection_data had target type %GTK_TYPE_TREE_ROW_DATA is otherwise valid.

  • 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, object 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.
    • @r a GtkExpression.

  • value_get_expression (object value)

    Retrieves the GtkExpression stored inside the given value.

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

  • 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.

  • paper_size_get_paper_sizes_list ()

    Returns paper_size_get_paper_sizes as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use paper_size_get_paper_sizes() when lazy or change-notify access is required.

    • @r An Aussom list of elements.

class: GtkFlowBoxCreateWidgetFuncCallback

[831:7] extends: object

Called for flow boxes that are bound to a GListModel. This function is called for each item that gets added to the model.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkFlowBoxCreateWidgetFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (item, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTextCharPredicateCallback

[2301:7] extends: object

The predicate function used by gtk_text_iter_forward_find_char() and gtk_text_iter_backward_find_char().

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTextCharPredicateCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (ch, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkFontFilterFuncCallback

[1120:7] extends: object

The type of function that is used for deciding what fonts get shown in a GtkFontChooser. See [method@Gtk.FontChooser.set_filter_func].

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkFontFilterFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (family, face, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkFlowBoxSortFuncCallback

[1048:7] extends: object

A function to compare two children to determine which should come first.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkFlowBoxSortFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (child1, child2, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeCellDataFuncCallback

[2518:7] extends: object

A function to set the properties of a cell instead of just using the straight mapping between the cell and the model. This function is useful for customizing the cell renderer. For example, a function might get an* integer from the @tree_model, and render it to the “text” attribute of “cell” by converting it to its written equivalent. See also: gtk_tree_view_column_set_cell_data_func()

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeCellDataFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (tree_column, cell, tree_model, iter, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkPageSetupDoneFuncCallback

[1780:7] extends: object

The type of function that is passed to gtk_print_run_page_setup_dialog_async(). This function will be called when the page setup dialog is dismissed, and also serves as destroy notify for @data.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkPageSetupDoneFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (page_setup, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTextTagTableForeachCallback

[2371:7] extends: object

A function used with gtk_text_tag_table_foreach(), to iterate over every GtkTextTag inside a GtkTextTagTable.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTextTagTableForeachCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (tag, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkPrinterFuncCallback

[1994:7] extends: object

The type of function passed to gtk_enumerate_printers(). Note that you need to ref @printer, if you want to keep a reference to it after the function has returned.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkPrinterFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (printer, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkListBoxUpdateHeaderFuncCallback

[1557:7] extends: object

Whenever @row changes or which row is before @row changes this is called, which lets you update the header on @row. You may remove or set a new one via [method@Gtk.ListBoxRow.set_header] or just change the state of the current header widget.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkListBoxUpdateHeaderFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (row, before, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTickCallbackCallback

[2442:7] extends: object

Callback type for adding a function to update animations. See [method@Gtk.Widget.add_tick_callback].

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTickCallbackCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (widget, frame_clock, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkFlowBoxFilterFuncCallback

[906:7] extends: object

A function that will be called whenever a child changes or is added. It lets you control if the child should be visible or not.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkFlowBoxFilterFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (child, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkCellAllocCallbackCallback

[86:7] extends: object

The type of the callback functions used for iterating over the cell renderers and their allocated areas inside a GtkCellArea, see gtk_cell_area_foreach_alloc().

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkCellAllocCallbackCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (renderer, cell_area, cell_background, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkIconViewForeachFuncCallback

[1192:7] extends: object

A function used by gtk_icon_view_selected_foreach() to map all selected rows. It will be called on every selected row in the view.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkIconViewForeachFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (icon_view, path, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkCustomAllocateFuncCallback

[303:7] extends: object

A function to be used by GtkCustomLayout to allocate a widget.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkCustomAllocateFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (widget, width, height, baseline)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewMappingFuncCallback

[3202:7] extends: object

Function used for gtk_tree_view_map_expanded_rows().

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewMappingFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (tree_view, path, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkEntryCompletionMatchFuncCallback

[690:7] extends: object

A function which decides whether the row indicated by @iter matches a given @key, and should be displayed as a possible completion for @key. Note that @key is normalized and case-folded (see g_utf8_normalize() and g_utf8_casefold()). If this is not appropriate, match functions have access to the unmodified key via gtk_editable_get_text (GTK_EDITABLE (gtk_entry_completion_get_entry ())).

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkEntryCompletionMatchFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (completion, key, iter, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkCellCallbackCallback

[159:7] extends: object

The type of the callback functions used for iterating over the cell renderers of a GtkCellArea, see gtk_cell_area_foreach().

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkCellCallbackCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (renderer, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkMapListModelMapFuncCallback

[1630:7] extends: object

User function that is called to map an @item of the original model to an item expected by the map model. The returned items must conform to the item type of the model they are used with.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkMapListModelMapFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (item, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeSelectionForeachFuncCallback

[2975:7] extends: object

A function used by gtk_tree_selection_selected_foreach() to map all selected rows. It will be called on every selected row in the view.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeSelectionForeachFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (model, path, iter, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkCustomMeasureFuncCallback

[445:7] extends: object

A function to be used by GtkCustomLayout to measure a widget.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkCustomMeasureFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (widget, orientation, for_size, minimum, natural, minimum_baseline, natural_baseline)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkDrawingAreaDrawFuncCallback

[614:7] extends: object

Whenever @drawing_area needs to redraw, this function will be called. This function should exclusively redraw the contents of the drawing area and must not call any widget functions that cause changes.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkDrawingAreaDrawFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (drawing_area, cr, width, height, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkPrintSettingsFuncCallback

[1923:7] extends: object

Function called by [method@Gtk.PrintSettings.foreach] on every key/value pair inside a [class@Gtk.PrintSettings].

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkPrintSettingsFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (key, value, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkAssistantPageFuncCallback

[15:7] extends: object

Type of callback used to calculate the next page in a GtkAssistant. It’s called both for computing the next page when the user presses the “forward” button and for handling the behavior of the “last” button. See [method@Gtk.Assistant.set_forward_page_func].

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkAssistantPageFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (current_page, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeSelectionFuncCallback

[3050:7] extends: object

A function used by gtk_tree_selection_set_select_function() to filter whether or not a row may be selected. It is called whenever a row's state might change. A return value of %TRUE indicates to @selection that it is okay to change the selection.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeSelectionFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (selection, model, path, path_currently_selected, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkMenuButtonCreatePopupFuncCallback

[1707:7] extends: object

User-provided callback function to create a popup for a GtkMenuButton on demand. This function is called when the popup of @menu_button is shown, but none has been provided via [method@Gtk.MenuButton.set_popover] or [method@Gtk.MenuButton.set_menu_model].

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkMenuButtonCreatePopupFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (menu_button, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkPrintJobCompleteFuncCallback

[1851:7] extends: object

The type of callback that is passed to gtk_print_job_send(). It is called when the print job has been completely sent.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkPrintJobCompleteFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (print_job, user_data, error)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkCustomRequestModeFuncCallback

[542:7] extends: object

Queries a widget for its preferred size request mode.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkCustomRequestModeFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (widget)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkCustomFilterFuncCallback

[375:7] extends: object

User function that is called to determine if the @item should be matched. If the filter matches the item, this function must return true. If the item should be filtered out, false must be returned.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkCustomFilterFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (item, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeModelFilterVisibleFuncCallback

[2830:7] extends: object

A function which decides whether the row indicated by @iter is visible.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeModelFilterVisibleFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (model, iter, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewSearchEqualFuncCallback

[3349:7] extends: object

A function used for checking whether a row in @model matches a search key string entered by the user. Note the return value is reversed from what you would normally expect, though it has some similarity to strcmp() returning 0 for equal strings.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewSearchEqualFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (model, column, key, iter, search_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkListBoxCreateWidgetFuncCallback

[1266:7] extends: object

Called for list boxes that are bound to a GListModel with gtk_list_box_bind_model() for each item that gets added to the model. If the widget returned is not a #GtkListBoxRow widget, then the widget will be inserted as the child of an intermediate #GtkListBoxRow.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkListBoxCreateWidgetFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (item, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTextBufferCommitNotifyCallback

[2229:7] extends: object

A notification callback used by [method@Gtk.TextBuffer.add_commit_notify]. You may not modify the [class@Gtk.TextBuffer] from a [callback@Gtk.TextBufferCommitNotify] callback and that is enforced by the [class@Gtk.TextBuffer] API. [callback@Gtk.TextBufferCommitNotify] may be used to be notified about changes to the underlying buffer right before-or-after the changes are committed to the underlying B-Tree. This is useful if you want to observe changes to the buffer without other signal handlers potentially modifying state on the way to the default signal handler. When @flags is GTK_TEXT_BUFFER_NOTIFY_BEFORE_INSERT, position is set to the offset in characters from the start of the buffer where the insertion will occur. length is set to the number of characters to be inserted. You may not yet retrieve the text until it has been inserted. You may access the text from GTK_TEXT_BUFFER_NOTIFY_AFTER_INSERT using [method@Gtk.TextBuffer.get_slice]. When @flags is GTK_TEXT_BUFFER_NOTIFY_AFTER_INSERT, position is set to offset in characters where the insertion occurred and length is set to the number of characters inserted. When @flags is GTK_TEXT_BUFFER_NOTIFY_BEFORE_DELETE, position is set to offset in characters where the deletion will occur and length is set to the number of characters that will be removed. You may still retrieve the text from this handler using position and length. When @flags is GTK_TEXT_BUFFER_NOTIFY_AFTER_DELETE, length is set to zero to denote that the delete-range has already been committed to the underlying B-Tree. You may no longer retrieve the text that has been deleted from the [class@Gtk.TextBuffer].

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTextBufferCommitNotifyCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (buffer, flags, position, length, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkFlowBoxForeachFuncCallback

[977:7] extends: object

A function used by gtk_flow_box_selected_foreach(). It will be called on every selected child of the @box.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkFlowBoxForeachFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (box, child, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkListBoxFilterFuncCallback

[1341:7] extends: object

Will be called whenever the row changes or is added and lets you control if the row should be visible or not.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkListBoxFilterFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (row, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeModelForeachFuncCallback

[2902:7] extends: object

Type of the callback passed to gtk_tree_model_foreach() to iterate over the rows in a tree model.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeModelForeachFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (model, path, iter, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewRowSeparatorFuncCallback

[3275:7] extends: object

Function type for determining whether the row pointed to by @iter should be rendered as a separator. A common way to implement this is to have a boolean column in the model, whose values the GtkTreeViewRowSeparatorFunc returns.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewRowSeparatorFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (model, iter, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkListBoxForeachFuncCallback

[1412:7] extends: object

A function used by gtk_list_box_selected_foreach(). It will be called on every selected child of the @box.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkListBoxForeachFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (box, row, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeIterCompareFuncCallback

[2598:7] extends: object

A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive integer if @a sorts before @b, @a sorts with @b, or @a sorts after @b respectively. If two iters compare as equal, their order in the sorted model is undefined. In order to ensure that the GtkTreeSortable behaves as expected, the GtkTreeIterCompareFunc must define a partial order on the model, i.e. it must be reflexive, antisymmetric and transitive. For example, if @model is a product catalogue, then a compare function for the “price” column could be one which returns price_of(@a) - price_of(@b).

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeIterCompareFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (model, a, b, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkWidgetActionActivateFuncCallback

[3422:7] extends: object

The type of the callback functions used for activating actions installed with [method@Gtk.WidgetClass.install_action]. The @parameter must match the @parameter_type of the action.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkWidgetActionActivateFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (widget, action_name, parameter)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewColumnDropFuncCallback

[3129:7] extends: object

Function type for determining whether @column can be dropped in a particular spot (as determined by @prev_column and @next_column). In left to right locales, @prev_column is on the left of the potential drop spot, and @next_column is on the right. In right to left mode, this is reversed. This function should return %TRUE if the spot is a valid drop spot. Please note that returning %TRUE does not actually indicate that the column drop was made, but is meant only to indicate a possible drop spot to the user.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewColumnDropFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (tree_view, column, prev_column, next_column, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkShortcutFuncCallback

[2135:7] extends: object

Type for shortcuts based on user callbacks.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkShortcutFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (widget, args, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkCellLayoutDataFuncCallback

[230:7] extends: object

A function which should set the value of @cell_layout’s cell renderer(s) as appropriate.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkCellLayoutDataFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (cell_layout, cell, tree_model, iter, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkExpressionNotifyCallback

[761:7] extends: object

Callback called by gtk_expression_watch() when the expression value changes.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkExpressionNotifyCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkListBoxSortFuncCallback

[1483:7] extends: object

Compare two rows to determine which should be first.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkListBoxSortFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (row1, row2, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeListModelCreateModelFuncCallback

[2674:7] extends: object

Prototype of the function called to create new child models when gtk_tree_list_row_set_expanded() is called. This function can return %NULL to indicate that @item is guaranteed to be a leaf node and will never have children. If it does not have children but may get children later, it should return an empty model that is filled once children arrive.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeListModelCreateModelFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (item, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeModelFilterModifyFuncCallback

[2751:7] extends: object

A function which calculates display values from raw values in the model. It must fill @value with the display value for the column @column in the row indicated by @iter. Since this function is called for each data access, it’s not a particularly efficient operation.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeModelFilterModifyFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (model, iter, value, column, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkScaleFormatValueFuncCallback

[2065:7] extends: object

Function that formats the value of a scale. See [method@Gtk.Scale.set_format_value_func].

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkScaleFormatValueFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (scale, value, user_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

Aussom

Write once. Embed everywhere.

Language

Tools

Community

Copyright 2026 Austin Lehman. All rights reserved.