Files
gimp/devel-docs/libgimp/xml/gimpprogressbar.xml
2010-08-11 01:13:56 -04:00

92 lines
2.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GimpProgressBar">
<refmeta>
<refentrytitle>GimpProgressBar</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpProgressBar</refname><refpurpose>A widget providing a progress bar.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="GimpProgressBar-struct">GimpProgressBar</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-progress-bar-new">gimp_progress_bar_new</link> (void);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkProgress">GtkProgress</link>
+----<link linkend="GtkProgressBar">GtkProgressBar</link>
+----GimpProgressBar
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
GimpProgressBar implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
A widget providing a progress bar that automatically redirects any progress
calls to itself.
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpProgressBar-struct"/>GimpProgressBar</title>
<indexterm><primary>GimpProgressBar</primary></indexterm><programlisting>typedef struct _GimpProgressBar GimpProgressBar;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-progress-bar-new"/>gimp_progress_bar_new ()</title>
<indexterm role="GIMP"><primary>gimp_progress_bar_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_progress_bar_new (void);</programlisting>
<para>
Creates a new <link linkend="GimpProgressBar"><type>GimpProgressBar</type></link> widget.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new widget.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>
</refentry>