about-dialog
============

about-dialog
Superclass: dialog atk-implementor-iface buildable

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

About dialog often contain links and email addresses. about-dialog supports this by offering global hooks (TODO: not implemented in cl-gtk2), which are called when the user clicks on a link or email address, see gtk_about_dialog_set_email_hook() and gtk_about_dialog_set_url_hook(). Email addresses in the authors, documenters and artists properties are recognized by looking for <user@host>, URLs are recognized by looking for http://url, with url extending to the next space, tab or line break.

When setting the website and email hooks for the about-dialog widget, you should remember that the order is important: you should set the hook functions before setting the website and email URL properties. Otherwise the about-dialog widget will not display the website and the email addresses as clickable.

Note that GTK+ sets a default title of _("About %s") on the dialog window (where %s is replaced by the name of the application, but in order to ensure proper translation of the title, applications should set the title property explicitly when constructing a about-dialog, as shown in the following example:

     (make-instance 'gtk:about-dialog :program-name "ExampleCode" :title "About ExampleCode")

Slots:

  * artists. Type: list of string. Accessor: about-dialog-artists.

     The people who contributed artwork to the program, as a list of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the description for more details.

  * authors. Type: list of string. Accessor: about-dialog-authors.

     The authors of the program, as a list of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

  * comments. Type: string. Accessor: about-dialog-comments.

     Comments about the program. This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, not a detailed list of features.

     Default value: NIL

  * copyright. Type: string. Accessor: about-dialog-copyright.

     Copyright information for the program.

     Default value: NIL

  * documenters. Type: list of string. Accessor: about-dialog-documenters.

     The people documenting the program, as a list of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

  * license. Type: string. Accessor: about-dialog-license.

     The license of the program. This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is only wrapped in the text view if the about-dialog,wrap-license property is set to True; otherwise the text itself must contain the intended linebreaks.

     Default value: NIL

  * logo. Type: pixbuf. Accessor: about-dialog-logo.

     A logo for the about box. If this is not set, it defaults to gtk_window_get_default_icon_list().

  * logo-icon-name. Type: string. Accessor: about-dialog-logo-icon-name.

     A named icon to use as the logo for the about box. This property overrides the about-dialog,logo property.

     Default value: NIL

  * program-name. Type: string. Accessor: about-dialog-program-name.

     The name of the program. If this is not set, it defaults to g_get_application_name().

     Default value: NIL

  * translator-credits. Type: string. Accessor: about-dialog-translator-credits.

     Credits to the translators. This string should be marked as translatable. The string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

     Default value: NIL

  * version. Type: string. Accessor: about-dialog-version.

     The version of the program.

     Default value: NIL

  * website. Type: string. Accessor: about-dialog-website.

     The URL for the link to the website of the program. This should be a string starting with "http://.

     Default value: NIL

  * website-label. Type: string. Accessor: about-dialog-website-label.

     The label for the link to the website of the program. If this is not set, it defaults to the URL specified in the website property.

     Default value: NIL

  * wrap-license. Type: boolean. Accessor: about-dialog-wrap-license.

     Whether to wrap the text in the license dialog.

     Default value: False

Signals:

accel-label
===========

accel-label
Superclass: label atk-implementor-iface buildable

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

The accelerator key to display is not set explicitly. Instead, the accel-label displays the accelerators which have been added to a particular widget. This widget is set by accel-label,accel-widget.

For example, a menu-item widget may have an accelerator added to emit the menu-item,activate signal when the 'Ctl+S' key combination is pressed. A accel-label is created and added to the accel-label, and accel-label,accel-widget is set to the menu-item as the second argument. The accel-label will now display 'Ctl+S' after its label.

A accel-label will only display accelerators which have accel-flags,visible set. Aaccel-label can display multiple accelerators and even signal names, though it is almost always used to display just one accelerator key.

Slots:

  * accel-closure. Type: GClosure. Accessor: accel-label-accel-closure.

     The closure to be monitored for accelerator changes.

     TODO: GClosure type mapping is not supported

  * accel-widget. Type: widget. Accessor: accel-label-accel-widget.

     The widget to be monitored for accelerator changes.

Signals:

alignment
=========

alignment
Superclass: bin atk-implementor-iface buildable

Slots:

  * bottom-padding. Type: integer. Accessor: alignment-bottom-padding.

  * left-padding. Type: integer. Accessor: alignment-left-padding.

  * right-padding. Type: integer. Accessor: alignment-right-padding.

  * top-padding. Type: integer. Accessor: alignment-top-padding.

  * xalign. Type: single-float. Accessor: alignment-xalign.

  * xscale. Type: single-float. Accessor: alignment-xscale.

  * yalign. Type: single-float. Accessor: alignment-yalign.

  * yscale. Type: single-float. Accessor: alignment-yscale.

Signals:

arrow
=====

arrow
Superclass: misc atk-implementor-iface buildable

Slots:

  * arrow-type. Type: arrow-type. Accessor: arrow-arrow-type.

  * shadow-type. Type: shadow-type. Accessor: arrow-shadow-type.

Signals:

aspect-frame
============

aspect-frame
Superclass: frame atk-implementor-iface buildable

Slots:

  * obey-child. Type: boolean. Accessor: aspect-frame-obey-child.

  * ratio. Type: single-float. Accessor: aspect-frame-ratio.

  * xalign. Type: single-float. Accessor: aspect-frame-xalign.

  * yalign. Type: single-float. Accessor: aspect-frame-yalign.

Signals:

assistant
=========

assistant
Superclass: gtk-window atk-implementor-iface buildable

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

Slots:

  * current-page. Type: integer. Accessor: assistant-current-page.

     The index (starting from 0) of the current page in the assistant, or -1 if the assistant has no pages.

  * forward-page-function. function. Accessor: assistant-forward-page-function. Write-only.

     Page forwarding function is used to determine what will be the next page when the user presses the forward button. Setting this to NIL will make the assistant to use the default forward function, which just goes to the next visible page. The function called both for computing the next page when the user presses the "forward" button and for handling the behavior of the "last" button. The function accepts a single integer - the current page number and returns the page number for the next page.

  * n-pages. Type: integer. Accessor: assistant-n-pages. Read-only.

     The number of pages in the assistant

Signals:

  * "apply". Signature: (instance assistant) => void. Options: run-last.

     This signal is emitted when the apply button is clicked. The default behavior of the assistant is to switch to the page after the current page, unless the current page is the last one.

     A handler for the assistant,apply signal should carry out the actions for which the wizard has collected data. If the action takes a long time to complete, you might consider to put a page of type assistant-page-type,progress after the confirmation page and handle this operation within the assistant,prepare signal of the progress page.

  * "cancel". Signature: (instance assistant) => void. Options: run-last.

     This signal is emitted when then the cancel button is clicked.

  * "close". Signature: (instance assistant) => void. Options: run-last.

     This signal is emitted either when the close button of a summary page is clicked, or when the apply button in the last page in the flow (of type assistant-page-type,confirm) is clicked.

  * "prepare". Signature: (instance assistant), (page widget) => void. Options: run-last.

     This signal is emitted when a new page is set as the assistant's current page, before making the new page visible. A handler for this signal can do any preparation which are necessary before showing page.

assistant-nth-page

     (assistant-nth-page assistant page-number) => page-widget

Returns the child widget (a widget) contained in page number PAGE-NUMBER (an integer).

assistant-append-page

     (assistant-append-page assistant page)

Appends a PAGE (a widget) to the ASSISTANT (a assistant).

assistant-prepend-page

     (assistant-prepend-page assistant page)

Prepends a PAGE (a widget) to the ASSISTANT (a assistant).

assistant-insert-page

     (assistant-insert-page assistant page position) => page-number

Inserts a PAGE (a widget) in the ASSISTANT (a assistant) at a given POSITION. POSITION is the index (starting at 0) at which to insert the page, or -1 to append the page. Returns the index of inserted PAGE.

assistant-add-action-widget

     (assistant-add-action-widget assistant widget)

Adds the WIDGET (a widget) to the action area of a ASSISTANT (a assistant).

assistant-remove-action-widget

     (assistant-remove-action-widget assistant widget)

Removes the WIDGET (a widget) from the action area of a ASSISTANT (a assistant).

assistant-update-buttons-state

     (assistant-update-buttons-state assistant)

Forces ASSISTANT (a assistant) to recompute the buttons state.

GTK+ automatically takes care of this in most situations, e.g. when the user goes to a different page, or when the visibility or completeness of a page changes.

One situation where it can be necessary to call this function is when changing a value on the current page affects the future page flow of the assistant.

bin
===

bin
Superclass: container atk-implementor-iface buildable

Subclasses: viewport scrolled-window tool-item handle-box expander event-box combo-box frame alignment button item gtk-window

Slots:

Signals:

box
===

box
Superclass: container atk-implementor-iface buildable orientable

Subclasses: h-box v-box button-box

Slots:

  * homogeneous. Type: boolean. Accessor: box-homogeneous.

  * spacing. Type: integer. Accessor: box-spacing.

Signals:

button
======

button
Superclass: bin atk-implementor-iface activatable buildable

Subclasses: scale-button link-button font-button color-button toggle-button

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

The button widget can hold any valid child widget. That is it can hold most any other standard widget. The most commonly used child is the label.

Slots:

  * focus-on-click. Type: boolean. Accessor: button-focus-on-click.

     Whether the button grabs focus when it is clicked with the mouse.

     Default value: True

  * image. Type: widget. Accessor: button-image.

     Child widget to appear next to the button text.

  * image-position. Type: position-type. Accessor: button-image-position.

     The position of the image relative to the text inside the button.

     Default value: position-type,left

  * label. Type: string. Accessor: button-label.

     Text of the label widget inside the button, if the button contains a label widget.

     Default value: NIL

  * relief. Type: relief-style. Accessor: button-relief.

     The border relief style.

     Default value: relief-style,normal

  * use-stock. Type: boolean. Accessor: button-use-stock.

     If set, the label is used to pick a stock item instead of being displayed.

     Default value: False

  * use-underline. Type: boolean. Accessor: button-use-underline.

     If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.

     Default value: False

  * xalign. Type: single-float. Accessor: button-xalign.

     If the child of the button is a misc or alignment, this property can be used to control it's horizontal alignment. 0.0 is left aligned, 1.0 is right aligned.

     Allowed values: [0,1]

     Default value: 0.5

  * yalign. Type: single-float. Accessor: button-yalign.

     If the child of the button is a misc or alignment, this property can be used to control it's vertical alignment. 0.0 is left aligned, 1.0 is right aligned.

     Allowed values: [0,1]

     Default value: 0.5

Signals:

  * "activate". Signature: (instance button) => void. Options: run-first, action.

     This signal is an action signal and emitting it causes the button to animate press then release. Applications should never connect to this signal, but use the button,clicked signal.

  * "clicked". Signature: (instance button) => void. Options: run-first, action.

     Emitted when the button has been activated (pressed and released).

  * "enter". Signature: (instance button) => void. Options: run-first.

     Emitted when the pointer enters the button.

  * "leave". Signature: (instance button) => void. Options: run-first.

     Emitted when the pointer leaves the button.

  * "pressed". Signature: (instance button) => void. Options: run-first.

     Emitted when the button is pressed.

  * "released". Signature: (instance button) => void. Options: run-first.

     Emitted when the button is released.

button-box
==========

button-box
Superclass: box atk-implementor-iface buildable orientable

Subclasses: v-button-box h-button-box

Slots:

  * layout-style. Type: button-box-style. Accessor: button-box-layout-style.

Signals:

calendar
========

calendar
Superclass: widget atk-implementor-iface buildable

Slots:

  * day. Type: integer. Accessor: calendar-day.

  * detail-function. Type: ????. Accessor: calendar-detail-function. Write-only.

  * detail-height-rows. Type: integer. Accessor: calendar-detail-height-rows.

  * detail-width-chars. Type: integer. Accessor: calendar-detail-width-chars.

  * month. Type: integer. Accessor: calendar-month.

  * no-month-change. Type: boolean. Accessor: calendar-no-month-change.

  * show-day-names. Type: boolean. Accessor: calendar-show-day-names.

  * show-details. Type: boolean. Accessor: calendar-show-details.

  * show-heading. Type: boolean. Accessor: calendar-show-heading.

  * show-week-numbers. Type: boolean. Accessor: calendar-show-week-numbers.

  * year. Type: integer. Accessor: calendar-year.

Signals:

  * "day-selected". Signature: (instance calendar) => void. Options: run-first.

  * "day-selected-double-click". Signature: (instance calendar) => void. Options: run-first.

  * "month-changed". Signature: (instance calendar) => void. Options: run-first.

  * "next-month". Signature: (instance calendar) => void. Options: run-first.

  * "next-year". Signature: (instance calendar) => void. Options: run-first.

  * "prev-month". Signature: (instance calendar) => void. Options: run-first.

  * "prev-year". Signature: (instance calendar) => void. Options: run-first.

cell-view
=========

cell-view
Superclass: widget atk-implementor-iface buildable cell-layout

Slots:

  * background. Type: string. Accessor: cell-view-background. Write-only.

  * background-gdk. Type: color. Accessor: cell-view-background-gdk.

  * background-set. Type: boolean. Accessor: cell-view-background-set.

  * displayed-row. Type: tree-path. Accessor: cell-view-displayed-row.

  * model. Type: tree-model. Accessor: cell-view-model.

Signals:

check-button
============

check-button
Superclass: toggle-button atk-implementor-iface activatable buildable

Subclasses: radio-button

A check-button places a discrete toggle-button next to a widget, (usually a label). See the toggle-button for more information about toggle/check buttons.

The important signal toggle-button,toggled is also inherited from toggle-button.

Slots:

Signals:

check-menu-item
===============

check-menu-item
Superclass: menu-item atk-implementor-iface activatable buildable

Subclasses: radio-menu-item

Slots:

  * active. Type: boolean. Accessor: check-menu-item-active.

  * draw-as-radio. Type: boolean. Accessor: check-menu-item-draw-as-radio.

  * inconsistent. Type: boolean. Accessor: check-menu-item-inconsistent.

Signals:

  * "toggled". Signature: (instance check-menu-item) => void. Options: run-first.

color-button
============

color-button
Superclass: button atk-implementor-iface activatable buildable

Slots:

  * alpha. Type: integer. Accessor: color-button-alpha.

  * color. Type: color. Accessor: color-button-color.

  * title. Type: string. Accessor: color-button-title.

  * use-alpha. Type: boolean. Accessor: color-button-use-alpha.

Signals:

  * "color-set". Signature: (instance color-button) => void. Options: run-first.

color-selection
===============

color-selection
Superclass: v-box atk-implementor-iface buildable orientable

Slots:

  * current-alpha. Type: integer. Accessor: color-selection-current-alpha.

  * current-color. Type: color. Accessor: color-selection-current-color.

  * has-opacity-control. Type: boolean. Accessor: color-selection-has-opacity-control.

  * has-palette. Type: boolean. Accessor: color-selection-has-palette.

Signals:

  * "color-changed". Signature: (instance color-selection) => void. Options: run-first.

color-selection-dialog
======================

color-selection-dialog
Superclass: dialog atk-implementor-iface buildable

Slots:

  * cancel-button. Type: widget. Accessor: color-selection-dialog-cancel-button. Read-only.

  * color-selection. Type: widget. Accessor: color-selection-dialog-color-selection. Read-only.

  * help-button. Type: widget. Accessor: color-selection-dialog-help-button. Read-only.

  * ok-button. Type: widget. Accessor: color-selection-dialog-ok-button. Read-only.

Signals:

combo-box
=========

combo-box
Superclass: bin atk-implementor-iface buildable cell-editable cell-layout

Subclasses: combo-box-entry

Slots:

  * active. Type: integer. Accessor: combo-box-active.

  * active-iter. Type: tree-iter. Accessor: combo-box-active-iter.

  * add-tearoffs. Type: boolean. Accessor: combo-box-add-tearoffs.

  * button-sensitivity. Type: sensitivity-type. Accessor: combo-box-button-sensitivity.

  * column-span-column. Type: integer. Accessor: combo-box-column-span-column.

  * focus-on-click. Type: boolean. Accessor: combo-box-focus-on-click.

  * has-frame. Type: boolean. Accessor: combo-box-has-frame.

  * model. Type: tree-model. Accessor: combo-box-model.

  * popup-shown. Type: boolean. Accessor: combo-box-popup-shown. Read-only.

  * row-separator-func. Type: ????. Accessor: combo-box-row-separator-func. Write-only.

  * row-span-column. Type: integer. Accessor: combo-box-row-span-column.

  * tearoff-title. Type: string. Accessor: combo-box-tearoff-title.

  * wrap-width. Type: integer. Accessor: combo-box-wrap-width.

Signals:

  * "changed". Signature: (instance combo-box) => void. Options: run-last.

  * "move-active". Signature: (instance combo-box), (arg-1 scroll-type) => void. Options: run-last, action.

  * "popdown". Signature: (instance combo-box) => boolean. Options: run-last, action.

  * "popup". Signature: (instance combo-box) => void. Options: run-last, action.

combo-box-entry
===============

combo-box-entry
Superclass: combo-box atk-implementor-iface buildable cell-editable cell-layout

Slots:

  * text-column. Type: integer. Accessor: combo-box-entry-text-column.

Signals:

container
=========

container
Superclass: widget atk-implementor-iface buildable

Subclasses: tree toolbar text-view table socket layout paned fixed box icon-view tree-view notebook menu-shell bin

Slots:

  * border-width. Type: integer. Accessor: container-border-width.

  * child. Type: widget. Accessor: container-child. Write-only.

  * focus-child. Type: g-object. Accessor: container-focus-child.

  * focus-hadjustment. Type: g-object. Accessor: container-focus-hadjustment.

  * focus-vadjustment. Type: g-object. Accessor: container-focus-vadjustment.

  * resize-mode. Type: resize-mode. Accessor: container-resize-mode.

Signals:

  * "add". Signature: (instance container), (arg-1 widget) => void. Options: run-first.

  * "check-resize". Signature: (instance container) => void. Options: run-last.

  * "remove". Signature: (instance container), (arg-1 widget) => void. Options: run-first.

  * "set-focus-child". Signature: (instance container), (arg-1 widget) => void. Options: run-first.

curve
=====

curve
Superclass: drawing-area atk-implementor-iface buildable

Slots:

  * curve-type. Type: curve-type. Accessor: curve-curve-type.

  * max-x. Type: single-float. Accessor: curve-max-x.

  * max-y. Type: single-float. Accessor: curve-max-y.

  * min-x. Type: single-float. Accessor: curve-min-x.

  * min-y. Type: single-float. Accessor: curve-min-y.

Signals:

  * "curve-type-changed". Signature: (instance curve) => void. Options: run-first.

dialog
======

dialog
Superclass: gtk-window atk-implementor-iface buildable

Subclasses: recent-chooser-dialog message-dialog input-dialog font-selection-dialog file-chooser-dialog color-selection-dialog about-dialog

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

GTK+ treats a dialog as a window split vertically. The top section is a v-box, and is where widgets such as a label or a entry should be packed. The bottom area is known as the dialog,action-area. This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply. The two areas are separated by a h-separator.

If 'dialog' is a newly created dialog, the two primary areas of the window can be accessed through dialog,content-area and dialog,action-area.

A 'modal' dialog (that is, one which freezes the rest of the application from user input), can be created by setting gtk-window,modal (e.g., by specifying :modal t initarg).

If you add buttons to dialog using dialog-add-button, or dialog-add-action-widget, clicking the button will emit a dialog,response signal with a response ID that was specified. GTK+ will never assign a meaning to positive response IDs; these are entirely user-defined. But for convenience, you can use the response IDs in the response-type enumeration (these all have values less than zero). If a dialog receives a delete event, the dialog,response signal will be emitted with a response ID of response-type,delete-event.

TODO: cl-gtk2 does not yet support specifying custom response IDs.

If you want to block waiting for a dialog to return before returning control flow to your code, you can call dialog-run. This function enters a recursive main loop and waits for the user to respond to the dialog, returning the response ID corresponding to the button the user clicked.

For the simple dialog in the following example, in reality you'd probably use message-dialog to save yourself some effort. But you'd need to create the dialog contents manually if you had more than a simple message in the dialog.

     (defun quick-message (message)
       "Function to open a dialog box display the MESSAGE"
       (let ((dialog (make-instance 'gtk:dialog :title "Message")))
         (gtk:dialog-add-button dialog "gtk-ok" :none)
         (gtk:container-add (gtk:dialog-content-area dialog)
                            (make-instance 'gtk:label :label message))
         (gobject:connect-signal dialog "response"
                                 (lambda (dialog1 response-id)
                                   (declare (ignore dialog1 response-id))
                                   (gtk:object-destroy dialog)))
         (gtk:widget-show dialog)))

Slots:

  * action-area. Type: v-box. Accessor: dialog-action-area. Read-only.

     The action area of dialog.

  * alternative-button-order. Type: list of response-type. Accessor: dialog-alternative-button-order. Write-only.

     Sets an alternative button order. If the "gtk-alternative-button-order" setting is set to True, the dialog buttons are reordered according to the order of the response ids passed to this function.

     By default, GTK+ dialogs use the button order advocated by the Gnome Human Interface Guidelines with the affirmative button at the far right, and the cancel button left of it. But the builtin GTK+ dialogs and message-dialogs do provide an alternative button order, which is more suitable on some platforms, e.g. Windows.

     Set this after adding all the buttons to your dialog, as the following example shows:

          (setf (dialog-alternative-button-order dialog) '(:ok :cancel :help))

  * content-area. Type: widget. Accessor: dialog-content-area. Read-only.

     The content area of dialog.

  * default-response. Type: response-type. Accessor: dialog-default-response. Write-only.

     The widget in the dialog's action area with the given this response is the default widget for the dialog. Pressing "Enter" normally activates the default widget.

  * has-separator. Type: boolean. Accessor: dialog-has-separator.

     When True, the dialog has a separator bar above its buttons.

     Default value: True

Signals:

  * "close". Signature: (instance dialog) => void. Options: run-last, action.

     The close signal is a keybinding signal which gets emitted when the user uses a keybinding to close the dialog.

     The default binding for this signal is the Escape key.

  * "response". Signature: (instance dialog), (response-id integer) => void. Options: run-last.

     Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls dialog-response. On a delete event, the response ID is response-type,delete-event. Otherwise, it depends on which action widget was clicked.

     Note: because of some limitations, RESPONSE-ID is an integer. Use (cffi:foreign-enum-keyword 'gtk:response-type response-id) to get the value of type response-type.

dialog-run

     (dialog-run dialog) => response

Blocks in a recursive main loop until the dialog either emits the dialog,response signal, or is destroyed. If the dialog is destroyed during the call to dialog-run, it returns response-type,none. Otherwise, it returns the response ID from the dialog,response signal emission.

Before entering the recursive main loop, dialog-run calls widget-show on the dialog for you. Note that you still need to show any children of the dialog yourself.

During dialog-run, the default behavior of widget,delete-event is disabled; if the dialog receives widget,delete-event, it will not be destroyed as windows usually are, and dialog-run will return response-type,delete-event. Also, during dialog-run the dialog will be modal. You can force dialog-run to return at any time by calling dialog-response to emit the dialog,response signal. Destroying the dialog during dialog-run is a very bad idea, because your post-run code won't know whether the dialog was destroyed or not.

After dialog-run returns, you are responsible for hiding or destroying the dialog if you wish to do so.

Note that even though the recursive main loop gives the effect of a modal dialog (it prevents the user from interacting with other windows in the same window group while the dialog is run), callbacks such as timeouts, IO channel watches, DND drops, etc, will be triggered during a dialog-run call.

dialog-response

     (dialog-response dialog response)

Emits the dialog,response signal with the given RESPONSE (of type response-type). Used to indicate that the user has responded to the DIALOG in some way; typically either you or dialog-run will be monitoring the dialog,response signal and take appropriate action.

dialog-add-button

     (dialog-add-button dialog text response) => button

Adds a button with the given TEXT (or a stock button, if TEXT is a stock ID) and sets things up so that clicking the button will emit the dialog,response signal with the given RESPONSE. The button is appended to the end of the dialog's action area. The button widget is returned, but usually you don't need it.

dialog-add-action-widget

     (dialog-add-action-widget dialog widget response)

Adds an activatable WIDGET to the action area of a DIALOG, connecting a signal handler that will emit the dialog,response signal on the dialog when the WIDGET is activated. The WIDGET is appended to the end of the dialog's action area. If you want to add a non-activatable widget, simply pack it into the dialog,action-area field of the dialog.

dialog-set-response-sensitive

     (dialog-set-response-sensitive dialog response setting)

Sets the widget,sensitive for each widget in the dialog's action area with the given RESPONSE. A convenient way to sensitize/desensitize dialog buttons.

dialog-response-for-widget

     (dialog-response-for-widget dialog widget) => response

Gets the RESPONSE (of type response-type) of a WIDGET in the action area of a DIALOG.

dialog-alternative-button-order-on-screen

     (dialog-alternative-button-order-on-screen screen) => boolean

Returns True if dialogs are expected to use an alternative button order on the screen SCREEN. See dialog,alternative-button-order for more details about alternative button order.

If you need to use this method, 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.

SCREEN: a screen or a NIL if to use a default screen.

drawing-area
============

drawing-area
Superclass: widget atk-implementor-iface buildable

Subclasses: curve

Slots:

Signals:

entry
=====

entry
Superclass: widget atk-implementor-iface buildable cell-editable editable

Subclasses: spin-button

Slots:

  * activates-default. Type: boolean. Accessor: entry-activates-default.

  * caps-lock-warning. Type: boolean. Accessor: entry-caps-lock-warning.

  * cursor-position. Type: integer. Accessor: entry-cursor-position. Read-only.

  * editable. Type: boolean. Accessor: entry-editable.

  * has-frame. Type: boolean. Accessor: entry-has-frame.

  * im-module. Type: string. Accessor: entry-im-module.

  * inner-border. Type: border. Accessor: entry-inner-border.

  * invisible-char. Type: integer. Accessor: entry-invisible-char.

  * invisible-char-set. Type: boolean. Accessor: entry-invisible-char-set.

  * max-length. Type: integer. Accessor: entry-max-length.

  * overwrite-mode. Type: boolean. Accessor: entry-overwrite-mode.

  * primary-icon-activatable. Type: boolean. Accessor: entry-primary-icon-activatable.

  * primary-icon-gicon. Type: GIcon. Accessor: entry-primary-icon-gicon.

  * primary-icon-name. Type: string. Accessor: entry-primary-icon-name.

  * primary-icon-pixbuf. Type: pixbuf. Accessor: entry-primary-icon-pixbuf.

  * primary-icon-sensitive. Type: boolean. Accessor: entry-primary-icon-sensitive.

  * primary-icon-stock. Type: string. Accessor: entry-primary-icon-stock.

  * primary-icon-storage-type. Type: image-type. Accessor: entry-primary-icon-storage-type. Read-only.

  * primary-icon-tooltip-markup. Type: string. Accessor: entry-primary-icon-tooltip-markup.

  * primary-icon-tooltip-text. Type: string. Accessor: entry-primary-icon-tooltip-text.

  * progress-fraction. Type: double-float. Accessor: entry-progress-fraction.

  * progress-pulse-step. Type: double-float. Accessor: entry-progress-pulse-step.

  * scroll-offset. Type: integer. Accessor: entry-scroll-offset. Read-only.

  * secondary-icon-activatable. Type: boolean. Accessor: entry-secondary-icon-activatable.

  * secondary-icon-gicon. Type: GIcon. Accessor: entry-secondary-icon-gicon.

  * secondary-icon-name. Type: string. Accessor: entry-secondary-icon-name.

  * secondary-icon-pixbuf. Type: pixbuf. Accessor: entry-secondary-icon-pixbuf.

  * secondary-icon-sensitive. Type: boolean. Accessor: entry-secondary-icon-sensitive.

  * secondary-icon-stock. Type: string. Accessor: entry-secondary-icon-stock.

  * secondary-icon-storage-type. Type: image-type. Accessor: entry-secondary-icon-storage-type. Read-only.

  * secondary-icon-tooltip-markup. Type: string. Accessor: entry-secondary-icon-tooltip-markup.

  * secondary-icon-tooltip-text. Type: string. Accessor: entry-secondary-icon-tooltip-text.

  * selection-bound. Type: integer. Accessor: entry-selection-bound. Read-only.

  * shadow-type. Type: shadow-type. Accessor: entry-shadow-type.

  * text. Type: string. Accessor: entry-text.

  * text-length. Type: integer. Accessor: entry-text-length. Read-only.

  * truncate-multiline. Type: boolean. Accessor: entry-truncate-multiline.

  * visibility. Type: boolean. Accessor: entry-visibility.

  * width-chars. Type: integer. Accessor: entry-width-chars.

  * xalign. Type: single-float. Accessor: entry-xalign.

Signals:

  * "activate". Signature: (instance entry) => void. Options: run-last, action.

  * "backspace". Signature: (instance entry) => void. Options: run-last, action.

  * "copy-clipboard". Signature: (instance entry) => void. Options: run-last, action.

  * "cut-clipboard". Signature: (instance entry) => void. Options: run-last, action.

  * "delete-from-cursor". Signature: (instance entry), (arg-1 delete-type), (arg-2 integer) => void. Options: run-last, action.

  * "icon-press". Signature: (instance entry), (arg-1 GtkEntryIconPosition), (arg-2 event) => void. Options: run-last.

  * "icon-release". Signature: (instance entry), (arg-1 GtkEntryIconPosition), (arg-2 event) => void. Options: run-last.

  * "insert-at-cursor". Signature: (instance entry), (arg-1 string) => void. Options: run-last, action.

  * "move-cursor". Signature: (instance entry), (arg-1 movement-step), (arg-2 integer), (arg-3 boolean) => void. Options: run-last, action.

  * "paste-clipboard". Signature: (instance entry) => void. Options: run-last, action.

  * "populate-popup". Signature: (instance entry), (arg-1 menu) => void. Options: run-last.

  * "toggle-overwrite". Signature: (instance entry) => void. Options: run-last, action.

event-box
=========

event-box
Superclass: bin atk-implementor-iface buildable

Slots:

  * above-child. Type: boolean. Accessor: event-box-above-child.

  * visible-window. Type: boolean. Accessor: event-box-visible-window.

Signals:

expander
========

expander
Superclass: bin atk-implementor-iface buildable

Slots:

  * expanded. Type: boolean. Accessor: expander-expanded.

  * label. Type: string. Accessor: expander-label.

  * label-widget. Type: widget. Accessor: expander-label-widget.

  * spacing. Type: integer. Accessor: expander-spacing.

  * use-markup. Type: boolean. Accessor: expander-use-markup.

  * use-underline. Type: boolean. Accessor: expander-use-underline.

Signals:

  * "activate". Signature: (instance expander) => void. Options: run-last, action.

file-chooser-button
===================

file-chooser-button
Superclass: h-box atk-implementor-iface buildable file-chooser orientable

Slots:

  * dialog. Type: file-chooser. Accessor: file-chooser-button-dialog. Write-only.

  * focus-on-click. Type: boolean. Accessor: file-chooser-button-focus-on-click.

  * title. Type: string. Accessor: file-chooser-button-title.

  * width-chars. Type: integer. Accessor: file-chooser-button-width-chars.

Signals:

  * "file-set". Signature: (instance file-chooser-button) => void. Options: run-first.

file-chooser-dialog
===================

file-chooser-dialog
Superclass: dialog atk-implementor-iface buildable file-chooser

Slots:

Signals:

file-chooser-widget
===================

file-chooser-widget
Superclass: v-box atk-implementor-iface buildable file-chooser file-chooser-embed orientable

Slots:

Signals:

fixed
=====

fixed
Superclass: container atk-implementor-iface buildable

Slots:

  * has-window. Type: boolean. Accessor: fixed-has-window.

Signals:

font-button
===========

font-button
Superclass: button atk-implementor-iface activatable buildable

Slots:

  * font-name. Type: string. Accessor: font-button-font-name.

  * show-size. Type: boolean. Accessor: font-button-show-size.

  * show-style. Type: boolean. Accessor: font-button-show-style.

  * title. Type: string. Accessor: font-button-title.

  * use-font. Type: boolean. Accessor: font-button-use-font.

  * use-size. Type: boolean. Accessor: font-button-use-size.

Signals:

  * "font-set". Signature: (instance font-button) => void. Options: run-first.

font-selection
==============

font-selection
Superclass: v-box atk-implementor-iface buildable orientable

Slots:

  * font. Type: font. Accessor: font-selection-font. Read-only.

  * font-name. Type: string. Accessor: font-selection-font-name.

  * preview-text. Type: string. Accessor: font-selection-preview-text.

Signals:

font-selection-dialog
=====================

font-selection-dialog
Superclass: dialog atk-implementor-iface buildable

Slots:

  * apply-button. Type: g-object. Accessor: font-selection-dialog-apply-button. Read-only.

  * cancel-button. Type: g-object. Accessor: font-selection-dialog-cancel-button. Read-only.

  * font-name. Type: string. Accessor: font-selection-dialog-font-name.

  * ok-button. Type: g-object. Accessor: font-selection-dialog-ok-button. Read-only.

  * preview-text. Type: string. Accessor: font-selection-dialog-preview-text.

Signals:

frame
=====

frame
Superclass: bin atk-implementor-iface buildable

Subclasses: aspect-frame

Slots:

  * label. Type: string. Accessor: frame-label.

  * label-widget. Type: widget. Accessor: frame-label-widget.

  * label-xalign. Type: single-float. Accessor: frame-label-xalign.

  * label-yalign. Type: single-float. Accessor: frame-label-yalign.

  * shadow. Type: shadow-type. Accessor: frame-shadow.

  * shadow-type. Type: shadow-type. Accessor: frame-shadow-type.

Signals:

gamma-curve
===========

gamma-curve
Superclass: v-box atk-implementor-iface buildable orientable

Slots:

Signals:

gtk-window
==========

gtk-window
Superclass: bin atk-implementor-iface buildable

Subclasses: plug assistant dialog

gtk-window is a toplevel window that can contain other widgets. Nearly always, the type of the window should be window-type,toplevel. If you're implementing something like a popup menu from scratch (which is a bad idea, just use menu), you might use window-type,popup. window-type,popup is not for dialogs, though in some other toolkits dialogs are called "popups". In GTK+, window-type,popup means a pop-up menu or pop-up tooltip. On X11, popup windows are not controlled by the window manager.

If you simply want an undecorated window (no window borders), use gtk-window,decorated, don't use window-type,popup.

Slots:

  * accept-focus. Type: boolean. Accessor: gtk-window-accept-focus.

     Windows may set a hint asking the desktop environment not to receive the input focus. True if the window should receive the input focus.

     Default value: True

  * allow-grow. Type: boolean. Accessor: gtk-window-allow-grow.

     If True, users can expand the window beyond its minimum size.

     Default value: True

  * allow-shrink. Type: boolean. Accessor: gtk-window-allow-shrink.

     If True, the window has no mimimum size. Setting this to True is 99% of the time a bad idea.

     Default value: False

  * decorated. Type: boolean. Accessor: gtk-window-decorated.

     Whether the window should be decorated by the window manager.

     By default, windows are decorated with a title bar, resize controls, etc. Some window managers allow GTK+ to disable these decorations, creating a borderless window. If you set the decorated property to False using this function, GTK+ will do its best to convince the window manager not to decorate the window. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling widget-show.

     On Windows, this always works, since there's no window manager policy involved.

     Default value: True

  * default-height. Type: integer. Accessor: gtk-window-default-height.

     The default height of the window, used when initially showing the window.

     If the window's "natural" size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the window (window-set-geometry-hints can be used to set these explicitly), the default size will be clamped to the nearest permitted size.

     Unlike widget,width-request and widget,height-request, that set a size request for a widget and thus would keep users from shrinking the window, this function only sets the initial size, just as if the user had resized the window themselves. Users can still shrink the window again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the window).

     For more control over a window's initial size and how resizing works, see window-set-geometry-hints.

     For some uses, window-resize is a more appropriate function. window-resize changes the current size of the window, rather than the size to be used on initial display. window-resize always affects the window itself, not the geometry widget.

     The default size of a window only affects the first time a window is shown; if a window is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.

     Windows can't actually be 0x0 in size, they must be at least 1x1, but passing 0 for width and height is OK, resulting in a 1x1 default size.

     Default value: -1

  * default-widget. Type: widget. Accessor: gtk-window-default-widget.

     The default widget is the widget that's activated when the user presses Enter in a dialog (for example). When setting (rather than unsetting) the default widget it's generally easier to call gtk_widget_grab_focus() on the widget. Before making a widget the default widget, you must set the widget,can-default on the widget you'd like to make the default.

  * default-width. Type: integer. Accessor: gtk-window-default-width.

     The default width of the window, used when initially showing the window.

     See gtk-window,default-height for explanation.

     Default value: -1

  * deletable. Type: boolean. Accessor: gtk-window-deletable.

     Whether the window frame should have a close button.

     By default, windows have a close button in the window frame. Some window managers allow GTK+ to disable this button. If you set the deletable property to False using this function, GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling widget-show.

     On Windows, this always works, since there's no window manager policy involved.

     Default value: True

  * destroy-with-parent. Type: boolean. Accessor: gtk-window-destroy-with-parent.

     If this window should be destroyed when the parent is destroyed.

     Default value: False

  * focus. Type: widget. Accessor: gtk-window-focus.

     The current focused widget within the window. Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then gtk-window,focus will not be True for the widget.

     Settings this works the following way. If focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. If focus is NIL, unsets the focus widget for this window. To set the focus to a particular widget in the toplevel, it is usually more convenient to use widget-grab-focus instead of this function.

  * focus-on-map. Type: boolean. Accessor: gtk-window-focus-on-map.

     Windows may set a hint asking the desktop environment not to receive the input focus when the window is mapped.  True if the window should receive the input focus when mapped.

     Default value: True

  * gravity. Type: gravity. Accessor: gtk-window-gravity.

     The window gravity of the window. See window-move and gravity for more details about window gravity.

     Default value: anchor-type,north-west

  * has-toplevel-focus. Type: boolean. Accessor: gtk-window-has-toplevel-focus. Read-only.

     Whether the input focus is within this GtkWindow.

     Default value: False

  * icon. Type: pixbuf. Accessor: gtk-window-icon.

     This icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts.

     The icon should be provided in whatever size it was naturally drawn; that is, don't scale the image before passing it to GTK+. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality.

     Icon for this window.

  * icon-name. Type: string. Accessor: gtk-window-icon-name.

     The icon-name property specifies the name of the themed icon to use as the window icon. See icon-theme for more details.

     Note that this has nothing to do with the WM_ICON_NAME property which is mentioned in the ICCCM.

     Default value: NIL

  * is-active. Type: boolean. Accessor: gtk-window-is-active. Read-only.

     Whether the toplevel is the current active window.

     Default value: False

  * modal. Type: boolean. Accessor: gtk-window-modal.

     If True, the window is modal (other windows are not usable while this one is up).

     Default value: False

  * opacity. Type: double-float. Accessor: gtk-window-opacity.

     The requested opacity of the window.

     Setting opacity requests the windowing system to make window partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Values of the opacity parameter are clamped to the [0,1] range.) On X11 this has any effect only on X screens with a compositing manager running. See screen,composited-p. On Windows it should work always.

     Note that setting a window's opacity after the window has been shown causes it to flicker once on Windows.

     Allowed values: [0,1]

     Default value: 1

  * resizable. Type: boolean. Accessor: gtk-window-resizable.

     If True, users can resize the window.

     Default value: True

  * role. Type: string. Accessor: gtk-window-role.

     Unique identifier for the window to be used when restoring a session.

     This is only useful on X11, not with other GTK+ targets.

     In combination with the window title, the window role allows a window manager to identify "the same" window when an application is restarted. So for example you might set the "toolbox" role on your app's toolbox window, so that when the user restarts their session, the window manager can put the toolbox back in the same place.

     If a window already has a unique title, you don't need to set the role, since the WM can use the title to identify the window when restoring the session.

     Default value: NIL

  * screen. Type: screen. Accessor: gtk-window-screen.

     The screen where this window will be displayed.

  * skip-pager-hint. Type: boolean. Accessor: gtk-window-skip-pager-hint.

     Windows may set a hint asking the desktop environment not to display the window in the pager. (A "pager" is any desktop navigation tool such as a workspace switcher that displays a thumbnail representation of the windows on the screen.) True if the window should not be in the pager.

     Default value: False

  * skip-taskbar-hint. Type: boolean. Accessor: gtk-window-skip-taskbar-hint.

     Windows may set a hint asking the desktop environment not to display the window in the task bar. True if the window should not be in the task bar.

     Default value: False

  * startup-id. Type: string. Accessor: gtk-window-startup-id. Write-only.

     The startup-id is a write-only property for setting window's startup notification identifier.

     Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other features. This function changes the corresponding property on the underlying gdk-window. Normally, startup identifier is managed automatically and you should only use this function in special cases like transferring focus from other processes. You should set this before calling window-present or any equivalent function generating a window map event.

     This is only useful on X11, not with other GTK+ targets.

     Default value: NIL

  * title. Type: string. Accessor: gtk-window-title.

     The title of the window.

     Default value: NIL

  * transient-for. Type: gtk-window. Accessor: gtk-window-transient-for.

     The transient parent of the window.

     Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window.

     On Windows, this puts the child window on top of the parent, much as the window manager would have done on X.

  * type. Type: window-type. Accessor: gtk-window-type.

     The type of the window.

     Default value: window-type,toplevel

  * type-hint. Type: gdk-window-type-hint. Accessor: gtk-window-type-hint.

     Hint to help the desktop environment understand what kind of window this is and how to treat it.

     This should be set before the window becomes visible.

     Default value: gdk-window-type-hint,normal

  * urgency-hint. Type: boolean. Accessor: gtk-window-urgency-hint.

     Windows may set a hint asking the desktop environment to draw the users attention to the window. True if the window should be brought to the user's attention.

     Default value: False

  * window-position. Type: window-position. Accessor: gtk-window-window-position.

     The initial position of the window.

     Default value: window-position,none

Signals:

  * "activate-default". Signature: (instance gtk-window) => void. Options: run-last, action.

     The activate-default signal is a keybinding signal which gets emitted when the user activates the default widget of window.

  * "activate-focus". Signature: (instance gtk-window) => void. Options: run-last, action.

     The activate-default signal is a keybinding signal which gets emitted when the user activates the currently focused widget of window.

  * "frame-event". Signature: (instance gtk-window), (event event) => boolean. Options: run-last.

  * "keys-changed". Signature: (instance gtk-window) => void. Options: run-first.

     The keys-changed signal gets emitted when the set of accelerators or mnemonics that are associated with window changes.

  * "set-focus". Signature: (instance gtk-window), (widget widget) => void. Options: run-last.

window-add-accel-group

     (window-add-accel-group window accel-group)

Associate ACCEL-GROUP (an accel-group) with WINDOW (an gtk-window).

window-remove-accel-group

     (window-remove-accel-group window accel-group)

Reverses the effect of window-add-accel-group.

window-activate-focus

     (window-activate-focus window)

Activates the current focused widget within the WINDOW (an gtk-window).

window-activate-default

     (window-activate-default window) => activated-p

Activates the default widget for the WINDOW (an gtk-window), unless the current focused widget has been configured to receive the default action (see widget,receives-default), in which case the focused widget is activated.

Returns True if a widget got activated.

window-set-geometry-hints

     (window-set-geometry-hints window geometry-widget geometry geometry-mask)

This function sets up hints about how a WINDOW (an gtk-window) can be resized by the user. You can set a minimum and maximum size; allowed resize increments (e.g. for xterm, you can only resize by the size of a character); aspect ratios; and more. See the geometry struct.

GEOMETRY-WIDGET: a widget - widget the geometry hints will be applied to

GEOMETRY: a geometry - struct containing geometry information

GEOMETRY-MASK: a window-hints - mask indicating which struct fields should be paid attention to

window-list-toplevels

     (window-list-toplevels) => windows

Returns a list of all existing toplevel windows. The widgets in the list are not individually referenced.

WINDOWS: fresh list of gtk-window

window-add-mnemonic

     (window-add-mnemonic window keyval target)

Adds a mnemonic to this WINDOW (a gtk-window).

KEYVAL: mnemonic keyval

TARGET: the widget that gets activated by the mnemonic

window-remove-mnemonic

     (window-remove-mnemonic window keyval target)

Removes a mnemonic from this WINDOW (a gtk-window).

KEYVAL: mnemonic keyval

TARGET: the widget that gets activated by the mnemonic

window-mnemonic-activate

     (window-mnemonic-activate window keyval modifier)

Activates the targets associated with the mnemonic.

KEYVAL: mnemonic keyval

MODIFIER: a modifier-type - modifiers

window-activate-key

     (window-activate-key window event) => activated-p

Activates mnemonics and accelerators for this gtk-window. This is normally called by the default widget,key-press-event handler for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.

Returns True if a mnemonic or accelerator was found and activated.

EVENT: a event-key

window-propagate-key-event

     (window-propagate-key-event window event) => handled-p

Propagate a key press or release event to the focus widget and up the focus container chain until a widget handles EVENT. This is normally called by the default widget,key-press-event and widget,key-release-event handlers for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.

Returns True if a widget in the focus chain handled the event.

EVENT: a event-key

window-present

     (window-present window)

Presents a WINDOW (a gtk-window) to the user. This may mean raising the window in the stacking order, deiconifying it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent on the user's platform, window manager, and preferences.

If window is hidden, this function calls widget-show as well.

This function should be used when the user tries to open a window that's already open. Say for example the preferences dialog is currently open, and the user chooses Preferences from the menu a second time; use window-present to move the already-open dialog where the user can see it.

If you are calling this function in response to a user interaction, it is preferable to use window-present-with-time.

window-present-with-time

     (window-present-with-time window timestamp)

Presents a WINDOW (a gtk-window) to the user in response to a user interaction. If you need to present a window without a timestamp, use window-present. See window-present for details.

TIMESTAMP: the timestamp of the user interaction (typically a button or key press event) which triggered this call

window-iconify

     (window-iconify window)

Asks to iconify (i.e. minimize) the specified WINDOW (a gtk-window). Note that you shouldn't assume the window is definitely iconified afterward, because other entities (e.g. the user or window manager) could deiconify it again, or there may not be a window manager in which case iconification isn't possible, etc. But normally the window will end up iconified. Just don't write code that crashes if not.

It's permitted to call this function before showing a window, in which case the window will be iconified before it ever appears onscreen.

You can track iconification via the widget,window-state-event signal on GtkWidget.

window-deiconify

     (window-deiconify window)

Asks to deiconify (i.e. unminimize) the specified window. Note that you shouldn't assume the window is definitely deiconified afterward, because other entities (e.g. the user or window manager) could iconify it again before your code which assumes deiconification gets to run.

You can track iconification via the widget,window-state-event.

window-stick

     (window-stick window)

Asks to stick WINDOW (a gtk-window), which means that it will appear on all user desktops. Note that you shouldn't assume the window is definitely stuck afterward, because other entities (e.g. the user or window manager) could unstick it again, and some window managers do not support sticking windows. But normally the window will end up stuck. Just don't write code that crashes if not.

It's permitted to call this function before showing a window.

You can track stickiness via the widget,window-state-event signal.

window-unstick

     (window-unstick window)

Asks to unstick WINDOW (a gtk-window), which means that it will appear on only one of the user's desktops. Note that you shouldn't assume the window is definitely unstuck afterward, because other entities (e.g. the user or window manager) could stick it again. But normally the window will end up stuck. Just don't write code that crashes if not.

You can track stickiness via the widget,window-state-event signal.

window-maximize

     (window-maximize window)

Asks to maximize WINDOW (a gtk-window), so that it becomes full-screen. Note that you shouldn't assume the window is definitely maximized afterward, because other entities (e.g. the user or window manager) could unmaximize it again, and not all window managers support maximization. But normally the window will end up maximized. Just don't write code that crashes if not.

It's permitted to call this function before showing a window, in which case the window will be maximized when it appears onscreen initially.

You can track maximization via the widget,window-state-event signal.

window-unmaximize

     (window-unmaximize window)

Asks to unmaximize WINDOW (a gtk-window). Note that you shouldn't assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager) could maximize it again, and not all window managers honor requests to unmaximize. But normally the window will end up unmaximized. Just don't write code that crashes if not.

You can track maximization via the widget,window-state-event signal on GtkWidget.

window-fullscreen

     (window-fullscreen window)

Asks to place WINDOW (a gtk-window) in the fullscreen state. Note that you shouldn't assume the window is definitely full screen afterward, because other entities (e.g. the user or window manager) could unfullscreen it again, and not all window managers honor requests to fullscreen windows. But normally the window will end up fullscreen. Just don't write code that crashes if not.

You can track the fullscreen state via the widget,window-state-event signal.

window-unfullscreen

     (window-unfullscreen window)

Asks to toggle off the fullscreen state for WINDOW (a gtk-window). Note that you shouldn't assume the window is definitely not full screen afterward, because other entities (e.g. the user or window manager) could fullscreen it again, and not all window managers honor requests to unfullscreen windows. But normally the window will end up restored to its normal state. Just don't write code that crashes if not.

You can track the fullscreen state via the widget,window-state-event signal.

window-set-keep-above

     (window-set-keep-above window setting)

Asks to keep WINDOW (a gtk-window) above, so that it stays on top. Note that you shouldn't assume the window is definitely above afterward, because other entities (e.g. the user or window manager) could not keep it above, and not all window managers support keeping windows above. But normally the window will end kept above. Just don't write code that crashes if not.

It's permitted to call this function before showing a window, in which case the window will be kept above when it appears onscreen initially.

You can track the above state via the widget,window-state-event signal.

Note that, according to the Extended Window Manager Hints specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.

SETTING: a boolean; whether to keep WINDOW above other windows

window-set-keep-below

     (window-set-keep-below window setting)

Asks to keep window below, so that it stays in bottom. Note that you shouldn't assume the window is definitely below afterward, because other entities (e.g. the user or window manager) could not keep it below, and not all window managers support putting windows below. But normally the window will be kept below. Just don't write code that crashes if not.

It's permitted to call this function before showing a window, in which case the window will be kept below when it appears onscreen initially.

You can track the below state via the "window-state-event" signal on GtkWidget.

Note that, according to the Extended Window Manager Hints specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.

SETTING: a boolean; whether to keep window below other windows

window-begin-resize-drag

     (window-begin-resize-drag window edge button root-x root-y timestamp)

Starts resizing a WINDOW (a gtk-window). This function is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window resizing, potentially not all that well, depending on the windowing system.

EDGE: a window-edge; position of the resize control

BUTTON: an integer; mouse button that initiated the drag

ROOT-X: an integer; X position where the user clicked to initiate the drag, in root window coordinates

ROOT-Y: an integer; Y position where the user clicked to initiate the drag

TIMESTAMP: timestamp from the click event that initiated the drag

window-begin-move-drag

     (window-begin-move-drag window button root-x root-y timestamp)

Starts moving a window. This function is used if an application has window movement grips. When GDK can support it, the window movement will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window movement, potentially not all that well, depending on the windowing system.

EDGE: a window-edge; position of the resize control

BUTTON: an integer; mouse button that initiated the drag

ROOT-X: an integer; X position where the user clicked to initiate the drag, in root window coordinates

ROOT-Y: an integer; Y position where the user clicked to initiate the drag

TIMESTAMP: timestamp from the click event that initiated the drag

window-set-frame-dimensions

     (window-set-frame-dimensions window left top right bottom)

(Note: this is a special-purpose function intended for the framebuffer port; see window-set-has-frame. It will have no effect on the window border drawn by the window manager, which is the normal case when using the X Window system.)

For windows with frames this function can be used to change the size of the frame border.

WINDOW: a gtk-window

LEFT, TOP, RIGHT, BOTTOM - integers; sizes of left, top, right, bottom borders

window-set-has-frame

     (window-set-has-frame window setting)

(Note: this is a special-purpose function for the framebuffer port, that causes GTK+ to draw its own window border. For most applications, you want gtk-window,decorated instead, which tells the window manager whether to draw the window border.)

If this function is called on a WINDOW (a gtk-window) with setting of True, before it is realized or showed, it will have a "frame" window around window->window, accessible in window->frame. Using the signal gtk-window,frame-event you can receive all events targeted at the frame.

This function is used by the linux-fb port to implement managed windows, but it could conceivably be used by X-programs that want to do their own window decorations.

SETTING: a boolean

window-set-mnemonic-modifier

     (window-set-mnemonic-modifier window modifier)

Sets the mnemonic MODIFIER (a modifier-type) for this WINDOW (a gtk-window).

window-default-icon-list

     (setf (window-default-icon-list) icons)

Sets an icon list to be used as fallback for windows that haven't had gtk_window_set_icon_list set on them to set up a window-specific icon list. This function allows you to set up the icon for all windows in your app at once.

ICONS: a list of pixbufs.

window-default-icon

     (setf (window-default-icon) icon)

Sets an ICON (a pixbuf) to be used as fallback for windows that haven't had gtk-window,icon set on them from a pixbuf.

window-default-icon-name

     (setf (window-default-icon-name) name)

Sets an icon (a string - the name of the themed icon) to be used as fallback for windows.

window-move

     (window-move window x y)

Asks the window manager to move WINDOW (a gtk-window) to the given position (defined by integers X, Y). Window managers are free to ignore this; most window managers ignore requests for initial window positions (instead using a user-defined placement algorithm) and honor requests after the window has already been shown.

Note: the position is the position of the gravity-determined reference point for the window. The gravity determines two things: first, the location of the reference point in root window coordinates; and second, which point on the window is positioned at the reference point.

By default the gravity is gravity,north-west, so the reference point is simply the x, y supplied. The top-left corner of the window decorations (aka window frame or border) will be placed at x, y. Therefore, to position a window at the top left of the screen, you want to use the default gravity (which is gravity,north-west) and move the window to 0,0.

To position a window at the bottom right corner of the screen, you would set gravity,south-east, which means that the reference point is at x + the window width and y + the window height, and the bottom-right corner of the window border will be placed at that reference point. So, to place a window in the bottom right corner you would first set gravity to south east, then write: gtk_window_move (window, gdk_screen_width() - window_width, gdk_screen_height() - window_height) (note that this example does not take multi-head scenarios into account).

The Extended Window Manager Hints specification at http://www.freedesktop.org/Standards/wm-spec has a nice table of gravities in the "implementation notes" section.

window-resize

     (window-resize window width height)

Resizes the WINDOW (a gtk-window) to WIDTH pixels by HEIGHT pixels as if the user had done so, obeying geometry constraints. The default geometry constraint is that windows may not be smaller than their size request (see widget,width-request, widget,height-request).

If window-resize is called before showing a window for the first time, it overrides any default size set with gtk-window,default-width, gtk-window,default-height.

Windows may not be resized smaller than 1 by 1 pixels.

h-box
=====

h-box
Superclass: box atk-implementor-iface buildable orientable

Subclasses: statusbar file-chooser-button

Slots:

Signals:

h-button-box
============

h-button-box
Superclass: button-box atk-implementor-iface buildable orientable

Slots:

Signals:

h-paned
=======

h-paned
Superclass: paned atk-implementor-iface buildable orientable

Slots:

Signals:

h-ruler
=======

h-ruler
Superclass: ruler atk-implementor-iface buildable orientable

Slots:

Signals:

h-s-v
=====

h-s-v
Superclass: widget atk-implementor-iface buildable

Slots:

Signals:

  * "changed". Signature: (instance h-s-v) => void. Options: run-first.

  * "move". Signature: (instance h-s-v), (arg-1 direction-type) => void. Options: run-last, action.

h-scale
=======

h-scale
Superclass: scale atk-implementor-iface buildable orientable

Slots:

Signals:

h-scrollbar
===========

h-scrollbar
Superclass: scrollbar atk-implementor-iface buildable orientable

Slots:

Signals:

h-separator
===========

h-separator
Superclass: separator atk-implementor-iface buildable orientable

Slots:

Signals:

handle-box
==========

handle-box
Superclass: bin atk-implementor-iface buildable

Slots:

  * child-detached. Type: boolean. Accessor: handle-box-child-detached. Read-only.

  * handle-position. Type: position-type. Accessor: handle-box-handle-position.

  * shadow. Type: shadow-type. Accessor: handle-box-shadow.

  * shadow-type. Type: shadow-type. Accessor: handle-box-shadow-type.

  * snap-edge. Type: position-type. Accessor: handle-box-snap-edge.

  * snap-edge-set. Type: boolean. Accessor: handle-box-snap-edge-set.

Signals:

  * "child-attached". Signature: (instance handle-box), (arg-1 widget) => void. Options: run-first.

  * "child-detached". Signature: (instance handle-box), (arg-1 widget) => void. Options: run-first.

icon-view
=========

icon-view
Superclass: container atk-implementor-iface buildable cell-layout

Slots:

  * column-spacing. Type: integer. Accessor: icon-view-column-spacing.

  * columns. Type: integer. Accessor: icon-view-columns.

  * item-width. Type: integer. Accessor: icon-view-item-width.

  * margin. Type: integer. Accessor: icon-view-margin.

  * markup-column. Type: integer. Accessor: icon-view-markup-column.

  * model. Type: tree-model. Accessor: icon-view-model.

  * orientation. Type: orientation. Accessor: icon-view-orientation.

  * pixbuf-column. Type: integer. Accessor: icon-view-pixbuf-column.

  * reorderable. Type: boolean. Accessor: icon-view-reorderable.

  * row-spacing. Type: integer. Accessor: icon-view-row-spacing.

  * selection-mode. Type: selection-mode. Accessor: icon-view-selection-mode.

  * spacing. Type: integer. Accessor: icon-view-spacing.

  * text-column. Type: integer. Accessor: icon-view-text-column.

  * tooltip-column. Type: integer. Accessor: icon-view-tooltip-column.

Signals:

  * "activate-cursor-item". Signature: (instance icon-view) => boolean. Options: run-last, action.

  * "item-activated". Signature: (instance icon-view), (arg-1 tree-path) => void. Options: run-last.

  * "move-cursor". Signature: (instance icon-view), (arg-1 movement-step), (arg-2 integer) => boolean. Options: run-last, action.

  * "select-all". Signature: (instance icon-view) => void. Options: run-last, action.

  * "select-cursor-item". Signature: (instance icon-view) => void. Options: run-last, action.

  * "selection-changed". Signature: (instance icon-view) => void. Options: run-first.

  * "set-scroll-adjustments". Signature: (instance icon-view), (arg-1 adjustment), (arg-2 adjustment) => void. Options: run-last.

  * "toggle-cursor-item". Signature: (instance icon-view) => void. Options: run-last, action.

  * "unselect-all". Signature: (instance icon-view) => void. Options: run-last, action.

image
=====

image
Superclass: misc atk-implementor-iface buildable

The image widget displays an image. Various kinds of object can be displayed as an image; most typically, you would load a pixbuf ("pixel buffer") from a file, and then display that. There's an image,file slot (with :file initarg) that is used to load pixbuf from file:

     (make-instance 'image :file "myfile.png")

If the file isn't loaded successfully, the image will contain a "broken image" icon similar to that used in many web browsers. If you want to handle errors in loading the file yourself, for example by displaying an error message, then load the image and set the image,pixbuf.

The image file may contain an animation, if so the image will display an animation (pixbuf-animation) instead of a static image.

image is a subclass of misc, which implies that you can align it (center, left, right) and add padding to it, using misc slot.

image is a "no window" widget (has no gdk-window of its own), so by default does not receive events. If you want to receive events on the image, such as button clicks, place the image inside a event-box, then connect to the event signals on the event box.

When handling events on the event box, keep in mind that coordinates in the image may be different from event box coordinates due to the alignment and padding settings on the image (see misc). The simplest way to solve this is to set the alignment to 0.0 (left/top), and set the padding to zero. Then the origin of the image will be the same as the origin of the event box.

Slots:

  * file. Type: string. Accessor: image-file.

     Filename to load and display.

     Default value: NIL

  * gicon. Type: GIcon. Accessor: image-gicon.

     The GIcon displayed in the GtkImage. For themed icons, If the icon theme is changed, the image will be updated automatically.

     TODO: GIcon is part of GIO library that is not yet supported by cl-gtk2

  * icon-name. Type: string. Accessor: image-icon-name.

     The name of the icon in the icon theme. If the icon theme is changed, the image will be updated automatically.

     Default value: NIL

  * icon-set. Type: GtkIconSet. Accessor: image-icon-set.

     Icon set to display.

  * icon-size. Type: integer. Accessor: image-icon-size.

     Symbolic size to use for stock icon, icon set or named icon.

     Allowed values: >= 0

     Default value: 4

  * image. Type: gdk-image. Accessor: image-image.

     A GdkImage to display.

  * mask. Type: pixmap. Accessor: image-mask.

     Mask bitmap to use with gdk-image or pixmap.

  * pixbuf. Type: pixbuf. Accessor: image-pixbuf.

     A pixbuf to display.

  * pixbuf-animation. Type: pixbuf-animation. Accessor: image-pixbuf-animation.

     pixbuf-animation to display.

  * pixel-size. Type: integer. Accessor: image-pixel-size.

     This property can be used to specify a fixed size overriding the image,icon-size property for images of type image-type,icon-name.

     Default value: -1

  * pixmap. Type: pixmap. Accessor: image-pixmap.

     A pixmap to display.

  * stock. Type: string. Accessor: image-stock.

     Stock ID for a stock image to display.

     Default value: NIL

  * storage-type. Type: image-type. Accessor: image-storage-type. Read-only.

     The representation being used for image data.

     Default value: image-type,empty

Signals:

image-menu-item
===============

image-menu-item
Superclass: menu-item atk-implementor-iface activatable buildable

Slots:

  * accel-group. Type: accel-group. Accessor: image-menu-item-accel-group. Write-only.

  * always-show-image. Type: boolean. Accessor: image-menu-item-always-show-image.

  * image. Type: widget. Accessor: image-menu-item-image.

  * use-stock. Type: boolean. Accessor: image-menu-item-use-stock.

Signals:

input-dialog
============

input-dialog
Superclass: dialog atk-implementor-iface buildable

Slots:

Signals:

  * "disable-device". Signature: (instance input-dialog), (arg-1 GdkDevice) => void. Options: run-last.

  * "enable-device". Signature: (instance input-dialog), (arg-1 GdkDevice) => void. Options: run-last.

invisible
=========

invisible
Superclass: widget atk-implementor-iface buildable

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

It is used for reliable pointer grabs and selection handling in the code for drag-and-drop.

Slots:

  * screen. Type: screen. Accessor: invisible-screen.

     The screen where this window will be displayed.

Signals:

item
====

item
Superclass: bin atk-implementor-iface buildable

Subclasses: tree-item menu-item

Slots:

Signals:

  * "deselect". Signature: (instance item) => void. Options: run-first.

  * "select". Signature: (instance item) => void. Options: run-first.

  * "toggle". Signature: (instance item) => void. Options: run-first.

label
=====

label
Superclass: misc atk-implementor-iface buildable

Subclasses: accel-label

The label widget displays a small amount of text. As the name implies, most labels are used to label another widget such as a button, or a menu-item.

Mnemonics
*********

Labels may contain mnemonics. Mnemonics are underlined characters in the label, used for keyboard navigation. Mnemonics are created by providing a string with an underscore before the mnemonic character, such as "_File", to label,label and setting label,use-underline to True.

Mnemonics automatically activate any activatable widget the label is inside, such as a button; if the label is not inside the mnemonic's target widget, you have to tell the label about the target by settings label,mnemonic-widget. Here's a simple example where the label is inside a button:

Markup (styled text)
********************

To make it easy to format text in a label (changing colors, fonts, etc.), label text can be provided in a simple markup format. Set label,use-markup to True if label,label contains markup. Here's how to create a label with a small font:

     (make-instance 'label :label "<small>Small text</small>" :use-markup t)

(See complete documentation of available tags in the Pango manual.)

The markup passed to label,label must be valid; for example, literal </>/& characters must be escaped as &lt;, &gt;, and &amp;. If you pass text obtained from the user, file, or a network, you'll want to escape it with g_markup_escape_text() or g_markup_printf_escaped(). (TODO: these functions are not supported yet in cl-gtk2)

Markup strings are just a convenient way to set the PangoAttrList on a label; label,attributes may be a simpler way to set attributes in some cases. Be careful though; PangoAttrList tends to cause internationalization problems, unless you're applying attributes to the entire string (i.e. unless you set the range of each attribute to [0, G_MAXINT)). The reason is that specifying the start_index and end_index for a PangoAttribute requires knowledge of the exact string being displayed, so translations will cause problems.

Selectable labels
*****************

Labels can be made selectable with label,selectable. Selectable labels allow the user to copy the label contents to the clipboard. Only labels that contain useful-to-copy information - such as error messages - should be made selectable.

Text layout
***********

A label can contain any number of paragraphs, but will have performance problems if it contains more than a small number. Paragraphs are separated by newlines or other paragraph separators understood by Pango.

Labels can automatically wrap text if you call label,line-wrap.

label,justify sets how the lines in a label align with one another. If you want to set how the label as a whole aligns in its available space, see misc,xalign and misc,yalign.

Slots:

  * angle. Type: double-float. Accessor: label-angle.

     The angle that the baseline of the label makes with the horizontal, in degrees, measured counterclockwise. An angle of 90 reads from from bottom to top, an angle of 270, from top to bottom. Ignored if the label is selectable, wrapped, or ellipsized.

     Allowed values: [0,360]

     Default value: 0

  * attributes. Type: PangoAttrList. Accessor: label-attributes.

     A list of style attributes to apply to the text of the label

  * cursor-position. Type: integer. Accessor: label-cursor-position. Read-only.

     The current position of the insertion cursor in chars.

     Allowed values: >= 0

     Default value: 0

  * ellipsize. Type: pango-ellipsize-mode. Accessor: label-ellipsize.

     The preferred place to ellipsize the string, if the label does not have enough room to display the entire string.

     Note that setting this property to a value other than pango-ellipsize-mode,none has the side-effect that the label requests only enough space to display the ellipsis "...". In particular, this means that ellipsizing labels do not work well in notebook tabs, unless the tab's "tab-expand" property is set to True. Other ways to set a label's width are widget,width-request and label,width-chars.

     Default value: pango-ellipsize-mode,none

  * justify. Type: justification. Accessor: label-justify.

     The alignment of the lines in the text of the label relative to each other. This does NOT affect the alignment of the label within its allocation. See misc,xalign for that.

     Default value: justification,left

  * label. Type: string. Accessor: label-label.

     The text of the label.

     Default value: ""

  * layout. Type: g-object. Accessor: label-layout. Read-only.

     Gets the PangoLayout used to display the label. The layout is useful to e.g. convert text positions to pixel positions, in combination with label,layout-offsets.

  * layout-offsets. Type: list of integer. Accessor: label-layout-offsets. Read-only.

     The coordinates where the label will draw the PangoLayout representing the text in the label; useful to convert mouse events into coordinates inside the PangoLayout, e.g. to take some action if some part of the label is clicked. Of course you will need to create a event-box to receive the events, and pack the label inside it, since labels are a no-window widgets. Remember when using the PangoLayout functions you need to convert to and from pixels using PANGO_PIXELS or PANGO_SCALE.

  * line-wrap. Type: boolean. Accessor: label-line-wrap.

     Whether lines in the label are automatically wrapped. True makes label break lines if text exceeds the widget's size. False lets the text get cut off by the edge of the widget if it exceeds the widget size.

     Note that setting line wrapping to True does not make the label wrap at its parent container's width, because GTK+ widgets conceptually can't make their requisition depend on the parent container's size. For a label that wraps at a specific position, set the label's width using widget,width-request.

  * line-wrap-mode. Type: pango-wrap-mode. Accessor: label-line-wrap-mode.

     If line wrapping is on (see label,line-wrap) this controls how the line wrapping is done. The default is pango-wrap-mode,word which means wrap on word boundaries.

  * max-width-chars. Type: integer. Accessor: label-max-width-chars.

     The desired maximum width of the label, in characters. If this property is set to -1, the width will be calculated automatically, otherwise the label will request space for no more than the requested number of characters. If the label,width-chars property is set to a positive value, then the label,max-width-chars property is ignored.

     Default value: -1

  * mnemonic-keyval. Type: integer. Accessor: label-mnemonic-keyval. Read-only.

     The mnemonic accelerator key for this label.

     Default value: 16777215

  * mnemonic-widget. Type: widget. Accessor: label-mnemonic-widget.

     The widget to be activated when the label's mnemonic key is pressed.

  * pattern. Type: string. Accessor: label-pattern. Write-only.

     A string with _ characters in positions correspond to characters in the text to underline.

     Default value: NIL

  * selectable. Type: boolean. Accessor: label-selectable.

     Whether the label text can be selected with the mouse.

     Default value: False

  * selection-bound. Type: integer. Accessor: label-selection-bound. Read-only.

     The position of the opposite end of the selection from the cursor in chars.

     Allowed values: >= 0

     Default value: 0

  * selection-bounds. Type: (list integer integer). Accessor: label-selection-bounds. Read-only.

     Gets the selected range of characters in the label. Returns either NIL if there is no selection or list of two integers specifying character offsets of start and end of a selection

  * single-line-mode. Type: boolean. Accessor: label-single-line-mode.

     Whether the label is in single line mode. In single line mode, the height of the label does not depend on the actual text, it is always set to ascent + descent of the font. This can be an advantage in situations where resizing the label because of text changes would be distracting, e.g. in a statusbar.

     Default value: False

  * use-markup. Type: boolean. Accessor: label-use-markup.

     The text of the label includes XML markup.

     Default value: False

  * use-underline. Type: boolean. Accessor: label-use-underline.

     If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.

     Default value: False

  * width-chars. Type: integer. Accessor: label-width-chars.

     he desired width of the label, in characters. If this property is set to -1, the width will be calculated automatically, otherwise the label will request either 3 characters or the property value, whichever is greater. If the label,width-chars property is set to a positive value, then the label,max-width-chars property is ignored.

     Default value: -1

  * wrap. Type: boolean. Accessor: label-wrap.

     If set, wrap lines if the text becomes too wide.

     Default value: False

  * wrap-mode. Type: pango-wrap-mode. Accessor: label-wrap-mode.

     If line wrapping is on (see the label,wrap property) this controls how the line wrapping is done. The default is pango-wrap-mode,word, which means wrap on word boundaries.

Signals:

  * "copy-clipboard". Signature: (instance label) => void. Options: run-last, action.

     This signal is a keybinding signal which gets emitted to copy the selection to the clipboard.

     The default binding for this signal is Ctrl-c.

  * "move-cursor". Signature: (instance label), (step movement-step), (count integer), (extend-selection boolean) => void. Options: run-last, action.

     This signal is a keybinding signal which gets emitted when the user initiates a cursor movement. If the cursor is not visible in entry, this signal causes the viewport to be moved instead.

     Applications should not connect to it, but may emit it with emit-signal if they need to control the cursor programmatically.

     The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifer does not. There are too many key combinations to list them all here.

       * Arrow keys move by individual characters/lines

       * Ctrl-arrow key combinations move by words/paragraphs

       * Home/End keys move to the ends of the buffer

     STEP: the granularity of the move, as a GtkMovementStep

     COUNT: the number of step units to move

     EXTEND-SELECTION: True if the move should extend the selection

  * "populate-popup". Signature: (instance label), (menu menu) => void. Options: run-last.

     This signal gets emitted before showing the context menu of the label. Note that only selectable labels have context menus.

     If you need to add items to the context menu, connect to this signal and append your menuitems to the menu.

layout
======

layout
Superclass: container atk-implementor-iface buildable

Slots:

  * bin-window. Type: g-object. Accessor: layout-bin-window. Read-only.

  * hadjustment. Type: adjustment. Accessor: layout-hadjustment.

  * height. Type: integer. Accessor: layout-height.

  * vadjustment. Type: adjustment. Accessor: layout-vadjustment.

  * width. Type: integer. Accessor: layout-width.

Signals:

  * "set-scroll-adjustments". Signature: (instance layout), (arg-1 adjustment), (arg-2 adjustment) => void. Options: run-last, action.

link-button
===========

link-button
Superclass: button atk-implementor-iface activatable buildable

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

link-button offers a global hook, which is called when the used clicks on it: see link-button-global-uri-hook.

Slots:

  * uri. Type: string. Accessor: link-button-uri.

     The URI bound to this button.

     Default value: NIL

  * visited. Type: boolean. Accessor: link-button-visited.

     The 'visited' state of this button. A visited link is drawn in a different color.

     Default value: False

Signals:

link-button-global-uri-hook

     (setf (link-button-gloval-uri-hook) function)

Sets function as the function that should be invoked every time a user clicks a link-button. This function is called before every callback registered for the button,clicked signal.

If FUNCTION is NIL, GTK+ defaults to calling gtk_show_uri() (default function that opens the default application for a URI).

FUNCTION is a function of two arguments: a link-button and a string. First argument is the button that was clicked and the second is the URI of the button.

menu
====

menu
Superclass: menu-shell atk-implementor-iface buildable

Subclasses: recent-chooser-menu

Slots:

  * accel-group. Type: accel-group. Accessor: menu-accel-group.

  * accel-path. Type: string. Accessor: menu-accel-path.

  * active. Type: integer. Accessor: menu-active.

  * attach-widget. Type: widget. Accessor: menu-attach-widget.

  * monitor. Type: integer. Accessor: menu-monitor.

  * screen. Type: g-object. Accessor: menu-screen. Write-only.

  * tearoff-state. Type: boolean. Accessor: menu-tearoff-state.

  * tearoff-title. Type: string. Accessor: menu-tearoff-title.

Signals:

  * "move-scroll". Signature: (instance menu), (arg-1 scroll-type) => void. Options: run-last, action.

menu-bar
========

menu-bar
Superclass: menu-shell atk-implementor-iface buildable

Slots:

  * child-pack-direction. Type: pack-direction. Accessor: menu-bar-child-pack-direction.

  * pack-direction. Type: pack-direction. Accessor: menu-bar-pack-direction.

Signals:

menu-item
=========

menu-item
Superclass: item atk-implementor-iface activatable buildable

Subclasses: tearoff-menu-item separator-menu-item image-menu-item check-menu-item

Slots:

  * accel-path. Type: string. Accessor: menu-item-accel-path.

  * label. Type: string. Accessor: menu-item-label.

  * right-justified. Type: boolean. Accessor: menu-item-right-justified.

  * submenu. Type: menu. Accessor: menu-item-submenu.

  * use-underline. Type: boolean. Accessor: menu-item-use-underline.

Signals:

  * "activate". Signature: (instance menu-item) => void. Options: run-first, action.

  * "activate-item". Signature: (instance menu-item) => void. Options: run-first.

  * "toggle-size-allocate". Signature: (instance menu-item), (arg-1 integer) => void. Options: run-first.

  * "toggle-size-request". Signature: (instance menu-item), (arg-1 gpointer) => void. Options: run-first.

menu-shell
==========

menu-shell
Superclass: container atk-implementor-iface buildable

Subclasses: menu-bar menu

Slots:

  * take-focus. Type: boolean. Accessor: menu-shell-take-focus.

Signals:

  * "activate-current". Signature: (instance menu-shell), (arg-1 boolean) => void. Options: run-last, action.

  * "cancel". Signature: (instance menu-shell) => void. Options: run-last, action.

  * "cycle-focus". Signature: (instance menu-shell), (arg-1 direction-type) => void. Options: run-last, action.

  * "deactivate". Signature: (instance menu-shell) => void. Options: run-first.

  * "move-current". Signature: (instance menu-shell), (arg-1 menu-direction-type) => void. Options: run-last, action.

  * "move-selected". Signature: (instance menu-shell), (arg-1 integer) => boolean. Options: run-last.

  * "selection-done". Signature: (instance menu-shell) => void. Options: run-first.

menu-tool-button
================

menu-tool-button
Superclass: tool-button atk-implementor-iface activatable buildable

Slots:

  * arrow-tooltip-markup. Type: string. Accessor: menu-tool-button-arrow-tooltip-markup. Write-only.

  * arrow-tooltip-text. Type: string. Accessor: menu-tool-button-arrow-tooltip-text. Write-only.

  * menu. Type: menu. Accessor: menu-tool-button-menu.

Signals:

  * "show-menu". Signature: (instance menu-tool-button) => void. Options: run-first.

message-dialog
==============

message-dialog
Superclass: dialog atk-implementor-iface buildable

message-dialog presents a dialog with an image representing the type of message (Error, Question, etc.) alongside some message text. It's simply a convenience widget; you could construct the equivalent of message-dialog from dialog without too much effort, but message-dialog saves typing.

The easiest way to do a modal message dialog is to use gtk_dialog_run(), though you can also pass in the dialog-flags,modal flag, dialog-run automatically makes the dialog modal and waits for the user to respond to it. dialog-run returns when any dialog button is clicked.

Slots:

  * buttons. Type: buttons-type. Accessor: message-dialog-buttons. Write-only.

     The buttons shown in the message dialog.

     Default value: buttons-type,none

  * image. Type: widget. Accessor: message-dialog-image.

     The image for this dialog

  * message-type. Type: message-type. Accessor: message-dialog-message-type.

     The type of the message. The type is used to determine the image that is shown in the dialog, unless the image is explicitly set by the message-dialog,image property.

     Default value: message-type,info

  * secondary-text. Type: string. Accessor: message-dialog-secondary-text.

     The secondary text of the message dialog.

     Default value: NIL

  * secondary-use-markup. Type: boolean. Accessor: message-dialog-secondary-use-markup.

     True if the secondary text of the dialog includes Pango markup. See pango_parse_markup().

     Default value: False

  * text. Type: string. Accessor: message-dialog-text.

     The primary text of the message dialog. If the dialog has a secondary text, this will appear as the title.

     Default value: ""

  * use-markup. Type: boolean. Accessor: message-dialog-use-markup.

     True if the primary text of the dialog includes Pango markup. See pango_parse_markup().

     Default value: False

Signals:

misc
====

misc
Superclass: widget atk-implementor-iface buildable

Subclasses: image arrow label

Slots:

  * xalign. Type: single-float. Accessor: misc-xalign.

  * xpad. Type: integer. Accessor: misc-xpad.

  * yalign. Type: single-float. Accessor: misc-yalign.

  * ypad. Type: integer. Accessor: misc-ypad.

Signals:

notebook
========

notebook
Superclass: container atk-implementor-iface buildable

Slots:

  * enable-popup. Type: boolean. Accessor: notebook-enable-popup.

  * group. Type: gpointer. Accessor: notebook-group.

  * group-id. Type: integer. Accessor: notebook-group-id.

  * homogeneous. Type: boolean. Accessor: notebook-homogeneous.

  * page. Type: integer. Accessor: notebook-page.

  * scrollable. Type: boolean. Accessor: notebook-scrollable.

  * show-border. Type: boolean. Accessor: notebook-show-border.

  * show-tabs. Type: boolean. Accessor: notebook-show-tabs.

  * tab-border. Type: integer. Accessor: notebook-tab-border. Write-only.

  * tab-hborder. Type: integer. Accessor: notebook-tab-hborder.

  * tab-pos. Type: position-type. Accessor: notebook-tab-pos.

  * tab-vborder. Type: integer. Accessor: notebook-tab-vborder.

Signals:

  * "change-current-page". Signature: (instance notebook), (arg-1 integer) => boolean. Options: run-last, action.

  * "create-window". Signature: (instance notebook), (arg-1 widget), (arg-2 integer), (arg-3 integer) => notebook. Options: run-last.

  * "focus-tab". Signature: (instance notebook), (arg-1 notebook-tab) => boolean. Options: run-last, action.

  * "move-focus-out". Signature: (instance notebook), (arg-1 direction-type) => void. Options: run-last, action.

  * "page-added". Signature: (instance notebook), (arg-1 widget), (arg-2 integer) => void. Options: run-last.

  * "page-removed". Signature: (instance notebook), (arg-1 widget), (arg-2 integer) => void. Options: run-last.

  * "page-reordered". Signature: (instance notebook), (arg-1 widget), (arg-2 integer) => void. Options: run-last.

  * "reorder-tab". Signature: (instance notebook), (arg-1 direction-type), (arg-2 boolean) => boolean. Options: run-last, action.

  * "select-page". Signature: (instance notebook), (arg-1 boolean) => boolean. Options: run-last, action.

  * "switch-page". Signature: (instance notebook), (arg-1 gpointer), (arg-2 integer) => void. Options: run-last.

old-editable
============

old-editable
Superclass: widget atk-implementor-iface buildable editable

Subclasses: text

Slots:

  * editable. Type: boolean. Accessor: old-editable-editable.

  * text-position. Type: integer. Accessor: old-editable-text-position.

Signals:

  * "activate". Signature: (instance old-editable) => void. Options: run-last, action.

  * "copy-clipboard". Signature: (instance old-editable) => void. Options: run-last, action.

  * "cut-clipboard". Signature: (instance old-editable) => void. Options: run-last, action.

  * "kill-char". Signature: (instance old-editable), (arg-1 integer) => void. Options: run-last, action.

  * "kill-line". Signature: (instance old-editable), (arg-1 integer) => void. Options: run-last, action.

  * "kill-word". Signature: (instance old-editable), (arg-1 integer) => void. Options: run-last, action.

  * "move-cursor". Signature: (instance old-editable), (arg-1 integer), (arg-2 integer) => void. Options: run-last, action.

  * "move-page". Signature: (instance old-editable), (arg-1 integer), (arg-2 integer) => void. Options: run-last, action.

  * "move-to-column". Signature: (instance old-editable), (arg-1 integer) => void. Options: run-last, action.

  * "move-to-row". Signature: (instance old-editable), (arg-1 integer) => void. Options: run-last, action.

  * "move-word". Signature: (instance old-editable), (arg-1 integer) => void. Options: run-last, action.

  * "paste-clipboard". Signature: (instance old-editable) => void. Options: run-last, action.

  * "set-editable". Signature: (instance old-editable), (arg-1 boolean) => void. Options: run-last, action.

paned
=====

paned
Superclass: container atk-implementor-iface buildable orientable

Subclasses: v-paned h-paned

Slots:

  * max-position. Type: integer. Accessor: paned-max-position. Read-only.

  * min-position. Type: integer. Accessor: paned-min-position. Read-only.

  * position. Type: integer. Accessor: paned-position.

  * position-set. Type: boolean. Accessor: paned-position-set.

Signals:

  * "accept-position". Signature: (instance paned) => boolean. Options: run-last, action.

  * "cancel-position". Signature: (instance paned) => boolean. Options: run-last, action.

  * "cycle-child-focus". Signature: (instance paned), (arg-1 boolean) => boolean. Options: run-last, action.

  * "cycle-handle-focus". Signature: (instance paned), (arg-1 boolean) => boolean. Options: run-last, action.

  * "move-handle". Signature: (instance paned), (arg-1 scroll-type) => boolean. Options: run-last, action.

  * "toggle-handle-focus". Signature: (instance paned) => boolean. Options: run-last, action.

plug
====

plug
Superclass: gtk-window atk-implementor-iface buildable

Slots:

  * embedded. Type: boolean. Accessor: plug-embedded. Read-only.

  * socket-window. Type: gdk-window. Accessor: plug-socket-window. Read-only.

Signals:

  * "embedded". Signature: (instance plug) => void. Options: run-last.

progress
========

progress
Superclass: widget atk-implementor-iface buildable

Subclasses: progress-bar

Slots:

  * activity-mode. Type: boolean. Accessor: progress-activity-mode.

  * show-text. Type: boolean. Accessor: progress-show-text.

  * text-xalign. Type: single-float. Accessor: progress-text-xalign.

  * text-yalign. Type: single-float. Accessor: progress-text-yalign.

Signals:

progress-bar
============

progress-bar
Superclass: progress atk-implementor-iface buildable

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

When an application can determine how much work needs to take place (e.g. read a fixed number of bytes from a file) and can monitor its progress, it can use the progress-bar in percentage mode and the user sees a growing bar indicating the percentage of the work that has been completed. In this mode, the application is required to set progress-bar,fraction periodically to update the progress bar.

When an application has no accurate way of knowing the amount of work to do, it can use the progress-bar in activity mode, which shows activity by a block moving back and forth within the progress area. In this mode, the application is required to call progress-bar-pulse perodically to update the progress bar.

There is quite a bit of flexibility provided to control the appearance of the progress-bar. Functions are provided to control the orientation of the bar, optional text can be displayed along with the bar, and the step size used in activity mode can be set.

Slots:

  * activity-blocks. Type: integer. Accessor: progress-bar-activity-blocks.

     The number of blocks which can fit in the progress bar area in activity mode (Deprecated).

     Allowed values: >= 2

     Default value: 5

  * activity-step. Type: integer. Accessor: progress-bar-activity-step.

     The increment used for each iteration in activity mode (Deprecated).

     Default value: 3

  * adjustment. Type: adjustment. Accessor: progress-bar-adjustment.

     The adjustment connected to the progress bar (Deprecated

  * bar-style. Type: progress-bar-style. Accessor: progress-bar-bar-style.

     Specifies the visual style of the bar in percentage mode (Deprecated).

     Default value: progress-bar-style,continuous

  * discrete-blocks. Type: integer. Accessor: progress-bar-discrete-blocks.

     The number of discrete blocks in a progress bar (when shown in the discrete style).

     Allowed values: >= 2

     Default value: 10

  * ellipsize. Type: pango-ellipsize-mode. Accessor: progress-bar-ellipsize.

     The preferred place to ellipsize the string, if the progressbar does not have enough room to display the entire string.

     Note that setting this property to a value other than pango-ellipsize-mode,none has the side-effect that the progressbar requests only enough space to display the ellipsis "...". Another means to set a progressbar's width is widget,width-request.

     Default value: pango-ellipsize-mode,none

  * fraction. Type: double-float. Accessor: progress-bar-fraction.

     The fraction of total work that has been completed.

     Allowed values: [0,1]

     Default value: 0

  * orientation. Type: progress-bar-orientation. Accessor: progress-bar-orientation.

     Orientation and growth direction of the progress bar.

     Default value: progress-bar-orientation,left-to-right

  * pulse-step. Type: double-float. Accessor: progress-bar-pulse-step.

     The fraction of total progress to move the bouncing block when pulsed.

     Allowed values: [0,1]

     Default value: 0.1

  * text. Type: string. Accessor: progress-bar-text.

     Text to be displayed in the progress bar.

     Default value: NIL

Signals:

progress-bar-pulse

     (progress-bar-pulse progress-bar)

Indicates that some progress is made, but you don't know how much. Causes the progress bar to enter "activity mode," where a block bounces back and forth. Each call to progress-bar-pulse causes the block to move by a little bit (the amount of movement per pulse is determined by progress-bar,pulse-step).

radio-button
============

radio-button
Superclass: check-button atk-implementor-iface activatable buildable

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

Every radio button is a member of some group of radio buttons. When one is selected, all other radio buttons in the same group are deselected. A radio-button is one way of giving the user a choice from many options.

To group radio buttons into one group, set radio-button,group to one of the radio buttons of the group.

Slots:

  * group. Type: radio-button. Accessor: radio-button-group. Write-only.

     A button of the radio button group that this radio button belongs to

Signals:

  * "group-changed". Signature: (instance radio-button) => void. Options: run-first.

     Emitted when the group of radio buttons that a radio button belongs to changes. This is emitted when a radio button switches from being alone to being part of a group of 2 or more buttons, or vice-versa, and when a button is moved from one group of 2 or more buttons to a different one, but not when the composition of the group that a button belongs to changes.

radio-menu-item
===============

radio-menu-item
Superclass: check-menu-item atk-implementor-iface activatable buildable

Slots:

  * group. Type: radio-menu-item. Accessor: radio-menu-item-group. Write-only.

Signals:

  * "group-changed". Signature: (instance radio-menu-item) => void. Options: run-first.

radio-tool-button
=================

radio-tool-button
Superclass: toggle-tool-button atk-implementor-iface activatable buildable

Slots:

  * group. Type: radio-tool-button. Accessor: radio-tool-button-group. Write-only.

Signals:

range
=====

range
Superclass: widget atk-implementor-iface buildable orientable

Subclasses: scrollbar scale

Slots:

  * adjustment. Type: adjustment. Accessor: range-adjustment.

  * fill-level. Type: double-float. Accessor: range-fill-level.

  * inverted. Type: boolean. Accessor: range-inverted.

  * lower-stepper-sensitivity. Type: sensitivity-type. Accessor: range-lower-stepper-sensitivity.

  * restrict-to-fill-level. Type: boolean. Accessor: range-restrict-to-fill-level.

  * show-fill-level. Type: boolean. Accessor: range-show-fill-level.

  * update-policy. Type: update-type. Accessor: range-update-policy.

  * upper-stepper-sensitivity. Type: sensitivity-type. Accessor: range-upper-stepper-sensitivity.

Signals:

  * "adjust-bounds". Signature: (instance range), (arg-1 double-float) => void. Options: run-last.

  * "change-value". Signature: (instance range), (arg-1 scroll-type), (arg-2 double-float) => boolean. Options: run-last.

  * "move-slider". Signature: (instance range), (arg-1 scroll-type) => void. Options: run-last, action.

  * "value-changed". Signature: (instance range) => void. Options: run-last.

recent-chooser-dialog
=====================

recent-chooser-dialog
Superclass: dialog atk-implementor-iface buildable recent-chooser

Slots:

Signals:

recent-chooser-menu
===================

recent-chooser-menu
Superclass: menu atk-implementor-iface activatable buildable recent-chooser

Slots:

  * show-numbers. Type: boolean. Accessor: recent-chooser-menu-show-numbers.

Signals:

recent-chooser-widget
=====================

recent-chooser-widget
Superclass: v-box atk-implementor-iface buildable orientable recent-chooser

Slots:

Signals:

ruler
=====

ruler
Superclass: widget atk-implementor-iface buildable orientable

Subclasses: v-ruler h-ruler

Slots:

  * lower. Type: double-float. Accessor: ruler-lower.

  * max-size. Type: double-float. Accessor: ruler-max-size.

  * metric. Type: metric-type. Accessor: ruler-metric.

  * position. Type: double-float. Accessor: ruler-position.

  * upper. Type: double-float. Accessor: ruler-upper.

Signals:

scale
=====

scale
Superclass: range atk-implementor-iface buildable orientable

Subclasses: v-scale h-scale

Slots:

  * digits. Type: integer. Accessor: scale-digits.

  * draw-value. Type: boolean. Accessor: scale-draw-value.

  * value-pos. Type: position-type. Accessor: scale-value-pos.

Signals:

  * "format-value". Signature: (instance scale), (arg-1 double-float) => string. Options: run-last.

scale-button
============

scale-button
Superclass: button atk-implementor-iface activatable buildable orientable

Subclasses: volume-button

Slots:

  * adjustment. Type: adjustment. Accessor: scale-button-adjustment.

  * icons. Type: GStrv. Accessor: scale-button-icons.

  * size. Type: icon-size. Accessor: scale-button-size.

  * value. Type: double-float. Accessor: scale-button-value.

Signals:

  * "popdown". Signature: (instance scale-button) => void. Options: run-last, action.

  * "popup". Signature: (instance scale-button) => void. Options: run-last, action.

  * "value-changed". Signature: (instance scale-button), (arg-1 double-float) => void. Options: run-last.

scrollbar
=========

scrollbar
Superclass: range atk-implementor-iface buildable orientable

Subclasses: v-scrollbar h-scrollbar

Slots:

Signals:

scrolled-window
===============

scrolled-window
Superclass: bin atk-implementor-iface buildable

Slots:

  * hadjustment. Type: adjustment. Accessor: scrolled-window-hadjustment.

  * hscrollbar-policy. Type: policy-type. Accessor: scrolled-window-hscrollbar-policy.

  * shadow-type. Type: shadow-type. Accessor: scrolled-window-shadow-type.

  * vadjustment. Type: adjustment. Accessor: scrolled-window-vadjustment.

  * vscrollbar-policy. Type: policy-type. Accessor: scrolled-window-vscrollbar-policy.

  * window-placement. Type: corner-type. Accessor: scrolled-window-window-placement.

  * window-placement-set. Type: boolean. Accessor: scrolled-window-window-placement-set.

Signals:

  * "move-focus-out". Signature: (instance scrolled-window), (arg-1 direction-type) => void. Options: run-last, action.

  * "scroll-child". Signature: (instance scrolled-window), (arg-1 scroll-type), (arg-2 boolean) => boolean. Options: run-last, action.

separator
=========

separator
Superclass: widget atk-implementor-iface buildable orientable

Subclasses: v-separator h-separator

Slots:

Signals:

separator-menu-item
===================

separator-menu-item
Superclass: menu-item atk-implementor-iface activatable buildable

Slots:

Signals:

separator-tool-item
===================

separator-tool-item
Superclass: tool-item atk-implementor-iface activatable buildable

Slots:

  * draw. Type: boolean. Accessor: separator-tool-item-draw.

Signals:

socket
======

socket
Superclass: container atk-implementor-iface buildable

Slots:

Signals:

  * "plug-added". Signature: (instance socket) => void. Options: run-last.

  * "plug-removed". Signature: (instance socket) => boolean. Options: run-last.

spin-button
===========

spin-button
Superclass: entry atk-implementor-iface buildable cell-editable editable

Slots:

  * adjustment. Type: adjustment. Accessor: spin-button-adjustment.

  * climb-rate. Type: double-float. Accessor: spin-button-climb-rate.

  * digits. Type: integer. Accessor: spin-button-digits.

  * numeric. Type: boolean. Accessor: spin-button-numeric.

  * snap-to-ticks. Type: boolean. Accessor: spin-button-snap-to-ticks.

  * update-policy. Type: spin-button-update-policy. Accessor: spin-button-update-policy.

  * value. Type: double-float. Accessor: spin-button-value.

  * wrap. Type: boolean. Accessor: spin-button-wrap.

Signals:

  * "change-value". Signature: (instance spin-button), (arg-1 scroll-type) => void. Options: run-last, action.

  * "input". Signature: (instance spin-button), (arg-1 gpointer) => integer. Options: run-last.

  * "output". Signature: (instance spin-button) => boolean. Options: run-last.

  * "value-changed". Signature: (instance spin-button) => void. Options: run-last.

  * "wrapped". Signature: (instance spin-button) => void. Options: run-last.

statusbar
=========

statusbar
Superclass: h-box atk-implementor-iface buildable orientable

A statusbar is usually placed along the bottom of an application's main gtk-window. It may provide a regular commentary of the application's status (as is usually the case in a web browser, for example), or may be used to simply output a message when the status changes, (when an upload is complete in an FTP client, for example). It may also have a resize grip (a triangular area in the lower right corner) which can be clicked on to resize the window containing the statusbar.

Status bars in GTK+ maintain a stack of messages. The message at the top of the each bar's stack is the one that will currently be displayed.

Any messages added to a statusbar's stack must specify a context id that is used to uniquely identify the source of a message. Context ids may be specified by context descriptions (as string) or by numeric identifiers obtained by statusbar-context-id. Note that messages are stored in a stack, and when choosing which message to display, the stack structure is adhered to, regardless of the context description of a message.

One could say that a statusbar maintains one stack of messages for display purposes, but allows multiple message producers to maintain sub-stacks of the messages they produced (via context descriptions).

Messages are added to the bar's stack with statusbar-push.

The message at the top of the stack can be removed using statusbar-pop. A message can be removed from anywhere in the stack if its MESSAGE-ID was recorded at the time it was added. This is done using statusbar-remove.

Slots:

  * has-resize-grip. Type: boolean. Accessor: statusbar-has-resize-grip.

     Whether the statusbar has a grip for resizing the toplevel window.

     Default value: True

Signals:

  * "text-popped". Signature: (instance statusbar), (context-id integer), (text string) => void. Options: run-last.

     Is emitted whenever a new message is popped off a statusbar's stack.

     CONTEXT-ID is a numeric identifier of a context.

  * "text-pushed". Signature: (instance statusbar), (context-id integer), (text string) => void. Options: run-last.

     Is emitted whenever a new message gets pushed onto a statusbar's stack.

     CONTEXT-ID is a numeric identifier of a context.

statusbar-context-id

     (statusbar-context-id statusbar context-description) => context-id

Returns a context identifier, given a description of the actual context. Note that the description is not shown in the UI.

CONTEXT-DESCRIPTION is a string - textual description of what context the new message is being used in

statusbar-push

     (statusbar-push statusbar context text) => message-id

Pushes a new message onto a statusbar's stack.

CONTEXT: a string (context description) or a number obtained by statusbar-context-id

TEXT: the message to add to the statusbar

MESSAGE-ID: a message id that can be used with statusbar-remove.

statusbar-pop

     (statusbar-pop statusbar context)

Removes the first message in the statusbar's stack with the given context.

Note that this may not change the displayed message, if the message at the top of the stack has a different context.

CONTEXT: a string (context description) or a number obtained by statusbar-context-id

statusbar-remove

     (statusbar-remove statusbar context message-id)

Forces the removal of a message from a statusbar's stack. The exact CONTEXT and MESSAGE-ID must be specified.

CONTEXT: a string (context description) or a number obtained by statusbar-context-id

MESSAGE-ID: a message identifier returned by statusbar-push

table
=====

table
Superclass: container atk-implementor-iface buildable

Slots:

  * column-spacing. Type: integer. Accessor: table-column-spacing.

  * homogeneous. Type: boolean. Accessor: table-homogeneous.

  * n-columns. Type: integer. Accessor: table-n-columns.

  * n-rows. Type: integer. Accessor: table-n-rows.

  * row-spacing. Type: integer. Accessor: table-row-spacing.

Signals:

tearoff-menu-item
=================

tearoff-menu-item
Superclass: menu-item atk-implementor-iface activatable buildable

Slots:

Signals:

text
====

text
Superclass: old-editable atk-implementor-iface buildable editable

Slots:

  * hadjustment. Type: adjustment. Accessor: text-hadjustment.

  * line-wrap. Type: boolean. Accessor: text-line-wrap.

  * vadjustment. Type: adjustment. Accessor: text-vadjustment.

  * word-wrap. Type: boolean. Accessor: text-word-wrap.

Signals:

  * "set-scroll-adjustments". Signature: (instance text), (arg-1 adjustment), (arg-2 adjustment) => void. Options: run-last.

text-view
=========

text-view
Superclass: container atk-implementor-iface buildable

Slots:

  * accepts-tab. Type: boolean. Accessor: text-view-accepts-tab.

  * buffer. Type: text-buffer. Accessor: text-view-buffer.

  * cursor-visible. Type: boolean. Accessor: text-view-cursor-visible.

  * editable. Type: boolean. Accessor: text-view-editable.

  * im-module. Type: string. Accessor: text-view-im-module.

  * indent. Type: integer. Accessor: text-view-indent.

  * justification. Type: justification. Accessor: text-view-justification.

  * left-margin. Type: integer. Accessor: text-view-left-margin.

  * overwrite. Type: boolean. Accessor: text-view-overwrite.

  * pixels-above-lines. Type: integer. Accessor: text-view-pixels-above-lines.

  * pixels-below-lines. Type: integer. Accessor: text-view-pixels-below-lines.

  * pixels-inside-wrap. Type: integer. Accessor: text-view-pixels-inside-wrap.

  * right-margin. Type: integer. Accessor: text-view-right-margin.

  * tabs. Type: PangoTabArray. Accessor: text-view-tabs.

  * wrap-mode. Type: wrap-mode. Accessor: text-view-wrap-mode.

Signals:

  * "backspace". Signature: (instance text-view) => void. Options: run-last, action.

  * "copy-clipboard". Signature: (instance text-view) => void. Options: run-last, action.

  * "cut-clipboard". Signature: (instance text-view) => void. Options: run-last, action.

  * "delete-from-cursor". Signature: (instance text-view), (arg-1 delete-type), (arg-2 integer) => void. Options: run-last, action.

  * "insert-at-cursor". Signature: (instance text-view), (arg-1 string) => void. Options: run-last, action.

  * "move-cursor". Signature: (instance text-view), (arg-1 movement-step), (arg-2 integer), (arg-3 boolean) => void. Options: run-last, action.

  * "move-viewport". Signature: (instance text-view), (arg-1 scroll-step), (arg-2 integer) => void. Options: run-last, action.

  * "page-horizontally". Signature: (instance text-view), (arg-1 integer), (arg-2 boolean) => void. Options: run-last, action.

  * "paste-clipboard". Signature: (instance text-view) => void. Options: run-last, action.

  * "populate-popup". Signature: (instance text-view), (arg-1 menu) => void. Options: run-last.

  * "select-all". Signature: (instance text-view), (arg-1 boolean) => void. Options: run-last, action.

  * "set-anchor". Signature: (instance text-view) => void. Options: run-last, action.

  * "set-scroll-adjustments". Signature: (instance text-view), (arg-1 adjustment), (arg-2 adjustment) => void. Options: run-last, action.

  * "toggle-cursor-visible". Signature: (instance text-view) => void. Options: run-last, action.

  * "toggle-overwrite". Signature: (instance text-view) => void. Options: run-last, action.

toggle-button
=============

toggle-button
Superclass: button atk-implementor-iface activatable buildable

Subclasses: check-button

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

The state of a toggle-button is stored in toggle-button,active and toggle-button,inconsistent.

Slots:

  * active. Type: boolean. Accessor: toggle-button-active.

     If the toggle button should be pressed in or not.

     Default value: False

  * draw-indicator. Type: boolean. Accessor: toggle-button-draw-indicator.

     If the toggle part of the button is displayed.

     Default value: False

  * inconsistent. Type: boolean. Accessor: toggle-button-inconsistent.

     If the toggle button is in an "in between" state.

     Default value: False

Signals:

  * "toggled". Signature: (instance toggle-button) => void. Options: run-first.

     Should be connected if you wish to perform an action whenever the toggle-button's state is changed.

toggle-tool-button
==================

toggle-tool-button
Superclass: tool-button atk-implementor-iface activatable buildable

Subclasses: radio-tool-button

Slots:

  * active. Type: boolean. Accessor: toggle-tool-button-active.

Signals:

  * "toggled". Signature: (instance toggle-tool-button) => void. Options: run-first.

tool-button
===========

tool-button
Superclass: tool-item atk-implementor-iface activatable buildable

Subclasses: toggle-tool-button menu-tool-button

Slots:

  * icon-name. Type: string. Accessor: tool-button-icon-name.

  * icon-widget. Type: widget. Accessor: tool-button-icon-widget.

  * label. Type: string. Accessor: tool-button-label.

  * label-widget. Type: widget. Accessor: tool-button-label-widget.

  * stock-id. Type: string. Accessor: tool-button-stock-id.

  * use-underline. Type: boolean. Accessor: tool-button-use-underline.

Signals:

  * "clicked". Signature: (instance tool-button) => void. Options: run-first, action.

tool-item
=========

tool-item
Superclass: bin atk-implementor-iface activatable buildable

Subclasses: separator-tool-item tool-button

Slots:

  * expand. Type: boolean. Accessor: tool-item-expand.

  * icon-size. Type: icon-size. Accessor: tool-item-icon-size. Read-only.

  * is-important. Type: boolean. Accessor: tool-item-is-important.

  * orientation. Type: orientation. Accessor: tool-item-orientation. Read-only.

  * relief-style. Type: relief-style. Accessor: tool-item-relief-style. Read-only.

  * toolbar-style. Type: toolbar-style. Accessor: tool-item-toolbar-style. Read-only.

  * use-drag-window. Type: boolean. Accessor: tool-item-use-drag-window.

  * visible-horizontal. Type: boolean. Accessor: tool-item-visible-horizontal.

  * visible-vertical. Type: boolean. Accessor: tool-item-visible-vertical.

Signals:

  * "create-menu-proxy". Signature: (instance tool-item) => boolean. Options: run-last.

  * "set-tooltip". Signature: (instance tool-item), (arg-1 tooltips), (arg-2 string), (arg-3 string) => boolean. Options: run-last.

  * "toolbar-reconfigured". Signature: (instance tool-item) => void. Options: run-last.

toolbar
=======

toolbar
Superclass: container atk-implementor-iface buildable orientable tool-shell

Slots:

  * icon-size. Type: integer. Accessor: toolbar-icon-size.

  * icon-size-set. Type: boolean. Accessor: toolbar-icon-size-set.

  * show-arrow. Type: boolean. Accessor: toolbar-show-arrow.

  * toolbar-style. Type: toolbar-style. Accessor: toolbar-toolbar-style.

  * tooltips. Type: boolean. Accessor: toolbar-tooltips.

Signals:

  * "focus-home-or-end". Signature: (instance toolbar), (arg-1 boolean) => boolean. Options: run-last, action.

  * "orientation-changed". Signature: (instance toolbar), (arg-1 orientation) => void. Options: run-first.

  * "popup-context-menu". Signature: (instance toolbar), (arg-1 integer), (arg-2 integer), (arg-3 integer) => boolean. Options: run-last.

  * "style-changed". Signature: (instance toolbar), (arg-1 toolbar-style) => void. Options: run-first.

tree
====

tree
Superclass: container atk-implementor-iface buildable

Slots:

Signals:

  * "select-child". Signature: (instance tree), (arg-1 widget) => void. Options: run-first.

  * "selection-changed". Signature: (instance tree) => void. Options: run-first.

  * "unselect-child". Signature: (instance tree), (arg-1 widget) => void. Options: run-first.

tree-item
=========

tree-item
Superclass: item atk-implementor-iface buildable

Slots:

Signals:

  * "collapse". Signature: (instance tree-item) => void. Options: run-first.

  * "expand". Signature: (instance tree-item) => void. Options: run-first.

tree-view
=========

tree-view
Superclass: container atk-implementor-iface buildable

Slots:

  * bin-window. Type: g-object. Accessor: tree-view-bin-window. Read-only.

  * column-drag-function. Type: ????. Accessor: tree-view-column-drag-function. Write-only.

  * enable-grid-lines. Type: tree-view-grid-lines. Accessor: tree-view-enable-grid-lines.

  * enable-search. Type: boolean. Accessor: tree-view-enable-search.

  * enable-tree-lines. Type: boolean. Accessor: tree-view-enable-tree-lines.

  * expander-column. Type: tree-view-column. Accessor: tree-view-expander-column.

  * fixed-height-mode. Type: boolean. Accessor: tree-view-fixed-height-mode.

  * hadjustment. Type: adjustment. Accessor: tree-view-hadjustment.

  * headers-clickable. Type: boolean. Accessor: tree-view-headers-clickable.

  * headers-visible. Type: boolean. Accessor: tree-view-headers-visible.

  * hover-expand. Type: boolean. Accessor: tree-view-hover-expand.

  * hover-selection. Type: boolean. Accessor: tree-view-hover-selection.

  * level-indentation. Type: integer. Accessor: tree-view-level-indentation.

  * model. Type: tree-model. Accessor: tree-view-model.

  * reorderable. Type: boolean. Accessor: tree-view-reorderable.

  * row-separator-func. Type: ????. Accessor: tree-view-row-separator-func. Write-only.

  * rubber-banding. Type: boolean. Accessor: tree-view-rubber-banding.

  * rules-hint. Type: boolean. Accessor: tree-view-rules-hint.

  * search-column. Type: integer. Accessor: tree-view-search-column.

  * search-entry. Type: g-object. Accessor: tree-view-search-entry.

  * search-equal-func. Type: ????. Accessor: tree-view-search-equal-func. Write-only.

  * search-position-func. Type: ????. Accessor: tree-view-search-position-func. Write-only.

  * selection. Type: g-object. Accessor: tree-view-selection. Read-only.

  * show-expanders. Type: boolean. Accessor: tree-view-show-expanders.

  * tooltip-column. Type: integer. Accessor: tree-view-tooltip-column.

  * vadjustment. Type: adjustment. Accessor: tree-view-vadjustment.

Signals:

  * "columns-changed". Signature: (instance tree-view) => void. Options: run-last.

  * "cursor-changed". Signature: (instance tree-view) => void. Options: run-last.

  * "expand-collapse-cursor-row". Signature: (instance tree-view), (arg-1 boolean), (arg-2 boolean), (arg-3 boolean) => boolean. Options: run-last, action.

  * "move-cursor". Signature: (instance tree-view), (arg-1 movement-step), (arg-2 integer) => boolean. Options: run-last, action.

  * "row-activated". Signature: (instance tree-view), (arg-1 tree-path), (arg-2 tree-view-column) => void. Options: run-last, action.

  * "row-collapsed". Signature: (instance tree-view), (arg-1 tree-iter), (arg-2 tree-path) => void. Options: run-last.

  * "row-expanded". Signature: (instance tree-view), (arg-1 tree-iter), (arg-2 tree-path) => void. Options: run-last.

  * "select-all". Signature: (instance tree-view) => boolean. Options: run-last, action.

  * "select-cursor-parent". Signature: (instance tree-view) => boolean. Options: run-last, action.

  * "select-cursor-row". Signature: (instance tree-view), (arg-1 boolean) => boolean. Options: run-last, action.

  * "set-scroll-adjustments". Signature: (instance tree-view), (arg-1 adjustment), (arg-2 adjustment) => void. Options: run-last, action.

  * "start-interactive-search". Signature: (instance tree-view) => boolean. Options: run-last, action.

  * "test-collapse-row". Signature: (instance tree-view), (arg-1 tree-iter), (arg-2 tree-path) => boolean. Options: run-last.

  * "test-expand-row". Signature: (instance tree-view), (arg-1 tree-iter), (arg-2 tree-path) => boolean. Options: run-last.

  * "toggle-cursor-row". Signature: (instance tree-view) => boolean. Options: run-last, action.

  * "unselect-all". Signature: (instance tree-view) => boolean. Options: run-last, action.

v-box
=====

v-box
Superclass: box atk-implementor-iface buildable orientable

Subclasses: recent-chooser-widget gamma-curve font-selection file-chooser-widget color-selection

Slots:

Signals:

v-button-box
============

v-button-box
Superclass: button-box atk-implementor-iface buildable orientable

Slots:

Signals:

v-paned
=======

v-paned
Superclass: paned atk-implementor-iface buildable orientable

Slots:

Signals:

v-ruler
=======

v-ruler
Superclass: ruler atk-implementor-iface buildable orientable

Slots:

Signals:

v-scale
=======

v-scale
Superclass: scale atk-implementor-iface buildable orientable

Slots:

Signals:

v-scrollbar
===========

v-scrollbar
Superclass: scrollbar atk-implementor-iface buildable orientable

Slots:

Signals:

v-separator
===========

v-separator
Superclass: separator atk-implementor-iface buildable orientable

Slots:

Signals:

viewport
========

viewport
Superclass: bin atk-implementor-iface buildable

Slots:

  * hadjustment. Type: adjustment. Accessor: viewport-hadjustment.

  * shadow-type. Type: shadow-type. Accessor: viewport-shadow-type.

  * vadjustment. Type: adjustment. Accessor: viewport-vadjustment.

Signals:

  * "set-scroll-adjustments". Signature: (instance viewport), (arg-1 adjustment), (arg-2 adjustment) => void. Options: run-last, action.

volume-button
=============

volume-button
Superclass: scale-button atk-implementor-iface activatable buildable orientable

Slots:

Signals:

widget
======

widget
Superclass: gtk-object atk-implementor-iface buildable

Subclasses: old-editable progress invisible h-s-v separator range ruler entry drawing-area cell-view calendar misc container

Slots:

  * accessible. Type: g-object. Accessor: widget-accessible. Read-only.

  * app-paintable. Type: boolean. Accessor: widget-app-paintable.

  * can-default. Type: boolean. Accessor: widget-can-default.

  * can-focus. Type: boolean. Accessor: widget-can-focus.

  * composite-child. Type: boolean. Accessor: widget-composite-child. Read-only.

  * composite-name. Type: string. Accessor: widget-composite-name.

  * direction. Type: text-direction. Accessor: widget-direction.

  * events. Type: event-mask. Accessor: widget-events.

  * extension-events. Type: gdk-extension-mode. Accessor: widget-extension-events.

  * has-default. Type: boolean. Accessor: widget-has-default.

  * has-focus. Type: boolean. Accessor: widget-has-focus.

  * has-tooltip. Type: boolean. Accessor: widget-has-tooltip.

  * height-request. Type: integer. Accessor: widget-height-request.

  * is-focus. Type: boolean. Accessor: widget-is-focus.

  * name. Type: string. Accessor: widget-name.

  * no-show-all. Type: boolean. Accessor: widget-no-show-all.

  * parent. Type: container. Accessor: widget-parent.

  * receives-default. Type: boolean. Accessor: widget-receives-default.

  * redraw-on-allocate. Type: boolean. Accessor: widget-redraw-on-allocate. Write-only.

  * sensitive. Type: boolean. Accessor: widget-sensitive.

  * style. Type: style. Accessor: widget-style.

  * tooltip-markup. Type: string. Accessor: widget-tooltip-markup.

  * tooltip-text. Type: string. Accessor: widget-tooltip-text.

  * tooltip-window. Type: g-object. Accessor: widget-tooltip-window.

  * visible. Type: boolean. Accessor: widget-visible.

  * width-request. Type: integer. Accessor: widget-width-request.

  * window. Type: gdk-window. Accessor: widget-window. Read-only.

Signals:

  * "accel-closures-changed". Signature: (instance widget) => void. Options: .

  * "button-press-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "button-release-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "can-activate-accel". Signature: (instance widget), (arg-1 integer) => boolean. Options: run-last.

  * "child-notify". Signature: (instance widget), (arg-1 GParam) => void. Options: run-first, no-recurse, detailed, no-hooks.

  * "client-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "composited-changed". Signature: (instance widget) => void. Options: run-last, action.

  * "configure-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "damage-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "delete-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "destroy-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "direction-changed". Signature: (instance widget), (arg-1 text-direction) => void. Options: run-first.

  * "drag-begin". Signature: (instance widget), (arg-1 drag-context) => void. Options: run-last.

  * "drag-data-delete". Signature: (instance widget), (arg-1 drag-context) => void. Options: run-last.

  * "drag-data-get". Signature: (instance widget), (arg-1 drag-context), (arg-2 GtkSelectionData), (arg-3 integer), (arg-4 integer) => void. Options: run-last.

  * "drag-data-received". Signature: (instance widget), (arg-1 drag-context), (arg-2 integer), (arg-3 integer), (arg-4 GtkSelectionData), (arg-5 integer), (arg-6 integer) => void. Options: run-last.

  * "drag-drop". Signature: (instance widget), (arg-1 drag-context), (arg-2 integer), (arg-3 integer), (arg-4 integer) => boolean. Options: run-last.

  * "drag-end". Signature: (instance widget), (arg-1 drag-context) => void. Options: run-last.

  * "drag-failed". Signature: (instance widget), (arg-1 drag-context), (arg-2 drag-result) => boolean. Options: run-last.

  * "drag-leave". Signature: (instance widget), (arg-1 drag-context), (arg-2 integer) => void. Options: run-last.

  * "drag-motion". Signature: (instance widget), (arg-1 drag-context), (arg-2 integer), (arg-3 integer), (arg-4 integer) => boolean. Options: run-last.

  * "enter-notify-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "event-after". Signature: (instance widget), (arg-1 event) => void. Options: .

  * "expose-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "focus". Signature: (instance widget), (arg-1 direction-type) => boolean. Options: run-last.

  * "focus-in-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "focus-out-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "grab-broken-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "grab-focus". Signature: (instance widget) => void. Options: run-last, action.

  * "grab-notify". Signature: (instance widget), (arg-1 boolean) => void. Options: run-first.

  * "hide". Signature: (instance widget) => void. Options: run-first.

  * "hierarchy-changed". Signature: (instance widget), (arg-1 widget) => void. Options: run-last.

  * "key-press-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "key-release-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "keynav-failed". Signature: (instance widget), (arg-1 direction-type) => boolean. Options: run-last.

  * "leave-notify-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "map". Signature: (instance widget) => void. Options: run-first.

  * "map-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "mnemonic-activate". Signature: (instance widget), (arg-1 boolean) => boolean. Options: run-last.

  * "motion-notify-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "move-focus". Signature: (instance widget), (arg-1 direction-type) => void. Options: run-last, action.

  * "no-expose-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "parent-set". Signature: (instance widget), (arg-1 widget) => void. Options: run-first.

  * "popup-menu". Signature: (instance widget) => boolean. Options: run-last, action.

  * "property-notify-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "proximity-in-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "proximity-out-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "query-tooltip". Signature: (instance widget), (arg-1 integer), (arg-2 integer), (arg-3 boolean), (arg-4 tooltip) => boolean. Options: run-last.

  * "realize". Signature: (instance widget) => void. Options: run-first.

  * "screen-changed". Signature: (instance widget), (arg-1 screen) => void. Options: run-last.

  * "scroll-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "selection-clear-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "selection-get". Signature: (instance widget), (arg-1 GtkSelectionData), (arg-2 integer), (arg-3 integer) => void. Options: run-last.

  * "selection-notify-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "selection-received". Signature: (instance widget), (arg-1 GtkSelectionData), (arg-2 integer) => void. Options: run-last.

  * "selection-request-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "show". Signature: (instance widget) => void. Options: run-first.

  * "show-help". Signature: (instance widget), (arg-1 widget-help-type) => boolean. Options: run-last, action.

  * "size-allocate". Signature: (instance widget), (arg-1 rectangle) => void. Options: run-first.

  * "size-request". Signature: (instance widget), (arg-1 GtkRequisition) => void. Options: run-first.

  * "state-changed". Signature: (instance widget), (arg-1 state-type) => void. Options: run-first.

  * "style-set". Signature: (instance widget), (arg-1 style) => void. Options: run-first.

  * "unmap". Signature: (instance widget) => void. Options: run-first.

  * "unmap-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "unrealize". Signature: (instance widget) => void. Options: run-last.

  * "visibility-notify-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

  * "window-state-event". Signature: (instance widget), (arg-1 event) => boolean. Options: run-last.

widget-show

Undocumented yet

widget-grab-focus

Undocumented yet