Gjsify LogoGjsify Logo

Namespace Gtk

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

Allocation

Allocation: Gdk.Rectangle

Stock

Stock: string

Variables

Const BINARY_AGE

BINARY_AGE: number

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.

Const INPUT_ERROR

INPUT_ERROR: number

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

Const INTERFACE_AGE

INTERFACE_AGE: number

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.

Const LEVEL_BAR_OFFSET_FULL

LEVEL_BAR_OFFSET_FULL: string

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

Const LEVEL_BAR_OFFSET_HIGH

LEVEL_BAR_OFFSET_HIGH: string

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

Const LEVEL_BAR_OFFSET_LOW

LEVEL_BAR_OFFSET_LOW: string

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

Const MAJOR_VERSION

MAJOR_VERSION: number

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.

Const MAX_COMPOSE_LEN

MAX_COMPOSE_LEN: number

The maximum length of sequences in compose tables.

Const MICRO_VERSION

MICRO_VERSION: number

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

Const MINOR_VERSION

MINOR_VERSION: number

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

Const PAPER_NAME_A3

PAPER_NAME_A3: string

Name for the A3 paper size.

Const PAPER_NAME_A4

PAPER_NAME_A4: string

Name for the A4 paper size.

Const PAPER_NAME_A5

PAPER_NAME_A5: string

Name for the A5 paper size.

Const PAPER_NAME_B5

PAPER_NAME_B5: string

Name for the B5 paper size.

Const PAPER_NAME_EXECUTIVE

PAPER_NAME_EXECUTIVE: string

Name for the Executive paper size.

Const PAPER_NAME_LEGAL

PAPER_NAME_LEGAL: string

Name for the Legal paper size.

Const PAPER_NAME_LETTER

PAPER_NAME_LETTER: string

Name for the Letter paper size.

Const PATH_PRIO_MASK

PATH_PRIO_MASK: number

Const PRINT_SETTINGS_COLLATE

PRINT_SETTINGS_COLLATE: string

Const PRINT_SETTINGS_DEFAULT_SOURCE

PRINT_SETTINGS_DEFAULT_SOURCE: string

Const PRINT_SETTINGS_DITHER

PRINT_SETTINGS_DITHER: string

Const PRINT_SETTINGS_DUPLEX

PRINT_SETTINGS_DUPLEX: string

Const PRINT_SETTINGS_FINISHINGS

PRINT_SETTINGS_FINISHINGS: string

Const PRINT_SETTINGS_MEDIA_TYPE

PRINT_SETTINGS_MEDIA_TYPE: string

Const PRINT_SETTINGS_NUMBER_UP

PRINT_SETTINGS_NUMBER_UP: string

Const PRINT_SETTINGS_NUMBER_UP_LAYOUT

PRINT_SETTINGS_NUMBER_UP_LAYOUT: string

Const PRINT_SETTINGS_N_COPIES

PRINT_SETTINGS_N_COPIES: string

Const PRINT_SETTINGS_ORIENTATION

PRINT_SETTINGS_ORIENTATION: string

Const PRINT_SETTINGS_OUTPUT_BASENAME

PRINT_SETTINGS_OUTPUT_BASENAME: string

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

Const PRINT_SETTINGS_OUTPUT_BIN

PRINT_SETTINGS_OUTPUT_BIN: string

Const PRINT_SETTINGS_OUTPUT_DIR

PRINT_SETTINGS_OUTPUT_DIR: string

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

Const PRINT_SETTINGS_OUTPUT_FILE_FORMAT

PRINT_SETTINGS_OUTPUT_FILE_FORMAT: string

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

Const PRINT_SETTINGS_OUTPUT_URI

PRINT_SETTINGS_OUTPUT_URI: string

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

Const PRINT_SETTINGS_PAGE_RANGES

PRINT_SETTINGS_PAGE_RANGES: string

Const PRINT_SETTINGS_PAGE_SET

PRINT_SETTINGS_PAGE_SET: string

Const PRINT_SETTINGS_PAPER_FORMAT

PRINT_SETTINGS_PAPER_FORMAT: string

Const PRINT_SETTINGS_PAPER_HEIGHT

PRINT_SETTINGS_PAPER_HEIGHT: string

Const PRINT_SETTINGS_PAPER_WIDTH

PRINT_SETTINGS_PAPER_WIDTH: string

Const PRINT_SETTINGS_PRINTER

PRINT_SETTINGS_PRINTER: string

Const PRINT_SETTINGS_PRINTER_LPI

PRINT_SETTINGS_PRINTER_LPI: string

Const PRINT_SETTINGS_PRINT_PAGES

PRINT_SETTINGS_PRINT_PAGES: string

Const PRINT_SETTINGS_QUALITY

PRINT_SETTINGS_QUALITY: string

Const PRINT_SETTINGS_RESOLUTION

PRINT_SETTINGS_RESOLUTION: string

Const PRINT_SETTINGS_RESOLUTION_X

PRINT_SETTINGS_RESOLUTION_X: string

Const PRINT_SETTINGS_RESOLUTION_Y

PRINT_SETTINGS_RESOLUTION_Y: string

Const PRINT_SETTINGS_REVERSE

PRINT_SETTINGS_REVERSE: string

Const PRINT_SETTINGS_SCALE

PRINT_SETTINGS_SCALE: string

Const PRINT_SETTINGS_USE_COLOR

PRINT_SETTINGS_USE_COLOR: string

Const PRINT_SETTINGS_WIN32_DRIVER_EXTRA

PRINT_SETTINGS_WIN32_DRIVER_EXTRA: string

Const PRINT_SETTINGS_WIN32_DRIVER_VERSION

PRINT_SETTINGS_WIN32_DRIVER_VERSION: string

Const PRIORITY_RESIZE

PRIORITY_RESIZE: number

Use this priority for functionality related to size allocation.

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

Const STOCK_ABOUT

STOCK_ABOUT: string

The “About” item.

Const STOCK_ADD

STOCK_ADD: string

The “Add” item and icon.

Const STOCK_APPLY

STOCK_APPLY: string

The “Apply” item and icon.

Const STOCK_BOLD

STOCK_BOLD: string

The “Bold” item and icon.

Const STOCK_CANCEL

STOCK_CANCEL: string

The “Cancel” item and icon.

Const STOCK_CAPS_LOCK_WARNING

STOCK_CAPS_LOCK_WARNING: string

The “Caps Lock Warning” icon.

Const STOCK_CDROM

STOCK_CDROM: string

The “CD-Rom” item and icon.

Const STOCK_CLEAR

STOCK_CLEAR: string

The “Clear” item and icon.

Const STOCK_CLOSE

STOCK_CLOSE: string

The “Close” item and icon.

Const STOCK_COLOR_PICKER

STOCK_COLOR_PICKER: string

The “Color Picker” item and icon.

Const STOCK_CONNECT

STOCK_CONNECT: string

The “Connect” icon.

Const STOCK_CONVERT

STOCK_CONVERT: string

The “Convert” item and icon.

Const STOCK_COPY

STOCK_COPY: string

The “Copy” item and icon.

Const STOCK_CUT

STOCK_CUT: string

The “Cut” item and icon.

Const STOCK_DELETE

STOCK_DELETE: string

The “Delete” item and icon.

Const STOCK_DIALOG_AUTHENTICATION

STOCK_DIALOG_AUTHENTICATION: string

The “Authentication” item and icon.

Const STOCK_DIALOG_ERROR

STOCK_DIALOG_ERROR: string

The “Error” item and icon.

Const STOCK_DIALOG_INFO

STOCK_DIALOG_INFO: string

The “Information” item and icon.

Const STOCK_DIALOG_QUESTION

STOCK_DIALOG_QUESTION: string

The “Question” item and icon.

Const STOCK_DIALOG_WARNING

STOCK_DIALOG_WARNING: string

The “Warning” item and icon.

Const STOCK_DIRECTORY

STOCK_DIRECTORY: string

The “Directory” icon.

Const STOCK_DISCARD

STOCK_DISCARD: string

The “Discard” item.

Const STOCK_DISCONNECT

STOCK_DISCONNECT: string

The “Disconnect” icon.

Const STOCK_DND

STOCK_DND: string

The “Drag-And-Drop” icon.

Const STOCK_DND_MULTIPLE

STOCK_DND_MULTIPLE: string

The “Drag-And-Drop multiple” icon.

Const STOCK_EDIT

STOCK_EDIT: string

The “Edit” item and icon.

Const STOCK_EXECUTE

STOCK_EXECUTE: string

The “Execute” item and icon.

Const STOCK_FILE

STOCK_FILE: string

The “File” item and icon.

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

Const STOCK_FIND

STOCK_FIND: string

The “Find” item and icon.

Const STOCK_FIND_AND_REPLACE

STOCK_FIND_AND_REPLACE: string

The “Find and Replace” item and icon.

Const STOCK_FLOPPY

STOCK_FLOPPY: string

The “Floppy” item and icon.

Const STOCK_FULLSCREEN

STOCK_FULLSCREEN: string

The “Fullscreen” item and icon.

Const STOCK_GOTO_BOTTOM

STOCK_GOTO_BOTTOM: string

The “Bottom” item and icon.

Const STOCK_GOTO_FIRST

STOCK_GOTO_FIRST: string

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

Const STOCK_GOTO_LAST

STOCK_GOTO_LAST: string

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

Const STOCK_GOTO_TOP

STOCK_GOTO_TOP: string

The “Top” item and icon.

Const STOCK_GO_BACK

STOCK_GO_BACK: string

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

Const STOCK_GO_DOWN

STOCK_GO_DOWN: string

The “Down” item and icon.

Const STOCK_GO_FORWARD

STOCK_GO_FORWARD: string

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

Const STOCK_GO_UP

STOCK_GO_UP: string

The “Up” item and icon.

Const STOCK_HARDDISK

STOCK_HARDDISK: string

