Button

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool focus_on_click { set; get; }
• public Widget image { set; get; }
• public PositionType image_position { set; get; }
  The position of the image relative to the text inside the button.
• public string label { construct set; get; }
• public ReliefStyle relief { set; get; }
• public bool use_stock { construct set; get; }
• public bool use_underline { construct set; get; }
• public float xalign { set; get; }
  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.
• public float yalign { set; get; }
  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 top aligned, 1.0 is bottom aligned.

Creation methods:

• public Button ()
• public Button.from_stock (string stock_id)
  Creates a new Button containing the image and text from a stock item. Some stock ids have preprocessor macros like STOCK_OK and STOCK_APPLY.
• public Button.with_label (string label)
• public Button.with_mnemonic (string label)
  Creates a new Button 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.

Methods:

• public void get_alignment (out float xalign, out float yalign)
  Gets the alignment of the child in the button.
• public bool get_focus_on_click ()
  Returns whether the button grabs focus when it is clicked with the mouse. See set_focus_on_click.
• public weak Widget get_image ()
  Gets the widget that is currenty set as the image of button. This may have been explicitly set by set_image or constructed by Button.from_stock.
• public PositionType get_image_position ()
  Gets the position of the image relative to the text inside the button.
• public unowned string get_label ()
  Fetches the text from the label of the button, as set by 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 Button to use as a container.
• public ReliefStyle get_relief ()
• public bool get_use_stock ()
  Returns whether the button label is a stock item.
• public bool get_use_underline ()
  Returns whether an embedded underline in the button label indicates a mnemonic. See set_use_underline.
• public void set_alignment (float xalign, float yalign)
  Sets the alignment of the child. This property has no effect unless the child is a Misc or a GtkAligment.
• public void set_focus_on_click (bool 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.
• public void set_image (Widget image)
  Set the image of button to the given widget. Note that it depends on the GtkSettings:gtk-button-images setting whether the image will be displayed or not, you don't have to call gtk_widget_show on image yourself.
• public void set_image_position (PositionType position)
  Sets the position of the image relative to the text inside the button.
• public void set_label (string label)
  Sets the text of the label of the button to str. This text is also used to select the stock item if set_use_stock is used.
• public void set_relief (ReliefStyle newstyle)
• public void set_use_stock (bool use_stock)
  If true, the label set on the button is used as a stock id to select the stock item for the button.
• public void set_use_underline (bool 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.

Signals:

• public virtual void 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 clicked signal.
• public virtual void clicked ()
  Emitted when the button has been activated (pressed and released).
• public virtual void enter ()
  Emitted when the pointer enters the button.
• public virtual void leave ()
  Emitted when the pointer leaves the button.
• public virtual void pressed ()
  Emitted when the button is pressed.
• public virtual void released ()
  Emitted when the button is released.

Fields:

• public uint activate_timeout
• public uint button_down
• public uint constructed
• public uint depress_on_activate
• public uint depressed
• public weak Window event_window
• public uint in_button
• public unowned string label_text