Fix up docs

This commit is contained in:
Matthias Clasen 2010-10-23 23:02:40 +02:00
parent d7653e7c0c
commit 520a6aeb8f
9 changed files with 110 additions and 19 deletions

View File

@ -89,6 +89,7 @@ GTK_IS_ACCEL_GROUP_CLASS
GTK_ACCEL_GROUP_GET_CLASS
<SUBSECTION Private>
GTK_ACCEL_GROUP_GET_PRIVATE
GtkAccelGroupPrivate
GtkAccelGroupEntry
gtk_accel_group_get_type
@ -163,6 +164,7 @@ GTK_ACCESSIBLE_GET_CLASS
GTK_IS_ACCESSIBLE
GTK_IS_ACCESSIBLE_CLASS
<SUBSECTION Private>
GtkAccessiblePrivate
gtk_accessible_get_type
</SECTION>
@ -397,6 +399,7 @@ GTK_ARROW_CLASS
GTK_IS_ARROW_CLASS
GTK_ARROW_GET_CLASS
<SUBSECTION Private>
GtkArrowPrivate
gtk_arrow_get_type
</SECTION>
@ -668,6 +671,7 @@ gtk_check_menu_item_get_type
GtkColorButton
gtk_color_button_new
gtk_color_button_new_with_color
gtk_color_button_new_with_rgba
gtk_color_button_set_color
gtk_color_button_get_color
gtk_color_button_set_alpha
@ -804,6 +808,8 @@ gtk_combo_box_get_button_sensitivity
gtk_combo_box_get_has_entry
gtk_combo_box_set_entry_text_column
gtk_combo_box_get_entry_text_column
gtk_combo_box_set_popup_fixed_width
gtk_combo_box_get_popup_fixed_width
<SUBSECTION Standard>
GTK_TYPE_COMBO_BOX
GTK_COMBO_BOX
@ -969,6 +975,7 @@ GTK_TYPE_EDITABLE
GTK_EDITABLE_CLASS
GTK_IS_EDITABLE_CLASS
GTK_EDITABLE_GET_CLASS
GTK_EDITABLE_GET_IFACE
<SUBSECTION Private>
gtk_editable_get_type
</SECTION>
@ -984,6 +991,7 @@ gtk_entry_set_buffer
gtk_entry_set_text
gtk_entry_get_text
gtk_entry_get_text_length
gtk_entry_get_text_area
gtk_entry_set_visibility
gtk_entry_set_invisible_char
gtk_entry_unset_invisible_char
@ -1039,6 +1047,7 @@ gtk_entry_set_icon_tooltip_markup
gtk_entry_get_icon_tooltip_markup
gtk_entry_set_icon_drag_source
gtk_entry_get_current_icon_drag_source
gtk_entry_get_icon_area
<SUBSECTION Standard>
GTK_ENTRY
@ -3401,9 +3410,7 @@ gtk_text_view_new
gtk_text_view_new_with_buffer
gtk_text_view_set_buffer
gtk_text_view_get_buffer
gtk_text_view_set_hadjustment
gtk_text_view_get_hadjustment
gtk_text_view_set_vadjustment
gtk_text_view_get_vadjustment
gtk_text_view_scroll_to_mark
gtk_text_view_scroll_to_iter
@ -3830,9 +3837,8 @@ gtk_tool_palette_get_drop_item
GtkToolPaletteDragTargets
gtk_tool_palette_set_drag_source
gtk_tool_palette_get_hadjustment
gtk_tool_palette_set_hadjustment
gtk_tool_palette_get_vadjustment
gtk_tool_palette_set_vadjustment
<SUBSECTION Standard>
GtkToolPaletteClass
GTK_TOOL_PALETTE
@ -4330,6 +4336,7 @@ gtk_cell_view_set_displayed_row
gtk_cell_view_get_displayed_row
gtk_cell_view_get_size_of_row
gtk_cell_view_set_background_color
gtk_cell_view_set_background_rgba
<SUBSECTION Standard>
GtkCellViewClass
GTK_TYPE_CELL_VIEW
@ -5020,6 +5027,7 @@ gtk_window_activate_focus
gtk_window_activate_default
gtk_window_set_modal
gtk_window_set_default_size
gtk_window_set_default_geometry
gtk_window_set_geometry_hints
gtk_window_set_gravity
gtk_window_get_gravity
@ -5098,6 +5106,7 @@ gtk_window_move
gtk_window_parse_geometry
gtk_window_reshow_with_initial_size
gtk_window_resize
gtk_window_resize_to_geometry
gtk_window_set_default_icon_list
gtk_window_set_default_icon
gtk_window_set_default_icon_from_file
@ -5113,8 +5122,9 @@ gtk_window_get_mnemonics_visible
gtk_window_set_mnemonics_visible
gtk_window_set_has_resize_grip
gtk_window_get_has_resize_grip
gtk_window_get_resize_grip_is_visible
gtk_window_resize_grip_is_visible
gtk_window_get_resize_grip_area
gtk_window_get_application
gtk_window_set_application
<SUBSECTION Standard>
@ -5409,6 +5419,7 @@ GTK_TYPE_TARGET_LIST
<SUBSECTION Private>
gtk_selection_data_get_type
gtk_target_list_get_type
gtk_target_entry_get_type
</SECTION>
<SECTION>

