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>
* gtk/gtktextmark.c:
......
......@@ -1623,7 +1623,7 @@ fi
# Checks for gtk-doc and docbook-tools
##################################################
GTK_DOC_CHECK([1.4])
GTK_DOC_CHECK([1.6])
AC_CHECK_PROG(DB2HTML, db2html, true, false)
AM_CONDITIONAL(HAVE_DOCBOOK, $DB2HTML)
......
......@@ -432,7 +432,7 @@ gtk_box_set_homogeneous (GtkBox *box,
* @box: a #GtkBox
*
* 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.
**/
......
......@@ -309,7 +309,7 @@ gtk_button_class_init (GtkButtonClass *klass)
*
* 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] =
g_signal_new (I_("pressed"),
......@@ -326,7 +326,7 @@ gtk_button_class_init (GtkButtonClass *klass)
*
* 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] =
g_signal_new (I_("released"),
......@@ -358,7 +358,7 @@ gtk_button_class_init (GtkButtonClass *klass)
*
* 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] =
g_signal_new (I_("enter"),
......@@ -375,7 +375,7 @@ gtk_button_class_init (GtkButtonClass *klass)
*
* 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] =
g_signal_new (I_("leave"),
......@@ -390,10 +390,10 @@ gtk_button_class_init (GtkButtonClass *klass)
* GtkButton::activate:
* @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.
* Applications should never connect to this signal, but use the
* "clicked" signal.
* #GtkButton::clicked signal.
*/
button_signals[ACTIVATE] =
g_signal_new (I_("activate"),
......@@ -438,8 +438,8 @@ gtk_button_class_init (GtkButtonClass *klass)
/**
* GtkButton:displace-focus:
*
* Whether the child_displacement_x/child_displacement_y properties should also
* affect the focus rectangle.
* Whether the child_displacement_x/child_displacement_y properties
* should also affect the focus rectangle.
*
* Since: 2.6
*/
......@@ -1651,7 +1651,7 @@ gtk_button_get_use_underline (GtkButton *button)
* @button: a #GtkButton
* @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.
*/
void
......@@ -1953,7 +1953,7 @@ gtk_button_grab_notify (GtkWidget *widget,
* @image: a widget to set as the image for the button
*
* 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
* gtk_widget_show() on @image yourself.
*
......
......@@ -262,7 +262,7 @@ gtk_container_class_init (GtkContainerClass *class)
/**
* gtk_container_child_type:
* @container: a #GtkContainer.
* @container: a #GtkContainer
*
* Returns the type of the children supported by the container.
*
......@@ -487,7 +487,7 @@ gtk_container_child_get_property (GtkContainer *container,
* @child: a widget which is a child of @container
* @first_property_name: the name of the first property to set
* @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.
**/
......@@ -610,7 +610,7 @@ gtk_container_child_set_property (GtkContainer *container,
* @widget: a widget to be placed inside @container
* @first_prop_name: the name of the first child property to set
* @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.
* See gtk_container_add() and gtk_container_child_set() for more details.
......@@ -650,7 +650,7 @@ gtk_container_add_with_properties (GtkContainer *container,
* @child: a widget which is a child of @container
* @first_prop_name: the name of the first property to set
* @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.
**/
......@@ -677,7 +677,7 @@ gtk_container_child_set (GtkContainer *container,
* @child: a widget which is a child of @container
* @first_prop_name: the name of the first property to get
* @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.
**/
......@@ -878,8 +878,8 @@ gtk_container_get_property (GObject *object,
/**
* gtk_container_set_border_width:
* @container: a #GtkContainer
* @border_width: amount of blank space to leave <emphasis>outside</emphasis> the container.
* Valid values are in the range 0-65535 pixels.
* @border_width: amount of blank space to leave <emphasis>outside</emphasis>
* the container. Valid values are in the range 0-65535 pixels.
*
* Sets the border width of the container.
*
......@@ -1003,8 +1003,8 @@ _gtk_container_dequeue_resize_handler (GtkContainer *container)
/**
* gtk_container_set_resize_mode:
* @container: a #GtkContainer.
* @resize_mode: the new resize mode.
* @container: a #GtkContainer
* @resize_mode: the new resize mode
*
* Sets the resize mode for the container.
*
......@@ -1053,8 +1053,8 @@ gtk_container_get_resize_mode (GtkContainer *container)
/**
* gtk_container_set_reallocate_redraws:
* @container: a #GtkContainer.
* @needs_redraws: the new value for the container's @reallocate_redraws flag.
* @container: a #GtkContainer
* @needs_redraws: the new value for the container's @reallocate_redraws flag
*
* Sets the @reallocate_redraws flag of the container to the given value.
*
......@@ -1263,7 +1263,7 @@ gtk_container_forall (GtkContainer *container,
* @callback: a callback
* @callback_data: callback user data
*
* Invokes @callback on each non-internal child of @container. See
* Invokes @callback on each non-internal child of @container. See
* gtk_container_forall() for details on what constitutes an
* "internal" child. Most applications should use
* gtk_container_foreach(), rather than gtk_container_forall().
......@@ -1354,7 +1354,7 @@ gtk_container_set_focus_child (GtkContainer *container,
/**
* gtk_container_get_children:
* @container: a #GtkContainer.
* @container: a #GtkContainer
*
* Returns the container's non-internal children. See
* gtk_container_forall() for details on what constitutes an "internal" child.
......@@ -1950,13 +1950,13 @@ gtk_container_focus_sort_left_right (GtkContainer *container,
* gtk_container_focus_sort:
* @container: a #GtkContainer
* @children: a list of descendents of @container (they don't
* have to be direct children.
* have to be direct children)
* @direction: focus direction
* @old_focus: widget to use for the starting position, or %NULL
* to determine this automatically.
* [ Note, this argument isn't used for GTK_DIR_TAB_*,
* which is the only @direction we use currently,
* so perhaps this argument should be removed ]
* (Note, this argument isn't used for GTK_DIR_TAB_*,
* which is the only @direction we use currently,
* so perhaps this argument should be removed)
*
* Sorts @children in the correct order for focusing with
* direction type @direction.
......@@ -2073,8 +2073,8 @@ chain_widget_destroyed (GtkWidget *widget,
/**
* gtk_container_set_focus_chain:
* @container: a #GtkContainer.
* @focusable_widgets: the new focus chain.
* @container: a #GtkContainer
* @focusable_widgets: the new focus chain
*
* Sets a focus chain, overriding the one computed automatically by GTK+.
*
......@@ -2165,7 +2165,7 @@ gtk_container_get_focus_chain (GtkContainer *container,
/**
* gtk_container_unset_focus_chain:
* @container: a #GtkContainer.
* @container: a #GtkContainer
*
* Removes a focus chain explicitly set with gtk_container_set_focus_chain().
**/
......@@ -2204,17 +2204,18 @@ gtk_container_unset_focus_chain (GtkContainer *container)
/**
* gtk_container_set_focus_vadjustment:
* @container: a #GtkContainer
* @adjustment: an adjustment which should be adjusted when the focus is moved among the
* descendents of @container
* @adjustment: an adjustment which should be adjusted when the focus
* is moved among the descendents of @container
*
* Hooks up an adjustment to focus handling in a container, so when a child of the
* container is focused, the adjustment is scrolled to show that widget. This function
* sets the vertical alignment. See gtk_scrolled_window_get_vadjustment() for a typical
* way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting
* Hooks up an adjustment to focus handling in a container, so when a
* child of the container is focused, the adjustment is scrolled to
* show that widget. This function sets the vertical alignment. See
* 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 adjustments have to be in pixel units and in the same coordinate system as the
* allocation for immediate children of the container.
* The adjustments have to be in pixel units and in the same coordinate
* system as the allocation for immediate children of the container.
*/
void
gtk_container_set_focus_vadjustment (GtkContainer *container,
......@@ -2238,7 +2239,7 @@ gtk_container_set_focus_vadjustment (GtkContainer *container,
* @container: a #GtkContainer
*
* 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
* none has been set.
......@@ -2258,17 +2259,18 @@ gtk_container_get_focus_vadjustment (GtkContainer *container)
/**
* gtk_container_set_focus_hadjustment:
* @container: a #GtkContainer
* @adjustment: an adjustment which should be adjusted when the focus is moved among the
* descendents of @container
* @adjustment: an adjustment which should be adjusted when the focus is
* moved among the descendents of @container
*
* Hooks up an adjustment to focus handling in a container, so when a child of the
* container is focused, the adjustment is scrolled to show that widget. This function
* sets the horizontal alignment. See gtk_scrolled_window_get_hadjustment() for a typical
* way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting
* Hooks up an adjustment to focus handling in a container, so when a child
* of the container is focused, the adjustment is scrolled to show that
* widget. This function sets the horizontal alignment. See gt
* 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 adjustments have to be in pixel units and in the same coordinate system as the
* allocation for immediate children of the container.
* The adjustments have to be in pixel units and in the same coordinate
* system as the allocation for immediate children of the container.
*/
void
gtk_container_set_focus_hadjustment (GtkContainer *container,
......@@ -2426,7 +2428,7 @@ gtk_container_unmap (GtkWidget *widget)
* the event's area with the child area, and sending the event.
*
* 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.
**/
void
......
......@@ -450,15 +450,15 @@ gtk_dialog_new_empty (const gchar *title,
* (#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
* text/response ID pairs should be listed, with a %NULL pointer ending
* the list. Button text can be either a stock ID such as
* #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
* enumeration. If the user clicks one of these dialog buttons,
* #GtkDialog will emit the "response" signal with the corresponding
* response ID. If a #GtkDialog receives the "delete_event" signal, it
* will emit "response" with a response ID of #GTK_RESPONSE_DELETE_EVENT.
* However, destroying a dialog does not emit the "response" signal;
* so be careful relying on "response" when using
* the #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
* #GtkDialog will emit the #GtkDialog::response signal with the corresponding
* response ID. If a #GtkDialog receives the #GtkWidget::delete-event signal,
* it will emit ::response with a response ID of #GTK_RESPONSE_DELETE_EVENT.
* However, destroying a dialog does not emit the ::response signal;
* so be careful relying on ::response when using the
* #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.
*
* Here's a simple example:
......@@ -541,11 +541,11 @@ action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
* @response_id: response ID for @child
*
* Adds an activatable widget to the action area of a #GtkDialog,
* connecting a signal handler that will emit the "response" signal on
* the dialog when the widget is activated. The widget is appended to
* the end of the dialog's action area. If you want to add a
* non-activatable widget, simply pack it into the
* <literal>action_area</literal> field of the #GtkDialog struct.
* connecting a signal handler that will emit the #GtkDialog::response
* signal on the dialog when the widget is activated. The widget is
* appended to the end of the dialog's action area. If you want to add a
* non-activatable widget, simply pack it into the @action_area field
* of the #GtkDialog struct.
**/
void
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
* 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
* end of the dialog's action area. The button widget is returned, but usually
* you don't need it.
* #GtkDialog::response signal with the given @response_id. The button is
* appended to the end of the dialog's action area. The button widget is
* returned, but usually you don't need it.
*
* Return value: the button widget that was added
**/
......@@ -821,10 +821,10 @@ gtk_dialog_get_has_separator (GtkDialog *dialog)
* @dialog: a #GtkDialog
* @response_id: response ID
*
* Emits the "response" signal with the given response ID. Used to
* indicate that the user has responded to the dialog in some way;
* Emits the #GtkDialog::response signal with the given response ID.
* 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
* "response" signal and take appropriate action.
* ::response signal and take appropriate action.
**/
void
gtk_dialog_response (GtkDialog *dialog,
......@@ -902,22 +902,23 @@ run_destroy_handler (GtkDialog *dialog, gpointer data)
* @dialog: a #GtkDialog
*
* 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
* to gtk_dialog_run(), gtk_dialog_returns #GTK_RESPONSE_NONE.
* Otherwise, it returns the response ID from the "response" signal emission.
* #GtkDialog::response signal, or is destroyed. If the dialog is
* destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns
* #GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the
* ::response signal emission.
*
* Before entering the recursive main loop, gtk_dialog_run() calls
* gtk_widget_show() on the dialog for you. Note that you still
* need to show any children of the dialog yourself.
*
* During gtk_dialog_run(), the default behavior of "delete_event" is
* disabled; if the dialog receives "delete_event", it will not be
* During gtk_dialog_run(), the default behavior of #GtkWidget::delete-event
* is disabled; if the dialog receives ::delete_event, it will not be
* destroyed as windows usually are, and gtk_dialog_run() will return
* #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog will be
* modal. You can force gtk_dialog_run() to return at any time by
* calling gtk_dialog_response() to emit the "response"
* signal. Destroying the dialog during gtk_dialog_run() is a very bad
* idea, because your post-run code won't know whether the dialog was
* destroyed or not.
* #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog
* will be modal. You can force gtk_dialog_run() to return at any time by
* calling gtk_dialog_response() to emit the ::response signal. Destroying
* the dialog during gtk_dialog_run() is a very bad idea, because your
* post-run code won't know whether the dialog was destroyed or not.
*
* After gtk_dialog_run() returns, you are responsible for hiding or
* destroying the dialog if you wish to do so.
......@@ -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
* @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
* setting is set to %TRUE, the dialog buttons are reordered according to
* the order of the response ids passed to this function.
* Sets an alternative button order. If the
* #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
* 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
* <ulink url="http://developer.gnome.org/projects/gup/hig/2.0/">Human
......@@ -1179,9 +1181,10 @@ gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
* @n_params: the number of response ids in @new_order
* @new_order: an array of response ids of @dialog's buttons
*
* Sets an alternative button order. If the gtk-alternative-button-order
* setting is set to %TRUE, the dialog buttons are reordered according to
* the order of the response ids in @new_order.
* Sets an alternative button order. If the
* #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
* 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.
*
......
......@@ -611,7 +611,8 @@ gtk_entry_class_init (GtkEntryClass *class)
/**
* 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
*/
......@@ -880,7 +881,7 @@ gtk_entry_class_init (GtkEntryClass *class)
/**
* 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
*/
......@@ -4439,7 +4440,6 @@ gtk_entry_get_visibility (GtkEntry *entry)
* 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
* no text on the screen as they type.
*
**/
void
gtk_entry_set_invisible_char (GtkEntry *entry,
......@@ -4460,7 +4460,7 @@ gtk_entry_set_invisible_char (GtkEntry *entry,
* @entry: a #GtkEntry
*
* 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
* show invisible text at all.
......@@ -4490,7 +4490,7 @@ gtk_entry_set_editable (GtkEntry *entry,
* See also gtk_editable_get_chars().
*
* Return value: a pointer to the contents of the widget as a
* string. This string points to internally allocated
* string. This string points to internally allocated
* storage in the widget and must not be freed, modified or
* stored.
**/
......@@ -4512,7 +4512,7 @@ gtk_entry_select_region (GtkEntry *entry,
/**
* gtk_entry_set_max_length:
* @entry: a #GtkEntry.
* @entry: a #GtkEntry
* @max: the maximum length of the entry, or 0 for no maximum.
* (other than the maximum length of entries.) The value passed in will
* be clamped to the range 0-65536.
......@@ -4566,8 +4566,7 @@ gtk_entry_get_max_length (GtkEntry *entry)
*
* (For experts: if @setting is %TRUE, the entry calls
* gtk_window_activate_default() on the window containing the entry, in
* the default handler for the "activate" signal.)
*
* the default handler for the #GtkWidget::activate signal.)
**/
void
gtk_entry_set_activates_default (GtkEntry *entry,
......@@ -4609,7 +4608,6 @@ gtk_entry_get_activates_default (GtkEntry *entry)
* <emphasis>request</emphasis>, the size can still be affected by
* how you pack the widget into containers. If @n_chars is -1, the
* size reverts to the default entry size.
*
**/
void
gtk_entry_set_width_chars (GtkEntry *entry,
......@@ -4718,7 +4716,7 @@ gtk_entry_set_inner_border (GtkEntry *entry,
* gtk_entry_get_inner_border:
* @entry: a #GtkEntry
*
* This function returns the entry's inner-border property. See
* This function returns the entry's #GtkEntry:inner-border property. See
* gtk_entry_set_inner_border() for more information.
*
* Return value: the entry's #GtkBorder, or %NULL if none was set.
......@@ -4856,7 +4854,6 @@ gtk_entry_text_index_to_layout_index (GtkEntry *entry,
* gtk_entry_layout_index_to_text_index() and
* gtk_entry_text_index_to_layout_index() are needed to convert byte
* indices in the layout to byte indices in the entry contents.
*
**/
void
gtk_entry_get_layout_offsets (GtkEntry *entry,
......@@ -6027,8 +6024,8 @@ connect_completion_signals (GtkEntry *entry,
/**
* gtk_entry_set_completion:
* @entry: A #GtkEntry.
* @completion: The #GtkEntryCompletion or %NULL.
* @entry: A #GtkEntry
* @completion: The #GtkEntryCompletion or %NULL
*
* Sets @completion to be the auxiliary completion object to use with @entry.
* All further configuration of the completion mechanism is done on
......@@ -6084,7 +6081,7 @@ gtk_entry_set_completion (GtkEntry *entry,
/**
* gtk_entry_get_completion:
* @entry: A #GtkEntry.
* @entry: A #GtkEntry
*
* Returns the auxiliary completion object currently in use by @entry.
*
......@@ -6108,8 +6105,8 @@ gtk_entry_get_completion (GtkEntry *entry)
/**
* gtk_entry_set_cursor_hadjustment:
* @entry: a #GtkEntry
* @adjustment: an adjustment which should be adjusted when the cursor is moved,
* or %NULL
* @adjustment: an adjustment which should be adjusted when the cursor
* is moved, or %NULL
*
* Hooks up an adjustment to the cursor position in an entry, so that when
* the cursor is moved, the adjustment is scrolled to show that position.
......
......@@ -192,8 +192,8 @@ gtk_image_class_init (GtkImageClass *class)
/**
* GtkImage:pixel-size:
*
* The :pixel-size property can be used to specify a fixed size
* overriding the :icon-size property for images of type
* The "pixel-size" property can be used to specify a fixed size
* overriding the #GtkImage:icon-size property for images of type
* %GTK_IMAGE_ICON_NAME.
*
* Since: 2.6
......@@ -218,7 +218,7 @@ gtk_image_class_init (GtkImageClass *class)
/**
* GtkImage:icon-name:
*
* The name of the icon in the icon theme. If the icon theme is
* The name of the icon in the icon theme. If the icon theme is
* changed, the image will be updated automatically.
*
* Since: 2.6
......@@ -489,8 +489,7 @@ gtk_image_new_from_pixmap (GdkPixmap *pixmap,
*
* Creates a #GtkImage widget displaying a @image with a @mask.
* A #GdkImage is a client-side image buffer in the pixel format of the
* current display.
* The #GtkImage does not assume a reference to the
* current display. The #GtkImage does not assume a reference to the
* image or mask; you still need to unref them if you own references.
* #GtkImage will add its own reference rather than adopting yours.
*
......@@ -553,9 +552,9 @@ gtk_image_new_from_file (const gchar *filename)
* pixbuf; you still need to unref it if you own references.
* #GtkImage will add its own reference rather than adopting yours.
*
* Note that this function just creates an #GtkImage from the pixbuf. The
* #GtkImage created will not react to state changes. Should you want that, you
* should use gtk_image_new_from_icon_set().
* Note that this function just creates an #GtkImage from the pixbuf. The
* #GtkImage created will not react to state changes. Should you want that,
* you should use gtk_image_new_from_icon_set().
*
* Return value: a new #GtkImage
**/
......@@ -615,7 +614,6 @@ gtk_image_new_from_stock (const gchar *stock_id,
* icon set; you still need to unref it if you own references.
* #GtkImage will add its own reference rather than adopting yours.
*
*
* Return value: a new #GtkImage
**/
GtkWidget*
......@@ -695,7 +693,6 @@ gtk_image_new_from_icon_name (const gchar *icon_name,
* @mask: a #GdkBitmap or %NULL
*
* See gtk_image_new_from_pixmap() for details.
*
**/
void
gtk_image_set_from_pixmap (GtkImage *image,
......@@ -747,7 +744,6 @@ gtk_image_set_from_pixmap (GtkImage *image,
* @mask: a #GdkBitmap or %NULL
*
* See gtk_image_new_from_image() for details.
*
**/
void
gtk_image_set_from_image (GtkImage *image,
......@@ -798,7 +794,6 @@ gtk_image_set_from_image (GtkImage *image,
* @filename: a filename or %NULL
*
* See gtk_image_new_from_file() for details.
*
**/
void
gtk_image_set_from_file (GtkImage *image,
......@@ -855,7 +850,6 @@ gtk_image_set_from_file (GtkImage *image,
* @pixbuf: a #GdkPixbuf or %NULL
*
* See gtk_image_new_from_pixbuf() for details.
*
**/
void
gtk_image_set_from_pixbuf (GtkImage *image,
......@@ -895,7 +889,6 @@ gtk_image_set_from_pixbuf (GtkImage *image,
* @size: a stock icon size
*
* See gtk_image_new_from_stock() for details.
*
**/
void
gtk_image_set_from_stock (GtkImage *image,
......@@ -939,7 +932,6 @@ gtk_image_set_from_stock (GtkImage *image,
* @size: a stock icon size
*
* See gtk_image_new_from_icon_set() for details.
*
**/
void
gtk_image_set_from_icon_set (GtkImage *image,
......@@ -1088,7 +1080,6 @@ gtk_image_get_storage_type (GtkImage *image)
* %GTK_IMAGE_PIXMAP (see gtk_image_get_storage_type()).
* The caller of this function does not own a reference to the
* returned pixmap and mask.
*
**/
void
gtk_image_get_pixmap (GtkImage *image,
......@@ -1138,7 +1129,6 @@ gtk_image_get_image (GtkImage *image,
* gtk_image_get_pixbuf:
* @image: a #GtkImage
*
*
* Gets the #GdkPixbuf being displayed by the #GtkImage.
* The storage type of the image must be %GTK_IMAGE_EMPTY or
* %GTK_IMAGE_PIXBUF (see gtk_image_get_storage_type()).
......@@ -1171,7 +1161,6 @@ gtk_image_get_pixbuf (GtkImage *image)
* %GTK_IMAGE_STOCK (see gtk_image_get_storage_type()).
* The returned string is owned by the #GtkImage and should not
* be freed.
*
**/
void
gtk_image_get_stock (GtkImage *image,
......@@ -1201,7 +1190,6 @@ gtk_image_get_stock (GtkImage *image,
* Gets the icon set and size being displayed by the #GtkImage.
* The storage type of the image must be %GTK_IMAGE_EMPTY or
* %GTK_IMAGE_ICON_SET (see gtk_image_get_storage_type()).
*
**/
void
gtk_image_get_icon_set (GtkImage *image,
......@@ -1223,7 +1211,6 @@ gtk_image_get_icon_set (GtkImage *image,
* gtk_image_get_animation:
* @image: a #GtkImage
*
*
* Gets the #GdkPixbufAnimation being displayed by the #GtkImage.
* The storage type of the image must be %GTK_IMAGE_EMPTY or
* %GTK_IMAGE_ANIMATION (see gtk_image_get_storage_type()).
......
......@@ -347,9 +347,9 @@ gtk_label_class_init (GtkLabelClass *class)
/**
* GtkLabel:wrap-mode:
*
* If line wrapping is on (see the wrap property) this controls how
* the line wrapping is done. The default is %PANGO_WRAP_WORD which means
* wrap on word boundaries.
* If line wrapping is on (see the #GtkLabel:wrap property) this controls
* how the line wrapping is done. The default is %PANGO_WRAP_WORD, which
* means wrap on word boundaries.
*
* Since: 2.10
*/
......@@ -409,15 +409,17 @@ gtk_label_class_init (GtkLabelClass *class)
/**
* GtkLabel:ellipsize:
*
* The preferred place to ellipsize the string, if the label does not have
* enough room to display the entire string, specified as a #PangoEllisizeMode.
* The preferred place to ellipsize the string, if the label does
* not have enough room to display the entire string, specified as a
* #PangoEllisizeMode.
*
* Note that setting this property to a value other than %PANGO_ELLIPSIZE_NONE
* has the side-effect that the label requests only enough space to display the
* ellipsis "...". In particular, this means that ellipsizing labels don't
* work well in notebook tabs, unless the tab's ::tab-expand property is set
* to %TRUE. Other means to set a label's width are
* gtk_widget_set_size_request() and gtk_label_set_width_chars().
* Note that setting this property to a value other than
* %PANGO_ELLIPSIZE_NONE has the side-effect that the label requests
* only enough space to display the ellipsis "...". In particular, this
* means that ellipsizing labels do not work well in notebook tabs, unless
* the tab's #GtkNotebook:tab-expand property is set to %TRUE. Other ways
* to set a label's width are gtk_widget_set_size_request() and
* gtk_label_set_width_chars().
*
* Since: 2.6
*/
......@@ -436,8 +438,8 @@ gtk_label_class_init (GtkLabelClass *class)
* The desired width of the label, in characters. If this property is set to
* -1, the width will be calculated automatically, otherwise the label will
* request either 3 characters or the property value, whichever is greater.
* If the width-chars property is set to a positive value, then the
* max-width-chars property is ignored.
* If the "width-chars" property is set to a positive value, then the
* #GtkLabel:max-width-chars property is ignored.
*
* Since: 2.6
**/
......@@ -496,8 +498,8 @@ gtk_label_class_init (GtkLabelClass *class)
* The desired maximum width of the label, in characters. If this property
* is set to -1, the width will be calculated automatically, otherwise the
* label will request space for no more than the requested number of
* characters. If the width-chars property is set to a positive value,
* then the max-width-chars property is ignored.
* characters. If the #GtkLabel:width-chars property is set to a positive
* value, then the "max-width-chars" property is ignored.
*
* Since: 2.6
**/
......@@ -844,12 +846,11 @@ gtk_label_new (const gchar *str)
* to activate another widget, chosen automatically, or explicitly using
* gtk_label_set_mnemonic_widget().
*
* If gtk_label_set_mnemonic_widget()
* is not called, then the first activatable ancestor of the #GtkLabel
* will be chosen as the mnemonic widget. For instance, if the
* label is inside a button or menu item, the button or menu item will
* automatically become the mnemonic widget and be activated by
* the mnemonic.
* If gtk_label_set_mnemonic_widget() is not called, then the first
* activatable ancestor of the #GtkLabel will be chosen as the mnemonic
* widget. For instance, if the label is inside a button or menu item,
* the button or menu item will automatically become the mnemonic widget
* and be activated by the mnemonic.
*
* Return value: the new #GtkLabel
**/
......@@ -1056,7 +1057,7 @@ label_mnemonic_widget_weak_notify (gpointer data,
* @widget: the target #GtkWidget
*
* If the label has been set so that it has an mnemonic key (using
* i.e. gtk_label_set_markup_with_mnemonic(),
* i.e. gtk_label_set_markup_with_mnemonic(),
* gtk_label_set_text_with_mnemonic(), gtk_label_new_with_mnemonic()
* or the "use_underline" property) the label can be associated with a
* widget that is the target of the mnemonic. When the label is inside
......@@ -1065,9 +1066,10 @@ label_mnemonic_widget_weak_notify (gpointer data,
* (i.e. when the target is a #GtkEntry next to the label) you need to
* set it explicitly using this function.
*
* The target widget will be accelerated by emitting "mnemonic_activate" on it.
* The default handler for this signal will activate the widget if there are no
* mnemonic collisions and toggle focus between the colliding widgets otherwise.
* The target widget will be accelerated by emitting the
* GtkWidget::mnemonic-activate signal on it. The default handler for
* this signal will activate the widget if there are no mnemonic collisions
* and toggle focus between the colliding widgets otherwise.
**/
void
gtk_label_set_mnemonic_widget (GtkLabel *label,
......@@ -1101,7 +1103,7 @@ gtk_label_set_mnemonic_widget (GtkLabel *label,
* @label: a #GtkLabel
*
* Retrieves the target of the mnemonic (keyboard shortcut) of this
* label. See gtk_label_set_mnemonic_widget ().
* label. See gtk_label_set_mnemonic_widget().