The “Harddisk” item and icon.

Const STOCK_HELP

STOCK_HELP: string

The “Help” item and icon.

Const STOCK_HOME

STOCK_HOME: string

The “Home” item and icon.

Const STOCK_INDENT

STOCK_INDENT: string

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

Const STOCK_INDEX

STOCK_INDEX: string

The “Index” item and icon.

Const STOCK_INFO

STOCK_INFO: string

The “Info” item and icon.

Const STOCK_ITALIC

STOCK_ITALIC: string

The “Italic” item and icon.

Const STOCK_JUMP_TO

STOCK_JUMP_TO: string

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

Const STOCK_JUSTIFY_CENTER

STOCK_JUSTIFY_CENTER: string

The “Center” item and icon.

Const STOCK_JUSTIFY_FILL

STOCK_JUSTIFY_FILL: string

The “Fill” item and icon.

Const STOCK_JUSTIFY_LEFT

STOCK_JUSTIFY_LEFT: string

The “Left” item and icon.

Const STOCK_JUSTIFY_RIGHT

STOCK_JUSTIFY_RIGHT: string

The “Right” item and icon.

Const STOCK_LEAVE_FULLSCREEN

STOCK_LEAVE_FULLSCREEN: string

The “Leave Fullscreen” item and icon.

Const STOCK_MEDIA_FORWARD

STOCK_MEDIA_FORWARD: string

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

Const STOCK_MEDIA_NEXT

STOCK_MEDIA_NEXT: string

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

Const STOCK_MEDIA_PAUSE

STOCK_MEDIA_PAUSE: string

The “Media Pause” item and icon.

Const STOCK_MEDIA_PLAY

STOCK_MEDIA_PLAY: string

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

Const STOCK_MEDIA_PREVIOUS

STOCK_MEDIA_PREVIOUS: string

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

Const STOCK_MEDIA_RECORD

STOCK_MEDIA_RECORD: string

The “Media Record” item and icon.

Const STOCK_MEDIA_REWIND

STOCK_MEDIA_REWIND: string

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

Const STOCK_MEDIA_STOP

STOCK_MEDIA_STOP: string

The “Media Stop” item and icon.

Const STOCK_MISSING_IMAGE

STOCK_MISSING_IMAGE: string

The “Missing image” icon.

Const STOCK_NETWORK

STOCK_NETWORK: string

The “Network” item and icon.

Const STOCK_NEW

STOCK_NEW: string

The “New” item and icon.

Const STOCK_NO

STOCK_NO: string

The “No” item and icon.

Const STOCK_OK

STOCK_OK: string

The “OK” item and icon.

Const STOCK_OPEN

STOCK_OPEN: string

The “Open” item and icon.

Const STOCK_ORIENTATION_LANDSCAPE

STOCK_ORIENTATION_LANDSCAPE: string

The “Landscape Orientation” item and icon.

Const STOCK_ORIENTATION_PORTRAIT

STOCK_ORIENTATION_PORTRAIT: string

The “Portrait Orientation” item and icon.

Const STOCK_ORIENTATION_REVERSE_LANDSCAPE

STOCK_ORIENTATION_REVERSE_LANDSCAPE: string

The “Reverse Landscape Orientation” item and icon.

Const STOCK_ORIENTATION_REVERSE_PORTRAIT

STOCK_ORIENTATION_REVERSE_PORTRAIT: string

The “Reverse Portrait Orientation” item and icon.

Const STOCK_PAGE_SETUP

STOCK_PAGE_SETUP: string

The “Page Setup” item and icon.

Const STOCK_PASTE

STOCK_PASTE: string

The “Paste” item and icon.

Const STOCK_PREFERENCES

STOCK_PREFERENCES: string

The “Preferences” item and icon.

Const STOCK_PRINT

STOCK_PRINT: string

The “Print” item and icon.

Const STOCK_PRINT_ERROR

STOCK_PRINT_ERROR: string

The “Print Error” icon.

Const STOCK_PRINT_PAUSED

STOCK_PRINT_PAUSED: string

The “Print Paused” icon.

Const STOCK_PRINT_PREVIEW

STOCK_PRINT_PREVIEW: string

The “Print Preview” item and icon.

Const STOCK_PRINT_REPORT

STOCK_PRINT_REPORT: string

The “Print Report” icon.

Const STOCK_PRINT_WARNING

STOCK_PRINT_WARNING: string

The “Print Warning” icon.

Const STOCK_PROPERTIES

STOCK_PROPERTIES: string

The “Properties” item and icon.

Const STOCK_QUIT

STOCK_QUIT: string

The “Quit” item and icon.

Const STOCK_REDO

STOCK_REDO: string

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

Const STOCK_REFRESH

STOCK_REFRESH: string

The “Refresh” item and icon.

Const STOCK_REMOVE

STOCK_REMOVE: string

The “Remove” item and icon.

Const STOCK_REVERT_TO_SAVED

STOCK_REVERT_TO_SAVED: string

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

Const STOCK_SAVE

STOCK_SAVE: string

The “Save” item and icon.

Const STOCK_SAVE_AS

STOCK_SAVE_AS: string

The “Save As” item and icon.

Const STOCK_SELECT_ALL

STOCK_SELECT_ALL: string

The “Select All” item and icon.

Const STOCK_SELECT_COLOR

STOCK_SELECT_COLOR: string

The “Color” item and icon.

Const STOCK_SELECT_FONT

STOCK_SELECT_FONT: string

The “Font” item and icon.

Const STOCK_SORT_ASCENDING

STOCK_SORT_ASCENDING: string

The “Ascending” item and icon.

Const STOCK_SORT_DESCENDING

STOCK_SORT_DESCENDING: string

The “Descending” item and icon.

Const STOCK_SPELL_CHECK

STOCK_SPELL_CHECK: string

The “Spell Check” item and icon.

Const STOCK_STOP

STOCK_STOP: string

The “Stop” item and icon.

Const STOCK_STRIKETHROUGH

STOCK_STRIKETHROUGH: string

The “Strikethrough” item and icon.

Const STOCK_UNDELETE

STOCK_UNDELETE: string

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

Const STOCK_UNDERLINE

STOCK_UNDERLINE: string

The “Underline” item and icon.

Const STOCK_UNDO

STOCK_UNDO: string

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

Const STOCK_UNINDENT

STOCK_UNINDENT: string

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

Const STOCK_YES

STOCK_YES: string

The “Yes” item and icon.

Const STOCK_ZOOM_100

STOCK_ZOOM_100: string

The “Zoom 100%” item and icon.

Const STOCK_ZOOM_FIT

STOCK_ZOOM_FIT: string

The “Zoom to Fit” item and icon.

Const STOCK_ZOOM_IN

STOCK_ZOOM_IN: string

The “Zoom In” item and icon.

Const STOCK_ZOOM_OUT

STOCK_ZOOM_OUT: string

The “Zoom Out” item and icon.

Const STYLE_CLASS_ACCELERATOR

STYLE_CLASS_ACCELERATOR: string

A CSS class to match an accelerator.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_ARROW

STYLE_CLASS_ARROW: string

A CSS class used when rendering an arrow element.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_BACKGROUND

STYLE_CLASS_BACKGROUND: string

A CSS class to match the window background.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_BOTTOM

STYLE_CLASS_BOTTOM: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_BUTTON

STYLE_CLASS_BUTTON: string

A CSS class to match buttons.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_CALENDAR

STYLE_CLASS_CALENDAR: string

A CSS class to match calendars.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_CELL

STYLE_CLASS_CELL: string

A CSS class to match content rendered in cell views.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_CHECK

STYLE_CLASS_CHECK: string

A CSS class to match check boxes.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_COMBOBOX_ENTRY

STYLE_CLASS_COMBOBOX_ENTRY: string

A CSS class to match combobox entries.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_CONTEXT_MENU

STYLE_CLASS_CONTEXT_MENU: string

A CSS class to match context menus.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_CSD

STYLE_CLASS_CSD: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_CURSOR_HANDLE

STYLE_CLASS_CURSOR_HANDLE: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_DEFAULT

STYLE_CLASS_DEFAULT: string

A CSS class to match the default widget.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_DESTRUCTIVE_ACTION

STYLE_CLASS_DESTRUCTIVE_ACTION: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_DIM_LABEL

STYLE_CLASS_DIM_LABEL: string

A CSS class to match dimmed labels.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_DND

STYLE_CLASS_DND: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_DOCK

STYLE_CLASS_DOCK: string

A CSS class defining a dock area.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_ENTRY

STYLE_CLASS_ENTRY: string

A CSS class to match text entries.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_ERROR

STYLE_CLASS_ERROR: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_EXPANDER

STYLE_CLASS_EXPANDER: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_FLAT

STYLE_CLASS_FLAT: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_FRAME

STYLE_CLASS_FRAME: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_GRIP

STYLE_CLASS_GRIP: string

A CSS class defining a resize grip.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_HEADER

STYLE_CLASS_HEADER: string

A CSS class to match a header element.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_HIGHLIGHT

STYLE_CLASS_HIGHLIGHT: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_HORIZONTAL

STYLE_CLASS_HORIZONTAL: string

A CSS class for horizontally layered widgets.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_IMAGE

STYLE_CLASS_IMAGE: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_INFO

STYLE_CLASS_INFO: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_INLINE_TOOLBAR

STYLE_CLASS_INLINE_TOOLBAR: string

A CSS class to match inline toolbars.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_INSERTION_CURSOR

STYLE_CLASS_INSERTION_CURSOR: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_LABEL

STYLE_CLASS_LABEL: string

A CSS class to match labels.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_LEFT

STYLE_CLASS_LEFT: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_LEVEL_BAR

STYLE_CLASS_LEVEL_BAR: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_LINKED

STYLE_CLASS_LINKED: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_LIST

STYLE_CLASS_LIST: string

A CSS class to match lists.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_LIST_ROW

