Class

GtkButton

Description [src]

class Gtk.Button : Gtk.Bin {
  /* No available fields */
}

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

The GtkButton widget can hold any valid child widget. That is, it can hold almost any other standard GtkWidget. The most commonly used child is the GtkLabel.

CSS nodes

GtkButton has a single CSS node with name button. The node will get the style classes .image-button or .text-button, if the content is just an image or label, respectively. It may also receive the .flat style class.

Other style classes that are commonly used with GtkButton include .suggested-action and .destructive-action. In special cases, buttons can be made round by adding the .circular style class.

Button-like widgets like GtkToggleButton, GtkMenuButton, GtkVolumeButton, GtkLockButton, GtkColorButton, GtkFontButton or GtkFileChooserButton use style classes such as .toggle, .popup, .scale, .lock, .color, .font, .file to differentiate themselves from a plain GtkButton.

Hierarchy

hierarchy this GtkButton implements_0 AtkImplementorIface this--implements_0 implements_1 GtkActionable this--implements_1 implements_2 GtkActivatable this--implements_2 implements_3 GtkBuildable this--implements_3 ancestor_0 GtkBin ancestor_0--this ancestor_1 GtkContainer ancestor_1--ancestor_0 ancestor_2 GtkWidget ancestor_2--ancestor_1 ancestor_3 GInitiallyUnowned ancestor_3--ancestor_2 ancestor_4 GObject ancestor_4--ancestor_3

Constructors

gtk_button_new

Creates a new GtkButton widget. To add a child widget to the button, use gtk_container_add().

gtk_button_new_from_icon_name

Creates a new button containing an icon from the current icon theme.

Available since: 3.10

gtk_button_new_from_stock

Creates a new GtkButton containing the image and text from a [stock item][gtkstock]. Some stock ids have preprocessor macros like #GTK_STOCK_OK and

GTK_STOCK_APPLY.

Deprecated since: 3.10

gtk_button_new_with_label

Creates a GtkButton widget with a GtkLabel child containing the given text.

gtk_button_new_with_mnemonic

