Add some missing symbols to the docs

This commit is contained in:
Matthias Clasen 2011-02-08 23:14:46 -05:00
parent 32398f11fa
commit 394ae46ec0
12 changed files with 85 additions and 39 deletions

View File

@ -2058,6 +2058,8 @@ gtk_menu_item_deselect
gtk_menu_item_activate gtk_menu_item_activate
gtk_menu_item_toggle_size_request gtk_menu_item_toggle_size_request
gtk_menu_item_toggle_size_allocate gtk_menu_item_toggle_size_allocate
gtk_menu_item_get_reserve_indicator
gtk_menu_item_set_reserve_indicator
<SUBSECTION Standard> <SUBSECTION Standard>
GTK_MENU_ITEM GTK_MENU_ITEM
GTK_IS_MENU_ITEM GTK_IS_MENU_ITEM
@ -4202,6 +4204,7 @@ gtk_tree_view_column_set_clickable
gtk_tree_view_column_get_clickable gtk_tree_view_column_get_clickable
gtk_tree_view_column_set_widget gtk_tree_view_column_set_widget
gtk_tree_view_column_get_widget gtk_tree_view_column_get_widget
gtk_tree_view_column_get_button
gtk_tree_view_column_set_alignment gtk_tree_view_column_set_alignment
gtk_tree_view_column_get_alignment gtk_tree_view_column_get_alignment
gtk_tree_view_column_set_reorderable gtk_tree_view_column_set_reorderable
@ -4286,6 +4289,7 @@ gtk_tree_view_row_expanded
gtk_tree_view_set_reorderable gtk_tree_view_set_reorderable
gtk_tree_view_get_reorderable gtk_tree_view_get_reorderable
gtk_tree_view_get_path_at_pos gtk_tree_view_get_path_at_pos
gtk_tree_view_is_blank_at_pos
gtk_tree_view_get_cell_area gtk_tree_view_get_cell_area
gtk_tree_view_get_background_area gtk_tree_view_get_background_area
gtk_tree_view_get_visible_rect gtk_tree_view_get_visible_rect
@ -5749,6 +5753,7 @@ gtk_style_new
gtk_style_copy gtk_style_copy
gtk_style_attach gtk_style_attach
gtk_style_detach gtk_style_detach
gtk_style_get_context
gtk_style_set_background gtk_style_set_background
gtk_style_apply_default_background gtk_style_apply_default_background
gtk_style_lookup_color gtk_style_lookup_color

View File

@ -753,14 +753,15 @@ gtk_app_chooser_button_append_custom_item (GtkAppChooserButton *self,
} }
/** /**
* gtk_app_chooser_button_select_custom_item: * gtk_app_chooser_button_set_active_custom_item:
* @self: a #GtkAppChooserButton * @self: a #GtkAppChooserButton
* @name: the name of the custom item * @name: the name of the custom item
* *
* Selects a custom item previously added with * Selects a custom item previously added with
* gtk_app_chooser_button_append_custom_item(). * gtk_app_chooser_button_append_custom_item().
* Use gtk_app_chooser_refresh() to bring the selection to its initial *
* state. * Use gtk_app_chooser_refresh() to bring the selection
* to its initial state.
* *
* Since: 3.0 * Since: 3.0
*/ */

View File