STYLE_CLASS_LIST_ROW: string

A CSS class to match list rows.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_MARK

STYLE_CLASS_MARK: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_MENU

STYLE_CLASS_MENU: string

A CSS class to match menus.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_MENUBAR

STYLE_CLASS_MENUBAR: string

A CSS class to menubars.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_MENUITEM

STYLE_CLASS_MENUITEM: string

A CSS class to match menu items.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_MESSAGE_DIALOG

STYLE_CLASS_MESSAGE_DIALOG: string

A CSS class that is added to message dialogs.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_MONOSPACE

STYLE_CLASS_MONOSPACE: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_NEEDS_ATTENTION

STYLE_CLASS_NEEDS_ATTENTION: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_NOTEBOOK

STYLE_CLASS_NOTEBOOK: string

A CSS class defining a notebook.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_OSD

STYLE_CLASS_OSD: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_OVERSHOOT

STYLE_CLASS_OVERSHOOT: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_PANE_SEPARATOR

STYLE_CLASS_PANE_SEPARATOR: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_PAPER

STYLE_CLASS_PAPER: string

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

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_POPOVER

STYLE_CLASS_POPOVER: string

A CSS class that matches popovers.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_POPUP

STYLE_CLASS_POPUP: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_PRIMARY_TOOLBAR

STYLE_CLASS_PRIMARY_TOOLBAR: string

A CSS class to match primary toolbars.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_PROGRESSBAR

STYLE_CLASS_PROGRESSBAR: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_PULSE

STYLE_CLASS_PULSE: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_QUESTION

STYLE_CLASS_QUESTION: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_RADIO

STYLE_CLASS_RADIO: string

A CSS class to match radio buttons.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_RAISED

STYLE_CLASS_RAISED: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_READ_ONLY

STYLE_CLASS_READ_ONLY: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_RIGHT

STYLE_CLASS_RIGHT: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_RUBBERBAND

STYLE_CLASS_RUBBERBAND: string

A CSS class to match the rubberband selection rectangle.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_SCALE

STYLE_CLASS_SCALE: string

A CSS class to match scale widgets.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_SCALE_HAS_MARKS_ABOVE

STYLE_CLASS_SCALE_HAS_MARKS_ABOVE: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_SCALE_HAS_MARKS_BELOW

STYLE_CLASS_SCALE_HAS_MARKS_BELOW: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_SCROLLBAR

STYLE_CLASS_SCROLLBAR: string

A CSS class to match scrollbars.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_SCROLLBARS_JUNCTION

STYLE_CLASS_SCROLLBARS_JUNCTION: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_SEPARATOR

STYLE_CLASS_SEPARATOR: string

A CSS class for a separator.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_SIDEBAR

STYLE_CLASS_SIDEBAR: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_SLIDER

STYLE_CLASS_SLIDER: string

A CSS class to match sliders.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_SPINBUTTON

STYLE_CLASS_SPINBUTTON: string

A CSS class defining an spinbutton.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_SPINNER

STYLE_CLASS_SPINNER: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_STATUSBAR

STYLE_CLASS_STATUSBAR: string

A CSS class to match statusbars.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_SUBTITLE

STYLE_CLASS_SUBTITLE: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_SUGGESTED_ACTION

STYLE_CLASS_SUGGESTED_ACTION: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_TITLE

STYLE_CLASS_TITLE: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_TITLEBAR

STYLE_CLASS_TITLEBAR: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_TOOLBAR

STYLE_CLASS_TOOLBAR: string

A CSS class to match toolbars.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_TOOLTIP

STYLE_CLASS_TOOLTIP: string

A CSS class to match tooltip windows.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_TOP

STYLE_CLASS_TOP: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_TOUCH_SELECTION

STYLE_CLASS_TOUCH_SELECTION: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_TROUGH

STYLE_CLASS_TROUGH: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_UNDERSHOOT

STYLE_CLASS_UNDERSHOOT: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_VERTICAL

STYLE_CLASS_VERTICAL: string

A CSS class for vertically layered widgets.

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_VIEW

STYLE_CLASS_VIEW: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_WARNING

STYLE_CLASS_WARNING: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_CLASS_WIDE

STYLE_CLASS_WIDE: string

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

Refer to individual widget documentation for used style classes.

Const STYLE_PROPERTY_BACKGROUND_COLOR

STYLE_PROPERTY_BACKGROUND_COLOR: string

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

Const STYLE_PROPERTY_BACKGROUND_IMAGE

STYLE_PROPERTY_BACKGROUND_IMAGE: string

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

Const STYLE_PROPERTY_BORDER_COLOR

STYLE_PROPERTY_BORDER_COLOR: string

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

Const STYLE_PROPERTY_BORDER_RADIUS

STYLE_PROPERTY_BORDER_RADIUS: string

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

Const STYLE_PROPERTY_BORDER_STYLE

STYLE_PROPERTY_BORDER_STYLE: string

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

Const STYLE_PROPERTY_BORDER_WIDTH

STYLE_PROPERTY_BORDER_WIDTH: string

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

gtk_render_frame() uses this property to find out the frame line width, so #GtkWidgets rendering frames may need to add up this padding when requesting size

Const STYLE_PROPERTY_COLOR

STYLE_PROPERTY_COLOR: string

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

Const STYLE_PROPERTY_FONT

STYLE_PROPERTY_FONT: string

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

Const STYLE_PROPERTY_MARGIN

STYLE_PROPERTY_MARGIN: string

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.

Const STYLE_PROPERTY_PADDING

STYLE_PROPERTY_PADDING: string

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.

Const STYLE_PROVIDER_PRIORITY_APPLICATION

STYLE_PROVIDER_PRIORITY_APPLICATION: number

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

Const STYLE_PROVIDER_PRIORITY_FALLBACK

STYLE_PROVIDER_PRIORITY_FALLBACK: number

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

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

Const STYLE_PROVIDER_PRIORITY_SETTINGS

STYLE_PROVIDER_PRIORITY_SETTINGS: number

The priority used for style information provided via #GtkSettings.

This priority is higher than #GTK_STYLE_PROVIDER_PRIORITY_THEME to let settings override themes.

Const STYLE_PROVIDER_PRIORITY_THEME

STYLE_PROVIDER_PRIORITY_THEME: number

The priority used for style information provided by themes.

Const STYLE_PROVIDER_PRIORITY_USER

STYLE_PROVIDER_PRIORITY_USER: number

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

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

Const STYLE_REGION_COLUMN

STYLE_REGION_COLUMN: string

A widget region name to define a treeview column.

Const STYLE_REGION_COLUMN_HEADER

STYLE_REGION_COLUMN_HEADER: string

A widget region name to define a treeview column header.

Const STYLE_REGION_ROW

STYLE_REGION_ROW: string

A widget region name to define a treeview row.

Const STYLE_REGION_TAB

STYLE_REGION_TAB: string

A widget region name to define a notebook tab.

Const TEXT_VIEW_PRIORITY_VALIDATE

TEXT_VIEW_PRIORITY_VALIDATE: number

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

Const TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID

TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID: number

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

See also gtk_tree_sortable_set_sort_column_id()

Const TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID

TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID: number

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

See also gtk_tree_sortable_set_sort_column_id()

Functions

accel_groups_activate

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

    Parameters

    • object: GObject.Object

      the #GObject, usually a #GtkWindow, on which to activate the accelerator

    • accel_key: number

      accelerator keyval from a key event

    • accel_mods: Gdk.ModifierType

      keyboard state mask from a key event

    Returns boolean

accel_groups_from_object

accelerator_get_default_mod_mask

  • Gets the modifier mask.

    The modifier mask determines which modifiers are considered significant for keyboard accelerators. See gtk_accelerator_set_default_mod_mask().

    Returns Gdk.ModifierType

accelerator_get_label

  • accelerator_get_label(accelerator_key: number, accelerator_mods: Gdk.ModifierType): string

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

    Parameters

    • accelerator_key: number

      accelerator keyval

    • accelerator_mods: Gdk.ModifierType

      accelerator modifier mask

    Returns string

accelerator_get_label_with_keycode

  • accelerator_get_label_with_keycode(display: Gdk.Display, accelerator_key: number, keycode: number, accelerator_mods: Gdk.ModifierType): string

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

    This is only useful for system-level components, applications should use gtk_accelerator_parse() instead.

    Parameters

    • display: Gdk.Display

      a #GdkDisplay or %NULL to use the default display

    • accelerator_key: number

      accelerator keyval

    • keycode: number

      accelerator keycode

    • accelerator_mods: Gdk.ModifierType

      accelerator modifier mask

    Returns string

accelerator_name

  • accelerator_name(accelerator_key: number, accelerator_mods: Gdk.ModifierType): string

  • Converts an accelerator keyval and modifier mask into a string parseable by gtk_accelerator_parse(). For example, if you pass in #GDK_KEY_q and #GDK_CONTROL_MASK, this function returns “q”.

    If you need to display accelerators in the user interface, see gtk_accelerator_get_label().

    Parameters

    • accelerator_key: number

      accelerator keyval

    • accelerator_mods: Gdk.ModifierType

      accelerator modifier mask

    Returns string

accelerator_name_with_keycode

  • accelerator_name_with_keycode(display: Gdk.Display, accelerator_key: number, keycode: number, accelerator_mods: Gdk.ModifierType): string

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

    Parameters

    • display: Gdk.Display

      a #GdkDisplay or %NULL to use the default display

    • accelerator_key: number

      accelerator keyval

    • keycode: number

      accelerator keycode

    • accelerator_mods: Gdk.ModifierType

      accelerator modifier mask

    Returns string

