Namespace

Gtk – 3.0

The GTK toolkit

Version3.24
AuthorsGTK Development Team
LicenseLGPL-2.1-or-later
Websitehttps://www.gtk.org
Sourcehttps://gitlab.gnome.org/GNOME/gtk/

Build

C headersgtk/gtk-a11y.h, gtk/gtk.h, gtk/gtkx.h
pkg-config filesgtk+-3.0

Dependencies

GObject The base type system library
Browse documentation
Cairo A 2D graphics library with support for multiple output devices
Browse documentation
Pango Text shaping and rendering
Browse documentation
Gdk The GTK windowing system backend
Browse documentation
Atk The Accessibility toolkit
Browse documentation

Classes

AboutDialog

The GtkAboutDialog offers a simple way to display information about a program like its logo, name, copyright, website and license. It is also possible to give credits to the authors, documenters, translators and artists who have worked on the program. An about dialog is typically opened when the user selects the About option from the Help menu. All parts of the dialog are optional.

AccelGroup

A GtkAccelGroup represents a group of keyboard accelerators, typically attached to a toplevel GtkWindow (with gtk_window_add_accel_group()). Usually you won’t need to create a GtkAccelGroup directly; instead, when using GtkUIManager, GTK+ automatically sets up the accelerators for your menus in the ui manager’s GtkAccelGroup.

AccelLabel

The GtkAccelLabel widget is a subclass of GtkLabel that also displays an accelerator key on the right of the label text, e.g. “Ctrl+S”. It is commonly used in menus to show the keyboard short-cuts for commands.

AccelMap

Accelerator maps are used to define runtime configurable accelerators. Functions for manipulating them are are usually used by higher level convenience mechanisms like GtkUIManager and are thus considered “low-level”. You’ll want to use them if you’re manually creating menus that should have user-configurable accelerators.

Accessible

The GtkAccessible class is the base class for accessible implementations for GtkWidget subclasses. It is a thin wrapper around AtkObject, which adds facilities for associating a widget with its accessible object.

Action

In GTK+ 3.10, GtkAction has been deprecated. Use GAction instead, and associate actions with GtkActionable widgets. Use GMenuModel for creating menus with gtk_menu_new_from_model().

ActionBar

GtkActionBar is designed to present contextual actions. It is expected to be displayed below the content and expand horizontally to fill the area.

ActionGroup

Actions are organised into groups. An action group is essentially a map from names to GtkAction objects.

Adjustment

The GtkAdjustment object represents a value which has an associated lower and upper bound, together with step and page increments, and a page size. It is used within several GTK+ widgets, including GtkSpinButton, GtkViewport, and GtkRange (which is a base class for GtkScrollbar and GtkScale).

Alignment

The GtkAlignment widget controls the alignment and size of its child widget. It has four settings: xscale, yscale, xalign, and yalign.

AppChooserButton

The GtkAppChooserButton is a widget that lets the user select an application. It implements the GtkAppChooser interface.

AppChooserDialog

GtkAppChooserDialog shows a GtkAppChooserWidget inside a GtkDialog.

AppChooserWidget

GtkAppChooserWidget is a widget for selecting applications. It is the main building block for GtkAppChooserDialog. Most applications only need to use the latter; but you can use this widget as part of a larger widget if you have special needs.

Application

GtkApplication is a class that handles many important aspects of a GTK+ application in a convenient fashion, without enforcing a one-size-fits-all application model.

ApplicationWindow

GtkApplicationWindow is a GtkWindow subclass that offers some extra functionality for better integration with GtkApplication features. Notably, it can handle both the application menu as well as the menubar. See gtk_application_set_app_menu() and gtk_application_set_menubar().

Arrow

GtkArrow should be used to draw simple arrows that need to point in one of the four cardinal directions (up, down, left, or right). The style of the arrow can be one of shadow in, shadow out, etched in, or etched out. Note that these directions and style types may be amended in versions of GTK+ to come.

ArrowAccessible
AspectFrame

The GtkAspectFrame is useful when you want pack a widget so that it can resize but always retains the same aspect ratio. For instance, one might be drawing a small preview of a larger image. GtkAspectFrame derives from GtkFrame, so it can draw a label and a frame around the child. The frame will be “shrink-wrapped” to the size of the child.

Assistant

A GtkAssistant is a widget used to represent a generally complex operation splitted in several steps, guiding the user through its pages and controlling the page flow to collect the necessary data.

Bin

The GtkBin widget is a container with just one child. It is not very useful itself, but it is useful for deriving subclasses, since it provides common code needed for handling a single child widget.

BooleanCellAccessible
Box

The GtkBox widget arranges child widgets into a single row or column, depending upon the value of its GtkOrientable:orientation property. Within the other dimension, all children are allocated the same size. Of course, the GtkWidget:halign and GtkWidget:valign properties can be used on the children to influence their allocation.

Builder

A GtkBuilder is an auxiliary object that reads textual descriptions of a user interface and instantiates the described objects. To create a GtkBuilder from a user interface description, call gtk_builder_new_from_file(), gtk_builder_new_from_resource() or gtk_builder_new_from_string().

Button

The GtkButton widget is generally used to trigger a callback function that is called when the button is pressed. The various signals and how to use them are outlined below.

ButtonAccessible
ButtonBox
Calendar

GtkCalendar is a widget that displays a Gregorian calendar, one month at a time. It can be created with gtk_calendar_new().

CellAccessible
CellArea

The GtkCellArea is an abstract class for GtkCellLayout widgets (also referred to as “layouting widgets”) to interface with an arbitrary number of GtkCellRenderers and interact with the user for a given GtkTreeModel row.

CellAreaBox

The GtkCellAreaBox renders cell renderers into a row or a column depending on its GtkOrientation.

CellAreaContext

The GtkCellAreaContext object is created by a given GtkCellArea implementation via its GtkCellAreaClass.create_context() virtual method and is used to store cell sizes and alignments for a series of GtkTreeModel rows that are requested and rendered in the same context.

CellRenderer

The GtkCellRenderer is a base class of a set of objects used for rendering a cell to a #cairo_t. These objects are used primarily by the GtkTreeView widget, though they aren’t tied to them in any specific way. It is worth noting that GtkCellRenderer is not a GtkWidget and cannot be treated as such.

CellRendererAccel

GtkCellRendererAccel displays a keyboard accelerator (i.e. a key combination like Control + a). If the cell renderer is editable, the accelerator can be changed by simply typing the new combination.

CellRendererCombo

GtkCellRendererCombo renders text in a cell like GtkCellRendererText from which it is derived. But while GtkCellRendererText offers a simple entry to edit the text, GtkCellRendererCombo offers a GtkComboBox widget to edit the text. The values to display in the combo box are taken from the tree model specified in the GtkCellRendererCombo:model property.

CellRendererPixbuf

A GtkCellRendererPixbuf can be used to render an image in a cell. It allows to render either a given GdkPixbuf (set via the GtkCellRendererPixbuf:pixbuf property) or a named icon (set via the GtkCellRendererPixbuf:icon-name property).

CellRendererProgress

GtkCellRendererProgress renders a numeric value as a progress par in a cell. Additionally, it can display a text on top of the progress bar.

CellRendererSpin

GtkCellRendererSpin renders text in a cell like GtkCellRendererText from which it is derived. But while GtkCellRendererText offers a simple entry to edit the text, GtkCellRendererSpin offers a GtkSpinButton widget. Of course, that means that the text has to be parseable as a floating point number.

CellRendererSpinner

GtkCellRendererSpinner renders a spinning animation in a cell, very similar to GtkSpinner. It can often be used as an alternative to a GtkCellRendererProgress for displaying indefinite activity, instead of actual progress.

CellRendererText

A GtkCellRendererText renders a given text in its cell, using the font, color and style information provided by its properties. The text will be ellipsized if it is too long and the GtkCellRendererText:ellipsize property allows it.

CellRendererToggle

GtkCellRendererToggle renders a toggle button in a cell. The button is drawn as a radio or a checkbutton, depending on the GtkCellRendererToggle:radio property. When activated, it emits the GtkCellRendererToggle::toggled signal.

CellView

A GtkCellView displays a single row of a GtkTreeModel using a GtkCellArea and GtkCellAreaContext. A GtkCellAreaContext can be provided to the GtkCellView at construction time in order to keep the cellview in context of a group of cell views, this ensures that the renderers displayed will be properly aligned with eachother (like the aligned cells in the menus of GtkComboBox).

CheckButton

A GtkCheckButton places a discrete GtkToggleButton next to a widget, (usually a GtkLabel). See the section on GtkToggleButton widgets for more information about toggle/check buttons.

CheckMenuItem

A GtkCheckMenuItem is a menu item that maintains the state of a boolean value in addition to a GtkMenuItem usual role in activating application code.

CheckMenuItemAccessible
Clipboard

The GtkClipboard object represents a clipboard of data shared between different processes or between different widgets in the same process. Each clipboard is identified by a name encoded as a GdkAtom. (Conversion to and from strings can be done with gdk_atom_intern() and gdk_atom_name().) The default clipboard corresponds to the “CLIPBOARD” atom; another commonly used clipboard is the “PRIMARY” clipboard, which, in X, traditionally contains the currently selected text.

ColorButton

The GtkColorButton is a button which displays the currently selected color and allows to open a color selection dialog to change the color. It is suitable widget for selecting a color in a preference dialog.

ColorChooserDialog

The GtkColorChooserDialog widget is a dialog for choosing a color. It implements the GtkColorChooser interface.

ColorChooserWidget

The GtkColorChooserWidget widget lets the user select a color. By default, the chooser presents a predefined palette of colors, plus a small number of settable custom colors. It is also possible to select a different color with the single-color editor. To enter the single-color editing mode, use the context menu of any color of the palette, or use the ‘+’ button to add a new custom color.

ColorSelection
ColorSelectionDialog
ComboBox

A GtkComboBox is a widget that allows the user to choose from a list of valid choices. The GtkComboBox displays the selected choice. When activated, the GtkComboBox displays a popup which allows the user to make a new choice. The style in which the selected value is displayed, and the style of the popup is determined by the current theme. It may be similar to a Windows-style combo box.

ComboBoxAccessible
ComboBoxText

A GtkComboBoxText is a simple variant of GtkComboBox that hides the model-view complexity for simple text-only use cases.

Container

A GTK+ user interface is constructed by nesting widgets inside widgets. Container widgets are the inner nodes in the resulting tree of widgets: they contain other widgets. So, for example, you might have a GtkWindow containing a GtkFrame containing a GtkLabel. If you wanted an image instead of a textual label inside the frame, you might replace the GtkLabel widget with a GtkImage widget.

ContainerAccessible
ContainerCellAccessible
CssProvider

GtkCssProvider is an object implementing the GtkStyleProvider interface. It is able to parse [CSS-like][css-overview] input in order to style widgets.

Dialog

Dialog boxes are a convenient way to prompt the user for a small amount of input, e.g. to display a message, ask a question, or anything else that does not require extensive effort on the user’s part.

DrawingArea

The GtkDrawingArea widget is used for creating custom user interface elements. It’s essentially a blank widget; you can draw on it. After creating a drawing area, the application may want to connect to:

Entry

The GtkEntry widget is a single line text entry widget. A fairly large set of key bindings are supported by default. If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible.

EntryAccessible
EntryBuffer

The GtkEntryBuffer class contains the actual text displayed in a GtkEntry widget.

EntryCompletion

GtkEntryCompletion is an auxiliary object to be used in conjunction with GtkEntry to provide the completion functionality. It implements the GtkCellLayout interface, to allow the user to add extra cells to the GtkTreeView with completion matches.

EntryIconAccessible
EventBox

The GtkEventBox widget is a subclass of GtkBin which also has its own window. It is useful since it allows you to catch events for widgets which do not have their own window.

EventController

GtkEventController is a base, low-level implementation for event controllers. Those react to a series of GdkEvents, and possibly trigger actions as a consequence of those.

EventControllerKey

GtkEventControllerKey is an event controller meant for situations where you need access to key events.

EventControllerMotion

GtkEventControllerMotion is an event controller meant for situations where you need to track the position of the pointer.

EventControllerScroll

GtkEventControllerScroll is an event controller meant to handle scroll events from mice and touchpads. It is capable of handling both discrete and continuous scroll events, abstracting them both on the GtkEventControllerScroll::scroll signal (deltas in the discrete case are multiples of 1).

Expander

A GtkExpander allows the user to hide or show its child by clicking on an expander triangle similar to the triangles used in a GtkTreeView.

ExpanderAccessible
FileChooserButton

