~ubuntu-branches/ubuntu/natty/gedit/natty

« back to all changes in this revision

Viewing changes to docs/reference/html/gedit-gedit-progress-message-area.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-06-21 15:14:19 UTC
  • mto: This revision was merged to the branch mainline in revision 112.
  • Revision ID: james.westby@ubuntu.com-20100621151419-82riwk31yl5vzo0n
Tags: upstream-2.30.3
Import upstream version 2.30.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
45
45
<a name="gedit-gedit-progress-message-area.synopsis"></a><h2>Synopsis</h2>
46
46
<a name="GeditProgressMessageArea"></a><pre class="synopsis">                    <a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageAreaPrivate" title="GeditProgressMessageAreaPrivate">GeditProgressMessageAreaPrivate</a>;
47
47
                    <a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea-struct" title="GeditProgressMessageArea">GeditProgressMessageArea</a>;
48
 
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="gedit-gedit-progress-message-area.html#gedit-progress-message-area-new" title="gedit_progress_message_area_new ()">gedit_progress_message_area_new</a>     (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
49
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *markup</code></em>,
50
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> has_cancel</code></em>);
 
48
<a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="gedit-gedit-progress-message-area.html#gedit-progress-message-area-new" title="gedit_progress_message_area_new ()">gedit_progress_message_area_new</a>     (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
 
49
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *markup</code></em>,
 
50
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> has_cancel</code></em>);
51
51
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-progress-message-area.html#gedit-progress-message-area-set-stock-image" title="gedit_progress_message_area_set_stock_image ()">gedit_progress_message_area_set_stock_image</a>
52
52
                                                        (<em class="parameter"><code><a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea"><span class="type">GeditProgressMessageArea</span></a> *area</code></em>,
53
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>);
 
53
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>);
54
54
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-progress-message-area.html#gedit-progress-message-area-set-markup" title="gedit_progress_message_area_set_markup ()">gedit_progress_message_area_set_markup</a>
55
55
                                                        (<em class="parameter"><code><a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea"><span class="type">GeditProgressMessageArea</span></a> *area</code></em>,
56
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *markup</code></em>);
 
56
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *markup</code></em>);
57
57
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-progress-message-area.html#gedit-progress-message-area-set-text" title="gedit_progress_message_area_set_text ()">gedit_progress_message_area_set_text</a>
58
58
                                                        (<em class="parameter"><code><a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea"><span class="type">GeditProgressMessageArea</span></a> *area</code></em>,
59
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
 
59
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
60
60
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-progress-message-area.html#gedit-progress-message-area-set-fraction" title="gedit_progress_message_area_set_fraction ()">gedit_progress_message_area_set_fraction</a>
61
61
                                                        (<em class="parameter"><code><a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea"><span class="type">GeditProgressMessageArea</span></a> *area</code></em>,
62
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);
 
62
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);
63
63
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-progress-message-area.html#gedit-progress-message-area-pulse" title="gedit_progress_message_area_pulse ()">gedit_progress_message_area_pulse</a>   (<em class="parameter"><code><a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea"><span class="type">GeditProgressMessageArea</span></a> *area</code></em>);
64
64
</pre>
65
65
</div>
66
66
<div class="refsect1" title="Object Hierarchy">
67
67
<a name="gedit-gedit-progress-message-area.object-hierarchy"></a><h2>Object Hierarchy</h2>
68
68
<pre class="synopsis">
69
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
70
 
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
71
 
         +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a>
72
 
               +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a>
73
 
                     +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html">GtkContainer</a>
74
 
                           +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkBox.html">GtkBox</a>
75
 
                                 +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkHBox.html">GtkHBox</a>
76
 
                                       +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkInfoBar.html">GtkInfoBar</a>
 
69
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
70
   +----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
71
         +----<a href="/usr/share/gtk-doc/html/gtk/GtkObject.html">GtkObject</a>
 
72
               +----<a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html">GtkWidget</a>
 
73
                     +----<a href="/usr/share/gtk-doc/html/gtk/GtkContainer.html">GtkContainer</a>
 
74
                           +----<a href="/usr/share/gtk-doc/html/gtk/GtkBox.html">GtkBox</a>
 
75
                                 +----<a href="/usr/share/gtk-doc/html/gtk/GtkHBox.html">GtkHBox</a>
 
76
                                       +----<a href="/usr/share/gtk-doc/html/gtk/GtkInfoBar.html">GtkInfoBar</a>
77
77
                                             +----GeditProgressMessageArea
