Move documentation to online comments: GtkCellRendererSpin

This commit is contained in:
Javier Jardón 2011-04-11 22:14:35 +01:00
parent a1ae3f7fe1
commit 1f9f5e8890
3 changed files with 23 additions and 68 deletions

View File

@ -13,6 +13,7 @@ gtkcelllayout.sgml
gtkcellrenderer.sgml
gtkcellrendereraccel.sgml
gtkcellrendererprogress.sgml
gtkcellrendererspin.sgml
gtkcellrenderertext.sgml
gtkcellrenderertoggle.sgml
gtkcellview.sgml

View File

@ -1,68 +0,0 @@
<!-- ##### SECTION Title ##### -->
GtkCellRendererSpin
<!-- ##### SECTION Short_Description ##### -->
Renders a spin button in a cell
<!-- ##### SECTION Long_Description ##### -->
<para>
#GtkCellRendererSpin renders text in a cell like #GtkCellRendererText from
which it is derived. But while #GtkCellRendererText offers a simple entry to
edit the text, #GtkCellRendererSpin offers a #GtkSpinButton widget. Of course,
that means that the text has to be parseable as a floating point number.
</para>
<para>
The range of the spinbutton is taken from the adjustment property of the
cell renderer, which can be set explicitly or mapped to a column in the
tree model, like all properties of cell renders. #GtkCellRendererSpin
also has properties for the climb rate and the number of digits to
display. Other #GtkSpinButton properties can be set in a handler for the
start-editing signal.
</para>
<para>
The #GtkCellRendererSpin cell renderer was added in GTK+ 2.10.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkCellRendererText, #GtkSpinButton
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkCellRendererSpin ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererSpin:adjustment ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererSpin:climb-rate ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererSpin:digits ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_cell_renderer_spin_new ##### -->
<para>
</para>
@void:
@Returns:

View File

@ -28,6 +28,28 @@
#include "gtkcellrendererspin.h"
/**
* SECTION:gtkcellrendererspin
* @Short_description: Renders a spin button in a cell
* @Title: GtkCellRendererSpin
* @See_also: #GtkCellRendererText, #GtkSpinButton
*
* #GtkCellRendererSpin renders text in a cell like #GtkCellRendererText from
* which it is derived. But while #GtkCellRendererText offers a simple entry to
* edit the text, #GtkCellRendererSpin offers a #GtkSpinButton widget. Of course,
* that means that the text has to be parseable as a floating point number.
*
* The range of the spinbutton is taken from the adjustment property of the
* cell renderer, which can be set explicitly or mapped to a column in the
* tree model, like all properties of cell renders. #GtkCellRendererSpin
* also has properties for the #GtkCellRendererSpin:climb-rate and the number
* of #GtkCellRendererSpin:digits to display. Other #GtkSpinButton properties
* can be set in a handler for the #GtkCellRenderer::editing-started signal.
*
* The #GtkCellRendererSpin cell renderer was added in GTK+ 2.10.
*/
struct _GtkCellRendererSpinPrivate
{
GtkAdjustment *adjustment;