The GtkFileChooserButton is a widget that lets the user select a file. It implements the GtkFileChooser interface. Visually, it is a file name with a button to bring up a GtkFileChooserDialog. The user can then use that dialog to change the file associated with that button. This widget does not support setting the GtkFileChooser:select-multiple property to TRUE.

FileChooserDialog

GtkFileChooserDialog is a dialog box suitable for use with “File/Open” or “File/Save as” commands. This widget works by putting a GtkFileChooserWidget inside a GtkDialog. It exposes the GtkFileChooser interface, so you can use all of the GtkFileChooser functions on the file chooser dialog as well as those for GtkDialog.

FileChooserNative

GtkFileChooserNative is an abstraction of a dialog box suitable for use with “File/Open” or “File/Save as” commands. By default, this just uses a GtkFileChooserDialog to implement the actual dialog. However, on certain platforms, such as Windows and macOS, the native platform file chooser is used instead. When the application is running in a sandboxed environment without direct filesystem access (such as Flatpak), GtkFileChooserNative may call the proper APIs (portals) to let the user choose a file and make it available to the application.

FileChooserWidget

GtkFileChooserWidget is a widget for choosing files. It exposes the GtkFileChooser interface, and you should use the methods of this interface to interact with the widget.

FileChooserWidgetAccessible
FileFilter

A GtkFileFilter can be used to restrict the files being shown in a GtkFileChooser. Files can be filtered based on their name (with gtk_file_filter_add_pattern()), on their mime type (with gtk_file_filter_add_mime_type()), or by a custom filter function (with gtk_file_filter_add_custom()).

Fixed

The GtkFixed widget is a container which can place child widgets at fixed positions and with fixed sizes, given in pixels. GtkFixed performs no automatic layout management.

FlowBox

A GtkFlowBox positions child widgets in sequence according to its orientation.

FlowBoxAccessible
FlowBoxChild
FlowBoxChildAccessible
FontButton

The GtkFontButton is a button which displays the currently selected font an allows to open a font chooser dialog to change the font. It is suitable widget for selecting a font in a preference dialog.

FontChooserDialog

The GtkFontChooserDialog widget is a dialog for selecting a font. It implements the GtkFontChooser interface.

FontChooserWidget

The GtkFontChooserWidget widget lists the available fonts, styles and sizes, allowing the user to select a font. It is used in the GtkFontChooserDialog widget to provide a dialog box for selecting fonts.

FontSelection
FontSelectionDialog
Frame

The frame widget is a bin that surrounds its child with a decorative frame and an optional label. If present, the label is drawn in a gap in the top side of the frame. The position of the label can be controlled with gtk_frame_set_label_align().

FrameAccessible
Gesture

GtkGesture is the base object for gesture recognition, although this object is quite generalized to serve as a base for multi-touch gestures, it is suitable to implement single-touch and pointer-based gestures (using the special NULL GdkEventSequence value for these).

GestureDrag

GtkGestureDrag is a GtkGesture implementation that recognizes drag operations. The drag operation itself can be tracked throught the GtkGestureDrag::drag-begin, GtkGestureDrag::drag-update and GtkGestureDrag::drag-end signals, or the relevant coordinates be extracted through gtk_gesture_drag_get_offset() and gtk_gesture_drag_get_start_point().

GestureLongPress

GtkGestureLongPress is a GtkGesture implementation able to recognize long presses, triggering the GtkGestureLongPress::pressed after the timeout is exceeded.

GestureMultiPress

GtkGestureMultiPress is a GtkGesture implementation able to recognize multiple clicks on a nearby zone, which can be listened for through the GtkGestureMultiPress::pressed signal. Whenever time or distance between clicks exceed the GTK+ defaults, GtkGestureMultiPress::stopped is emitted, and the click counter is reset.

GesturePan

GtkGesturePan is a GtkGesture implementation able to recognize pan gestures, those are drags that are locked to happen along one axis. The axis that a GtkGesturePan handles is defined at construct time, and can be changed through gtk_gesture_pan_set_orientation().

GestureRotate

GtkGestureRotate is a GtkGesture implementation able to recognize 2-finger rotations, whenever the angle between both handled sequences changes, the GtkGestureRotate::angle-changed signal is emitted.

GestureSingle

GtkGestureSingle is a subclass of GtkGesture, optimized (although not restricted) for dealing with mouse and single-touch gestures. Under interaction, these gestures stick to the first interacting sequence, which is accessible through gtk_gesture_single_get_current_sequence() while the gesture is being interacted with.

GestureStylus

GtkGestureStylus is a GtkGesture implementation specific to stylus input. The provided signals just provide the basic information.

GestureSwipe

GtkGestureSwipe is a GtkGesture implementation able to recognize swipes, after a press/move/…/move/release sequence happens, the GtkGestureSwipe::swipe signal will be emitted, providing the velocity and directionality of the sequence at the time it was lifted.

GestureZoom

GtkGestureZoom is a GtkGesture implementation able to recognize pinch/zoom gestures, whenever the distance between both tracked sequences changes, the GtkGestureZoom::scale-changed signal is emitted to report the scale factor.

GLArea

GtkGLArea is a widget that allows drawing with OpenGL.

Grid

GtkGrid is a container which arranges its child widgets in rows and columns, with arbitrary positions and horizontal/vertical spans.

HandleBox

The GtkHandleBox widget allows a portion of a window to be “torn off”. It is a bin widget which displays its child and a handle that the user can drag to tear off a separate window (the “float window”) containing the child widget. A thin “ghost” is drawn in the original location of the handlebox. By dragging the separate window back to its original location, it can be reattached.

HBox

GtkHBox is a container that organizes child widgets into a single row.

HButtonBox
HeaderBar

GtkHeaderBar is similar to a horizontal GtkBox. It allows children to be placed at the start or the end. In addition, it allows a title and subtitle to be displayed. The title will be centered with respect to the width of the box, even if the children at either side take up different amounts of space. The height of the titlebar will be set to provide sufficient space for the subtitle, even if none is currently set. If a subtitle is not needed, the space reservation can be turned off with gtk_header_bar_set_has_subtitle().

HeaderBarAccessible
HPaned

The HPaned widget is a container widget with two children arranged horizontally. The division between the two panes is adjustable by the user by dragging a handle. See GtkPaned for details.

HScale

The GtkHScale widget is used to allow the user to select a value using a horizontal slider. To create one, use gtk_hscale_new_with_range().

HScrollbar

The GtkHScrollbar widget is a widget arranged horizontally creating a scrollbar. See GtkScrollbar for details on scrollbars. GtkAdjustment pointers may be added to handle the adjustment of the scrollbar or it may be left NULL in which case one will be created for you. See GtkScrollbar for a description of what the fields in an adjustment represent for a scrollbar.

HSeparator

The GtkHSeparator widget is a horizontal separator, used to group the widgets within a window. It displays a horizontal line with a shadow to make it appear sunken into the interface.

HSV

GtkHSV is the “color wheel” part of a complete color selector widget. It allows to select a color by determining its HSV components in an intuitive way. Moving the selection around the outer ring changes the hue, and moving the selection point inside the inner triangle changes value and saturation.

IconFactory

An icon factory manages a collection of GtkIconSet; a GtkIconSet manages a set of variants of a particular icon (i.e. a GtkIconSet contains variants for different sizes and widget states). Icons in an icon factory are named by a stock ID, which is a simple string identifying the icon. Each GtkStyle has a list of GtkIconFactory derived from the current theme; those icon factories are consulted first when searching for an icon. If the theme doesn’t set a particular icon, GTK+ looks for the icon in a list of default icon factories, maintained by gtk_icon_factory_add_default() and gtk_icon_factory_remove_default(). Applications with icons should add a default icon factory with their icons, which will allow themes to override the icons for the application.

IconInfo

Contains information found when looking up an icon in an icon theme.

IconTheme

GtkIconTheme provides a facility for looking up icons by name and size. The main reason for using a name rather than simply providing a filename is to allow different icons to be used depending on what “icon theme” is selected by the user. The operation of icon themes on Linux and Unix follows the Icon Theme Specification There is a fallback icon theme, named hicolor, where applications should install their icons, but additional icon themes can be installed as operating system vendors and users choose.

IconView

GtkIconView provides an alternative view on a GtkTreeModel. It displays the model as a grid of icons with labels. Like GtkTreeView, it allows to select one or multiple items (depending on the selection mode, see gtk_icon_view_set_selection_mode()). In addition to selection with the arrow keys, GtkIconView supports rubberband selection, which is controlled by dragging the pointer.

IconViewAccessible
Image

The GtkImage widget displays an image. Various kinds of object can be displayed as an image; most typically, you would load a GdkPixbuf (“pixel buffer”) from a file, and then display that. There’s a convenience function to do this, gtk_image_new_from_file(), used as follows:

  GtkWidget *image;
  image = gtk_image_new_from_file ("myfile.png");

If the file isn’t loaded successfully, the image will contain a “broken image” icon similar to that used in many web browsers. If you want to handle errors in loading the file yourself, for example by displaying an error message, then load the image with gdk_pixbuf_new_from_file(), then create the GtkImage with gtk_image_new_from_pixbuf().

ImageAccessible
ImageCellAccessible
ImageMenuItem

A GtkImageMenuItem is a menu item which has an icon next to the text label.

IMContext

GtkIMContext defines the interface for GTK+ input methods. An input method is used by GTK+ text input widgets like GtkEntry to map from key events to Unicode character strings.

IMContextSimple

GtkIMContextSimple is a simple input method context supporting table-based input methods. It has a built-in table of compose sequences that is derived from the X11 Compose files.

IMMulticontext
InfoBar

GtkInfoBar is a widget that can be used to show messages to the user without showing a dialog. It is often temporarily shown at the top or bottom of a document. In contrast to GtkDialog, which has a action area at the bottom, GtkInfoBar has an action area at the side.

Invisible

The GtkInvisible widget is used internally in GTK+, and is probably not very useful for application developers.

Label

The GtkLabel widget displays a small amount of text. As the name implies, most labels are used to label another widget such as a GtkButton, a GtkMenuItem, or a GtkComboBox.

LabelAccessible
Layout

GtkLayout is similar to GtkDrawingArea in that it’s a “blank slate” and doesn’t do anything except paint a blank background by default. It’s different in that it supports scrolling natively due to implementing GtkScrollable, and can contain child widgets since it’s a GtkContainer.

LevelBar

The GtkLevelBar is a bar widget that can be used as a level indicator. Typical use cases are displaying the strength of a password, or showing the charge level of a battery.

LevelBarAccessible
LinkButton

A GtkLinkButton is a GtkButton with a hyperlink, similar to the one used by web browsers, which triggers an action when clicked. It is useful to show quick links to resources.

LinkButtonAccessible
ListBox

A GtkListBox is a vertical container that contains GtkListBoxRow children. These rows can be dynamically sorted and filtered, and headers can be added dynamically depending on the row content. It also allows keyboard and mouse navigation and selection like a typical list.

ListBoxAccessible
ListBoxRow
ListBoxRowAccessible
ListStore

The GtkListStore object is a list model for use with a GtkTreeView widget. It implements the GtkTreeModel interface, and consequentialy, can use all of the methods available there. It also implements the GtkTreeSortable interface so it can be sorted by the view. Finally, it also implements the tree [drag and drop][gtk3-GtkTreeView-drag-and-drop] interfaces.

LockButton

GtkLockButton is a widget that can be used in control panels or preference dialogs to allow users to obtain and revoke authorizations needed to operate the controls. The required authorization is represented by a GPermission object. Concrete implementations of GPermission may use PolicyKit or some other authorization framework. To obtain a PolicyKit-based GPermission, use polkit_permission_new().

LockButtonAccessible
Menu

A GtkMenu is a GtkMenuShell that implements a drop down menu consisting of a list of GtkMenuItem objects which can be navigated and activated by the user to perform application functions.

MenuAccessible
MenuBar

The GtkMenuBar is a subclass of GtkMenuShell which contains one or more GtkMenuItems. The result is a standard menu bar which can hold many menu items.

MenuButton

The GtkMenuButton widget is used to display a popup when clicked on. This popup can be provided either as a GtkMenu, a GtkPopover or an abstract GMenuModel.

MenuButtonAccessible
MenuItem

The GtkMenuItem widget and the derived widgets are the only valid children for menus. Their function is to correctly handle highlighting, alignment, events and submenus.

MenuItemAccessible
MenuShell

A GtkMenuShell is the abstract base class used to derive the GtkMenu and GtkMenuBar subclasses.

MenuShellAccessible
MenuToolButton

A GtkMenuToolButton is a GtkToolItem that contains a button and a small additional button with an arrow. When clicked, the arrow button pops up a dropdown menu.

