← Back to branch summary

~behda/+junk/udisks2.original

« back to all changes in this revision

Viewing changes to doc/tmpl/udisksclient.sgml

  • Committer: behda
  • Date: 2014-05-24 15:15:11 UTC
  • Revision ID: pauvitk@gmail.com-20140524151511-3vtr0uubjewx3z2j
Initial commit of source code and Debian packaging.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/tmpl/udisksclient.sgml
 
1
<!-- ##### SECTION Title ##### -->
 
2
UDisksClient
 
3
 
 
4
<!-- ##### SECTION Short_Description ##### -->
 
5
 
 
6
 
 
7
<!-- ##### SECTION Long_Description ##### -->
 
8
<para>
 
9
 
 
10
</para>
 
11
 
 
12
 
 
13
<!-- ##### SECTION See_Also ##### -->
 
14
<para>
 
15
 
 
16
</para>
 
17
 
 
18
 
 
19
<!-- ##### SECTION Stability_Level ##### -->
 
20
 
 
21
 
 
22
<!-- ##### SECTION Image ##### -->
 
23
 
 
24
 
 
25
<!-- ##### MACRO UDISKS_MAJOR_VERSION ##### -->
 
26
<para>
 
27
 
 
28
</para>
 
29
 
 
30
 
 
31
 
 
32
<!-- ##### MACRO UDISKS_MINOR_VERSION ##### -->
 
33
<para>
 
34
 
 
35
</para>
 
36
 
 
37
 
 
38
 
 
39
<!-- ##### MACRO UDISKS_MICRO_VERSION ##### -->
 
40
<para>
 
41
 
 
42
</para>
 
43
 
 
44
 
 
45
 
 
46
<!-- ##### MACRO UDISKS_CHECK_VERSION ##### -->
 
47
<para>
 
48
 
 
49
</para>
 
50
 
 
51
@major: 
 
52
@minor: 
 
53
@micro: 
 
54
 
 
55
 
 
56
<!-- ##### STRUCT UDisksClient ##### -->
 
57
<para>
 
58
 
 
59
</para>
 
60
 
 
61
 
 
62
<!-- ##### SIGNAL UDisksClient::changed ##### -->
 
63
<para>
 
64
 
 
65
</para>
 
66
 
 
67
@udisksclient: the object which received the signal.
 
68
 
 
69
<!-- ##### ARG UDisksClient:manager ##### -->
 
70
<para>
 
71
 
 
72
</para>
 
73
 
 
74
<!-- ##### ARG UDisksClient:object-manager ##### -->
 
75
<para>
 
76
 
 
77
</para>
 
78
 
 
79
<!-- ##### FUNCTION udisks_client_new ##### -->
 
80
<para>
 
81
 
 
82
</para>
 
83
 
 
84
@cancellable: 
 
85
@callback: 
 
86
@user_data: 
 
87
 
 
88
 
 
89
<!-- ##### FUNCTION udisks_client_new_finish ##### -->
 
90
<para>
 
91
 
 
92
</para>
 
93
 
 
94
@res: 
 
95
@error: 
 
96
@Returns: 
 
97
 
 
98
 
 
99
<!-- ##### FUNCTION udisks_client_new_sync ##### -->
 
100
<para>
 
101
 
 
102
</para>
 
103
 
 
104
@cancellable: 
 
105
@error: 
 
106
@Returns: 
 
107
 
 
108
 
 
109
<!-- ##### FUNCTION udisks_client_get_object ##### -->
 
110
<para>
 
111
 
 
112
</para>
 
113
 
 
114
@client: 
 
115
@object_path: 
 
116
@Returns: 
 
117
 
 
118
 
 
119
<!-- ##### FUNCTION udisks_client_peek_object ##### -->
 
120
<para>
 
121
 
 
122
</para>
 
123
 
 
124
@client: 
 
125
@object_path: 
 
126
@Returns: 
 
127
 
 
128
 
 
129
<!-- ##### FUNCTION udisks_client_get_object_manager ##### -->
 
130
<para>
 
131
 
 
132
</para>
 
133
 
 
134
@client: 
 
135
@Returns: 
 
136
 
 
137
 
 
138
<!-- ##### FUNCTION udisks_client_get_manager ##### -->
 
139
<para>
 
140
 
 
141
</para>
 
142
 
 
143
@client: 
 
144
@Returns: 
 
145
 
 
146
 
 
147
<!-- ##### FUNCTION udisks_client_settle ##### -->
 
148
<para>
 
149
 
 
150
</para>
 
151
 
 
152
@client: 
 
153
 
 
154
 
 
155
<!-- ##### FUNCTION udisks_client_queue_changed ##### -->
 
156
<para>
 
157
 
 
158
</para>
 
