forked from AuroraMiddleware/gtk
35af5c4eba
Wed Mar 7 13:24:57 2001 Tim Janik <timj@gtk.org> * gtk/*.c: marshaller fixes. * gtk/gtkmarshal.list: extreme cleanup. * gtk/gtktreeview.c (gtk_tree_view_class_init): disable interface param spec for now. * gtk/gtktexttag.c (gtk_text_tag_set_property): use g_value_get_boxed() where appliable. * gtk/gtktypeutils.[hc]: updates to GLib API changes. special cased autogenerated boxed types from gtktypebuiltins_ids.c which are not reference counted: GtkSelectionData, GdkEvent, GdkColor, GtkTextIter, PangoTabArray, PangoFontDescription, GtkTreeIter and GtkTreePath. Thu Mar 1 03:58:56 2001 Tim Janik <timj@gtk.org> * gtk/gtktreeselection.h: * gtk/gtktreemodel.c: * gtk/gtktreedatalist.[hc]: fixed includes. no gobject/* file should be included directly, and gobject/gmarshal.h as well as gtk/gtkmarshal.h even can't be included directly. * Makefile.am: grr, install gtk-config-2.0. * gtk/testgtk.c: * gtk/simple.c: * gtk/gtkmenu.c: * gtk/gtkitemfactory.c: use g_object_connect() instead of passing "*signal*::*" args to gtk_widget_set(). * gtk/gtktypeutils.[hc]: got rid of GTK_TYPE_SIGNAL. * gtk/*.c: removed trailer arg from property setters and getters. macro fixups. Thu Mar 1 04:01:57 2001 Tim Janik <timj@gtk.org> * test-gdk-pixbuf.c: fixed includes.
186 lines
4.3 KiB
Plaintext
186 lines
4.3 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_accel ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@uline_label:
|
|
@accel_group:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_button_new_stock ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@stock_id:
|
|
@accel_group:
|
|
@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
|
|
|
|
|
|
<!-- ##### 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>
|
|
The text within the child #GtkLabel of the #GtkButton. Only useful if
|
|
there is actually a #GtkLabel inside of the #GtkButton.
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkButton:relief ##### -->
|
|
<para>
|
|
The #GtkReliefStyle as outlined in gtk_button_set_relief().
|
|
</para>
|
|
|