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
|
Tkinter Dialogs
===============
:mod:`tkinter.simpledialog` --- Standard Tkinter input dialogs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. module:: tkinter.simpledialog
:platform: Tk
:synopsis: Simple dialog windows
**Source code:** :source:`Lib/tkinter/simpledialog.py`
--------------
The :mod:`tkinter.simpledialog` module contains convenience classes and
functions for creating simple modal dialogs to get a value from the user.
.. function:: askfloat(title, prompt, **kw)
askinteger(title, prompt, **kw)
askstring(title, prompt, **kw)
The above three functions provide dialogs that prompt the user to enter a value
of the desired type.
.. class:: Dialog(parent, title=None)
The base class for custom dialogs.
.. method:: body(master)
Override to construct the dialog's interface and return the widget that
should have initial focus.
.. method:: buttonbox()
Default behaviour adds OK and Cancel buttons. Override for custom button
layouts.
:mod:`tkinter.filedialog` --- File selection dialogs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. module:: tkinter.filedialog
:platform: Tk
:synopsis: Dialog classes for file selection
**Source code:** :source:`Lib/tkinter/filedialog.py`
--------------
The :mod:`tkinter.filedialog` module provides classes and factory functions for
creating file/directory selection windows.
Native Load/Save Dialogs
------------------------
The following classes and functions provide file dialog windows that combine a
native look-and-feel with configuration options to customize behaviour.
The following keyword arguments are applicable to the classes and functions
listed below:
| *parent* - the window to place the dialog on top of
| *title* - the title of the window
| *initialdir* - the directory that the dialog starts in
| *initialfile* - the file selected upon opening of the dialog
| *filetypes* - a sequence of (label, pattern) tuples, '*' wildcard is allowed
| *defaultextension* - default extension to append to file (save dialogs)
| *multiple* - when true, selection of multiple items is allowed
**Static factory functions**
The below functions when called create a modal, native look-and-feel dialog,
wait for the user's selection, then return the selected value(s) or ``None`` to the
caller.
.. function:: askopenfile(mode="r", **options)
askopenfiles(mode="r", **options)
The above two functions create an :class:`Open` dialog and return the opened
file object(s) in read-only mode.
.. function:: asksaveasfile(mode="w", **options)
Create a :class:`SaveAs` dialog and return a file object opened in write-only mode.
.. function:: askopenfilename(**options)
askopenfilenames(**options)
The above two functions create an :class:`Open` dialog and return the
selected filename(s) that correspond to existing file(s).
.. function:: asksaveasfilename(**options)
Create a :class:`SaveAs` dialog and return the selected filename.
.. function:: askdirectory(**options)
| Prompt user to select a directory.
| Additional keyword option:
| *mustexist* - determines if selection must be an existing directory.
.. class:: Open(master=None, **options)
SaveAs(master=None, **options)
The above two classes provide native dialog windows for saving and loading
files.
**Convenience classes**
The below classes are used for creating file/directory windows from scratch.
These do not emulate the native look-and-feel of the platform.
.. class:: Directory(master=None, **options)
Create a dialog prompting the user to select a directory.
.. note:: The *FileDialog* class should be subclassed for custom event
handling and behaviour.
.. class:: FileDialog(master, title=None)
Create a basic file selection dialog.
.. method:: cancel_command(event=None)
Trigger the termination of the dialog window.
.. method:: dirs_double_event(event)
Event handler for double-click event on directory.
.. method:: dirs_select_event(event)
Event handler for click event on directory.
.. method:: files_double_event(event)
Event handler for double-click event on file.
.. method:: files_select_event(event)
Event handler for single-click event on file.
.. method:: filter_command(event=None)
Filter the files by directory.
.. method:: get_filter()
Retrieve the file filter currently in use.
.. method:: get_selection()
Retrieve the currently selected item.
.. method:: go(dir_or_file=os.curdir, pattern="*", default="", key=None)
Render dialog and start event loop.
.. method:: ok_event(event)
Exit dialog returning current selection.
.. method:: quit(how=None)
Exit dialog returning filename, if any.
.. method:: set_filter(dir, pat)
Set the file filter.
.. method:: set_selection(file)
Update the current file selection to *file*.
.. class:: LoadFileDialog(master, title=None)
A subclass of FileDialog that creates a dialog window for selecting an
existing file.
.. method:: ok_command()
Test that a file is provided and that the selection indicates an
already existing file.
.. class:: SaveFileDialog(master, title=None)
A subclass of FileDialog that creates a dialog window for selecting a
destination file.
.. method:: ok_command()
Test whether or not the selection points to a valid file that is not a
directory. Confirmation is required if an already existing file is
selected.
:mod:`tkinter.commondialog` --- Dialog window templates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. module:: tkinter.commondialog
:platform: Tk
:synopsis: Tkinter base class for dialogs
**Source code:** :source:`Lib/tkinter/commondialog.py`
--------------
The :mod:`tkinter.commondialog` module provides the :class:`Dialog` class that
is the base class for dialogs defined in other supporting modules.
.. class:: Dialog(master=None, **options)
.. method:: show(**options)
Render the Dialog window.
.. seealso::
Modules :mod:`tkinter.messagebox`, :ref:`tut-files`
|
