Type Aliases

CSS Provider reference

CSS Provider class

The rectangle representing the area allocated for a widget by its parent.

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 [methodGtk.Assistant.set_forward_page_func].

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().

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

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

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

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.

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

Queries a widget for its preferred size request mode.

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.

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 ())).

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

Called for flow boxes that are bound to a GListModel.

This function is called for each item that gets added to the model.

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.

A function used by gtk_flow_box_selected_foreach().

It will be called on every selected child of the box.

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

The type of function that is used for deciding what fonts get shown in a GtkFontChooser.

See [methodGtk.FontChooser.set_filter_func].

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.

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.

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

A function used by gtk_list_box_selected_foreach().

It will be called on every selected child of the box.

Compare two rows to determine which should be first.

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 [methodGtk.ListBoxRow.set_header] or just change the state of the current header widget.

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.

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 [methodGtk.MenuButton.set_popover] or [methodGtk.MenuButton.set_menu_model].

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.

The type of callback that is passed to gtk_print_job_send().

It is called when the print job has been completely sent.

Undocumented

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.

Undocumented

Prototype for shortcuts based on user callbacks.

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

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

Callback type for adding a function to update animations. See gtk_widget_add_tick_callback().

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()

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

Prototype of the function called to create new child models when gtk_tree_list_row_set_expanded() is called.

This function can return nil 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.

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.

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

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

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.

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.

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.

Function used for gtk_tree_view_map_expanded_rows().

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.

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.

The type of the callback functions used for activating actions installed with gtk_widget_class_install_action().

The parameter must match the parameter_type of the action.

The possible values for the GTK_ACCESSIBLE_PROPERTY_AUTOCOMPLETE accessible property.

The possible values for the GTK_ACCESSIBLE_STATE_INVALID accessible state.

Note that the GTK_ACCESSIBLE_INVALID_FALSE and GTK_ACCESSIBLE_INVALID_TRUE have the same values as false and true.

The possible accessible properties of a GtkAccessible.

The possible accessible relations of a GtkAccessible.

Accessible relations can be references to other widgets, integers or strings.

The accessible role for a GtkAccessible implementation.

Abstract roles are only used as part of the ontology; application developers must not use abstract roles in their code.

The possible values for the GTK_ACCESSIBLE_PROPERTY_SORT accessible property.

The possible accessible states of a GtkAccessible.

The possible values for the GTK_ACCESSIBLE_STATE_PRESSED accessible state.

Note that the GTK_ACCESSIBLE_TRISTATE_FALSE and GTK_ACCESSIBLE_TRISTATE_TRUE have the same values as false and true.

Controls how a widget deals with extra space in a single dimension.

Alignment only matters if the widget receives a “too large” allocation, for example if you packed the widget with the [propertyGtk.Widget:hexpand] property inside a GtkBox, then the widget might get extra space. If you have for example a 16x16 icon inside a 32x32 space, the icon could be scaled and stretched, it could be centered, or it could be positioned to one side of the space.

Note that in horizontal context GTK_ALIGN_START and GTK_ALIGN_END are interpreted relative to text direction.

GTK_ALIGN_BASELINE support is optional for containers and widgets, and it is only supported for vertical alignment. When it’s not supported by a child or a container it is treated as GTK_ALIGN_FILL.

Used to indicate the direction in which an arrow should point.

Determines the page role inside a GtkAssistant.

The role is used to handle buttons sensitivity and visibility.

Note that an assistant needs to end its page flow with a page of type GTK_ASSISTANT_PAGE_CONFIRM, GTK_ASSISTANT_PAGE_SUMMARY or GTK_ASSISTANT_PAGE_PROGRESS to be correct.

The Cancel button will only be shown if the page isn’t “committed”. See gtk_assistant_commit() for details.

Baseline position in a row of widgets.

Whenever a container has some form of natural row it may align children in that row along a common typographical baseline. If the amount of vertical space in the row is taller than the total requested height of the baseline-aligned children then it can use a GtkBaselinePosition to select where to put the baseline inside the extra available space.

Describes how the border of a UI element should be rendered.