View File

@ -754,6 +754,7 @@ gtk_color_button_get_type G_GNUC_CONST
gtk_color_button_get_use_alpha
gtk_color_button_new
gtk_color_button_new_with_color
gtk_color_button_new_with_rgba
gtk_color_button_set_alpha
gtk_color_button_set_color
gtk_color_button_set_title

View File

@ -537,6 +537,16 @@ gtk_color_button_new_with_color (const GdkColor *color)
return g_object_new (GTK_TYPE_COLOR_BUTTON, "color", color, NULL);
}
/**
* gtk_color_button_new_with_rgba:
* @rgba: A #GdkRGBA to set the current color with.
*
* Creates a new color button.
*
* Returns: a new color button
*
* Since: 3.0
*/
GtkWidget *
gtk_color_button_new_with_rgba (const GdkRGBA *rgba)
{

View File

@ -5871,14 +5871,14 @@ gtk_combo_box_set_title (GtkComboBox *combo_box,
* @combo_box: a #GtkComboBox
* @fixed: whether to use a fixed popup width
*
* Specifies whether the popup's width should be a fixed width matching
* the allocated width of the combo box.
* Specifies whether the popup's width should be a fixed width
* matching the allocated width of the combo box.
*
* Since: 3.0
**/
void
gtk_combo_box_set_popup_fixed_width (GtkComboBox *combo_box,
gboolean fixed)
gboolean fixed)
{
g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
@ -5894,9 +5894,11 @@ gtk_combo_box_set_popup_fixed_width (GtkComboBox *combo_box,
* gtk_combo_box_get_popup_fixed_width:
* @combo_box: a #GtkComboBox
*
* Gets whether the popup uses a fixed width matching
* Gets whether the popup uses a fixed width matching
* the allocated width of the combo box.
*
* Returns: %TRUE if the popup uses a fixed width
*
* Since: 3.0
**/
gboolean

View File

@ -6660,9 +6660,11 @@ gtk_entry_set_buffer (GtkEntry *entry,
* @entry: a #GtkEntry
* @text_area: Return location for the text area.
*
* Returns the area where the entry's text is drawn. This function is
* Gets the area where the entry's text is drawn. This function is
* useful when drawing something to the entry in a draw callback.
*
* If the entry is not realized, @text_area is filled with zeros.
*
* See also gtk_entry_get_icon_area().
*
* Since: 3.0
@ -8111,10 +8113,13 @@ gtk_entry_get_current_icon_drag_source (GtkEntry *entry)
* @icon_pos: Icon position
* @icon_area: Return location for the icon's area
*
* Returns the area where entry's icon at @icon_pos is drawn.
* Gets the area where entry's icon at @icon_pos is drawn.
* This function is useful when drawing something to the
* entry in a draw callback.
*
* If the entry is not realized or has no icon at the given position,
* @icon_area is filled with zeros.
*
* See also gtk_entry_get_text_area()
*
* Since: 3.0

View File

@ -74,7 +74,7 @@ void gtk_grid_attach (GtkGrid *grid,
gint width,
gint height);
void gtk_grid_attach_next_to (GtkGrid *grid,
GtkWidget *widget,
GtkWidget *child,
GtkWidget *sibling,
GtkPositionType side,
gint width,

View File

@ -2181,6 +2181,16 @@ gtk_scrolled_window_get_preferred_width_for_height (GtkWidget *widget,
GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, minimum_width, natural_width);
}
/**
* gtk_scrolled_window_get_min_content_width:
* @scrolled_window: a #GtkScrolledWindow
*
* Gets the minimum content width of @scrolled_window, or -1 if not set.
*
* Returns: the minimum content width
*
* Since: 3.0
*/
gint
gtk_scrolled_window_get_min_content_width (GtkScrolledWindow *scrolled_window)
{
@ -2189,9 +2199,20 @@ gtk_scrolled_window_get_min_content_width (GtkScrolledWindow *scrolled_window)
return scrolled_window->priv->min_content_width;
}
/**
* gtk_scrolled_window_set_min_content_width:
* @scrolled_window: a #GtkScrolledWindow
* @width: the minimal content width
*
* Sets the minimum width that @scrolled_window should keep visible.
* Note that this can and (usually will) be smaller than the minimum
* size of the content.
*
* Since: 3.0
*/
void
gtk_scrolled_window_set_min_content_width (GtkScrolledWindow *scrolled_window,
gint min_content_width)
gint width)
{
GtkScrolledWindowPrivate *priv;
@ -2199,9 +2220,9 @@ gtk_scrolled_window_set_min_content_width (GtkScrolledWindow *scrolled_window,
priv = scrolled_window->priv;
if (priv->min_content_width != min_content_width)
if (priv->min_content_width != width)
{
priv->min_content_width = min_content_width;
priv->min_content_width = width;
gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
@ -2209,6 +2230,16 @@ gtk_scrolled_window_set_min_content_width (GtkScrolledWindow *scrolled_window,
}
}
/**
* gtk_scrolled_window_get_min_content_height:
* @scrolled_window: a #GtkScrolledWindow
*
* Gets the minimal content height of @scrolled_window, or -1 if not set.
*
* Returns: the minimal content height
*
* Since: 3.0
*/
gint
gtk_scrolled_window_get_min_content_height (GtkScrolledWindow *scrolled_window)
{
@ -2217,9 +2248,20 @@ gtk_scrolled_window_get_min_content_height (GtkScrolledWindow *scrolled_window)
return scrolled_window->priv->min_content_height;
}
/**
* gtk_scrolled_window_set_min_content_height:
* @scrolled_window: a #GtkScrolledWindow
* @height: the minimal content height
*
* Sets the minimum height that @scrolled_window should keep visible.
* Note that this can and (usually will) be smaller than the minimum
* size of the content.
*
* Since: 3.0
*/
void
gtk_scrolled_window_set_min_content_height (GtkScrolledWindow *scrolled_window,
gint min_content_height)
gint height)
{
GtkScrolledWindowPrivate *priv;
@ -2227,9 +2269,9 @@ gtk_scrolled_window_set_min_content_height (GtkScrolledWindow *scrolled_window,
priv = scrolled_window->priv;
if (priv->min_content_height != min_content_height)
if (priv->min_content_height != height)
{
priv->min_content_height = min_content_height;
priv->min_content_height = height;
gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));

View File

@ -934,7 +934,7 @@ gtk_table_get_homogeneous (GtkTable *table)
* @columns: (out) (allow-none): return location for the number
* of columns, or %NULL
*
* Returns the number of rows and columns in the table.
* Gets the number of rows and columns in the table.
*
* Since: 2.22
**/

View File

@ -11204,6 +11204,16 @@ gtk_widget_update_computed_expand (GtkWidget *widget)
}
}
/**
* gtk_widget_queue_compute_expand:
* @widget: a #GtkWidget
*
* Mark @widget as needing to recompute its expand flags. Call
* this function when setting legacy expand child properties
* on the child of a container.
*
* See gtk_widget_compute_expand().
*/
void
gtk_widget_queue_compute_expand (GtkWidget *widget)
{
@ -13146,6 +13156,16 @@ gtk_widget_send_focus_change (GtkWidget *widget,
return res;
}
/**
* gtk_widget_in_destruction:
* @widget: a #GtkWidget
*
* Returns whether the widget is currently being destroyed.
* This information can sometimes be used to avoid doing
* unnecessary work.
*
* Returns: %TRUE if @widget is being destroyed
*/
gboolean
gtk_widget_in_destruction (GtkWidget *widget)
{