78
78
</pre>
79
79
</div>
81
81
<a name="gedit-gedit-progress-message-area.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
82
82
<p>
83
83
GeditProgressMessageArea implements
84
 
 AtkImplementorIface,  <a href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a> and  <a href="http://library.gnome.org/devel/gtk/unstable/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
 
84
 AtkImplementorIface,  <a href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a> and  <a href="/usr/share/gtk-doc/html/gtk/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
85
85
</div>
86
86
<div class="refsect1" title="Properties">
87
87
<a name="gedit-gedit-progress-message-area.properties"></a><h2>Properties</h2>
88
88
<pre class="synopsis">
89
 
  "<a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea--has-cancel-button" title='The "has-cancel-button" property'>has-cancel-button</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Write / Construct Only
 
89
  "<a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea--has-cancel-button" title='The "has-cancel-button" property'>has-cancel-button</a>"        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Write / Construct Only
90
90
</pre>
91
91
</div>
92
92
<div class="refsect1" title="Description">
93
93
<a name="gedit-gedit-progress-message-area.description"></a><h2>Description</h2>
94
 
<p>
95
 
</p>
96
94
</div>
97
95
<div class="refsect1" title="Details">
98
96
<a name="gedit-gedit-progress-message-area.details"></a><h2>Details</h2>
99
97
<div class="refsect2" title="GeditProgressMessageAreaPrivate">
100
98
<a name="GeditProgressMessageAreaPrivate"></a><h3>GeditProgressMessageAreaPrivate</h3>
101
99
<pre class="programlisting">typedef struct _GeditProgressMessageAreaPrivate GeditProgressMessageAreaPrivate;</pre>
102
 
<p>
103
 
</p>
104
100
</div>
105
101
<hr>
106
102
<div class="refsect2" title="GeditProgressMessageArea">
107
103
<a name="GeditProgressMessageArea-struct"></a><h3>GeditProgressMessageArea</h3>
108
104
<pre class="programlisting">typedef struct _GeditProgressMessageArea GeditProgressMessageArea;</pre>
109
 
<p>
110
 
</p>
111
105
</div>
112
106
<hr>
113
107
<div class="refsect2" title="gedit_progress_message_area_new ()">
114
108
<a name="gedit-progress-message-area-new"></a><h3>gedit_progress_message_area_new ()</h3>
115
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         gedit_progress_message_area_new     (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
116
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *markup</code></em>,
117
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> has_cancel</code></em>);</pre>
118
 
<p>
119
 
</p>
120
 
<div class="variablelist"><table border="0">
121
 
<col align="left" valign="top">
122
 
<tbody>
123
 
<tr>
124
 
<td><p><span class="term"><em class="parameter"><code>stock_id</code></em> :</span></p></td>
125
 
<td>
126
 
</td>
127
 
</tr>
128
 
<tr>
129
 
<td><p><span class="term"><em class="parameter"><code>markup</code></em> :</span></p></td>
130
 
<td>
131
 
</td>
132
 
</tr>
133
 
<tr>
134
 
<td><p><span class="term"><em class="parameter"><code>has_cancel</code></em> :</span></p></td>
135
 
<td>
136
 
</td>
137
 
</tr>
138
 
<tr>
139
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
140
 
<td>
141
 
</td>
142
 
</tr>
143
 
</tbody>
144
 
</table></div>
 
109
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         gedit_progress_message_area_new     (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
 
110
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *markup</code></em>,
 
111
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> has_cancel</code></em>);</pre>
145
112
</div>
146
113
<hr>
147
114
<div class="refsect2" title="gedit_progress_message_area_set_stock_image ()">
148
115
<a name="gedit-progress-message-area-set-stock-image"></a><h3>gedit_progress_message_area_set_stock_image ()</h3>
149
116
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_progress_message_area_set_stock_image
150
117
                                                        (<em class="parameter"><code><a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea"><span class="type">GeditProgressMessageArea</span></a> *area</code></em>,
151
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>);</pre>
152
 
<p>
153
 
</p>
154
 
<div class="variablelist"><table border="0">
155
 
<col align="left" valign="top">
156
 
<tbody>
157
 
<tr>
158
 
<td><p><span class="term"><em class="parameter"><code>area</code></em> :</span></p></td>
159
 
<td>
160
 
</td>
161
 
</tr>
162
 
<tr>
163
 
<td><p><span class="term"><em class="parameter"><code>stock_id</code></em> :</span></p></td>
164
 
<td>
165
 
</td>
166
 
</tr>
167
 
</tbody>
168
 
</table></div>
 
