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
|
# -*- coding: utf-8 -*-
"""
tkfilebrowser - Alternative to filedialog for Tkinter
Copyright 2017-2018 Juliette Monsel <j_4321@protonmail.com>
tkfilebrowser 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 3 of the License, or
(at your option) any later version.
tkfilebrowser is distributed 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 this program. If not, see <http://www.gnu.org/licenses/>.
Functions
"""
from .constants import _
from .filebrowser import FileBrowser
def askopenpathname(parent=None, title=_("Open"), **kwargs):
r"""
Return :obj:`''` or the absolute path of the chosen path (file or directory).
Arguments:
parent : Tk or Toplevel instance
parent window
title : str
the title of the filebrowser window
initialdir : str
directory whose content is initially displayed
initialfile : str
initially selected item (just the name, not the full path)
filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
only the files of given filetype will be displayed,
e.g. to allow the user to switch between displaying only PNG or JPG
pictures or dispalying all files:
:obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
okbuttontext : str
text displayed on the validate button, default is "Open".
cancelbuttontext : str
text displayed on the button that cancels the selection, default is "Cancel".
foldercreation : bool
enable the user to create new folders if True (default)
"""
dialog = FileBrowser(parent, mode="openpath", multiple_selection=False,
title=title, **kwargs)
dialog.wait_window(dialog)
return dialog.get_result()
def askopenpathnames(parent=None, title=_("Open"), **kwargs):
r"""
Return :obj:`()` or the tuple of the absolute paths of the chosen paths (files and directories)
Arguments:
parent : Tk or Toplevel instance
parent window
title : str
the title of the filebrowser window
initialdir : str
directory whose content is initially displayed
initialfile : str
initially selected item (just the name, not the full path)
filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
only the files of given filetype will be displayed,
e.g. to allow the user to switch between displaying only PNG or JPG
pictures or dispalying all files:
:obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
okbuttontext : str
text displayed on the validate button, default is "Open".
cancelbuttontext : str
text displayed on the button that cancels the selection, default is "Cancel".
foldercreation : bool
enable the user to create new folders if True (default)
"""
dialog = FileBrowser(parent, mode="openpath", multiple_selection=True,
title=title, **kwargs)
dialog.wait_window(dialog)
res = dialog.get_result()
if not res: # type consistency: always return a tuple
res = ()
return res
def askopendirname(parent=None, title=_("Open"), **kwargs):
r"""
Return :obj:`''` or the absolute path of the chosen directory.
Arguments:
parent : Tk or Toplevel instance
parent window
title : str
the title of the filebrowser window
initialdir : str
directory whose content is initially displayed
initialfile : str
initially selected item (just the name, not the full path)
filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
only the files of given filetype will be displayed,
e.g. to allow the user to switch between displaying only PNG or JPG
pictures or dispalying all files:
:obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
okbuttontext : str
text displayed on the validate button, default is "Open".
cancelbuttontext : str
text displayed on the button that cancels the selection, default is "Cancel".
foldercreation : bool
enable the user to create new folders if True (default)
"""
dialog = FileBrowser(parent, mode="opendir", multiple_selection=False,
title=title, **kwargs)
dialog.wait_window(dialog)
return dialog.get_result()
def askdirectory(parent=None, title=_("Open"), **kwargs):
"""
Alias for askopendirname, for tk.filedialog compatibility
"""
return askopendirname(parent=parent, title=title, **kwargs)
def askopendirnames(parent=None, title=_("Open"), **kwargs):
r"""
Return :obj:`()` or the tuple of the absolute paths of the chosen directories
Arguments:
parent : Tk or Toplevel instance
parent window
title : str
the title of the filebrowser window
initialdir : str
directory whose content is initially displayed
initialfile : str
initially selected item (just the name, not the full path)
filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
only the files of given filetype will be displayed,
e.g. to allow the user to switch between displaying only PNG or JPG
pictures or dispalying all files:
:obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
okbuttontext : str
text displayed on the validate button, default is "Open".
cancelbuttontext : str
text displayed on the button that cancels the selection, default is "Cancel".
foldercreation : bool
enable the user to create new folders if True (default)
"""
dialog = FileBrowser(parent, mode="opendir", multiple_selection=True,
title=title, **kwargs)
dialog.wait_window(dialog)
res = dialog.get_result()
if not res: # type consistency: always return a tuple
res = ()
return res
def askopenfilename(parent=None, title=_("Open"), **kwargs):
r"""
Return :obj:`''` or the absolute path of the chosen file
Arguments:
parent : Tk or Toplevel instance
parent window
title : str
the title of the filebrowser window
initialdir : str
directory whose content is initially displayed
initialfile : str
initially selected item (just the name, not the full path)
filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
only the files of given filetype will be displayed,
e.g. to allow the user to switch between displaying only PNG or JPG
pictures or dispalying all files:
:obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
okbuttontext : str
text displayed on the validate button, default is "Open".
cancelbuttontext : str
text displayed on the button that cancels the selection, default is "Cancel".
foldercreation : bool
enable the user to create new folders if True (default)
"""
dialog = FileBrowser(parent, mode="openfile", multiple_selection=False,
title=title, **kwargs)
dialog.wait_window(dialog)
return dialog.get_result()
def askopenfilenames(parent=None, title=_("Open"), **kwargs):
r"""
Return :obj:`()` or the tuple of the absolute paths of the chosen files
Arguments:
parent : Tk or Toplevel instance
parent window
title : str
the title of the filebrowser window
initialdir : str
directory whose content is initially displayed
initialfile : str
initially selected item (just the name, not the full path)
filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
only the files of given filetype will be displayed,
e.g. to allow the user to switch between displaying only PNG or JPG
pictures or dispalying all files:
:obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
okbuttontext : str
text displayed on the validate button, default is "Open".
cancelbuttontext : str
text displayed on the button that cancels the selection, default is "Cancel".
foldercreation : bool
enable the user to create new folders if True (default)
"""
dialog = FileBrowser(parent, mode="openfile", multiple_selection=True,
title=title, **kwargs)
dialog.wait_window(dialog)
res = dialog.get_result()
if not res: # type consistency: always return a tuple
res = ()
return res
def asksaveasfilename(parent=None, title=_("Save As"), **kwargs):
r"""
Return :obj:`''` or the chosen absolute path (the file might not exist)
Arguments:
parent : Tk or Toplevel instance
parent window
title : str
the title of the filebrowser window
initialdir : str
directory whose content is initially displayed
initialfile : str
initially selected item (just the name, not the full path)
defaultext : str (e.g. '.png')
extension added to filename if none is given (default is none)
filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
only the files of given filetype will be displayed,
e.g. to allow the user to switch between displaying only PNG or JPG
pictures or dispalying all files:
:obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
okbuttontext : str
text displayed on the validate button, default is "Open".
cancelbuttontext : str
text displayed on the button that cancels the selection, default is "Cancel".
foldercreation : bool
enable the user to create new folders if True (default)
"""
dialog = FileBrowser(parent, mode="save", title=title, **kwargs)
dialog.wait_window(dialog)
return dialog.get_result()
|
