/usr/share/gtk-doc/html/libepc-1.0/libepc-1.0-progress-window.html is in libepc-doc 0.4.4-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EpcProgressWindow</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Easy Publish and Consume Reference Manual">
<link rel="up" href="widgets.html" title="Widgets">
<link rel="prev" href="libepc-1.0-password-dialog.html" title="EpcPasswordDialog">
<link rel="next" href="internal-api.html" title="Internal API">
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="libepc-1.0-password-dialog.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="widgets.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">Easy Publish and Consume Reference Manual</th>
<td><a accesskey="n" href="internal-api.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libepc-1.0-progress-window.synopsis" class="shortcut">Top</a>
|
<a href="#libepc-1.0-progress-window.description" class="shortcut">Description</a>
|
<a href="#libepc-1.0-progress-window.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#libepc-1.0-progress-window.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#libepc-1.0-progress-window.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="libepc-1.0-progress-window"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libepc-1.0-progress-window.top_of_page"></a>EpcProgressWindow</span></h2>
<p>EpcProgressWindow — provide feedback during lengthly operations</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libepc-1.0-progress-window.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libepc-1.0-progress-window.synopsis"></a><h2>Synopsis</h2>
<a name="EpcProgressWindow"></a><pre class="synopsis">
#include <libepc-ui/progress-window.h>
struct <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindowClass" title="struct EpcProgressWindowClass">EpcProgressWindowClass</a>;
<a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindowPrivate" title="EpcProgressWindowPrivate">EpcProgressWindowPrivate</a>;
struct <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow-struct" title="struct EpcProgressWindow">EpcProgressWindow</a>;
<span class="returnvalue">GtkWidget</span> * <a class="link" href="libepc-1.0-progress-window.html#epc-progress-window-new" title="epc_progress_window_new ()">epc_progress_window_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
<em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libepc-1.0-progress-window.html#epc-progress-window-update" title="epc_progress_window_update ()">epc_progress_window_update</a> (<em class="parameter"><code><a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow"><span class="type">EpcProgressWindow</span></a> *window</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> progress</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libepc-1.0-progress-window.html#epc-progress-window-install" title="epc_progress_window_install ()">epc_progress_window_install</a> (<em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libepc-1.0-progress-window.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkWidget
+----GtkContainer
+----GtkBin
+----GtkWindow
+----EpcProgressWindow
</pre>
</div>
<div class="refsect1">
<a name="libepc-1.0-progress-window.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EpcProgressWindow implements
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1">
<a name="libepc-1.0-progress-window.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow--message" title='The "message" property'>message</a>" <span class="type">gchar</span>* : Read / Write / Construct
"<a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow--progress" title='The "progress" property'>progress</a>" <span class="type">gdouble</span> : Read / Write / Construct
"<a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow--title" title='The "title" property'>title</a>" <span class="type">gchar</span>* : Read / Write / Construct
</pre>
</div>
<div class="refsect1">
<a name="libepc-1.0-progress-window.description"></a><h2>Description</h2>
<p>
The <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow"><span class="type">EpcProgressWindow</span></a> can be used to provide some feedback during
lengthly operations, like generating server keys.
</p>
<p>
See also: <a class="link" href="libepc-1.0-EpcTls.html#epc-tls-private-key-new" title="epc_tls_private_key_new ()"><code class="function">epc_tls_private_key_new()</code></a>
</p>
</div>
<div class="refsect1">
<a name="libepc-1.0-progress-window.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EpcProgressWindowClass"></a><h3>struct EpcProgressWindowClass</h3>
<pre class="programlisting">struct EpcProgressWindowClass {
};
</pre>
<p>
Virtual methods of the <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow"><span class="type">EpcProgressWindow</span></a> class.
</p>
</div>
<hr>
<div class="refsect2">
<a name="EpcProgressWindowPrivate"></a><h3>EpcProgressWindowPrivate</h3>
<pre class="programlisting">typedef struct _EpcProgressWindowPrivate EpcProgressWindowPrivate;</pre>
<p>
Private fields of the <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow"><span class="type">EpcProgressWindow</span></a> class.
</p>
</div>
<hr>
<div class="refsect2">
<a name="EpcProgressWindow-struct"></a><h3>struct EpcProgressWindow</h3>
<pre class="programlisting">struct EpcProgressWindow;</pre>
<p>
Public fields of the <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow"><span class="type">EpcProgressWindow</span></a> class.
</p>
</div>
<hr>
<div class="refsect2">
<a name="epc-progress-window-new"></a><h3>epc_progress_window_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * epc_progress_window_new (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
<em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);</pre>
<p>
Creates a new <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow"><span class="type">EpcProgressWindow</span></a> instance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>the title of the window</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>the transient parent of the window, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>the message to show, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow"><span class="type">EpcProgressWindow</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-progress-window-update"></a><h3>epc_progress_window_update ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> epc_progress_window_update (<em class="parameter"><code><a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow"><span class="type">EpcProgressWindow</span></a> *window</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> progress</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);</pre>
<p>
Updates the <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow"><span class="type">EpcProgressWindow</span></a> with new progress information. The <em class="parameter"><code>progress</code></em>
is expressed as percentage in the range [0..1], or -1 if the progress cannot
be estimated.
</p>
<p>
See also: <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow--message" title='The "message" property'><span class="type">"message"</span></a>, <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow--progress" title='The "progress" property'><span class="type">"progress"</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>a <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow"><span class="type">EpcProgressWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
<td>the current progress, or -1</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>a description of the current progress</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-progress-window-install"></a><h3>epc_progress_window_install ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> epc_progress_window_install (<em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>);</pre>
<p>
Configures the hooks provided by libepc to use <a class="link" href="libepc-1.0-progress-window.html#EpcProgressWindow"><span class="type">EpcProgressWindow</span></a> when for
performing long standing tasks like for instance generating private keys.
</p>
<p>
See also: <code class="function">epc_tls_set_private_key_hooks()</code>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>the transient parent of the window, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libepc-1.0-progress-window.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EpcProgressWindow--message"></a><h3>The <code class="literal">"message"</code> property</h3>
<pre class="programlisting"> "message" <span class="type">gchar</span>* : Read / Write / Construct</pre>
<p>The progress message to show.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EpcProgressWindow--progress"></a><h3>The <code class="literal">"progress"</code> property</h3>
<pre class="programlisting"> "progress" <span class="type">gdouble</span> : Read / Write / Construct</pre>
<p>Current progress, or -1.</p>
<p>Allowed values: [-1,1]</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2">
<a name="EpcProgressWindow--title"></a><h3>The <code class="literal">"title"</code> property</h3>
<pre class="programlisting"> "title" <span class="type">gchar</span>* : Read / Write / Construct</pre>
<p>The title to show.</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|