@ -41,13 +41,13 @@ typedef struct _GtkBorder GtkBorder;
/** /**
* GtkBorder: * GtkBorder:
* @left: The width of the left border. * @left: The width of the left border
* @right: The width of the right border. * @right: The width of the right border
* @top: The width of the top border. * @top: The width of the top border
* @bottom: The width of the bottom border. * @bottom: The width of the bottom border
* *
* A struct that specifies a border around a rectangular area that can * A struct that specifies a border around a rectangular area
* be of different width on each side. * that can be of different width on each side.
*/ */
struct _GtkBorder struct _GtkBorder
{ {

View File

@ -3100,9 +3100,11 @@ gtk_cell_area_remove_focus_sibling (GtkCellArea *area,
* @renderer: the #GtkCellRenderer expected to have focus * @renderer: the #GtkCellRenderer expected to have focus
* @sibling: the #GtkCellRenderer to check against @renderer's sibling list * @sibling: the #GtkCellRenderer to check against @renderer's sibling list
* *
* Returns %TRUE if @sibling is one of @renderer's focus siblings * Returns whether @sibling is one of @renderer's focus siblings
* (see gtk_cell_area_add_focus_sibling()). * (see gtk_cell_area_add_focus_sibling()).
* *
* Return value: %TRUE if @sibling is a focus sibling of @renderer
*
* Since: 3.0 * Since: 3.0
*/ */
gboolean gboolean

View File

@ -408,10 +408,11 @@ gtk_combo_box_text_insert_text (GtkComboBoxText *combo_box,
/** /**
* gtk_combo_box_text_append: * gtk_combo_box_text_append:
* @combo_box: A #GtkComboBoxText * @combo_box: A #GtkComboBoxText
* @id: (allow-none): a string ID for this value, or %NULL
* @text: A string * @text: A string
* *
* Appends @text to the list of strings stored in @combo_box. If @id is * Appends @text to the list of strings stored in @combo_box.
* non-%NULL then it is used as the ID of the row. * If @id is non-%NULL then it is used as the ID of the row.
* *
* This is the same as calling gtk_combo_box_text_insert() with a * This is the same as calling gtk_combo_box_text_insert() with a
* position of -1. * position of -1.
@ -432,8 +433,8 @@ gtk_combo_box_text_append (GtkComboBoxText *combo_box,
* @id: (allow-none): a string ID for this value, or %NULL * @id: (allow-none): a string ID for this value, or %NULL
* @text: a string * @text: a string
* *
* Prepends @text to the list of strings stored in @combo_box. If @id * Prepends @text to the list of strings stored in @combo_box.
* is non-%NULL then it is used as the ID of the row. * If @id is non-%NULL then it is used as the ID of the row.
* *
* This is the same as calling gtk_combo_box_text_insert() with a * This is the same as calling gtk_combo_box_text_insert() with a
* position of 0. * position of 0.

View File

@ -738,21 +738,19 @@ gtk_icon_theme_set_search_path (GtkIconTheme *icon_theme,
/** /**
* gtk_icon_theme_get_search_path: * gtk_icon_theme_get_search_path:
* @icon_theme: a #GtkIconTheme * @icon_theme: a #GtkIconTheme
* @path: (allow-none) (array length=n_elements) (element-type filename) (out): * @path: (allow-none) (array length=n_elements) (element-type filename) (out):
* location to store a list of icon theme path directories or %NULL . * location to store a list of icon theme path directories or %NULL.
* The stored value should be freed with g_strfreev(). * The stored value should be freed with g_strfreev().
* @n_elements: location to store number of elements * @n_elements: location to store number of elements in @path, or %NULL
* in @path, or %NULL *
*
* Gets the current search path. See gtk_icon_theme_set_search_path(). * Gets the current search path. See gtk_icon_theme_set_search_path().
* *
* Since: 2.4 * Since: 2.4
**/ */
void void
gtk_icon_theme_get_search_path (GtkIconTheme *icon_theme, gtk_icon_theme_get_search_path (GtkIconTheme *icon_theme,
gchar **path[], gchar **path[],
gint *n_elements) gint *n_elements)
{ {
GtkIconThemePrivate *priv; GtkIconThemePrivate *priv;
int i; int i;

View File

@ -1987,12 +1987,12 @@ gtk_menu_set_accel_group (GtkMenu *menu,
/** /**
* gtk_menu_get_accel_group: * gtk_menu_get_accel_group:
* @menu a #GtkMenu * @menu: a #GtkMenu
* *
* Gets the #GtkAccelGroup which holds global accelerators for the * Gets the #GtkAccelGroup which holds global accelerators for the
* menu. See gtk_menu_set_accel_group(). * menu. See gtk_menu_set_accel_group().
* *
* Returns: (transfer none): the #GtkAccelGroup associated with the menu. * Returns: (transfer none): the #GtkAccelGroup associated with the menu
*/ */
GtkAccelGroup* GtkAccelGroup*
gtk_menu_get_accel_group (GtkMenu *menu) gtk_menu_get_accel_group (GtkMenu *menu)
@ -2418,8 +2418,11 @@ gtk_menu_get_title (GtkMenu *menu)
* gtk_menu_reorder_child: * gtk_menu_reorder_child:
* @menu: a #GtkMenu * @menu: a #GtkMenu
* @child: the #GtkMenuItem to move * @child: the #GtkMenuItem to move
* @position: the new position to place @child. Positions are * @position: the new position to place @child.
* numbered from 0 to n-1. * Positions are numbered from 0 to n - 1
*
* Moves @child to a new @position in the list of @menu
* children.
*/ */
void void
gtk_menu_reorder_child (GtkMenu *menu, gtk_menu_reorder_child (GtkMenu *menu,

View File

@ -2564,9 +2564,23 @@ gtk_menu_item_get_use_underline (GtkMenuItem *menu_item)
return FALSE; return FALSE;
} }
/**
* gtk_menu_item_set_reserve_indicator:
* @menu_item: a #GtkMenuItem
* @reserve: the new value
*
* Sets whether the @menu_item should reserve space for
* the submenu indicator, regardless if it actually has
* a submenu or not.
*
* There should be little need for applications to call
* this functions.
*
* Since: 3.0
*/
void void
gtk_menu_item_set_reserve_indicator (GtkMenuItem *menu_item, gtk_menu_item_set_reserve_indicator (GtkMenuItem *menu_item,
gboolean reserve) gboolean reserve)
{ {
GtkMenuItemPrivate *priv; GtkMenuItemPrivate *priv;
@ -2581,8 +2595,21 @@ gtk_menu_item_set_reserve_indicator (GtkMenuItem *menu_item,
} }
} }
/**
* gtk_menu_item_get_reserve_indicator:
* @menu_item: a #GtkMenuItem
*
* Returns whether the @menu_item reserves space for
* the submenu indicator, regardless if it has a submenu
* or not.
*
* Returns: %TRUE if @menu_item always reserves space for the
* submenu indicator
*
* Since: 3.0
*/
gboolean gboolean
gtk_menu_item_get_reserve_indicator (GtkMenuItem *menu_item) gtk_menu_item_get_reserve_indicator (GtkMenuItem *menu_item)
{ {
g_return_val_if_fail (GTK_IS_MENU_ITEM (menu_item), FALSE); g_return_val_if_fail (GTK_IS_MENU_ITEM (menu_item), FALSE);

View File

@ -119,9 +119,9 @@ void gtk_menu_item_set_use_underline (GtkMenuItem *menu_item,
gboolean setting); gboolean setting);
gboolean gtk_menu_item_get_use_underline (GtkMenuItem *menu_item); gboolean gtk_menu_item_get_use_underline (GtkMenuItem *menu_item);
void gtk_menu_item_set_reserve_indicator(GtkMenuItem *menu_item, void gtk_menu_item_set_reserve_indicator (GtkMenuItem *menu_item,
gboolean reserve); gboolean reserve);
gboolean gtk_menu_item_get_reserve_indicator(GtkMenuItem *menu_item); gboolean gtk_menu_item_get_reserve_indicator (GtkMenuItem *menu_item);
G_END_DECLS G_END_DECLS

View File

@ -297,7 +297,7 @@ _gtk_print_backend_create (const gchar *backend_name)
} }
/** /**
* gtk_printer_backend_load_modules: * gtk_print_backend_load_modules:
* *
* Return value: (element-type GtkPrintBackend) (transfer container): * Return value: (element-type GtkPrintBackend) (transfer container):
*/ */

View File

@ -765,9 +765,8 @@ gtk_print_job_get_page_ranges (GtkPrintJob *job,
/** /**
* gtk_print_job_set_page_ranges: * gtk_print_job_set_page_ranges:
* @job: a #GtkPrintJob * @job: a #GtkPrintJob
* @ranges: (array length=n_ranges): pointer to an array of * @ranges: (array length=n_ranges): pointer to an array of
* #GtkPageRange structs * #GtkPageRange structs
* @n_ranges: the length of the @ranges array * @n_ranges: the length of the @ranges array
* *
* Sets the page ranges for this job. * Sets the page ranges for this job.
@ -993,7 +992,7 @@ gtk_print_job_get_collate (GtkPrintJob *job)
} }
/** /**
* gtk_print_job_set_collated: * gtk_print_job_set_collate:
* @job: a #GtkPrintJob * @job: a #GtkPrintJob
* @collate: whether the job is printed collated * @collate: whether the job is printed collated
* *

View File

@ -858,6 +858,16 @@ gtk_style_new (void)
return style; return style;
} }
/**
* gtk_style_has_context:
* @style: a #GtkStyle
*
* Returns whether @style has an associated #GtkStyleContext.
*
* Returns: %TRUE if @style has a #GtkStyleContext
*
* Since: 3.0
*/
gboolean gboolean
gtk_style_has_context (GtkStyle *style) gtk_style_has_context (GtkStyle *style)
{ {