Creates a new GtkButton containing a label. If characters in label are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use “__” (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt and that key activates the button.

Instance methods

gtk_button_clicked

Emits a GtkButton::clicked signal to the given GtkButton.

gtk_button_enter

Emits a GtkButton::enter signal to the given GtkButton.

Deprecated since: 2.20

gtk_button_get_alignment

Gets the alignment of the child in the button.

Available since: 2.4

Deprecated since: 3.14

gtk_button_get_always_show_image

Returns whether the button will ignore the GtkSettings:gtk-button-images setting and always show the image, if available.

Available since: 3.6

gtk_button_get_event_window

Returns the button’s event window if it is realized, NULL otherwise. This function should be rarely needed.

Available since: 2.22

gtk_button_get_focus_on_click

Returns whether the button grabs focus when it is clicked with the mouse. See gtk_button_set_focus_on_click().

Available since: 2.4

Deprecated since: 3.20

gtk_button_get_image

Gets the widget that is currenty set as the image of button. This may have been explicitly set by gtk_button_set_image() or constructed by gtk_button_new_from_stock().

Available since: 2.6

gtk_button_get_image_position

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

Available since: 2.10

gtk_button_get_label

Fetches the text from the label of the button, as set by gtk_button_set_label(). If the label text has not been set the return value will be NULL. This will be the case if you create an empty button with gtk_button_new() to use as a container.

gtk_button_get_relief

Returns the current relief style of the given GtkButton.

gtk_button_get_use_stock

Returns whether the button label is a stock item.

Deprecated since: 3.10

gtk_button_get_use_underline

Returns whether an embedded underline in the button label indicates a mnemonic. See gtk_button_set_use_underline ().

gtk_button_leave

Emits a GtkButton::leave signal to the given GtkButton.

Deprecated since: 2.20

gtk_button_pressed

Emits a GtkButton::pressed signal to the given GtkButton.

Deprecated since: 2.20

gtk_button_released

Emits a GtkButton::released signal to the given GtkButton.

Deprecated since: 2.20

gtk_button_set_alignment

Sets the alignment of the child. This property has no effect unless the child is a GtkMisc or a GtkAlignment.

Available since: 2.4

Deprecated since: 3.14

gtk_button_set_always_show_image

If TRUE, the button will ignore the GtkSettings:gtk-button-images setting and always show the image, if available.

Available since: 3.6

gtk_button_set_focus_on_click

Sets whether the button will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.

Available since: 2.4

Deprecated since: 3.20

gtk_button_set_image

Set the image of button to the given widget. The image will be displayed if the label text is NULL or if GtkButton:always-show-image is TRUE. You don’t have to call gtk_widget_show() on image yourself.

Available since: 2.6

gtk_button_set_image_position

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

Available since: 2.10

gtk_button_set_label

Sets the text of the label of the button to str. This text is also used to select the stock item if gtk_button_set_use_stock() is used.

gtk_button_set_relief

Sets the relief style of the edges of the given GtkButton widget. Two styles exist, GTK_RELIEF_NORMAL and GTK_RELIEF_NONE. The default style is, as one can guess, GTK_RELIEF_NORMAL. The deprecated value GTK_RELIEF_HALF behaves the same as GTK_RELIEF_NORMAL.

gtk_button_set_use_stock

If TRUE, the label set on the button is used as a stock id to select the stock item for the button.

Deprecated since: 3.10

gtk_button_set_use_underline

If true, an underline in the text of the button label indicates the next character should be used for the mnemonic accelerator key.

Methods inherited from GtkBin (1)
gtk_bin_get_child

Gets the child of the GtkBin, or NULL if the bin contains no child widget. The returned widget does not have a reference added, so you do not need to unref it.

Methods inherited from GtkContainer (33)

Please see GtkContainer for a full list of methods.

Methods inherited from GtkWidget (263)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkActionable (6)
gtk_actionable_get_action_name

Gets the action name for actionable.

Available since: 3.4

gtk_actionable_get_action_target_value

Gets the current target value of actionable.

Available since: 3.4

gtk_actionable_set_action_name

Specifies the name of the action with which this widget should be associated. If action_name is NULL then the widget will be unassociated from any previous action.

Available since: 3.4

gtk_actionable_set_action_target

Sets the target of an actionable widget.

Available since: 3.4

gtk_actionable_set_action_target_value

Sets the target value of an actionable widget.

Available since: 3.4

gtk_actionable_set_detailed_action_name

Sets the action-name and associated string target value of an actionable widget.

Available since: 3.4

Methods inherited from GtkActivatable (6)
gtk_activatable_do_set_related_action

This is a utility function for GtkActivatable implementors.

Available since: 2.16

Deprecated since: 3.10

gtk_activatable_get_related_action

Gets the related GtkAction for activatable.

Available since: 2.16

Deprecated since: 3.10

gtk_activatable_get_use_action_appearance

Gets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance.

Available since: 2.16

Deprecated since: 3.10

gtk_activatable_set_related_action

Sets the related action on the activatable object.

Available since: 2.16

Deprecated since: 3.10

gtk_activatable_set_use_action_appearance

Sets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance.

Available since: 2.16

Deprecated since: 3.10

gtk_activatable_sync_action_properties

This is called to update the activatable completely, this is called internally when the GtkActivatable:related-action property is set or unset and by the implementing class when GtkActivatable:use-action-appearance changes.

Available since: 2.16

Deprecated since: 3.10

Methods inherited from GtkBuildable (10)
gtk_buildable_add_child

Adds a child to buildable. type is an optional string describing how the child should be added.

Available since: 2.12

gtk_buildable_construct_child

Constructs a child of buildable with the name name.

Available since: 2.12

gtk_buildable_custom_finished

This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable.

Available since: 2.12

gtk_buildable_custom_tag_end

This is called at the end of each custom element handled by the buildable.

Available since: 2.12

gtk_buildable_custom_tag_start

This is called for each unknown element under <child>.

Available since: 2.12

gtk_buildable_get_internal_child

Get the internal child called childname of the buildable object.

Available since: 2.12

gtk_buildable_get_name

Gets the name of the buildable object.

Available since: 2.12

gtk_buildable_parser_finished

Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() is called on a builder.

Available since: 2.12

gtk_buildable_set_buildable_property

Sets the property name name to value on the buildable object.

Available since: 2.12

gtk_buildable_set_name

Sets the name of the buildable object.

Available since: 2.12

Properties

Gtk.Button:always-show-image

If TRUE, the button will ignore the GtkSettings:gtk-button-images setting and always show the image, if available.

Available since: 3.6

Gtk.Button:image

The child widget to appear next to the button text.

Available since: 2.6

Gtk.Button:image-position

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

Available since: 2.10

Gtk.Button:label
No description available.
Gtk.Button:relief
No description available.
Gtk.Button:use-stock
No description available.

Deprecated since: 3.10

Gtk.Button:use-underline
No description available.
Gtk.Button:xalign

If the child of the button is a GtkMisc or GtkAlignment, this property can be used to control its horizontal alignment. 0.0 is left aligned, 1.0 is right aligned.

Available since: 2.4

Deprecated since: 3.14

Gtk.Button:yalign

If the child of the button is a GtkMisc or GtkAlignment, this property can be used to control its vertical alignment. 0.0 is top aligned, 1.0 is bottom aligned.

Available since: 2.4

Deprecated since: 3.14

Properties inherited from GtkContainer (3)
Gtk.Container:border-width
No description available.
Gtk.Container:child
No description available.
Gtk.Container:resize-mode
No description available.
Properties inherited from GtkWidget (39)
Gtk.Widget:app-paintable
No description available.
Gtk.Widget:can-default
No description available.
Gtk.Widget:can-focus
No description available.
Gtk.Widget:composite-child
No description available.
Gtk.Widget:double-buffered

Whether the widget is double buffered.

Available since: 2.18

Deprecated since: 3.14

Gtk.Widget:events
No description available.
Gtk.Widget:expand

Whether to expand in both directions. Setting this sets both GtkWidget:hexpand and GtkWidget:vexpand.

Available since: 3.0

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Available since: 3.20

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space, see GtkAlign.

Available since: 3.0

Gtk.Widget:has-default
No description available.
Gtk.Widget:has-focus
No description available.
Gtk.Widget:has-tooltip

Enables or disables the emission of GtkWidget::query-tooltip on widget. A value of TRUE indicates that widget can have a tooltip, in this case the widget will be queried using GtkWidget::query-tooltip to determine whether it will provide a tooltip or not.

Available since: 2.12

Gtk.Widget:height-request
No description available.
Gtk.Widget:hexpand

Whether to expand horizontally. See gtk_widget_set_hexpand().

Available since: 3.0

Gtk.Widget:hexpand-set

Whether to use the GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().

Available since: 3.0

Gtk.Widget:is-focus
No description available.
Gtk.Widget:margin

Sets all four sides’ margin at once. If read, returns max margin on any side.

Available since: 3.0

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Available since: 3.0

Gtk.Widget:margin-end

Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.

Available since: 3.12

Gtk.Widget:margin-left

Margin on left side of widget.

Available since: 3.0

Deprecated since: 3.12

Gtk.Widget:margin-right

Margin on right side of widget.

Available since: 3.0

Deprecated since: 3.12

Gtk.Widget:margin-start

Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.

Available since: 3.12

Gtk.Widget:margin-top

Margin on top side of widget.

Available since: 3.0

Gtk.Widget:name
No description available.
Gtk.Widget:no-show-all
No description available.
Gtk.Widget:opacity

The requested opacity of the widget. See gtk_widget_set_opacity() for more details about window opacity.

Available since: 3.8

Gtk.Widget:parent
No description available.
Gtk.Widget:receives-default
No description available.
Gtk.Widget:scale-factor

The scale factor of the widget. See gtk_widget_get_scale_factor() for more details about widget scaling.

Available since: 3.10

Gtk.Widget:sensitive
No description available.
Gtk.Widget:style

The style of the widget, which contains information about how it will look (colors, etc).

Deprecated since: Unknown

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_tooltip_set_markup().

Available since: 2.12

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Available since: 2.12

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space, see GtkAlign.

Available since: 3.0

Gtk.Widget:vexpand

Whether to expand vertically. See gtk_widget_set_vexpand().

Available since: 3.0

Gtk.Widget:vexpand-set

Whether to use the GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().

Available since: 3.0

Gtk.Widget:visible
No description available.
Gtk.Widget:width-request
No description available.
Gtk.Widget:window

The widget’s window if it is realized, NULL otherwise.

Available since: 2.14

Properties inherited from GtkActionable (2)
Gtk.Actionable:action-name
No description available.
Gtk.Actionable:action-target
No description available.
Properties inherited from GtkActivatable (2)
Gtk.Activatable:related-action

The action that this activatable will activate and receive updates from for various states and possibly appearance.

Available since: 2.16

Deprecated since: 3.10

Gtk.Activatable:use-action-appearance

Whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance.

Available since: 2.16

Deprecated since: 3.10

Signals

Gtk.Button::activate

The ::activate signal on GtkButton 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 GtkButton::clicked signal.

Gtk.Button::clicked

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

Gtk.Button::enter

Emitted when the pointer enters the button.

Deprecated since: 2.8

Gtk.Button::leave

Emitted when the pointer leaves the button.

Deprecated since: 2.8

Gtk.Button::pressed

Emitted when the button is pressed.

Deprecated since: 2.8

Gtk.Button::released

Emitted when the button is released.

Deprecated since: 2.8

Signals inherited from GtkContainer (4)
Gtk.Container::add
No description available.
Gtk.Container::check-resize
No description available.
Gtk.Container::remove
No description available.
Gtk.Container::set-focus-child
No description available.
Signals inherited from GtkWidget (69)
Gtk.Widget::accel-closures-changed
No description available.
Gtk.Widget::button-press-event

The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed.

Gtk.Widget::button-release-event

The ::button-release-event signal will be emitted when a button (typically from a mouse) is released.

Gtk.Widget::can-activate-accel

Determines whether an accelerator that activates the signal identified by signal_id can currently be activated. This signal is present to allow applications and derived widgets to override the default GtkWidget handling for determining whether an accelerator can be activated.

Gtk.Widget::child-notify

The ::child-notify signal is emitted for each [child property][child-properties] that has changed on an object. The signal’s detail holds the property name.

Gtk.Widget::composited-changed

The ::composited-changed signal is emitted when the composited status of widgets screen changes. See gdk_screen_is_composited().

Deprecated since: 3.22

Gtk.Widget::configure-event

The ::configure-event signal will be emitted when the size, position or stacking of the widgets window has changed.

Gtk.Widget::damage-event

Emitted when a redirected window belonging to widget gets drawn into. The region/area members of the event shows what area of the redirected drawable was drawn into.

Available since: 2.14

Gtk.Widget::delete-event

The ::delete-event signal is emitted if a user requests that a toplevel window is closed. The default handler for this signal destroys the window. Connecting gtk_widget_hide_on_delete() to this signal will cause the window to be hidden instead, so that it can later be shown again without reconstructing it.

Gtk.Widget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold. May result in finalization of the widget if all references are released.

Gtk.Widget::destroy-event

The ::destroy-event signal is emitted when a GdkWindow is destroyed. You rarely get this signal, because most widgets disconnect themselves from their window before they destroy it, so no widget owns the window at destroy time.

Gtk.Widget::direction-changed

The ::direction-changed signal is emitted when the text direction of a widget changes.

Gtk.Widget::drag-begin

The ::drag-begin signal is emitted on the drag source when a drag is started. A typical reason to connect to this signal is to set up a custom drag icon with e.g. gtk_drag_source_set_icon_pixbuf().

Gtk.Widget::drag-data-delete

The ::drag-data-delete signal is emitted on the drag source when a drag with the action GDK_ACTION_MOVE is successfully completed. The signal handler is responsible for deleting the data that has been dropped. What “delete” means depends on the context of the drag operation.

Gtk.Widget::drag-data-get

The ::drag-data-get signal is emitted on the drag source when the drop site requests the data which is dragged. It is the responsibility of the signal handler to fill data with the data in the format which is indicated by info. See gtk_selection_data_set() and gtk_selection_data_set_text().

Gtk.Widget::drag-data-received

The ::drag-data-received signal is emitted on the drop site when the dragged data has been received. If the data was received in order to determine whether the drop will be accepted, the handler is expected to call gdk_drag_status() and not finish the drag. If the data was received in response to a GtkWidget::drag-drop signal (and this is the last target to be received), the handler for this signal is expected to process the received data and then call gtk_drag_finish(), setting the success parameter depending on whether the data was processed successfully.

Gtk.Widget::drag-drop

The ::drag-drop signal is emitted on the drop site when the user drops the data onto the widget. The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns FALSE and no further processing is necessary. Otherwise, the handler returns TRUE. In this case, the handler must ensure that gtk_drag_finish() is called to let the source know that the drop is done. The call to gtk_drag_finish() can be done either directly or in a GtkWidget::drag-data-received handler which gets triggered by calling gtk_drag_get_data() to receive the data for one or more of the supported targets.

Gtk.Widget::drag-end

The ::drag-end signal is emitted on the drag source when a drag is finished. A typical reason to connect to this signal is to undo things done in GtkWidget::drag-begin.

Gtk.Widget::drag-failed

The ::drag-failed signal is emitted on the drag source when a drag has failed. The signal handler may hook custom code to handle a failed DnD operation based on the type of error, it returns TRUE is the failure has been already handled (not showing the default “drag operation failed” animation), otherwise it returns FALSE.

Available since: 2.12

Gtk.Widget::drag-leave

The ::drag-leave signal is emitted on the drop site when the cursor leaves the widget. A typical reason to connect to this signal is to undo things done in GtkWidget::drag-motion, e.g. undo highlighting with gtk_drag_unhighlight().

Gtk.Widget::drag-motion

The ::drag-motion signal is emitted on the drop site when the user moves the cursor over the widget during a drag. The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns FALSE and no further processing is necessary. Otherwise, the handler returns TRUE. In this case, the handler is responsible for providing the necessary information for displaying feedback to the user, by calling gdk_drag_status().

Gtk.Widget::draw

This signal is emitted when a widget is supposed to render itself. The widgets top left corner must be painted at the origin of the passed in context and be sized to the values returned by gtk_widget_get_allocated_width() and gtk_widget_get_allocated_height().

Available since: 3.0

Gtk.Widget::enter-notify-event

The ::enter-notify-event will be emitted when the pointer enters the widgets window.

Gtk.Widget::event

The GTK+ main loop will emit three signals for each GDK event delivered to a widget: one generic ::event signal, another, more specific, signal that matches the type of event delivered (e.g. GtkWidget::key-press-event) and finally a generic GtkWidget::event-after signal.

Gtk.Widget::event-after

After the emission of the GtkWidget::event signal and (optionally) the second more specific signal, ::event-after will be emitted regardless of the previous two signals handlers return values.

Gtk.Widget::focus
No description available.
Gtk.Widget::focus-in-event

The ::focus-in-event signal will be emitted when the keyboard focus enters the widgets window.

Gtk.Widget::focus-out-event

The ::focus-out-event signal will be emitted when the keyboard focus leaves the widgets window.

Gtk.Widget::grab-broken-event

Emitted when a pointer or keyboard grab on a window belonging to widget gets broken.

Available since: 2.8

Gtk.Widget::grab-focus
No description available.
Gtk.Widget::grab-notify

The ::grab-notify signal is emitted when a widget becomes shadowed by a GTK+ grab (not a pointer or keyboard grab) on another widget, or when it becomes unshadowed due to a grab being removed.

Gtk.Widget::hide

The ::hide signal is emitted when widget is hidden, for example with gtk_widget_hide().

Gtk.Widget::hierarchy-changed

The ::hierarchy-changed signal is emitted when the anchored state of a widget changes. A widget is “anchored” when its toplevel ancestor is a GtkWindow. This signal is emitted when a widget changes from un-anchored to anchored or vice-versa.

Gtk.Widget::key-press-event

The ::key-press-event signal is emitted when a key is pressed. The signal emission will reoccur at the key-repeat rate when the key is kept pressed.

Gtk.Widget::key-release-event

The ::key-release-event signal is emitted when a key is released.

Gtk.Widget::keynav-failed

Gets emitted if keyboard navigation fails. See gtk_widget_keynav_failed() for details.

Available since: 2.12

Gtk.Widget::leave-notify-event

The ::leave-notify-event will be emitted when the pointer leaves the widgets window.

Gtk.Widget::map

The ::map signal is emitted when widget is going to be mapped, that is when the widget is visible (which is controlled with gtk_widget_set_visible()) and all its parents up to the toplevel widget are also visible. Once the map has occurred, GtkWidget::map-event will be emitted.

Gtk.Widget::map-event

The ::map-event signal will be emitted when the widgets window is mapped. A window is mapped when it becomes visible on the screen.

Gtk.Widget::mnemonic-activate

The default handler for this signal activates widget if group_cycling is FALSE, or just makes widget grab focus if group_cycling is TRUE.

Gtk.Widget::motion-notify-event

The ::motion-notify-event signal is emitted when the pointer moves over the widget’s GdkWindow.

Gtk.Widget::move-focus
No description available.
Gtk.Widget::parent-set

The ::parent-set signal is emitted when a new parent has been set on a widget.

Gtk.Widget::popup-menu

This signal gets emitted whenever a widget should pop up a context menu. This usually happens through the standard key binding mechanism; by pressing a certain key while a widget is focused, the user can cause the widget to pop up a menu. For example, the GtkEntry widget creates a menu with clipboard commands. See the [Popup Menu Migration Checklist][checklist-popup-menu] for an example of how to use this signal.

Gtk.Widget::property-notify-event

The ::property-notify-event signal will be emitted when a property on the widgets window has been changed or deleted.

Gtk.Widget::proximity-in-event

To receive this signal the GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_IN_MASK mask.

Gtk.Widget::proximity-out-event

To receive this signal the GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_OUT_MASK mask.

Gtk.Widget::query-tooltip

Emitted when GtkWidget:has-tooltip is TRUE and the hover timeout has expired with the cursor hovering “above” widget; or emitted when widget got focus in keyboard mode.

Available since: 2.12

Gtk.Widget::realize

The ::realize signal is emitted when widget is associated with a GdkWindow, which means that gtk_widget_realize() has been called or the widget has been mapped (that is, it is going to be drawn).

Gtk.Widget::screen-changed

The ::screen-changed signal gets emitted when the screen of a widget has changed.

Gtk.Widget::scroll-event

The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.

Gtk.Widget::selection-clear-event

The ::selection-clear-event signal will be emitted when the the widgets window has lost ownership of a selection.

Gtk.Widget::selection-get
No description available.
Gtk.Widget::selection-notify-event
No description available.
Gtk.Widget::selection-received
No description available.
Gtk.Widget::selection-request-event

The ::selection-request-event signal will be emitted when another client requests ownership of the selection owned by the widgets window.

Gtk.Widget::show

The ::show signal is emitted when widget is shown, for example with gtk_widget_show().

Gtk.Widget::show-help
No description available.
Gtk.Widget::size-allocate
No description available.
Gtk.Widget::state-changed

The ::state-changed signal is emitted when the widget state changes. See gtk_widget_get_state().

Deprecated since: 3.0

Gtk.Widget::state-flags-changed

The ::state-flags-changed signal is emitted when the widget state changes, see gtk_widget_get_state_flags().

Available since: 3.0

Gtk.Widget::style-set

The ::style-set signal is emitted when a new style has been set on a widget. Note that style-modifying functions like gtk_widget_modify_base() also cause this signal to be emitted.

Deprecated since: 3.0

Gtk.Widget::style-updated

The ::style-updated signal is a convenience signal that is emitted when the GtkStyleContext::changed signal is emitted on the widgets associated GtkStyleContext as returned by gtk_widget_get_style_context().

Available since: 3.0

Gtk.Widget::touch-event
No description available.
Gtk.Widget::unmap

The ::unmap signal is emitted when widget is going to be unmapped, which means that either it or any of its parents up to the toplevel widget have been set as hidden.

Gtk.Widget::unmap-event

The ::unmap-event signal will be emitted when the widgets window is unmapped. A window is unmapped when it becomes invisible on the screen.

Gtk.Widget::unrealize

The ::unrealize signal is emitted when the GdkWindow associated with widget is destroyed, which means that gtk_widget_unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Gtk.Widget::visibility-notify-event

The ::visibility-notify-event will be emitted when the widgets window is obscured or unobscured.

Deprecated since: 3.12

Gtk.Widget::window-state-event

The ::window-state-event will be emitted when the state of the toplevel window associated to the widget changes.

Signals inherited from GObject (1)
GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct GtkButtonClass {
  GtkBinClass parent_class;
  void (* pressed) (
    GtkButton* button
  );
  void (* released) (
    GtkButton* button
  );
  void (* clicked) (
    GtkButton* button
  );
  void (* enter) (
    GtkButton* button
  );
  void (* leave) (
    GtkButton* button
  );
  void (* activate) (
    GtkButton* button
  );
  void (* _gtk_reserved1) (
void
  );
  void (* _gtk_reserved2) (
void
  );
  void (* _gtk_reserved3) (
void
  );
  void (* _gtk_reserved4) (
void
  );
  
}
No description available.
Class members
parent_class
GtkBinClass
 

The parent class.

pressed
void (* pressed) (
    GtkButton* button
  )
  No description available.
released
void (* released) (
    GtkButton* button
  )
  No description available.
clicked
void (* clicked) (
    GtkButton* button
  )
  No description available.
enter
void (* enter) (
    GtkButton* button
  )
  No description available.
leave
void (* leave) (
    GtkButton* button
  )
  No description available.
activate
void (* activate) (
    GtkButton* button
  )
  No description available.
_gtk_reserved1
void (* _gtk_reserved1) (
void
  )
  No description available.
_gtk_reserved2
void (* _gtk_reserved2) (
void
  )
  No description available.
_gtk_reserved3
void (* _gtk_reserved3) (
void
  )
  No description available.
_gtk_reserved4
void (* _gtk_reserved4) (
void
  )
  No description available.

Virtual methods

Gtk.ButtonClass.activate
No description available.
Gtk.ButtonClass.clicked

Emits a GtkButton::clicked signal to the given GtkButton.

Gtk.ButtonClass.enter

Emits a GtkButton::enter signal to the given GtkButton.

Deprecated since: 2.20

Gtk.ButtonClass.leave

Emits a GtkButton::leave signal to the given GtkButton.

Deprecated since: 2.20

Gtk.ButtonClass.pressed

Emits a GtkButton::pressed signal to the given GtkButton.

Deprecated since: 2.20

Gtk.ButtonClass.released

Emits a GtkButton::released signal to the given GtkButton.

Deprecated since: 2.20