gtk.types

A function used by [gtk.assistant.Assistant.setForwardPageFunc] to know which is the next page given a current one. 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.

This is the signature of a function used to connect signals. It is used by the [gtk.builder.Builder.connectSignals] and [gtk.builder.Builder.connectSignalsFull] methods. It is mainly intended for interpreted language bindings, but could be useful where the programmer wants more control over the signal connection process. Note that this function can only be called once, subsequent calls will do nothing.

This kind of functions provide Pango markup with detail information for the specified day. Examples for such details are holidays or appointments. The function returns null when no information is available.

The type of the callback functions used for e.g. iterating over the children of a container, see [gtk.container.Container.foreach_].

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

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

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

A function that will be called when the contents of the clipboard are changed or cleared. Once this has called, the user_data_or_owner argument will not be used again.

A function that will be called to provide the contents of the selection. If multiple types of data were advertised, the requested type can be determined from the info parameter or by checking the target field of selection_data. If the data could successfully be converted into then it should be stored into the selection_data object by calling [gtk.selection_data.SelectionData.set] (or related functions such as [gtk.selection_data.SelectionData.setText]). If no data is set, the requestor will be informed that the attempt to get the data failed.

A function to be called when the results of [gtk.clipboard.Clipboard.requestImage] are received, or when the request fails.

A function to be called when the results of [gtk.clipboard.Clipboard.requestContents] are received, or when the request fails.

A function to be called when the results of [gtk.clipboard.Clipboard.requestRichText] are received, or when the request fails.

A function to be called when the results of [gtk.clipboard.Clipboard.requestText] are received, or when the request fails.

A function to be called when the results of [gtk.clipboard.Clipboard.requestUris] are received, or when the request fails.

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_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry ())).

The type of function that is used with custom filters, see [gtk.file_filter.FileFilter.addCustom].

Called for flow boxes that are bound to a #GListModel with [gtk.flow_box.FlowBox.bindModel] for each item that gets added to the model.

A function that will be called whenrever 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 #GtkFontChooser. 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.

Key snooper functions are called before normal event delivery. They can be used to implement custom key event handling.

Called for list boxes that are bound to a #GListModel with [gtk.list_box.ListBox.bindModel] for each item that gets added to the model.

Versions of GTK+ prior to 3.18 called [gtk.widget.Widget.showAll] on the rows created by the GtkListBoxCreateWidgetFunc, but this forced all widgets inside the row to be shown, and is no longer the case. Applications should be updated to show the desired row widgets.

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.

A user function supplied when calling [gtk.menu.Menu.attachToWidget] which will be called when the menu is later detached from the widget.

A user function supplied when calling [gtk.menu.Menu.popup] which controls the positioning of the menu when it is displayed. The function sets the x and y parameters to the coordinates where the menu is to be drawn. To make the menu appear on a different monitor than the mouse pointer, [gtk.menu.Menu.setMonitor] must be called.

A multihead-aware GTK+ module may have a gtk_module_display_init() function with this prototype. GTK+ calls this function for each opened display.

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 function that is used with custom filters, see [gtk.recent_filter.RecentFilter.addCustom].

A function that is called to deserialize rich text that has been serialized with [gtk.text_buffer.TextBuffer.serialize], and insert it at iter.

A function that is called to serialize the content of a text buffer. It must return the serialized form of the content.

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

The function used to translate messages in e.g. #GtkIconFactory and #GtkActionGroup.

