Type Aliases

CSS Provider reference

CSS Provider class

A GtkAllocation-struct of a widget represents region which has been allocated to the widget by its parent. It is a subregion of its parents allocation. See GtkWidget’s geometry management section for more information.

Undocumented

Undocumented

Undocumented

Undocumented

A function used by gtk_assistant_set_forward_page_func() 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_connect_signals() and gtk_builder_connect_signals_full() 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 nil 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_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_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 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_set() (or related functions such as gtk_selection_data_set_text()). 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_request_image() are received, or when the request fails.

A function to be called when the results of gtk_clipboard_request_contents() are received, or when the request fails.

A function to be called when the results of gtk_clipboard_request_rich_text() are received, or when the request fails.

A function to be called when the results of gtk_clipboard_request_targets() are received, or when the request fails.

A function to be called when the results of gtk_clipboard_request_text() are received, or when the request fails.

A function to be called when the results of gtk_clipboard_request_uris() are received, or when the request fails.

ColorSelectionChangePaletteFunc is deprecated: This method is deprecated.

ColorSelectionChangePaletteWithScreenFunc is deprecated: This method is deprecated.

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

The type of function that is used with custom filters, see gtk_file_filter_add_custom().

Called for flow boxes that are bound to a GListModel with gtk_flow_box_bind_model() 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_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 gtk_font_chooser_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.

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_bind_model() for each item that gets added to the model.

Versions of GTK+ prior to 3.18 called gtk_widget_show_all() 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_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 gtk_list_box_row_set_header() or just change the state of the current header widget.

A user function supplied when calling gtk_menu_attach_to_widget() which will be called when the menu is later detached from the widget.

A user function supplied when calling gtk_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_set_monitor() 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.

Each GTK+ module must have a function gtk_module_init() with this prototype. This function is called after loading the module.

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.

Undocumented

Undocumented

The type of function that is used with custom filters, see gtk_recent_filter_add_custom().

Undocumented

Undocumented

A function that is called to deserialize rich text that has been serialized with gtk_text_buffer_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.

Undocumented

Undocumented

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

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

TranslateFunc is deprecated: This method is deprecated.

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

Undocumented

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

Undocumented

Controls how a widget deals with extra space in a single (x or y) dimension.

Alignment only matters if the widget receives a “too large” allocation, for example if you packed the widget with the GtkWidget:expand flag 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 for it is optional for containers and widgets, and it is only supported for vertical alignment. When its not supported by a child or a container it is treated as GTK_ALIGN_FILL.

Used to specify the placement of scroll arrows in scrolling menus.

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

An enum for determining the page role inside the GtkAssistant. It’s 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.

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 verical 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 availible space.

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

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

Used to dictate the style that a GtkButtonBox uses to layout the buttons it contains.

The role specifies the desired appearance of a GtkModelButton.

Prebuilt sets of buttons for the dialog. If none of these choices are appropriate, simply use GTK_BUTTONS_NONE then call gtk_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.

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.

Error codes for GTK_CSS_PROVIDER_ERROR.

The different types of sections indicate parts of a CSS document as parsed by GTK’s CSS parser. They are oriented towards the CSS Grammar, but may contain extensions.

More types might be added in the future as the parser incorporates more features.

See also: GtkEntry::delete-from-cursor.

Focus movement types.

Gives an indication why a drag operation failed. The value can by obtained by connecting to the GtkWidget::drag-failed signal.

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

Describes the state of a GdkEventSequence in a GtkGesture.

Used to specify the style of the expanders drawn by a GtkTreeView.

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

Used as a return value of handlers for the GtkFileChooser::confirm-overwrite signal of a GtkFileChooser. This value determines whether the file chooser will present the stock confirmation dialog, accept the user’s choice of a filename, or let the user choose another filename.

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

Style for input method preedit. See also GtkSettings:gtk-im-preedit-style

IMPreeditStyle is deprecated: This method is deprecated.

Style for input method status. See also GtkSettings:gtk-im-status-style

IMStatusStyle is deprecated: This method is deprecated.

Built-in stock icon sizes.

Error codes for GtkIconTheme operations.

An enum for determining where a dropped item goes.

