|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/libgnomeui/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GnomeAppBar</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="application-mgmt.html" title="Application management">
<link rel="prev" href="GnomeApp.html" title="GnomeApp">
<link rel="next" href="libgnomeui-gnome-app-helper.html" title="gnome-app-helper">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="GNOME UI Library (libgnomeui)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GnomeApp.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="application-mgmt.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME UI Library Reference Manual</th>
<td><a accesskey="n" href="libgnomeui-gnome-app-helper.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2925969" class="shortcut">Top</a>
 | 
<a href="#id2926622" class="shortcut">Description</a>
 | 
<a href="#id2926379" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2926449" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2926472" class="shortcut">Properties</a>
 | 
<a href="#id2926540" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GnomeAppBar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2925969"></a><span class="refentrytitle">GnomeAppBar</span>
</h2>
<p>GnomeAppBar — An application status and progress bar widget</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
#define <a href="GnomeAppBar.html#GNOME-APPBAR-HAS-STATUS:CAPS">GNOME_APPBAR_HAS_STATUS</a> (appbar)
#define <a href="GnomeAppBar.html#GNOME-APPBAR-HAS-PROGRESS:CAPS">GNOME_APPBAR_HAS_PROGRESS</a> (appbar)
#define <a href="GnomeAppBar.html#GNOME-APPBAR-INTERACTIVE:CAPS">GNOME_APPBAR_INTERACTIVE</a> (ab)
<a href="GnomeAppBar.html#GnomeAppBar-struct">GnomeAppBar</a>;
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a href="GnomeAppBar.html#gnome-appbar-new">gnome_appbar_new</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> has_progress,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> has_status,
<a href="libgnomeui-gnome-types.html#GnomePreferencesType">GnomePreferencesType</a> interactivity);
void <a href="GnomeAppBar.html#gnome-appbar-set-status">gnome_appbar_set_status</a> (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *status);
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a href="GnomeAppBar.html#gnome-appbar-get-status">gnome_appbar_get_status</a> (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);
void <a href="GnomeAppBar.html#gnome-appbar-set-default">gnome_appbar_set_default</a> (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *default_status);
void <a href="GnomeAppBar.html#gnome-appbar-push">gnome_appbar_push</a> (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *status);
void <a href="GnomeAppBar.html#gnome-appbar-pop">gnome_appbar_pop</a> (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);
void <a href="GnomeAppBar.html#gnome-appbar-clear-stack">gnome_appbar_clear_stack</a> (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);
void <a href="GnomeAppBar.html#gnome-appbar-set-progress-percentage">gnome_appbar_set_progress_percentage</a>
(<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"
>gfloat</a> percentage);
<a
href="/usr/share/gtk-doc/html/gtk/GtkProgressBar.html"
>GtkProgressBar</a>* <a href="GnomeAppBar.html#gnome-appbar-get-progress">gnome_appbar_get_progress</a> (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);
void <a href="GnomeAppBar.html#gnome-appbar-refresh">gnome_appbar_refresh</a> (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);
void <a href="GnomeAppBar.html#gnome-appbar-set-prompt">gnome_appbar_set_prompt</a> (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *prompt,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> modal);
void <a href="GnomeAppBar.html#gnome-appbar-clear-prompt">gnome_appbar_clear_prompt</a> (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GnomeAppBar.html#gnome-appbar-get-response">gnome_appbar_get_response</a> (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2926379"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkBox.html"
>GtkBox</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkHBox.html"
>GtkHBox</a>
+----GnomeAppBar
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2926449"></a><h2>Implemented Interfaces</h2>
<p>
GnomeAppBar implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2926472"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GnomeAppBar.html#GnomeAppBar--has-progress">has-progress</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write / Construct
"<a href="GnomeAppBar.html#GnomeAppBar--has-status">has-status</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write / Construct
"<a href="GnomeAppBar.html#GnomeAppBar--interactivity">interactivity</a>" <a href="libgnomeui-gnome-types.html#GnomePreferencesType">GnomePreferencesType</a> : Read / Write / Construct
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2926540"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GnomeAppBar.html#GnomeAppBar-clear-prompt">clear-prompt</a>"
void user_function (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GnomeAppBar.html#GnomeAppBar-user-response">user-response</a>"
void user_function (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2926622"></a><h2>Description</h2>
<p>
A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> widget sits (usually) at the bottom of an application window and
contains a progress bar (for indicating time consuming tasks and their
completion status) and/or a status bar for sending short one-line message to
the user. It is also possible (in theory) for the user to edit the contents of
the status bar, should the application developer choose to allow that, however
<span class="emphasis"><em>note that this is not really working</em></span> in the present
implementation, so developers are recommended to avoid using interactive status
bars and use proper editable widgets instead.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2926657"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2926667"></a><h3>
<a name="GNOME-APPBAR-HAS-STATUS:CAPS"></a>GNOME_APPBAR_HAS_STATUS()</h3>
<a class="indexterm" name="id2926680"></a><pre class="programlisting">#define GNOME_APPBAR_HAS_STATUS(appbar) (gnome_appbar_get_status(GNOME_APPBAR(appbar)) != NULL)
</pre>
<p>
Whether or not the application bar contains a status box.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td>A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
<a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> is a status box is contained in the appbar.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2926744"></a><h3>
<a name="GNOME-APPBAR-HAS-PROGRESS:CAPS"></a>GNOME_APPBAR_HAS_PROGRESS()</h3>
<a class="indexterm" name="id2926757"></a><pre class="programlisting">#define GNOME_APPBAR_HAS_PROGRESS(appbar) (gnome_appbar_get_progress(GNOME_APPBAR(appbar)) != NULL)
</pre>
<p>
Whether or not the application bar contains a status box.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td>A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
<a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> is a status box is contained in the appbar.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2926821"></a><h3>
<a name="GNOME-APPBAR-INTERACTIVE:CAPS"></a>GNOME_APPBAR_INTERACTIVE()</h3>
<a class="indexterm" name="id2926834"></a><pre class="programlisting">#define GNOME_APPBAR_INTERACTIVE(ab) ((ab) ? (ab)->interactive : FALSE)
</pre>
<p>
Whether or not the user can edit the text in the statusbar portion of a
<a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>ab</code></em> :</span></td>
<td>A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
<a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the user can edit the statusbar text.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2926905"></a><h3>
<a name="GnomeAppBar-struct"></a>GnomeAppBar</h3>
<a class="indexterm" name="id2926918"></a><pre class="programlisting">typedef struct _GnomeAppBar GnomeAppBar;</pre>
<p>
This widget contains the status bar and progress bar (if they are requested).
After creating a <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> widget (via <a href="GnomeAppBar.html#gnome-appbar-new"><code class="function">gnome_appbar_new()</code></a>, for example), it
can then be passed to <a href="GnomeApp.html#gnome-app-set-statusbar"><code class="function">gnome_app_set_statusbar()</code></a> to add it to the main
application window.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2926966"></a><h3>
<a name="gnome-appbar-new"></a>gnome_appbar_new ()</h3>
<a class="indexterm" name="id2926978"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* gnome_appbar_new (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> has_progress,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> has_status,
<a href="libgnomeui-gnome-types.html#GnomePreferencesType">GnomePreferencesType</a> interactivity);</pre>
<p>
Create a new GNOME application status bar. If <em class="parameter"><code>has_progress</code></em> is
<a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>, a small progress bar widget will be created, and placed on the
left side of the appbar. If <em class="parameter"><code>has_status</code></em> is <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>, a status bar,
possibly an editable one, is created.
</p>
<p>
The <em class="parameter"><code>interactivity</code></em> parameter determines whether the appbar is an interactive
"minibuffer" or just a status bar. If it is set to
<span class="type">GNOME_PREFERENCES_NEVER</span>, it is never interactive. If it is set to
<span class="type">GNOME_PREFERENCES_USER</span> we respect user preferences from
ui-properties. If it's <span class="type">GNOME_PREFERENCES_ALWAYS</span> we are interactive
whether the user likes it or not. Basically, if your app supports
both interactive and not (for example, if you use the
gnome-app-util interfaces), you should use
<span class="type">GNOME_PREFERENCES_USER</span>. Otherwise, use the setting you
support. Please note that "interactive" mode is not functional now;
GtkEntry is inadequate and so a custom widget will be written
eventually.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>has_progress</code></em> :</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if appbar needs progress bar widget, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> if not.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>has_status</code></em> :</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if appbar needs status bar widget, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> if not.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>interactivity</code></em> :</span></td>
<td> Level of user activity required.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> Pointer to new <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2927224"></a><h3>
<a name="gnome-appbar-set-status"></a>gnome_appbar_set_status ()</h3>
<a class="indexterm" name="id2927238"></a><pre class="programlisting">void gnome_appbar_set_status (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *status);</pre>
<p>
Sets the status label without changing widget state; next call to
<a href="GnomeAppBar.html#gnome-appbar-set-status"><code class="function">gnome_appbar_set_status()</code></a> or <a href="GnomeAppBar.html#gnome-appbar-push"><code class="function">gnome_appbar_push()</code></a> will destroy this
permanently.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td> A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>status</code></em> :</span></td>
<td> Text to which status label will be set.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2927340"></a><h3>
<a name="gnome-appbar-get-status"></a>gnome_appbar_get_status ()</h3>
<a class="indexterm" name="id2927354"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* gnome_appbar_get_status (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);</pre>
<p>
Retrieves the statusbar widget.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td> A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
A pointer to the statusbar widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2927423"></a><h3>
<a name="gnome-appbar-set-default"></a>gnome_appbar_set_default ()</h3>
<a class="indexterm" name="id2927435"></a><pre class="programlisting">void gnome_appbar_set_default (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *default_status);</pre>
<p>
What to show when showing nothing else is on the stack; defaults to the
empty string.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td> A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>default_status</code></em> :</span></td>
<td> Text for status label.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2927516"></a><h3>
<a name="gnome-appbar-push"></a>gnome_appbar_push ()</h3>
<a class="indexterm" name="id2927529"></a><pre class="programlisting">void gnome_appbar_push (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *status);</pre>
<p>
Push a new status message onto the status bar stack and display it.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td> A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>status</code></em> :</span></td>
<td> Text of status message.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2927609"></a><h3>
<a name="gnome-appbar-pop"></a>gnome_appbar_pop ()</h3>
<a class="indexterm" name="id2927622"></a><pre class="programlisting">void gnome_appbar_pop (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);</pre>
<p>
Remove current status message, and display previous status
message, if any. It is fine to call this with an empty stack.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td> A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2927681"></a><h3>
<a name="gnome-appbar-clear-stack"></a>gnome_appbar_clear_stack ()</h3>
<a class="indexterm" name="id2927694"></a><pre class="programlisting">void gnome_appbar_clear_stack (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);</pre>
<p>
Remove all status messages from <em class="parameter"><code>appbar</code></em>, and display default status
message (if present).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td> A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2927759"></a><h3>
<a name="gnome-appbar-set-progress-percentage"></a>gnome_appbar_set_progress_percentage ()</h3>
<a class="indexterm" name="id2927773"></a><pre class="programlisting">void gnome_appbar_set_progress_percentage
(<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"
>gfloat</a> percentage);</pre>
<p>
Sets progress bar to <em class="parameter"><code>percentage</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td> A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>percentage</code></em> :</span></td>
<td> Percentage to which progress bar should be set.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2927860"></a><h3>
<a name="gnome-appbar-get-progress"></a>gnome_appbar_get_progress ()</h3>
<a class="indexterm" name="id2927873"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkProgressBar.html"
>GtkProgressBar</a>* gnome_appbar_get_progress (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);</pre>
<p>
Retrieves the progress bar widget for further manipulation.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td> A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A <a
href="/usr/share/gtk-doc/html/gtk/GtkProgressBar.html"
><span class="type">GtkProgressBar</span></a> widget which is <em class="parameter"><code>appbar</code></em>'s progress bar, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>
if <em class="parameter"><code>appbar</code></em> has no progress bar.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2927973"></a><h3>
<a name="gnome-appbar-refresh"></a>gnome_appbar_refresh ()</h3>
<a class="indexterm" name="id2927985"></a><pre class="programlisting">void gnome_appbar_refresh (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);</pre>
<p>
Refresh the status message bar by redrawing the item on the top of the
stack, or the default value if the stack is empty.. Useful to force the
message from a previous call to <a href="GnomeAppBar.html#gnome-appbar-set-status"><code class="function">gnome_appbar_set_status()</code></a> to disappear.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td> A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2928057"></a><h3>
<a name="gnome-appbar-set-prompt"></a>gnome_appbar_set_prompt ()</h3>
<a class="indexterm" name="id2928070"></a><pre class="programlisting">void gnome_appbar_set_prompt (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *prompt,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> modal);</pre>
<p>
Put a prompt in the appbar and wait for a response. When the
user responds or cancels, a 'user_response' signal is emitted.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td> A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>prompt</code></em> :</span></td>
<td> Text of the prompt message.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>modal</code></em> :</span></td>
<td> If <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>, grabs input.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2928184"></a><h3>
<a name="gnome-appbar-clear-prompt"></a>gnome_appbar_clear_prompt ()</h3>
<a class="indexterm" name="id2928197"></a><pre class="programlisting">void gnome_appbar_clear_prompt (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);</pre>
<p>
Remove any prompt from the status message bar.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td> A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2928255"></a><h3>
<a name="gnome-appbar-get-response"></a>gnome_appbar_get_response ()</h3>
<a class="indexterm" name="id2928268"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gnome_appbar_get_response (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar);</pre>
<p>
Get the response to the prompt, if any.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td> A <a href="GnomeAppBar.html" title="GnomeAppBar"><span class="type">GnomeAppBar</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
Text from <em class="parameter"><code>appbar</code></em> entry widget, as entered by user. This string should be
freed by the caller (using <code class="function">gfree()</code>) when no longer required.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2928356"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2928367"></a><h3>
<a name="GnomeAppBar--has-progress"></a>The "<code class="literal">has-progress</code>" property</h3>
<a class="indexterm" name="id2928383"></a><pre class="programlisting"> "has-progress" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write / Construct</pre>
<p>Create a progress widget.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2928410"></a><h3>
<a name="GnomeAppBar--has-status"></a>The "<code class="literal">has-status</code>" property</h3>
<a class="indexterm" name="id2928427"></a><pre class="programlisting"> "has-status" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write / Construct</pre>
<p>Create a status widget.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2928453"></a><h3>
<a name="GnomeAppBar--interactivity"></a>The "<code class="literal">interactivity</code>" property</h3>
<a class="indexterm" name="id2928469"></a><pre class="programlisting"> "interactivity" <a href="libgnomeui-gnome-types.html#GnomePreferencesType">GnomePreferencesType</a> : Read / Write / Construct</pre>
<p>Level of user activity required.</p>
<p>Default value: GNOME_PREFERENCES_NEVER</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2928498"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2928509"></a><h3>
<a name="GnomeAppBar-clear-prompt"></a>The "clear-prompt" signal</h3>
<a class="indexterm" name="id2928520"></a><pre class="programlisting">void user_function (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2928588"></a><h3>
<a name="GnomeAppBar-user-response"></a>The "user-response" signal</h3>
<a class="indexterm" name="id2928598"></a><pre class="programlisting">void user_function (<a href="GnomeAppBar.html" title="GnomeAppBar">GnomeAppBar</a> *appbar,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appbar</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>