Error codes that identify various errors that can occur while using GtkBuilder.

Prebuilt sets of buttons for GtkDialog.

If none of these choices are appropriate, simply use GTK_BUTTONS_NONE and call [methodGtk.Dialog.add_buttons].

> Please note that GTK_BUTTONS_OK, GTK_BUTTONS_YES_NO > and GTK_BUTTONS_OK_CANCEL are discouraged by the > GNOME Human Interface Guidelines.

Determines if the edited accelerators are GTK accelerators. If they are, consumed modifiers are suppressed, only accelerators accepted by GTK are allowed, and the accelerators are rendered in the same way as they are in menus.

Identifies how the user can interact with a particular cell.

The widget attributes that can be used when creating a GtkConstraint.

The relation between two terms of a constraint.

The strength of a constraint, expressed as a symbolic constant.

The strength of a GtkConstraint can be expressed with any positive integer; the values of this enumeration can be used for readability.

Domain for VFL parsing errors.

Specifies which corner a child widget should be placed in when packed into a GtkScrolledWindow.

This is effectively the opposite of where the scroll bars are placed.

Errors that can occur while parsing CSS.

These errors are unexpected and will cause parts of the given CSS to be ignored.

Warnings that can occur while parsing CSS.

Unlike GtkCssParserErrors, warnings do not cause the parser to skip any input, but they indicate issues that should be fixed.

Passed to various keybinding signals for deleting text.

Focus movement types.

Undocumented

Specifies the side of the entry at which an icon is placed.

Describes the state of a GdkEventSequence in a GtkGesture.

Describes whether a GtkFileChooser is being used to open existing files or to save to a possibly new file.

These identify the various errors that can occur while calling GtkFileChooser functions.

Describes changes in a filter in more detail and allows objects using the filter to optimize refiltering items.

If you are writing an implementation and are not sure which value to pass, GTK_FILTER_CHANGE_DIFFERENT is always a correct choice.

Describes the known strictness of a filter.

Note that for filters where the strictness is not known, GTK_FILTER_MATCH_SOME is always an acceptable value, even if a filter does match all or no items.

Built-in icon sizes.

Icon sizes default to being inherited. Where they cannot be inherited, text size is the default.

All widgets which use GtkIconSize set the normal-icons or large-icons style classes correspondingly, and let themes determine the actual size to be used with the -gtk-icon-size CSS property.

Error codes for GtkIconTheme operations.

An enum for determining where a dropped item goes.

Describes the image data representation used by a [classGtk.Image].

If you want to get the image from the widget, you can only get the currently-stored representation; for instance, if the gtk_image_get_storage_type() returns GTK_IMAGE_PAINTABLE, then you can call gtk_image_get_paintable().

For empty images, you can request any storage type (call any of the “get” functions), but they will all return nil values.

Describes primary purpose of the input widget.

This information is useful for on-screen keyboards and similar input methods to decide which keys should be presented to the user.

Note that the purpose is not meant to impose a totally strict rule about allowed characters, and does not replace input validation. It is fine for an on-screen keyboard to let the user override the character set restriction that is expressed by the purpose. The application is expected to validate the entry contents, even if it specified a purpose.

The difference between GTK_INPUT_PURPOSE_DIGITS and GTK_INPUT_PURPOSE_NUMBER is that the former accepts only digits while the latter also some punctuation (like commas or points, plus, minus) and “e” or “E” as in 3.14E+000.

This enumeration may be extended in the future; input methods should interpret unknown values as “free form”.

Used for justifying the text inside a GtkLabel widget.

Describes how GtkLevelBar contents should be rendered.

Note that this enumeration could be extended with additional modes in the future.

The type of license for an application.

This enumeration can be expanded at later date.

The type of message being displayed in a GtkMessageDialog.

Passed as argument to various keybinding signals for moving the cursor position.

The parameter used in the action signals of GtkNotebook.

Used to determine the layout of pages on a sheet when printing multiple pages per sheet.

Describes the way two values can be compared.

These values can be used with a GCompareFunc. However, a GCompareFunc is allowed to return any integer values. For converting such a value to a GtkOrdering value, use [funcGtk.Ordering.from_cmpfunc].