accelerator_parse

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

    The parser is fairly liberal and allows lower or upper case, and also abbreviations such as “” and “”. Key names are parsed using gdk_keyval_from_name(). For character keys the name is not the symbol, but the lowercase name, e.g. one would use “minus” instead of “-”.

    If the parse fails, accelerator_key and accelerator_mods will be set to 0 (zero).

    Parameters

    • accelerator: string

      string representing an accelerator

    Returns [number, Gdk.ModifierType]

accelerator_parse_with_keycode

  • accelerator_parse_with_keycode(accelerator: string): [number, number[], Gdk.ModifierType]

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

    If accelerator_codes is given and the result stored in it is non-%NULL, the result must be freed with g_free().

    If a keycode is present in the accelerator and no accelerator_codes is given, the parse will fail.

    If the parse fails, accelerator_key, accelerator_mods and accelerator_codes will be set to 0 (zero).

    Parameters

    • accelerator: string

      string representing an accelerator

    Returns [number, number[], Gdk.ModifierType]

accelerator_set_default_mod_mask

  • Sets the modifiers that will be considered significant for keyboard accelerators. The default mod mask depends on the GDK backend in use, but will typically include #GDK_CONTROL_MASK | #GDK_SHIFT_MASK | #GDK_MOD1_MASK | #GDK_SUPER_MASK | #GDK_HYPER_MASK | #GDK_META_MASK. In other words, Control, Shift, Alt, Super, Hyper and Meta. Other modifiers will by default be ignored by #GtkAccelGroup.

    You must include at least the three modifiers Control, Shift and Alt in any value you pass to this function.

    The default mod mask should be changed on application startup, before using any accelerator groups.

    Parameters

    Returns void

accelerator_valid

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

    Parameters

    Returns boolean

alternative_dialog_button_order

  • alternative_dialog_button_order(screen: Gdk.Screen): boolean

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

    If you need to use this function, you should probably connect to the ::notify:gtk-alternative-button-order signal on the #GtkSettings object associated to screen, in order to be notified if the button order setting changes.

    Parameters

    • screen: Gdk.Screen

      a #GdkScreen, or %NULL to use the default screen

    Returns boolean