MessageDialog

GtkMessageDialog presents a dialog with some message text. It’s simply a convenience widget; you could construct the equivalent of GtkMessageDialog from GtkDialog without too much effort, but GtkMessageDialog saves typing.

Misc

The GtkMisc widget is an abstract widget which is not useful itself, but is used to derive subclasses which have alignment and padding attributes.

ModelButton

GtkModelButton is a button class that can use a GAction as its model. In contrast to GtkToggleButton or GtkRadioButton, which can also be backed by a GAction via the GtkActionable:action-name property, GtkModelButton will adapt its appearance according to the kind of action it is backed by, and appear either as a plain, check or radio button.

MountOperation

This should not be accessed directly. Use the accessor functions below.

NativeDialog

Native dialogs are platform dialogs that don’t use GtkDialog or GtkWindow. They are used in order to integrate better with a platform, by looking the same as other native applications and supporting platform specific features.

Notebook

The GtkNotebook widget is a GtkContainer whose children are pages that can be switched between using tab labels along one edge.

NotebookAccessible
NotebookPageAccessible
NumerableIcon

GtkNumerableIcon is a subclass of GEmblemedIcon that can show a number or short string as an emblem. The number can be overlayed on top of another emblem, if desired.

OffscreenWindow

GtkOffscreenWindow is strictly intended to be used for obtaining snapshots of widgets that are not part of a normal widget hierarchy. Since GtkOffscreenWindow is a toplevel widget you cannot obtain snapshots of a full window with it since you cannot pack a toplevel widget in another toplevel.

Overlay

GtkOverlay is a container which contains a single main child, on top of which it can place “overlay” widgets. The position of each overlay widget is determined by its GtkWidget:halign and GtkWidget:valign properties. E.g. a widget with both alignments set to GTK_ALIGN_START will be placed at the top left corner of the GtkOverlay container, whereas an overlay with halign set to GTK_ALIGN_CENTER and valign set to GTK_ALIGN_END will be placed a the bottom edge of the GtkOverlay, horizontally centered. The position can be adjusted by setting the margin properties of the child to non-zero values.

PadController

GtkPadController is an event controller for the pads found in drawing tablets (The collection of buttons and tactile sensors often found around the stylus-sensitive area).

PageSetup

A GtkPageSetup object stores the page size, orientation and margins. The idea is that you can get one of these from the page setup dialog and then pass it to the GtkPrintOperation when printing. The benefit of splitting this out of the GtkPrintSettings is that these affect the actual layout of the page, and thus need to be set long before user prints.

Paned

GtkPaned has two panes, arranged either horizontally or vertically. The division between the two panes is adjustable by the user by dragging a handle.

PanedAccessible
PlacesSidebar

GtkPlacesSidebar is a widget that displays a list of frequently-used places in the file system: the user’s home directory, the user’s bookmarks, and volumes and drives. This widget is used as a sidebar in GtkFileChooser and may be used by file managers and similar programs.

Plug

Together with GtkSocket, GtkPlug provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user. One process creates a GtkSocket widget and passes the ID of that widget’s window to the other process, which then creates a GtkPlug with that window ID. Any widgets contained in the GtkPlug then will appear inside the first application’s window.

PlugAccessible
Popover

GtkPopover is a bubble-like context window, primarily meant to provide context-dependent information or options. Popovers are attached to a widget, passed at construction time on gtk_popover_new(), or updated afterwards through gtk_popover_set_relative_to(), by default they will point to the whole widget area, although this behavior can be changed through gtk_popover_set_pointing_to().

PopoverAccessible
PopoverMenu

GtkPopoverMenu is a subclass of GtkPopover that treats its children like menus and allows switching between them. It is meant to be used primarily together with GtkModelButton, but any widget can be used, such as GtkSpinButton or GtkScale. In this respect, GtkPopoverMenu is more flexible than popovers that are created from a GMenuModel with gtk_popover_new_from_model().

PrintContext

A GtkPrintContext encapsulates context information that is required when drawing pages for printing, such as the cairo context and important parameters like page size and resolution. It also lets you easily create PangoLayout and PangoContext objects that match the font metrics of the cairo surface.

PrintOperation

GtkPrintOperation is the high-level, portable printing API. It looks a bit different than other GTK+ dialogs such as the GtkFileChooser, since some platforms don’t expose enough infrastructure to implement a good print dialog. On such platforms, GtkPrintOperation uses the native print dialog. On platforms which do not provide a native print dialog, GTK+ uses its own, see GtkPrintUnixDialog.

PrintSettings

A GtkPrintSettings object represents the settings of a print dialog in a system-independent way. The main use for this object is that once you’ve printed you can get a settings object that represents the settings the user chose, and the next time you print you can pass that object in so that the user doesn’t have to re-set all his settings.

ProgressBar

The GtkProgressBar is typically used to display the progress of a long running operation. It provides a visual clue that processing is underway. The GtkProgressBar can be used in two different modes: percentage mode and activity mode.

ProgressBarAccessible
RadioAction

A GtkRadioAction is similar to GtkRadioMenuItem. A number of radio actions can be linked together so that only one may be active at any one time.

RadioButton

A single radio button performs the same basic function as a GtkCheckButton, as its position in the object hierarchy reflects. It is only when multiple radio buttons are grouped together that they become a different user interface component in their own right.

RadioButtonAccessible
RadioMenuItem

A radio menu item is a check menu item that belongs to a group. At each instant exactly one of the radio menu items from a group is selected.

RadioMenuItemAccessible
RadioToolButton

A GtkRadioToolButton is a GtkToolItem that contains a radio button, that is, a button that is part of a group of toggle buttons where only one button can be active at a time.

Range

GtkRange is the common base class for widgets which visualize an adjustment, e.g GtkScale or GtkScrollbar.

RangeAccessible
RcStyle

The GtkRcStyle-struct is used to represent a set of information about the appearance of a widget. This can later be composited together with other GtkRcStyle-structs to form a GtkStyle.

RecentAction

A GtkRecentAction represents a list of recently used files, which can be shown by widgets such as GtkRecentChooserDialog or GtkRecentChooserMenu.

RecentChooserDialog

GtkRecentChooserDialog is a dialog box suitable for displaying the recently used documents. This widgets works by putting a GtkRecentChooserWidget inside a GtkDialog. It exposes the GtkRecentChooserIface interface, so you can use all the GtkRecentChooser functions on the recent chooser dialog as well as those for GtkDialog.

RecentChooserMenu

GtkRecentChooserMenu is a widget suitable for displaying recently used files inside a menu. It can be used to set a sub-menu of a GtkMenuItem using gtk_menu_item_set_submenu(), or as the menu of a GtkMenuToolButton.

RecentChooserWidget

GtkRecentChooserWidget is a widget suitable for selecting recently used files. It is the main building block of a GtkRecentChooserDialog. Most applications will only need to use the latter; you can use GtkRecentChooserWidget as part of a larger window if you have special needs.

RecentFilter

A GtkRecentFilter can be used to restrict the files being shown in a GtkRecentChooser. Files can be filtered based on their name (with gtk_recent_filter_add_pattern()), on their mime type (with gtk_file_filter_add_mime_type()), on the application that has registered them (with gtk_recent_filter_add_application()), or by a custom filter function (with gtk_recent_filter_add_custom()).

RecentManager

GtkRecentManager provides a facility for adding, removing and looking up recently used files. Each recently used file is identified by its URI, and has meta-data associated to it, like the names and command lines of the applications that have registered it, the number of time each application has registered the same file, the mime type of the file and whether the file should be displayed only by the applications that have registered it.

RendererCellAccessible
Revealer

The GtkRevealer widget is a container which animates the transition of its child from invisible to visible.

Scale

A GtkScale is a slider control used to select a numeric value. To use it, you’ll probably want to investigate the methods on its base class, GtkRange, in addition to the methods for GtkScale itself. To set the value of a scale, you would normally use gtk_range_set_value(). To detect changes to the value, you would normally use the GtkRange::value-changed signal.

ScaleAccessible
ScaleButton

GtkScaleButton provides a button which pops up a scale widget. This kind of widget is commonly used for volume controls in multimedia applications, and GTK+ provides a GtkVolumeButton subclass that is tailored for this use case.

ScaleButtonAccessible
Scrollbar

The GtkScrollbar widget is a horizontal or vertical scrollbar, depending on the value of the GtkOrientable:orientation property.

ScrolledWindow

GtkScrolledWindow is a container that accepts a single child widget, makes that child scrollable using either internally added scrollbars or externally associated adjustments, and optionally draws a frame around the child.

ScrolledWindowAccessible
SearchBar

GtkSearchBar is a container made to have a search entry (possibly with additional connex widgets, such as drop-down menus, or buttons) built-in. The search bar would appear when a search is started through typing on the keyboard, or the application’s search mode is toggled on.

SearchEntry

GtkSearchEntry is a subclass of GtkEntry that has been tailored for use as a search entry.

Separator

GtkSeparator is a horizontal or vertical separator widget, depending on the value of the GtkOrientable:orientation property, used to group the widgets within a window. It displays a line with a shadow to make it appear sunken into the interface.

SeparatorMenuItem

The GtkSeparatorMenuItem is a separator used to group items within a menu. It displays a horizontal line with a shadow to make it appear sunken into the interface.

SeparatorToolItem

A GtkSeparatorToolItem is a GtkToolItem that separates groups of other GtkToolItems. Depending on the theme, a GtkSeparatorToolItem will often look like a vertical line on horizontally docked toolbars.

Settings

GtkSettings provide a mechanism to share global settings between applications.

ShortcutLabel

GtkShortcutLabel is a widget that represents a single keyboard shortcut or gesture in the user interface.

ShortcutsGroup

A GtkShortcutsGroup represents a group of related keyboard shortcuts or gestures. The group has a title. It may optionally be associated with a view of the application, which can be used to show only relevant shortcuts depending on the application context.

ShortcutsSection

A GtkShortcutsSection collects all the keyboard shortcuts and gestures for a major application mode. If your application needs multiple sections, you should give each section a unique GtkShortcutsSection:section-name and a GtkShortcutsSection:title that can be shown in the section selector of the GtkShortcutsWindow.

ShortcutsShortcut

A GtkShortcutsShortcut represents a single keyboard shortcut or gesture with a short text. This widget is only meant to be used with GtkShortcutsWindow.

ShortcutsWindow

A GtkShortcutsWindow shows brief information about the keyboard shortcuts and gestures of an application. The shortcuts can be grouped, and you can have multiple sections in this window, corresponding to the major modes of your application.

SizeGroup

GtkSizeGroup provides a mechanism for grouping a number of widgets together so they all request the same amount of space. This is typically useful when you want a column of widgets to have the same size, but you can’t use a GtkGrid widget.

Socket

Together with GtkPlug, GtkSocket provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user. One process creates a GtkSocket widget and passes that widget’s window ID to the other process, which then creates a GtkPlug with that window ID. Any widgets contained in the GtkPlug then will appear inside the first application’s window.

SocketAccessible
SpinButton

A GtkSpinButton is an ideal way to allow the user to set the value of some attribute. Rather than having to directly type a number into a GtkEntry, GtkSpinButton allows the user to click on one of two arrows to increment or decrement the displayed value. A value can still be typed in, with the bonus that it can be checked to ensure it is in a given range.

SpinButtonAccessible
Spinner

A GtkSpinner widget displays an icon-size spinning animation. It is often used as an alternative to a GtkProgressBar for displaying indefinite activity, instead of actual progress.

SpinnerAccessible
Stack

The GtkStack widget is a container which only shows one of its children at a time. In contrast to GtkNotebook, GtkStack does not provide a means for users to change the visible child. Instead, the GtkStackSwitcher widget can be used with GtkStack to provide this functionality.

StackAccessible
StackSidebar

A GtkStackSidebar enables you to quickly and easily provide a consistent “sidebar” object for your user interface.

StackSwitcher

The GtkStackSwitcher widget acts as a controller for a GtkStack; it shows a row of buttons to switch between the various pages of the associated stack widget.

Statusbar

A GtkStatusbar is usually placed along the bottom of an application’s main GtkWindow. It may provide a regular commentary of the application’s status (as is usually the case in a web browser, for example), or may be used to simply output a message when the status changes, (when an upload is complete in an FTP client, for example).

StatusbarAccessible
StatusIcon

The “system tray” or notification area is normally used for transient icons that indicate some special state. For example, a system tray icon might appear to tell the user that they have new mail, or have an incoming instant message, or something along those lines. The basic idea is that creating an icon in the notification area is less annoying than popping up a dialog.

Style

A GtkStyle object encapsulates the information that provides the look and feel for a widget.

StyleContext

GtkStyleContext is an object that stores styling information affecting a widget defined by GtkWidgetPath.

StyleProperties

GtkStyleProperties provides the storage for style information that is used by GtkStyleContext and other GtkStyleProvider implementations.

Switch

GtkSwitch is a widget that has two states: on or off. The user can control which state should be active by clicking the empty area, or by dragging the handle.

SwitchAccessible
Table

The GtkTable functions allow the programmer to arrange widgets in rows and columns, making it easy to align many widgets next to each other, horizontally and vertically.

TearoffMenuItem

A GtkTearoffMenuItem is a special GtkMenuItem which is used to tear off and reattach its menu.

TextBuffer

You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together.

TextCellAccessible
TextChildAnchor

A GtkTextChildAnchor is a spot in the buffer where child widgets can be “anchored” (inserted inline, as if they were characters). The anchor can have multiple widgets anchored, to allow for multiple views.

TextMark

You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together.

TextTag

You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together.

TextTagTable

You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together.

TextView

You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together.

TextViewAccessible
ThemingEngine

GtkThemingEngine was the object used for rendering themed content in GTK+ widgets. It used to allow overriding GTK+’s default implementation of rendering functions by allowing engines to be loaded as modules.

ToggleAction

A GtkToggleAction corresponds roughly to a GtkCheckMenuItem. It has an “active” state specifying whether the action has been checked or not.

ToggleButton

A GtkToggleButton is a GtkButton which will remain “pressed-in” when clicked. Clicking again will cause the toggle button to return to its normal state.

ToggleButtonAccessible
ToggleToolButton

A GtkToggleToolButton is a GtkToolItem that contains a toggle button.

Toolbar

A toolbar is created with a call to gtk_toolbar_new().

ToolButton

GtkToolButtons are GtkToolItems containing buttons.

ToolItem

GtkToolItems are widgets that can appear on a toolbar. To create a toolbar item that contain something else than a button, use gtk_tool_item_new(). Use gtk_container_add() to add a child widget to the tool item.

ToolItemGroup

A GtkToolItemGroup is used together with GtkToolPalette to add GtkToolItems to a palette like container with different categories and drag and drop support.

ToolPalette

A GtkToolPalette allows you to add GtkToolItems to a palette-like container with different categories and drag and drop support.

Tooltip

Basic tooltips can be realized simply by using gtk_widget_set_tooltip_text() or gtk_widget_set_tooltip_markup() without any explicit tooltip object.

ToplevelAccessible
TreeModelFilter

A GtkTreeModelFilter is a tree model which wraps another tree model, and can do the following things:

TreeModelSort

The GtkTreeModelSort is a model which implements the GtkTreeSortable interface. It does not hold any data itself, but rather is created with a child model and proxies its data. It has identical column types to this child model, and the changes in the child are propagated. The primary purpose of this model is to provide a way to sort a different model without modifying it. Note that the sort function used by GtkTreeModelSort is not guaranteed to be stable.

TreeSelection

The GtkTreeSelection object is a helper object to manage the selection for a GtkTreeView widget. The GtkTreeSelection object is automatically created when a new GtkTreeView widget is created, and cannot exist independently of this widget. The primary reason the GtkTreeSelection objects exists is for cleanliness of code and API. That is, there is no conceptual reason all these functions could not be methods on the GtkTreeView widget instead of a separate function.

TreeStore

The GtkTreeStore object is a list model for use with a GtkTreeView widget. It implements the GtkTreeModel interface, and consequentially, can use all of the methods available there. It also implements the GtkTreeSortable interface so it can be sorted by the view. Finally, it also implements the tree [drag and drop][gtk3-GtkTreeView-drag-and-drop] interfaces.

TreeView

Widget that displays any object that implements the GtkTreeModel interface.

TreeViewAccessible
TreeViewColumn

The GtkTreeViewColumn object represents a visible column in a GtkTreeView widget. It allows to set properties of the column header, and functions as a holding pen for the cell renderers which determine how the data in the column is displayed.

UIManager

A GtkUIManager constructs a user interface (menus and toolbars) from one or more UI definitions, which reference actions from one or more action groups.

VBox

A GtkVBox is a container that organizes child widgets into a single column.

VButtonBox
Viewport

The GtkViewport widget acts as an adaptor class, implementing scrollability for child widgets that lack their own scrolling capabilities. Use GtkViewport to scroll child widgets such as GtkGrid, GtkBox, and so on.

VolumeButton

GtkVolumeButton is a subclass of GtkScaleButton that has been tailored for use as a volume control widget with suitable icons, tooltips and accessible labels.

VPaned

The VPaned widget is a container widget with two children arranged vertically. The division between the two panes is adjustable by the user by dragging a handle. See GtkPaned for details.

VScale

The GtkVScale widget is used to allow the user to select a value using a vertical slider. To create one, use gtk_hscale_new_with_range().

VScrollbar

The GtkVScrollbar widget is a widget arranged vertically creating a scrollbar. See GtkScrollbar for details on scrollbars. GtkAdjustment pointers may be added to handle the adjustment of the scrollbar or it may be left NULL in which case one will be created for you. See GtkScrollbar for a description of what the fields in an adjustment represent for a scrollbar.

VSeparator

The GtkVSeparator widget is a vertical separator, used to group the widgets within a window. It displays a vertical line with a shadow to make it appear sunken into the interface.

Widget

GtkWidget is the base class all widgets in GTK+ derive from. It manages the widget lifecycle, states and style.

WidgetAccessible
Window

A GtkWindow is a toplevel window which can contain other widgets. Windows normally have decorations that are under the control of the windowing system and allow the user to manipulate the window (resize it, move it, close it,…).

WindowAccessible
WindowGroup

A GtkWindowGroup restricts the effect of grabs to windows in the same group, thereby making window groups almost behave like separate applications.

Interfaces

Actionable

This interface provides a convenient way of associating widgets with actions on a GtkApplicationWindow or GtkApplication.

Activatable

Activatable widgets can be connected to a GtkAction and reflects the state of its action. A GtkActivatable can also provide feedback through its action, as they are responsible for activating their related actions.

AppChooser

GtkAppChooser is an interface that can be implemented by widgets which allow the user to choose an application (typically for the purpose of opening a file). The main objects that implement this interface are GtkAppChooserWidget, GtkAppChooserDialog and GtkAppChooserButton.

Buildable

GtkBuildable allows objects to extend and customize their deserialization from [GtkBuilder UI descriptions][BUILDER-UI]. The interface includes methods for setting names and properties of objects, parsing custom tags and constructing child objects.

CellAccessibleParent
CellEditable

The GtkCellEditable interface must be implemented for widgets to be usable to edit the contents of a GtkTreeView cell. It provides a way to specify how temporary widgets should be configured for editing, get the new value, etc.

CellLayout

GtkCellLayout is an interface to be implemented by all objects which want to provide a GtkTreeViewColumn like API for packing cells, setting attributes and data funcs.

ColorChooser

GtkColorChooser is an interface that is implemented by widgets for choosing colors. Depending on the situation, colors may be allowed to have alpha (translucency).

Editable

The GtkEditable interface is an interface which should be implemented by text editing widgets, such as GtkEntry and GtkSpinButton. It contains functions for generically manipulating an editable widget, a large number of action signals used for key bindings, and several signals that an application can connect to to modify the behavior of a widget.

FileChooser

GtkFileChooser is an interface that can be implemented by file selection widgets. In GTK+, the main objects that implement this interface are GtkFileChooserWidget, GtkFileChooserDialog, and GtkFileChooserButton. You do not need to write an object that implements the GtkFileChooser interface unless you are trying to adapt an existing file selector to expose a standard programming interface.

FontChooser

GtkFontChooser is an interface that can be implemented by widgets displaying the list of fonts. In GTK+, the main objects that implement this interface are GtkFontChooserWidget, GtkFontChooserDialog and GtkFontButton. The GtkFontChooser interface has been introducted in GTK+ 3.2.

Orientable

The GtkOrientable interface is implemented by all widgets that can be oriented horizontally or vertically. Historically, such widgets have been realized as subclasses of a common base class (e.g GtkBox/GtkHBox/GtkVBox or GtkScale/GtkHScale/GtkVScale). GtkOrientable is more flexible in that it allows the orientation to be changed at runtime, allowing the widgets to “flip”.

PrintOperationPreview
RecentChooser

GtkRecentChooser is an interface that can be implemented by widgets displaying the list of recently used files. In GTK+, the main objects that implement this interface are GtkRecentChooserWidget, GtkRecentChooserDialog and GtkRecentChooserMenu.

Scrollable

GtkScrollable is an interface that is implemented by widgets with native scrolling ability.

StyleProvider

GtkStyleProvider is an interface used to provide style information to a GtkStyleContext. See gtk_style_context_add_provider() and gtk_style_context_add_provider_for_screen().

ToolShell

The GtkToolShell interface allows container widgets to provide additional information when embedding GtkToolItem widgets.

TreeDragDest
TreeDragSource
TreeModel

The GtkTreeModel interface defines a generic tree interface for use by the GtkTreeView widget. It is an abstract interface, and is designed to be usable with any appropriate data structure. The programmer just has to implement this interface on their own data type for it to be viewable by a GtkTreeView widget.

TreeSortable

GtkTreeSortable is an interface to be implemented by tree models which support sorting. The GtkTreeView uses the methods provided by this interface to sort the model.

Structs

_MountOperationHandler

Abstract interface type for the D-Bus interface org.Gtk.MountOperationHandler.

_MountOperationHandlerIface

Virtual table for the D-Bus interface org.Gtk.MountOperationHandler.

_MountOperationHandlerProxy

The #_GtkMountOperationHandlerProxy structure contains only private data and should only be accessed using the provided API.

_MountOperationHandlerProxyClass

Class structure for #_GtkMountOperationHandlerProxy.

_MountOperationHandlerSkeleton

The #_GtkMountOperationHandlerSkeleton structure contains only private data and should only be accessed using the provided API.

_MountOperationHandlerSkeletonClass

Class structure for #_GtkMountOperationHandlerSkeleton.

AccelGroupEntry
AccelKey
ActionEntry

GtkActionEntry structs are used with gtk_action_group_add_actions() to construct actions.

BindingArg

A GtkBindingArg holds the data associated with an argument for a key binding signal emission as stored in GtkBindingSignal.

BindingEntry

Each key binding element of a binding sets binding list is represented by a GtkBindingEntry.

BindingSet

A binding set maintains a list of activatable key bindings. A single binding set can match multiple types of widgets. Similar to style contexts, can be matched by any information contained in a widgets GtkWidgetPath. When a binding within a set is matched upon activation, an action signal is emitted on the target widget to carry out the actual activation.

BindingSignal

A GtkBindingSignal stores the necessary information to activate a widget in response to a key press via a signal emission.

Border

A struct that specifies a border around a rectangular area that can be of different width on each side.

CssSection

Defines a part of a CSS document. Because sections are nested into one another, you can use gtk_css_section_get_parent() to get the containing region.

FileFilterInfo

A GtkFileFilterInfo-struct is used to pass information about the tested file to gtk_file_filter_filter().

FixedChild
Gradient

GtkGradient is a boxed type that represents a gradient. It is the result of parsing a [gradient expression][gtkcssprovider-gradients]. To obtain the gradient represented by a GtkGradient, it has to be resolved with gtk_gradient_resolve(), which replaces all symbolic color references by the colors they refer to (in a given context) and constructs a #cairo_pattern_t value.

IconSet
IconSource
IMContextInfo

Bookkeeping information about a loadable input method.

LabelSelectionInfo
PadActionEntry

Struct defining a pad action entry.

PageRange

See also gtk_print_settings_set_page_ranges().

PaperSize

GtkPaperSize handles paper sizes. It uses the standard called PWG 5101.1-2002 PWG: Standard for Media Standardized Names to name the paper sizes (and to get the data for the page sizes). In addition to standard paper sizes, GtkPaperSize allows to construct custom paper sizes with arbitrary dimensions.

RadioActionEntry

GtkRadioActionEntry structs are used with gtk_action_group_add_radio_actions() to construct groups of radio actions.

RcContext
RcProperty

Deprecated.

RecentData

Meta-data to be passed to gtk_recent_manager_add_full() when registering a recently used resource.

RecentFilterInfo

A GtkRecentFilterInfo struct is used to pass information about the tested file to gtk_recent_filter_filter().

RecentInfo

GtkRecentInfo-struct contains private data only, and should be accessed using the provided API.

RequestedSize

Represents a request of a screen object in a given orientation. These are primarily used in container implementations when allocating a natural size for children calling. See gtk_distribute_natural_allocation().

