gtk2/docs/reference/gtk/tmpl/gtkbutton.sgml

390 lines
6.0 KiB
Plaintext
Raw Normal View History

1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Title ##### -->
GtkButton
<!-- ##### SECTION Short_Description ##### -->
A widget that creates a signal when clicked on
1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkButton 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.
</para>
<para>
The #GtkButton widget can hold any valid child widget. That is it can
hold most any other standard #GtkWidget. The most commonly used child is
the #GtkLabel.
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
2005-06-20 22:06:27 +00:00
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
1999-08-16 18:51:52 +00:00
<!-- ##### STRUCT GtkButton ##### -->
<para>
This should not be accessed directly. Use the accessor functions below.
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### SIGNAL GtkButton::activate ##### -->
<para>
</para>
@button: the object which received the signal.
<!-- ##### SIGNAL GtkButton::clicked ##### -->
<para>
</para>
@button:
<!-- ##### SIGNAL GtkButton::enter ##### -->
<para>
</para>
@button:
<!-- ##### SIGNAL GtkButton::leave ##### -->
<para>
</para>
@button:
<!-- ##### SIGNAL GtkButton::pressed ##### -->
<para>
</para>
@button:
<!-- ##### SIGNAL GtkButton::released ##### -->
<para>
</para>
2006-05-05 16:21:19 +00:00
@button:
<!-- ##### ARG GtkButton:focus-on-click ##### -->
<para>
</para>
2004-12-16 18:21:44 +00:00
<!-- ##### ARG GtkButton:image ##### -->
<para>
</para>
2006-06-05 19:33:40 +00:00
<!-- ##### ARG GtkButton:image-position ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:label ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:relief ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:use-stock ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:use-underline ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:xalign ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:yalign ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:child-displacement-x ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:child-displacement-y ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:default-border ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:default-outside-border ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:displace-focus ##### -->
<para>
</para>
2006-06-05 19:33:40 +00:00
<!-- ##### ARG GtkButton:image-spacing ##### -->
<para>
</para>
2006-05-05 16:21:19 +00:00
<!-- ##### ARG GtkButton:inner-border ##### -->
<para>
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_button_new ##### -->
<para>
Creates a new #GtkButton widget. To add a child widget to the button,
use gtk_container_add().
1999-08-16 18:51:52 +00:00
</para>
@void:
1999-08-16 18:51:52 +00:00
@Returns: The newly created #GtkButton widget.
<!-- ##### FUNCTION gtk_button_new_with_label ##### -->
<para>
Creates a #GtkButton widget with a #GtkLabel child containing the given
text.
1999-08-16 18:51:52 +00:00
</para>
@label: The text you want the #GtkLabel to hold.
@Returns: The newly created #GtkButton widget.
<!-- ##### FUNCTION gtk_button_new_with_mnemonic ##### -->
<para>
</para>
@label:
@Returns:
<!-- ##### FUNCTION gtk_button_new_from_stock ##### -->
<para>
</para>
@stock_id:
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_button_pressed ##### -->
<para>
Emits a #GtkButton::pressed signal to the given #GtkButton.
1999-08-16 18:51:52 +00:00
</para>
@button: The #GtkButton you want to send the signal to.
@Deprecated: 2.20: Use the #GtkWidget::button-press-event signal.
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_button_released ##### -->
<para>
Emits a #GtkButton::released signal to the given #GtkButton.
1999-08-16 18:51:52 +00:00
</para>
@button: The #GtkButton you want to send the signal to.
@Deprecated: 2.20: Use the #GtkWidget::button-release-event signal.
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_button_clicked ##### -->
<para>
Emits a #GtkButton::clicked signal to the given #GtkButton.
1999-08-16 18:51:52 +00:00
</para>
@button: The #GtkButton you want to send the signal to.
<!-- ##### FUNCTION gtk_button_enter ##### -->
<para>
Emits a #GtkButton::enter signal to the given #GtkButton.
1999-08-16 18:51:52 +00:00
</para>
@button: The #GtkButton you want to send the signal to.
@Deprecated: 2.20: Use the #GtkWidget::enter-notify-event signal.
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_button_leave ##### -->
<para>
Emits a #GtkButton::leave signal to the given #GtkButton.
1999-08-16 18:51:52 +00:00
</para>
@button: The #GtkButton you want to send the signal to.
@Deprecated: 2.20: Use the #GtkWidget::leave-notify-event signal.
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_button_set_relief ##### -->
<para>
Sets the relief style of the edges of the given #GtkButton widget.
Three styles exist, GTK_RELIEF_NORMAL, GTK_RELIEF_HALF, GTK_RELIEF_NONE.
The default style is, as one can guess, GTK_RELIEF_NORMAL.
<!-- FIXME: put pictures of each style -->
1999-08-16 18:51:52 +00:00
</para>
@button: The #GtkButton you want to set relief styles of.
@newstyle: The GtkReliefStyle as described above.
<!-- ##### FUNCTION gtk_button_get_relief ##### -->
<para>
Returns the current relief style of the given #GtkButton.
1999-08-16 18:51:52 +00:00
</para>
@button: The #GtkButton you want the #GtkReliefStyle from.
@Returns: The current #GtkReliefStyle
<!-- ##### FUNCTION gtk_button_get_label ##### -->
<para>
</para>
@button:
@Returns:
<!-- ##### FUNCTION gtk_button_set_label ##### -->
<para>
</para>
@button:
@label:
<!-- ##### FUNCTION gtk_button_get_use_stock ##### -->
<para>
</para>
@button:
@Returns:
<!-- ##### FUNCTION gtk_button_set_use_stock ##### -->
<para>
</para>
@button:
@use_stock:
<!-- ##### FUNCTION gtk_button_get_use_underline ##### -->
<para>
</para>
@button:
@Returns:
<!-- ##### FUNCTION gtk_button_set_use_underline ##### -->
<para>
</para>
@button:
@use_underline:
<!-- ##### FUNCTION gtk_button_set_focus_on_click ##### -->
<para>
</para>
@button:
@focus_on_click:
<!-- ##### FUNCTION gtk_button_get_focus_on_click ##### -->
<para>
</para>
@button:
@Returns:
<!-- ##### FUNCTION gtk_button_set_alignment ##### -->
<para>
</para>
@button:
@xalign:
@yalign:
<!-- ##### FUNCTION gtk_button_get_alignment ##### -->
<para>
</para>
@button:
@xalign:
@yalign:
2005-06-20 22:06:27 +00:00
<!-- ##### FUNCTION gtk_button_set_image ##### -->
<para>
</para>
@button:
@image:
<!-- ##### FUNCTION gtk_button_get_image ##### -->
<para>
</para>
@button:
@Returns:
2006-06-05 19:33:40 +00:00
<!-- ##### FUNCTION gtk_button_set_image_position ##### -->
<para>
</para>
@button:
@position:
<!-- ##### FUNCTION gtk_button_get_image_position ##### -->
<para>
</para>
@button:
@Returns: