callisto-debian/gtk3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] Move documentation to inline comments: GtkVRuler

Browse Source 
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611656

Signed-off-by: Javier Jardón <jjardon@gnome.org>
This commit is contained in:
Steven Harms
2010-03-03 19:11:46 -05:00
committed by Javier Jardón
parent 25b6994cba
commit 6cdeb370a1
2 changed files with 29 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/reference/gtk/tmpl/gtkvruler.sgml
View File

@ -1,50 +0,0 @@
<!-- ##### SECTION Title ##### -->
GtkVRuler
<!-- ##### SECTION Short_Description ##### -->
A vertical ruler
<!-- ##### SECTION Long_Description ##### -->
<note>
<para>
This widget is considered too specialized/little-used for
GTK+, and will in the future be moved to some other package. If
your application needs this widget, feel free to use it, as the
widget does work and is useful in some applications; it's just not
of general interest. However, we are not accepting new features for
the widget, and it will eventually move out of the GTK+
distribution.
</para>
</note>
<para>
The VRuler widget is a widget arranged vertically creating a ruler that is
utilized around other widgets such as a text widget. The ruler is used to show
the location of the mouse on the window and to show the size of the window in
specified units. The available units of measurement are GTK_PIXELS, GTK_INCHES
and GTK_CENTIMETERS. GTK_PIXELS is the default.
rulers.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkVRuler ##### -->
<para>
The #GtkVRuler struct contains private data and should be accessed
using the functions below.
</para>
<!-- ##### FUNCTION gtk_vruler_new ##### -->
<para>
Creates a new vertical ruler
</para>
@Returns: a new #GtkVRuler.

29
gtk/gtkvruler.c
View File

@ -30,6 +30,28 @@
#include "gtkvruler.h"
#include "gtkalias.h"
/**
* SECTION:gtkvruler
* @Short_description: A vertical ruler
* @Title: GtkVRuler
*
* <note>
* This widget is considered too specialized/little-used for
* GTK+, and will in the future be moved to some other package. If
* your application needs this widget, feel free to use it, as the
* widget does work and is useful in some applications; it's just not
* of general interest. However, we are not accepting new features for
* the widget, and it will eventually move out of the GTK+
* distribution.
* </note>
*
* The VRuler widget is a widget arranged vertically creating a ruler that is
* utilized around other widgets such as a text widget. The ruler is used to show
* the location of the mouse on the window and to show the size of the window in
* specified units. The available units of measurement are GTK_PIXELS, GTK_INCHES
* and GTK_CENTIMETERS. GTK_PIXELS is the default unit of measurement.
*/
G_DEFINE_TYPE (GtkVRuler, gtk_vruler, GTK_TYPE_RULER)
static void
@ -44,6 +66,13 @@ gtk_vruler_init (GtkVRuler *vruler)
GTK_ORIENTATION_VERTICAL);
}
/**
* gtk_vruler_new:
*
* Creates a new vertical ruler
*
* Returns: a new #GtkVRuler.
*/
GtkWidget *
gtk_vruler_new (void)
{