Requisition

A GtkRequisition-struct represents the desired size of a widget. See [GtkWidget’s geometry management section][geometry-management] for more information.

SelectionData
SettingsValue
StockItem
SymbolicColor

GtkSymbolicColor is a boxed type that represents a symbolic color. It is the result of parsing a [color expression][gtkcssprovider-symbolic-colors]. To obtain the color represented by a GtkSymbolicColor, it has to be resolved with gtk_symbolic_color_resolve(), which replaces all symbolic color references by the colors they refer to (in a given context) and evaluates mix, shade and other expressions, resulting in a GdkRGBA value.

TableChild
TableRowCol
TargetEntry

A GtkTargetEntry represents a single type of data than can be supplied for by a widget for a selection or for supplied or received during drag-and-drop.

TargetList

A GtkTargetList-struct is a reference counted list of GtkTargetPair and should be treated as opaque.

TargetPair

A GtkTargetPair is used to represent the same information as a table of GtkTargetEntry, but in an efficient form.

TextAppearance
TextAttributes

Using GtkTextAttributes directly should rarely be necessary. It’s primarily useful with gtk_text_iter_get_attributes(). As with most GTK+ structs, the fields in this struct should only be read, never modified directly.

TextBTree
TextIter

You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together.

ThemeEngine
ToggleActionEntry

GtkToggleActionEntry structs are used with gtk_action_group_add_toggle_actions() to construct toggle actions.

TreeIter

The GtkTreeIter is the primary structure for accessing a GtkTreeModel. Models are expected to put a unique integer in the stamp member, and put model-specific data in the three user_data members.

TreePath
TreeRowReference

A GtkTreeRowReference tracks model changes so that it always refers to the same row (a GtkTreePath refers to a position, not a fixed row). Create a new GtkTreeRowReference with gtk_tree_row_reference_new().

WidgetPath

GtkWidgetPath is a boxed type that represents a widget hierarchy from the topmost widget, typically a toplevel, to any child. This widget path abstraction is used in GtkStyleContext on behalf of the real widget in order to query style information.

WindowGeometryInfo

Aliases

Allocation

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][geometry-management] for more information.

Stock

Enumerations

Align

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

ArrowPlacement

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

ArrowType

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

AssistantPageType

An enum for determining the page role inside the GtkAssistant. It’s used to handle buttons sensitivity and visibility.

BaselinePosition

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.

BorderStyle

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

ButtonBoxStyle

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

ButtonRole

The role specifies the desired appearance of a GtkModelButton.

ButtonsType

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

CellRendererAccelMode

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.

CellRendererMode

Identifies how the user can interact with a particular cell.

CornerType

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.

CssSectionType

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.

DeleteType

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

DirectionType

Focus movement types.

DragResult

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

EntryIconPosition

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

EventSequenceState

Describes the state of a GdkEventSequence in a GtkGesture.

ExpanderStyle

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

FileChooserAction

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

FileChooserConfirmation

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.

IconSize

Built-in stock icon sizes.

IconViewDropPosition

An enum for determining where a dropped item goes.

ImageType

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 NULL values.

IMPreeditStyle

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

IMStatusStyle

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

InputPurpose

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.

Justification

Used for justifying the text inside a GtkLabel widget. (See also GtkAlignment).

LevelBarMode

Describes how GtkLevelBar contents should be rendered. Note that this enumeration could be extended with additional modes in the future.

License

The type of license for an application.

MenuDirectionType

An enumeration representing directional movements within a menu.

MessageType

The type of message being displayed in the dialog.

MovementStep
NotebookTab
NumberUpLayout

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

Orientation

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

PackDirection

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

PackType

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

PadActionType

The type of a pad action.

PageOrientation

See also gtk_print_settings_set_orientation().

PageSet

See also gtk_print_job_set_page_set().

PanDirection

Describes the panning direction of a GtkGesturePan.

PathPriorityType

Priorities for path lookups. See also gtk_binding_set_add_path().

PathType

Widget path types. See also gtk_binding_set_add_path().

PolicyType

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

PopoverConstraint

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

PositionType

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.

PrintDuplex

See also gtk_print_settings_set_duplex().

PrintOperationAction

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

PrintOperationResult

A value of this type is returned by gtk_print_operation_run().

PrintPages

See also gtk_print_job_set_pages()

PrintQuality

See also gtk_print_settings_set_quality().

PrintStatus

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

PropagationPhase

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

RcTokenType

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.

RecentSortType

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

ReliefStyle

Indicated the relief to be drawn around a GtkButton.

ResizeMode
ResponseType

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.

RevealerTransitionType

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

ScrollablePolicy

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

ScrollStep
ScrollType

Scrolling types.

SelectionMode

Used to control what selections users are allowed to make.

SensitivityType

Determines how GTK+ handles the sensitivity of stepper arrows at the end of range widgets.

ShadowType

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

ShortcutType

GtkShortcutType specifies the kind of shortcut that is being described. More values may be added to this enumeration over time.

SizeGroupMode

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

SizeRequestMode

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

SortType

Determines the direction of a sort.

SpinButtonUpdatePolicy

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

SpinType

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

StackTransitionType

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

StateType

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.

TextBufferTargetInfo

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

TextDirection

Reading directions for text.

TextExtendSelection

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

TextViewLayer

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

TextWindowType

Used to reference the parts of GtkTextView.

ToolbarSpaceStyle

Whether spacers are vertical lines or just blank.

ToolbarStyle

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.

TreeViewColumnSizing

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.

TreeViewDropPosition

An enum for determining where a dropped row goes.

TreeViewGridLines

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

Unit

See also gtk_print_settings_set_paper_width().

WidgetHelpType

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

WindowPosition

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.

WindowType

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.

WrapMode

Describes a type of line wrapping.

Bitfields

AccelFlags

Accelerator flags used with gtk_accel_group_connect().

ApplicationInhibitFlags

Types of user actions that may be blocked by gtk_application_inhibit().

AttachOptions

Denotes the expansion properties that a widget will have when it (or its parent) is resized.

CalendarDisplayOptions

These options can be used to influence the display and behaviour of a GtkCalendar.

CellRendererState

Tells how a cell is to be rendered.

DebugFlag
DestDefaults

The GtkDestDefaults enumeration specifies the various types of action that will be taken on behalf of the user for a drag destination site.

DialogFlags

Flags used to influence dialog construction.

EventControllerScrollFlags

Describes the behavior of a GtkEventControllerScroll.

FileFilterFlags

These flags indicate what parts of a GtkFileFilterInfo struct are filled or need to be filled.

FontChooserLevel

This enumeration specifies the granularity of font selection that is desired in a font chooser.

IconLookupFlags

Used to specify options for gtk_icon_theme_lookup_icon()

InputHints

Describes hints that might be taken into account by input methods or applications. Note that input methods may already tailor their behaviour according to the GtkInputPurpose of the entry.

JunctionSides

Describes how a rendered element connects to adjacent elements.

PlacesOpenFlags

These flags serve two purposes. First, the application can call gtk_places_sidebar_set_open_flags() using these flags as a bitmask. This tells the sidebar that the application is able to open folders selected from the sidebar in various ways, for example, in new tabs or in new windows in addition to the normal mode.

RcFlags

Deprecated.

RecentFilterFlags

These flags indicate what parts of a GtkRecentFilterInfo struct are filled or need to be filled.

RegionFlags

Describes a region within a widget.

StateFlags

Describes a widget state. Widget states are used to match the widget against CSS pseudo-classes. Note that GTK extends the regular CSS classes and sometimes uses different names.

StyleContextPrintFlags

Flags that modify the behavior of gtk_style_context_to_string(). New values may be added to this enumeration.

TargetFlags

The GtkTargetFlags enumeration is used to specify constraints on a GtkTargetEntry.

TextSearchFlags

Flags affecting how a search is done.

ToolPaletteDragTargets

Flags used to specify the supported drag targets.

TreeModelFlags

These flags indicate various properties of a GtkTreeModel.

UIManagerItemType

These enumeration values are used by gtk_ui_manager_add_ui() to determine what UI element to create.

Error Domains

BuilderError

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

CssProviderError

Error codes for GTK_CSS_PROVIDER_ERROR.

FileChooserError

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

IconThemeError

Error codes for GtkIconTheme operations.

PrintError

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

RecentChooserError

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

RecentManagerError

Error codes for GtkRecentManager operations.

Callbacks

AccelGroupActivate
AccelGroupFindFunc
AccelMapForeach
AssistantPageFunc

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.

BuilderConnectFunc

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.

CalendarDetailFunc

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.

Callback

The type of the callback functions used for e.g. iterating over the children of a container, see gtk_container_foreach().

CellAllocCallback

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

CellCallback

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

CellLayoutDataFunc

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

ClipboardClearFunc

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.

ClipboardGetFunc

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.

ClipboardImageReceivedFunc

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

ClipboardReceivedFunc

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

ClipboardRichTextReceivedFunc

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

ClipboardTargetsReceivedFunc

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

ClipboardTextReceivedFunc

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

ClipboardURIReceivedFunc

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

ColorSelectionChangePaletteFunc
ColorSelectionChangePaletteWithScreenFunc
EntryCompletionMatchFunc

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

FileFilterFunc

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

FlowBoxCreateWidgetFunc

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.

FlowBoxFilterFunc

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.

FlowBoxForeachFunc

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

FlowBoxSortFunc

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

FontFilterFunc

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

IconViewForeachFunc

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.

KeySnoopFunc

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

ListBoxCreateWidgetFunc

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.

ListBoxFilterFunc

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

ListBoxForeachFunc

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

ListBoxSortFunc

Compare two rows to determine which should be first.

ListBoxUpdateHeaderFunc

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.

MenuDetachFunc

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

MenuPositionFunc

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.

ModuleDisplayInitFunc

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

ModuleInitFunc

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

PageSetupDoneFunc

The type of function that is passed to gtk_print_run_page_setup_dialog_async().

PrintSettingsFunc
RcPropertyParser
RecentFilterFunc

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

RecentSortFunc
StylePropertyParser
TextBufferDeserializeFunc

A function that is called to deserialize rich text that has been serialized with gtk_text_buffer_serialize(), and insert it at iter.

TextBufferSerializeFunc

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

TextCharPredicate
TextTagTableForeach
TickCallback

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

TranslateFunc

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

TreeCellDataFunc

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

TreeDestroyCountFunc
TreeIterCompareFunc

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.

TreeModelFilterModifyFunc

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.

TreeModelFilterVisibleFunc

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

TreeModelForeachFunc

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

TreeSelectionForeachFunc

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.

TreeSelectionFunc

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.

TreeViewColumnDropFunc

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.

TreeViewMappingFunc

Function used for gtk_tree_view_map_expanded_rows().

TreeViewRowSeparatorFunc

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.

TreeViewSearchEqualFunc

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.

TreeViewSearchPositionFunc

Functions

accel_groups_activate

Finds the first accelerator in any GtkAccelGroup attached to object that matches accel_key and accel_mods, and activates that accelerator.

accel_groups_from_object

Gets a list of all accel groups which are attached to object.

accelerator_get_default_mod_mask

Gets the modifier mask.

accelerator_get_label

Converts an accelerator keyval and modifier mask into a string which can be used to represent the accelerator to the user.

accelerator_get_label_with_keycode

Converts an accelerator keyval and modifier mask into a (possibly translated) string that can be displayed to a user, similarly to gtk_accelerator_get_label(), but handling keycodes.

accelerator_name

Converts an accelerator keyval and modifier mask into a string parseable by gtk_accelerator_parse(). For example, if you pass in

GDK_KEY_q and #GDK_CONTROL_MASK, this function returns “q”.

accelerator_name_with_keycode

Converts an accelerator keyval and modifier mask into a string parseable by gtk_accelerator_parse_with_keycode(), similarly to gtk_accelerator_name() but handling keycodes. This is only useful for system-level components, applications should use gtk_accelerator_parse() instead.

accelerator_parse

Parses a string representing an accelerator. The format looks like “a” or “F1” or “z” (the last one is for key release).

accelerator_parse_with_keycode

Parses a string representing an accelerator, similarly to gtk_accelerator_parse() but handles keycodes as well. This is only useful for system-level components, applications should use gtk_accelerator_parse() instead.

accelerator_set_default_mod_mask

Sets the modifiers that will be considered significant for keyboard accelerators. The default mod mask depends on the GDK backend in use, but will typically include #GDK_CONTROL_MASK | #GDK_SHIFT_MASK |

GDK_MOD1_MASK | #GDK_SUPER_MASK | #GDK_HYPER_MASK | #GDK_META_MASK.

