← Back to branch summary

~ubuntu-branches/ubuntu/precise/telepathy-mission-control-5/precise

« back to all changes in this revision

Viewing changes to doc/reference/libmissioncontrol-server/html/McdMission.html

Import upstream version 5.3.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/libmissioncontrol-server/html/McdMission.html
53
53
#include <mcd-mission.h>
54
54
 
55
55
                    <a class="link" href="McdMission.html#McdMission-struct" title="McdMission">McdMission</a>;
56
 
#define             <a class="link" href="McdMission.html#MCD-MISSION-GET-FLAGS-MASKED--CAPS" title="MCD_MISSION_GET_FLAGS_MASKED()">MCD_MISSION_GET_FLAGS_MASKED</a>        (mission, flags)
57
 
#define             <a class="link" href="McdMission.html#MCD-MISSION-SET-FLAGS-MASKED--CAPS" title="MCD_MISSION_SET_FLAGS_MASKED()">MCD_MISSION_SET_FLAGS_MASKED</a>        (mission, flags)
58
 
#define             <a class="link" href="McdMission.html#MCD-MISSION-UNSET-FLAGS-MASKED--CAPS" title="MCD_MISSION_UNSET_FLAGS_MASKED()">MCD_MISSION_UNSET_FLAGS_MASKED</a>      (mission, flags)
59
 
enum                <a class="link" href="McdMission.html#McdMode" title="enum McdMode">McdMode</a>;
60
 
enum                <a class="link" href="McdMission.html#McdSystemFlags" title="enum McdSystemFlags">McdSystemFlags</a>;
61
 
<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *        <a class="link" href="McdMission.html#mcd-mission-new" title="mcd_mission_new ()">mcd_mission_new</a>                     (void);
62
56
<a
63
57
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
64
58
>gboolean</a>            <a class="link" href="McdMission.html#mcd-mission-is-connected" title="mcd_mission_is_connected ()">mcd_mission_is_connected</a>            (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission);
65
59
<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *        <a class="link" href="McdMission.html#mcd-mission-get-parent" title="mcd_mission_get_parent ()">mcd_mission_get_parent</a>              (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission);
66
60
void                <a class="link" href="McdMission.html#mcd-mission-abort" title="mcd_mission_abort ()">mcd_mission_abort</a>                   (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission);
67
 
void                <a class="link" href="McdMission.html#mcd-mission-set-parent" title="mcd_mission_set_parent ()">mcd_mission_set_parent</a>              (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission,
68
 
                                                         <a class="link" href="McdMission.html" title="McdMission">McdMission</a> *parent);
69
61
void                <a class="link" href="McdMission.html#mcd-mission-connect" title="mcd_mission_connect ()">mcd_mission_connect</a>                 (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission);
70
62
void                <a class="link" href="McdMission.html#mcd-mission-disconnect" title="mcd_mission_disconnect ()">mcd_mission_disconnect</a>              (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission);
71
 
void                <a class="link" href="McdMission.html#mcd-mission-set-flags" title="mcd_mission_set_flags ()">mcd_mission_set_flags</a>               (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission,
72
 
                                                         <a class="link" href="McdMission.html#McdSystemFlags" title="enum McdSystemFlags">McdSystemFlags</a> flags);
73
 
<a class="link" href="McdMission.html#McdSystemFlags" title="enum McdSystemFlags">McdSystemFlags</a>      <a class="link" href="McdMission.html#mcd-mission-get-flags" title="mcd_mission_get_flags ()">mcd_mission_get_flags</a>               (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission);
74
 
void                <a class="link" href="McdMission.html#mcd-mission-set-mode" title="mcd_mission_set_mode ()">mcd_mission_set_mode</a>                (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission,
75
 
                                                         <a class="link" href="McdMission.html#McdMode" title="enum McdMode">McdMode</a> mode);
76
 
