Synopsis

class gtk.Button(gtk.Bin):
    gtk.Button(label=None, stock=None, use_underline=True)
    def pressed()
    def released()
    def clicked()
    def enter()
    def leave()
    def set_relief(newstyle)
    def get_relief()
    def set_label(label)
    def get_label()
    def set_use_underline(use_underline)
    def get_use_underline()
    def set_use_stock(use_stock)
    def get_use_stock()
    def set_focus_on_click(focus_on_click)
    def get_focus_on_click()
    def set_alignment(xalign, yalign)
    def get_alignment()
    def set_image(image)
    def get_image()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.Button

Implemented Interfaces

gtk.Button implements gtk.Buildable

gtk.Button Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Button Style Properties

gtk.Widget Style Properties

gtk.Button Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

Description

The gtk.Button widget is usually displayed as a pushbutton with a text label (gtk.Label) though it can contain any valid widget. The gtk.Button is generally used to attach a callback function or method that is called when the button is clicked. Buttons generate signals that indicate:

The "clicked" signal is usually the only signal that an application needs to handle.

If a label is being used by the button its text (the "label" property) is retrieved using the get_label() method. The label text is changed using the set_label() method.

The property ("use_underline") that tells a button to use the first underscore to indicate a mnemonic key is changed using the set_use_underline(). method. It can be retrieved using the get_use_underline() method.

The button's relief style (the "relief" property) is retrieved using the method get_relief(). The relief style is set to one of gtk.RELIEF_NONE, gtk.RELIEF_HALF or gtk.RELIEF_NORMAL using the method set_relief().

Constructor

    gtk.Button(label=None, stock=None, use_underline=True)

Creates a new button widget with the content depending on the parameters: label, stock and use_underline. The default values for stock and label are None and, in PyGTK 2.4 and above, use_underline is available and defaults to True. If both label and stock are specified stock takes precedence. If neither is specified the button is created with no child widget. A child widget can be added later with the add() method.

If stock is specified the "use-stock" property will be set to True.

If label is specified the "label" property will be set with the text of the label, the "use_underline" property will be set to True and any characters that are preceded by an underscore are underlined (use two underscores to insert an underscore in a label). The first underscored character will become the mnemonic character used as the keyboard accelerator for the button when pressed simultaneously with the Alt key. In PyGTK 2.4 and above the "use-underline" property can be set by using the optional use_underline parameter.

Methods

    def pressed()

    def released()

    def clicked()

    def enter()

    def leave()

    def set_relief(newstyle)

    def get_relief()

    def set_label(label)

    def get_label()

    def set_use_underline(use_underline)

    def get_use_underline()

    def set_use_stock(use_stock)

    def get_use_stock()

    def set_focus_on_click(focus_on_click)

    def get_focus_on_click()

    def set_alignment(xalign, yalign)

    def get_alignment()

    def set_image(image)

    def get_image()

Signals

    def callback(button, user_param1, ...)

    def callback(button, user_param1, ...)

    def callback(button, user_param1, ...)

    def callback(button, user_param1, ...)

    def callback(button, user_param1, ...)

    def callback(button, user_param1, ...)