Commit bf17f3f3 authored by Garrett Regier's avatar Garrett Regier Committed by Tristan Van Berkom

docs: Move documentation to inline comments: GtkColorSelection

Signed-off-by: default avatarJavier Jardón <jjardon@gnome.org>
parent 46627d00
......@@ -9,6 +9,7 @@ gtkbutton.sgml
gtkcalendar.sgml
gtkcelleditable.sgml
gtkcolorbutton.sgml
gtkcolorsel.sgml
gtkcombobox.sgml
gtkcomboboxentry.sgml
gtkcontainer.sgml
......
<!-- ##### SECTION Title ##### -->
GtkColorSelection
<!-- ##### SECTION Short_Description ##### -->
A widget used to select a color
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkColorSelection is a widget that is used to select
a color. It consists of a color wheel and number of sliders
and entry boxes for color parameters such as hue, saturation,
value, red, green, blue, and opacity. It is found on the standard
color selection dialog box #GtkColorSelectionDialog.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkColorSelection ##### -->
<para>
The #GtkColorSelection-struct struct contains private data only,
and should be accessed using the functions below.
</para>
<!-- ##### SIGNAL GtkColorSelection::color-changed ##### -->
<para>
This signal is emitted when the color changes in the #GtkColorSelection
according to its update policy.
</para>
@colorselection: the object which received the signal.
<!-- ##### ARG GtkColorSelection:current-alpha ##### -->
<para>
</para>
<!-- ##### ARG GtkColorSelection:current-color ##### -->
<para>
</para>
<!-- ##### ARG GtkColorSelection:has-opacity-control ##### -->
<para>
</para>
<!-- ##### ARG GtkColorSelection:has-palette ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_color_selection_new ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION gtk_color_selection_set_has_opacity_control ##### -->
<para>
</para>
@colorsel:
@has_opacity:
<!-- ##### FUNCTION gtk_color_selection_get_has_opacity_control ##### -->
<para>
</para>
@colorsel:
@Returns:
<!-- ##### FUNCTION gtk_color_selection_set_has_palette ##### -->
<para>
</para>
@colorsel:
@has_palette:
<!-- ##### FUNCTION gtk_color_selection_get_has_palette ##### -->
<para>
</para>
@colorsel:
@Returns:
<!-- ##### FUNCTION gtk_color_selection_get_current_alpha ##### -->
<para>
</para>
@colorsel:
@Returns:
<!-- ##### FUNCTION gtk_color_selection_set_current_alpha ##### -->
<para>
</para>
@colorsel:
@alpha:
<!-- ##### FUNCTION gtk_color_selection_get_current_color ##### -->
<para>
</para>
@colorsel:
@color:
<!-- ##### FUNCTION gtk_color_selection_set_current_color ##### -->
<para>
</para>
@colorsel:
@color:
<!-- ##### FUNCTION gtk_color_selection_get_previous_alpha ##### -->
<para>
</para>
@colorsel:
@Returns:
<!-- ##### FUNCTION gtk_color_selection_set_previous_alpha ##### -->
<para>
</para>
@colorsel:
@alpha:
<!-- ##### FUNCTION gtk_color_selection_get_previous_color ##### -->
<para>
</para>
@colorsel:
@color:
<!-- ##### FUNCTION gtk_color_selection_set_previous_color ##### -->
<para>
</para>
@colorsel:
@color:
<!-- ##### FUNCTION gtk_color_selection_is_adjusting ##### -->
<para>
</para>
@colorsel:
@Returns:
<!-- ##### FUNCTION gtk_color_selection_palette_from_string ##### -->
<para>
</para>
@str:
@colors:
@n_colors:
@Returns:
<!-- ##### FUNCTION gtk_color_selection_palette_to_string ##### -->
<para>
</para>
@colors:
@n_colors:
@Returns:
<!-- ##### USER_FUNCTION GtkColorSelectionChangePaletteFunc ##### -->
<para>
</para>
@colors:
@n_colors:
<!-- ##### FUNCTION gtk_color_selection_set_change_palette_with_screen_hook ##### -->
<para>
</para>
@func:
@Returns:
<!-- ##### USER_FUNCTION GtkColorSelectionChangePaletteWithScreenFunc ##### -->
<para>
</para>
@screen:
@colors:
@n_colors:
@Since: 2.2
......@@ -63,6 +63,20 @@
#include "gtkprivate.h"
#include "gtkintl.h"
/**
* SECTION:gtkcolorsel
* @Short_description: A widget used to select a color
* @Title: GtkColorSelection
*
* The #GtkColorSelection is a widget that is used to select
* a color. It consists of a color wheel and number of sliders
* and entry boxes for color parameters such as hue, saturation,
* value, red, green, blue, and opacity. It is found on the standard
* color selection dialog box #GtkColorSelectionDialog.
*/
/* Keep it in sync with gtksettings.c:default_color_palette */
#define DEFAULT_COLOR_PALETTE "black:white:gray50:red:purple:blue:light blue:green:yellow:orange:lavender:brown:goldenrod4:dodger blue:pink:light green:gray10:gray30:gray75:gray90"
......@@ -349,6 +363,13 @@ gtk_color_selection_class_init (GtkColorSelectionClass *klass)
GDK_TYPE_RGBA,
GTK_PARAM_READWRITE));
/**
* GtkColorSelection::color-changed:
* @colorselection: the object which received the signal.
*
* This signal is emitted when the color changes in the #GtkColorSelection
* according to its update policy.
*/
color_selection_signals[COLOR_CHANGED] =
g_signal_new (I_("color-changed"),
G_OBJECT_CLASS_TYPE (gobject_class),
......
......@@ -51,6 +51,15 @@ typedef struct _GtkColorSelectionClass GtkColorSelectionClass;
typedef void (* GtkColorSelectionChangePaletteFunc) (const GdkColor *colors,
gint n_colors);
/**
* GtkColorSelectionChangePaletteWithScreenFunc:
* @screen:
* @colors:
* @n_colors:
*
* Since: 2.2
*/
typedef void (* GtkColorSelectionChangePaletteWithScreenFunc) (GdkScreen *screen,
const GdkColor *colors,
gint n_colors);
......
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