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
|
// Copyright (C) 2001 Neil Stevens <multivac@fcmail.com>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// THE AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
// AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
// Except as contained in this notice, the name(s) of the author(s) shall not be
// used in advertising or otherwise to promote the sale, use or other dealings
// in this Software without prior written authorization from the author(s).
#ifndef KSAVER_H
#define KSAVER_H
#include <kurl.h>
#include <tqfile.h>
#include <tqstring.h>
#include <textstream.h>
#include <tqdatastream.h>
namespace Noatun
{
/**
* KSaver provides a way to save files in the most efficient way for
* both local and remote URLs.
*/
class KSaver
{
public:
/**
* The constructor takes the url and decides the best way to save,
* which will mean using something like KIO::NetAccess or TQFile.
*/
KSaver(const KURL &_target);
/**
* The destructor closes if necessary.
*/
~KSaver();
/**
* open actually tries to open the file
*
* true on success, false on failure (get the error in @ref error)
*/
bool open(void);
/**
* close closes the file, and uploads if necessary.
*
* true on success, false on failure (get the error in @ref error)
*/
bool close(void);
/**
* If open or close returns false, there was an error, and error
* returns what the error was, when available.
*/
TQString error(void);
/**
* file returns a TQFile open for writing, which may be for a temporary
* file on the local filesystem.
*
* If this is called before the file is opened, you will crash.
*/
TQFile &file(void);
/**
* You can use this to write out your data.
*
* If this is called before the file is opened, you will crash.
*/
TQTextStream &textStream(void);
/**
* You can use this to write out your data.
*
* If this is called before the file is opened, you will crash.
*/
TQDataStream &dataStream(void);
private:
class KSaverPrivate;
KSaverPrivate *d;
};
}
#endif
|