159
 
 
160
@client: 
 
161
 
 
162
 
 
163
<!-- ##### FUNCTION udisks_client_get_jobs_for_object ##### -->
 
164
<para>
 
165
 
 
166
</para>
 
167
 
 
168
@client: 
 
169
@object: 
 
170
@Returns: 
 
171
 
 
172
 
 
173
<!-- ##### FUNCTION udisks_client_get_job_description ##### -->
 
174
<para>
 
175
 
 
176
</para>
 
177
 
 
178
@client: 
 
179
@job: 
 
180
@Returns: 
 
181
 
 
182
 
 
183
<!-- ##### FUNCTION udisks_client_get_block_for_dev ##### -->
 
184
<para>
 
185
 
 
186
</para>
 
187
 
 
188
@client: 
 
189
@block_device_number: 
 
190
@Returns: 
 
191
 
 
192
 
 
193
<!-- ##### FUNCTION udisks_client_get_block_for_label ##### -->
 
194
<para>
 
195
 
 
196
</para>
 
197
 
 
198
@client: 
 
199
@label: 
 
200
@Returns: 
 
201
 
 
202
 
 
203
<!-- ##### FUNCTION udisks_client_get_block_for_uuid ##### -->
 
204
<para>
 
205
 
 
206
</para>
 
207
 
 
208
@client: 
 
209
@uuid: 
 
210
@Returns: 
 
211
 
 
212
 
 
213
<!-- ##### FUNCTION udisks_client_get_block_for_drive ##### -->
 
214
<para>
 
215
 
 
216
</para>
 
217
 
 
218
@client: 
 
219
@drive: 
 
220
@get_physical: 
 
221
@Returns: 
 
222
 
 
223
 
 
224
<!-- ##### FUNCTION udisks_client_get_drive_for_block ##### -->
 
225
<para>
 
226
 
 
227
</para>
 
228
 
 
229
@client: 
 
230
@block: 
 
231
@Returns: 
 
232
 
 
233
 
 
234
<!-- ##### FUNCTION udisks_client_get_cleartext_block ##### -->
 
235
<para>
 
236
 
 
237
</para>
 
238
 
 
239
@client: 
 
240
@block: 
 
241
@Returns: 
 
242
 
 
243
 
 
244
<!-- ##### FUNCTION udisks_client_get_partition_table ##### -->
 
245
<para>
 
246
 
 
247
</para>
 
248
 
 
249
@client: 
 
250
@partition: 
 
251
@Returns: 
 
252
 
 
253
 
 
254
<!-- ##### FUNCTION udisks_client_get_loop_for_block ##### -->
 
255
<para>
 
256
 
 
257
</para>
 
258
 
 
259
@client: 
 
260
@block: 
 
261
@Returns: 
 
262
 
 
263
 
 
264
<!-- ##### FUNCTION udisks_client_get_partitions ##### -->
 
265
<para>
 
266
 
 
267
</para>
 
268
 
 
269
@client: 
 
270
@table: 
 
271
@Returns: 
 
272
 
 
273
 
 
274
<!-- ##### FUNCTION udisks_client_get_drive_siblings ##### -->
 
275
<para>
 
276
 
 
277
</para>
 
278
 
 
279
@client: 
 
280
@drive: 
 
281
@Returns: 
 
282
 
 
283
 
 
284
<!-- ##### FUNCTION udisks_client_get_block_for_mdraid ##### -->
 
285
<para>
 
286
 
 
287
</para>
 
288
 
 
289
@client: 
 
290
@raid: 
 
291
@Returns: 
 
292
 
 
293
 
 
294
<!-- ##### FUNCTION udisks_client_get_all_blocks_for_mdraid ##### -->
 
295
<para>
 
296
 
 
297
</para>
 
298
 
 
299
@client: 
 
300
@raid: 
 
301
@Returns: 
 
302
 
 
303
 
 
304
<!-- ##### FUNCTION udisks_client_get_members_for_mdraid ##### -->
 
305
<para>
 
306
 
 
307
</para>
 
308
 
 
309
@client: 
 
310
@raid: 
 
311
@Returns: 
 
312
 
 
313
 
 
314
<!-- ##### FUNCTION udisks_client_get_mdraid_for_block ##### -->
 
315
<para>
 
316
 
 
317
</para>
 
318
 
 
319
@client: 
 
320
@block: 
 
321
@Returns: 
 
322
 
 
323
 
 
324
<!-- ##### FUNCTION udisks_client_get_object_info ##### -->
 
325
<para>
 
326
 
 
327
</para>
 
328
 
 
329
@client: 
 
330
@object: 
 
331
@Returns: 
 
332
 
 
333
 
 
334
<!-- ##### FUNCTION udisks_client_get_drive_info ##### -->
 
