Commit f4f1768d authored by Matthias Clasen's avatar Matthias Clasen

Fix docs for gtk_tree_view_column_set_sort_order. (#62647)

        * gtk/gtktreeviewcolumn.c: Fix docs for
        gtk_tree_view_column_set_sort_order. (#62647)

        * gtk/gtkcontainer.c: Fix docs for
        gtk_container_set_border_width. (#64139)

        * gtk/gtkcolorsel.c: Documentation fixes.

        * gtk/tmpl/gtkpaned.sgml: Document gtk_paned_set_gutter_size
        as noop. (#45802)

        * gtk/tmpl/gtkcolorsel.sgml: Remove stuff duplicating inline
        docs. (#60481)
parent 77764092
2001-11-10 Matthias Clasen <matthiasc@poet.de>
* gtk/gtktreeviewcolumn.c: Fix docs for
gtk_tree_view_column_set_sort_order. (#62647)
* gtk/gtkcontainer.c: Fix docs for
gtk_container_set_border_width. (#64139)
* gtk/gtkcolorsel.c: Documentation fixes.
2001-10-28 Hans Breuer <hans@breuer.org>
* gtk/gtkfontsel.c : use g_strcasecmp(), some poor platforms
......
2001-11-10 Matthias Clasen <matthiasc@poet.de>
* gtk/gtktreeviewcolumn.c: Fix docs for
gtk_tree_view_column_set_sort_order. (#62647)
* gtk/gtkcontainer.c: Fix docs for
gtk_container_set_border_width. (#64139)
* gtk/gtkcolorsel.c: Documentation fixes.
2001-10-28 Hans Breuer <hans@breuer.org>
* gtk/gtkfontsel.c : use g_strcasecmp(), some poor platforms
......
2001-11-10 Matthias Clasen <matthiasc@poet.de>
* gtk/gtktreeviewcolumn.c: Fix docs for
gtk_tree_view_column_set_sort_order. (#62647)
* gtk/gtkcontainer.c: Fix docs for
gtk_container_set_border_width. (#64139)
* gtk/gtkcolorsel.c: Documentation fixes.
2001-10-28 Hans Breuer <hans@breuer.org>
* gtk/gtkfontsel.c : use g_strcasecmp(), some poor platforms
......
2001-11-10 Matthias Clasen <matthiasc@poet.de>
* gtk/gtktreeviewcolumn.c: Fix docs for
gtk_tree_view_column_set_sort_order. (#62647)
* gtk/gtkcontainer.c: Fix docs for
gtk_container_set_border_width. (#64139)
* gtk/gtkcolorsel.c: Documentation fixes.
2001-10-28 Hans Breuer <hans@breuer.org>
* gtk/gtkfontsel.c : use g_strcasecmp(), some poor platforms
......
2001-11-10 Matthias Clasen <matthiasc@poet.de>
* gtk/gtktreeviewcolumn.c: Fix docs for
gtk_tree_view_column_set_sort_order. (#62647)
* gtk/gtkcontainer.c: Fix docs for
gtk_container_set_border_width. (#64139)
* gtk/gtkcolorsel.c: Documentation fixes.
2001-10-28 Hans Breuer <hans@breuer.org>
* gtk/gtkfontsel.c : use g_strcasecmp(), some poor platforms
......
2001-11-10 Matthias Clasen <matthiasc@poet.de>
* gtk/gtktreeviewcolumn.c: Fix docs for
gtk_tree_view_column_set_sort_order. (#62647)
* gtk/gtkcontainer.c: Fix docs for
gtk_container_set_border_width. (#64139)
* gtk/gtkcolorsel.c: Documentation fixes.
2001-10-28 Hans Breuer <hans@breuer.org>
* gtk/gtkfontsel.c : use g_strcasecmp(), some poor platforms
......
2001-11-10 Matthias Clasen <matthiasc@poet.de>
* gtk/gtktreeviewcolumn.c: Fix docs for
gtk_tree_view_column_set_sort_order. (#62647)
* gtk/gtkcontainer.c: Fix docs for
gtk_container_set_border_width. (#64139)
* gtk/gtkcolorsel.c: Documentation fixes.
2001-10-28 Hans Breuer <hans@breuer.org>
* gtk/gtkfontsel.c : use g_strcasecmp(), some poor platforms
......
2001-11-10 Matthias Clasen <matthiasc@poet.de>
* gtk/tmpl/gtkpaned.sgml: Document gtk_paned_set_gutter_size
as noop. (#45802)
* gtk/tmpl/gtkcolorsel.sgml: Remove stuff duplicating inline
docs. (#60481)
* gtk/tmpl/gtkstock.sgml: Document all stock items
with their stock text.
......
......@@ -27,10 +27,10 @@ and should be accessed using the functions below.
<!-- ##### FUNCTION gtk_color_selection_new ##### -->
<para>
Create a new #GtkColorSelection.
</para>
@Returns: a #GtkColorSelection.
@Returns:
<!-- ##### FUNCTION gtk_color_selection_set_update_policy ##### -->
......@@ -71,8 +71,6 @@ time.
@colorsel:
@has_opacity:
<!-- # Unused Parameters # -->
@use_opacity:
<!-- ##### FUNCTION gtk_color_selection_get_has_opacity_control ##### -->
......@@ -91,8 +89,6 @@ time.
@colorsel:
@has_palette:
<!-- # Unused Parameters # -->
@use_palette:
<!-- ##### FUNCTION gtk_color_selection_get_has_palette ##### -->
......@@ -226,23 +222,20 @@ time.
<!-- ##### FUNCTION gtk_color_selection_set_color ##### -->
<para>
Sets the color in the #GtkColorSelection. The widgets are updated
to reflect the new color.
</para>
@colorsel: a #GtkColorSelection.
@color: a color array consisting of 4 gfloat values for red, green,
blue, and opacity.
@colorsel:
@color:
<!-- ##### FUNCTION gtk_color_selection_get_color ##### -->
<para>
Retrieve the currently selected color value.
</para>
@colorsel: a #GtkColorSelection
@color: a color array consisting of 4 gfloat values for red, green,
blue, and opacity.
@colorsel:
@color:
<!-- ##### SIGNAL GtkColorSelection::color-changed ##### -->
......
......@@ -112,9 +112,6 @@ Old name for gtk_paned_set_handle_size()
Old name for gtk_paned_set_gutter_size()
</para>
@p:
@s:
<!-- ##### FUNCTION gtk_paned_pack1 ##### -->
<para>
......@@ -140,14 +137,12 @@ Add a child to the bottom or right pane.
<!-- ##### MACRO gtk_paned_set_gutter_size ##### -->
<para>
Set the width of the gutter. (The area between the two panes).
In older versions of Gtk, this function used to set the width of the
gutter (the area between the two panes). It does nothing now.
</para>
@p:
@s:
<!-- # Unused Parameters # -->
@paned: a paned widget
@size: the width of the widget in pixels
@p: a paned widget
@s: the width of the gutter in pixels
<!-- ##### FUNCTION gtk_paned_set_position ##### -->
......
......@@ -2004,11 +2004,11 @@ gtk_color_selection_set_update_policy (GtkColorSelection *colorsel,
/**
* gtk_color_selection_get_has_opacity_control:
* @colorsel: A GtkColorSelection.
* @colorsel: a #GtkColorSelection.
*
* Determines whether the colorsel has an opacity control.
*
* Return value: TRUE if the @colorsel has an opacity control. FALSE if it does't.
* Return value: %TRUE if the @colorsel has an opacity control. %FALSE if it does't.
**/
gboolean
gtk_color_selection_get_has_opacity_control (GtkColorSelection *colorsel)
......@@ -2024,8 +2024,8 @@ gtk_color_selection_get_has_opacity_control (GtkColorSelection *colorsel)
/**
* gtk_color_selection_set_has_opacity_control:
* @colorsel: A GtkColorSelection.
* @has_opacity: TRUE if @colorsel can set the opacity, FALSE otherwise.
* @colorsel: a #GtkColorSelection.
* @has_opacity: %TRUE if @colorsel can set the opacity, %FALSE otherwise.
*
* Sets the @colorsel to use or not use opacity.
*
......@@ -2064,11 +2064,11 @@ gtk_color_selection_set_has_opacity_control (GtkColorSelection *colorsel,
/**
* gtk_color_selection_get_has_palette:
* @colorsel: A GtkColorSelection.
* @colorsel: a #GtkColorSelection.
*
* Determines whether the color selector has a color palette.
*
* Return value: TRUE if the selector has a palette. FALSE if it hasn't.
* Return value: %TRUE if the selector has a palette. %FALSE if it hasn't.
**/
gboolean
gtk_color_selection_get_has_palette (GtkColorSelection *colorsel)
......@@ -2084,8 +2084,8 @@ gtk_color_selection_get_has_palette (GtkColorSelection *colorsel)
/**
* gtk_color_selection_set_has_palette:
* @colorsel: A GtkColorSelection.
* @has_palette: TRUE if palette is to be visible, FALSE otherwise.
* @colorsel: a #GtkColorSelection.
* @has_palette: %TRUE if palette is to be visible, %FALSE otherwise.
*
* Shows and hides the palette based upon the value of @has_palette.
*
......@@ -2114,12 +2114,11 @@ gtk_color_selection_set_has_palette (GtkColorSelection *colorsel,
/**
* gtk_color_selection_set_current_color:
* @colorsel: A GtkColorSelection.
* @color: A GdkColor to set the current color with.
* @colorsel: a #GtkColorSelection.
* @color: A #GdkColor to set the current color with.
*
* Sets the current color to be @color. The first time this is called, it will
* also set the original color to be @color too.
*
**/
void
gtk_color_selection_set_current_color (GtkColorSelection *colorsel,
......@@ -2154,12 +2153,11 @@ gtk_color_selection_set_current_color (GtkColorSelection *colorsel,
/**
* gtk_color_selection_set_current_alpha:
* @colorsel: A GtkColorSelection.
* @alpha: an integer between 0 and 65535
* @colorsel: a #GtkColorSelection.
* @alpha: an integer between 0 and 65535.
*
* Sets the current opacity to be @alpha. The first time this is called, it will
* also set the original opacity to be @alpha too.
*
**/
void
gtk_color_selection_set_current_alpha (GtkColorSelection *colorsel,
......@@ -2184,14 +2182,14 @@ gtk_color_selection_set_current_alpha (GtkColorSelection *colorsel,
/**
* gtk_color_selection_set_color:
* @colorsel: A GtkColorSelection.
* @color: A array of doubles that specifies the color to set the current color with.
* @colorsel: a #GtkColorSelection.
* @color: an array of 4 doubles specifying the red, green, blue and opacity
* to set the current color to.
*
* Sets the current color to be @color. The first time this is called, it will
* also set the original color to be @color too.
*
* This function is deprecated, use gtk_color_selection_set_current_color() instead.
*
**/
void
gtk_color_selection_set_color (GtkColorSelection *colorsel,
......@@ -2226,12 +2224,10 @@ gtk_color_selection_set_color (GtkColorSelection *colorsel,
/**
* gtk_color_selection_get_current_color:
* @colorsel: A GtkColorSelection.
* @color: A GdkColor to fill in with the current color.
* @colorsel: a #GtkColorSelection.
* @color: a #GdkColor to fill in with the current color.
*
* Sets @color to be the current color in the GtkColorSelection widget.
*
* This function is deprecated, use gtk_color_selection_get_current_color() instead.
**/
void
gtk_color_selection_get_current_color (GtkColorSelection *colorsel,
......@@ -2249,11 +2245,11 @@ gtk_color_selection_get_current_color (GtkColorSelection *colorsel,
/**
* gtk_color_selection_get_current_alpha:
* @colorsel: A GtkColorSelection.
* @colorsel: a #GtkColorSelection.
*
* Returns the current alpha value
* Returns the current alpha value.
*
* Return value: an integer between 0 and 65535
* Return value: an integer between 0 and 65535.
**/
guint16
gtk_color_selection_get_current_alpha (GtkColorSelection *colorsel)
......@@ -2268,11 +2264,12 @@ gtk_color_selection_get_current_alpha (GtkColorSelection *colorsel)
/**
* gtk_color_selection_get_color:
* @colorsel: A GtkColorSelection.
* @color: A color to fill in with the current color.
* @colorsel: a #GtkColorSelection.
* @color: an array of 4 #gdouble to fill in with the current color.
*
* Sets @color to be the current color in the GtkColorSelection widget.
*
* This function is deprecated, use gtk_color_selection_get_current_color() instead.
**/
void
gtk_color_selection_get_color (GtkColorSelection *colorsel,
......@@ -2291,14 +2288,13 @@ gtk_color_selection_get_color (GtkColorSelection *colorsel,
/**
* gtk_color_selection_set_previous_color:
* @colorsel: A GtkColorSelection.
* @color: A color to set the previous color with.
* @colorsel: a #GtkColorSelection.
* @color: a #GdkColor to set the previous color with.
*
* Sets the 'previous' color to be @color. This function should be called with
* some hesitations, as it might seem confusing to have that color change.
* Calling gtk_color_selection_set_current_color will also set this color the first
* Calling gtk_color_selection_set_current_color() will also set this color the first
* time it is called.
*
**/
void
gtk_color_selection_set_previous_color (GtkColorSelection *colorsel,
......@@ -2325,12 +2321,11 @@ gtk_color_selection_set_previous_color (GtkColorSelection *colorsel,
/**
* gtk_color_selection_set_previous_alpha:
* @colorsel: A GtkColorSelection.
* @alpha: an integer between 0 and 65535
* @colorsel: a #GtkColorSelection.
* @alpha: an integer between 0 and 65535.
*
* Sets the 'previous' alpha to be @alpha. This function should be called with
* some hesitations, as it might seem confusing to have that color change.
*
* some hesitations, as it might seem confusing to have that alpha change.
**/
void
gtk_color_selection_set_previous_alpha (GtkColorSelection *colorsel,
......@@ -2350,11 +2345,10 @@ gtk_color_selection_set_previous_alpha (GtkColorSelection *colorsel,
/**
* gtk_color_selection_get_previous_color:
* @colorsel: A GtkColorSelection.
* @color: A GdkColor to fill in with the original color value.
* @colorsel: a #GtkColorSelection.
* @color: a #GdkColor to fill in with the original color value.
*
* Fills @color in with the original color value.
*
**/
void
gtk_color_selection_get_previous_color (GtkColorSelection *colorsel,
......@@ -2372,11 +2366,11 @@ gtk_color_selection_get_previous_color (GtkColorSelection *colorsel,
/**
* gtk_color_selection_get_previous_alpha:
* @colorsel: A GtkColorSelection.
* @colorsel: a #GtkColorSelection.
*
* Returns the previous alpha value
* Returns the previous alpha value.
*
* Return value: an integer between 0 and 65535
* Return value: an integer between 0 and 65535.
**/
guint16
gtk_color_selection_get_previous_alpha (GtkColorSelection *colorsel)
......@@ -2391,11 +2385,11 @@ gtk_color_selection_get_previous_alpha (GtkColorSelection *colorsel)
/**
* gtk_color_selection_set_palette_color:
* @colorsel: A GtkColorSelection.
* @index: The color index of the palette.
* @color: A GdkColor to set the palette with.
* @colorsel: a #GtkColorSelection.
* @index: the color index of the palette.
* @color: A #GdkColor to set the palette with.
*
* Set the palette located at at @index to have @color set as its color.
* Sets the palette located at @index to have @color as its color.
*
**/
static void
......@@ -2423,14 +2417,14 @@ gtk_color_selection_set_palette_color (GtkColorSelection *colorsel,
/**
* gtk_color_selection_get_palette_color:
* @colorsel: A GtkColorSelection.
* @index: The color index of the palette.
* @color: A color to fill in with the color value.
* @colorsel: a #GtkColorSelection.
* @index: the color index of the palette.
* @color: a #GdkColor to fill in with the color value.
*
* Set @color to have the color found in the palette at @index. If
* the palette is unset, it will leave the color unset.
*
* Return value: TRUE if the palette located at @index has a color set. FALSE
* Return value: %TRUE if the palette located at @index has a color set. %FALSE
* if it doesn't.
**/
static gboolean
......@@ -2464,11 +2458,10 @@ gtk_color_selection_get_palette_color (GtkColorSelection *colorsel,
/**
* gtk_color_selection_unset_palette_color:
* @colorsel: A GtkColorSelection.
* @index: The color index in the palette.
* @colorsel: a #GtkColorSelection.
* @index: the color index in the palette.
*
* Change the palette located @index to have no color set.
*
* Changes the palette located @index to have no color set.
**/
static void
gtk_color_selection_unset_palette_color (GtkColorSelection *colorsel,
......@@ -2489,11 +2482,11 @@ gtk_color_selection_unset_palette_color (GtkColorSelection *colorsel,
/**
* gtk_color_selection_get_current_alpha:
* @colorsel: A GtkColorSelection.
* @colorsel: a #GtkColorSelection.
*
* Returns the maximum number of palette colors.
*
* Return value: the maximum number of palette indexes
* Return value: the maximum number of palette indexes.
**/
static gint
gtk_color_selection_get_palette_size (GtkColorSelection *colorsel)
......@@ -2504,11 +2497,11 @@ gtk_color_selection_get_palette_size (GtkColorSelection *colorsel)
/**
* gtk_color_selection_is_adjusting:
* @colorsel: A GtkColorSelection.
* @colorsel: a #GtkColorSelection.
*
* Gets the current state of the @colorsel.
*
* Return value: TRUE if the user is currently dragging a color around, and FALSE
* Return value: %TRUE if the user is currently dragging a color around, and %FALSE
* if the selection has stopped.
**/
gboolean
......@@ -2587,14 +2580,14 @@ gtk_color_selection_get_property (GObject *object,
/**
* gtk_color_selection_palette_from_string:
* @str: a string encoding a color palette
* @colors: return location for allocated array of GdkColor
* @n_colors: return location for length of array
* @str: a string encoding a color palette.
* @colors: return location for allocated array of #GdkColor.
* @n_colors: return location for length of array.
*
* Parses a color palette string; the string is a colon-separated
* list of color names readable by gdk_color_parse().
*
* Return value: %TRUE if a palette was successfully parsed
* Return value: %TRUE if a palette was successfully parsed.
**/
gboolean
gtk_color_selection_palette_from_string (const gchar *str,
......@@ -2673,12 +2666,12 @@ gtk_color_selection_palette_from_string (const gchar *str,
/**
* gtk_color_selection_palette_to_string:
* @colors: an array of colors
* @n_colors: length of the array
* @colors: an array of colors.
* @n_colors: length of the array.
*
* Encodes a palette as a string, useful for persistent storage.
*
* Return value: allocated string encoding the palette
* Return value: allocated string encoding the palette.
**/
gchar*
gtk_color_selection_palette_to_string (const GdkColor *colors,
......@@ -2720,14 +2713,14 @@ gtk_color_selection_palette_to_string (const GdkColor *colors,
/**
* gtk_color_selection_set_change_palette_hook:
* @func: a function to call when the custom palette needs saving
* @func: a function to call when the custom palette needs saving.
*
* Installs a global function to be called whenever the user tries to
* modify the palette in a color selection. This function should save
* the new palette contents, and update the GtkSettings property
* "gtk-color-palette" so all GtkColorSelection widgets will be modified.
*
* Return value: the previous change palette hook (that was replaced)
* Return value: the previous change palette hook (that was replaced).
**/
GtkColorSelectionChangePaletteFunc
gtk_color_selection_set_change_palette_hook (GtkColorSelectionChangePaletteFunc func)
......
......@@ -780,7 +780,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.
* Valid values are in the range 0-65535 pixels.
*
* The border width of a container is the amount of space to leave
* around the outside of the container. The only exception to this is
* #GtkWindow; because toplevel windows can't leave space outside,
......@@ -788,7 +789,6 @@ gtk_container_get_property (GObject *object,
* the container. To add space to only one side, one approach is to
* create a #GtkAlignment widget, call gtk_widget_set_usize() to give
* it a size, and place it on the side of the container as a spacer.
*
**/
void
gtk_container_set_border_width (GtkContainer *container,
......
......@@ -1968,16 +1968,17 @@ gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
* @tree_column: a #GtkTreeViewColumn
* @order: sort order that the sort indicator should indicate
*
* Changes the appearance of the sort indicator. (This <emphasis>does
* not</emphasis> actually sort the model. Use
* Changes the appearance of the sort indicator.
*
* This <emphasis>does not</emphasis> actually sort the model. Use
* gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
* support. This function is primarily for custom sorting behavior, and should
* be used in conjunction with #gtk_tree_sortable_set_sort_column() to do
* that. For custom models, the mechanism will vary. The sort indicator changes
* direction to indicate normal sort or reverse sort. Note that you must have
* the sort indicator enabled to see anything when calling this function; see
* gtk_tree_view_column_set_sort_indicator().
* be used in conjunction with gtk_tree_sortable_set_sort_column() to do
* that. For custom models, the mechanism will vary.
*
* The sort indicator changes direction to indicate normal sort or reverse sort.
* Note that you must have the sort indicator enabled to see anything when
* calling this function; see gtk_tree_view_column_set_sort_indicator().
**/
void
gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment