Commit 69279262 authored by Steven Harms's avatar Steven Harms Committed by Javier Jardón

Update gtkvscale documentation for in code comments. Removed template document

parent 24ba8f31
<!-- ##### SECTION Title ##### -->
GtkVScale
<!-- ##### SECTION Short_Description ##### -->
A vertical slider widget for selecting a value from a range
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkVScale widget is used to allow the user to select a value using
a vertical slider. To create one, use gtk_hscale_new_with_range().
</para>
<para>
The position to show the current value, and the number of decimal places
shown can be set using the parent #GtkScale class's functions.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkVScale ##### -->
<para>
The #GtkVScale-struct struct contains private data only, and
should be accessed using the functions below.
</para>
<!-- ##### FUNCTION gtk_vscale_new ##### -->
<para>
Creates a new #GtkVScale.
</para>
@adjustment: the #GtkAdjustment which sets the range of the scale.
@Returns: a new #GtkVScale.
<!-- ##### FUNCTION gtk_vscale_new_with_range ##### -->
<para>
</para>
@min:
@max:
@step:
@Returns:
......@@ -33,6 +33,17 @@
#include "gtkorientable.h"
#include "gtkalias.h"
/**
* SECTION:gtkvscale
* @Short_description: A vertical slider widget for selecting a value from a range
* @Title: GtkVScale
*
* The #GtkVScale widget is used to allow the user to select a value using
* a vertical slider. To create one, use gtk_hscale_new_with_range().
*
* The position to show the current value, and the number of decimal places
* shown can be set using the parent #GtkScale class's functions.
*/
G_DEFINE_TYPE (GtkVScale, gtk_vscale, GTK_TYPE_SCALE)
......@@ -50,7 +61,14 @@ gtk_vscale_init (GtkVScale *vscale)
gtk_orientable_set_orientation (GTK_ORIENTABLE (vscale),
GTK_ORIENTATION_VERTICAL);
}
/**
* gtk_vscale_new:
* @adjustment: the #GtkAdjustment which sets the range of the scale.
*
* Creates a new #GtkVScale.
*
* Returns: a new #GtkVScale.
*/
GtkWidget *
gtk_vscale_new (GtkAdjustment *adjustment)
{
......
......@@ -49,6 +49,12 @@ G_BEGIN_DECLS
typedef struct _GtkVScale GtkVScale;
typedef struct _GtkVScaleClass GtkVScaleClass;
/**
* GtkVScale:
*
* The #GtkVScale struct contains private data only, and
* should be accessed using the functions below.
*/
struct _GtkVScale
{
GtkScale scale;
......
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