summaryrefslogtreecommitdiffstats
path: root/python/pyqt/sip/qt/qfiledialog.sip
blob: 3e1df96319bb5a95614cb7c9f0ff2c4dee131eaf (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
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
// This is the SIP interface definition for QFileDialog, QFileIconProvider and
// QFilePreview.
//
// 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.


%ExportedDoc
<Sect2><Title>QFileDialog</Title>
<Para>
<Literal>QFileDialog</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QFileIconProvider</Title>
<Para>
<Literal>QFileIconProvider</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QFilePreview</Title>
<Para>
<Literal>QFilePreview</Literal> is fully implemented.  However it cannot be
used from Python in the same way as it is used from C++ because PyQt does not
support multiple inheritance involving more than one wrapped class.  A trick
that seems to work is to use composition rather than inheritance as in the
following code fragment.
</Para>
<ProgramListing>
class FilePreview(QFilePreview):
    pass

class Preview(QLabel):
    def __init__(self, parent=None):
        QLabel.__init__(self, parent)
        self.preview = FilePreview()
        self.preview.previewUrl = self.previewUrl
</ProgramListing>
<Para>
Note that QFilePreview cannot be instantiated directly because it is abstract.
Thanks to Hans-Peter Jansen for this trick.
</Para>
</Sect2>
%End


%If (Qt_FILEDIALOG)

class QFileIconProvider : QObject
{
%TypeHeaderCode
#include <qfiledialog.h>
%End

public:
	QFileIconProvider(QObject * /TransferThis/ = 0,const char * = 0);

	virtual const QPixmap *pixmap(const QFileInfo &);

private:
%If (Qt_2_1_0 -)
	QFileIconProvider(const QFileIconProvider &);
%End
};


%If (Qt_2_1_0 -)
class QFilePreview
{
%TypeHeaderCode
#include <qfiledialog.h>
%End

public:
	QFilePreview();

	virtual void previewUrl(const QUrl &) = 0;
};
%End


class QFileDialog : QDialog
{
%TypeHeaderCode
#include <qfiledialog.h>
%End

public:
%If (- Qt_2_00)
	QFileDialog(const char *,const char * = 0,QWidget * /TransferThis/ = 0,
		    const char * = 0,bool = 0);
%End
%If (Qt_2_00 -)
	QFileDialog(const QString &,const QString & = QString::null,
		    QWidget * /TransferThis/ = 0,const char * = 0,bool = 0);
%End
	QFileDialog(QWidget * /TransferThis/ = 0,const char * = 0,bool = 0);

%If (- Qt_2_00)
	static QString getOpenFileName(const char * = 0,const char * = 0,
				       QWidget * = 0,
				       const char * = 0) /ReleaseGIL/;
	static QString getSaveFileName(const char * = 0,const char * = 0,
				       QWidget * = 0,
				       const char * = 0) /ReleaseGIL/;
	static QString getExistingDirectory(const char * = 0,QWidget * = 0,
					    const char * = 0) /ReleaseGIL/;
	static QStrList getOpenFileNames(const char * = 0,const char * = 0,
					 QWidget * = 0,
					 const char * = 0) /ReleaseGIL/;
%End
%If (Qt_2_00 - Qt_3_0_0)
	static QString getOpenFileName(const QString & = QString::null,
				       const QString & = QString::null,
				       QWidget * = 0,
				       const char * = 0) /ReleaseGIL/;
	static QString getSaveFileName(const QString & = QString::null,
				       const QString & = QString::null,
				       QWidget * = 0,
				       const char * = 0) /ReleaseGIL/;
	static QString getExistingDirectory(const QString & = QString::null,
					    QWidget * = 0,
					    const char * = 0) /ReleaseGIL/;
	static QStringList getOpenFileNames(const QString & = QString::null,
					    const QString & = QString::null,
					    QWidget * = 0,
					    const char * = 0) /ReleaseGIL/;
%End
%If (Qt_2_1_0 - Qt_3_0_0)
	static QString getOpenFileName(const QString &,const QString &,
				       QWidget *,const char *,
				       const QString &) /ReleaseGIL/;
	static QString getSaveFileName(const QString &,const QString &,
				       QWidget *,const char *,
				       const QString &) /ReleaseGIL/;
	static QString getExistingDirectory(const QString &,QWidget *,
					    const char *,
					    const QString &) /ReleaseGIL/;
	static QStringList getOpenFileNames(const QString &,const QString &,
					   QWidget *,const char *,
					   const QString &) /ReleaseGIL/;
%End
%If (Qt_2_2_0 - Qt_3_0_0)
	static QString getExistingDirectory(const QString &,QWidget *,
					    const char *,
					    const QString &,bool) /ReleaseGIL/;
%End
%If (Qt_3_0_0 -)
	static QString getOpenFileName(const QString & = QString::null,
				       const QString & = QString::null,
				       QWidget * = 0,const char * = 0,
				       const QString & = QString::null,
				       QString * = 0,bool = 1) /ReleaseGIL/;

	static QString getSaveFileName(const QString & = QString::null,
				       const QString & = QString::null,
				       QWidget * = 0,const char * = 0,
				       const QString & = QString::null,
				       QString * = 0,bool = 1) /ReleaseGIL/;

	static QString getExistingDirectory(const QString & = QString::null,
					    QWidget * = 0,const char * = 0,
					    const QString & = QString::null,
					    bool = 1,bool = 1) /ReleaseGIL/;

	static QStringList getOpenFileNames(const QString & = QString::null,
					    const QString & = QString::null,
					    QWidget * = 0,const char * = 0,
					    const QString & = QString::null,
					    QString * = 0,
					    bool = 1) /ReleaseGIL/;

%End

	static void setIconProvider(QFileIconProvider *);
	static QFileIconProvider *iconProvider();

	QString selectedFile() const;
%If (Qt_2_1_0 -)
	QString selectedFilter() const;
%End
%If (Qt_3_0_0 -)
	virtual void setSelectedFilter(const QString &);
	virtual void setSelectedFilter(int);
%End

%If (- Qt_2_00)
	void setSelection(const char *);
%End
%If (Qt_2_00 -)
	void setSelection(const QString &);
%End

%If (Qt_2_1_0 -)
	void selectAll(bool);

	QStringList selectedFiles() const;
%End

%If (- Qt_2_00)
	const char *dirPath() const;
%End
%If (Qt_2_00 -)
	QString dirPath() const;
%End

	void setDir(const QDir &);
	const QDir* dir() const;

%If (Qt_2_1_0 -)
	void setShowHiddenFiles(bool);
	bool showHiddenFiles() const;
%End

	void rereadDir() /ReleaseGIL/;
%If (Qt_2_1_0 -)
	void resortDir();
%End

%If (- Qt_2_2_0)
	enum Mode {
		AnyFile,
		ExistingFile,
		Directory,
		ExistingFiles
	};
%End
%If (Qt_2_2_0 -)
	enum Mode {
		AnyFile,
		ExistingFile,
		Directory,
		ExistingFiles,
		DirectoryOnly
	};
%End

	void setMode(Mode);
	Mode mode() const;

%If (Qt_2_1_0 -)
	enum ViewMode {
		Detail,
		List
	};

	enum PreviewMode {
		NoPreview,
		Contents,
		Info
	};

	void setViewMode(ViewMode);
	ViewMode viewMode() const;
	void setPreviewMode(PreviewMode);
	PreviewMode previewMode() const;
%End

	bool eventFilter(QObject *,QEvent *);

%If (Qt_2_1_0 -)
	bool isInfoPreviewEnabled() const;
	bool isContentsPreviewEnabled() const;
	void setInfoPreviewEnabled(bool);
	void setContentsPreviewEnabled(bool);

	void setInfoPreview(QWidget *,QFilePreview *);
	void setContentsPreview(QWidget *,QFilePreview *);

	QUrl url() const;
%End

%If (Qt_3_0_0 -)
	void addFilter(const QString &);
%End

public slots:
%If (Qt_2_2_0 -)
	void done(int);
%End
%If (- Qt_2_00)
	void setDir(const char *);
%End
%If (Qt_2_00 -)
	void setDir(const QString &);
%End
%If (Qt_2_1_0 -)
	void setUrl(const QUrlOperator &);
%End
%If (- Qt_2_00)
	void setFilter(const char *);
%End
%If (Qt_2_00 -)
	void setFilter(const QString &);
%End
%If (Qt_2_1_0 -)
	void setFilters(const QString &);
%End
//	void setFilters(const char **);
%If (- Qt_2_00)
	void setFilters(const QStrList &);
%End
%If (Qt_2_00 -)
	void setFilters(const QStringList &);
%End

signals:
%If (- Qt_2_00)
	void fileHighlighted(const char *);
	void fileSelected(const char *);
	void dirEntered(const char *);
%End
%If (Qt_2_00 -)
	void fileHighlighted(const QString &);
	void fileSelected(const QString &);
%End
%If (Qt_3_0_0 -)
	void filesSelected(const QStringList &);
%End
%If (Qt_2_00 -)
	void dirEntered(const QString &);
%End
%If (Qt_3_0_0 -)
	void filterSelected(const QString &);
%End

protected:
	void resizeEvent(QResizeEvent *);
	void keyPressEvent(QKeyEvent *);

	void addWidgets(QLabel *,QWidget *,QPushButton *);
%If (Qt_2_1_0 -)
	void addToolButton(QButton *,bool = 0);
	void addLeftWidget(QWidget *);
	void addRightWidget(QWidget *);
%End
%If (Qt_2_1_0 - Qt_3_0_0)
	void addFilter(const QString &);
%End

private:
	QFileDialog(const QFileDialog &);
};

%End