Represents the orientation of widgets and other objects.

Typical examples are GtkBox orGtkGesturePan`.

Defines how content overflowing a given area should be handled.

This is used in [methodGtk.Widget.set_overflow]. The [propertyGtk.Widget:overflow] property is modeled after the CSS overflow property, but implements it only partially.

Represents the packing location of a children in its parent.

See GtkWindowControls for example.

The type of a pad action.

See also gtk_print_settings_set_orientation().

See also gtk_print_job_set_page_set().

Describes the panning direction of a GtkGesturePan

Determines how the size should be computed to achieve the one of the visibility mode for the scrollbars.

Describes which edge of a widget a certain feature is positioned at.

For examples, see the tabs of a GtkNotebook, or the label of a GtkScale.

See also gtk_print_settings_set_duplex().

Error codes that identify various errors that can occur while using the GTK printing support.

Determines what action the print operation should perform.

A parameter of this typs is passed to [methodGtk.PrintOperation.run].

The result of a print operation.

A value of this type is returned by [methodGtk.PrintOperation.run].

See also gtk_print_job_set_pages()

See also gtk_print_settings_set_quality().

The status gives a rough indication of the completion of a running print operation.

Describes limits of a GtkEventController for handling events targeting other widgets.

Describes the stage at which events are fed into a GtkEventController.

Error codes for GtkRecentManager operations

Predefined values for use as response ids in gtk_dialog_add_button().

All predefined values are negative; GTK leaves values of 0 or greater for application-defined response ids.

These enumeration values describe the possible transitions when the child of a GtkRevealer widget is shown or hidden.

Passed as argument to various keybinding signals.

Scrolling types.

Defines the policy to be used in a scrollable widget when updating the scrolled window adjustments in a given orientation.

Used to control what selections users are allowed to make.

Determines how GTK handles the sensitivity of various controls, such as combo box buttons.

Describes where GtkShortcuts added to a GtkShortcutController get handled.

GtkShortcutType specifies the kind of shortcut that is being described.

More values may be added to this enumeration over time.

The mode of the size group determines the directions in which the size group affects the requested sizes of its component widgets.

Specifies a preference for height-for-width or width-for-height geometry management.

Determines the direction of a sort.

Describes changes in a sorter in more detail and allows users to optimize resorting.

Describes the type of order that a GtkSorter may produce.

Determines whether the spin button displays values outside the adjustment bounds.

See [methodGtk.SpinButton.set_update_policy].

The values of the GtkSpinType enumeration are used to specify the change to make in gtk_spin_button_spin().

Possible transitions between pages in a GtkStack widget.

New values may be added to this enumeration over time.

Specifies how search strings are matched inside text.

Values that can be passed to the [vfuncGtk.Widget.system_setting_changed] vfunc.

The values indicate which system setting has changed. Widgets may need to drop caches, or react otherwise.

Most of the values correspond to GtkSettings properties.

More values may be added over time.

Reading directions for text.

Granularity types that extend the text selection. Use the GtkTextViewextend-selection`` signal to customize the selection.

Used to reference the layers of GtkTextView for the purpose of customized drawing with the snapshot_layer vfunc.

Used to reference the parts of GtkTextView.

The sizing method the column uses to determine its width. Please note that GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and can make columns appear choppy.

An enum for determining where a dropped row goes.

Used to indicate which grid lines to draw in a tree view.

See also gtk_print_settings_set_paper_width().

Describes a type of line wrapping.

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

A closure taking a reference to the current application as an argument

A closure taking a reference to the current box and cairo_t as an argument

A closure taking a reference to the current drawing area, a cairo context, and width and height as arguments

Tree View row activation signal handler

Closure holder for a Tree View row activation signal handler

A closure taking a reference to the current widget and cairo_t as an argument

A closure taking a reference to the current widget and Gdk.EventKeyRef as an argument

A closure taking a reference to the current widget and Gdk.EventButtonRef as an argument

A closure taking a reference to the current widget and Gdk.EventMotionRef as an argument