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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KSaveFile</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KSaveFile Class Reference</h1>
<code>from PyKDE4.kdecore import *</code>
<p>
Inherits: QFile → QIODevice → QObject<br />
<h2>Detailed Description</h2>
<p>\class KSaveFile ksavefile.h <KSaveFile>
</p>
<p>
Class to allow for atomic file I/O, as well as utility functions.
</p>
<p>
The KSaveFile class has been made to write out changes to an existing
file atomically. This means that either <b>ALL</b> changes will be written
to the file, or <b>NO</b> changes have been written, and the original file
(if any) has been unchanged. This is useful if you have lots of
time-consuming processing to perform during which an interruption could
occur, or if any error in the file structure will cause the entire file
to be corrupt.
</p>
<p>
When you create a KSaveFile for a given file, a temporary file is instead
created and all your I/O occurs in the save file. Once you call finalize()
the temporary file is renamed to the target file, so that all your changes
happen at once. If abort() is called then the temporary file is removed and
the target file is untouched. KSaveFile derives from QFile so you can use
it just as you would a normal QFile.
</p>
<p>
This class also includes several static utility functions available that
can help ensure data integrity. See the individual functions for details.
</p>
<p>
Here is a quick example of how to use KSaveFile:
</p>
<p>
First we create the KSaveFile and open it.
</p>
<p>
<pre class="fragment">
KSaveFile saveFile;
saveFile.setFileName("/lib/foo/bar.dat");
if ( !saveFile.open() ) {
//Handle error
}
</pre>
</p>
<p>
At this point the file "/lib/foo/bar.dat" has not been altered in any way.
Now, let's write out some data to the file.
</p>
<p>
<pre class="fragment">
QTextStream stream ( &saveFile );
stream << "Add some data.";
// Perform long processing
stream << "Add some more data.";
stream.flush();
</pre>
</p>
<p>
Even after writing this data, the target file "/lib/foo/bar.dat" still has
not been altered in any way. Now that we are done writing our data, we can
write out all the changes that we have made by calling finalize().
</p>
<p>
<pre class="fragment">
if ( !saveFile.finalize() ) {
//Handle error
}
</pre>
</p>
<p>
If a user interruption or error occurred while we were writing out our
changes, we would instead call abort() to cancel all the I/O without
affecting the target file.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> QFile
</dd></dl> </p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Jaison Lee <lee.jaison@gmail.com> </dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Waldo Bastian <bastian@kde.org> </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KSaveFile">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KSaveFile">__init__</a> (self, QString filename, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData=KGlobal.mainComponent())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KSaveFile">__init__</a> (self, <a href="../kdecore/KSaveFile.html">KSaveFile</a> a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abort">abort</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QFile::FileError </td><td class="memItemRight" valign="bottom"><a class="el" href="#error">error</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#errorString">errorString</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#fileName">fileName</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#finalize">finalize</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#open">open</a> (self, QIODevice::OpenMode flags=QIODevice.ReadWrite)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFileName">setFileName</a> (self, QString filename)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#backupFile">backupFile</a> (QString filename, QString backupDir=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#numberedBackupFile">numberedBackupFile</a> (QString filename, QString backupDir=QString(), QString backupExtension=QString.fromLatin1("~"), long maxBackups=10)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#rcsBackupFile">rcsBackupFile</a> (QString filename, QString backupDir=QString(), QString backupMessage=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#simpleBackupFile">simpleBackupFile</a> (QString filename, QString backupDir=QString(), QString backupExtension=QLatin1String("~"))</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KSaveFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Default constructor.
</p></div></div><a class="anchor" name="KSaveFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a> </td>
<td class="paramname"><em>componentData=KGlobal.mainComponent()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates a new KSaveFile and sets the target file to <b>filename.</b>
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>filename</em> </td><td> the path of the file
<tr><td></td><td valign="top"><em>componentData</em> </td><td> unused
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="KSaveFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KSaveFile.html">KSaveFile</a> </td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Default constructor.
</p></div></div><a class="anchor" name="abort"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> abort</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Discard changes without affecting the target file.
This will discard all changes that have been made to this file.
The target file will not be altered in any way.
</p></div></div><a class="anchor" name="error"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QFile::FileError error</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the last error that occurred.
Use this function to check for errors.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The last error that occurred, or QFile.NoError.
</dd></dl>
</p></div></div><a class="anchor" name="errorString"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString errorString</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns a human-readable description of the last error.
Use this function to get a human-readable description of the
last error that occurred.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> A string describing the last error that occurred.
</dd></dl>
</p></div></div><a class="anchor" name="fileName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString fileName</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the name of the target file.
This function returns the name of the target file, or an empty
QString if it has not yet been set.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The name of the target file.
</dd></dl>
</p></div></div><a class="anchor" name="finalize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool finalize</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Finalize changes to the file.
This will commit all the changes that have been made to the file.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if successful, or false if an error has occurred.
</dd></dl>
</p></div></div><a class="anchor" name="open"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool open</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QIODevice::OpenMode </td>
<td class="paramname"><em>flags=QIODevice.ReadWrite</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Open the save file.
This function will open the save file by creating a temporary file to write
to. It will also check to ensure that there are sufficient permissions to
write to the target file.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>flags</em> </td><td> Sets the QIODevice.OpenMode. It should contain the write flag, otherwise you
have a save file you cannot save to.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if successful, or false if an error has occurred.
</dd></dl>
</p></div></div><a class="anchor" name="setFileName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setFileName</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>filename</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the target filename for the save file.
You must use this to set the filename of the target file if you do
not use the contructor that does so.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>filename</em> </td><td> Name of the target file.
</td></tr>
</table></dl>
<p>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="backupFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool backupFile</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>backupDir=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Static method to create a backup file before saving.
</p>
<p>
If empty (the default), the backup will be in the same directory as <b>filename.</b>
The backup type (simple, rcs, or numbered), extension string, and maximum
number of backup files are read from the user's global configuration.
Use simpleBackupFile() or numberedBackupFile() to force one of these
specific backup styles.
You can use this method even if you don't use KSaveFile.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>filename</em> </td><td> the file to backup
<tr><td></td><td valign="top"><em>backupDir</em> </td><td> optional directory where to save the backup file in.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if successful, or false if an error has occurred.
</dd></dl>
</p></div></div><a class="anchor" name="numberedBackupFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool numberedBackupFile</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>backupDir=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>backupExtension=QString.fromLatin1("~")</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>maxBackups=10</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Static method to create a backup file for a given filename.
</p>
<p>
This function creates a series of numbered backup files from the
given filename.
</p>
<p>
The backup file names will be of the form:
<name>.<number><extension>
for instance
<pre> chat.3.log </pre>
</p>
<p>
The new backup file will be have the backup number 1.
Each existing backup file will have its number incremented by 1.
Any backup files with numbers greater than the maximum number
permitted (@p maxBackups) will be removed.
You can use this method even if you don't use KSaveFile.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>filename</em> </td><td> the file to backup
<tr><td></td><td valign="top"><em>backupDir</em> </td><td> optional directory where to save the backup file in.
If empty (the default), the backup will be in the same directory as
<b>filename.</b>
<tr><td></td><td valign="top"><em>backupExtension</em> </td><td> the extension to append to <b>filename,</b>
which is "~" by default. Do not use an extension containing digits.
<tr><td></td><td valign="top"><em>maxBackups</em> </td><td> the maximum number of backup files permitted.
For best performance a small number (10) is recommended.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if successful, or false if an error has occurred.
</dd></dl>
</p></div></div><a class="anchor" name="rcsBackupFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool rcsBackupFile</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>backupDir=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>backupMessage=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Static method to create an rcs backup file for a given filename.
</p>
<p>
This function creates a rcs-formatted backup file from the
given filename.
</p>
<p>
The backup file names will be of the form:
<name>,v
for instance
<pre> photo.jpg,v </pre>
</p>
<p>
The new backup file will be in RCS format.
Each existing backup file will be committed as a new revision.
You can use this method even if you don't use KSaveFile.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>filename</em> </td><td> the file to backup
<tr><td></td><td valign="top"><em>backupDir</em> </td><td> optional directory where to save the backup file in.
If empty (the default), the backup will be in the same directory as
<b>filename.</b>
<tr><td></td><td valign="top"><em>backupMessage</em> </td><td> is the RCS commit message for this revision.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if successful, or false if an error has occurred.
</dd></dl>
</p></div></div><a class="anchor" name="simpleBackupFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool simpleBackupFile</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>backupDir=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>backupExtension=QLatin1String("~")</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Static method to create a backup file for a given filename.
</p>
<p>
This function creates a backup file from the given filename.
You can use this method even if you don't use KSaveFile.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>filename</em> </td><td> the file to backup
<tr><td></td><td valign="top"><em>backupDir</em> </td><td> optional directory where to save the backup file in.
If empty (the default), the backup will be in the same directory as <b>filename.</b>
<tr><td></td><td valign="top"><em>backupExtension</em> </td><td> the extension to append to <b>filename,</b> "~" by default.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if successful, or false if an error has occurred.
</dd></dl>
</p></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
|
