<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY pi "&#960;">
<!ENTITY solidus "&#8260;">
]>
<refentry id="GtkCellRendererProgress">
<refmeta>
<refentrytitle role="top_of_page" id="GtkCellRendererProgress.top_of_page">GtkCellRendererProgress</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkCellRendererProgress</refname>
<refpurpose>Renders numbers as progress bars</refpurpose>
</refnamediv>

<refsect1 id="GtkCellRendererProgress.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkCellRenderer"><returnvalue>GtkCellRenderer</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-cell-renderer-progress-new">gtk_cell_renderer_progress_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellRendererProgress.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkCellRendererProgress--inverted">inverted</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gint"><type>gint</type></link></entry><entry role="property_name"><link linkend="GtkCellRendererProgress--pulse">pulse</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkCellRendererProgress--text">text</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gfloat"><type>gfloat</type></link></entry><entry role="property_name"><link linkend="GtkCellRendererProgress--text-xalign">text-xalign</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gfloat"><type>gfloat</type></link></entry><entry role="property_name"><link linkend="GtkCellRendererProgress--text-yalign">text-yalign</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gint"><type>gint</type></link></entry><entry role="property_name"><link linkend="GtkCellRendererProgress--value">value</link></entry><entry role="property_flags">Read / Write</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellRendererProgress.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkCellRendererProgress-struct">GtkCellRendererProgress</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellRendererProgress.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
        <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkCellRenderer">GtkCellRenderer</link>
            <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkCellRendererProgress
</screen>
</refsect1>
<refsect1 id="GtkCellRendererProgress.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkCellRendererProgress implements
 <link linkend="GtkOrientable">GtkOrientable</link>.</para>

</refsect1>

<refsect1 id="GtkCellRendererProgress.includes"><title>Includes</title><synopsis>#include &lt;gtk/gtk.h&gt;
</synopsis></refsect1>

<refsect1 id="GtkCellRendererProgress.description" role="desc">
<title role="desc.title">Description</title>
<para><link linkend="GtkCellRendererProgress"><type>GtkCellRendererProgress</type></link> renders a numeric value as a progress par in a cell.
Additionally, it can display a text on top of the progress bar.</para>
<para>The <link linkend="GtkCellRendererProgress"><type>GtkCellRendererProgress</type></link> cell renderer was added in GTK+ 2.6.</para>

</refsect1>
<refsect1 id="GtkCellRendererProgress.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-cell-renderer-progress-new" role="function">
<title>gtk_cell_renderer_progress_new&#160;()</title>
<indexterm zone="gtk-cell-renderer-progress-new"><primary>gtk_cell_renderer_progress_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkCellRenderer"><returnvalue>GtkCellRenderer</returnvalue></link>&#160;*
gtk_cell_renderer_progress_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new <link linkend="GtkCellRendererProgress"><type>GtkCellRendererProgress</type></link>.</para>
<refsect3 id="gtk-cell-renderer-progress-new.returns" role="returns">
<title>Returns</title>
<para> the new cell renderer</para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkCellRendererProgress.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkCellRendererProgress-struct" role="struct">
<title>GtkCellRendererProgress</title>
<indexterm zone="GtkCellRendererProgress-struct"><primary>GtkCellRendererProgress</primary></indexterm>
<programlisting language="C">typedef struct _GtkCellRendererProgress GtkCellRendererProgress;</programlisting>
</refsect2>

</refsect1>
<refsect1 id="GtkCellRendererProgress.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkCellRendererProgress--inverted" role="property"><title>The <literal>“inverted”</literal> property</title>
<indexterm zone="GtkCellRendererProgress--inverted"><primary>GtkCellRendererProgress:inverted</primary></indexterm>
<programlisting>  “inverted”                 <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>Invert the direction in which the progress bar grows.</para><para>Owner: GtkCellRendererProgress</para>
<para>Flags: Read / Write</para>
<para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GtkCellRendererProgress--pulse" role="property"><title>The <literal>“pulse”</literal> property</title>
<indexterm zone="GtkCellRendererProgress--pulse"><primary>GtkCellRendererProgress:pulse</primary></indexterm>
<programlisting>  “pulse”                    <link linkend="gint"><type>gint</type></link></programlisting>
<para>Setting this to a non-negative value causes the cell renderer to
enter "activity mode", where a block bounces back and forth to

indicate that some progress is made, without specifying exactly how
much.</para>
<para>Each increment of the property causes the block to move by a little

bit.</para>
<para>To indicate that the activity has not started yet, set the property
to zero. To indicate completion, set the property to <link linkend="G-MAXINT:CAPS"><literal>G_MAXINT</literal></link>.</para>
<para>Owner: GtkCellRendererProgress</para>
<para>Flags: Read / Write</para>
<para>Allowed values: &gt;= -1</para>
<para>Default value: -1</para>
</refsect2>
<refsect2 id="GtkCellRendererProgress--text" role="property"><title>The <literal>“text”</literal> property</title>
<indexterm zone="GtkCellRendererProgress--text"><primary>GtkCellRendererProgress:text</primary></indexterm>
<programlisting>  “text”                     <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>The "text" property determines the label which will be drawn
over the progress bar. Setting this property to <link linkend="NULL:CAPS"><literal>NULL</literal></link> causes the default

label to be displayed. Setting this property to an empty string causes

no label to be displayed.</para>
<para>Owner: GtkCellRendererProgress</para>
<para>Flags: Read / Write</para>
<para>Default value: NULL</para>
</refsect2>
<refsect2 id="GtkCellRendererProgress--text-xalign" role="property"><title>The <literal>“text-xalign”</literal> property</title>
<indexterm zone="GtkCellRendererProgress--text-xalign"><primary>GtkCellRendererProgress:text-xalign</primary></indexterm>
<programlisting>  “text-xalign”              <link linkend="gfloat"><type>gfloat</type></link></programlisting>
<para>The "text-xalign" property controls the horizontal alignment of the
text in the progress bar.  Valid values range from 0 (left) to 1
(right).  Reserved for RTL layouts.</para>
<para>Owner: GtkCellRendererProgress</para>
<para>Flags: Read / Write</para>
<para>Allowed values: [0,1]</para>
<para>Default value: 0.5</para>
</refsect2>
<refsect2 id="GtkCellRendererProgress--text-yalign" role="property"><title>The <literal>“text-yalign”</literal> property</title>
<indexterm zone="GtkCellRendererProgress--text-yalign"><primary>GtkCellRendererProgress:text-yalign</primary></indexterm>
<programlisting>  “text-yalign”              <link linkend="gfloat"><type>gfloat</type></link></programlisting>
<para>The "text-yalign" property controls the vertical alignment of the
text in the progress bar.  Valid values range from 0 (top) to 1
(bottom).</para>
<para>Owner: GtkCellRendererProgress</para>
<para>Flags: Read / Write</para>
<para>Allowed values: [0,1]</para>
<para>Default value: 0.5</para>
</refsect2>
<refsect2 id="GtkCellRendererProgress--value" role="property"><title>The <literal>“value”</literal> property</title>
<indexterm zone="GtkCellRendererProgress--value"><primary>GtkCellRendererProgress:value</primary></indexterm>
<programlisting>  “value”                    <link linkend="gint"><type>gint</type></link></programlisting>
<para>The "value" property determines the percentage to which the
progress bar will be "filled in".</para>
<para>Owner: GtkCellRendererProgress</para>
<para>Flags: Read / Write</para>
<para>Allowed values: [0,100]</para>
<para>Default value: 0</para>
</refsect2>

</refsect1>

</refentry>
