Commit b80b5260 authored by Matthias Clasen's avatar Matthias Clasen Committed by Matthias Clasen

Require gtk-doc 1.6, for signal and property links.

2007-05-26  Matthias Clasen  <mclasen@redhat.com>

        * configure.in: Require gtk-doc 1.6, for signal and property links.
        * gtk/gtkbox.c:
        * gtk/gtkbutton.c:
        * gtk/gtkcontainer.c:
        * gtk/gtkdialog.c:
        * gtk/gtkentry.c:
        * gtk/gtkimage.c:
        * gtk/gtklabel.c:
        * gtk/gtkmisc.c:
        * gtk/gtksettings.c:
        * gtk/gtkwidget.c: Documentation improvements, link signals
        and properties where it makes sense.

svn path=/trunk/; revision=17924
parent d8e3fc2b
2007-05-26 Matthias Clasen <mclasen@redhat.com>
* configure.in: Require gtk-doc 1.6, for signal and property links.
* gtk/gtkbox.c:
* gtk/gtkbutton.c:
* gtk/gtkcontainer.c:
* gtk/gtkdialog.c:
* gtk/gtkentry.c:
* gtk/gtkimage.c:
* gtk/gtklabel.c:
* gtk/gtkmisc.c:
* gtk/gtksettings.c:
* gtk/gtkwidget.c: Documentation improvements, link signals
and properties where it makes sense.
2007-05-25 Matthias Clasen <mclasen@redhat.com> 2007-05-25 Matthias Clasen <mclasen@redhat.com>
* gtk/gtktextmark.c: * gtk/gtktextmark.c:
......
...@@ -1623,7 +1623,7 @@ fi ...@@ -1623,7 +1623,7 @@ fi
# Checks for gtk-doc and docbook-tools # Checks for gtk-doc and docbook-tools
################################################## ##################################################
GTK_DOC_CHECK([1.4]) GTK_DOC_CHECK([1.6])
AC_CHECK_PROG(DB2HTML, db2html, true, false) AC_CHECK_PROG(DB2HTML, db2html, true, false)
AM_CONDITIONAL(HAVE_DOCBOOK, $DB2HTML) AM_CONDITIONAL(HAVE_DOCBOOK, $DB2HTML)
......
...@@ -432,7 +432,7 @@ gtk_box_set_homogeneous (GtkBox *box, ...@@ -432,7 +432,7 @@ gtk_box_set_homogeneous (GtkBox *box,
* @box: a #GtkBox * @box: a #GtkBox
* *
* Returns whether the box is homogeneous (all children are the * Returns whether the box is homogeneous (all children are the
* same size). See gtk_box_set_homogeneous (). * same size). See gtk_box_set_homogeneous().
* *
* Return value: %TRUE if the box is homogeneous. * Return value: %TRUE if the box is homogeneous.
**/ **/
......
...@@ -309,7 +309,7 @@ gtk_button_class_init (GtkButtonClass *klass) ...@@ -309,7 +309,7 @@ gtk_button_class_init (GtkButtonClass *klass)
* *
* Emitted when the button is pressed. * Emitted when the button is pressed.
* *
* @Deprecated: Use the GtkWidget::button-press-event signal. * @Deprecated: Use the #GtkWidget::button-press-event signal.
*/ */
button_signals[PRESSED] = button_signals[PRESSED] =
g_signal_new (I_("pressed"), g_signal_new (I_("pressed"),
...@@ -326,7 +326,7 @@ gtk_button_class_init (GtkButtonClass *klass) ...@@ -326,7 +326,7 @@ gtk_button_class_init (GtkButtonClass *klass)
* *
* Emitted when the button is released. * Emitted when the button is released.
* *
* @Deprecated: Use the GtkWidget::button-release-event signal. * @Deprecated: Use the #GtkWidget::button-release-event signal.
*/ */
button_signals[RELEASED] = button_signals[RELEASED] =
g_signal_new (I_("released"), g_signal_new (I_("released"),
...@@ -358,7 +358,7 @@ gtk_button_class_init (GtkButtonClass *klass) ...@@ -358,7 +358,7 @@ gtk_button_class_init (GtkButtonClass *klass)
* *
* Emitted when the pointer enters the button. * Emitted when the pointer enters the button.
* *
* @Deprecated: Use the GtkWidget::enter-notify-event signal. * @Deprecated: Use the #GtkWidget::enter-notify-event signal.
*/ */
button_signals[ENTER] = button_signals[ENTER] =
g_signal_new (I_("enter"), g_signal_new (I_("enter"),
...@@ -375,7 +375,7 @@ gtk_button_class_init (GtkButtonClass *klass) ...@@ -375,7 +375,7 @@ gtk_button_class_init (GtkButtonClass *klass)
* *
* Emitted when the pointer leaves the button. * Emitted when the pointer leaves the button.
* *
* @Deprecated: Use the GtkWidget::leave-notify-event signal. * @Deprecated: Use the #GtkWidget::leave-notify-event signal.
*/ */
button_signals[LEAVE] = button_signals[LEAVE] =
g_signal_new (I_("leave"), g_signal_new (I_("leave"),
...@@ -390,10 +390,10 @@ gtk_button_class_init (GtkButtonClass *klass) ...@@ -390,10 +390,10 @@ gtk_button_class_init (GtkButtonClass *klass)
* GtkButton::activate: * GtkButton::activate:
* @widget: the object which received the signal. * @widget: the object which received the signal.
* *
* The "activate" signal on GtkButton is an action signal and * The ::activate signal on GtkButton is an action signal and
* emitting it causes the button to animate press then release. * emitting it causes the button to animate press then release.
* Applications should never connect to this signal, but use the * Applications should never connect to this signal, but use the
* "clicked" signal. * #GtkButton::clicked signal.
*/ */
button_signals[ACTIVATE] = button_signals[ACTIVATE] =
g_signal_new (I_("activate"), g_signal_new (I_("activate"),
...@@ -438,8 +438,8 @@ gtk_button_class_init (GtkButtonClass *klass) ...@@ -438,8 +438,8 @@ gtk_button_class_init (GtkButtonClass *klass)
/** /**
* GtkButton:displace-focus: * GtkButton:displace-focus:
* *
* Whether the child_displacement_x/child_displacement_y properties should also * Whether the child_displacement_x/child_displacement_y properties
* affect the focus rectangle. * should also affect the focus rectangle.
* *
* Since: 2.6 * Since: 2.6
*/ */
...@@ -1651,7 +1651,7 @@ gtk_button_get_use_underline (GtkButton *button) ...@@ -1651,7 +1651,7 @@ gtk_button_get_use_underline (GtkButton *button)
* @button: a #GtkButton * @button: a #GtkButton
* @use_stock: %TRUE if the button should use a stock item * @use_stock: %TRUE if the button should use a stock item
* *
* If true, the label set on the button is used as a * If %TRUE, the label set on the button is used as a
* stock id to select the stock item for the button. * stock id to select the stock item for the button.
*/ */
void void
...@@ -1953,7 +1953,7 @@ gtk_button_grab_notify (GtkWidget *widget, ...@@ -1953,7 +1953,7 @@ gtk_button_grab_notify (GtkWidget *widget,
* @image: a widget to set as the image for the button * @image: a widget to set as the image for the button
* *
* Set the image of @button to the given widget. Note that * Set the image of @button to the given widget. Note that
* it depends on the gtk-button-images setting whether the * it depends on the #GtkSettings:gtk-button-images setting whether the
* image will be displayed or not, you don't have to call * image will be displayed or not, you don't have to call
* gtk_widget_show() on @image yourself. * gtk_widget_show() on @image yourself.
* *
......
...@@ -262,7 +262,7 @@ gtk_container_class_init (GtkContainerClass *class) ...@@ -262,7 +262,7 @@ gtk_container_class_init (GtkContainerClass *class)
/** /**
* gtk_container_child_type: * gtk_container_child_type:
* @container: a #GtkContainer. * @container: a #GtkContainer
* *
* Returns the type of the children supported by the container. * Returns the type of the children supported by the container.
* *
...@@ -487,7 +487,7 @@ gtk_container_child_get_property (GtkContainer *container, ...@@ -487,7 +487,7 @@ gtk_container_child_get_property (GtkContainer *container,
* @child: a widget which is a child of @container * @child: a widget which is a child of @container
* @first_property_name: the name of the first property to set * @first_property_name: the name of the first property to set
* @var_args: a %NULL-terminated list of property names and values, starting * @var_args: a %NULL-terminated list of property names and values, starting
* with @first_prop_name. * with @first_prop_name
* *
* Sets one or more child properties for @child and @container. * Sets one or more child properties for @child and @container.
**/ **/
...@@ -610,7 +610,7 @@ gtk_container_child_set_property (GtkContainer *container, ...@@ -610,7 +610,7 @@ gtk_container_child_set_property (GtkContainer *container,
* @widget: a widget to be placed inside @container * @widget: a widget to be placed inside @container
* @first_prop_name: the name of the first child property to set * @first_prop_name: the name of the first child property to set
* @Varargs: a %NULL-terminated list of property names and values, starting * @Varargs: a %NULL-terminated list of property names and values, starting
* with @first_prop_name. * with @first_prop_name
* *
* Adds @widget to @container, setting child properties at the same time. * Adds @widget to @container, setting child properties at the same time.
* See gtk_container_add() and gtk_container_child_set() for more details. * See gtk_container_add() and gtk_container_child_set() for more details.
...@@ -650,7 +650,7 @@ gtk_container_add_with_properties (GtkContainer *container, ...@@ -650,7 +650,7 @@ gtk_container_add_with_properties (GtkContainer *container,
* @child: a widget which is a child of @container * @child: a widget which is a child of @container
* @first_prop_name: the name of the first property to set * @first_prop_name: the name of the first property to set
* @Varargs: a %NULL-terminated list of property names and values, starting * @Varargs: a %NULL-terminated list of property names and values, starting
* with @first_prop_name. * with @first_prop_name
* *
* Sets one or more child properties for @child and @container. * Sets one or more child properties for @child and @container.
**/ **/
...@@ -677,7 +677,7 @@ gtk_container_child_set (GtkContainer *container, ...@@ -677,7 +677,7 @@ gtk_container_child_set (GtkContainer *container,
* @child: a widget which is a child of @container * @child: a widget which is a child of @container
* @first_prop_name: the name of the first property to get * @first_prop_name: the name of the first property to get
* @Varargs: a %NULL-terminated list of property names and #GValue*, * @Varargs: a %NULL-terminated list of property names and #GValue*,
* starting with @first_prop_name. * starting with @first_prop_name
* *
* Gets the values of one or more child properties for @child and @container. * Gets the values of one or more child properties for @child and @container.
**/ **/
...@@ -878,8 +878,8 @@ gtk_container_get_property (GObject *object, ...@@ -878,8 +878,8 @@ gtk_container_get_property (GObject *object,
/** /**
* gtk_container_set_border_width: * gtk_container_set_border_width:
* @container: a #GtkContainer * @container: a #GtkContainer
* @border_width: amount of blank space to leave <emphasis>outside</emphasis> the container. * @border_width: amount of blank space to leave <emphasis>outside</emphasis>
* Valid values are in the range 0-65535 pixels. * the container. Valid values are in the range 0-65535 pixels.
* *
* Sets the border width of the container. * Sets the border width of the container.
* *
...@@ -1003,8 +1003,8 @@ _gtk_container_dequeue_resize_handler (GtkContainer *container) ...@@ -1003,8 +1003,8 @@ _gtk_container_dequeue_resize_handler (GtkContainer *container)
/** /**
* gtk_container_set_resize_mode: * gtk_container_set_resize_mode:
* @container: a #GtkContainer. * @container: a #GtkContainer
* @resize_mode: the new resize mode. * @resize_mode: the new resize mode
* *
* Sets the resize mode for the container. * Sets the resize mode for the container.
* *
...@@ -1053,8 +1053,8 @@ gtk_container_get_resize_mode (GtkContainer *container) ...@@ -1053,8 +1053,8 @@ gtk_container_get_resize_mode (GtkContainer *container)
/** /**
* gtk_container_set_reallocate_redraws: * gtk_container_set_reallocate_redraws:
* @container: a #GtkContainer. * @container: a #GtkContainer
* @needs_redraws: the new value for the container's @reallocate_redraws flag. * @needs_redraws: the new value for the container's @reallocate_redraws flag
* *
* Sets the @reallocate_redraws flag of the container to the given value. * Sets the @reallocate_redraws flag of the container to the given value.
* *
...@@ -1354,7 +1354,7 @@ gtk_container_set_focus_child (GtkContainer *container, ...@@ -1354,7 +1354,7 @@ gtk_container_set_focus_child (GtkContainer *container,
/** /**
* gtk_container_get_children: * gtk_container_get_children:
* @container: a #GtkContainer. * @container: a #GtkContainer
* *
* Returns the container's non-internal children. See * Returns the container's non-internal children. See
* gtk_container_forall() for details on what constitutes an "internal" child. * gtk_container_forall() for details on what constitutes an "internal" child.
...@@ -1950,13 +1950,13 @@ gtk_container_focus_sort_left_right (GtkContainer *container, ...@@ -1950,13 +1950,13 @@ gtk_container_focus_sort_left_right (GtkContainer *container,
* gtk_container_focus_sort: * gtk_container_focus_sort:
* @container: a #GtkContainer * @container: a #GtkContainer
* @children: a list of descendents of @container (they don't * @children: a list of descendents of @container (they don't
* have to be direct children. * have to be direct children)
* @direction: focus direction * @direction: focus direction
* @old_focus: widget to use for the starting position, or %NULL * @old_focus: widget to use for the starting position, or %NULL
* to determine this automatically. * to determine this automatically.
* [ Note, this argument isn't used for GTK_DIR_TAB_*, * (Note, this argument isn't used for GTK_DIR_TAB_*,
* which is the only @direction we use currently, * which is the only @direction we use currently,
* so perhaps this argument should be removed ] * so perhaps this argument should be removed)
* *
* Sorts @children in the correct order for focusing with * Sorts @children in the correct order for focusing with
* direction type @direction. * direction type @direction.
...@@ -2073,8 +2073,8 @@ chain_widget_destroyed (GtkWidget *widget, ...@@ -2073,8 +2073,8 @@ chain_widget_destroyed (GtkWidget *widget,
/** /**
* gtk_container_set_focus_chain: * gtk_container_set_focus_chain:
* @container: a #GtkContainer. * @container: a #GtkContainer
* @focusable_widgets: the new focus chain. * @focusable_widgets: the new focus chain
* *
* Sets a focus chain, overriding the one computed automatically by GTK+. * Sets a focus chain, overriding the one computed automatically by GTK+.
* *
...@@ -2165,7 +2165,7 @@ gtk_container_get_focus_chain (GtkContainer *container, ...@@ -2165,7 +2165,7 @@ gtk_container_get_focus_chain (GtkContainer *container,
/** /**
* gtk_container_unset_focus_chain: * gtk_container_unset_focus_chain:
* @container: a #GtkContainer. * @container: a #GtkContainer
* *
* Removes a focus chain explicitly set with gtk_container_set_focus_chain(). * Removes a focus chain explicitly set with gtk_container_set_focus_chain().
**/ **/
...@@ -2204,17 +2204,18 @@ gtk_container_unset_focus_chain (GtkContainer *container) ...@@ -2204,17 +2204,18 @@ gtk_container_unset_focus_chain (GtkContainer *container)
/** /**
* gtk_container_set_focus_vadjustment: * gtk_container_set_focus_vadjustment:
* @container: a #GtkContainer * @container: a #GtkContainer
* @adjustment: an adjustment which should be adjusted when the focus is moved among the * @adjustment: an adjustment which should be adjusted when the focus
* descendents of @container * is moved among the descendents of @container
* *
* Hooks up an adjustment to focus handling in a container, so when a child of the * Hooks up an adjustment to focus handling in a container, so when a
* container is focused, the adjustment is scrolled to show that widget. This function * child of the container is focused, the adjustment is scrolled to
* sets the vertical alignment. See gtk_scrolled_window_get_vadjustment() for a typical * show that widget. This function sets the vertical alignment. See
* way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting * gtk_scrolled_window_get_vadjustment() for a typical way of obtaining
* the adjustment and gtk_container_set_focus_hadjustment() for setting
* the horizontal adjustment. * the horizontal adjustment.
* *
* The adjustments have to be in pixel units and in the same coordinate system as the * The adjustments have to be in pixel units and in the same coordinate
* allocation for immediate children of the container. * system as the allocation for immediate children of the container.
*/ */
void void
gtk_container_set_focus_vadjustment (GtkContainer *container, gtk_container_set_focus_vadjustment (GtkContainer *container,
...@@ -2238,7 +2239,7 @@ gtk_container_set_focus_vadjustment (GtkContainer *container, ...@@ -2238,7 +2239,7 @@ gtk_container_set_focus_vadjustment (GtkContainer *container,
* @container: a #GtkContainer * @container: a #GtkContainer
* *
* Retrieves the vertical focus adjustment for the container. See * Retrieves the vertical focus adjustment for the container. See
* gtk_container_set_focus_vadjustment (). * gtk_container_set_focus_vadjustment().
* *
* Return value: the vertical focus adjustment, or %NULL if * Return value: the vertical focus adjustment, or %NULL if
* none has been set. * none has been set.
...@@ -2258,17 +2259,18 @@ gtk_container_get_focus_vadjustment (GtkContainer *container) ...@@ -2258,17 +2259,18 @@ gtk_container_get_focus_vadjustment (GtkContainer *container)
/** /**
* gtk_container_set_focus_hadjustment: * gtk_container_set_focus_hadjustment:
* @container: a #GtkContainer * @container: a #GtkContainer
* @adjustment: an adjustment which should be adjusted when the focus is moved among the * @adjustment: an adjustment which should be adjusted when the focus is
* descendents of @container * moved among the descendents of @container
* *
* Hooks up an adjustment to focus handling in a container, so when a child of the * Hooks up an adjustment to focus handling in a container, so when a child
* container is focused, the adjustment is scrolled to show that widget. This function * of the container is focused, the adjustment is scrolled to show that
* sets the horizontal alignment. See gtk_scrolled_window_get_hadjustment() for a typical * widget. This function sets the horizontal alignment. See gt
* way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting * k_scrolled_window_get_hadjustment() for a typical way of obtaining the
* adjustment and gtk_container_set_focus_vadjustment() for setting
* the vertical adjustment. * the vertical adjustment.
* *
* The adjustments have to be in pixel units and in the same coordinate system as the * The adjustments have to be in pixel units and in the same coordinate
* allocation for immediate children of the container. * system as the allocation for immediate children of the container.
*/ */
void void
gtk_container_set_focus_hadjustment (GtkContainer *container, gtk_container_set_focus_hadjustment (GtkContainer *container,
...@@ -2426,7 +2428,7 @@ gtk_container_unmap (GtkWidget *widget) ...@@ -2426,7 +2428,7 @@ gtk_container_unmap (GtkWidget *widget)
* the event's area with the child area, and sending the event. * the event's area with the child area, and sending the event.
* *
* In most cases, a container can simply either simply inherit the * In most cases, a container can simply either simply inherit the
* ::expose implementation from #GtkContainer, or, do some drawing * #GtkWidget::expose implementation from #GtkContainer, or, do some drawing
* and then chain to the ::expose implementation from #GtkContainer. * and then chain to the ::expose implementation from #GtkContainer.
**/ **/
void void
......
...@@ -453,12 +453,12 @@ gtk_dialog_new_empty (const gchar *title, ...@@ -453,12 +453,12 @@ gtk_dialog_new_empty (const gchar *title,
* #GTK_STOCK_OK, or some arbitrary text. A response ID can be * #GTK_STOCK_OK, or some arbitrary text. A response ID can be
* any positive number, or one of the values in the #GtkResponseType * any positive number, or one of the values in the #GtkResponseType
* enumeration. If the user clicks one of these dialog buttons, * enumeration. If the user clicks one of these dialog buttons,
* #GtkDialog will emit the "response" signal with the corresponding * #GtkDialog will emit the #GtkDialog::response signal with the corresponding
* response ID. If a #GtkDialog receives the "delete_event" signal, it * response ID. If a #GtkDialog receives the #GtkWidget::delete-event signal,
* will emit "response" with a response ID of #GTK_RESPONSE_DELETE_EVENT. * it will emit ::response with a response ID of #GTK_RESPONSE_DELETE_EVENT.
* However, destroying a dialog does not emit the "response" signal; * However, destroying a dialog does not emit the ::response signal;
* so be careful relying on "response" when using * so be careful relying on ::response when using the
* the #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right, * #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
* so the first button in the list will be the leftmost button in the dialog. * so the first button in the list will be the leftmost button in the dialog.
* *
* Here's a simple example: * Here's a simple example:
...@@ -541,11 +541,11 @@ action_widget_activated (GtkWidget *widget, GtkDialog *dialog) ...@@ -541,11 +541,11 @@ action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
* @response_id: response ID for @child * @response_id: response ID for @child
* *
* Adds an activatable widget to the action area of a #GtkDialog, * Adds an activatable widget to the action area of a #GtkDialog,
* connecting a signal handler that will emit the "response" signal on * connecting a signal handler that will emit the #GtkDialog::response
* the dialog when the widget is activated. The widget is appended to * signal on the dialog when the widget is activated. The widget is
* the end of the dialog's action area. If you want to add a * appended to the end of the dialog's action area. If you want to add a
* non-activatable widget, simply pack it into the * non-activatable widget, simply pack it into the @action_area field
* <literal>action_area</literal> field of the #GtkDialog struct. * of the #GtkDialog struct.
**/ **/
void void
gtk_dialog_add_action_widget (GtkDialog *dialog, gtk_dialog_add_action_widget (GtkDialog *dialog,
...@@ -598,9 +598,9 @@ gtk_dialog_add_action_widget (GtkDialog *dialog, ...@@ -598,9 +598,9 @@ gtk_dialog_add_action_widget (GtkDialog *dialog,
* *
* Adds a button with the given text (or a stock button, if @button_text is a * Adds a button with the given text (or a stock button, if @button_text is a
* stock ID) and sets things up so that clicking the button will emit the * stock ID) and sets things up so that clicking the button will emit the
* "response" signal with the given @response_id. The button is appended to the * #GtkDialog::response signal with the given @response_id. The button is
* end of the dialog's action area. The button widget is returned, but usually * appended to the end of the dialog's action area. The button widget is
* you don't need it. * returned, but usually you don't need it.
* *
* Return value: the button widget that was added * Return value: the button widget that was added
**/ **/
...@@ -821,10 +821,10 @@ gtk_dialog_get_has_separator (GtkDialog *dialog) ...@@ -821,10 +821,10 @@ gtk_dialog_get_has_separator (GtkDialog *dialog)
* @dialog: a #GtkDialog * @dialog: a #GtkDialog
* @response_id: response ID * @response_id: response ID
* *
* Emits the "response" signal with the given response ID. Used to * Emits the #GtkDialog::response signal with the given response ID.
* indicate that the user has responded to the dialog in some way; * Used to indicate that the user has responded to the dialog in some way;
* typically either you or gtk_dialog_run() will be monitoring the * typically either you or gtk_dialog_run() will be monitoring the
* "response" signal and take appropriate action. * ::response signal and take appropriate action.
**/ **/
void void
gtk_dialog_response (GtkDialog *dialog, gtk_dialog_response (GtkDialog *dialog,
...@@ -902,22 +902,23 @@ run_destroy_handler (GtkDialog *dialog, gpointer data) ...@@ -902,22 +902,23 @@ run_destroy_handler (GtkDialog *dialog, gpointer data)
* @dialog: a #GtkDialog * @dialog: a #GtkDialog
* *
* Blocks in a recursive main loop until the @dialog either emits the * Blocks in a recursive main loop until the @dialog either emits the
* response signal, or is destroyed. If the dialog is destroyed during the call * #GtkDialog::response signal, or is destroyed. If the dialog is
* to gtk_dialog_run(), gtk_dialog_returns #GTK_RESPONSE_NONE. * destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns
* Otherwise, it returns the response ID from the "response" signal emission. * #GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the
* ::response signal emission.
*
* Before entering the recursive main loop, gtk_dialog_run() calls * Before entering the recursive main loop, gtk_dialog_run() calls
* gtk_widget_show() on the dialog for you. Note that you still * gtk_widget_show() on the dialog for you. Note that you still
* need to show any children of the dialog yourself. * need to show any children of the dialog yourself.
* *
* During gtk_dialog_run(), the default behavior of "delete_event" is * During gtk_dialog_run(), the default behavior of #GtkWidget::delete-event
* disabled; if the dialog receives "delete_event", it will not be * is disabled; if the dialog receives ::delete_event, it will not be
* destroyed as windows usually are, and gtk_dialog_run() will return * destroyed as windows usually are, and gtk_dialog_run() will return
* #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog will be * #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog
* modal. You can force gtk_dialog_run() to return at any time by * will be modal. You can force gtk_dialog_run() to return at any time by
* calling gtk_dialog_response() to emit the "response" * calling gtk_dialog_response() to emit the ::response signal. Destroying
* signal. Destroying the dialog during gtk_dialog_run() is a very bad * the dialog during gtk_dialog_run() is a very bad idea, because your
* idea, because your post-run code won't know whether the dialog was * post-run code won't know whether the dialog was destroyed or not.
* destroyed or not.
* *
* After gtk_dialog_run() returns, you are responsible for hiding or * After gtk_dialog_run() returns, you are responsible for hiding or
* destroying the dialog if you wish to do so. * destroying the dialog if you wish to do so.
...@@ -1115,9 +1116,10 @@ gtk_dialog_set_alternative_button_order_valist (GtkDialog *dialog, ...@@ -1115,9 +1116,10 @@ gtk_dialog_set_alternative_button_order_valist (GtkDialog *dialog,
* @first_response_id: a response id used by one @dialog's buttons * @first_response_id: a response id used by one @dialog's buttons
* @Varargs: a list of more response ids of @dialog's buttons, terminated by -1 * @Varargs: a list of more response ids of @dialog's buttons, terminated by -1
* *
* Sets an alternative button order. If the gtk-alternative-button-order * Sets an alternative button order. If the
* setting is set to %TRUE, the dialog buttons are reordered according to * #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
* the order of the response ids passed to this function. * the dialog buttons are reordered according to the order of the
* response ids passed to this function.
* *
* By default, GTK+ dialogs use the button order advocated by the Gnome * By default, GTK+ dialogs use the button order advocated by the Gnome
* <ulink url="http://developer.gnome.org/projects/gup/hig/2.0/">Human * <ulink url="http://developer.gnome.org/projects/gup/hig/2.0/">Human
...@@ -1179,9 +1181,10 @@ gtk_dialog_set_alternative_button_order (GtkDialog *dialog, ...@@ -1179,9 +1181,10 @@ gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
* @n_params: the number of response ids in @new_order * @n_params: the number of response ids in @new_order
* @new_order: an array of response ids of @dialog's buttons * @new_order: an array of response ids of @dialog's buttons
* *
* Sets an alternative button order. If the gtk-alternative-button-order * Sets an alternative button order. If the
* setting is set to %TRUE, the dialog buttons are reordered according to * #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
* the order of the response ids in @new_order. * the dialog buttons are reordered according to the order of the
* response ids in @new_order.
* *
* See gtk_dialog_set_alternative_button_order() for more information. * See gtk_dialog_set_alternative_button_order() for more information.
* *
......
...@@ -611,7 +611,8 @@ gtk_entry_class_init (GtkEntryClass *class) ...@@ -611,7 +611,8 @@ gtk_entry_class_init (GtkEntryClass *class)
/** /**
* GtkEntry:shadow-type: * GtkEntry:shadow-type:
* *
* Which kind of shadow to draw around the entry when has-frame is set. * Which kind of shadow to draw around the entry when
* #GtkEntry:has-frame is set to %TRUE.
* *
* Since: 2.12 * Since: 2.12
*/ */
...@@ -880,7 +881,7 @@ gtk_entry_class_init (GtkEntryClass *class) ...@@ -880,7 +881,7 @@ gtk_entry_class_init (GtkEntryClass *class)
/** /**
* GtkEntry:inner-border: * GtkEntry:inner-border:
* *
* Sets the text area's border between the text and the frame * Sets the text area's border between the text and the frame.
* *
* Since: 2.10 * Since: 2.10
*/ */
...@@ -4439,7 +4440,6 @@ gtk_entry_get_visibility (GtkEntry *entry) ...@@ -4439,7 +4440,6 @@ gtk_entry_get_visibility (GtkEntry *entry)
* invisible char is an asterisk ('*'). If you set the invisible char * invisible char is an asterisk ('*'). If you set the invisible char
* to 0, then the user will get no feedback at all; there will be * to 0, then the user will get no feedback at all; there will be
* no text on the screen as they type. * no text on the screen as they type.
*
**/ **/
void void
gtk_entry_set_invisible_char (GtkEntry *entry, gtk_entry_set_invisible_char (GtkEntry *entry,
...@@ -4460,7 +4460,7 @@ gtk_entry_set_invisible_char (GtkEntry *entry, ...@@ -4460,7 +4460,7 @@ gtk_entry_set_invisible_char (GtkEntry *entry,
* @entry: a #GtkEntry * @entry: a #GtkEntry
* *
* Retrieves the character displayed in place of the real characters * Retrieves the character displayed in place of the real characters
* for entries with visisbility set to false. See gtk_entry_set_invisible_char(). * for entries with visibility set to false. See gtk_entry_set_invisible_char().
* *
* Return value: the current invisible char, or 0, if the entry does not * Return value: the current invisible char, or 0, if the entry does not
* show invisible text at all. * show invisible text at all.
...@@ -4512,7 +4512,7 @@ gtk_entry_select_region (GtkEntry *entry, ...@@ -4512,7 +4512,7 @@ gtk_entry_select_region (GtkEntry *entry,
/** /**
* gtk_entry_set_max_length: * gtk_entry_set_max_length:
* @entry: a #GtkEntry. * @entry: a #GtkEntry
* @max: the maximum length of the entry, or 0 for no maximum.