binding_entry_add_signal_from_string

  • Parses a signal description from signal_desc and incorporates it into binding_set.

    Signal descriptions may either bind a key combination to one or more signals: |[ bind "key" { "signalname" (param, ...) ... }



    Or they may also unbind a key combination:
    |[
      unbind "key"

    Key combinations must be in a format that can be parsed by gtk_accelerator_parse().

    Parameters

    • binding_set: Gtk.BindingSet

      a #GtkBindingSet

    • signal_desc: string

      a signal description

    Returns GLib.TokenType

binding_entry_add_signall

  • Override or install a new key binding for keyval with modifiers on binding_set.

    Parameters

    • binding_set: Gtk.BindingSet

      a #GtkBindingSet to add a signal to

    • keyval: number

      key value

    • modifiers: Gdk.ModifierType

      key modifier

    • signal_name: string

      signal name to be bound

    • binding_args: Gtk.BindingArg[]

      list of #GtkBindingArg signal arguments

    Returns void

binding_entry_remove

  • Remove a binding previously installed via gtk_binding_entry_add_signal() on binding_set.

    Parameters

    • binding_set: Gtk.BindingSet

      a #GtkBindingSet to remove an entry of

    • keyval: number

      key value of binding to remove

    • modifiers: Gdk.ModifierType

      key modifier of binding to remove

    Returns void

binding_entry_skip

  • Install a binding on binding_set which causes key lookups to be aborted, to prevent bindings from lower priority sets to be activated.

    Parameters

    • binding_set: Gtk.BindingSet

      a #GtkBindingSet to skip an entry of

    • keyval: number

      key value of binding to skip

    • modifiers: Gdk.ModifierType

      key modifier of binding to skip

    Returns void

binding_set_find

  • Find a binding set by its globally unique name.

    The set_name can either be a name used for gtk_binding_set_new() or the type name of a class used in gtk_binding_set_by_class().

    Parameters

    • set_name: string

      unique binding set name

    Returns Gtk.BindingSet | null

bindings_activate

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

    Parameters

    • object: GObject.Object

      object to activate when binding found

    • keyval: number

      key value of the binding

    • modifiers: Gdk.ModifierType

      key modifier of the binding

    Returns boolean

bindings_activate_event

builder_error_quark

  • builder_error_quark(): Quark

cairo_should_draw_window

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

    Parameters

    • cr: cairo.Context

      a cairo context

    • window: Gdk.Window

      the window to check. window may not be an input-only window.

    Returns boolean

cairo_transform_to_window

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

    This is the inverse to the transformation GTK applies when preparing an expose event to be emitted with the #GtkWidget::draw signal. It is intended to help porting multiwindow widgets from GTK+ 2 to the rendering architecture of GTK+ 3.

    Parameters

    • cr: cairo.Context

      the cairo context to transform

    • widget: Gtk.Widget

      the widget the context is currently centered for

    • window: Gdk.Window

      the window to transform the context to

    Returns void

check_version

  • check_version(required_major: number, required_minor: number, required_micro: number): string | null

  • Checks that the GTK+ library in use is compatible with the given version. Generally you would pass in the constants #GTK_MAJOR_VERSION, #GTK_MINOR_VERSION, #GTK_MICRO_VERSION as the three arguments to this function; that produces a check that the library in use is compatible with the version of GTK+ the application or module was compiled against.

    Compatibility is defined by two things: first the version of the running library is newer than the version required_major.required_minor.required_micro. Second the running library must be binary compatible with the version required_major.required_minor.required_micro (same major version.)

    This function is primarily for GTK+ modules; the module can call this function to check that it wasn’t loaded into an incompatible version of GTK+. However, such a check isn’t completely reliable, since the module may be linked against an old version of GTK+ and calling the old version of gtk_check_version(), but still get loaded into an application using a newer version of GTK+.

    Parameters

    • required_major: number

      the required major version

    • required_minor: number

      the required minor version

    • required_micro: number

      the required micro version

    Returns string | null

css_provider_error_quark

  • css_provider_error_quark(): Quark

device_grab_add

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

    Parameters

    • widget: Gtk.Widget

      a #GtkWidget

    • device: Gdk.Device

      a #GdkDevice to grab on.

    • block_others: boolean

      %TRUE to prevent other devices to interact with widget.

    Returns void

device_grab_remove

  • Removes a device grab from the given widget.

    You have to pair calls to gtk_device_grab_add() and gtk_device_grab_remove().

    Parameters

    Returns void

disable_setlocale

  • disable_setlocale(): void

  • Prevents gtk_init(), gtk_init_check(), gtk_init_with_args() and gtk_parse_args() from automatically calling setlocale (LC_ALL, ""). You would want to use this function if you wanted to set the locale for your program to something other than the user’s locale, or if you wanted to set different values for different locale categories.

    Most programs should not need to call this function.

    Returns void

distribute_natural_allocation

  • distribute_natural_allocation(extra_space: number, n_requested_sizes: number, sizes: Gtk.RequestedSize): number

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

    The remaining space will be added to the minimum_size member of the GtkRequestedSize struct. If all sizes reach their natural size then the remaining space is returned.

    Parameters

    • extra_space: number

      Extra space to redistribute among children after subtracting minimum sizes and any child padding from the overall allocation

    • n_requested_sizes: number

      Number of requests to fit into the allocation

    • sizes: Gtk.RequestedSize

      An array of structs with a client pointer and a minimum/natural size in the orientation of the allocation.

    Returns number

drag_cancel

  • Cancels an ongoing drag operation on the source side.

    If you want to be able to cancel a drag operation in this way, you need to keep a pointer to the drag context, either from an explicit call to gtk_drag_begin_with_coordinates(), or by connecting to #GtkWidget::drag-begin.

    If context does not refer to an ongoing drag operation, this function does nothing.

    If a drag is cancelled in this way, the result argument of #GtkWidget::drag-failed is set to GTK_DRAG_RESULT_ERROR.

    Parameters

    • context: Gdk.DragContext

      a #GdkDragContext, as e.g. returned by gtk_drag_begin_with_coordinates()

    Returns void

drag_finish

  • drag_finish(context: Gdk.DragContext, success: boolean, del: boolean, time_: number): void

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

    Parameters

    • context: Gdk.DragContext

      the drag context

    • success: boolean

      a flag indicating whether the drop was successful

    • del: boolean

      a flag indicating whether the source should delete the original data. (This should be %TRUE for a move)

    • time_: number

      the timestamp from the #GtkWidget::drag-drop signal

    Returns void

drag_get_source_widget

drag_set_icon_default

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

    Parameters

    • context: Gdk.DragContext

      the context for a drag (This must be called with a context for the source side of a drag)

    Returns void

drag_set_icon_gicon

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

    Parameters

    • context: Gdk.DragContext

      the context for a drag (This must be called with a context for the source side of a drag)

    • icon: Gio.Icon

      a #GIcon

    • hot_x: number

      the X offset of the hotspot within the icon

    • hot_y: number

      the Y offset of the hotspot within the icon

    Returns void

drag_set_icon_name

  • drag_set_icon_name(context: Gdk.DragContext, icon_name: string, hot_x: number, hot_y: number): void

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

    Parameters

    • context: Gdk.DragContext

      the context for a drag (This must be called with a context for the source side of a drag)

    • icon_name: string

      name of icon to use

    • hot_x: number

      the X offset of the hotspot within the icon

    • hot_y: number

      the Y offset of the hotspot within the icon

    Returns void

drag_set_icon_pixbuf

  • Sets pixbuf as the icon for a given drag.

    Parameters

    • context: Gdk.DragContext

      the context for a drag (This must be called with a context for the source side of a drag)

    • pixbuf: Pixbuf

      the #GdkPixbuf to use as the drag icon

    • hot_x: number

      the X offset within widget of the hotspot

    • hot_y: number

      the Y offset within widget of the hotspot

    Returns void

drag_set_icon_stock

  • drag_set_icon_stock(context: Gdk.DragContext, stock_id: string, hot_x: number, hot_y: number): void

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

    Parameters

    • context: Gdk.DragContext

      the context for a drag (This must be called with a context for the source side of a drag)

    • stock_id: string

      the ID of the stock icon to use for the drag

    • hot_x: number

      the X offset within the icon of the hotspot

    • hot_y: number

      the Y offset within the icon of the hotspot

    Returns void

drag_set_icon_surface

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

    To position the surface relative to the mouse, use cairo_surface_set_device_offset() on surface. The mouse cursor will be positioned at the (0,0) coordinate of the surface.

    Parameters

    • context: Gdk.DragContext

      the context for a drag (This must be called with a context for the source side of a drag)

    • surface: cairo.Surface

      the surface to use as icon

    Returns void

drag_set_icon_widget

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

    Parameters

    • context: Gdk.DragContext

      the context for a drag. (This must be called with a context for the source side of a drag)

    • widget: Gtk.Widget

      a widget to use as an icon

    • hot_x: number

      the X offset within widget of the hotspot

    • hot_y: number

      the Y offset within widget of the hotspot

    Returns void

draw_insertion_cursor

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

    Parameters

    • widget: Gtk.Widget

      a #GtkWidget

    • cr: cairo.Context

      cairo context to draw to

    • location: Gdk.Rectangle

      location where to draw the cursor (location->width is ignored)

    • is_primary: boolean

      if the cursor should be the primary cursor color.

    • direction: Gtk.TextDirection

      whether the cursor is left-to-right or right-to-left. Should never be #GTK_TEXT_DIR_NONE

    • draw_arrow: boolean

      %TRUE to draw a directional arrow on the cursor. Should be %FALSE unless the cursor is split.

    Returns void

events_pending

  • events_pending(): boolean

false_TODO

  • false_TODO(): boolean

file_chooser_error_quark

  • file_chooser_error_quark(): Quark

get_binary_age

  • get_binary_age(): number

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

    Returns number

get_current_event

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

    For example, if you are handling a #GtkButton::clicked signal, the current event will be the #GdkEventButton that triggered the ::clicked signal.

    Returns Gdk.Event | null

get_current_event_device

  • get_current_event_device(): Gdk.Device | null

get_current_event_state

get_current_event_time

  • get_current_event_time(): number

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

    Returns number

get_debug_flags

  • get_debug_flags(): number

  • Returns the GTK+ debug flags.

    This function is intended for GTK+ modules that want to adjust their debug output based on GTK+ debug flags.

    Returns number

get_default_language

  • Returns the #PangoLanguage for the default language currently in effect. (Note that this can change over the life of an application.) The default language is derived from the current locale. It determines, for example, whether GTK+ uses the right-to-left or left-to-right text direction.

    This function is equivalent to pango_language_get_default(). See that function for details.

    Returns Pango.Language

get_event_widget

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

    Parameters

    Returns Gtk.Widget | null

get_interface_age

  • get_interface_age(): number

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

    Returns number

get_locale_direction

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

    This function depends on the current locale being set with setlocale() and will default to setting the %GTK_TEXT_DIR_LTR direction otherwise. %GTK_TEXT_DIR_NONE will never be returned.

    GTK+ sets the default text direction according to the locale during gtk_init(), and you should normally use gtk_widget_get_direction() or gtk_widget_get_default_direction() to obtain the current direcion.

    This function is only needed rare cases when the locale is changed after GTK+ has already been initialized. In this case, you can use it to update the default text direction as follows:

    setlocale (LC_ALL, new_locale);
    direction = gtk_get_locale_direction ();
    gtk_widget_set_default_direction (direction);

    Returns Gtk.TextDirection

get_major_version

  • get_major_version(): number

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

    This function is in the library, so it represents the GTK+ library your code is running against. Contrast with the #GTK_MAJOR_VERSION macro, which represents the major version of the GTK+ headers you have included when compiling your code.

    Returns number

get_micro_version

  • get_micro_version(): number

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

    This function is in the library, so it represents the GTK+ library your code is are running against. Contrast with the #GTK_MICRO_VERSION macro, which represents the micro version of the GTK+ headers you have included when compiling your code.

    Returns number

get_minor_version

  • get_minor_version(): number

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

    This function is in the library, so it represents the GTK+ library your code is are running against. Contrast with the #GTK_MINOR_VERSION macro, which represents the minor version of the GTK+ headers you have included when compiling your code.

    Returns number

get_option_group

  • get_option_group(open_default_display: boolean): OptionGroup

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

    You should add this group to your #GOptionContext with g_option_context_add_group(), if you are using g_option_context_parse() to parse your commandline arguments.

    Parameters

    • open_default_display: boolean

      whether to open the default display when parsing the commandline arguments

    Returns OptionGroup

grab_get_current

icon_size_from_name

  • icon_size_from_name(name: string): number

  • Looks up the icon size associated with name.

    Parameters

    • name: string

      the name to look up.

    Returns number

icon_size_get_name

  • icon_size_get_name(size: number): string

  • Gets the canonical name of the given icon size. The returned string is statically allocated and should not be freed.

    Parameters

    • size: number

      a #GtkIconSize.

    Returns string

icon_size_lookup

  • icon_size_lookup(size: number): [boolean, number, number]

  • Obtains the pixel size of a semantic icon size size: #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function isn’t normally needed, gtk_icon_theme_load_icon() is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by gtk_icon_size_lookup(), because themes are free to render the pixbuf however they like, including changing the usual size.

    Parameters

    • size: number

      an icon size (#GtkIconSize)

    Returns [boolean, number, number]

icon_size_lookup_for_settings

  • icon_size_lookup_for_settings(settings: Gtk.Settings, size: number): [boolean, number, number]

  • Obtains the pixel size of a semantic icon size, possibly modified by user preferences for a particular #GtkSettings. Normally size would be #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function isn’t normally needed, gtk_widget_render_icon_pixbuf() is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by gtk_icon_size_lookup(), because themes are free to render the pixbuf however they like, including changing the usual size.

    Parameters

    • settings: Gtk.Settings

      a #GtkSettings object, used to determine which set of user preferences to used.

    • size: number

      an icon size (#GtkIconSize)

    Returns [boolean, number, number]

icon_size_register

  • icon_size_register(name: string, width: number, height: number): number

  • Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU, etc. Returns the integer value for the size.

    Parameters

    • name: string

      name of the icon size

    • width: number

      the icon width

    • height: number

      the icon height

    Returns number

icon_size_register_alias

  • icon_size_register_alias(alias: string, target: number): void

  • Registers alias as another name for target. So calling gtk_icon_size_from_name() with alias as argument will return target.

    Parameters

    • alias: string

      an alias for target

    • target: number

      an existing icon size (#GtkIconSize)

    Returns void

icon_theme_error_quark

  • icon_theme_error_quark(): Quark

init

  • init(argv: string[]): string[] | null

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

    Although you are expected to pass the argc, argv parameters from main() to this function, it is possible to pass %NULL if argv is not available or commandline handling is not required.

    argc and argv are adjusted accordingly so your own code will never see those standard arguments.

    Note that there are some alternative ways to initialize GTK+: if you are calling gtk_parse_args(), gtk_init_check(), gtk_init_with_args() or g_option_context_parse() with the option group returned by gtk_get_option_group(), you don’t have to call gtk_init().

    And if you are using #GtkApplication, you don't have to call any of the initialization functions either; the #GtkApplication::startup handler does it for you.

    This function will terminate your program if it was unable to initialize the windowing system for some reason. If you want your program to fall back to a textual interface you want to call gtk_init_check() instead.

    Since 2.18, GTK+ calls signal (SIGPIPE, SIG_IGN) during initialization, to ignore SIGPIPE signals, since these are almost never wanted in graphical applications. If you do need to handle SIGPIPE for some reason, reset the handler after gtk_init(), but notice that other libraries (e.g. libdbus or gvfs) might do similar things.

    Parameters

    • argv: string[]

      Address of the argv parameter of main(), or %NULL. Any options understood by GTK+ are stripped before return.

    Returns string[] | null

init_check

  • init_check(argv: string[]): [boolean, string[] | null]

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

    This way the application can fall back to some other means of communication with the user - for example a curses or command line interface.

    Note that calling any GTK function or instantiating any GTK type after this function returns %FALSE results in undefined behavior.

    Parameters

    • argv: string[]

      Address of the argv parameter of main(), or %NULL. Any options understood by GTK+ are stripped before return.

    Returns [boolean, string[] | null]

init_with_args

  • init_with_args(argv: string[], parameter_string: string, entries: OptionEntry[], translation_domain: string): [boolean, string[] | null]

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

    Parameters

    • argv: string[]

      Address of the argv parameter of main(), or %NULL. Any options understood by GTK+ are stripped before return.

    • parameter_string: string

      a string which is displayed in the first line of --help output, after programname [OPTION...]

    • entries: OptionEntry[]

      a %NULL-terminated array of #GOptionEntrys describing the options of your program

    • translation_domain: string

      a translation domain to use for translating the --help output for the options in entries and the parameter_string with gettext(), or %NULL

    Returns [boolean, string[] | null]

key_snooper_remove

  • key_snooper_remove(snooper_handler_id: number): void

  • Removes the key snooper function with the given id.

    Parameters

    • snooper_handler_id: number

      Identifies the key snooper to remove

    Returns void

main

  • main(): void

  • Runs the main loop until gtk_main_quit() is called.

    You can nest calls to gtk_main(). In that case gtk_main_quit() will make the innermost invocation of the main loop return.

    Returns void

main_do_event

  • Processes a single GDK event.

    This is public only to allow filtering of events between GDK and GTK+. You will not usually need to call this function directly.

    While you should not call this function directly, you might want to know how exactly events are handled. So here is what this function does with the event:

    1. Compress enter/leave notify events. If the event passed build an enter/leave pair together with the next event (peeked from GDK), both events are thrown away. This is to avoid a backlog of (de-)highlighting widgets crossed by the pointer.

    2. Find the widget which got the event. If the widget can’t be determined the event is thrown away unless it belongs to a INCR transaction.

    3. Then the event is pushed onto a stack so you can query the currently handled event with gtk_get_current_event().

    4. The event is sent to a widget. If a grab is active all events for widgets that are not in the contained in the grab widget are sent to the latter with a few exceptions:

      • Deletion and destruction events are still sent to the event widget for obvious reasons.
      • Events which directly relate to the visual representation of the event widget.
      • Leave events are delivered to the event widget if there was an enter event delivered to it before without the paired leave event.
      • Drag events are not redirected because it is unclear what the semantics of that would be. Another point of interest might be that all key events are first passed through the key snooper functions if there are any. Read the description of gtk_key_snooper_install() if you need this feature.

    5. After finishing the delivery the event is popped from the event stack.

    Parameters

    • event: Gdk.Event

      An event to process (normally passed by GDK)

    Returns void

main_iteration

  • main_iteration(): boolean

  • Runs a single iteration of the mainloop.

    If no events are waiting to be processed GTK+ will block until the next event is noticed. If you don’t want to block look at gtk_main_iteration_do() or check if any events are pending with gtk_events_pending() first.

    Returns boolean

main_iteration_do

  • main_iteration_do(blocking: boolean): boolean

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

    Parameters

    • blocking: boolean

      %TRUE if you want GTK+ to block if no events are pending

    Returns boolean

main_level

  • main_level(): number

main_quit

  • main_quit(): void

paint_arrow

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      the type of shadow to draw

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • arrow_type: Gtk.ArrowType

      the type of arrow to draw

    • fill: boolean

      %TRUE if the arrow tip should be filled

    • x: number

      x origin of the rectangle to draw the arrow in

    • y: number

      y origin of the rectangle to draw the arrow in

    • width: number

      width of the rectangle to draw the arrow in

    • height: number

      height of the rectangle to draw the arrow in

    Returns void

paint_box

  • Draws a box on cr with the given parameters.

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      the type of shadow to draw

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      x origin of the box

    • y: number

      y origin of the box

    • width: number

      the width of the box

    • height: number

      the height of the box

    Returns void

paint_box_gap

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      type of shadow to draw

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      x origin of the rectangle

    • y: number

      y origin of the rectangle

    • width: number

      width of the rectangle

    • height: number

      width of the rectangle

    • gap_side: Gtk.PositionType

      side in which to leave the gap

    • gap_x: number

      starting position of the gap

    • gap_width: number

      width of the gap

    Returns void

paint_check

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      the type of shadow to draw

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      x origin of the rectangle to draw the check in

    • y: number

      y origin of the rectangle to draw the check in

    • width: number

      the width of the rectangle to draw the check in

    • height: number

      the height of the rectangle to draw the check in

    Returns void

paint_diamond

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      the type of shadow to draw

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      x origin of the rectangle to draw the diamond in

    • y: number

      y origin of the rectangle to draw the diamond in

    • width: number

      width of the rectangle to draw the diamond in

    • height: number

      height of the rectangle to draw the diamond in

    Returns void

paint_expander

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      the x position to draw the expander at

    • y: number

      the y position to draw the expander at

    • expander_style: Gtk.ExpanderStyle

      the style to draw the expander in; determines whether the expander is collapsed, expanded, or in an intermediate state.

    Returns void

paint_extension

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      type of shadow to draw

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      x origin of the extension

    • y: number

      y origin of the extension

    • width: number

      width of the extension

    • height: number

      width of the extension

    • gap_side: Gtk.PositionType

      the side on to which the extension is attached

    Returns void

paint_flat_box

  • Draws a flat box on cr with the given parameters.

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      the type of shadow to draw

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      x origin of the box

    • y: number

      y origin of the box

    • width: number

      the width of the box

    • height: number

      the height of the box

    Returns void

paint_focus

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      the x origin of the rectangle around which to draw a focus indicator

    • y: number

      the y origin of the rectangle around which to draw a focus indicator

    • width: number

      the width of the rectangle around which to draw a focus indicator

    • height: number

      the height of the rectangle around which to draw a focus indicator

    Returns void

paint_handle

  • Draws a handle as used in #GtkHandleBox and #GtkPaned.

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      type of shadow to draw

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      x origin of the handle

    • y: number

      y origin of the handle

    • width: number

      with of the handle

    • height: number

      height of the handle

    • orientation: Gtk.Orientation

      the orientation of the handle

    Returns void

paint_hline

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #caio_t

    • state_type: Gtk.StateType

      a state

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x1: number

      the starting x coordinate

    • x2: number

      the ending x coordinate

    • y: number

      the y coordinate

    Returns void

paint_layout

  • Draws a layout on cr using the given parameters.

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • use_text: boolean

      whether to use the text or foreground graphics context of style

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      x origin

    • y: number

      y origin

    • layout: Pango.Layout

      the layout to draw

    Returns void

paint_option

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      the type of shadow to draw

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      x origin of the rectangle to draw the option in

    • y: number

      y origin of the rectangle to draw the option in

    • width: number

      the width of the rectangle to draw the option in

    • height: number

      the height of the rectangle to draw the option in

    Returns void

paint_resize_grip

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • edge: Gdk.WindowEdge

      the edge in which to draw the resize grip

    • x: number

      the x origin of the rectangle in which to draw the resize grip

    • y: number

      the y origin of the rectangle in which to draw the resize grip

    • width: number

      the width of the rectangle in which to draw the resize grip

    • height: number

      the height of the rectangle in which to draw the resize grip

    Returns void

paint_shadow

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      type of shadow to draw

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      x origin of the rectangle

    • y: number

      y origin of the rectangle

    • width: number

      width of the rectangle

    • height: number

      width of the rectangle

    Returns void

paint_shadow_gap

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      type of shadow to draw

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      x origin of the rectangle

    • y: number

      y origin of the rectangle

    • width: number

      width of the rectangle

    • height: number

      width of the rectangle

    • gap_side: Gtk.PositionType

      side in which to leave the gap

    • gap_x: number

      starting position of the gap

    • gap_width: number

      width of the gap

    Returns void

paint_slider

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      a shadow

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      the x origin of the rectangle in which to draw a slider

    • y: number

      the y origin of the rectangle in which to draw a slider

    • width: number

      the width of the rectangle in which to draw a slider

    • height: number

      the height of the rectangle in which to draw a slider

    • orientation: Gtk.Orientation

      the orientation to be used

    Returns void

paint_spinner

  • Draws a spinner on window using the given parameters.

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • widget: Gtk.Widget

      the widget (may be %NULL)

    • detail: string

      a style detail (may be %NULL)

    • step: number

      the nth step

    • x: number

      the x origin of the rectangle in which to draw the spinner

    • y: number

      the y origin of the rectangle in which to draw the spinner

    • width: number

      the width of the rectangle in which to draw the spinner

    • height: number

      the height of the rectangle in which to draw the spinner

    Returns void

paint_tab

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

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • shadow_type: Gtk.ShadowType

      the type of shadow to draw

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • x: number

      x origin of the rectangle to draw the tab in

    • y: number

      y origin of the rectangle to draw the tab in

    • width: number

      the width of the rectangle to draw the tab in

    • height: number

      the height of the rectangle to draw the tab in

    Returns void

paint_vline

  • Draws a vertical line from (x, y1) to (x, y2) in cr using the given style and state.

    Parameters

    • style: Gtk.Style

      a #GtkStyle

    • cr: cairo.Context

      a #cairo_t

    • state_type: Gtk.StateType

      a state

    • widget: Gtk.Widget

      the widget

    • detail: string

      a style detail

    • y1_: number

      the starting y coordinate

    • y2_: number

      the ending y coordinate

    • x: number

      the x coordinate

    Returns void

paper_size_get_default

  • paper_size_get_default(): string

paper_size_get_paper_sizes

  • paper_size_get_paper_sizes(include_custom: boolean): Gtk.PaperSize[]

  • Creates a list of known paper sizes.

    Parameters

    • include_custom: boolean

      whether to include custom paper sizes as defined in the page setup dialog

    Returns Gtk.PaperSize[]

parse_args

  • parse_args(argv: string[]): [boolean, string[]]

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

    Any arguments used by GTK+ or GDK are removed from the array and argc and argv are updated accordingly.

    There is no need to call this function explicitly if you are using gtk_init(), or gtk_init_check().

    Note that many aspects of GTK+ require a display connection to function, so this way of initializing GTK+ is really only useful for specialized use cases.

    Parameters

    • argv: string[]

      a pointer to the array of command line arguments

    Returns [boolean, string[]]

print_error_quark

  • print_error_quark(): Quark

print_run_page_setup_dialog

  • Runs a page setup dialog, letting the user modify the values from page_setup. If the user cancels the dialog, the returned #GtkPageSetup is identical to the passed in page_setup, otherwise it contains the modifications done in the dialog.

    Note that this function may use a recursive mainloop to show the page setup dialog. See gtk_print_run_page_setup_dialog_async() if this is a problem.

    Parameters

    Returns Gtk.PageSetup

print_run_page_setup_dialog_async

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

    In contrast to gtk_print_run_page_setup_dialog(), this function returns after showing the page setup dialog on platforms that support this, and calls done_cb from a signal handler for the ::response signal of the dialog.

    Parameters

    Returns void

propagate_event

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

    Events received by GTK+ from GDK normally begin in gtk_main_do_event(). Depending on the type of event, existence of modal dialogs, grabs, etc., the event may be propagated; if so, this function is used.

    gtk_propagate_event() calls gtk_widget_event() on each widget it decides to send the event to. So gtk_widget_event() is the lowest-level function; it simply emits the #GtkWidget::event and possibly an event-specific signal on a widget. gtk_propagate_event() is a bit higher-level, and gtk_main_do_event() is the highest level.

    All that said, you most likely don’t want to use any of these functions; synthesizing events is rarely needed. There are almost certainly better ways to achieve your goals. For example, use gdk_window_invalidate_rect() or gtk_widget_queue_draw() instead of making up expose events.

    Parameters

    Returns void

rc_add_default_file

  • rc_add_default_file(filename: string): void

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

    Parameters

    • filename: string

      the pathname to the file. If filename is not absolute, it is searched in the current directory.

    Returns void

rc_find_module_in_path

  • rc_find_module_in_path(module_file: string): string

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

    Parameters

    • module_file: string

      name of a theme engine

    Returns string

rc_find_pixmap_in_path

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

    Parameters

    • settings: Gtk.Settings

      a #GtkSettings

    • scanner: GLib.Scanner

      Scanner used to get line number information for the warning message, or %NULL

    • pixmap_file: string

      name of the pixmap file to locate.

    Returns string

rc_get_default_files

  • rc_get_default_files(): string[]

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

    Returns string[]

rc_get_im_module_file

  • rc_get_im_module_file(): string

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

    Returns string

rc_get_im_module_path

  • rc_get_im_module_path(): string

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

    Returns string

rc_get_module_dir

  • rc_get_module_dir(): string

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

    Returns string

rc_get_style

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

    Parameters

    Returns Gtk.Style

rc_get_style_by_paths

  • rc_get_style_by_paths(settings: Gtk.Settings, widget_path: string, class_path: string, type: GType<unknown>): Gtk.Style | null

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

    The action of gtk_rc_get_style() is similar to:

     gtk_widget_path (widget, NULL, &path, NULL);
     gtk_widget_class_path (widget, NULL, &class_path, NULL);
     gtk_rc_get_style_by_paths (gtk_widget_get_settings (widget),
                                path, class_path,
                                G_OBJECT_TYPE (widget));

    Parameters

    • settings: Gtk.Settings

      a #GtkSettings object

    • widget_path: string

      the widget path to use when looking up the style, or %NULL if no matching against the widget path should be done

    • class_path: string

      the class path to use when looking up the style, or %NULL if no matching against the class path should be done.

    • type: GType<unknown>

      a type that will be used along with parent types of this type when matching against class styles, or #G_TYPE_NONE

    Returns Gtk.Style | null

rc_get_theme_dir

  • rc_get_theme_dir(): string

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

    Returns string

rc_parse

  • rc_parse(filename: string): void

  • Parses a given resource file.

    Parameters

    • filename: string

      the filename of a file to parse. If filename is not absolute, it is searched in the current directory.

    Returns void

rc_parse_color

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

    Note that theme engines should use gtk_rc_parse_color_full() in order to support symbolic colors.

    Parameters

    Returns [number, Gdk.Color]

rc_parse_color_full

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

    Parameters

    Returns [number, Gdk.Color]

rc_parse_priority

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

    Parameters

    • scanner: GLib.Scanner

      a #GScanner (must be initialized for parsing an RC file)

    • priority: Gtk.PathPriorityType

      A pointer to #GtkPathPriorityType variable in which to store the result.

    Returns number

rc_parse_state

rc_parse_string

  • rc_parse_string(rc_string: string): void

  • Parses resource information directly from a string.

    Parameters

    • rc_string: string

      a string to parse.

    Returns void

rc_property_parse_border

  • A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses borders in the form "{ left, right, top, bottom }" for integers left, right, top and bottom.

    Parameters

    • pspec: ParamSpec

      a #GParamSpec

    • gstring: GLib.String

      the #GString to be parsed

    • property_value: any

      a #GValue which must hold boxed values.

    Returns boolean

rc_property_parse_color

  • A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses a color given either by its name or in the form { red, green, blue } where red, green and blue are integers between 0 and 65535 or floating-point numbers between 0 and 1.

    Parameters

    • pspec: ParamSpec

      a #GParamSpec

    • gstring: GLib.String

      the #GString to be parsed

    • property_value: any

      a #GValue which must hold #GdkColor values.

    Returns boolean

rc_property_parse_enum

  • A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses a single enumeration value.

    The enumeration value can be specified by its name, its nickname or its numeric value. For consistency with flags parsing, the value may be surrounded by parentheses.

    Parameters

    • pspec: ParamSpec

      a #GParamSpec

    • gstring: GLib.String

      the #GString to be parsed

    • property_value: any

      a #GValue which must hold enum values.

    Returns boolean

rc_property_parse_flags

  • A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses flags.

    Flags can be specified by their name, their nickname or numerically. Multiple flags can be specified in the form "( flag1 | flag2 | ... )".

    Parameters

    • pspec: ParamSpec

      a #GParamSpec

    • gstring: GLib.String

      the #GString to be parsed

    • property_value: any

      a #GValue which must hold flags values.

    Returns boolean

rc_property_parse_requisition

  • rc_property_parse_requisition(pspec: ParamSpec, gstring: GLib.String, property_value: any): boolean

  • A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses a requisition in the form "{ width, height }" for integers %width and %height.

    Parameters

    • pspec: ParamSpec

      a #GParamSpec

    • gstring: GLib.String

      the #GString to be parsed

    • property_value: any

      a #GValue which must hold boxed values.

    Returns boolean

rc_reparse_all

  • rc_reparse_all(): boolean

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

    Returns boolean

rc_reparse_all_for_settings

  • rc_reparse_all_for_settings(settings: Gtk.Settings, force_load: boolean): boolean

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

    Parameters

    • settings: Gtk.Settings

      a #GtkSettings

    • force_load: boolean

      load whether or not anything changed

    Returns boolean

rc_reset_styles

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

    Parameters

    Returns void

rc_set_default_files

  • rc_set_default_files(filenames: string[]): void

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

    Parameters

    • filenames: string[]

      A %NULL-terminated list of filenames.

    Returns void

recent_chooser_error_quark

  • recent_chooser_error_quark(): Quark

recent_manager_error_quark

  • recent_manager_error_quark(): Quark

render_activity

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

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    Returns void

render_arrow

  • Renders an arrow pointing to angle.

    Typical arrow rendering at 0, 1⁄2 π;, π; and 3⁄2 π:

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • angle: number

      arrow angle from 0 to 2 * %G_PI, being 0 the arrow pointing to the north

    • x: number

      X origin of the render area

    • y: number

      Y origin of the render area

    • size: number

      square side for render area

    Returns void

render_background

  • Renders the background of an element.

    Typical background rendering, showing the effect of background-image, border-width and border-radius:

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    Returns void

render_background_get_clip

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

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    Returns Gdk.Rectangle

render_check

  • Renders a checkmark (as in a #GtkCheckButton).

    The %GTK_STATE_FLAG_CHECKED state determines whether the check is on or off, and %GTK_STATE_FLAG_INCONSISTENT determines whether it should be marked as undefined.

    Typical checkmark rendering:

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    Returns void

render_expander

  • Renders an expander (as used in #GtkTreeView and #GtkExpander) in the area defined by x, y, width, height. The state %GTK_STATE_FLAG_CHECKED determines whether the expander is collapsed or expanded.

    Typical expander rendering:

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    Returns void

render_extension

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

    Typical extension rendering:

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    • gap_side: Gtk.PositionType

      side where the gap is

    Returns void

render_focus

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

    Typical focus rendering:

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    Returns void

render_frame

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

    Examples of frame rendering, showing the effect of border-image, border-color, border-width, border-radius and junctions:

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    Returns void

render_frame_gap

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

    Typical rendering of a frame with a gap:

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    • gap_side: Gtk.PositionType

      side where the gap is

    • xy0_gap: number

      initial coordinate (X or Y depending on gap_side) for the gap

    • xy1_gap: number

      end coordinate (X or Y depending on gap_side) for the gap

    Returns void

render_handle

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

    Handles rendered for the paned and grip classes:

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    Returns void

render_icon

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

    This function will render the icon in pixbuf at exactly its size, regardless of scaling factors, which may not be appropriate when drawing on displays with high pixel densities.

    You probably want to use gtk_render_icon_surface() instead, if you already have a Cairo surface.

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • pixbuf: Pixbuf

      a #GdkPixbuf containing the icon to draw

    • x: number

      X position for the pixbuf

    • y: number

      Y position for the pixbuf

    Returns void

render_icon_pixbuf

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

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • source: Gtk.IconSource

      the #GtkIconSource specifying the icon to render

    • size: number

      the size (#GtkIconSize) to render the icon at. A size of (GtkIconSize) -1 means render at the size of the source and don’t scale.

    Returns Pixbuf

render_icon_surface

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

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • surface: cairo.Surface

      a #cairo_surface_t containing the icon to draw

    • x: number

      X position for the icon

    • y: number

      Y position for the incon

    Returns void

render_insertion_cursor

render_layout

render_line

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

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • x0: number

      X coordinate for the origin of the line

    • y0: number

      Y coordinate for the origin of the line

    • x1: number

      X coordinate for the end of the line

    • y1: number

      Y coordinate for the end of the line

    Returns void

render_option

  • Renders an option mark (as in a #GtkRadioButton), the %GTK_STATE_FLAG_CHECKED state will determine whether the option is on or off, and %GTK_STATE_FLAG_INCONSISTENT whether it should be marked as undefined.

    Typical option mark rendering:

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    Returns void

render_slider

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

    Typical slider rendering:

    Parameters

    • context: Gtk.StyleContext

      a #GtkStyleContext

    • cr: cairo.Context

      a #cairo_t

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    • orientation: Gtk.Orientation

      orientation of the slider

    Returns void

rgb_to_hsv

  • rgb_to_hsv(r: number, g: number, b: number): [number, number, number]

  • Converts a color from RGB space to HSV.

    Input values must be in the [0.0, 1.0] range; output values will be in the same range.

    Parameters

    • r: number

      Red

    • g: number

      Green

    • b: number

      Blue

    Returns [number, number, number]

selection_add_target

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

    Parameters

    • widget: Gtk.Widget

      a #GtkWidget

    • selection: Gdk.Atom

      the selection

    • target: Gdk.Atom

      target to add.

    • info: number

      A unsigned integer which will be passed back to the application.

    Returns void

selection_add_targets

selection_clear_targets

selection_convert

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

    Parameters

    • widget: Gtk.Widget

      The widget which acts as requestor

    • selection: Gdk.Atom

      Which selection to get

    • target: Gdk.Atom

      Form of information desired (e.g., STRING)

    • time_: number

      Time of request (usually of triggering event) In emergency, you could use #GDK_CURRENT_TIME

    Returns boolean

selection_owner_set

  • selection_owner_set(widget: Gtk.Widget, selection: Gdk.Atom, time_: number): boolean

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

    Parameters

    • widget: Gtk.Widget

      a #GtkWidget, or %NULL.

    • selection: Gdk.Atom

      an interned atom representing the selection to claim

    • time_: number

      timestamp with which to claim the selection

    Returns boolean

selection_owner_set_for_display

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

    Parameters

    • display: Gdk.Display

      the #GdkDisplay where the selection is set

    • widget: Gtk.Widget

      new selection owner (a #GtkWidget), or %NULL.

    • selection: Gdk.Atom

      an interned atom representing the selection to claim.

    • time_: number

      timestamp with which to claim the selection

    Returns boolean

selection_remove_all

  • selection_remove_all(widget: Gtk.Widget): void

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

    Parameters

    Returns void

set_debug_flags

  • set_debug_flags(flags: number): void

show_uri

  • show_uri(screen: Gdk.Screen, uri: string, timestamp: number): boolean

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

    Note that this function is deprecated as it does not pass the necessary information for helpers to parent their dialog properly, when run from sandboxed applications for example.

    Parameters

    • screen: Gdk.Screen

      screen to show the uri on or %NULL for the default screen

    • uri: string

      the uri to show

    • timestamp: number

      a timestamp to prevent focus stealing

    Returns boolean

show_uri_on_window

  • show_uri_on_window(parent: Gtk.Window, uri: string, timestamp: number): boolean

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

    • file:///home/gnome/pict.jpg
    • http://www.gnome.org
    • mailto:megnome.org

    Ideally the timestamp is taken from the event triggering the gtk_show_uri() call. If timestamp is not known you can take %GDK_CURRENT_TIME.

    This is the recommended call to be used as it passes information necessary for sandbox helpers to parent their dialogs properly.

    Parameters

    • parent: Gtk.Window

      parent window

    • uri: string

      the uri to show

    • timestamp: number

      a timestamp to prevent focus stealing

    Returns boolean

stock_add

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

    Parameters

    Returns void

stock_add_static

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

    Parameters

    • items: Gtk.StockItem[]

      a #GtkStockItem or array of #GtkStockItem

    Returns void

stock_list_ids

  • stock_list_ids(): string[]

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

    Returns string[]

stock_lookup

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

    Parameters

    • stock_id: string

      a stock item name

    Returns [boolean, Gtk.StockItem]

stock_set_translate_func

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

    If no function is registered for a translation domain, g_dgettext() is used.

    The function is used for all stock items whose translation_domain matches domain. Note that it is possible to use strings different from the actual gettext translation domain of your application for this, as long as your #GtkTranslateFunc uses the correct domain when calling dgettext(). This can be useful, e.g. when dealing with message contexts:

    GtkStockItem items[] = {
     { MY_ITEM1, NC_("odd items", "Item 1"), 0, 0, "odd-item-domain" },
     { MY_ITEM2, NC_("even items", "Item 2"), 0, 0, "even-item-domain" },
    };

    gchar *
    my_translate_func (const gchar *msgid,
                       gpointer     data)
    {
      gchar *msgctxt = data;

      return (gchar*)g_dpgettext2 (GETTEXT_PACKAGE, msgctxt, msgid);
    }

    ...

    gtk_stock_add (items, G_N_ELEMENTS (items));
    gtk_stock_set_translate_func ("odd-item-domain", my_translate_func, "odd items");
    gtk_stock_set_translate_func ("even-item-domain", my_translate_func, "even items");

    Parameters

    • domain: string

      the translation domain for which func shall be used

    • func: Gtk.TranslateFunc

      a #GtkTranslateFunc

    Returns void

target_table_free

target_table_new_from_list

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

    Parameters

    Returns Gtk.TargetEntry[]

targets_include_image

  • targets_include_image(targets: Gdk.Atom[], writable: boolean): boolean

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

    Parameters

    • targets: Gdk.Atom[]

      an array of #GdkAtoms

    • writable: boolean

      whether to accept only targets for which GTK+ knows how to convert a pixbuf into the format

    Returns boolean

targets_include_rich_text

targets_include_text

  • targets_include_text(targets: Gdk.Atom[]): boolean

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

    Parameters

    • targets: Gdk.Atom[]

      an array of #GdkAtoms

    Returns boolean

targets_include_uri

  • targets_include_uri(targets: Gdk.Atom[]): boolean

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

    Parameters

    • targets: Gdk.Atom[]

      an array of #GdkAtoms

    Returns boolean

test_create_simple_window

  • test_create_simple_window(window_title: string, dialog_text: string): Gtk.Widget

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

    Parameters

    • window_title: string

      Title of the window to be displayed.

    • dialog_text: string

      Text inside the window to be displayed.

    Returns Gtk.Widget

test_find_label

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

    Parameters

    • widget: Gtk.Widget

      Valid label or container widget.

    • label_pattern: string

      Shell-glob pattern to match a label string.

    Returns Gtk.Widget

test_find_sibling

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

    Parameters

    • base_widget: Gtk.Widget

      Valid widget, part of a widget hierarchy

    • widget_type: GType<unknown>

      Type of a aearched for sibling widget

    Returns Gtk.Widget

test_find_widget

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

    Parameters

    • widget: Gtk.Widget

      Container widget, usually a GtkWindow.

    • label_pattern: string

      Shell-glob pattern to match a label string.

    • widget_type: GType<unknown>

      Type of a aearched for label sibling widget.

    Returns Gtk.Widget | null

test_list_all_types

  • test_list_all_types(): GType[]

test_register_all_types

  • test_register_all_types(): void

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

    Returns void

test_slider_get_value

  • test_slider_get_value(widget: Gtk.Widget): number

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

    Parameters

    Returns number

test_slider_set_perc

  • test_slider_set_perc(widget: Gtk.Widget, percentage: number): void

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

    Parameters

    • widget: Gtk.Widget

      valid widget pointer.

    • percentage: number

      value between 0 and 100.

    Returns void

test_spin_button_click

  • test_spin_button_click(spinner: Gtk.SpinButton, button: number, upwards: boolean): boolean

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

    Parameters

    • spinner: Gtk.SpinButton

      valid GtkSpinButton widget.

    • button: number

      Number of the pointer button for the event, usually 1, 2 or 3.

    • upwards: boolean

      %TRUE for upwards arrow click, %FALSE for downwards arrow click.

    Returns boolean

test_text_get

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

    Parameters

    Returns string

test_text_set

  • test_text_set(widget: Gtk.Widget, string: string): void

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

    Parameters

    • widget: Gtk.Widget

      valid widget pointer.

    • string: string

      a 0-terminated C string

    Returns void

test_widget_click

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

    Parameters

    • widget: Gtk.Widget

      Widget to generate a button click on.

    • button: number

      Number of the pointer button for the event, usually 1, 2 or 3.

    • modifiers: Gdk.ModifierType

      Keyboard modifiers the event is setup with.

    Returns boolean

test_widget_send_key

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

    Parameters

    • widget: Gtk.Widget

      Widget to generate a key press and release on.

    • keyval: number

      A Gdk keyboard value.

    • modifiers: Gdk.ModifierType

      Keyboard modifiers the event is setup with.

    Returns boolean

test_widget_wait_for_draw

  • test_widget_wait_for_draw(widget: Gtk.Widget): void

  • Enters the main loop and waits for widget to be “drawn”. In this context that means it waits for the frame clock of widget to have run a full styling, layout and drawing cycle.

    This function is intended to be used for syncing with actions that depend on widget relayouting or on interaction with the display server.

    Parameters

    Returns void

tree_get_row_drag_data

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

    Parameters

    Returns [boolean, Gtk.TreeModel | null, Gtk.TreePath | null]

tree_row_reference_deleted

  • Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the #GtkTreeModel::row-deleted signal.

    Parameters

    Returns void

tree_row_reference_inserted

  • Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the #GtkTreeModel::row-inserted signal.

    Parameters

    Returns void

tree_set_row_drag_data

true_TODO

  • true_TODO(): boolean

  • All this function does it to return %TRUE.

    This can be useful for example if you want to inhibit the deletion of a window. Of course you should not do this as the user expects a reaction from clicking the close icon of the window...

    A persistent window

     
    #include <gtk/gtk.h>

    int
    main (int argc, char **argv)
    {
      GtkWidget *win, *but;
      const char *text = "Close yourself. I mean it!";

      gtk_init (&argc, &argv);

      win = gtk_window_new (GTK_WINDOW_TOPLEVEL);
      g_signal_connect (win,
                        "delete-event",
                        G_CALLBACK (gtk_true),
                        NULL);
      g_signal_connect (win, "destroy",
                        G_CALLBACK (gtk_main_quit),
                        NULL);

      but = gtk_button_new_with_label (text);
      g_signal_connect_swapped (but, "clicked",
                                G_CALLBACK (gtk_object_destroy),
                                win);
      gtk_container_add (GTK_CONTAINER (win), but);

      gtk_widget_show_all (win);

      gtk_main ();

      return 0;
    }

    Returns boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc v0.22.17 Gjsify Theme v0.1.0