gtk.types

Type of callback used to calculate the next page in a gtk.assistant.Assistant.

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 gtk.assistant.Assistant.setForwardPageFunc.

The type of the callback functions used for iterating over the cell renderers and their allocated areas inside a gtk.cell_area.CellArea, see gtk.cell_area.CellArea.foreachAlloc.

The type of the callback functions used for iterating over the cell renderers of a gtk.cell_area.CellArea, see gtk.cell_area.CellArea.foreach_.

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

A function to be used by gtk.custom_layout.CustomLayout 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 gtk.custom_layout.CustomLayout 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 glib.global.utf8Normalize and glib.global.utf8Casefold). 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.Expression.watch when the expression value changes.

Called for flow boxes that are bound to a gio.list_model.ListModel.

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.FlowBox.selectedForeach.

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 gtk.font_chooser.FontChooser.

See gtk.font_chooser.FontChooser.setFilterFunc.

A function used by gtk.icon_view.IconView.selectedForeach 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 gio.list_model.ListModel with gtk.list_box.ListBox.bindModel 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.

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.ListBox.selectedForeach.

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 gtk.list_box_row.ListBoxRow.setHeader 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 gtk.menu_button.MenuButton on demand.

This function is called when the popup of menu_button is shown, but none has been provided via gtk.menu_button.MenuButton.setPopover or gtk.menu_button.MenuButton.setMenuModel.

The type of function that is passed to gtk.global.printRunPageSetupDialogAsync.

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.PrintJob.send.

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

The type of function passed to gtk.global.enumeratePrinters.

Note that you need to ref printer, if you want to keep a reference to it after the function has returned.

Prototype for shortcuts based on user callbacks.

The predicate function used by gtk.text_iter.TextIter.forwardFindChar and gtk.text_iter.TextIter.backwardFindChar.

A function used with gtk.text_tag_table.TextTagTable.foreach_, to iterate over every gtk.text_tag.TextTag inside a gtk.text_tag_table.TextTagTable.

Callback type for adding a function to update animations. See gtk.widget.Widget.addTickCallback.

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.TreeViewColumn.setCellDataFunc

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 gtk.tree_sortable.TreeSortable 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.TreeListRow.setExpanded 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.

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.TreeModel.foreach_ to iterate over the rows in a tree model.

A function used by gtk.tree_selection.TreeSelection.selectedForeach to map all selected rows. It will be called on every selected row in the view.

A function used by gtk.tree_selection.TreeSelection.setSelectFunction 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.TreeView.mapExpandedRows.

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 gtk.types.TreeViewRowSeparatorFunc 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.WidgetClass.installAction.

The parameter must match the parameter_type of the action.

An attribute for the background color, expressed as an RGB value encoded in a string using the format: {r8},{g8},{b8}.

An attribute for the font family name.

An attribute for the foreground color, expressed as an RGB value encoded in a string using the format: {r8},{g8},{b8}.

An attribute for the overline style.

Possible values are:

• gtk.types.ACCESSIBLE_ATTRIBUTE_OVERLINE_NONE
• gtk.types.ACCESSIBLE_ATTRIBUTE_OVERLINE_SINGLE

The "none" overline value for gtk.types.ACCESSIBLE_ATTRIBUTE_OVERLINE.

The "single" overline value for gtk.types.ACCESSIBLE_ATTRIBUTE_OVERLINE.

An attribute for the font size, expressed in points.

An attribute for the font stretch type.

Possible values are:

• gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH_ULTRA_CONDENSED
• gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH_EXTRA_CONDENSED
• gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH_CONDENSED
• gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH_SEMI_CONDENSED

The "condensed" stretch value for gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH.

The "expanded" stretch value for gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH.

The "extra condensed" stretch value for gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH.

The "extra expanded" stretch value for gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH.

The "normal" stretch value for gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH.

The "semi condensed" stretch value for gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH.

The "semi expanded" stretch value for gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH.

The "ultra condensed" stretch value for gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH.

The "ultra expanded" stretch value for gtk.types.ACCESSIBLE_ATTRIBUTE_STRETCH.

An attribute for strikethrough text.

Possible values are true or false.

An attribute for the font style.

Possible values are:

• gtk.types.ACCESSIBLE_ATTRIBUTE_STYLE_NORMAL
• gtk.types.ACCESSIBLE_ATTRIBUTE_STYLE_OBLIQUE
• gtk.types.ACCESSIBLE_ATTRIBUTE_STYLE_ITALIC

The "italic" style value for gtk.types.ACCESSIBLE_ATTRIBUTE_STYLE.

The "normal" style value for gtk.types.ACCESSIBLE_ATTRIBUTE_STYLE.

The "oblique" style value for gtk.types.ACCESSIBLE_ATTRIBUTE_STYLE.

An attribute for the underline style.

Possible values are:

• gtk.types.ACCESSIBLE_ATTRIBUTE_UNDERLINE_NONE
• gtk.types.ACCESSIBLE_ATTRIBUTE_UNDERLINE_SINGLE
• gtk.types.ACCESSIBLE_ATTRIBUTE_UNDERLINE_DOUBLE
• gtk.types.ACCESSIBLE_ATTRIBUTE_UNDERLINE_ERROR

The "double" underline value for gtk.types.ACCESSIBLE_ATTRIBUTE_UNDERLINE.

The "error" underline value for gtk.types.ACCESSIBLE_ATTRIBUTE_UNDERLINE.

The "none" underline value for gtk.types.ACCESSIBLE_ATTRIBUTE_UNDERLINE.

The "single" underline value for gtk.types.ACCESSIBLE_ATTRIBUTE_UNDERLINE.

An attribute for the font variant.

Possible values are:

• gtk.types.ACCESSIBLE_ATTRIBUTE_VARIANT_SMALL_CAPS
• gtk.types.ACCESSIBLE_ATTRIBUTE_VARIANT_ALL_SMALL_CAPS
• gtk.types.ACCESSIBLE_ATTRIBUTE_VARIANT_PETITE_CAPS
• gtk.types.ACCESSIBLE_ATTRIBUTE_VARIANT_ALL_PETITE_CAPS
• gtk.types.ACCESSIBLE_ATTRIBUTE_VARIANT_UNICASE
• gtk.types.ACCESSIBLE_ATTRIBUTE_VARIANT_TITLE_CAPS

The "all petite caps" variant value for gtk.types.ACCESSIBLE_ATTRIBUTE_VARIANT.

The "all small caps" variant value for gtk.types.ACCESSIBLE_ATTRIBUTE_VARIANT.

The "petite caps" variant value for gtk.types.ACCESSIBLE_ATTRIBUTE_VARIANT.

The "small caps" variant value for gtk.types.ACCESSIBLE_ATTRIBUTE_VARIANT.

The "title caps" variant value for gtk.types.ACCESSIBLE_ATTRIBUTE_VARIANT.

The "unicase" variant value for gtk.types.ACCESSIBLE_ATTRIBUTE_VARIANT.

An attribute for the font weight.

An undefined value. The accessible attribute is either unset, or its value is undefined.

Like func@get_binary_age, but from the headers used at application compile time, rather than from the library linked against at application run time.

Constant to return from a signal handler for the ::input signal in case of conversion failure.

See gtk.spin_button.SpinButton.input.

Like func@get_interface_age, but from the headers used at application compile time, rather than from the library linked against at application run time.

The value used to refer to a guaranteed invalid position in a gio.list_model.ListModel.

This value may be returned from some functions, others may accept it as input. Its interpretation may differ for different functions.

Refer to each function's documentation for if this value is allowed and what it does.

The name used for the stock full offset included by gtk.level_bar.LevelBar.

The name used for the stock high offset included by gtk.level_bar.LevelBar.

The name used for the stock low offset included by gtk.level_bar.LevelBar.

Like func@get_major_version, but from the headers used at application compile time, rather than from the library linked against at application run time.

Like func@get_micro_version, but from the headers used at application compile time, rather than from the library linked against at application run time.

Like func@get_minor_version, but from the headers used at application compile time, rather than from the library linked against at application run time.

Name for the A3 paper size.

Name for the A4 paper size.

Name for the A5 paper size.

Name for the B5 paper size.

Name for the Executive paper size.

Name for the Legal paper size.

Name for the Letter paper size.

The key used by the “Print to file” printer to store the file name of the output without the path to the directory and the file extension.

The key used by the “Print to file” printer to store the directory to which the output should be written.

The key used by the “Print to file” printer to store the format of the output. The supported values are “PS” and “PDF”.

The key used by the “Print to file” printer to store the URI to which the output should be written. GTK itself supports only “file://” URIs.

Use this priority for functionality related to size allocation.

It is used internally by GTK+ to compute the sizes of widgets. This priority is higher than gdk.types.PRIORITY_REDRAW to avoid resizing a widget which was just redrawn.

A priority that can be used when adding a gtk.style_provider.StyleProvider for application-specific style information.

The priority used for default style information that is used in the absence of themes.

Note that this is not very useful for providing default styling for custom style classes - themes are likely to override styling provided at this priority with catch-all `* {...}` rules.

The priority used for style information provided via gtk.settings.Settings.

This priority is higher than gtk.types.STYLE_PROVIDER_PRIORITY_THEME to let settings override themes.

The priority used for style information provided by themes.

The priority used for the style information from $XDG_CONFIG_HOME/gtk-4.0/gtk.css.

You should not use priorities higher than this, to give the user the last word.

The priority at which the text view validates onscreen lines in an idle job in the background.

Uses the default sort function in a gtk.tree_sortable.TreeSortable.

See also: gtk.tree_sortable.TreeSortable.setSortColumnId

Disables sorting in a gtk.tree_sortable.TreeSortable.

See also: gtk.tree_sortable.TreeSortable.setSortColumnId