summaryrefslogtreecommitdiffstats
path: root/sip/qt/qnetworkprotocol.sip
blob: d8f9d1eee4f95ee85511f66d4a35160b2bae0572 (plain)
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
// This is the SIP interface definition for TQNetworkOperation, TQNetworkProtocol
// and TQNetworkProtocolFactoryBase.
//
// Copyright (c) 2007
// 	Riverbank Computing Limited <[email protected]>
// 
// This file is part of PyTQt.
// 
// This copy of PyTQt is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2, or (at your option) any later
// version.
// 
// PyTQt is supplied in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
// 
// You should have received a copy of the GNU General Public License along with
// PyTQt; see the file LICENSE.  If not, write to the Free Software Foundation,
// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


%ExportedDoc
<Sect2><Title>TQNetworkOperation (TQt v2.1+)</Title>
<Para>
<Literal>TQNetworkOperation</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>TQNetworkProtocol (TQt v2.1+)</Title>
<Para>
<Literal>TQNetworkProtocol</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>TQNetworkProtocolFactoryBase (TQt v2.1+)</Title>
<Para>
<Literal>TQNetworkProtocolFactoryBase</Literal> is fully implemented.
</Para>
</Sect2>
%End


%If (TQt_NETWORKPROTOCOL)
%If (TQt_2_1_0 -)

class TQNetworkProtocolFactoryBase
{
%TypeHeaderCode
#include <tqnetworkprotocol.h>
%End

public:
	virtual TQNetworkProtocol *createObject() = 0 /Factory/;

};


class TQNetworkProtocol : TQObject
{
%TypeHeaderCode
#include <tqnetworkprotocol.h>
%End

public:
	enum State {
		StWaiting,
		StInProgress,
		StDone,
		StFailed,
		StStopped
	};

%If (- TQt_3_0_0)
	enum Operation {
		OpListChildren,
		OpMkdir,
		OpRemove,
		OpRename,
		OpGet,
		OpPut
	};
%End
%If (TQt_3_0_0 -)
	enum Operation {
		OpListChildren,
		OpMkDir,
		OpRemove,
		OpRename,
		OpGet,
		OpPut
	};
%End

	enum ConnectionState {
		ConHostFound,
		ConConnected,
		ConClosed
	};

%If (- TQt_3_0_0)
	enum Error {
		NoError,
		ErrValid,
		ErrUnknownProtocol,
		ErrUnsupported,
		ErrParse,
		ErrLoginIncorrect,
		ErrHostNotFound,
		ErrListChlidren,
		ErrMkdir,
		ErrRemove,
		ErrRename,
		ErrGet,
		ErrPut,
		ErrFileNotExisting,
		ErrPermissionDenied
	};
%End
%If (TQt_3_0_0 -)
	enum Error {
		NoError,
		ErrValid,
		ErrUnknownProtocol,
		ErrUnsupported,
		ErrParse,
		ErrLoginIncorrect,
		ErrHostNotFound,
		ErrListChildren,
		ErrMkDir,
		ErrRemove,
		ErrRename,
		ErrGet,
		ErrPut,
		ErrFileNotExisting,
		ErrPermissionDenied
	};
%End

	TQNetworkProtocol();

	virtual void setUrl(TQUrlOperator *);

	virtual void setAutoDelete(bool,int = 10000);
	bool autoDelete() const;

	static void registerNetworkProtocol(const TQString &,
					    TQNetworkProtocolFactoryBase *);
	static TQNetworkProtocol *getNetworkProtocol(const TQString &) /Factory/;
	static bool hasOnlyLocalFileSystem();

	virtual int supportedOperations() const;
	virtual void addOperation(TQNetworkOperation *);

	TQUrlOperator *url() const;
	TQNetworkOperation *operationInProgress() const;
	virtual void clearOperationQueue();
	virtual void stop();

signals:
	void data(const TQByteArray &,TQNetworkOperation *);
	void connectionStateChanged(int,const TQString &);
	void finished(TQNetworkOperation *);
	void start(TQNetworkOperation *);
	void newChildren(const TQValueList<TQUrlInfo> &,TQNetworkOperation *);
	void newChild(const TQUrlInfo &,TQNetworkOperation *);
	void createdDirectory(const TQUrlInfo &,TQNetworkOperation *);
	void removed(TQNetworkOperation *);
	void itemChanged(TQNetworkOperation *);
	void dataTransferProgress(int,int,TQNetworkOperation *);

protected:
	virtual void processOperation(TQNetworkOperation *);
	virtual void operationListChildren(TQNetworkOperation *);
	virtual void operationMkDir(TQNetworkOperation *);
	virtual void operationRemove(TQNetworkOperation *);
	virtual void operationRename(TQNetworkOperation *);
	virtual void operationGet(TQNetworkOperation *);
	virtual void operationPut(TQNetworkOperation *);
%If (TQt_3_0_0 -)
	virtual void operationPutChunk(TQNetworkOperation *);
%End
	virtual bool checkConnection(TQNetworkOperation *);

private:
%If (TQt_3_1_0 -)
	TQNetworkProtocol(const TQNetworkProtocol &);
%End
};


class TQNetworkOperation : TQObject
{
%TypeHeaderCode
#include <tqnetworkprotocol.h>
%End

public:
	TQNetworkOperation(TQNetworkProtocol::Operation,const TQString &,
			  const TQString &,const TQString &);
	TQNetworkOperation(TQNetworkProtocol::Operation,const TQByteArray &,
			  const TQByteArray &,const TQByteArray &);

	void setState(TQNetworkProtocol::State);
	void setProtocolDetail(const TQString &);
	void setErrorCode(int);
	void setArg(int,const TQString &);
	void setRawArg(int,const TQByteArray &);

	TQNetworkProtocol::Operation operation() const;
	TQNetworkProtocol::State state() const;
	TQString arg(int) const;
	TQByteArray rawArg(int) const;
	TQString protocolDetail() const;
	int errorCode() const;

	void free();

private:
%If (TQt_3_1_0 -)
	TQNetworkOperation(const TQNetworkOperation &);
%End
};

%End
%End