335
<para>
 
336
 
 
337
</para>
 
338
 
 
339
@client: 
 
340
@drive: 
 
341
@out_name: 
 
342
@out_description: 
 
343
@out_drive_icon: 
 
344
@out_media_description: 
 
345
@out_media_icon: 
 
346
 
 
347
 
 
348
<!-- ##### FUNCTION udisks_client_get_partition_info ##### -->
 
349
<para>
 
350
 
 
351
</para>
 
352
 
 
353
@client: 
 
354
@partition: 
 
355
@Returns: 
 
356
 
 
357
 
 
358
<!-- ##### FUNCTION udisks_client_get_size_for_display ##### -->
 
359
<para>
 
360
 
 
361
</para>
 
362
 
 
363
@client: 
 
364
@size: 
 
365
@use_pow2: 
 
366
@long_string: 
 
367
@Returns: 
 
368
 
 
369
 
 
370
<!-- ##### FUNCTION udisks_client_get_id_for_display ##### -->
 
371
<para>
 
372
 
 
373
</para>
 
374
 
 
375
@client: 
 
376
@usage: 
 
377
@type: 
 
378
@version: 
 
379
@long_string: 
 
380
@Returns: 
 
381
 
 
382
 
 
383
<!-- ##### FUNCTION udisks_client_get_media_compat_for_display ##### -->
 
384
<para>
 
385
 
 
386
</para>
 
387
 
 
388
@client: 
 
389
@media_compat: 
 
390
@Returns: 
 
391
 
 
392
 
 
393
<!-- ##### STRUCT UDisksPartitionTypeInfo ##### -->
 
394
<para>
 
395
 
 
396
</para>
 
397
 
 
398
@table_type: 
 
399
@table_subtype: 
 
400
@type: 
 
401
@flags: 
 
402
 
 
403
<!-- ##### ENUM UDisksPartitionTypeInfoFlags ##### -->
 
404
<para>
 
405
 
 
406
</para>
 
407
 
 
408
@UDISKS_PARTITION_TYPE_INFO_FLAGS_NONE: 
 
409
@UDISKS_PARTITION_TYPE_INFO_FLAGS_SWAP: 
 
410
@UDISKS_PARTITION_TYPE_INFO_FLAGS_RAID: 
 
411
@UDISKS_PARTITION_TYPE_INFO_FLAGS_HIDDEN: 
 
412
@UDISKS_PARTITION_TYPE_INFO_FLAGS_CREATE_ONLY: 
 
413
@UDISKS_PARTITION_TYPE_INFO_FLAGS_SYSTEM: 
 
414
 
 
415
<!-- ##### FUNCTION udisks_partition_type_info_free ##### -->
 
416
<para>
 
417
 
 
418
</para>
 
419
 
 
420
@info: 
 
421
 
 
422
 
 
423
<!-- ##### FUNCTION udisks_client_get_partition_type_infos ##### -->
 
424
<para>
 
425
 
 
426
</para>
 
427
 
 
428
@client: 
 
429
@partition_table_type: 
 
430
@partition_table_subtype: 
 
431
@Returns: 
 
432
 
 
433
 
 
434
<!-- ##### FUNCTION udisks_client_get_partition_table_subtypes ##### -->
 
435
<para>
 
436
 
 
437
</para>
 
438
 
 
439
@client: 
 
440
@partition_table_type: 
 
441
@Returns: 
 
442
 
 
443
 
 
444
<!-- ##### FUNCTION udisks_client_get_partition_type_for_display ##### -->
 
445
<para>
 
446
 
 
447
</para>
 
448
 
 
449
@client: 
 
450
@partition_table_type: 
 
451
@partition_type: 
 
452
@Returns: 
 
453
 
 
454
 
 
455
<!-- ##### FUNCTION udisks_client_get_partition_type_and_subtype_for_display ##### -->
 
456
<para>
 
457
 
 
458
</para>
 
459
 
 
460
@client: 
 
461
@partition_table_type: 
 
462
@partition_table_subtype: 
 
463
@partition_type: 
 
464
@Returns: 
 
465
 
 
466
 
 
467
<!-- ##### FUNCTION udisks_client_get_partition_table_type_for_display ##### -->
 
468
<para>
 
469
 
 
470
</para>
 
471
 
 
472
@client: 
 
473
@partition_table_type: 
 
474
@Returns: 
 
475
 
 
476
 
 
477
<!-- ##### FUNCTION udisks_client_get_partition_table_subtype_for_display ##### -->
 
478
<para>
 
479
 
 
480
</para>
 
481
 
 
482
@client: 
 
483
@partition_table_type: 
 
484
@partition_table_subtype: 
 
485
@Returns: 
 
486
 
 
487