77eee887f3
2002-08-10 Soren Sandmann <sandmann@daimi.au.dk> * docs/reference/gtk/tree_widget.sgml, docs/reference/gtk/tmpl/gtkdialog.sgml, docs/reference/gtk/tmpl/gtkentry.sgml, docs/reference/gtk/tmpl/gtkfilesel.sgml, docs/reference/gtk/tmpl/gtkfontsel.sgml, docs/reference/gtk/tmpl/gtkfontseldlg.sgml, docs/reference/gtk/tmpl/gtktreemodel.sgml, docs/reference/gtk/tmpl/gtkwidget.sgml, gdk/x11/gdkdisplay-x11.c, gtk/gtkbbox.c, gtk/gtkbox.c, gtk/gtkbutton.c, gtk/gtkcellrenderer.c, gtk/gtkcellrendererpixbuf.c, gtk/gtkcellrenderertext.c, gtk/gtkcheckmenuitem.c, gtk/gtkcontainer.c, gtk/gtkcurve.c, gtk/gtkdialog.h, gtk/gtkentry.c, gtk/gtkfilesel.c, gtk/gtkfontsel.c, gtk/gtkframe.c, gtk/gtkhandlebox.c, gtk/gtkiconfactory.c, gtk/gtkimage.c, gtk/gtkinvisible.c, gtk/gtkitemfactory.c, gtk/gtklabel.c, gtk/gtklayout.c, gtk/gtkmenu.c, gtk/gtkprogress.c, gtk/gtkprogressbar.c, gtk/gtkscrolledwindow.c, gtk/gtksizegroup.c, gtk/gtktable.c, gtk/gtktextiter.c, gtk/gtktexttag.c, gtk/gtktexttag.h, gtk/gtktextview.c, gtk/gtktogglebutton.c, gtk/gtktoolbar.c, gtk/gtktreemodel.c, gtk/gtktreeselection.c, gtk/gtktreestore.c, gtk/gtktreeview.c, gtk/gtktreeviewcolumn.c, gtk/gtkviewport.c, gtk/gtkwidget.c, gtk/gtkwidget.h, gtk/gtkwindow.c: Minor documentation fixes (#89254, patch from Brett Nash; #85809, patch from daten@dnetc.org; #76391, patch from Ross Burton; #74559, Manuel Clos; #73569, #72005, Alexey A. Malyshev; #70061, patch from Dennis Bj"orklund; #64566, #63388, #58328, #57499, #81007, #77349, Vitaly Tishkov; #78932, Vitaly Tishkov, patch from Ross Burton; #73306)
271 lines
5.0 KiB
Plaintext
271 lines
5.0 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GtkButton
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
A widget that creates a signal when clicked on.
|
|
|
|
<!-- ##### 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.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GtkButton ##### -->
|
|
<para>
|
|
This should not be accessed directly. Use the accessor functions below.
|
|
</para>
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_button_new ##### -->
|
|
<para>
|
|
Creates a new #GtkButton widget.
|
|
</para>
|
|
|
|
@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.
|
|
</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:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_button_pressed ##### -->
|
|
<para>
|
|
Emits a #GtkButton::pressed signal to the given #GtkButton.
|
|
</para>
|
|
|
|
@button: The #GtkButton you want to send the signal to.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_button_released ##### -->
|
|
<para>
|
|
Emits a #GtkButton::released signal to the given #GtkButton.
|
|
</para>
|
|
|
|
@button: The #GtkButton you want to send the signal to.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_button_clicked ##### -->
|
|
<para>
|
|
Emits a #GtkButton::clicked signal to the given #GtkButton.
|
|
</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.
|
|
</para>
|
|
|
|
@button: The #GtkButton you want to send the signal to.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_button_leave ##### -->
|
|
<para>
|
|
Emits a #GtkButton::leave signal to the given #GtkButton.
|
|
</para>
|
|
|
|
@button: The #GtkButton you want to send the signal to.
|
|
|
|
|
|
<!-- ##### 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 -->
|
|
</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.
|
|
</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:
|
|
<!-- # Unused Parameters # -->
|
|
@value:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_button_get_use_underline ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@button:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_button_set_use_underline ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@button:
|
|
@use_underline:
|
|
<!-- # Unused Parameters # -->
|
|
@value:
|
|
|
|
|
|
<!-- ##### SIGNAL GtkButton::activate ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@button: the object which received the signal.
|
|
|
|
<!-- ##### SIGNAL GtkButton::clicked ##### -->
|
|
<para>
|
|
Emitted when a button clicked on by the mouse and the cursor stays on the
|
|
button. If the cursor is not on the button when the mouse button is released,
|
|
the signal is not emitted.
|
|
</para>
|
|
|
|
@button: the object which received the signal.
|
|
|
|
<!-- ##### SIGNAL GtkButton::enter ##### -->
|
|
<para>
|
|
Emitted when the mouse cursor enters the region of the button.
|
|
</para>
|
|
|
|
@button: the object which received the signal.
|
|
|
|
<!-- ##### SIGNAL GtkButton::leave ##### -->
|
|
<para>
|
|
Emitted when the mouse cursor leaves the region of the button.
|
|
</para>
|
|
|
|
@button: the object which received the signal.
|
|
|
|
<!-- ##### SIGNAL GtkButton::pressed ##### -->
|
|
<para>
|
|
Emitted when the button is initially pressed.
|
|
</para>
|
|
|
|
@button: the object which received the signal.
|
|
|
|
<!-- ##### SIGNAL GtkButton::released ##### -->
|
|
<para>
|
|
Emitted when a button which is pressed is released, no matter where the
|
|
mouse cursor is.
|
|
</para>
|
|
|
|
@button: the object which received the signal.
|
|
|
|
<!-- ##### ARG GtkButton:label ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkButton:relief ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkButton:use-underline ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkButton:use-stock ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkButton:child-displacement-y ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkButton:child-displacement-x ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkButton:default-border ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkButton:default-outside-border ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|