In other words, Control, Shift, Alt, Super, Hyper and Meta. Other modifiers will by default be ignored by GtkAccelGroup.

accelerator_valid

Determines whether a given keyval and modifier mask constitute a valid keyboard accelerator. For example, the #GDK_KEY_a keyval plus #GDK_CONTROL_MASK is valid - this is a “Ctrl+a” accelerator. But, you can’t, for instance, use the #GDK_KEY_Control_L keyval as an accelerator.

alternative_dialog_button_order

Returns TRUE if dialogs are expected to use an alternative button order on the screen screen. See gtk_dialog_set_alternative_button_order() for more details about alternative button order.

bindings_activate

Find a key binding matching keyval and modifiers and activate the binding on object.

bindings_activate_event

Looks up key bindings for object to find one matching event, and if one was found, activate it.

cairo_should_draw_window

This function is supposed to be called in GtkWidget::draw implementations for widgets that support multiple windows. cr must be untransformed from invoking of the draw function. This function will return TRUE if the contents of the given window are supposed to be drawn and FALSE otherwise. Note that when the drawing was not initiated by the windowing system this function will return TRUE for all windows, so you need to draw the bottommost window first. Also, do not use “else if” statements to check which window should be drawn.

cairo_transform_to_window

Transforms the given cairo context cr that from widget-relative coordinates to window-relative coordinates. If the widget’s window is not an ancestor of window, no modification will be applied.

check_version

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.

device_grab_add

Adds a GTK+ grab on device, so all the events on device and its associated pointer or keyboard (if any) are delivered to widget. If the block_others parameter is TRUE, any other devices will be unable to interact with widget during the grab.

device_grab_remove

Removes a device grab from the given widget.

disable_setlocale

Prevents gtk_init(), gtk_init_check(), gtk_init_with_args() and gtk_parse_args() from automatically calling setlocale (LC_ALL, ""). 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.

distribute_natural_allocation

Distributes extra_space to child sizes by bringing smaller children up to natural size first.

drag_cancel

Cancels an ongoing drag operation on the source side.

drag_finish

Informs the drag source that the drop is finished, and that the data of the drag will no longer be required.

drag_get_source_widget

Determines the source widget for a drag.

drag_set_icon_default

Sets the icon for a particular drag to the default icon.

drag_set_icon_gicon

Sets the icon for a given drag from the given icon. See the documentation for gtk_drag_set_icon_name() for more details about using icons in drag and drop.

drag_set_icon_name

