Commit 09efa564 authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkHSV

parent b398f96b
......@@ -52,6 +52,7 @@ gtkhpaned.sgml
gtkhscale.sgml
gtkhscrollbar.sgml
gtkhseparator.sgml
gtkhsv.c
gtkiconfactory.sgml
gtkicontheme.sgml
gtkiconview.sgml
......
<!-- ##### SECTION Title ##### -->
GtkHSV
<!-- ##### SECTION Short_Description ##### -->
A 'color wheel' widget
<!-- ##### SECTION Long_Description ##### -->
<para>
#GtkHSV is the 'color wheel' part of a complete color selector widget.
It allows to select a color by determining its HSV components in an
intuitive way. Moving the selection around the outer ring changes the hue,
and moving the selection point inside the inner triangle changes value and
saturation.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkColorSelection</term>
<listitem>a complete color selection widget</listitem>
</varlistentry>
<varlistentry>
<term>#GtkColorSelectionDialog</term>
<listitem>a color selection dialog</listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkHSV ##### -->
<para>
</para>
<!-- ##### SIGNAL GtkHSV::changed ##### -->
<para>
</para>
@hsv: the object which received the signal.
<!-- ##### SIGNAL GtkHSV::move ##### -->
<para>
</para>
@hsv: the object which received the signal.
@arg1:
<!-- ##### FUNCTION gtk_hsv_new ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION gtk_hsv_set_color ##### -->
<para>
</para>
@hsv:
@h:
@s:
@v:
<!-- ##### FUNCTION gtk_hsv_get_color ##### -->
<para>
</para>
@hsv:
@h:
@s:
@v:
<!-- ##### FUNCTION gtk_hsv_set_metrics ##### -->
<para>
</para>
@hsv:
@size:
@ring_width:
<!-- ##### FUNCTION gtk_hsv_get_metrics ##### -->
<para>
</para>
@hsv:
@size:
@ring_width:
<!-- ##### FUNCTION gtk_hsv_is_adjusting ##### -->
<para>
</para>
@hsv:
@Returns:
<!-- ##### FUNCTION gtk_hsv_to_rgb ##### -->
<para>
</para>
@h:
@s:
@v:
@r:
@g:
@b:
<!-- ##### FUNCTION gtk_rgb_to_hsv ##### -->
<para>
</para>
@r:
@g:
@b:
@h:
@s:
@v:
......@@ -40,6 +40,21 @@
#include "gtktypebuiltins.h"
#include "gtkintl.h"
/**
* SECTION:gtkhsv
* @Short_description: A 'color wheel' widget
* @Title: GtkHSV
* @See_also: #GtkColorSelection, #GtkColorSelectionDialog
*
* #GtkHSV is the 'color wheel' part of a complete color selector widget.
* It allows to select a color by determining its HSV components in an
* intuitive way. Moving the selection around the outer ring changes the hue,
* and moving the selection point inside the inner triangle changes value and
* saturation.
*/
/* Default width/height */
#define DEFAULT_SIZE 100
......
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