diff options
| -rw-r--r-- | docs/reference/ChangeLog | 6 | ||||
| -rw-r--r-- | docs/reference/gtk/tmpl/gtkhsv.sgml | 124 | ||||
| -rw-r--r-- | docs/reference/gtk/tmpl/gtkorientable.sgml | 56 | ||||
| -rw-r--r-- | docs/reference/gtk/tmpl/gtkvscrollbar.sgml | 14 |
4 files changed, 194 insertions, 6 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 4257b7ef07..764e545eb9 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,5 +1,11 @@ 2008-12-30 Matthias Clasen <mclasen@redhat.com> + * gtk/tmpl/gtkorientable.sgml: + * gtk/tmpl/gtkvscrollbar.sgml: + * gtk/tmpl/gtkhsv.sgml: Add short/long description. + +2008-12-30 Matthias Clasen <mclasen@redhat.com> + * gtk/tmpl/gtkwidget.sgml: * gtk/tmpl/gtkprintoperation.sgml: Additions diff --git a/docs/reference/gtk/tmpl/gtkhsv.sgml b/docs/reference/gtk/tmpl/gtkhsv.sgml new file mode 100644 index 0000000000..1c2c2f4c67 --- /dev/null +++ b/docs/reference/gtk/tmpl/gtkhsv.sgml @@ -0,0 +1,124 @@ +<!-- ##### 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 ##### --> + + +<!-- ##### STRUCT GtkHSV ##### --> +<para> + +</para> + +@parent_instance: + +<!-- ##### FUNCTION gtk_hsv_new ##### --> +<para> + +</para> + +@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: + + diff --git a/docs/reference/gtk/tmpl/gtkorientable.sgml b/docs/reference/gtk/tmpl/gtkorientable.sgml new file mode 100644 index 0000000000..72ff0d54a8 --- /dev/null +++ b/docs/reference/gtk/tmpl/gtkorientable.sgml @@ -0,0 +1,56 @@ +<!-- ##### SECTION Title ##### --> +Orientable + +<!-- ##### SECTION Short_Description ##### --> +An interface for flippable widgets + +<!-- ##### SECTION Long_Description ##### --> +<para> +The #GtkOrientable interface is implemented by all widgets that can be +oriented horizontally or vertically. Historically, such widgets have been +realized as subclasses of a common base class (e.g #GtkBox/#GtkHBox/#GtkVBox +and #GtkScale/#GtkHScale/#GtkVScale). GtkOrientable is more flexible in that +it allows the orientation to be changed at runtime, allowing the widgets +to 'flip'. +</para> +<para> +GtkOrientable was introduced in GTK+ 2.16. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT GtkOrientable ##### --> +<para> + +</para> + + +<!-- ##### ARG GtkOrientable:orientation ##### --> +<para> + +</para> + +<!-- ##### FUNCTION gtk_orientable_get_orientation ##### --> +<para> + +</para> + +@orientable: +@Returns: + + +<!-- ##### FUNCTION gtk_orientable_set_orientation ##### --> +<para> + +</para> + +@orientable: +@orientation: + + diff --git a/docs/reference/gtk/tmpl/gtkvscrollbar.sgml b/docs/reference/gtk/tmpl/gtkvscrollbar.sgml index 3365ab233f..44ce1ec49d 100644 --- a/docs/reference/gtk/tmpl/gtkvscrollbar.sgml +++ b/docs/reference/gtk/tmpl/gtkvscrollbar.sgml @@ -4,25 +4,27 @@ GtkVScrollbar <!-- ##### SECTION Short_Description ##### --> A vertical scrollbar - <!-- ##### SECTION Long_Description ##### --> <para> - +The #GtkVScrollbar widget is a widget arranged verticall creating a +scrollbar. See #GtkScrollbar for details on +scrollbars. #GtkAdjustment pointers may be added to handle the +adjustment of the scrollbar or it may be left %NULL in which case one +will be created for you. See #GtkAdjustment for details. </para> - <!-- ##### SECTION See_Also ##### --> <para> - +#GtkScrollbar, #GtkScrolledWindow </para> - <!-- ##### SECTION Stability_Level ##### --> <!-- ##### STRUCT GtkVScrollbar ##### --> <para> - +The #GtkVScrollbar struct contains private data and should be accessed +using the functions below. </para> |