Commit 4a7400db authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkCellRendererPixbuf

parent 3990af22
......@@ -13,6 +13,7 @@ gtkcelllayout.sgml
gtkcellrenderer.sgml
gtkcellrendereraccel.sgml
gtkcellrenderercombo.sgml
gtkcellrendererpixbuf.sgml
gtkcellrendererprogress.sgml
gtkcellrendererspin.sgml
gtkcellrenderertext.sgml
......
<!-- ##### SECTION Title ##### -->
GtkCellRendererPixbuf
<!-- ##### SECTION Short_Description ##### -->
Renders a pixbuf in a cell
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkCellRendererPixbuf can be used to render an image in a cell. It allows to render
either a given #GdkPixbuf (set via the
<link linkend="GtkCellRendererPixbuf--pixbuf">pixbuf</link> property) or a stock icon
(set via the <link linkend="GtkCellRendererPixbuf--stock-id">stock-id</link> property).
</para>
<para>
To support the tree view, #GtkCellRendererPixbuf also supports rendering two alternative
pixbufs, when the <link linkend="GtkCellRenderer--is-expander">is-expander</link> property
is %TRUE. If the <link linkend="GtkCellRenderer--is-expanded">is-expanded</link> property
is %TRUE and the
<link linkend="GtkCellRendererPixbuf--pixbuf-expander-open">pixbuf-expander-open</link>
property is set to a pixbuf, it renders that pixbuf, if the
<link linkend="GtkCellRenderer--is-expanded">is-expanded</link> property is %FALSE and
the
<link linkend="GtkCellRendererPixbuf--pixbuf-expander-closed">pixbuf-expander-closed</link>
property is set to a pixbuf, it renders that one.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkCellRendererPixbuf ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererPixbuf:follow-state ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererPixbuf:gicon ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererPixbuf:icon-name ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererPixbuf:pixbuf ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererPixbuf:pixbuf-expander-closed ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererPixbuf:pixbuf-expander-open ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererPixbuf:stock-detail ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererPixbuf:stock-id ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererPixbuf:stock-size ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_cell_renderer_pixbuf_new ##### -->
<para>
</para>
@void:
@Returns:
......@@ -26,6 +26,26 @@
#include "gtkprivate.h"
/**
* SECTION:gtkcellrendererpixbuf
* @Short_description: Renders a pixbuf in a cell
* @Title: GtkCellRendererPixbuf
*
* A #GtkCellRendererPixbuf can be used to render an image in a cell. It allows
* to render either a given #GdkPixbuf (set via the
* #GtkCellRendererPixbuf:pixbuf property) or a stock icon (set via the
* #GtkCellRendererPixbuf:stock-id property).
*
* To support the tree view, #GtkCellRendererPixbuf also supports rendering two
* alternative pixbufs, when the #GtkCellRenderer:is-expander property is %TRUE.
* If the #GtkCellRenderer:is-expanded property is %TRUE and the
* #GtkCellRendererPixbuf:pixbuf-expander-open property is set to a pixbuf, it
* renders that pixbuf, if the #GtkCellRenderer:is-expanded property is %FALSE
* and the #GtkCellRendererPixbuf:pixbuf-expander-closed property is set to a
* pixbuf, it renders that one.
*/
static void gtk_cell_renderer_pixbuf_get_property (GObject *object,
guint param_id,
GValue *value,
......
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