<a class="link" href="McdMission.html#McdMode" title="enum McdMode">McdMode</a>             <a class="link" href="McdMission.html#mcd-mission-get-mode" title="mcd_mission_get_mode ()">mcd_mission_get_mode</a>                (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission);
77
63
</pre>
78
64
</div>
79
65
<div class="refsect1" title="Object Hierarchy">
91
77
<div class="refsect1" title="Properties">
92
78
<a name="McdMission.properties"></a><h2>Properties</h2>
93
79
<pre class="synopsis">
94
 
  "<a class="link" href="McdMission.html#McdMission--mode" title='The "mode" property'>mode</a>"                     <a class="link" href="McdMission.html#McdMode" title="enum McdMode">McdMode</a>               : Read / Write
95
80
  "<a class="link" href="McdMission.html#McdMission--parent" title='The "parent" property'>parent</a>"                   <a class="link" href="McdMission.html" title="McdMission">McdMission</a>*           : Read / Write
96
 
  "<a class="link" href="McdMission.html#McdMission--system-flags" title='The "system-flags" property'>system-flags</a>"             <a class="link" href="McdMission.html#McdMode" title="enum McdMode">McdMode</a>               : Read / Write
97
81
</pre>
98
82
</div>
99
83
<div class="refsect1" title="Signals">
102
86
  "<a class="link" href="McdMission.html#McdMission-abort" title='The "abort" signal'>abort</a>"                                          : Run First
103
87
  "<a class="link" href="McdMission.html#McdMission-connected" title='The "connected" signal'>connected</a>"                                      : Run First
104
88
  "<a class="link" href="McdMission.html#McdMission-disconnected" title='The "disconnected" signal'>disconnected</a>"                                   : Run First
105
 
  "<a class="link" href="McdMission.html#McdMission-flags-changed" title='The "flags-changed" signal'>flags-changed</a>"                                  : Run First
106
 
  "<a class="link" href="McdMission.html#McdMission-mode-set" title='The "mode-set" signal'>mode-set</a>"                                       : Run First
107
89
  "<a class="link" href="McdMission.html#McdMission-parent-set" title='The "parent-set" signal'>parent-set</a>"                                     : Run First
108
90
</pre>
109
91
</div>
140
122
</p>
141
123
</div>
142
124
<hr>
143
 
<div class="refsect2" title="MCD_MISSION_GET_FLAGS_MASKED()">
144
 
<a name="MCD-MISSION-GET-FLAGS-MASKED--CAPS"></a><h3>MCD_MISSION_GET_FLAGS_MASKED()</h3>
145
 
<pre class="programlisting">#define             MCD_MISSION_GET_FLAGS_MASKED(mission, flags)</pre>
146
 
<p>
147
 
</p>
148
 
<div class="variablelist"><table border="0">
149
 
<col align="left" valign="top">
150
 
<tbody>
151
 
<tr>
152
 
<td><p><span class="term"><em class="parameter"><code>mission</code></em> :</span></p></td>
153
 
<td>
154
 
</td>
155
 
</tr>
156
 
<tr>
157
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
158
 
<td>
159
 
</td>
160
 
</tr>
161
 
</tbody>
162
 
</table></div>
163
 
</div>
164
 
<hr>
165
 
<div class="refsect2" title="MCD_MISSION_SET_FLAGS_MASKED()">
166
 
<a name="MCD-MISSION-SET-FLAGS-MASKED--CAPS"></a><h3>MCD_MISSION_SET_FLAGS_MASKED()</h3>
167
 
<pre class="programlisting">#define             MCD_MISSION_SET_FLAGS_MASKED(mission, flags)</pre>
168
 
<p>
169
 
</p>
170
 
<div class="variablelist"><table border="0">
171
 
<col align="left" valign="top">
172
 
<tbody>
173
 
<tr>
174
 
<td><p><span class="term"><em class="parameter"><code>mission</code></em> :</span></p></td>
175
 
<td>
176
 
</td>
177
 
</tr>
178
 
<tr>
179
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
180
 
<td>
181
 
</td>
182
 
</tr>
183
 
</tbody>
184
 
</table></div>
185
 
</div>
186
 
<hr>
187
 
<div class="refsect2" title="MCD_MISSION_UNSET_FLAGS_MASKED()">
188
 
<a name="MCD-MISSION-UNSET-FLAGS-MASKED--CAPS"></a><h3>MCD_MISSION_UNSET_FLAGS_MASKED()</h3>
189
 