A function to set the properties of a cell instead of just using the straight mapping between the cell and the model. This 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. This is set by calling [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 #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`)`.

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

Like [gtk.global.getBinaryAge], 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 #GtkSpinButton::input signal in case of conversion failure.

Like [gtk.global.getInterfaceAge], but from the headers used at application compile time, rather than from the library linked against at application run time.

The name used for the stock full offset included by #GtkLevelBar.

The name used for the stock high offset included by #GtkLevelBar.

The name used for the stock low offset included by #GtkLevelBar.

Like [gtk.global.getMajorVersion], but from the headers used at application compile time, rather than from the library linked against at application run time.

The maximum length of sequences in compose tables.

Like [gtk.global.getMicroVersion], but from the headers used at application compile time, rather than from the library linked against at application run time.

Like [gtk.global.getMinorVersion], 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.

The “About” item. 

The “Add” item and icon.

The “Apply” item and icon.

The “Bold” item and icon.

The “Cancel” item and icon.

The “Caps Lock Warning” icon.

The “CD-Rom” item and icon.

The “Clear” item and icon.

The “Close” item and icon.

The “Color Picker” item and icon.

The “Connect” icon.

The “Convert” item and icon.

The “Copy” item and icon.

The “Cut” item and icon.

The “Delete” item and icon.

The “Authentication” item and icon.

The “Error” item and icon.

The “Information” item and icon.

The “Question” item and icon.

The “Warning” item and icon.

The “Directory” icon.

The “Discard” item.

The “Disconnect” icon.

The “Drag-And-Drop” icon.

The “Drag-And-Drop multiple” icon.

The “Edit” item and icon.

The “Execute” item and icon.

The “File” item and icon.

Since 3.0, this item has a label, before it only had an icon.

The “Find” item and icon.

The “Find and Replace” item and icon.

The “Floppy” item and icon.

The “Fullscreen” item and icon.

The “Bottom” item and icon.

The “First” item and icon. The icon has an RTL variant.

The “Last” item and icon. The icon has an RTL variant.

The “Top” item and icon.

The “Back” item and icon. The icon has an RTL variant.

The “Down” item and icon.

The “Forward” item and icon. The icon has an RTL variant.

The “Up” item and icon.

The “Harddisk” item and icon.

The “Help” item and icon.

The “Home” item and icon.

The “Indent” item and icon. The icon has an RTL variant.

The “Index” item and icon.

The “Info” item and icon.

The “Italic” item and icon.

The “Jump to” item and icon. The icon has an RTL variant.

The “Center” item and icon.

The “Fill” item and icon.

The “Left” item and icon.

The “Right” item and icon.

The “Leave Fullscreen” item and icon.

The “Media Forward” item and icon. The icon has an RTL variant.

The “Media Next” item and icon. The icon has an RTL variant.

The “Media Pause” item and icon.

The “Media Play” item and icon. The icon has an RTL variant.

The “Media Previous” item and icon. The icon has an RTL variant.

The “Media Record” item and icon.

The “Media Rewind” item and icon. The icon has an RTL variant.

The “Media Stop” item and icon.

The “Missing image” icon.

The “Network” item and icon.

The “New” item and icon.

The “No” item and icon.

The “OK” item and icon.

The “Open” item and icon.

The “Landscape Orientation” item and icon.

The “Portrait Orientation” item and icon.

The “Reverse Landscape Orientation” item and icon.

The “Reverse Portrait Orientation” item and icon.

The “Page Setup” item and icon.

The “Paste” item and icon.

The “Preferences” item and icon.

The “Print” item and icon.

The “Print Error” icon.

The “Print Paused” icon.

The “Print Preview” item and icon.

The “Print Report” icon.

The “Print Warning” icon.

The “Properties” item and icon.

The “Quit” item and icon.

The “Redo” item and icon. The icon has an RTL variant.

The “Refresh” item and icon.

The “Remove” item and icon.

The “Revert” item and icon. The icon has an RTL variant.

The “Save” item and icon.

The “Save As” item and icon.

The “Select All” item and icon.

The “Color” item and icon.

The “Font” item and icon.

The “Ascending” item and icon.

The “Descending” item and icon.

The “Spell Check” item and icon.

The “Stop” item and icon.

The “Strikethrough” item and icon.

The “Undelete” item and icon. The icon has an RTL variant.

The “Underline” item and icon.

The “Undo” item and icon. The icon has an RTL variant.

The “Unindent” item and icon. The icon has an RTL variant.

The “Yes” item and icon.

The “Zoom 100%” item and icon.

The “Zoom to Fit” item and icon.

The “Zoom In” item and icon.

The “Zoom Out” item and icon.

A CSS class to match an accelerator.

Refer to individual widget documentation for used style classes.

A CSS class used when rendering an arrow element.

Refer to individual widget documentation for used style classes.

A CSS class to match the window background.

Refer to individual widget documentation for used style classes.

A CSS class to indicate an area at the bottom of a widget.

Refer to individual widget documentation for used style classes.

A CSS class to match buttons.

Refer to individual widget documentation for used style classes.

A CSS class to match calendars.

Refer to individual widget documentation for used style classes.

A CSS class to match content rendered in cell views.

Refer to individual widget documentation for used style classes.

A CSS class to match check boxes.

Refer to individual widget documentation for used style classes.

A CSS class to match combobox entries.

Refer to individual widget documentation for used style classes.

A CSS class to match context menus.

Refer to individual widget documentation for used style classes.

A CSS class that gets added to windows which have client-side decorations.

Refer to individual widget documentation for used style classes.

A CSS class used when rendering a drag handle for text selection.

Refer to individual widget documentation for used style classes.

A CSS class to match the default widget.

Refer to individual widget documentation for used style classes.

A CSS class used when an action (usually a button) is one that is expected to remove or destroy something visible to the user.

Refer to individual widget documentation for used style classes.

A CSS class to match dimmed labels.

Refer to individual widget documentation for used style classes.

A CSS class for a drag-and-drop indicator.

Refer to individual widget documentation for used style classes.

A CSS class defining a dock area.

Refer to individual widget documentation for used style classes.

A CSS class to match text entries.

Refer to individual widget documentation for used style classes.

A CSS class for an area displaying an error message, such as those in infobars.

Refer to individual widget documentation for used style classes.

A CSS class defining an expander, such as those in treeviews.

Refer to individual widget documentation for used style classes.

A CSS class that is added when widgets that usually have a frame or border (like buttons or entries) should appear without it.

Refer to individual widget documentation for used style classes.

A CSS class defining a frame delimiting content, such as #GtkFrame or the scrolled window frame around the scrollable area.

Refer to individual widget documentation for used style classes.

A CSS class defining a resize grip.

Refer to individual widget documentation for used style classes.

A CSS class to match a header element.

Refer to individual widget documentation for used style classes.

A CSS class defining a highlighted area, such as headings in assistants and calendars.

Refer to individual widget documentation for used style classes.

A CSS class for horizontally layered widgets.

Refer to individual widget documentation for used style classes.

A CSS class defining an image, such as the icon in an entry.

Refer to individual widget documentation for used style classes.

A CSS class for an area displaying an informational message, such as those in infobars.

Refer to individual widget documentation for used style classes.

A CSS class to match inline toolbars.

Refer to individual widget documentation for used style classes.

A CSS class used when rendering a drag handle for the insertion cursor position.

Refer to individual widget documentation for used style classes.

A CSS class to match labels.

Refer to individual widget documentation for used style classes.

A CSS class to indicate an area at the left of a widget.

Refer to individual widget documentation for used style classes.

A CSS class used when rendering a level indicator, such as a battery charge level, or a password strength.

Refer to individual widget documentation for used style classes.

A CSS class to match a linked area, such as a box containing buttons belonging to the same control.

Refer to individual widget documentation for used style classes.

A CSS class to match lists.

Refer to individual widget documentation for used style classes.

A CSS class to match list rows.

Refer to individual widget documentation for used style classes.

A CSS class defining marks in a widget, such as in scales.

Refer to individual widget documentation for used style classes.

A CSS class to match menus.

Refer to individual widget documentation for used style classes.

A CSS class to menubars.

Refer to individual widget documentation for used style classes.

A CSS class to match menu items.

Refer to individual widget documentation for used style classes.

A CSS class that is added to message dialogs.

Refer to individual widget documentation for used style classes.

A CSS class that is added to text view that should use a monospace font.

Refer to individual widget documentation for used style classes.

A CSS class used when an element needs the user attention, for instance a button in a stack switcher corresponding to a hidden page that changed state.

Refer to individual widget documentation for used style classes.

A CSS class defining a notebook.

Refer to individual widget documentation for used style classes.

A CSS class used when rendering an OSD (On Screen Display) element, on top of another container.

Refer to individual widget documentation for used style classes.

A CSS class that is added on the visual hints that happen when scrolling is attempted past the limits of a scrollable area.

Refer to individual widget documentation for used style classes.

A CSS class for a pane separator, such as those in #GtkPaned.

Refer to individual widget documentation for used style classes.

A CSS class that is added to areas that should look like paper.

This is used in print previews and themes are encouraged to style it as black text on white background.

Refer to individual widget documentation for used style classes.

A CSS class that matches popovers.

Refer to individual widget documentation for used style classes.

A CSS class that is added to the toplevel windows used for menus.

Refer to individual widget documentation for used style classes.

A CSS class to match primary toolbars.

Refer to individual widget documentation for used style classes.

A CSS class to use when rendering activity as a progressbar.

Refer to individual widget documentation for used style classes.

A CSS class to use when rendering a pulse in an indeterminate progress bar.

Refer to individual widget documentation for used style classes.

A CSS class for an area displaying a question to the user, such as those in infobars.

Refer to individual widget documentation for used style classes.

A CSS class to match radio buttons.

Refer to individual widget documentation for used style classes.

A CSS class to match a raised control, such as a raised button on a toolbar.

Refer to individual widget documentation for used style classes.

A CSS class used to indicate a read-only state.

Refer to individual widget documentation for used style classes.

A CSS class to indicate an area at the right of a widget.

Refer to individual widget documentation for used style classes.

A CSS class to match the rubberband selection rectangle.

Refer to individual widget documentation for used style classes.

A CSS class to match scale widgets.

Refer to individual widget documentation for used style classes.

A CSS class to match scale widgets with marks attached, all the marks are above for horizontal #GtkScale. left for vertical #GtkScale.

Refer to individual widget documentation for used style classes.

A CSS class to match scale widgets with marks attached, all the marks are below for horizontal #GtkScale, right for vertical #GtkScale.

Refer to individual widget documentation for used style classes.

A CSS class to match scrollbars.

Refer to individual widget documentation for used style classes.

A CSS class to match the junction area between an horizontal and vertical scrollbar, when they’re both shown.

Refer to individual widget documentation for used style classes.

A CSS class for a separator.

Refer to individual widget documentation for used style classes.

A CSS class defining a sidebar, such as the left side in a file chooser.

Refer to individual widget documentation for used style classes.

A CSS class to match sliders.

Refer to individual widget documentation for used style classes.

A CSS class defining an spinbutton.

Refer to individual widget documentation for used style classes.

A CSS class to use when rendering activity as a “spinner”.

Refer to individual widget documentation for used style classes.

A CSS class to match statusbars.

Refer to individual widget documentation for used style classes.

A CSS class used for the subtitle label in a titlebar in a toplevel window.

Refer to individual widget documentation for used style classes.

A CSS class used when an action (usually a button) is the primary suggested action in a specific context.

Refer to individual widget documentation for used style classes.

A CSS class used for the title label in a titlebar in a toplevel window.

Refer to individual widget documentation for used style classes.

A CSS class used when rendering a titlebar in a toplevel window.

Refer to individual widget documentation for used style classes.

A CSS class to match toolbars.

Refer to individual widget documentation for used style classes.

A CSS class to match tooltip windows.

Refer to individual widget documentation for used style classes.

A CSS class to indicate an area at the top of a widget.

Refer to individual widget documentation for used style classes.

A CSS class for touch selection popups on entries and text views.

Refer to individual widget documentation for used style classes.

A CSS class to match troughs, as in scrollbars and progressbars.

Refer to individual widget documentation for used style classes.

A CSS class that is added on the visual hints that happen where content is 'scrolled off' and can be made visible by scrolling.

Refer to individual widget documentation for used style classes.

A CSS class for vertically layered widgets.

Refer to individual widget documentation for used style classes.

A CSS class defining a view, such as iconviews or treeviews.

Refer to individual widget documentation for used style classes.

A CSS class for an area displaying a warning message, such as those in infobars.

Refer to individual widget documentation for used style classes.

A CSS class to indicate that a UI element should be 'wide'. Used by #GtkPaned.

Refer to individual widget documentation for used style classes.

A property holding the background color of rendered elements as a #GdkRGBA.

A property holding the element’s background as a #cairo_pattern_t.

A property holding the element’s border color as a #GdkRGBA.

A property holding the rendered element’s border radius in pixels as a #gint.

A property holding the element’s border style as a #GtkBorderStyle.

A property holding the rendered element’s border width in pixels as a #GtkBorder. The border is the intermediary spacing property of the padding/border/margin series.

[gtk.global.renderFrame] uses this property to find out the frame line width, so #GtkWidgets rendering frames may need to add up this padding when requesting size

A property holding the foreground color of rendered elements as a #GdkRGBA.

A property holding the font properties used when rendering text as a #PangoFontDescription.

A property holding the rendered element’s margin as a #GtkBorder. The margin is defined as the spacing between the border of the element and its surrounding elements. It is external to #GtkWidget's size allocations, and the most external spacing property of the padding/border/margin series.

A property holding the rendered element’s padding as a #GtkBorder. The padding is defined as the spacing between the inner part of the element border and its child. It’s the innermost spacing property of the padding/border/margin series.

A priority that can be used when adding a #GtkStyleProvider 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 #GtkSettings.

This priority is higher than #GTK_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-3.0/gtk.css.

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

A widget region name to define a treeview column.

A widget region name to define a treeview column header.

A widget region name to define a treeview row.

A widget region name to define a notebook tab.

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

The GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID can be used to make a #GtkTreeSortable use the default sort function.

See also [gtk.tree_sortable.TreeSortable.setSortColumnId]

The GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID can be used to make a #GtkTreeSortable use no sorting.

See also [gtk.tree_sortable.TreeSortable.setSortColumnId]