Python code coverage for Lib/lib-tk/tkSimpleDialog.py

#	count	content
1	n/a	#
2	n/a	# An Introduction to Tkinter
3	n/a	# tkSimpleDialog.py
4	n/a	#
5	n/a	# Copyright (c) 1997 by Fredrik Lundh
6	n/a	#
7	n/a	# fredrik@pythonware.com
8	n/a	# http://www.pythonware.com
9	n/a	#
10	n/a
11	n/a	# --------------------------------------------------------------------
12	n/a	# dialog base class
13	n/a
14	n/a	'''Dialog boxes
15	n/a
16	n/a	This module handles dialog boxes. It contains the following
17	n/a	public symbols:
18	n/a
19	n/a	Dialog -- a base class for dialogs
20	n/a
21	n/a	askinteger -- get an integer from the user
22	n/a
23	n/a	askfloat -- get a float from the user
24	n/a
25	n/a	askstring -- get a string from the user
26	n/a	'''
27	n/a
28	n/a	from Tkinter import *
29	n/a
30	n/a	class Dialog(Toplevel):
31	n/a
32	n/a	'''Class to open dialogs.
33	n/a
34	n/a	This class is intended as a base class for custom dialogs
35	n/a	'''
36	n/a
37	n/a	def __init__(self, parent, title = None):
38	n/a
39	n/a	'''Initialize a dialog.
40	n/a
41	n/a	Arguments:
42	n/a
43	n/a	parent -- a parent window (the application window)
44	n/a
45	n/a	title -- the dialog title
46	n/a	'''
47	n/a	Toplevel.__init__(self, parent)
48	n/a
49	n/a	self.withdraw() # remain invisible for now
50	n/a	# If the master is not viewable, don't
51	n/a	# make the child transient, or else it
52	n/a	# would be opened withdrawn
53	n/a	if parent.winfo_viewable():
54	n/a	self.transient(parent)
55	n/a
56	n/a	if title:
57	n/a	self.title(title)
58	n/a
59	n/a	self.parent = parent
60	n/a
61	n/a	self.result = None
62	n/a
63	n/a	body = Frame(self)
64	n/a	self.initial_focus = self.body(body)
65	n/a	body.pack(padx=5, pady=5)
66	n/a
67	n/a	self.buttonbox()
68	n/a
69	n/a
70	n/a	if not self.initial_focus:
71	n/a	self.initial_focus = self
72	n/a
73	n/a	self.protocol("WM_DELETE_WINDOW", self.cancel)
74	n/a
75	n/a	if self.parent is not None:
76	n/a	self.geometry("+%d+%d" % (parent.winfo_rootx()+50,
77	n/a	parent.winfo_rooty()+50))
78	n/a
79	n/a	self.deiconify() # become visibile now
80	n/a
81	n/a	self.initial_focus.focus_set()
82	n/a
83	n/a	# wait for window to appear on screen before calling grab_set
84	n/a	self.wait_visibility()
85	n/a	self.grab_set()
86	n/a	self.wait_window(self)
87	n/a
88	n/a	def destroy(self):
89	n/a	'''Destroy the window'''
90	n/a	self.initial_focus = None
91	n/a	Toplevel.destroy(self)
92	n/a
93	n/a	#
94	n/a	# construction hooks
95	n/a
96	n/a	def body(self, master):
97	n/a	'''create dialog body.
98	n/a
99	n/a	return widget that should have initial focus.
100	n/a	This method should be overridden, and is called
101	n/a	by the __init__ method.
102	n/a	'''
103	n/a	pass
104	n/a
105	n/a	def buttonbox(self):
106	n/a	'''add standard button box.
107	n/a
108	n/a	override if you do not want the standard buttons
109	n/a	'''
110	n/a
111	n/a	box = Frame(self)
112	n/a
113	n/a	w = Button(box, text="OK", width=10, command=self.ok, default=ACTIVE)
114	n/a	w.pack(side=LEFT, padx=5, pady=5)
115	n/a	w = Button(box, text="Cancel", width=10, command=self.cancel)
116	n/a	w.pack(side=LEFT, padx=5, pady=5)
117	n/a
118	n/a	self.bind("<Return>", self.ok)
119	n/a	self.bind("<Escape>", self.cancel)
120	n/a
121	n/a	box.pack()
122	n/a
123	n/a	#
124	n/a	# standard button semantics
125	n/a
126	n/a	def ok(self, event=None):
127	n/a
128	n/a	if not self.validate():
129	n/a	self.initial_focus.focus_set() # put focus back
130	n/a	return
131	n/a
132	n/a	self.withdraw()
133	n/a	self.update_idletasks()
134	n/a
135	n/a	try:
136	n/a	self.apply()
137	n/a	finally:
138	n/a	self.cancel()
139	n/a
140	n/a	def cancel(self, event=None):
141	n/a
142	n/a	# put focus back to the parent window
143	n/a	if self.parent is not None:
144	n/a	self.parent.focus_set()
145	n/a	self.destroy()
146	n/a
147	n/a	#
148	n/a	# command hooks
149	n/a
150	n/a	def validate(self):
151	n/a	'''validate the data
152	n/a
153	n/a	This method is called automatically to validate the data before the
154	n/a	dialog is destroyed. By default, it always validates OK.
155	n/a	'''
156	n/a
157	n/a	return 1 # override
158	n/a
159	n/a	def apply(self):
160	n/a	'''process the data
161	n/a
162	n/a	This method is called automatically to process the data, after
163	n/a	the dialog is destroyed. By default, it does nothing.
164	n/a	'''
165	n/a
166	n/a	pass # override
167	n/a
168	n/a
169	n/a	# --------------------------------------------------------------------
170	n/a	# convenience dialogues
171	n/a
172	n/a	class _QueryDialog(Dialog):
173	n/a
174	n/a	def __init__(self, title, prompt,
175	n/a	initialvalue=None,
176	n/a	minvalue = None, maxvalue = None,
177	n/a	parent = None):
178	n/a
179	n/a	if not parent:
180	n/a	import Tkinter
181	n/a	parent = Tkinter._default_root
182	n/a
183	n/a	self.prompt = prompt
184	n/a	self.minvalue = minvalue
185	n/a	self.maxvalue = maxvalue
186	n/a
187	n/a	self.initialvalue = initialvalue
188	n/a
189	n/a	Dialog.__init__(self, parent, title)
190	n/a
191	n/a	def destroy(self):
192	n/a	self.entry = None
193	n/a	Dialog.destroy(self)
194	n/a
195	n/a	def body(self, master):
196	n/a
197	n/a	w = Label(master, text=self.prompt, justify=LEFT)
198	n/a	w.grid(row=0, padx=5, sticky=W)
199	n/a
200	n/a	self.entry = Entry(master, name="entry")
201	n/a	self.entry.grid(row=1, padx=5, sticky=W+E)
202	n/a
203	n/a	if self.initialvalue:
204	n/a	self.entry.insert(0, self.initialvalue)
205	n/a	self.entry.select_range(0, END)
206	n/a
207	n/a	return self.entry
208	n/a
209	n/a	def validate(self):
210	n/a
211	n/a	import tkMessageBox
212	n/a
213	n/a	try:
214	n/a	result = self.getresult()
215	n/a	except ValueError:
216	n/a	tkMessageBox.showwarning(
217	n/a	"Illegal value",
218	n/a	self.errormessage + "\nPlease try again",
219	n/a	parent = self
220	n/a	)
221	n/a	return 0
222	n/a
223	n/a	if self.minvalue is not None and result < self.minvalue:
224	n/a	tkMessageBox.showwarning(
225	n/a	"Too small",
226	n/a	"The allowed minimum value is %s. "
227	n/a	"Please try again." % self.minvalue,
228	n/a	parent = self
229	n/a	)
230	n/a	return 0
231	n/a
232	n/a	if self.maxvalue is not None and result > self.maxvalue:
233	n/a	tkMessageBox.showwarning(
234	n/a	"Too large",
235	n/a	"The allowed maximum value is %s. "
236	n/a	"Please try again." % self.maxvalue,
237	n/a	parent = self
238	n/a	)
239	n/a	return 0
240	n/a
241	n/a	self.result = result
242	n/a
243	n/a	return 1
244	n/a
245	n/a
246	n/a	class _QueryInteger(_QueryDialog):
247	n/a	errormessage = "Not an integer."
248	n/a	def getresult(self):
249	n/a	return int(self.entry.get())
250	n/a
251	n/a	def askinteger(title, prompt, **kw):
252	n/a	'''get an integer from the user
253	n/a
254	n/a	Arguments:
255	n/a
256	n/a	title -- the dialog title
257	n/a	prompt -- the label text
258	n/a	**kw -- see SimpleDialog class
259	n/a
260	n/a	Return value is an integer
261	n/a	'''
262	n/a	d = _QueryInteger(title, prompt, **kw)
263	n/a	return d.result
264	n/a
265	n/a	class _QueryFloat(_QueryDialog):
266	n/a	errormessage = "Not a floating point value."
267	n/a	def getresult(self):
268	n/a	return float(self.entry.get())
269	n/a
270	n/a	def askfloat(title, prompt, **kw):
271	n/a	'''get a float from the user
272	n/a
273	n/a	Arguments:
274	n/a
275	n/a	title -- the dialog title
276	n/a	prompt -- the label text
277	n/a	**kw -- see SimpleDialog class
278	n/a
279	n/a	Return value is a float
280	n/a	'''
281	n/a	d = _QueryFloat(title, prompt, **kw)
282	n/a	return d.result
283	n/a
284	n/a	class _QueryString(_QueryDialog):
285	n/a	def __init__(self, args, *kw):
286	n/a	if "show" in kw:
287	n/a	self.__show = kw["show"]
288	n/a	del kw["show"]
289	n/a	else:
290	n/a	self.__show = None
291	n/a	_QueryDialog.__init__(self, args, *kw)
292	n/a
293	n/a	def body(self, master):
294	n/a	entry = _QueryDialog.body(self, master)
295	n/a	if self.__show is not None:
296	n/a	entry.configure(show=self.__show)
297	n/a	return entry
298	n/a
299	n/a	def getresult(self):
300	n/a	return self.entry.get()
301	n/a
302	n/a	def askstring(title, prompt, **kw):
303	n/a	'''get a string from the user
304	n/a
305	n/a	Arguments:
306	n/a
307	n/a	title -- the dialog title
308	n/a	prompt -- the label text
309	n/a	**kw -- see SimpleDialog class
310	n/a
311	n/a	Return value is a string
312	n/a	'''
313	n/a	d = _QueryString(title, prompt, **kw)
314	n/a	return d.result
315	n/a
316	n/a	if __name__ == "__main__":
317	n/a
318	n/a	root = Tk()
319	n/a	root.update()
320	n/a
321	n/a	print askinteger("Spam", "Egg count", initialvalue=12*12)
322	n/a	print askfloat("Spam", "Egg weight\n(in tons)", minvalue=1, maxvalue=100)
323	n/a	print askstring("Spam", "Egg label")