Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

actionName?: string
actionTarget?: GLib.Variant
active?: boolean

The state of the button. This is reflecting the state of the associated #GAction.

alwaysShowImage?: boolean

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

Use this property if the button would be useless or hard to use without the image.

appPaintable?: boolean
borderWidth?: number
canDefault?: boolean
canFocus?: boolean
centered?: boolean

Whether to render the button contents centered instead of left-aligned. This property should be set for title-like items.

child?: Gtk.Widget
doubleBuffered?: boolean

Whether the widget is double buffered.

events?: Gdk.EventMask
expand?: boolean

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

focusOnClick?: boolean

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

This property is only relevant for widgets that can take focus.

Before 3.20, several widgets (GtkButton, GtkFileChooserButton, GtkComboBox) implemented this property individually.

halign?: Gtk.Align

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

hasDefault?: boolean
hasFocus?: boolean
hasTooltip?: boolean

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.

Note that setting this property to %TRUE for the first time will change the event masks of the GdkWindows of this widget to include leave-notify and motion-notify events. This cannot and will not be undone when the property is set to %FALSE again.

heightRequest?: number
hexpand?: boolean

Whether to expand horizontally. See gtk_widget_set_hexpand().

hexpandSet?: boolean

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

icon?: Gio.Icon

A #GIcon that will be used if iconic appearance for the button is desired.

iconic?: boolean

If this property is set, the button will show an icon if one is set. If no icon is set, the text will be used. This is typically used for horizontal sections of linked buttons.

image?: Gtk.Widget

The child widget to appear next to the button text.

imagePosition?: Gtk.PositionType

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

inverted?: boolean

Whether to show the submenu indicator at the opposite side than normal. This property should be set for model buttons that 'go back' to a parent menu.

isFocus?: boolean
label?: string
margin?: number

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

marginBottom?: number

Margin on bottom side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

marginEnd?: number

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

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

marginLeft?: number

Margin on left side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

marginRight?: number

Margin on right side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

marginStart?: number

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

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

marginTop?: number

Margin on top side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

menuName?: string

The name of a submenu to open when the button is activated. If this is set, the button should not have an action associated with it.

name?: string
noShowAll?: boolean
opacity?: number

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

Before 3.8 this was only available in GtkWindow

parent?: Gtk.Container
receivesDefault?: boolean
relatedAction?: Gtk.Action

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

#GtkActivatable implementors need to handle the this property and call gtk_activatable_do_set_related_action() when it changes.

relief?: Gtk.ReliefStyle
resizeMode?: Gtk.ResizeMode
role?: ButtonRole

Specifies whether the button is a plain, check or radio button. When #GtkActionable:action-name is set, the role will be determined from the action and does not have to be set explicitly.

sensitive?: boolean
style?: Gtk.Style

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

text?: string

The label for the button.

tooltipMarkup?: string

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

This is a convenience property which will take care of getting the tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip will automatically be set to %TRUE and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup are set, the last one wins.

tooltipText?: string

Sets the text of tooltip to be the given string.

Also see gtk_tooltip_set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip will automatically be set to %TRUE and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup are set, the last one wins.

useActionAppearance?: boolean

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

See the #GtkAction documentation directly to find which properties should be ignored by the #GtkActivatable when this property is %FALSE.

#GtkActivatable implementors need to handle this property and call gtk_activatable_sync_action_properties() on the activatable widget when it changes.

useMarkup?: boolean

If %TRUE, XML tags in the text of the button are interpreted as by pango_parse_markup() to format the enclosed spans of text. If %FALSE, the text will be displayed verbatim.

useStock?: boolean
useUnderline?: boolean
valign?: Gtk.Align

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

vexpand?: boolean

Whether to expand vertically. See gtk_widget_set_vexpand().

vexpandSet?: boolean

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

visible?: boolean
widthRequest?: number
xalign?: number

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.

yalign?: number

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.

Legend

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