<pre class="programlisting">#define             MCD_MISSION_UNSET_FLAGS_MASKED(mission, flags)</pre>
190
 
<p>
191
 
</p>
192
 
<div class="variablelist"><table border="0">
193
 
<col align="left" valign="top">
194
 
<tbody>
195
 
<tr>
196
 
<td><p><span class="term"><em class="parameter"><code>mission</code></em> :</span></p></td>
197
 
<td>
198
 
</td>
199
 
</tr>
200
 
<tr>
201
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
202
 
<td>
203
 
</td>
204
 
</tr>
205
 
</tbody>
206
 
</table></div>
207
 
</div>
208
 
<hr>
209
 
<div class="refsect2" title="enum McdMode">
210
 
<a name="McdMode"></a><h3>enum McdMode</h3>
211
 
<pre class="programlisting">typedef enum
212
 
{
213
 
    MCD_MODE_UNKNOWN,
214
 
    MCD_MODE_NORMAL,
215
 
    MCD_MODE_RESTRICTED,
216
 
    MCD_MODE_CALL
217
 
} McdMode;
218
 
</pre>
219
 
<p>
220
 
</p>
221
 
</div>
222
 
<hr>
223
 
<div class="refsect2" title="enum McdSystemFlags">
224
 
<a name="McdSystemFlags"></a><h3>enum McdSystemFlags</h3>
225
 
<pre class="programlisting">typedef enum
226
 
{
227
 
    MCD_SYSTEM_CONNECTED          = 1,
228
 
    MCD_SYSTEM_MEMORY_CONSERVED   = 1 &lt;&lt; 1,
229
 
    MCD_SYSTEM_POWER_CONSERVED    = 1 &lt;&lt; 2,
230
 
    MCD_SYSTEM_SCREEN_BLANKED     = 1 &lt;&lt; 3,
231
 
    MCD_SYSTEM_LOCKED             = 1 &lt;&lt; 4,
232
 
    MCD_SYSTEM_IDLE               = 1 &lt;&lt; 5
233
 
} McdSystemFlags;
234
 
</pre>
235
 
<p>
236
 
</p>
237
 
</div>
238
 
<hr>
239
 
<div class="refsect2" title="mcd_mission_new ()">
240
 
<a name="mcd-mission-new"></a><h3>mcd_mission_new ()</h3>
241
 
<pre class="programlisting"><a class="link" href="McdMission.html" title="McdMission">McdMission</a> *        mcd_mission_new                     (void);</pre>
242
 
<p>
243
 
</p>
244
 
<div class="variablelist"><table border="0">
245
 
<col align="left" valign="top">
246
 
<tbody><tr>
247
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
248
 
<td>
249
 
</td>
250
 
</tr></tbody>
251
 
</table></div>
252
 
</div>
253
 
<hr>
254
125
<div class="refsect2" title="mcd_mission_is_connected ()">
255
126
<a name="mcd-mission-is-connected"></a><h3>mcd_mission_is_connected ()</h3>
256
127
<pre class="programlisting"><a
312
183
</table></div>
313
184
</div>
314
185
<hr>
315
 
<div class="refsect2" title="mcd_mission_set_parent ()">
316
 
<a name="mcd-mission-set-parent"></a><h3>mcd_mission_set_parent ()</h3>
317
 
<pre class="programlisting">void                mcd_mission_set_parent              (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission,
318
 
                                                         <a class="link" href="McdMission.html" title="McdMission">McdMission</a> *parent);</pre>
319
 
<p>
320
 
</p>
321
 
<div class="variablelist"><table border="0">
322
 
<col align="left" valign="top">
323
 
<tbody>
324
 
<tr>
325
 
<td><p><span class="term"><em class="parameter"><code>mission</code></em> :</span></p></td>
326
 
<td>
327
 
</td>
328
 
</tr>
329
 
<tr>
330
 
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
331
 
<td>
332
 
</td>
333
 
</tr>
334
 
</tbody>
335
 
</table></div>
336
 
</div>
337
 
<hr>
338
186
<div class="refsect2" title="mcd_mission_connect ()">
339
187
<a name="mcd-mission-connect"></a><h3>mcd_mission_connect ()</h3>
340
188
<pre class="programlisting">void                mcd_mission_connect                 (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission);</pre>
364
212
</tr></tbody>
365
213
</table></div>
366
214
</div>
367
 
