summaryrefslogtreecommitdiffstats
path: root/python/pyqt/sip/qtnetwork/qftp.sip
blob: f79ecc12b7a45abdafceaa5c8699c675fb89758e (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
// This is the SIP interface definition for QFtp.
//
// Copyright (c) 2007
// 	Riverbank Computing Limited <info@riverbankcomputing.co.uk>
// 
// This file is part of PyQt.
// 
// This copy of PyQt 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.
// 
// PyQt 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
// PyQt; 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>QFtp (Qt v2.2+)</Title>
<FuncSynopsis>
        <FuncDef>Q_LONG <Function>readBlock</Function></FuncDef>
        <ParamDef>char *<Parameter>data</Parameter></ParamDef>
        <ParamDef>Q_ULONG <Parameter>maxlen</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes a single <Literal>maxlen</Literal> parameter.  The
<Literal>data</Literal> is returned if there was no error, otherwise
<Literal>None</Literal> is returned.
</Para>
</Sect2>
%End


%If (Qt_NETWORKPROTOCOL_FTP)
%If (Qt_2_2_0 -)

class QFtp : QNetworkProtocol
{
%TypeHeaderCode
#include <qftp.h>
%End

public:
	QFtp();
%If (Qt_3_1_0 -)
	QFtp(QObject * /TransferThis/,const char * = 0);
%End
	virtual ~QFtp();

%If (Qt_3_0_0 -)
	int supportedOperations() const;
%End
%If (- Qt_3_0_0)
	virtual int supportedOperations() const;
%End

%If (Qt_3_1_0 -)
	enum State {
		Unconnected,
		HostLookup,
		Connecting,
		Connected,
		LoggedIn,
		Closing
	};

	enum Error {
		NoError,
		UnknownError,
		HostNotFound,
		ConnectionRefused,
		NotConnected
	};

	enum Command {
		None,
		ConnectToHost,
		Login,
		Close,
		List,
		Cd,
		Get,
		Put,
		Remove,
		Mkdir,
		Rmdir,
		Rename,
		RawCommand
	};

	int connectToHost(const QString &,Q_UINT16 = 21) /ReleaseGIL/;
	int login(const QString & = QString::null,
		  const QString & = QString::null) /ReleaseGIL/;
	int close() /ReleaseGIL/;
	int list(const QString & = QString::null) /ReleaseGIL/;
	int cd(const QString &) /ReleaseGIL/;
	int get(const QString &,QIODevice * = 0) /ReleaseGIL/;
	int put(const QByteArray &,const QString &) /ReleaseGIL/;
	int put(QIODevice *,const QString &) /ReleaseGIL/;
	int remove(const QString &) /ReleaseGIL/;
	int mkdir(const QString &) /ReleaseGIL/;
	int rmdir(const QString &) /ReleaseGIL/;
	int rename(const QString &,const QString &) /ReleaseGIL/;

	int rawCommand(const QString &) /ReleaseGIL/;

	unsigned long bytesAvailable() const;

	SIP_PYOBJECT readBlock(Q_ULONG) /ReleaseGIL/ [Q_LONG (char *,Q_ULONG)];
%MethodCode
		char *buf;

		if ((buf = (char *)sipMalloc(a0)) == NULL)
			sipIsErr = 1;
		else
		{
			Q_LONG actlen;

			Py_BEGIN_ALLOW_THREADS
			actlen = sipCpp -> QFtp::readBlock(buf,a0);
			Py_END_ALLOW_THREADS

			if (actlen < 0)
			{
				Py_INCREF(Py_None);
				sipRes = Py_None;
			}
			else if ((sipRes = PyString_FromStringAndSize(buf,actlen)) == NULL)
				sipIsErr = 1;

			sipFree((ANY *)buf);
		}
%End

	QByteArray readAll() /ReleaseGIL/;

	int currentId() const;
	QIODevice* currentDevice() const;
	Command currentCommand() const;
	bool hasPendingCommands() const;
	void clearPendingCommands();

	State state() const;

	Error error() const;
	QString errorString() const;
%End

public slots:
%If (Qt_3_1_0 -)
	void abort();
%End

signals:
%If (Qt_3_1_0 -)
	void stateChanged(int);
	void listInfo(const QUrlInfo &);
	void readyRead();
	void dataTransferProgress(int,int);
	void rawCommandReply(int,const QString &);

	void commandStarted(int);
	void commandFinished(int,bool);
	void done(bool);
%End

protected:
	void parseDir(const QString &,QUrlInfo &);
	virtual void operationListChildren(QNetworkOperation *);
	virtual void operationMkDir(QNetworkOperation *);
	virtual void operationRemove(QNetworkOperation *);
	virtual void operationRename(QNetworkOperation *);
	virtual void operationGet(QNetworkOperation *);
	virtual void operationPut(QNetworkOperation *);
};

%End
%End