Sets the icon for a given drag from a named themed icon. See the docs for GtkIconTheme for more details. Note that the size of the icon depends on the icon theme (the icon is loaded at the symbolic size #GTK_ICON_SIZE_DND), thus hot_x and hot_y have to be used with care.

drag_set_icon_pixbuf

Sets pixbuf as the icon for a given drag.

drag_set_icon_stock

Sets the icon for a given drag from a stock ID.

drag_set_icon_surface

Sets surface as the icon for a given drag. GTK+ retains references for the arguments, and will release them when they are no longer needed.

drag_set_icon_widget

Changes the icon for drag operation to a given widget. GTK+ will not destroy the widget, so if you don’t want it to persist, you should connect to the “drag-end” signal and destroy it yourself.

draw_insertion_cursor

Draws a text caret on cr at location. This is not a style function but merely a convenience function for drawing the standard cursor shape.

events_pending

Checks if any events are pending.

false

Analogical to gtk_true(), this function does nothing but always returns FALSE.

get_binary_age

Returns the binary age as passed to libtool when building the GTK+ library the process is running against. If libtool means nothing to you, don’t worry about it.

get_current_event

Obtains a copy of the event currently being processed by GTK+.

get_current_event_device

If there is a current event and it has a device, return that device, otherwise return NULL.

get_current_event_state

If there is a current event and it has a state field, place that state field in state and return TRUE, otherwise return FALSE.

get_current_event_time

If there is a current event and it has a timestamp, return that timestamp, otherwise return GDK_CURRENT_TIME.

get_debug_flags

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

get_event_widget

If event is NULL or the event was not associated with any widget, returns NULL, otherwise returns the widget that received the event originally.

get_interface_age

Returns the interface age as passed to libtool when building the GTK+ library the process is running against. If libtool means nothing to you, don’t worry about it.

get_locale_direction

Get the direction of the current locale. This is the expected reading direction for text and UI.

get_major_version

Returns the major version number of the GTK+ library. (e.g. in GTK+ version 3.1.5 this is 3.)

get_micro_version

Returns the micro version number of the GTK+ library. (e.g. in GTK+ version 3.1.5 this is 5.)

get_minor_version

Returns the minor version number of the GTK+ library. (e.g. in GTK+ version 3.1.5 this is 1.)

get_option_group

Returns a GOptionGroup for the commandline arguments recognized by GTK+ and GDK.

grab_get_current

Queries the current grab of the default window group.

init

Call this function before using any other GTK+ functions in your GUI applications. It will initialize everything needed to operate the toolkit and parses some standard command line options.

init_check

This function does the same work as gtk_init() with only a single change: It does not terminate the program if the commandline arguments couldn’t be parsed or the windowing system can’t be initialized. Instead it returns FALSE on failure.

init_with_args

This function does the same work as gtk_init_check(). Additionally, it allows you to add your own commandline options, and it automatically generates nicely formatted --help output. Note that your program will be terminated after writing out the help output.

key_snooper_install

Installs a key snooper function, which will get called on all key events before delivering them normally.

key_snooper_remove

Removes the key snooper function with the given id.

main

Runs the main loop until gtk_main_quit() is called.

main_do_event

Processes a single GDK event.

main_iteration

Runs a single iteration of the mainloop.

main_iteration_do

Runs a single iteration of the mainloop. If no events are available either return or block depending on the value of blocking.

main_level

Asks for the current nesting level of the main loop.

main_quit

Makes the innermost invocation of the main loop return when it regains control.

paint_arrow

Draws an arrow in the given rectangle on cr using the given parameters. arrow_type determines the direction of the arrow.

paint_box

Draws a box on cr with the given parameters.

paint_box_gap

Draws a box in cr using the given style and state and shadow type, leaving a gap in one side.

paint_check

Draws a check button indicator in the given rectangle on cr with the given parameters.

paint_diamond

Draws a diamond in the given rectangle on window using the given parameters.

paint_expander

Draws an expander as used in GtkTreeView. x and y specify the center the expander. The size of the expander is determined by the “expander-size” style property of widget. (If widget is not specified or doesn’t have an “expander-size” property, an unspecified default size will be used, since the caller doesn’t have sufficient information to position the expander, this is likely not useful.) The expander is expander_size pixels tall in the collapsed position and expander_size pixels wide in the expanded position.

paint_extension

Draws an extension, i.e. a notebook tab.

paint_flat_box

Draws a flat box on cr with the given parameters.

paint_focus

Draws a focus indicator around the given rectangle on cr using the given style.

paint_handle

Draws a handle as used in GtkHandleBox and GtkPaned.

paint_hline

Draws a horizontal line from (x1, y) to (x2, y) in cr using the given style and state.

paint_layout

Draws a layout on cr using the given parameters.

paint_option

Draws a radio button indicator in the given rectangle on cr with the given parameters.

paint_resize_grip

Draws a resize grip in the given rectangle on cr using the given parameters.

paint_shadow

Draws a shadow around the given rectangle in cr using the given style and state and shadow type.

paint_shadow_gap

Draws a shadow around the given rectangle in cr using the given style and state and shadow type, leaving a gap in one side.

paint_slider

Draws a slider in the given rectangle on cr using the given style and orientation.

paint_spinner

Draws a spinner on window using the given parameters.

paint_tab

Draws an option menu tab (i.e. the up and down pointing arrows) in the given rectangle on cr using the given parameters.

paint_vline

Draws a vertical line from (x, y1_) to (x, y2_) in cr using the given style and state.

parse_args

Parses command line arguments, and initializes global attributes of GTK+, but does not actually open a connection to a display. (See gdk_display_open(), gdk_get_display_arg_name())

print_run_page_setup_dialog

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.

print_run_page_setup_dialog_async

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

propagate_event

Sends an event to a widget, propagating the event to parent widgets if the event remains unhandled.

rc_add_default_file

Adds a file to the list of files to be parsed at the end of gtk_init().

rc_find_module_in_path

Searches for a theme engine in the GTK+ search path. This function is not useful for applications and should not be used.

rc_find_pixmap_in_path

Looks up a file in pixmap path for the specified GtkSettings. If the file is not found, it outputs a warning message using g_warning() and returns NULL.

rc_get_default_files

Retrieves the current list of RC files that will be parsed at the end of gtk_init().

rc_get_im_module_file

Obtains the path to the IM modules file. See the documentation of the GTK_IM_MODULE_FILE environment variable for more details.

rc_get_im_module_path

Obtains the path in which to look for IM modules. See the documentation of the GTK_PATH environment variable for more details about looking up modules. This function is useful solely for utilities supplied with GTK+ and should not be used by applications under normal circumstances.

rc_get_module_dir

Returns a directory in which GTK+ looks for theme engines. For full information about the search for theme engines, see the docs for GTK_PATH in [Running GTK+ Applications][gtk-running].

rc_get_style

Finds all matching RC styles for a given widget, composites them together, and then creates a GtkStyle representing the composite appearance. (GTK+ actually keeps a cache of previously created styles, so a new style may not be created.)

rc_get_style_by_paths

Creates up a GtkStyle from styles defined in a RC file by providing the raw components used in matching. This function may be useful when creating pseudo-widgets that should be themed like widgets but don’t actually have corresponding GTK+ widgets. An example of this would be items inside a GNOME canvas widget.

rc_get_theme_dir

Returns the standard directory in which themes should be installed. (GTK+ does not actually use this directory itself.)

rc_parse

Parses a given resource file.

rc_parse_color

Parses a color in the format expected in a RC file.

rc_parse_color_full

Parses a color in the format expected in a RC file. If style is not NULL, it will be consulted to resolve references to symbolic colors.

rc_parse_priority

Parses a GtkPathPriorityType variable from the format expected in a RC file.

rc_parse_state

Parses a GtkStateType variable from the format expected in a RC file.

rc_parse_string

Parses resource information directly from a string.

rc_reparse_all

If the modification time on any previously read file for the default GtkSettings has changed, discard all style information and then reread all previously read RC files.

rc_reparse_all_for_settings

If the modification time on any previously read file for the given GtkSettings has changed, discard all style information and then reread all previously read RC files.

rc_reset_styles

This function recomputes the styles for all widgets that use a particular GtkSettings object. (There is one GtkSettings object per GdkScreen, see gtk_settings_get_for_screen()); It is useful when some global parameter has changed that affects the appearance of all widgets, because when a widget gets a new style, it will both redraw and recompute any cached information about its appearance. As an example, it is used when the default font size set by the operating system changes. Note that this function doesn’t affect widgets that have a style set explicitly on them with gtk_widget_set_style().

rc_scanner_new
rc_set_default_files

Sets the list of files that GTK+ will read at the end of gtk_init().

render_activity

Renders an activity indicator (such as in GtkSpinner). The state GTK_STATE_FLAG_CHECKED determines whether there is activity going on.

render_arrow

Renders an arrow pointing to angle.

render_background

Renders the background of an element.

render_background_get_clip

Returns the area that will be affected (i.e. drawn to) when calling gtk_render_background() for the given context and rectangle.

render_check

Renders a checkmark (as in a GtkCheckButton).

render_expander

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.

render_extension

Renders a extension (as in a GtkNotebook tab) in the rectangle defined by x, y, width, height. The side where the extension connects to is defined by gap_side.

render_focus

Renders a focus indicator on the rectangle determined by x, y, width, height.

render_frame

Renders a frame around the rectangle defined by x, y, width, height.

render_frame_gap

Renders a frame around the rectangle defined by (x, y, width, height), leaving a gap on one side. xy0_gap and xy1_gap will mean X coordinates for GTK_POS_TOP and GTK_POS_BOTTOM gap sides, and Y coordinates for GTK_POS_LEFT and GTK_POS_RIGHT.

render_handle

Renders a handle (as in GtkHandleBox, GtkPaned and GtkWindow’s resize grip), in the rectangle determined by x, y, width, height.

render_icon

Renders the icon in pixbuf at the specified x and y coordinates.

render_icon_pixbuf

Renders the icon specified by source at the given size, returning the result in a pixbuf.

render_icon_surface

Renders the icon in surface at the specified x and y coordinates.

render_insertion_cursor

Draws a text caret on cr at the specified index of layout.

render_layout

Renders layout on the coordinates x, y.

render_line

Renders a line from (x0, y0) to (x1, y1).

render_option

Renders an option mark (as in a GtkRadioButton), 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.

render_slider

Renders a slider (as in GtkScale) in the rectangle defined by x, y, width, height. orientation defines whether the slider is vertical or horizontal.

rgb_to_hsv

Converts a color from RGB space to HSV.

selection_add_target

Appends a specified target to the list of supported targets for a given widget and selection.

selection_add_targets

Prepends a table of targets to the list of supported targets for a given widget and selection.

selection_clear_targets

Remove all targets registered for the given selection for the widget.

selection_convert

Requests the contents of a selection. When received, a “selection-received” signal will be generated.

selection_owner_set

Claims ownership of a given selection for a particular widget, or, if widget is NULL, release ownership of the selection.

selection_owner_set_for_display

Claim ownership of a given selection for a particular widget, or, if widget is NULL, release ownership of the selection.

selection_remove_all

Removes all handlers and unsets ownership of all selections for a widget. Called when widget is being destroyed. This function will not generally be called by applications.

set_debug_flags

Sets the GTK+ debug flags.

show_about_dialog

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

show_uri

A convenience function for launching the default application to show the uri. Like gtk_show_uri_on_window(), but takes a screen as transient parent instead of a window.

show_uri_on_window

This is a convenience function for launching the default application to show the uri. The uri must be of a form understood by GIO (i.e. you need to install gvfs to get support for uri schemes such as http:// or ftp://, as only local files are handled by GIO itself). Typical examples are - file:///home/gnome/pict.jpg - http://www.gnome.org - mailto:me@gnome.org

stock_add

Registers each of the stock items in items. If an item already exists with the same stock ID as one of the items, the old item gets replaced. The stock items are copied, so GTK+ does not hold any pointer into items and items can be freed. Use gtk_stock_add_static() if items is persistent and GTK+ need not copy the array.

stock_add_static

Same as gtk_stock_add(), but doesn’t copy items, so items must persist until application exit.

stock_list_ids

Retrieves a list of all known stock IDs added to a GtkIconFactory or registered with gtk_stock_add(). The list must be freed with g_slist_free(), and each string in the list must be freed with g_free().

stock_lookup

Fills item with the registered values for stock_id, returning TRUE if stock_id was known.

stock_set_translate_func

Sets a function to be used for translating the label of a stock item.

target_table_free

This function frees a target table as returned by gtk_target_table_new_from_list()

target_table_new_from_list

This function creates an GtkTargetEntry array that contains the same targets as the passed %list. The returned table is newly allocated and should be freed using gtk_target_table_free() when no longer needed.

targets_include_image

Determines if any of the targets in targets can be used to provide a GdkPixbuf.

targets_include_rich_text

Determines if any of the targets in targets can be used to provide rich text.

targets_include_text

Determines if any of the targets in targets can be used to provide text.

targets_include_uri

Determines if any of the targets in targets can be used to provide an uri list.

test_create_simple_window

Create a simple window with window title window_title and text contents dialog_text. The window will quit any running gtk_main()-loop when destroyed, and it will automatically be destroyed upon test function teardown.

test_create_widget

This function wraps g_object_new() for widget types. It’ll automatically show all created non window widgets, also g_object_ref_sink() them (to keep them alive across a running test) and set them up for destruction during the next test teardown phase.

test_display_button_window

Create a window with window title window_title, text contents dialog_text, and a number of buttons, according to the paired argument list given as @… parameters. Each button is created with a label and a ::clicked signal handler that incremrents the integer stored in nump. The window will be automatically shown with gtk_widget_show_now() after creation, so when this function returns it has already been mapped, resized and positioned on screen. The window will quit any running gtk_main()-loop when destroyed, and it will automatically be destroyed upon test function teardown.

test_find_label

This function will search widget and all its descendants for a GtkLabel widget with a text string matching label_pattern. The label_pattern may contain asterisks “*” and question marks “?” as placeholders, g_pattern_match() is used for the matching. Note that locales other than “C“ tend to alter (translate” label strings, so this function is genrally only useful in test programs with predetermined locales, see gtk_test_init() for more details.

test_find_sibling

This function will search siblings of base_widget and siblings of its ancestors for all widgets matching widget_type. Of the matching widgets, the one that is geometrically closest to base_widget will be returned. The general purpose of this function is to find the most likely “action” widget, relative to another labeling widget. Such as finding a button or text entry widget, given its corresponding label widget.

test_find_widget

This function will search the descendants of widget for a widget of type widget_type that has a label matching label_pattern next to it. This is most useful for automated GUI testing, e.g. to find the “OK” button in a dialog and synthesize clicks on it. However see gtk_test_find_label(), gtk_test_find_sibling() and gtk_test_widget_click() for possible caveats involving the search of such widgets and synthesizing widget events.

test_init

This function is used to initialize a GTK+ test program.

test_list_all_types

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

test_register_all_types

Force registration of all core Gtk+ and Gdk object types. This allowes to refer to any of those object types via g_type_from_name() after calling this function.

test_slider_get_value

Retrive the literal adjustment value for GtkRange based widgets and spin buttons. Note that the value returned by this function is anything between the lower and upper bounds of the adjustment belonging to widget, and is not a percentage as passed in to gtk_test_slider_set_perc().

test_slider_set_perc

This function will adjust the slider position of all GtkRange based widgets, such as scrollbars or scales, it’ll also adjust spin buttons. The adjustment value of these widgets is set to a value between the lower and upper limits, according to the percentage argument.

test_spin_button_click

This function will generate a button click in the upwards or downwards spin button arrow areas, usually leading to an increase or decrease of spin button’s value.

test_text_get

Retrive the text string of widget if it is a GtkLabel, GtkEditable (entry and text widgets) or GtkTextView.

test_text_set

Set the text string of widget to string if it is a GtkLabel, GtkEditable (entry and text widgets) or GtkTextView.

test_widget_click

This function will generate a button click (button press and button release event) in the middle of the first GdkWindow found that belongs to widget. For windowless widgets like GtkButton (which returns FALSE from gtk_widget_get_has_window()), this will often be an input-only event window. For other widgets, this is usually widget->window. Certain caveats should be considered when using this function, in particular because the mouse pointer is warped to the button click location, see gdk_test_simulate_button() for details.

test_widget_send_key

This function will generate keyboard press and release events in the middle of the first GdkWindow found that belongs to widget. For windowless widgets like GtkButton (which returns FALSE from gtk_widget_get_has_window()), this will often be an input-only event window. For other widgets, this is usually widget->window. Certain caveats should be considered when using this function, in particular because the mouse pointer is warped to the key press location, see gdk_test_simulate_key() for details.

test_widget_wait_for_draw

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.

tree_get_row_drag_data

Obtains a tree_model and path from selection data of target type GTK_TREE_MODEL_ROW. Normally called from a drag_data_received handler. This function can only be used if selection_data originates from the same process that’s calling this function, because a pointer to the tree model is being passed around. If you aren’t in the same process, then you’ll get memory corruption. In the GtkTreeDragDest drag_data_received handler, you can assume that selection data of type GTK_TREE_MODEL_ROW is in from the current process. The returned path must be freed with gtk_tree_path_free().

tree_set_row_drag_data

Sets selection data of target type GTK_TREE_MODEL_ROW. Normally used in a drag_data_get handler.

true

All this function does it to return TRUE.

Function Macros

ACTIVATABLE_CLASS
BUILDABLE_CLASS
BUILDER_WARN_INVALID_CHILD_TYPE

This macro should be used to emit a warning about and unexpected type value in a GtkBuildable add_child implementation.

CELL_AREA_WARN_INVALID_CELL_PROPERTY_ID

This macro should be used to emit a standard warning about unexpected properties in set_cell_property() and get_cell_property() implementations.

CELL_EDITABLE_CLASS
CHECK_VERSION

Returns TRUE if the version of the GTK+ header files is the same as or newer than the passed-in version.

CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID

This macro should be used to emit a standard warning about unexpected properties in set_child_property() and get_child_property() implementations.

DEBUG_CHECK
HBOX
HBOX_CLASS
HBUTTON_BOX
HBUTTON_BOX_CLASS
HPANED
HPANED_CLASS
HSCALE
HSCALE_CLASS
HSCROLLBAR
HSCROLLBAR_CLASS
HSEPARATOR
HSEPARATOR_CLASS
HSV_CLASS
NOTE
ORIENTABLE_CLASS
RC_STYLE
RC_STYLE_CLASS
STYLE_ATTACHED
TREE_SORTABLE_CLASS
VBOX
VBOX_CLASS
VBUTTON_BOX
VBUTTON_BOX_CLASS
VPANED
VPANED_CLASS
VSCALE
VSCALE_CLASS
VSCROLLBAR
VSCROLLBAR_CLASS
VSEPARATOR
VSEPARATOR_CLASS
widget_class_bind_template_callback

Binds a callback function defined in a template to the widget_class.

widget_class_bind_template_child

Binds a child widget defined in a template to the widget_class.

widget_class_bind_template_child_internal

Binds a child widget defined in a template to the widget_class, and also makes it available as an internal child in GtkBuilder, under the name member_name.

widget_class_bind_template_child_internal_private

Binds a child widget defined in a template to the widget_class, and also makes it available as an internal child in GtkBuilder, under the name member_name.

widget_class_bind_template_child_private

Binds a child widget defined in a template to the widget_class.

Constants

BINARY_AGE

Like gtk_get_binary_age(), but from the headers used at application compile time, rather than from the library linked against at application run time.

INPUT_ERROR

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

INTERFACE_AGE

Like gtk_get_interface_age(), but from the headers used at application compile time, rather than from the library linked against at application run time.

LEVEL_BAR_OFFSET_FULL

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

LEVEL_BAR_OFFSET_HIGH

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

LEVEL_BAR_OFFSET_LOW

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

MAJOR_VERSION

Like gtk_get_major_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

MAX_COMPOSE_LEN

The maximum length of sequences in compose tables.

MICRO_VERSION

Like gtk_get_micro_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

MINOR_VERSION

Like gtk_get_minor_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

PAPER_NAME_A3

Name for the A3 paper size.

PAPER_NAME_A4

Name for the A4 paper size.

PAPER_NAME_A5

Name for the A5 paper size.

PAPER_NAME_B5

Name for the B5 paper size.

PAPER_NAME_EXECUTIVE

Name for the Executive paper size.

PAPER_NAME_LEGAL

Name for the Legal paper size.

PAPER_NAME_LETTER

Name for the Letter paper size.

PATH_PRIO_MASK
PRINT_SETTINGS_COLLATE
PRINT_SETTINGS_DEFAULT_SOURCE
PRINT_SETTINGS_DITHER
PRINT_SETTINGS_DUPLEX
PRINT_SETTINGS_FINISHINGS
PRINT_SETTINGS_MEDIA_TYPE
PRINT_SETTINGS_N_COPIES
PRINT_SETTINGS_NUMBER_UP
PRINT_SETTINGS_NUMBER_UP_LAYOUT
PRINT_SETTINGS_ORIENTATION
PRINT_SETTINGS_OUTPUT_BASENAME

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.

PRINT_SETTINGS_OUTPUT_BIN
PRINT_SETTINGS_OUTPUT_DIR

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

PRINT_SETTINGS_OUTPUT_FILE_FORMAT

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

PRINT_SETTINGS_OUTPUT_URI

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.

PRINT_SETTINGS_PAGE_RANGES
PRINT_SETTINGS_PAGE_SET
PRINT_SETTINGS_PAPER_FORMAT
PRINT_SETTINGS_PAPER_HEIGHT
PRINT_SETTINGS_PAPER_WIDTH
PRINT_SETTINGS_PRINT_PAGES
PRINT_SETTINGS_PRINTER
PRINT_SETTINGS_PRINTER_LPI
PRINT_SETTINGS_QUALITY
PRINT_SETTINGS_RESOLUTION
PRINT_SETTINGS_RESOLUTION_X
PRINT_SETTINGS_RESOLUTION_Y
PRINT_SETTINGS_REVERSE
PRINT_SETTINGS_SCALE
PRINT_SETTINGS_USE_COLOR
PRINT_SETTINGS_WIN32_DRIVER_EXTRA
PRINT_SETTINGS_WIN32_DRIVER_VERSION
PRIORITY_RESIZE

Use this priority for functionality related to size allocation.

STOCK_ABOUT

The “About” item.

STOCK_ADD

The “Add” item and icon.

STOCK_APPLY

The “Apply” item and icon.

STOCK_BOLD

The “Bold” item and icon.

STOCK_CANCEL

The “Cancel” item and icon.

STOCK_CAPS_LOCK_WARNING

The “Caps Lock Warning” icon.

STOCK_CDROM

The “CD-Rom” item and icon.

STOCK_CLEAR

The “Clear” item and icon.

STOCK_CLOSE

The “Close” item and icon.

STOCK_COLOR_PICKER

The “Color Picker” item and icon.

STOCK_CONNECT

The “Connect” icon.

STOCK_CONVERT

The “Convert” item and icon.

STOCK_COPY

The “Copy” item and icon.

STOCK_CUT

The “Cut” item and icon.

STOCK_DELETE

The “Delete” item and icon.

STOCK_DIALOG_AUTHENTICATION

The “Authentication” item and icon.

STOCK_DIALOG_ERROR

The “Error” item and icon.

STOCK_DIALOG_INFO

The “Information” item and icon.

STOCK_DIALOG_QUESTION

The “Question” item and icon.

STOCK_DIALOG_WARNING

The “Warning” item and icon.

STOCK_DIRECTORY

The “Directory” icon.

STOCK_DISCARD

The “Discard” item.

STOCK_DISCONNECT

The “Disconnect” icon.

STOCK_DND

The “Drag-And-Drop” icon.

STOCK_DND_MULTIPLE

The “Drag-And-Drop multiple” icon.

STOCK_EDIT

The “Edit” item and icon.

STOCK_EXECUTE

The “Execute” item and icon.

STOCK_FILE

The “File” item and icon.

STOCK_FIND

The “Find” item and icon.

STOCK_FIND_AND_REPLACE

The “Find and Replace” item and icon.

STOCK_FLOPPY

The “Floppy” item and icon.

STOCK_FULLSCREEN

The “Fullscreen” item and icon.

STOCK_GO_BACK

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

STOCK_GO_DOWN

The “Down” item and icon.

STOCK_GO_FORWARD

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

STOCK_GO_UP

The “Up” item and icon.

STOCK_GOTO_BOTTOM

The “Bottom” item and icon.

STOCK_GOTO_FIRST

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

STOCK_GOTO_LAST

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

STOCK_GOTO_TOP

The “Top” item and icon.

STOCK_HARDDISK

The “Harddisk” item and icon.

STOCK_HELP

The “Help” item and icon.

STOCK_HOME

The “Home” item and icon.

STOCK_INDENT

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

STOCK_INDEX

The “Index” item and icon.

STOCK_INFO

The “Info” item and icon.

STOCK_ITALIC

The “Italic” item and icon.

STOCK_JUMP_TO

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

STOCK_JUSTIFY_CENTER

The “Center” item and icon.

STOCK_JUSTIFY_FILL

The “Fill” item and icon.

STOCK_JUSTIFY_LEFT

The “Left” item and icon.

STOCK_JUSTIFY_RIGHT

The “Right” item and icon.

STOCK_LEAVE_FULLSCREEN

The “Leave Fullscreen” item and icon.

STOCK_MEDIA_FORWARD

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

STOCK_MEDIA_NEXT

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

STOCK_MEDIA_PAUSE

The “Media Pause” item and icon.

STOCK_MEDIA_PLAY

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

STOCK_MEDIA_PREVIOUS

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

STOCK_MEDIA_RECORD

The “Media Record” item and icon.

STOCK_MEDIA_REWIND

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

STOCK_MEDIA_STOP

The “Media Stop” item and icon.

STOCK_MISSING_IMAGE

The “Missing image” icon.

STOCK_NETWORK

The “Network” item and icon.

STOCK_NEW

The “New” item and icon.

STOCK_NO

The “No” item and icon.

STOCK_OK

The “OK” item and icon.

STOCK_OPEN

The “Open” item and icon.

STOCK_ORIENTATION_LANDSCAPE

The “Landscape Orientation” item and icon.

STOCK_ORIENTATION_PORTRAIT

The “Portrait Orientation” item and icon.

STOCK_ORIENTATION_REVERSE_LANDSCAPE

The “Reverse Landscape Orientation” item and icon.

STOCK_ORIENTATION_REVERSE_PORTRAIT

The “Reverse Portrait Orientation” item and icon.

STOCK_PAGE_SETUP

The “Page Setup” item and icon.

STOCK_PASTE

The “Paste” item and icon.

STOCK_PREFERENCES

The “Preferences” item and icon.

STOCK_PRINT

The “Print” item and icon.

STOCK_PRINT_ERROR

The “Print Error” icon.

STOCK_PRINT_PAUSED

The “Print Paused” icon.

STOCK_PRINT_PREVIEW

The “Print Preview” item and icon.

STOCK_PRINT_REPORT

The “Print Report” icon.

STOCK_PRINT_WARNING

The “Print Warning” icon.

STOCK_PROPERTIES

The “Properties” item and icon.

STOCK_QUIT

The “Quit” item and icon.

STOCK_REDO

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

STOCK_REFRESH

The “Refresh” item and icon.

STOCK_REMOVE

The “Remove” item and icon.

STOCK_REVERT_TO_SAVED

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

STOCK_SAVE

The “Save” item and icon.

STOCK_SAVE_AS

The “Save As” item and icon.

STOCK_SELECT_ALL

The “Select All” item and icon.

STOCK_SELECT_COLOR

The “Color” item and icon.

STOCK_SELECT_FONT

The “Font” item and icon.

STOCK_SORT_ASCENDING

The “Ascending” item and icon.

STOCK_SORT_DESCENDING

The “Descending” item and icon.

STOCK_SPELL_CHECK

The “Spell Check” item and icon.

STOCK_STOP

The “Stop” item and icon.

STOCK_STRIKETHROUGH

The “Strikethrough” item and icon.

STOCK_UNDELETE

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

STOCK_UNDERLINE

The “Underline” item and icon.

STOCK_UNDO

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

STOCK_UNINDENT

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

STOCK_YES

The “Yes” item and icon.

STOCK_ZOOM_100

The “Zoom 100%” item and icon.

STOCK_ZOOM_FIT

The “Zoom to Fit” item and icon.

STOCK_ZOOM_IN

The “Zoom In” item and icon.

STOCK_ZOOM_OUT

The “Zoom Out” item and icon.

STYLE_CLASS_ACCELERATOR

A CSS class to match an accelerator.

STYLE_CLASS_ARROW

A CSS class used when rendering an arrow element.

STYLE_CLASS_BACKGROUND

A CSS class to match the window background.

STYLE_CLASS_BOTTOM

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

STYLE_CLASS_BUTTON

A CSS class to match buttons.

STYLE_CLASS_CALENDAR

A CSS class to match calendars.

STYLE_CLASS_CELL

A CSS class to match content rendered in cell views.

STYLE_CLASS_CHECK

A CSS class to match check boxes.

STYLE_CLASS_COMBOBOX_ENTRY

A CSS class to match combobox entries.

STYLE_CLASS_CONTEXT_MENU

A CSS class to match context menus.

STYLE_CLASS_CSD

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

STYLE_CLASS_CURSOR_HANDLE

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

STYLE_CLASS_DEFAULT

A CSS class to match the default widget.

STYLE_CLASS_DESTRUCTIVE_ACTION

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

STYLE_CLASS_DIM_LABEL

A CSS class to match dimmed labels.

STYLE_CLASS_DND

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

STYLE_CLASS_DOCK

A CSS class defining a dock area.

STYLE_CLASS_ENTRY

A CSS class to match text entries.

STYLE_CLASS_ERROR

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

STYLE_CLASS_EXPANDER

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

STYLE_CLASS_FLAT

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

STYLE_CLASS_FRAME

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

STYLE_CLASS_GRIP

A CSS class defining a resize grip.

STYLE_CLASS_HEADER

A CSS class to match a header element.

STYLE_CLASS_HIGHLIGHT

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

STYLE_CLASS_HORIZONTAL

A CSS class for horizontally layered widgets.

STYLE_CLASS_IMAGE

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

STYLE_CLASS_INFO

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

STYLE_CLASS_INLINE_TOOLBAR

A CSS class to match inline toolbars.

STYLE_CLASS_INSERTION_CURSOR

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

STYLE_CLASS_LABEL

A CSS class to match labels.

STYLE_CLASS_LEFT

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

STYLE_CLASS_LEVEL_BAR

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

STYLE_CLASS_LINKED

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

STYLE_CLASS_LIST

A CSS class to match lists.

STYLE_CLASS_LIST_ROW

A CSS class to match list rows.

STYLE_CLASS_MARK

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

STYLE_CLASS_MENU

A CSS class to match menus.

STYLE_CLASS_MENUBAR

A CSS class to menubars.

STYLE_CLASS_MENUITEM

A CSS class to match menu items.

STYLE_CLASS_MESSAGE_DIALOG

A CSS class that is added to message dialogs.

STYLE_CLASS_MONOSPACE

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

STYLE_CLASS_NEEDS_ATTENTION

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.

STYLE_CLASS_NOTEBOOK

A CSS class defining a notebook.

STYLE_CLASS_OSD

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

STYLE_CLASS_OVERSHOOT

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

STYLE_CLASS_PANE_SEPARATOR

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

STYLE_CLASS_PAPER

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

STYLE_CLASS_POPOVER

A CSS class that matches popovers.

STYLE_CLASS_POPUP

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

STYLE_CLASS_PRIMARY_TOOLBAR

A CSS class to match primary toolbars.

STYLE_CLASS_PROGRESSBAR

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

STYLE_CLASS_PULSE

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

STYLE_CLASS_QUESTION

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

STYLE_CLASS_RADIO

A CSS class to match radio buttons.

STYLE_CLASS_RAISED

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

STYLE_CLASS_READ_ONLY

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

STYLE_CLASS_RIGHT

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

STYLE_CLASS_RUBBERBAND

A CSS class to match the rubberband selection rectangle.

STYLE_CLASS_SCALE

A CSS class to match scale widgets.

STYLE_CLASS_SCALE_HAS_MARKS_ABOVE

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

STYLE_CLASS_SCALE_HAS_MARKS_BELOW

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

STYLE_CLASS_SCROLLBAR

A CSS class to match scrollbars.

STYLE_CLASS_SCROLLBARS_JUNCTION

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

STYLE_CLASS_SEPARATOR

A CSS class for a separator.

STYLE_CLASS_SIDEBAR

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

STYLE_CLASS_SLIDER

A CSS class to match sliders.

STYLE_CLASS_SPINBUTTON

A CSS class defining an spinbutton.

STYLE_CLASS_SPINNER

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

STYLE_CLASS_STATUSBAR

A CSS class to match statusbars.

STYLE_CLASS_SUBTITLE

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

STYLE_CLASS_SUGGESTED_ACTION

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

STYLE_CLASS_TITLE

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

STYLE_CLASS_TITLEBAR

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

STYLE_CLASS_TOOLBAR

A CSS class to match toolbars.

STYLE_CLASS_TOOLTIP

A CSS class to match tooltip windows.

STYLE_CLASS_TOP

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

STYLE_CLASS_TOUCH_SELECTION

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

STYLE_CLASS_TROUGH

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

STYLE_CLASS_UNDERSHOOT

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

STYLE_CLASS_VERTICAL

A CSS class for vertically layered widgets.

STYLE_CLASS_VIEW

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

STYLE_CLASS_WARNING

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

STYLE_CLASS_WIDE

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

STYLE_PROPERTY_BACKGROUND_COLOR

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

STYLE_PROPERTY_BACKGROUND_IMAGE

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

STYLE_PROPERTY_BORDER_COLOR

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

STYLE_PROPERTY_BORDER_RADIUS

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

STYLE_PROPERTY_BORDER_STYLE

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

STYLE_PROPERTY_BORDER_WIDTH

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.

STYLE_PROPERTY_COLOR

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

STYLE_PROPERTY_FONT

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

STYLE_PROPERTY_MARGIN

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 GtkWidgets size allocations, and the most external spacing property of the padding/border/margin series.

STYLE_PROPERTY_PADDING

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.

STYLE_PROVIDER_PRIORITY_APPLICATION

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

STYLE_PROVIDER_PRIORITY_FALLBACK

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

STYLE_PROVIDER_PRIORITY_SETTINGS

The priority used for style information provided via GtkSettings.

STYLE_PROVIDER_PRIORITY_THEME

The priority used for style information provided by themes.

STYLE_PROVIDER_PRIORITY_USER

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

STYLE_REGION_COLUMN

A widget region name to define a treeview column.

STYLE_REGION_COLUMN_HEADER

A widget region name to define a treeview column header.

STYLE_REGION_ROW

A widget region name to define a treeview row.

STYLE_REGION_TAB

A widget region name to define a notebook tab.

TEXT_VIEW_PRIORITY_VALIDATE

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

TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID

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

TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID

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