<hr>
368
 
<div class="refsect2" title="mcd_mission_set_flags ()">
369
 
<a name="mcd-mission-set-flags"></a><h3>mcd_mission_set_flags ()</h3>
370
 
<pre class="programlisting">void                mcd_mission_set_flags               (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission,
371
 
                                                         <a class="link" href="McdMission.html#McdSystemFlags" title="enum McdSystemFlags">McdSystemFlags</a> flags);</pre>
372
 
<p>
373
 
</p>
374
 
<div class="variablelist"><table border="0">
375
 
<col align="left" valign="top">
376
 
<tbody>
377
 
<tr>
378
 
<td><p><span class="term"><em class="parameter"><code>mission</code></em> :</span></p></td>
379
 
<td>
380
 
</td>
381
 
</tr>
382
 
<tr>
383
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
384
 
<td>
385
 
</td>
386
 
</tr>
387
 
</tbody>
388
 
</table></div>
389
 
</div>
390
 
<hr>
391
 
<div class="refsect2" title="mcd_mission_get_flags ()">
392
 
<a name="mcd-mission-get-flags"></a><h3>mcd_mission_get_flags ()</h3>
393
 
<pre class="programlisting"><a class="link" href="McdMission.html#McdSystemFlags" title="enum McdSystemFlags">McdSystemFlags</a>      mcd_mission_get_flags               (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission);</pre>
394
 
<p>
395
 
</p>
396
 
<div class="variablelist"><table border="0">
397
 
<col align="left" valign="top">
398
 
<tbody>
399
 
<tr>
400
 
<td><p><span class="term"><em class="parameter"><code>mission</code></em> :</span></p></td>
401
 
<td>
402
 
</td>
403
 
</tr>
404
 
<tr>
405
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
406
 
<td>
407
 
</td>
408
 
</tr>
409
 
</tbody>
410
 
</table></div>
411
 
</div>
412
 
<hr>
413
 
<div class="refsect2" title="mcd_mission_set_mode ()">
414
 
<a name="mcd-mission-set-mode"></a><h3>mcd_mission_set_mode ()</h3>
415
 
<pre class="programlisting">void                mcd_mission_set_mode                (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission,
416
 
                                                         <a class="link" href="McdMission.html#McdMode" title="enum McdMode">McdMode</a> mode);</pre>
417
 
<p>
418
 
</p>
419
 
<div class="variablelist"><table border="0">
420
 
<col align="left" valign="top">
421
 
<tbody>
422
 
<tr>
423
 
<td><p><span class="term"><em class="parameter"><code>mission</code></em> :</span></p></td>
424
 
<td>
425
 
</td>
426
 
</tr>
427
 
<tr>
428
 
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
429
 
<td>
430
 
</td>
431
 
</tr>
432
 
</tbody>
433
 
</table></div>
434
 
</div>
435
 
<hr>
436
 
<div class="refsect2" title="mcd_mission_get_mode ()">
437
 
<a name="mcd-mission-get-mode"></a><h3>mcd_mission_get_mode ()</h3>
438
 
<pre class="programlisting"><a class="link" href="McdMission.html#McdMode" title="enum McdMode">McdMode</a>             mcd_mission_get_mode                (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mission);</pre>
439
 
<p>
440
 
</p>
441
 
<div class="variablelist"><table border="0">
442
 
<col align="left" valign="top">
443
 
<tbody>
444
 
<tr>
445
 
<td><p><span class="term"><em class="parameter"><code>mission</code></em> :</span></p></td>
446
 
<td>
447
 
</td>
448
 
</tr>
449
 
<tr>
450
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
451
 
<td>
452
 
</td>
453
 
</tr>
454
 
</tbody>
455
 
</table></div>
456
 
</div>
457
215
</div>
458
216
<div class="refsect1" title="Property Details">
459
217
<a name="McdMission.property-details"></a><h2>Property Details</h2>
460
 
<div class="refsect2" title='The "mode" property'>
461
 
<a name="McdMission--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
462
 