Describes the image data representation used by a GtkImage. If you want to get the image from the widget, you can only get the currently-stored representation. e.g. if the gtk_image_get_storage_type() returns GTK_IMAGE_PIXBUF, then you can call gtk_image_get_pixbuf() but not gtk_image_get_stock(). 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. (See also GtkAlignment).

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.

An enumeration representing directional movements within a menu.

The type of message being displayed in the dialog.

Undocumented

Undocumented

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

Represents the orientation of widgets and other objects which can be switched between horizontal and vertical orientation on the fly, like GtkToolbar or GtkGesturePan.

Determines how widgets should be packed inside menubars and menuitems contained in menubars.

Represents the packing location GtkBox children. (See: GtkVBox, GtkHBox, and GtkButtonBox).

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

Priorities for path lookups. See also gtk_binding_set_add_path().

PathPriorityType is deprecated: This method is deprecated.

Widget path types. See also gtk_binding_set_add_path().

PathType is deprecated: This method is deprecated.

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

Describes constraints to positioning of popovers. More values may be added to this enumeration in the future.

Describes which edge of a widget a certain feature is positioned at, e.g. the tabs of a GtkNotebook, the handle of a GtkHandleBox 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.

The action parameter to gtk_print_operation_run() determines what action the print operation should perform.

A value of this type is returned by gtk_print_operation_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 the stage at which events are fed into a GtkEventController.

The GtkRcTokenType enumeration represents the tokens in the RC file. It is exposed so that theme engines can reuse these tokens when parsing the theme-engine specific portions of a RC file.

RcTokenType is deprecated: Use #GtkCssProvider instead.

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

Error codes for GtkRecentManager operations

Used to specify the sorting method to be applyed to the recently used resource list.

Indicated the relief to be drawn around a GtkButton.

Undocumented

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.

Undocumented

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 stepper arrows at the end of range widgets.

Used to change the appearance of an outline typically provided by a GtkFrame.

Note that many themes do not differentiate the appearance of the various shadow types: Either their is no visible shadow (GTK_SHADOW_NONE), or there is (any other value).

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.

The spin button update policy determines whether the spin button displays values even if they are outside the bounds of its adjustment. See gtk_spin_button_set_update_policy().

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

These enumeration values describe the possible transitions between pages in a GtkStack widget.

New values may be added to this enumeration over time.

This type indicates the current state of a widget; the state determines how the widget is drawn. The GtkStateType enumeration is also used to identify different colors in a GtkStyle for drawing, so states can be used for subparts of a widget as well as entire widgets.

StateType is deprecated: All APIs that are using this enumeration have been deprecated in favor of alternatives using #GtkStateFlags.

These values are used as “info” for the targets contained in the lists returned by gtk_text_buffer_get_copy_target_list() and gtk_text_buffer_get_paste_target_list().

The values counts down from -1 to avoid clashes with application added drag destinations which usually start at 0.

Reading directions for text.

Granularity types that extend the text selection. Use the GtkTextView::extend-selection signal to customize the selection.

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

Used to reference the parts of GtkTextView.

Whether spacers are vertical lines or just blank.

ToolbarSpaceStyle is deprecated: This method is deprecated.

Used to customize the appearance of a GtkToolbar. Note that setting the toolbar style overrides the user’s preferences for the default toolbar style. Note that if the button has only a label set and GTK_TOOLBAR_ICONS is used, the label will be visible, and vice versa.

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

Kinds of widget-specific help. Used by the show-help signal.

Window placement can be influenced using this enumeration. Note that using GTK_WIN_POS_CENTER_ALWAYS is almost always a bad idea. It won’t necessarily work well with all window managers or on all windowing systems.

A GtkWindow can be one of these types. Most things you’d consider a “window” should have type GTK_WINDOW_TOPLEVEL; windows with this type are managed by the window manager and have a frame by default (call gtk_window_set_decorated() to toggle the frame). Windows with type GTK_WINDOW_POPUP are ignored by the window manager; window manager keybindings won’t work on them, the window manager won’t decorate the window with a frame, many GTK+ features that rely on the window manager will not work (e.g. resize grips and maximization/minimization). GTK_WINDOW_POPUP is used to implement widgets such as GtkMenu or tooltips that you normally don’t think of as windows per se. Nearly all windows should be GTK_WINDOW_TOPLEVEL. In particular, do not use GTK_WINDOW_POPUP just to turn off the window borders; use gtk_window_set_decorated() for that.

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

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

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