The GTK toolkit
AboutDialogThe 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.
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
.
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.
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.
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.
ActionBarIn GTK+ 3.10, GtkAction has been deprecated. Use
GAction
instead, and associate actions withGtkActionable
widgets. UseGMenuModel
for creating menus with gtk_menu_new_from_model().
GtkActionBar is designed to present contextual actions. It is expected to be displayed below the content and expand horizontally to fill the area.
ActionGroupActions are organised into groups. An action group is essentially a map from names to GtkAction
objects.
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
).
The GtkAlignment
widget controls the alignment and size of its child widget. It has four settings: xscale, yscale, xalign, and yalign.
The GtkAppChooserButton
is a widget that lets the user select an application. It implements the GtkAppChooser
interface.
GtkAppChooserDialog
shows a GtkAppChooserWidget
inside a GtkDialog
.
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.
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.
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().
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 AspectFrameThe 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.
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.
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.
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.
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().
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.
GtkCalendar
is a widget that displays a Gregorian calendar, one month at a time. It can be created with gtk_calendar_new().
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.
The GtkCellAreaBox
renders cell renderers into a row or a column depending on its GtkOrientation
.
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.
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.
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.
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.
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).
GtkCellRendererProgress
renders a numeric value as a progress par in a cell. Additionally, it can display a text on top of the progress bar.
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.
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.
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.
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.
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
).
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.
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.
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.
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.
The GtkColorChooserDialog
widget is a dialog for choosing a color. It implements the GtkColorChooser
interface.
since: 3.4
ColorChooserWidgetThe 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.
since: 3.4
ColorSelection ColorSelectionDialog ComboBoxA 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 ComboBoxTextA GtkComboBoxText is a simple variant of GtkComboBox
that hides the model-view complexity for simple text-only use cases.
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.
GtkCssProvider is an object implementing the GtkStyleProvider
interface. It is able to parse [CSS-like][css-overview] input in order to style widgets.
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.
DrawingAreaThe 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:.
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.
The GtkEntryBuffer
class contains the actual text displayed in a GtkEntry
widget.
since: 2.18
EntryCompletionGtkEntryCompletion
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.
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.
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.
GtkEventControllerKey
is an event controller meant for situations where you need access to key events.
GtkEventControllerMotion
is an event controller meant for situations where you need to track the position of the pointer.
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).
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
.
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
.
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
.
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.
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.
unstable since: 3.24.30
FileFilterA 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()).
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.
A GtkFlowBox positions child widgets in sequence according to its orientation.
FlowBoxAccessible FlowBoxChild FlowBoxChildAccessible FontButtonThe 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.
The GtkFontChooserDialog
widget is a dialog for selecting a font. It implements the GtkFontChooser
interface.
since: 3.2
FontChooserWidgetThe 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.
since: 3.2
FontSelection FontSelectionDialog FrameThe 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 GestureGtkGesture
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).
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().
GtkGestureLongPress
is a GtkGesture
implementation able to recognize long presses, triggering the GtkGestureLongPress::pressed
after the timeout is exceeded.
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.
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().
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.
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.
GtkGestureStylus
is a GtkGesture
implementation specific to stylus input. The provided signals just provide the basic information.
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.
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.
GtkGLArea
is a widget that allows drawing with OpenGL.
since: 3.16
GridGtkGrid is a container which arranges its child widgets in rows and columns, with arbitrary positions and horizontal/vertical spans.
HandleBoxThe 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.
GtkHBox
is a container that organizes child widgets into a single row.
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().
unstable since: 3.24.11
HPanedThe 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.
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().
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.
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.
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.
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.
Contains information found when looking up an icon in an icon theme.
IconThemeGtkIconTheme
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.
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.
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().
A GtkImageMenuItem is a menu item which has an icon next to the text label.
IMContextGtkIMContext
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.
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 InfoBarGtkInfoBar
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.
The GtkInvisible
widget is used internally in GTK+, and is probably not very useful for application developers.
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
.
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
.
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.
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.
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 ListStoreThe 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.
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().
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.
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.
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
.
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.
A GtkMenuShell
is the abstract base class used to derive the GtkMenu
and GtkMenuBar
subclasses.
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.
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.
The GtkMisc
widget is an abstract widget which is not useful itself, but is used to derive subclasses which have alignment and padding attributes.
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.
This should not be accessed directly. Use the accessor functions below.
NativeDialogNative 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.
The GtkNotebook
widget is a GtkContainer
whose children are pages that can be switched between using tab labels along one edge.
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.
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.
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.
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).
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.
GtkPaned
has two panes, arranged either horizontally or vertically. The division between the two panes is adjustable by the user by dragging a handle.
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.
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.
unstable since: 3.24.30
PopoverGtkPopover 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().
since: 3.12
PopoverAccessible PopoverMenuGtkPopoverMenu 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().
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.
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
.
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.
ProgressBarThe 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.
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.
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.
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 RadioToolButtonA 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.
GtkRange
is the common base class for widgets which visualize an adjustment, e.g GtkScale
or GtkScrollbar
.
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
.
A GtkRecentAction
represents a list of recently used files, which can be shown by widgets such as GtkRecentChooserDialog
or GtkRecentChooserMenu
.
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
.
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
.
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.
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()).
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.
since: 2.10
RendererCellAccessible RevealerThe GtkRevealer widget is a container which animates the transition of its child from invisible to visible.
ScaleA 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.
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.
The GtkScrollbar
widget is a horizontal or vertical scrollbar, depending on the value of the GtkOrientable:orientation
property.
GtkScrolledWindow is a container that accepts a single child widget and makes that child scrollable using either internally added scrollbars or externally associated adjustments.
ScrolledWindowAccessible SearchBarGtkSearchBar
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.
since: 3.10
SearchEntryGtkSearchEntry
is a subclass of GtkEntry
that has been tailored for use as a search entry.
since: 3.6
SeparatorGtkSeparator 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.
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.
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.
GtkSettings provide a mechanism to share global settings between applications.
ShortcutLabelGtkShortcutLabel
is a widget that represents a single keyboard shortcut or gesture in the user interface.
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.
ShortcutsSectionA 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.
A GtkShortcutsShortcut represents a single keyboard shortcut or gesture with a short text. This widget is only meant to be used with GtkShortcutsWindow
.
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.
SizeGroupGtkSizeGroup
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.
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.
unstable since: 3.24.30
SpinButtonA 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.
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.
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.
A GtkStackSidebar enables you to quickly and easily provide a consistent “sidebar” object for your user interface.
since: 3.16
StackSwitcherThe 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.
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).
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.
StyleA GtkStyle
object encapsulates the information that provides the look and feel for a widget.
GtkStyleContext
is an object that stores styling information affecting a widget defined by GtkWidgetPath
.
GtkStyleProperties provides the storage for style information that is used by GtkStyleContext
and other GtkStyleProvider
implementations.
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.
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.
A GtkTearoffMenuItem
is a special GtkMenuItem
which is used to tear off and reattach its menu.
You may wish to begin by reading the text widget conceptual overview which gives an overview of all the objects and data types related to the text widget and how they work together.
TextCellAccessible TextChildAnchorA 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.
You may wish to begin by reading the text widget conceptual overview which gives an overview of all the objects and data types related to the text widget and how they work together.
TextTagYou may wish to begin by reading the text widget conceptual overview which gives an overview of all the objects and data types related to the text widget and how they work together.
TextTagTableYou may wish to begin by reading the text widget conceptual overview which gives an overview of all the objects and data types related to the text widget and how they work together.
TextViewYou may wish to begin by reading the text widget conceptual overview which gives an overview of all the objects and data types related to the text widget and how they work together.
TextViewAccessible ThemingEngineGtkThemingEngine
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.
A GtkToggleAction
corresponds roughly to a GtkCheckMenuItem
. It has an “active” state specifying whether the action has been checked or not.
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.
A GtkToggleToolButton
is a GtkToolItem
that contains a toggle button.
A toolbar is created with a call to gtk_toolbar_new().
ToolButtonGtkToolButtons
are GtkToolItems
containing buttons.
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.
A GtkToolItemGroup
is used together with GtkToolPalette
to add GtkToolItems
to a palette like container with different categories and drag and drop support.
since: 2.20
ToolPaletteA GtkToolPalette
allows you to add GtkToolItems
to a palette-like container with different categories and drag and drop support.
since: 2.20
TooltipBasic tooltips can be realized simply by using gtk_widget_set_tooltip_text()
or gtk_widget_set_tooltip_markup()
without any explicit tooltip object.
A GtkTreeModelFilter
is a tree model which wraps another tree model, and can do the following things:.
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.
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.
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.
Widget that displays any object that implements the GtkTreeModel
interface.
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.
A GtkUIManager
constructs a user interface (menus and toolbars) from one or more UI definitions, which reference actions from one or more action groups.
A GtkVBox
is a container that organizes child widgets into a single column.
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.
GtkVolumeButton
is a subclass of GtkScaleButton
that has been tailored for use as a volume control widget with suitable icons, tooltips and accessible labels.
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.
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().
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.
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.
GtkWidget is the base class all widgets in GTK+ derive from. It manages the widget lifecycle, states and style.
WidgetAccessible WindowA 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 WindowGroupA GtkWindowGroup
restricts the effect of grabs to windows in the same group, thereby making window groups almost behave like separate applications.
This interface provides a convenient way of associating widgets with actions on a GtkApplicationWindow
or GtkApplication
.
since: 3.4
ActivatableActivatable 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.
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
.
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 CellEditableThe 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.
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.
GtkColorChooser
is an interface that is implemented by widgets for choosing colors. Depending on the situation, colors may be allowed to have alpha (translucency).
since: 3.4
EditableThe 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.
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.
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.
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”.
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
.
GtkScrollable
is an interface that is implemented by widgets with native scrolling ability.
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().
The GtkToolShell
interface allows container widgets to provide additional information when embedding GtkToolItem
widgets.
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.
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.
Abstract interface type for the D-Bus interface org.Gtk.MountOperationHandler.
_MountOperationHandlerIfaceVirtual table for the D-Bus interface org.Gtk.MountOperationHandler.
_MountOperationHandlerProxyThe #_GtkMountOperationHandlerProxy structure contains only private data and should only be accessed using the provided API.
_MountOperationHandlerProxyClassClass structure for #_GtkMountOperationHandlerProxy.
_MountOperationHandlerSkeletonThe #_GtkMountOperationHandlerSkeleton structure contains only private data and should only be accessed using the provided API.
_MountOperationHandlerSkeletonClassClass structure for #_GtkMountOperationHandlerSkeleton.
AccelGroupEntry AccelKey ActionEntryGtkActionEntry
structs are used with gtk_action_group_add_actions()
to construct actions.
deprecated: 3.10
BindingArgA GtkBindingArg
holds the data associated with an argument for a key binding signal emission as stored in GtkBindingSignal
.
Each key binding element of a binding sets binding list is represented by a GtkBindingEntry.
BindingSetA 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.
A GtkBindingSignal stores the necessary information to activate a widget in response to a key press via a signal emission.
BorderA struct that specifies a border around a rectangular area that can be of different width on each side.
CssSectionDefines 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.
since: 3.2
FileFilterInfoA GtkFileFilterInfo
-struct is used to pass information about the tested file to gtk_file_filter_filter().
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 IMContextInfoBookkeeping information about a loadable input method.
LabelSelectionInfo PadActionEntryStruct defining a pad action entry.
PageRangeSee also gtk_print_settings_set_page_ranges().
PaperSizeGtkPaperSize 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.
RadioActionEntryGtkRadioActionEntry
structs are used with gtk_action_group_add_radio_actions()
to construct groups of radio actions.
deprecated: 3.10
RcContext RcPropertyDeprecated.
RecentDataMeta-data to be passed to gtk_recent_manager_add_full()
when registering a recently used resource.
A GtkRecentFilterInfo struct is used to pass information about the tested file to gtk_recent_filter_filter().
RecentInfoGtkRecentInfo
-struct contains private data only, and should be accessed using the provided API.
since: 2.10
RequestedSizeRepresents 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().
RequisitionA GtkRequisition
-struct represents the desired size of a widget. See [GtkWidget’s geometry management section][geometry-management] for more information.
deprecated: 3.10
SymbolicColorGtkSymbolicColor 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.
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.
A GtkTargetList
-struct is a reference counted list of GtkTargetPair
and should be treated as opaque.
A GtkTargetPair
is used to represent the same information as a table of GtkTargetEntry
, but in an efficient form.
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.
You may wish to begin by reading the text widget conceptual overview which gives an overview of all the objects and data types related to the text widget and how they work together.
ThemeEngine ToggleActionEntryGtkToggleActionEntry
structs are used with gtk_action_group_add_toggle_actions()
to construct toggle actions.
deprecated: 3.10
TreeIterThe 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.
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().
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.
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.
Controls how a widget deals with extra space in a single (x or y) dimension.
ArrowPlacementUsed to specify the placement of scroll arrows in scrolling menus.
ArrowTypeUsed to indicate the direction in which an arrow should point.
AssistantPageTypeAn enum for determining the page role inside the GtkAssistant
. It’s used to handle buttons sensitivity and visibility.
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.
since: 3.10
BorderStyleDescribes how the border of a UI element should be rendered.
ButtonBoxStyleUsed to dictate the style that a GtkButtonBox
uses to layout the buttons it contains.
The role specifies the desired appearance of a GtkModelButton
.
Prebuilt sets of buttons for the dialog. If none of these choices are appropriate, simply use GTK_BUTTONS_NONE
then call gtk_dialog_add_buttons().
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.
CellRendererModeIdentifies how the user can interact with a particular cell.
CornerTypeSpecifies 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.
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.
since: 3.2
DeleteTypeSee also: GtkEntry::delete-from-cursor
.
Focus movement types.
DragResultGives an indication why a drag operation failed. The value can by obtained by connecting to the GtkWidget::drag-failed
signal.
Specifies the side of the entry at which an icon is placed.
since: 2.16
EventSequenceStateDescribes the state of a GdkEventSequence
in a GtkGesture
.
since: 3.14
ExpanderStyleUsed to specify the style of the expanders drawn by a GtkTreeView
.
Describes whether a GtkFileChooser
is being used to open existing files or to save to a possibly new file.
Used as a return value of handlers for the GtkFileChooser::confirm-overwrite
signal of a GtkFileChooser
. This value determines whether the file chooser will present the stock confirmation dialog, accept the user’s choice of a filename, or let the user choose another filename.
since: 2.8
IconSizeBuilt-in stock icon sizes.
IconViewDropPositionAn enum for determining where a dropped item goes.
ImageTypeDescribes 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.
Style for input method preedit. See also GtkSettings:gtk-im-preedit-style
.
deprecated: 3.10
IMStatusStyleStyle for input method status. See also GtkSettings:gtk-im-status-style
.
deprecated: 3.10
InputPurposeDescribes 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.
since: 3.6
JustificationUsed for justifying the text inside a GtkLabel
widget. (See also GtkAlignment
).
Describes how GtkLevelBar
contents should be rendered. Note that this enumeration could be extended with additional modes in the future.
since: 3.6
LicenseThe type of license for an application.
since: 3.0
MenuDirectionTypeAn enumeration representing directional movements within a menu.
MessageTypeThe type of message being displayed in the dialog.
MovementStep NotebookTab NumberUpLayoutUsed to determine the layout of pages on a sheet when printing multiple pages per sheet.
OrientationRepresents the orientation of widgets and other objects which can be switched between horizontal and vertical orientation on the fly, like GtkToolbar
or GtkGesturePan
.
Determines how widgets should be packed inside menubars and menuitems contained in menubars.
PackTypeRepresents the packing location GtkBox
children. (See: GtkVBox
, GtkHBox
, and GtkButtonBox
).
The type of a pad action.
PageOrientationSee also gtk_print_settings_set_orientation().
PageSetSee also gtk_print_job_set_page_set().
PanDirectionDescribes the panning direction of a GtkGesturePan
.
since: 3.14
PathPriorityTypePriorities for path lookups. See also gtk_binding_set_add_path().
deprecated: 3.0
PathTypeWidget path types. See also gtk_binding_set_add_path().
deprecated: 3.0
PolicyTypeDetermines how the size should be computed to achieve the one of the visibility mode for the scrollbars.
PopoverConstraintDescribes constraints to positioning of popovers. More values may be added to this enumeration in the future.
since: 3.20
PositionTypeDescribes which edge of a widget a certain feature is positioned at, e.g. the tabs of a GtkNotebook
, the handle of a GtkHandleBox
or the label of a GtkScale
.
See also gtk_print_settings_set_duplex().
PrintOperationActionThe action
parameter to gtk_print_operation_run()
determines what action the print operation should perform.
A value of this type is returned by gtk_print_operation_run().
PrintPagesSee also gtk_print_job_set_pages().
PrintQualitySee also gtk_print_settings_set_quality().
PrintStatusThe status gives a rough indication of the completion of a running print operation.
PropagationPhaseDescribes the stage at which events are fed into a GtkEventController
.
since: 3.14
RcTokenTypeThe 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.
deprecated: 3.0
RecentSortTypeUsed to specify the sorting method to be applyed to the recently used resource list.
since: 2.10
ReliefStyleIndicated the relief to be drawn around a GtkButton
.
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.
RevealerTransitionTypeThese enumeration values describe the possible transitions when the child of a GtkRevealer
widget is shown or hidden.
Defines the policy to be used in a scrollable widget when updating the scrolled window adjustments in a given orientation.
ScrollStep ScrollTypeScrolling types.
SelectionModeUsed to control what selections users are allowed to make.
SensitivityTypeDetermines how GTK+ handles the sensitivity of stepper arrows at the end of range widgets.
ShadowTypeUsed to change the appearance of an outline typically provided by a GtkFrame
.
GtkShortcutType specifies the kind of shortcut that is being described. More values may be added to this enumeration over time.
since: 3.20
SizeGroupModeThe mode of the size group determines the directions in which the size group affects the requested sizes of its component widgets.
SizeRequestModeSpecifies a preference for height-for-width or width-for-height geometry management.
SortTypeDetermines the direction of a sort.
SpinButtonUpdatePolicyThe 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().
SpinTypeThe values of the GtkSpinType enumeration are used to specify the change to make in gtk_spin_button_spin().
StackTransitionTypeThese enumeration values describe the possible transitions between pages in a GtkStack
widget.
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.
deprecated: 3.14
TextBufferTargetInfoThese 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().
Reading directions for text.
TextExtendSelectionGranularity types that extend the text selection. Use the GtkTextView::extend-selection
signal to customize the selection.
since: 3.16
TextViewLayerUsed to reference the layers of GtkTextView
for the purpose of customized drawing with the ::draw_layer vfunc.
Used to reference the parts of GtkTextView
.
Whether spacers are vertical lines or just blank.
deprecated: 3.20
ToolbarStyleUsed to customize the appearance of a GtkToolbar
. Note that setting the toolbar style overrides the user’s preferences for the default toolbar style. Note that if the button has only a label set and GTK_TOOLBAR_ICONS is used, the label will be visible, and vice versa.
The sizing method the column uses to determine its width. Please note that GTK_TREE_VIEW_COLUMN_AUTOSIZE
are inefficient for large views, and can make columns appear choppy.
An enum for determining where a dropped row goes.
TreeViewGridLinesUsed to indicate which grid lines to draw in a tree view.
UnitSee also gtk_print_settings_set_paper_width().
WidgetHelpTypeKinds of widget-specific help. Used by the ::show-help signal.
WindowPositionWindow 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.
WindowTypeA 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
keybindings won’t work on them, the window manager won’t decorate the window with a frame, many GTK+ features that rely on the window manager will not work (e.g. resize grips and maximization/minimization). #GTK_WINDOW_POPUP is used to implement widgets such as GtkMenu
or tooltips that you normally don’t think of as windows per se. Nearly all windows should be #GTK_WINDOW_TOPLEVEL. In particular, do not use #GTK_WINDOW_POPUP just to turn off the window borders; use gtk_window_set_decorated()
for that.
Describes a type of line wrapping.
AccelFlagsAccelerator flags used with gtk_accel_group_connect().
ApplicationInhibitFlagsTypes of user actions that may be blocked by gtk_application_inhibit().
since: 3.4
AttachOptionsDenotes the expansion properties that a widget will have when it (or its parent) is resized.
CalendarDisplayOptionsThese options can be used to influence the display and behaviour of a GtkCalendar
.
Tells how a cell is to be rendered.
DebugFlag DestDefaultsThe GtkDestDefaults
enumeration specifies the various types of action that will be taken on behalf of the user for a drag destination site.
Flags used to influence dialog construction.
EventControllerScrollFlagsDescribes the behavior of a GtkEventControllerScroll
.
since: 3.24
FileFilterFlagsThese flags indicate what parts of a GtkFileFilterInfo
struct are filled or need to be filled.
This enumeration specifies the granularity of font selection that is desired in a font chooser.
IconLookupFlagsUsed to specify options for gtk_icon_theme_lookup_icon().
InputHintsDescribes 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.
since: 3.6
JunctionSidesDescribes how a rendered element connects to adjacent elements.
PlacesOpenFlagsThese 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.
Deprecated.
RecentFilterFlagsThese flags indicate what parts of a GtkRecentFilterInfo
struct are filled or need to be filled.
Describes a region within a widget.
StateFlagsDescribes 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.
StyleContextPrintFlagsFlags that modify the behavior of gtk_style_context_to_string(). New values may be added to this enumeration.
TargetFlagsThe GtkTargetFlags
enumeration is used to specify constraints on a GtkTargetEntry
.
Flags affecting how a search is done.
ToolPaletteDragTargetsFlags used to specify the supported drag targets.
TreeModelFlagsThese flags indicate various properties of a GtkTreeModel
.
These enumeration values are used by gtk_ui_manager_add_ui()
to determine what UI element to create.
deprecated: 3.10
Error Domains BuilderErrorError codes that identify various errors that can occur while using GtkBuilder
.
Error codes for GTK_CSS_PROVIDER_ERROR
.
These identify the various errors that can occur while calling GtkFileChooser
functions.
Error codes for GtkIconTheme operations.
PrintErrorError codes that identify various errors that can occur while using the GTK+ printing support.
RecentChooserErrorThese identify the various errors that can occur while calling GtkRecentChooser
functions.
since: 2.10
RecentManagerErrorError codes for GtkRecentManager
operations.
since: 2.10
AccelGroupActivate AccelGroupFindFuncsince: 2.2
AccelMapForeach AssistantPageFuncA function used by gtk_assistant_set_forward_page_func()
to know which is the next page given a current one. It’s called both for computing the next page when the user presses the “forward” button and for handling the behavior of the “last” button.
This is the signature of a function used to connect signals. It is used by the gtk_builder_connect_signals()
and gtk_builder_connect_signals_full()
methods. It is mainly intended for interpreted language bindings, but could be useful where the programmer wants more control over the signal connection process. Note that this function can only be called once, subsequent calls will do nothing.
since: 2.12
CalendarDetailFuncThis 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.
since: 2.14
CallbackThe type of the callback functions used for e.g. iterating over the children of a container, see gtk_container_foreach().
CellAllocCallbackThe type of the callback functions used for iterating over the cell renderers and their allocated areas inside a GtkCellArea
, see gtk_cell_area_foreach_alloc().
The type of the callback functions used for iterating over the cell renderers of a GtkCellArea
, see gtk_cell_area_foreach().
A function which should set the value of cell_layout
’s cell renderer(s) as appropriate.
A function that will be called when the contents of the clipboard are changed or cleared. Once this has called, the user_data_or_owner
argument will not be used again.
A function that will be called to provide the contents of the selection. If multiple types of data were advertised, the requested type can be determined from the info
parameter or by checking the target field of selection_data
. If the data could successfully be converted into then it should be stored into the selection_data
object by calling gtk_selection_data_set()
(or related functions such as gtk_selection_data_set_text()). If no data is set, the requestor will be informed that the attempt to get the data failed.
A function to be called when the results of gtk_clipboard_request_image()
are received, or when the request fails.
since: 2.6
ClipboardReceivedFuncA function to be called when the results of gtk_clipboard_request_contents()
are received, or when the request fails.
A function to be called when the results of gtk_clipboard_request_rich_text()
are received, or when the request fails.
since: 2.10
ClipboardTargetsReceivedFuncA function to be called when the results of gtk_clipboard_request_targets()
are received, or when the request fails.
since: 2.4
ClipboardTextReceivedFuncA function to be called when the results of gtk_clipboard_request_text()
are received, or when the request fails.
A function to be called when the results of gtk_clipboard_request_uris()
are received, or when the request fails.
since: 2.14
ColorSelectionChangePaletteFuncdeprecated: 3.4
ColorSelectionChangePaletteWithScreenFuncdeprecated: 3.4 since: 2.2
EntryCompletionMatchFuncA function which decides whether the row indicated by iter
matches a given key
, and should be displayed as a possible completion for key
. Note that key
is normalized and case-folded (see g_utf8_normalize()
and g_utf8_casefold()). If this is not appropriate, match functions have access to the unmodified key via gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry ()))
.
The type of function that is used with custom filters, see gtk_file_filter_add_custom().
FlowBoxCreateWidgetFuncCalled for flow boxes that are bound to a GListModel
with gtk_flow_box_bind_model()
for each item that gets added to the model.
since: 3.18
FlowBoxFilterFuncA function that will be called whenrever a child changes or is added. It lets you control if the child should be visible or not.
since: 3.12
FlowBoxForeachFuncA function used by gtk_flow_box_selected_foreach(). It will be called on every selected child of the box
.
since: 3.12
FlowBoxSortFuncA function to compare two children to determine which should come first.
since: 3.12
FontFilterFuncThe type of function that is used for deciding what fonts get shown in a GtkFontChooser
. See gtk_font_chooser_set_filter_func().
A function used by gtk_icon_view_selected_foreach()
to map all selected rows. It will be called on every selected row in the view.
Key snooper functions are called before normal event delivery. They can be used to implement custom key event handling.
ListBoxCreateWidgetFuncCalled for list boxes that are bound to a GListModel
with gtk_list_box_bind_model()
for each item that gets added to the model.
since: 3.16
ListBoxFilterFuncWill be called whenever the row changes or is added and lets you control if the row should be visible or not.
since: 3.10
ListBoxForeachFuncA function used by gtk_list_box_selected_foreach(). It will be called on every selected child of the box
.
since: 3.14
ListBoxSortFuncCompare two rows to determine which should be first.
since: 3.10
ListBoxUpdateHeaderFuncWhenever 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.
since: 3.10
MenuDetachFuncA user function supplied when calling gtk_menu_attach_to_widget()
which will be called when the menu is later detached from the widget.
A user function supplied when calling gtk_menu_popup()
which controls the positioning of the menu when it is displayed. The function sets the x
and y
parameters to the coordinates where the menu is to be drawn. To make the menu appear on a different monitor than the mouse pointer, gtk_menu_set_monitor()
must be called.
A multihead-aware GTK+ module may have a gtk_module_display_init()
function with this prototype. GTK+ calls this function for each opened display.
since: 2.2
ModuleInitFuncEach GTK+ module must have a function gtk_module_init()
with this prototype. This function is called after loading the module.
The type of function that is passed to gtk_print_run_page_setup_dialog_async().
PrintSettingsFunc RcPropertyParser RecentFilterFuncThe type of function that is used with custom filters, see gtk_recent_filter_add_custom().
RecentSortFunc StylePropertyParser TextBufferDeserializeFuncA function that is called to deserialize rich text that has been serialized with gtk_text_buffer_serialize(), and insert it at iter
.
A function that is called to serialize the content of a text buffer. It must return the serialized form of the content.
TextCharPredicate TextTagTableForeach TickCallbackCallback type for adding a function to update animations. See gtk_widget_add_tick_callback().
since: 3.8
TranslateFuncThe function used to translate messages in e.g. GtkIconFactory
and GtkActionGroup
.
deprecated: 3.10
TreeCellDataFuncA 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().
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.
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
.
A function which decides whether the row indicated by iter
is visible.
Type of the callback passed to gtk_tree_model_foreach()
to iterate over the rows in a tree model.
A function used by gtk_tree_selection_selected_foreach()
to map all selected rows. It will be called on every selected row in the view.
A function used by gtk_tree_selection_set_select_function()
to filter whether or not a row may be selected. It is called whenever a row’s state might change. A return value of TRUE
indicates to selection
that it is okay to change the selection.
Function type for determining whether column
can be dropped in a particular spot (as determined by prev_column
and next_column
). In left to right locales, prev_column
is on the left of the potential drop spot, and next_column
is on the right. In right to left mode, this is reversed. This function should return TRUE
if the spot is a valid drop spot. Please note that returning TRUE
does not actually indicate that the column drop was made, but is meant only to indicate a possible drop spot to the user.
Function used for gtk_tree_view_map_expanded_rows().
TreeViewRowSeparatorFuncFunction type for determining whether the row pointed to by iter
should be rendered as a separator. A common way to implement this is to have a boolean column in the model, whose values the GtkTreeViewRowSeparatorFunc
returns.
A function used for checking whether a row in model
matches a search key string entered by the user. Note the return value is reversed from what you would normally expect, though it has some similarity to strcmp()
returning 0 for equal strings.
Finds the first accelerator in any GtkAccelGroup
attached to object
that matches accel_key
and accel_mods
, and activates that accelerator.
Gets a list of all accel groups which are attached to object
.
Gets the modifier mask.
accelerator_get_labelConverts an accelerator keyval and modifier mask into a string which can be used to represent the accelerator to the user.
since: 2.6
accelerator_get_label_with_keycodeConverts 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.
since: 3.4
accelerator_nameConverts 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_keycodeConverts 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.
since: 3.4
accelerator_parseParses a string representing an accelerator. The format looks like “ a” or “ F1” or “ z” (the last one is for key release).
accelerator_parse_with_keycodeParses 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.
since: 3.4
accelerator_set_default_mod_maskSets 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 |
In other words, Control, Shift, Alt, Super, Hyper and Meta. Other modifiers will by default be ignored by GtkAccelGroup
.
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_orderReturns 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.
deprecated: 3.10 since: 2.6
bindings_activateFind a key binding matching keyval
and modifiers
and activate the binding on object
.
Looks up key bindings for object
to find one matching event
, and if one was found, activate it.
since: 2.4
cairo_should_draw_windowThis 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.
since: 3.0
cairo_transform_to_windowTransforms 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.
since: 3.0
check_versionChecks 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_VERSIONas 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_addAdds 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.
since: 3.0
device_grab_removeRemoves a device grab from the given widget.
since: 3.0
disable_setlocalePrevents 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.
Distributes extra_space
to child sizes
by bringing smaller children up to natural size first.
Cancels an ongoing drag operation on the source side.
since: 3.16
drag_finishInforms the drag source that the drop is finished, and that the data of the drag will no longer be required.
drag_get_source_widgetDetermines the source widget for a drag.
drag_set_icon_defaultSets the icon for a particular drag to the default icon.
drag_set_icon_giconSets 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.
since: 3.2
drag_set_icon_nameSets 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.
since: 2.8
drag_set_icon_pixbufSets pixbuf
as the icon for a given drag.
Sets the icon for a given drag from a stock ID.
deprecated: 3.10
drag_set_icon_surfaceSets surface
as the icon for a given drag. GTK+ retains references for the arguments, and will release them when they are no longer needed.
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_cursorDraws a text caret on cr
at location
. This is not a style function but merely a convenience function for drawing the standard cursor shape.
deprecated: 3.4 since: 3.0
events_pendingChecks if any events are pending.
falseAnalogical to gtk_true(), this function does nothing but always returns FALSE
.
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.
since: 3.0
get_current_eventObtains a copy of the event currently being processed by GTK+.
get_current_event_deviceIf there is a current event and it has a device, return that device, otherwise return NULL
.
If there is a current event and it has a state field, place that state field in state
and return TRUE
, otherwise return FALSE
.
If there is a current event and it has a timestamp, return that timestamp, otherwise return GDK_CURRENT_TIME
.
Returns the GTK+ debug flags.
get_default_languageReturns 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.
If event
is NULL
or the event was not associated with any widget, returns NULL
, otherwise returns the widget that received the event originally.
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.
since: 3.0
get_locale_directionGet the direction of the current locale. This is the expected reading direction for text and UI.
since: 3.12
get_major_versionReturns the major version number of the GTK+ library. (e.g. in GTK+ version 3.1.5 this is 3.).
since: 3.0
get_micro_versionReturns the micro version number of the GTK+ library. (e.g. in GTK+ version 3.1.5 this is 5.).
since: 3.0
get_minor_versionReturns the minor version number of the GTK+ library. (e.g. in GTK+ version 3.1.5 this is 1.).
since: 3.0
get_option_groupReturns a GOptionGroup
for the commandline arguments recognized by GTK+ and GDK.
since: 2.6
grab_get_currentQueries the current grab of the default window group.
initCall 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_checkThis 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.
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.
since: 2.6
key_snooper_installInstalls a key snooper function, which will get called on all key events before delivering them normally.
deprecated: 3.4
key_snooper_removeRemoves the key snooper function with the given id.
deprecated: 3.4
mainRuns the main loop until gtk_main_quit()
is called.
Processes a single GDK event.
main_iterationRuns a single iteration of the mainloop.
main_iteration_doRuns a single iteration of the mainloop. If no events are available either return or block depending on the value of blocking
.
Asks for the current nesting level of the main loop.
main_quitMakes the innermost invocation of the main loop return when it regains control.
paint_arrowDraws an arrow in the given rectangle on cr
using the given parameters. arrow_type
determines the direction of the arrow.
deprecated: 3.0
paint_boxDraws a box on cr
with the given parameters.
deprecated: 3.0
paint_box_gapDraws a box in cr
using the given style and state and shadow type, leaving a gap in one side.
deprecated: 3.0
paint_checkDraws a check button indicator in the given rectangle on cr
with the given parameters.
deprecated: 3.0
paint_diamondDraws a diamond in the given rectangle on window
using the given parameters.
deprecated: 3.0
paint_expanderDraws 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.
deprecated: 3.0
paint_extensionDraws an extension, i.e. a notebook tab.
deprecated: 3.0
paint_flat_boxDraws a flat box on cr
with the given parameters.
deprecated: 3.0
paint_focusDraws a focus indicator around the given rectangle on cr
using the given style.
deprecated: 3.0
paint_handleDraws a handle as used in GtkHandleBox
and GtkPaned
.
deprecated: 3.0
paint_hlineDraws a horizontal line from (x1
, y
) to (x2
, y
) in cr
using the given style and state.
deprecated: 3.0
paint_layoutDraws a layout on cr
using the given parameters.
deprecated: 3.0
paint_optionDraws a radio button indicator in the given rectangle on cr
with the given parameters.
deprecated: 3.0
paint_resize_gripDraws a resize grip in the given rectangle on cr
using the given parameters.
deprecated: 3.0
paint_shadowDraws a shadow around the given rectangle in cr
using the given style and state and shadow type.
deprecated: 3.0
paint_shadow_gapDraws a shadow around the given rectangle in cr
using the given style and state and shadow type, leaving a gap in one side.
deprecated: 3.0
paint_sliderDraws a slider in the given rectangle on cr
using the given style and orientation.
deprecated: 3.0
paint_spinnerDraws a spinner on window
using the given parameters.
deprecated: 3.0
paint_tabDraws an option menu tab (i.e. the up and down pointing arrows) in the given rectangle on cr
using the given parameters.
deprecated: 3.0
paint_vlineDraws a vertical line from (x
, y1_
) to (x
, y2_
) in cr
using the given style and state.
deprecated: 3.0
parse_argsParses 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_dialogRuns 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.
since: 2.10
print_run_page_setup_dialog_asyncRuns a page setup dialog, letting the user modify the values from page_setup
.
since: 2.10
propagate_eventSends an event to a widget, propagating the event to parent widgets if the event remains unhandled.
rc_add_default_fileAdds a file to the list of files to be parsed at the end of gtk_init().
deprecated: 3.0
rc_find_module_in_pathSearches for a theme engine in the GTK+ search path. This function is not useful for applications and should not be used.
deprecated: 3.0
rc_find_pixmap_in_pathLooks 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
.
deprecated: 3.0
rc_get_default_filesRetrieves the current list of RC files that will be parsed at the end of gtk_init().
deprecated: 3.0
rc_get_im_module_fileObtains the path to the IM modules file. See the documentation of the GTK_IM_MODULE_FILE
environment variable for more details.
deprecated: 3.0
rc_get_im_module_pathObtains 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.
deprecated: 3.0
rc_get_module_dirReturns 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].
deprecated: 3.0
rc_get_styleFinds 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.).
deprecated: 3.0
rc_get_style_by_pathsCreates 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.
deprecated: 3.0
rc_get_theme_dirReturns the standard directory in which themes should be installed. (GTK+ does not actually use this directory itself.).
deprecated: 3.0
rc_parseParses a given resource file.
deprecated: 3.0
rc_parse_colorParses a color in the format expected in a RC file.
deprecated: 3.0
rc_parse_color_fullParses 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.
deprecated: 3.0 since: 2.12
rc_parse_priorityParses a GtkPathPriorityType
variable from the format expected in a RC file.
deprecated: 3.0
rc_parse_stateParses a GtkStateType
variable from the format expected in a RC file.
deprecated: 3.0
rc_parse_stringParses resource information directly from a string.
deprecated: 3.0
rc_reparse_allIf 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.
deprecated: 3.0
rc_reparse_all_for_settingsIf 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.
deprecated: 3.0
rc_reset_stylesThis 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().
deprecated: 3.0 since: 2.4
rc_scanner_newdeprecated: 3.0
rc_set_default_filesSets the list of files that GTK+ will read at the end of gtk_init().
deprecated: 3.0
render_activityRenders an activity indicator (such as in GtkSpinner
). The state GTK_STATE_FLAG_CHECKED
determines whether there is activity going on.
since: 3.0
render_arrowRenders an arrow pointing to angle
.
since: 3.0
render_backgroundRenders the background of an element.
since: 3.0
render_background_get_clipReturns the area that will be affected (i.e. drawn to) when calling gtk_render_background()
for the given context
and rectangle.
since: 3.20
render_checkRenders a checkmark (as in a GtkCheckButton
).
since: 3.0
render_expanderRenders 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.
since: 3.0
render_extensionRenders 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
.
since: 3.0
render_focusRenders a focus indicator on the rectangle determined by x
, y
, width
, height
.
since: 3.0
render_frameRenders a frame around the rectangle defined by x
, y
, width
, height
.
since: 3.0
render_frame_gapRenders 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
.
deprecated: 3.24 since: 3.0
render_handleRenders a handle (as in GtkHandleBox
, GtkPaned
and GtkWindow
’s resize grip), in the rectangle determined by x
, y
, width
, height
.
since: 3.0
render_iconRenders the icon in pixbuf
at the specified x
and y
coordinates.
since: 3.2
render_icon_pixbufRenders the icon specified by source
at the given size
, returning the result in a pixbuf.
deprecated: 3.10 since: 3.0
render_icon_surfaceRenders the icon in surface
at the specified x
and y
coordinates.
since: 3.10
render_insertion_cursorDraws a text caret on cr
at the specified index of layout
.
since: 3.4
render_layoutRenders layout
on the coordinates x
, y
.
since: 3.0
render_lineRenders a line from (x0, y0) to (x1, y1).
since: 3.0
render_optionRenders 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.
since: 3.0
render_sliderRenders a slider (as in GtkScale
) in the rectangle defined by x
, y
, width
, height
. orientation
defines whether the slider is vertical or horizontal.
since: 3.0
rgb_to_hsvConverts a color from RGB space to HSV.
since: 2.14
selection_add_targetAppends a specified target to the list of supported targets for a given widget and selection.
selection_add_targetsPrepends a table of targets to the list of supported targets for a given widget and selection.
selection_clear_targetsRemove all targets registered for the given selection for the widget.
selection_convertRequests the contents of a selection. When received, a “selection-received” signal will be generated.
selection_owner_setClaims ownership of a given selection for a particular widget, or, if widget
is NULL
, release ownership of the selection.
Claim ownership of a given selection for a particular widget, or, if widget
is NULL
, release ownership of the selection.
since: 2.2
selection_remove_allRemoves 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_flagsSets the GTK+ debug flags.
show_about_dialogThis 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.
since: 2.6
show_uriA 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.
deprecated: 3.22 since: 2.14
show_uri_on_windowThis 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
.
since: 3.22
stock_addRegisters 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.
deprecated: 3.10
stock_add_staticSame as gtk_stock_add(), but doesn’t copy items
, so items
must persist until application exit.
deprecated: 3.10
stock_list_idsRetrieves 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().
deprecated: 3.10
stock_lookupFills item
with the registered values for stock_id
, returning TRUE
if stock_id
was known.
deprecated: 3.10
stock_set_translate_funcSets a function to be used for translating the label
of a stock item.
deprecated: 3.10 since: 2.8
target_table_freeThis function frees a target table as returned by gtk_target_table_new_from_list().
since: 2.10
target_table_new_from_listThis 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.
since: 2.10
targets_include_imageDetermines if any of the targets in targets
can be used to provide a GdkPixbuf
.
since: 2.10
targets_include_rich_textDetermines if any of the targets in targets
can be used to provide rich text.
since: 2.10
targets_include_textDetermines if any of the targets in targets
can be used to provide text.
since: 2.10
targets_include_uriDetermines if any of the targets in targets
can be used to provide an uri list.
since: 2.10
test_create_simple_windowCreate 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.
deprecated: 3.20 since: 2.14
test_create_widgetThis 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.
deprecated: 3.20 since: 2.14
test_display_button_windowCreate 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.
deprecated: 3.20 since: 2.14
test_find_labelThis 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.
since: 2.14
test_find_siblingThis 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.
since: 2.14
test_find_widgetThis 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.
since: 2.14
test_initThis function is used to initialize a GTK+ test program.
since: 2.14
test_list_all_typesReturn the type ids that have been registered after calling gtk_test_register_all_types().
since: 2.14
test_register_all_typesForce 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.
since: 2.14
test_slider_get_valueRetrive 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().
deprecated: 3.20 since: 2.14
test_slider_set_percThis 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.
deprecated: 3.20 since: 2.14
test_spin_button_clickThis 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.
deprecated: 3.20 since: 2.14
test_text_getRetrive the text string of widget
if it is a GtkLabel, GtkEditable (entry and text widgets) or GtkTextView.
deprecated: 3.20 since: 2.14
test_text_setSet the text string of widget
to string
if it is a GtkLabel, GtkEditable (entry and text widgets) or GtkTextView.
deprecated: 3.20 since: 2.14
test_widget_clickThis 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.
deprecated: 3.20 since: 2.14
test_widget_send_keyThis 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.
since: 2.14
test_widget_wait_for_drawEnters 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.
since: 3.10
tree_get_row_drag_dataObtains 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().
Sets selection data of target type GTK_TREE_MODEL_ROW
. Normally used in a drag_data_get handler.
All this function does it to return TRUE
.
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_ERRORConstant to return from a signal handler for the GtkSpinButton::input
signal in case of conversion failure.
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_FULLThe name used for the stock full offset included by GtkLevelBar
.
The name used for the stock high offset included by GtkLevelBar
.
The name used for the stock low offset included by GtkLevelBar
.
Like gtk_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_LENThe maximum length of sequences in compose tables.
MICRO_VERSIONLike 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_VERSIONLike 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_A3Name for the A3 paper size.
PAPER_NAME_A4Name for the A4 paper size.
PAPER_NAME_A5Name for the A5 paper size.
PAPER_NAME_B5Name for the B5 paper size.
PAPER_NAME_EXECUTIVEName for the Executive paper size.
PAPER_NAME_LEGALName for the Legal paper size.
PAPER_NAME_LETTERName 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_BASENAMEThe 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_DIRThe key used by the “Print to file” printer to store the directory to which the output should be written.
PRINT_SETTINGS_OUTPUT_FILE_FORMATThe 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_URIThe 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_RESIZEUse this priority for functionality related to size allocation.
STOCK_ABOUTThe “About” item. .
deprecated: 3.10
STOCK_ADDThe “Add” item and icon.
deprecated: 3.10
STOCK_APPLYThe “Apply” item and icon.
deprecated: 3.10
STOCK_BOLDThe “Bold” item and icon.
deprecated: 3.10
STOCK_CANCELThe “Cancel” item and icon.
deprecated: 3.10
STOCK_CAPS_LOCK_WARNINGThe “Caps Lock Warning” icon.
deprecated: 3.10
STOCK_CDROMThe “CD-Rom” item and icon.
deprecated: 3.10
STOCK_CLEARThe “Clear” item and icon.
deprecated: 3.10
STOCK_CLOSEThe “Close” item and icon.
deprecated: 3.10
STOCK_COLOR_PICKERThe “Color Picker” item and icon.
deprecated: 3.10
STOCK_CONNECTThe “Connect” icon.
deprecated: 3.10
STOCK_CONVERTThe “Convert” item and icon.
deprecated: 3.10
STOCK_COPYThe “Copy” item and icon.
deprecated: 3.10
STOCK_CUTThe “Cut” item and icon.
deprecated: 3.10
STOCK_DELETEThe “Delete” item and icon.
deprecated: 3.10
STOCK_DIALOG_AUTHENTICATIONThe “Authentication” item and icon.
deprecated: 3.10
STOCK_DIALOG_ERRORThe “Error” item and icon.
deprecated: 3.10
STOCK_DIALOG_INFOThe “Information” item and icon.
deprecated: 3.10
STOCK_DIALOG_QUESTIONThe “Question” item and icon.
deprecated: 3.10
STOCK_DIALOG_WARNINGThe “Warning” item and icon.
deprecated: 3.10
STOCK_DIRECTORYThe “Directory” icon.
deprecated: 3.10
STOCK_DISCARDThe “Discard” item.
deprecated: 3.10
STOCK_DISCONNECTThe “Disconnect” icon.
deprecated: 3.10
STOCK_DNDThe “Drag-And-Drop” icon.
deprecated: 3.10
STOCK_DND_MULTIPLEThe “Drag-And-Drop multiple” icon.
deprecated: 3.10
STOCK_EDITThe “Edit” item and icon.
deprecated: 3.10
STOCK_EXECUTEThe “Execute” item and icon.
deprecated: 3.10
STOCK_FILEThe “File” item and icon.
deprecated: 3.10
STOCK_FINDThe “Find” item and icon.
deprecated: 3.10
STOCK_FIND_AND_REPLACEThe “Find and Replace” item and icon.
deprecated: 3.10
STOCK_FLOPPYThe “Floppy” item and icon.
deprecated: 3.10
STOCK_FULLSCREENThe “Fullscreen” item and icon.
deprecated: 3.10
STOCK_GO_BACKThe “Back” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_GO_DOWNThe “Down” item and icon.
deprecated: 3.10
STOCK_GO_FORWARDThe “Forward” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_GO_UPThe “Up” item and icon.
deprecated: 3.10
STOCK_GOTO_BOTTOMThe “Bottom” item and icon.
deprecated: 3.10
STOCK_GOTO_FIRSTThe “First” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_GOTO_LASTThe “Last” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_GOTO_TOPThe “Top” item and icon.
deprecated: 3.10
STOCK_HARDDISKThe “Harddisk” item and icon.
deprecated: 3.10
STOCK_HELPThe “Help” item and icon.
deprecated: 3.10
STOCK_HOMEThe “Home” item and icon.
deprecated: 3.10
STOCK_INDENTThe “Indent” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_INDEXThe “Index” item and icon.
deprecated: 3.10
STOCK_INFOThe “Info” item and icon.
deprecated: 3.10
STOCK_ITALICThe “Italic” item and icon.
deprecated: 3.10
STOCK_JUMP_TOThe “Jump to” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_JUSTIFY_CENTERThe “Center” item and icon.
deprecated: 3.10
STOCK_JUSTIFY_FILLThe “Fill” item and icon.
deprecated: 3.10
STOCK_JUSTIFY_LEFTThe “Left” item and icon.
deprecated: 3.10
STOCK_JUSTIFY_RIGHTThe “Right” item and icon.
deprecated: 3.10
STOCK_LEAVE_FULLSCREENThe “Leave Fullscreen” item and icon.
deprecated: 3.10
STOCK_MEDIA_FORWARDThe “Media Forward” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_MEDIA_NEXTThe “Media Next” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_MEDIA_PAUSEThe “Media Pause” item and icon.
deprecated: 3.10
STOCK_MEDIA_PLAYThe “Media Play” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_MEDIA_PREVIOUSThe “Media Previous” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_MEDIA_RECORDThe “Media Record” item and icon.
deprecated: 3.10
STOCK_MEDIA_REWINDThe “Media Rewind” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_MEDIA_STOPThe “Media Stop” item and icon.
deprecated: 3.10
STOCK_MISSING_IMAGEThe “Missing image” icon.
deprecated: 3.10
STOCK_NETWORKThe “Network” item and icon.
deprecated: 3.10
STOCK_NEWThe “New” item and icon.
deprecated: 3.10
STOCK_NOThe “No” item and icon.
deprecated: 3.10
STOCK_OKThe “OK” item and icon.
deprecated: 3.10
STOCK_OPENThe “Open” item and icon.
deprecated: 3.10
STOCK_ORIENTATION_LANDSCAPEThe “Landscape Orientation” item and icon.
deprecated: 3.10
STOCK_ORIENTATION_PORTRAITThe “Portrait Orientation” item and icon.
deprecated: 3.10
STOCK_ORIENTATION_REVERSE_LANDSCAPEThe “Reverse Landscape Orientation” item and icon.
deprecated: 3.10
STOCK_ORIENTATION_REVERSE_PORTRAITThe “Reverse Portrait Orientation” item and icon.
deprecated: 3.10
STOCK_PAGE_SETUPThe “Page Setup” item and icon.
deprecated: 3.10
STOCK_PASTEThe “Paste” item and icon.
deprecated: 3.10
STOCK_PREFERENCESThe “Preferences” item and icon.
deprecated: 3.10
STOCK_PRINTThe “Print” item and icon.
deprecated: 3.10
STOCK_PRINT_ERRORThe “Print Error” icon.
deprecated: 3.10
STOCK_PRINT_PAUSEDThe “Print Paused” icon.
deprecated: 3.10
STOCK_PRINT_PREVIEWThe “Print Preview” item and icon.
deprecated: 3.10
STOCK_PRINT_REPORTThe “Print Report” icon.
deprecated: 3.10
STOCK_PRINT_WARNINGThe “Print Warning” icon.
deprecated: 3.10
STOCK_PROPERTIESThe “Properties” item and icon.
deprecated: 3.10
STOCK_QUITThe “Quit” item and icon.
deprecated: 3.10
STOCK_REDOThe “Redo” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_REFRESHThe “Refresh” item and icon.
deprecated: 3.10
STOCK_REMOVEThe “Remove” item and icon.
deprecated: 3.10
STOCK_REVERT_TO_SAVEDThe “Revert” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_SAVEThe “Save” item and icon.
deprecated: 3.10
STOCK_SAVE_ASThe “Save As” item and icon.
deprecated: 3.10
STOCK_SELECT_ALLThe “Select All” item and icon.
deprecated: 3.10
STOCK_SELECT_COLORThe “Color” item and icon.
deprecated: 3.10
STOCK_SELECT_FONTThe “Font” item and icon.
deprecated: 3.10
STOCK_SORT_ASCENDINGThe “Ascending” item and icon.
deprecated: 3.10
STOCK_SORT_DESCENDINGThe “Descending” item and icon.
deprecated: 3.10
STOCK_SPELL_CHECKThe “Spell Check” item and icon.
deprecated: 3.10
STOCK_STOPThe “Stop” item and icon.
deprecated: 3.10
STOCK_STRIKETHROUGHThe “Strikethrough” item and icon.
deprecated: 3.10
STOCK_UNDELETEThe “Undelete” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_UNDERLINEThe “Underline” item and icon.
deprecated: 3.10
STOCK_UNDOThe “Undo” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_UNINDENTThe “Unindent” item and icon. The icon has an RTL variant.
deprecated: 3.10
STOCK_YESThe “Yes” item and icon.
deprecated: 3.10
STOCK_ZOOM_100The “Zoom 100%” item and icon.
deprecated: 3.10
STOCK_ZOOM_FITThe “Zoom to Fit” item and icon.
deprecated: 3.10
STOCK_ZOOM_INThe “Zoom In” item and icon.
deprecated: 3.10
STOCK_ZOOM_OUTThe “Zoom Out” item and icon.
deprecated: 3.10
STYLE_CLASS_ACCELERATORA CSS class to match an accelerator.
STYLE_CLASS_ARROWA CSS class used when rendering an arrow element.
STYLE_CLASS_BACKGROUNDA CSS class to match the window background.
STYLE_CLASS_BOTTOMA CSS class to indicate an area at the bottom of a widget.
STYLE_CLASS_BUTTONA CSS class to match buttons.
STYLE_CLASS_CALENDARA CSS class to match calendars.
STYLE_CLASS_CELLA CSS class to match content rendered in cell views.
STYLE_CLASS_CHECKA CSS class to match check boxes.
STYLE_CLASS_COMBOBOX_ENTRYA CSS class to match combobox entries.
STYLE_CLASS_CONTEXT_MENUA CSS class to match context menus.
STYLE_CLASS_CSDA CSS class that gets added to windows which have client-side decorations.
STYLE_CLASS_CURSOR_HANDLEA CSS class used when rendering a drag handle for text selection.
STYLE_CLASS_DEFAULTA CSS class to match the default widget.
STYLE_CLASS_DESTRUCTIVE_ACTIONA 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_LABELA CSS class to match dimmed labels.
STYLE_CLASS_DNDA CSS class for a drag-and-drop indicator.
STYLE_CLASS_DOCKA CSS class defining a dock area.
STYLE_CLASS_ENTRYA CSS class to match text entries.
STYLE_CLASS_ERRORA CSS class for an area displaying an error message, such as those in infobars.
STYLE_CLASS_EXPANDERA CSS class defining an expander, such as those in treeviews.
STYLE_CLASS_FLATA CSS class that is added when widgets that usually have a frame or border (like buttons or entries) should appear without it.
STYLE_CLASS_FRAMEA CSS class defining a frame delimiting content, such as GtkFrame
or the scrolled window frame around the scrollable area.
A CSS class defining a resize grip.
STYLE_CLASS_HEADERA CSS class to match a header element.
STYLE_CLASS_HIGHLIGHTA CSS class defining a highlighted area, such as headings in assistants and calendars.
STYLE_CLASS_HORIZONTALA CSS class for horizontally layered widgets.
STYLE_CLASS_IMAGEA CSS class defining an image, such as the icon in an entry.
STYLE_CLASS_INFOA CSS class for an area displaying an informational message, such as those in infobars.
STYLE_CLASS_INLINE_TOOLBARA CSS class to match inline toolbars.
STYLE_CLASS_INSERTION_CURSORA CSS class used when rendering a drag handle for the insertion cursor position.
STYLE_CLASS_LABELA CSS class to match labels.
STYLE_CLASS_LEFTA CSS class to indicate an area at the left of a widget.
STYLE_CLASS_LEVEL_BARA CSS class used when rendering a level indicator, such as a battery charge level, or a password strength.
STYLE_CLASS_LINKEDA CSS class to match a linked area, such as a box containing buttons belonging to the same control.
STYLE_CLASS_LISTA CSS class to match lists.
STYLE_CLASS_LIST_ROWA CSS class to match list rows.
STYLE_CLASS_MARKA CSS class defining marks in a widget, such as in scales.
STYLE_CLASS_MENUA CSS class to match menus.
STYLE_CLASS_MENUBARA CSS class to menubars.
STYLE_CLASS_MENUITEMA CSS class to match menu items.
STYLE_CLASS_MESSAGE_DIALOGA CSS class that is added to message dialogs.
STYLE_CLASS_MONOSPACEA CSS class that is added to text view that should use a monospace font.
STYLE_CLASS_NEEDS_ATTENTIONA 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_NOTEBOOKA CSS class defining a notebook.
STYLE_CLASS_OSDA CSS class used when rendering an OSD (On Screen Display) element, on top of another container.
STYLE_CLASS_OVERSHOOTA 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_SEPARATORA CSS class for a pane separator, such as those in GtkPaned
.
A CSS class that is added to areas that should look like paper.
STYLE_CLASS_POPOVERA CSS class that matches popovers.
STYLE_CLASS_POPUPA CSS class that is added to the toplevel windows used for menus.
STYLE_CLASS_PRIMARY_TOOLBARA CSS class to match primary toolbars.
STYLE_CLASS_PROGRESSBARA CSS class to use when rendering activity as a progressbar.
STYLE_CLASS_PULSEA CSS class to use when rendering a pulse in an indeterminate progress bar.
STYLE_CLASS_QUESTIONA CSS class for an area displaying a question to the user, such as those in infobars.
STYLE_CLASS_RADIOA CSS class to match radio buttons.
STYLE_CLASS_RAISEDA CSS class to match a raised control, such as a raised button on a toolbar.
STYLE_CLASS_READ_ONLYA CSS class used to indicate a read-only state.
STYLE_CLASS_RIGHTA CSS class to indicate an area at the right of a widget.
STYLE_CLASS_RUBBERBANDA CSS class to match the rubberband selection rectangle.
STYLE_CLASS_SCALEA CSS class to match scale widgets.
STYLE_CLASS_SCALE_HAS_MARKS_ABOVEA CSS class to match scale widgets with marks attached, all the marks are above for horizontal GtkScale
. left for vertical GtkScale
.
A CSS class to match scale widgets with marks attached, all the marks are below for horizontal GtkScale
, right for vertical GtkScale
.
A CSS class to match scrollbars.
STYLE_CLASS_SCROLLBARS_JUNCTIONA CSS class to match the junction area between an horizontal and vertical scrollbar, when they’re both shown.
STYLE_CLASS_SEPARATORA CSS class for a separator.
STYLE_CLASS_SIDEBARA CSS class defining a sidebar, such as the left side in a file chooser.
STYLE_CLASS_SLIDERA CSS class to match sliders.
STYLE_CLASS_SPINBUTTONA CSS class defining an spinbutton.
STYLE_CLASS_SPINNERA CSS class to use when rendering activity as a “spinner”.
STYLE_CLASS_STATUSBARA CSS class to match statusbars.
STYLE_CLASS_SUBTITLEA CSS class used for the subtitle label in a titlebar in a toplevel window.
STYLE_CLASS_SUGGESTED_ACTIONA CSS class used when an action (usually a button) is the primary suggested action in a specific context.
STYLE_CLASS_TITLEA CSS class used for the title label in a titlebar in a toplevel window.
STYLE_CLASS_TITLEBARA CSS class used when rendering a titlebar in a toplevel window.
STYLE_CLASS_TOOLBARA CSS class to match toolbars.
STYLE_CLASS_TOOLTIPA CSS class to match tooltip windows.
STYLE_CLASS_TOPA CSS class to indicate an area at the top of a widget.
STYLE_CLASS_TOUCH_SELECTIONA CSS class for touch selection popups on entries and text views.
STYLE_CLASS_TROUGHA CSS class to match troughs, as in scrollbars and progressbars.
STYLE_CLASS_UNDERSHOOTA 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_VERTICALA CSS class for vertically layered widgets.
STYLE_CLASS_VIEWA CSS class defining a view, such as iconviews or treeviews.
STYLE_CLASS_WARNINGA CSS class for an area displaying a warning message, such as those in infobars.
STYLE_CLASS_WIDEA CSS class to indicate that a UI element should be ‘wide’. Used by GtkPaned
.
A property holding the background color of rendered elements as a GdkRGBA
.
A property holding the element’s background as a #cairo_pattern_t.
STYLE_PROPERTY_BORDER_COLORA property holding the element’s border color as a GdkRGBA
.
A property holding the rendered element’s border radius in pixels as a #gint.
STYLE_PROPERTY_BORDER_STYLEA property holding the element’s border style as a GtkBorderStyle
.
A property holding the rendered element’s border width in pixels as a GtkBorder
. The border is the intermediary spacing property of the padding/border/margin series.
A property holding the foreground color of rendered elements as a GdkRGBA
.
A property holding the font properties used when rendering text as a PangoFontDescription
.
A property holding the rendered element’s margin as a GtkBorder
. The margin is defined as the spacing between the border of the element and its surrounding elements. It is external to GtkWidget
‘s size allocations, and the most external spacing property of the padding/border/margin series.
A property holding the rendered element’s padding as a GtkBorder
. The padding is defined as the spacing between the inner part of the element border and its child. It’s the innermost spacing property of the padding/border/margin series.
A priority that can be used when adding a GtkStyleProvider
for application-specific style information.
The priority used for default style information that is used in the absence of themes.
STYLE_PROVIDER_PRIORITY_SETTINGSThe priority used for style information provided via GtkSettings
.
The priority used for style information provided by themes.
STYLE_PROVIDER_PRIORITY_USERThe priority used for the style information from XDG_CONFIG_HOME/gtk-3.0/gtk.css
.
A widget region name to define a treeview column.
deprecated: 3.20
STYLE_REGION_COLUMN_HEADERA widget region name to define a treeview column header.
deprecated: 3.20
STYLE_REGION_ROWA widget region name to define a treeview row.
deprecated: 3.20
STYLE_REGION_TABA widget region name to define a notebook tab.
deprecated: 3.20
TEXT_VIEW_PRIORITY_VALIDATEThe priority at which the text view validates onscreen lines in an idle job in the background.
TREE_SORTABLE_DEFAULT_SORT_COLUMN_IDThe GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID can be used to make a GtkTreeSortable
use the default sort function.
The GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID can be used to make a GtkTreeSortable
use no sorting.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.3