<pre class="programlisting">  "mode"                     <a class="link" href="McdMission.html#McdMode" title="enum McdMode">McdMode</a>               : Read / Write</pre>
463
 
<p>Platform-specific modes.</p>
464
 
<p>Default value: MCD_MODE_NORMAL</p>
465
 
</div>
466
 
<hr>
467
218
<div class="refsect2" title='The "parent" property'>
468
219
<a name="McdMission--parent"></a><h3>The <code class="literal">"parent"</code> property</h3>
469
220
<pre class="programlisting">  "parent"                   <a class="link" href="McdMission.html" title="McdMission">McdMission</a>*           : Read / Write</pre>
470
221
<p>Parent mission.</p>
471
222
</div>
472
 
<hr>
473
 
<div class="refsect2" title='The "system-flags" property'>
474
 
<a name="McdMission--system-flags"></a><h3>The <code class="literal">"system-flags"</code> property</h3>
475
 
<pre class="programlisting">  "system-flags"             <a class="link" href="McdMission.html#McdMode" title="enum McdMode">McdMode</a>               : Read / Write</pre>
476
 
<p>Mission control system flags.</p>
477
 
<p>Default value: MCD_MODE_NORMAL</p>
478
 
</div>
479
223
</div>
480
224
<div class="refsect1" title="Signal Details">
481
225
<a name="McdMission.signal-details"></a><h2>Signal Details</h2>
551
295
</table></div>
552
296
</div>
553
297
<hr>
554
 
<div class="refsect2" title='The "flags-changed" signal'>
555
 
<a name="McdMission-flags-changed"></a><h3>The <code class="literal">"flags-changed"</code> signal</h3>
556
 
<pre class="programlisting">void                user_function                      (<a class="link" href="McdMission.html" title="McdMission">McdMission</a>    *mcdmission,
557
 
                                                        <a class="link" href="McdMission.html#McdSystemFlags" title="enum McdSystemFlags">McdSystemFlags</a> arg1,
558
 
                                                        <a
559
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
560
 
>gpointer</a>       user_data)       : Run First</pre>
561
 
<p>
562
 
</p>
563
 
<div class="variablelist"><table border="0">
564
 
<col align="left" valign="top">
565
 
<tbody>
566
 
<tr>
567
 
<td><p><span class="term"><em class="parameter"><code>mcdmission</code></em> :</span></p></td>
568
 
<td>the object which received the signal.
569
 
</td>
570
 
</tr>
571
 
<tr>
572
 
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
573
 
<td>
574
 
</td>
575
 
</tr>
576
 
<tr>
577
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
578
 
<td>user data set when the signal handler was connected.</td>
579
 
</tr>
580
 
</tbody>
581
 
</table></div>
582
 
</div>
583
 
<hr>
584
 
<div class="refsect2" title='The "mode-set" signal'>
585
 
<a name="McdMission-mode-set"></a><h3>The <code class="literal">"mode-set"</code> signal</h3>
586
 
<pre class="programlisting">void                user_function                      (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mcdmission,
587
 
                                                        <a class="link" href="McdMission.html#McdMode" title="enum McdMode">McdMode</a>     arg1,
588
 
                                                        <a
589
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
590
 
>gpointer</a>    user_data)       : Run First</pre>
591
 
<p>
592
 
</p>
593
 
<div class="variablelist"><table border="0">
594
 
<col align="left" valign="top">
595
 
<tbody>
596
 
<tr>
597
 
<td><p><span class="term"><em class="parameter"><code>mcdmission</code></em> :</span></p></td>
598
 
<td>the object which received the signal.
599
 
</td>
600
 
</tr>
601
 
<tr>
602
 
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
603
 
<td>
604
 
</td>
605
 
</tr>
606
 
<tr>
607
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
608
 
<td>user data set when the signal handler was connected.</td>
609
 
</tr>
610
 
</tbody>
611
 
</table></div>
612
 
</div>
613
 
<hr>
614
298
<div class="refsect2" title='The "parent-set" signal'>
615
299
<a name="McdMission-parent-set"></a><h3>The <code class="literal">"parent-set"</code> signal</h3>
616
300
<pre class="programlisting">void                user_function                      (<a class="link" href="McdMission.html" title="McdMission">McdMission</a> *mcdmission,