118
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>);</pre>
169
119
</div>
170
120
<hr>
171
121
<div class="refsect2" title="gedit_progress_message_area_set_markup ()">
172
122
<a name="gedit-progress-message-area-set-markup"></a><h3>gedit_progress_message_area_set_markup ()</h3>
173
123
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_progress_message_area_set_markup
174
124
                                                        (<em class="parameter"><code><a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea"><span class="type">GeditProgressMessageArea</span></a> *area</code></em>,
175
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *markup</code></em>);</pre>
176
 
<p>
177
 
</p>
178
 
<div class="variablelist"><table border="0">
179
 
<col align="left" valign="top">
180
 
<tbody>
181
 
<tr>
182
 
<td><p><span class="term"><em class="parameter"><code>area</code></em> :</span></p></td>
183
 
<td>
184
 
</td>
185
 
</tr>
186
 
<tr>
187
 
<td><p><span class="term"><em class="parameter"><code>markup</code></em> :</span></p></td>
188
 
<td>
189
 
</td>
190
 
</tr>
191
 
</tbody>
192
 
</table></div>
 
125
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *markup</code></em>);</pre>
193
126
</div>
194
127
<hr>
195
128
<div class="refsect2" title="gedit_progress_message_area_set_text ()">
196
129
<a name="gedit-progress-message-area-set-text"></a><h3>gedit_progress_message_area_set_text ()</h3>
197
130
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_progress_message_area_set_text
198
131
                                                        (<em class="parameter"><code><a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea"><span class="type">GeditProgressMessageArea</span></a> *area</code></em>,
199
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
200
 
<p>
201
 
</p>
202
 
<div class="variablelist"><table border="0">
203
 
<col align="left" valign="top">
204
 
<tbody>
205
 
<tr>
206
 
<td><p><span class="term"><em class="parameter"><code>area</code></em> :</span></p></td>
207
 
<td>
208
 
</td>
209
 
</tr>
210
 
<tr>
211
 
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
212
 
<td>
213
 
</td>
214
 
</tr>
215
 
</tbody>
216
 
</table></div>
 
132
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
217
133
</div>
218
134
<hr>
219
135
<div class="refsect2" title="gedit_progress_message_area_set_fraction ()">
220
136
<a name="gedit-progress-message-area-set-fraction"></a><h3>gedit_progress_message_area_set_fraction ()</h3>
221
137
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_progress_message_area_set_fraction
222
138
                                                        (<em class="parameter"><code><a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea"><span class="type">GeditProgressMessageArea</span></a> *area</code></em>,
223
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);</pre>
224
 
<p>
225
 
</p>
226
 
<div class="variablelist"><table border="0">
227
 
<col align="left" valign="top">
228
 
<tbody>
229
 
<tr>
230
 
<td><p><span class="term"><em class="parameter"><code>area</code></em> :</span></p></td>
231
 
<td>
232
 
</td>
233
 
</tr>
234
 
<tr>
235
 
<td><p><span class="term"><em class="parameter"><code>fraction</code></em> :</span></p></td>
236
 
<td>
237
 
</td>
238
 
</tr>
239
 
</tbody>
240
 
</table></div>
 
139
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);</pre>
241
140
</div>
242
141
<hr>
243
142
<div class="refsect2" title="gedit_progress_message_area_pulse ()">
244
143
<a name="gedit-progress-message-area-pulse"></a><h3>gedit_progress_message_area_pulse ()</h3>
245
144
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_progress_message_area_pulse   (<em class="parameter"><code><a class="link" href="gedit-gedit-progress-message-area.html#GeditProgressMessageArea"><span class="type">GeditProgressMessageArea</span></a> *area</code></em>);</pre>
246
 
<p>
247
 
</p>
248
 
<div class="variablelist"><table border="0">
249
 
<col align="left" valign="top">
250
 
<tbody><tr>
251
 
<td><p><span class="term"><em class="parameter"><code>area</code></em> :</span></p></td>
252
 
<td>
253
 
</td>
254
 
</tr></tbody>
255
 
</table></div>
256
145
</div>
257
146
</div>
258
147
<div class="refsect1" title="Property Details">
259
148
<a name="gedit-gedit-progress-message-area.property-details"></a><h2>Property Details</h2>
260
149
<div class="refsect2" title='The "has-cancel-button" property'>
261
150
<a name="GeditProgressMessageArea--has-cancel-button"></a><h3>The <code class="literal">"has-cancel-button"</code> property</h3>
262
 
<pre class="programlisting">  "has-cancel-button"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Write / Construct Only</pre>
 
151
<pre class="programlisting">  "has-cancel-button"        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Write / Construct Only</pre>
263
152
<p>If the message area has a cancel button.</p>
264
153
<p>Default value: TRUE</p>
265
154
</div>