Fix duplicate test numbers in extra.decTest
[python.git] / Lib / lib-tk / Tkinter.py
blob1516d79b6eaa97a91cef9dfb9fc37b89a6b59f49
1 """Wrapper functions for Tcl/Tk.
3 Tkinter provides classes which allow the display, positioning and
4 control of widgets. Toplevel widgets are Tk and Toplevel. Other
5 widgets are Frame, Label, Entry, Text, Canvas, Button, Radiobutton,
6 Checkbutton, Scale, Listbox, Scrollbar, OptionMenu, Spinbox
7 LabelFrame and PanedWindow.
9 Properties of the widgets are specified with keyword arguments.
10 Keyword arguments have the same name as the corresponding resource
11 under Tk.
13 Widgets are positioned with one of the geometry managers Place, Pack
14 or Grid. These managers can be called with methods place, pack, grid
15 available in every Widget.
17 Actions are bound to events by resources (e.g. keyword argument
18 command) or with the method bind.
20 Example (Hello, World):
21 import Tkinter
22 from Tkconstants import *
23 tk = Tkinter.Tk()
24 frame = Tkinter.Frame(tk, relief=RIDGE, borderwidth=2)
25 frame.pack(fill=BOTH,expand=1)
26 label = Tkinter.Label(frame, text="Hello, World")
27 label.pack(fill=X, expand=1)
28 button = Tkinter.Button(frame,text="Exit",command=tk.destroy)
29 button.pack(side=BOTTOM)
30 tk.mainloop()
31 """
33 __version__ = "$Revision$"
35 import sys
36 if sys.platform == "win32":
37 # Attempt to configure Tcl/Tk without requiring PATH
38 import FixTk
39 import _tkinter # If this fails your Python may not be configured for Tk
40 tkinter = _tkinter # b/w compat for export
41 TclError = _tkinter.TclError
42 from types import *
43 from Tkconstants import *
45 wantobjects = 1
47 TkVersion = float(_tkinter.TK_VERSION)
48 TclVersion = float(_tkinter.TCL_VERSION)
50 READABLE = _tkinter.READABLE
51 WRITABLE = _tkinter.WRITABLE
52 EXCEPTION = _tkinter.EXCEPTION
54 # These are not always defined, e.g. not on Win32 with Tk 8.0 :-(
55 try: _tkinter.createfilehandler
56 except AttributeError: _tkinter.createfilehandler = None
57 try: _tkinter.deletefilehandler
58 except AttributeError: _tkinter.deletefilehandler = None
61 def _flatten(tuple):
62 """Internal function."""
63 res = ()
64 for item in tuple:
65 if type(item) in (TupleType, ListType):
66 res = res + _flatten(item)
67 elif item is not None:
68 res = res + (item,)
69 return res
71 try: _flatten = _tkinter._flatten
72 except AttributeError: pass
74 def _cnfmerge(cnfs):
75 """Internal function."""
76 if type(cnfs) is DictionaryType:
77 return cnfs
78 elif type(cnfs) in (NoneType, StringType):
79 return cnfs
80 else:
81 cnf = {}
82 for c in _flatten(cnfs):
83 try:
84 cnf.update(c)
85 except (AttributeError, TypeError), msg:
86 print "_cnfmerge: fallback due to:", msg
87 for k, v in c.items():
88 cnf[k] = v
89 return cnf
91 try: _cnfmerge = _tkinter._cnfmerge
92 except AttributeError: pass
94 class Event:
95 """Container for the properties of an event.
97 Instances of this type are generated if one of the following events occurs:
99 KeyPress, KeyRelease - for keyboard events
100 ButtonPress, ButtonRelease, Motion, Enter, Leave, MouseWheel - for mouse events
101 Visibility, Unmap, Map, Expose, FocusIn, FocusOut, Circulate,
102 Colormap, Gravity, Reparent, Property, Destroy, Activate,
103 Deactivate - for window events.
105 If a callback function for one of these events is registered
106 using bind, bind_all, bind_class, or tag_bind, the callback is
107 called with an Event as first argument. It will have the
108 following attributes (in braces are the event types for which
109 the attribute is valid):
111 serial - serial number of event
112 num - mouse button pressed (ButtonPress, ButtonRelease)
113 focus - whether the window has the focus (Enter, Leave)
114 height - height of the exposed window (Configure, Expose)
115 width - width of the exposed window (Configure, Expose)
116 keycode - keycode of the pressed key (KeyPress, KeyRelease)
117 state - state of the event as a number (ButtonPress, ButtonRelease,
118 Enter, KeyPress, KeyRelease,
119 Leave, Motion)
120 state - state as a string (Visibility)
121 time - when the event occurred
122 x - x-position of the mouse
123 y - y-position of the mouse
124 x_root - x-position of the mouse on the screen
125 (ButtonPress, ButtonRelease, KeyPress, KeyRelease, Motion)
126 y_root - y-position of the mouse on the screen
127 (ButtonPress, ButtonRelease, KeyPress, KeyRelease, Motion)
128 char - pressed character (KeyPress, KeyRelease)
129 send_event - see X/Windows documentation
130 keysym - keysym of the event as a string (KeyPress, KeyRelease)
131 keysym_num - keysym of the event as a number (KeyPress, KeyRelease)
132 type - type of the event as a number
133 widget - widget in which the event occurred
134 delta - delta of wheel movement (MouseWheel)
136 pass
138 _support_default_root = 1
139 _default_root = None
141 def NoDefaultRoot():
142 """Inhibit setting of default root window.
144 Call this function to inhibit that the first instance of
145 Tk is used for windows without an explicit parent window.
147 global _support_default_root
148 _support_default_root = 0
149 global _default_root
150 _default_root = None
151 del _default_root
153 def _tkerror(err):
154 """Internal function."""
155 pass
157 def _exit(code='0'):
158 """Internal function. Calling it will throw the exception SystemExit."""
159 raise SystemExit, code
161 _varnum = 0
162 class Variable:
163 """Class to define value holders for e.g. buttons.
165 Subclasses StringVar, IntVar, DoubleVar, BooleanVar are specializations
166 that constrain the type of the value returned from get()."""
167 _default = ""
168 def __init__(self, master=None, value=None, name=None):
169 """Construct a variable
171 MASTER can be given as master widget.
172 VALUE is an optional value (defaults to "")
173 NAME is an optional Tcl name (defaults to PY_VARnum).
175 If NAME matches an existing variable and VALUE is omitted
176 then the existing value is retained.
178 global _varnum
179 if not master:
180 master = _default_root
181 self._master = master
182 self._tk = master.tk
183 if name:
184 self._name = name
185 else:
186 self._name = 'PY_VAR' + repr(_varnum)
187 _varnum += 1
188 if value is not None:
189 self.set(value)
190 elif not self._tk.call("info", "exists", self._name):
191 self.set(self._default)
192 def __del__(self):
193 """Unset the variable in Tcl."""
194 self._tk.globalunsetvar(self._name)
195 def __str__(self):
196 """Return the name of the variable in Tcl."""
197 return self._name
198 def set(self, value):
199 """Set the variable to VALUE."""
200 return self._tk.globalsetvar(self._name, value)
201 def get(self):
202 """Return value of variable."""
203 return self._tk.globalgetvar(self._name)
204 def trace_variable(self, mode, callback):
205 """Define a trace callback for the variable.
207 MODE is one of "r", "w", "u" for read, write, undefine.
208 CALLBACK must be a function which is called when
209 the variable is read, written or undefined.
211 Return the name of the callback.
213 cbname = self._master._register(callback)
214 self._tk.call("trace", "variable", self._name, mode, cbname)
215 return cbname
216 trace = trace_variable
217 def trace_vdelete(self, mode, cbname):
218 """Delete the trace callback for a variable.
220 MODE is one of "r", "w", "u" for read, write, undefine.
221 CBNAME is the name of the callback returned from trace_variable or trace.
223 self._tk.call("trace", "vdelete", self._name, mode, cbname)
224 self._master.deletecommand(cbname)
225 def trace_vinfo(self):
226 """Return all trace callback information."""
227 return map(self._tk.split, self._tk.splitlist(
228 self._tk.call("trace", "vinfo", self._name)))
229 def __eq__(self, other):
230 """Comparison for equality (==).
232 Note: if the Variable's master matters to behavior
233 also compare self._master == other._master
235 return self.__class__.__name__ == other.__class__.__name__ \
236 and self._name == other._name
238 class StringVar(Variable):
239 """Value holder for strings variables."""
240 _default = ""
241 def __init__(self, master=None, value=None, name=None):
242 """Construct a string variable.
244 MASTER can be given as master widget.
245 VALUE is an optional value (defaults to "")
246 NAME is an optional Tcl name (defaults to PY_VARnum).
248 If NAME matches an existing variable and VALUE is omitted
249 then the existing value is retained.
251 Variable.__init__(self, master, value, name)
253 def get(self):
254 """Return value of variable as string."""
255 value = self._tk.globalgetvar(self._name)
256 if isinstance(value, basestring):
257 return value
258 return str(value)
260 class IntVar(Variable):
261 """Value holder for integer variables."""
262 _default = 0
263 def __init__(self, master=None, value=None, name=None):
264 """Construct an integer variable.
266 MASTER can be given as master widget.
267 VALUE is an optional value (defaults to 0)
268 NAME is an optional Tcl name (defaults to PY_VARnum).
270 If NAME matches an existing variable and VALUE is omitted
271 then the existing value is retained.
273 Variable.__init__(self, master, value, name)
275 def set(self, value):
276 """Set the variable to value, converting booleans to integers."""
277 if isinstance(value, bool):
278 value = int(value)
279 return Variable.set(self, value)
281 def get(self):
282 """Return the value of the variable as an integer."""
283 return getint(self._tk.globalgetvar(self._name))
285 class DoubleVar(Variable):
286 """Value holder for float variables."""
287 _default = 0.0
288 def __init__(self, master=None, value=None, name=None):
289 """Construct a float variable.
291 MASTER can be given as master widget.
292 VALUE is an optional value (defaults to 0.0)
293 NAME is an optional Tcl name (defaults to PY_VARnum).
295 If NAME matches an existing variable and VALUE is omitted
296 then the existing value is retained.
298 Variable.__init__(self, master, value, name)
300 def get(self):
301 """Return the value of the variable as a float."""
302 return getdouble(self._tk.globalgetvar(self._name))
304 class BooleanVar(Variable):
305 """Value holder for boolean variables."""
306 _default = False
307 def __init__(self, master=None, value=None, name=None):
308 """Construct a boolean variable.
310 MASTER can be given as master widget.
311 VALUE is an optional value (defaults to False)
312 NAME is an optional Tcl name (defaults to PY_VARnum).
314 If NAME matches an existing variable and VALUE is omitted
315 then the existing value is retained.
317 Variable.__init__(self, master, value, name)
319 def get(self):
320 """Return the value of the variable as a bool."""
321 return self._tk.getboolean(self._tk.globalgetvar(self._name))
323 def mainloop(n=0):
324 """Run the main loop of Tcl."""
325 _default_root.tk.mainloop(n)
327 getint = int
329 getdouble = float
331 def getboolean(s):
332 """Convert true and false to integer values 1 and 0."""
333 return _default_root.tk.getboolean(s)
335 # Methods defined on both toplevel and interior widgets
336 class Misc:
337 """Internal class.
339 Base class which defines methods common for interior widgets."""
341 # XXX font command?
342 _tclCommands = None
343 def destroy(self):
344 """Internal function.
346 Delete all Tcl commands created for
347 this widget in the Tcl interpreter."""
348 if self._tclCommands is not None:
349 for name in self._tclCommands:
350 #print '- Tkinter: deleted command', name
351 self.tk.deletecommand(name)
352 self._tclCommands = None
353 def deletecommand(self, name):
354 """Internal function.
356 Delete the Tcl command provided in NAME."""
357 #print '- Tkinter: deleted command', name
358 self.tk.deletecommand(name)
359 try:
360 self._tclCommands.remove(name)
361 except ValueError:
362 pass
363 def tk_strictMotif(self, boolean=None):
364 """Set Tcl internal variable, whether the look and feel
365 should adhere to Motif.
367 A parameter of 1 means adhere to Motif (e.g. no color
368 change if mouse passes over slider).
369 Returns the set value."""
370 return self.tk.getboolean(self.tk.call(
371 'set', 'tk_strictMotif', boolean))
372 def tk_bisque(self):
373 """Change the color scheme to light brown as used in Tk 3.6 and before."""
374 self.tk.call('tk_bisque')
375 def tk_setPalette(self, *args, **kw):
376 """Set a new color scheme for all widget elements.
378 A single color as argument will cause that all colors of Tk
379 widget elements are derived from this.
380 Alternatively several keyword parameters and its associated
381 colors can be given. The following keywords are valid:
382 activeBackground, foreground, selectColor,
383 activeForeground, highlightBackground, selectBackground,
384 background, highlightColor, selectForeground,
385 disabledForeground, insertBackground, troughColor."""
386 self.tk.call(('tk_setPalette',)
387 + _flatten(args) + _flatten(kw.items()))
388 def tk_menuBar(self, *args):
389 """Do not use. Needed in Tk 3.6 and earlier."""
390 pass # obsolete since Tk 4.0
391 def wait_variable(self, name='PY_VAR'):
392 """Wait until the variable is modified.
394 A parameter of type IntVar, StringVar, DoubleVar or
395 BooleanVar must be given."""
396 self.tk.call('tkwait', 'variable', name)
397 waitvar = wait_variable # XXX b/w compat
398 def wait_window(self, window=None):
399 """Wait until a WIDGET is destroyed.
401 If no parameter is given self is used."""
402 if window is None:
403 window = self
404 self.tk.call('tkwait', 'window', window._w)
405 def wait_visibility(self, window=None):
406 """Wait until the visibility of a WIDGET changes
407 (e.g. it appears).
409 If no parameter is given self is used."""
410 if window is None:
411 window = self
412 self.tk.call('tkwait', 'visibility', window._w)
413 def setvar(self, name='PY_VAR', value='1'):
414 """Set Tcl variable NAME to VALUE."""
415 self.tk.setvar(name, value)
416 def getvar(self, name='PY_VAR'):
417 """Return value of Tcl variable NAME."""
418 return self.tk.getvar(name)
419 getint = int
420 getdouble = float
421 def getboolean(self, s):
422 """Return a boolean value for Tcl boolean values true and false given as parameter."""
423 return self.tk.getboolean(s)
424 def focus_set(self):
425 """Direct input focus to this widget.
427 If the application currently does not have the focus
428 this widget will get the focus if the application gets
429 the focus through the window manager."""
430 self.tk.call('focus', self._w)
431 focus = focus_set # XXX b/w compat?
432 def focus_force(self):
433 """Direct input focus to this widget even if the
434 application does not have the focus. Use with
435 caution!"""
436 self.tk.call('focus', '-force', self._w)
437 def focus_get(self):
438 """Return the widget which has currently the focus in the
439 application.
441 Use focus_displayof to allow working with several
442 displays. Return None if application does not have
443 the focus."""
444 name = self.tk.call('focus')
445 if name == 'none' or not name: return None
446 return self._nametowidget(name)
447 def focus_displayof(self):
448 """Return the widget which has currently the focus on the
449 display where this widget is located.
451 Return None if the application does not have the focus."""
452 name = self.tk.call('focus', '-displayof', self._w)
453 if name == 'none' or not name: return None
454 return self._nametowidget(name)
455 def focus_lastfor(self):
456 """Return the widget which would have the focus if top level
457 for this widget gets the focus from the window manager."""
458 name = self.tk.call('focus', '-lastfor', self._w)
459 if name == 'none' or not name: return None
460 return self._nametowidget(name)
461 def tk_focusFollowsMouse(self):
462 """The widget under mouse will get automatically focus. Can not
463 be disabled easily."""
464 self.tk.call('tk_focusFollowsMouse')
465 def tk_focusNext(self):
466 """Return the next widget in the focus order which follows
467 widget which has currently the focus.
469 The focus order first goes to the next child, then to
470 the children of the child recursively and then to the
471 next sibling which is higher in the stacking order. A
472 widget is omitted if it has the takefocus resource set
473 to 0."""
474 name = self.tk.call('tk_focusNext', self._w)
475 if not name: return None
476 return self._nametowidget(name)
477 def tk_focusPrev(self):
478 """Return previous widget in the focus order. See tk_focusNext for details."""
479 name = self.tk.call('tk_focusPrev', self._w)
480 if not name: return None
481 return self._nametowidget(name)
482 def after(self, ms, func=None, *args):
483 """Call function once after given time.
485 MS specifies the time in milliseconds. FUNC gives the
486 function which shall be called. Additional parameters
487 are given as parameters to the function call. Return
488 identifier to cancel scheduling with after_cancel."""
489 if not func:
490 # I'd rather use time.sleep(ms*0.001)
491 self.tk.call('after', ms)
492 else:
493 def callit():
494 try:
495 func(*args)
496 finally:
497 try:
498 self.deletecommand(name)
499 except TclError:
500 pass
501 name = self._register(callit)
502 return self.tk.call('after', ms, name)
503 def after_idle(self, func, *args):
504 """Call FUNC once if the Tcl main loop has no event to
505 process.
507 Return an identifier to cancel the scheduling with
508 after_cancel."""
509 return self.after('idle', func, *args)
510 def after_cancel(self, id):
511 """Cancel scheduling of function identified with ID.
513 Identifier returned by after or after_idle must be
514 given as first parameter."""
515 try:
516 data = self.tk.call('after', 'info', id)
517 # In Tk 8.3, splitlist returns: (script, type)
518 # In Tk 8.4, splitlist may return (script, type) or (script,)
519 script = self.tk.splitlist(data)[0]
520 self.deletecommand(script)
521 except TclError:
522 pass
523 self.tk.call('after', 'cancel', id)
524 def bell(self, displayof=0):
525 """Ring a display's bell."""
526 self.tk.call(('bell',) + self._displayof(displayof))
528 # Clipboard handling:
529 def clipboard_get(self, **kw):
530 """Retrieve data from the clipboard on window's display.
532 The window keyword defaults to the root window of the Tkinter
533 application.
535 The type keyword specifies the form in which the data is
536 to be returned and should be an atom name such as STRING
537 or FILE_NAME. Type defaults to STRING.
539 This command is equivalent to:
541 selection_get(CLIPBOARD)
543 return self.tk.call(('clipboard', 'get') + self._options(kw))
545 def clipboard_clear(self, **kw):
546 """Clear the data in the Tk clipboard.
548 A widget specified for the optional displayof keyword
549 argument specifies the target display."""
550 if 'displayof' not in kw: kw['displayof'] = self._w
551 self.tk.call(('clipboard', 'clear') + self._options(kw))
552 def clipboard_append(self, string, **kw):
553 """Append STRING to the Tk clipboard.
555 A widget specified at the optional displayof keyword
556 argument specifies the target display. The clipboard
557 can be retrieved with selection_get."""
558 if 'displayof' not in kw: kw['displayof'] = self._w
559 self.tk.call(('clipboard', 'append') + self._options(kw)
560 + ('--', string))
561 # XXX grab current w/o window argument
562 def grab_current(self):
563 """Return widget which has currently the grab in this application
564 or None."""
565 name = self.tk.call('grab', 'current', self._w)
566 if not name: return None
567 return self._nametowidget(name)
568 def grab_release(self):
569 """Release grab for this widget if currently set."""
570 self.tk.call('grab', 'release', self._w)
571 def grab_set(self):
572 """Set grab for this widget.
574 A grab directs all events to this and descendant
575 widgets in the application."""
576 self.tk.call('grab', 'set', self._w)
577 def grab_set_global(self):
578 """Set global grab for this widget.
580 A global grab directs all events to this and
581 descendant widgets on the display. Use with caution -
582 other applications do not get events anymore."""
583 self.tk.call('grab', 'set', '-global', self._w)
584 def grab_status(self):
585 """Return None, "local" or "global" if this widget has
586 no, a local or a global grab."""
587 status = self.tk.call('grab', 'status', self._w)
588 if status == 'none': status = None
589 return status
590 def option_add(self, pattern, value, priority = None):
591 """Set a VALUE (second parameter) for an option
592 PATTERN (first parameter).
594 An optional third parameter gives the numeric priority
595 (defaults to 80)."""
596 self.tk.call('option', 'add', pattern, value, priority)
597 def option_clear(self):
598 """Clear the option database.
600 It will be reloaded if option_add is called."""
601 self.tk.call('option', 'clear')
602 def option_get(self, name, className):
603 """Return the value for an option NAME for this widget
604 with CLASSNAME.
606 Values with higher priority override lower values."""
607 return self.tk.call('option', 'get', self._w, name, className)
608 def option_readfile(self, fileName, priority = None):
609 """Read file FILENAME into the option database.
611 An optional second parameter gives the numeric
612 priority."""
613 self.tk.call('option', 'readfile', fileName, priority)
614 def selection_clear(self, **kw):
615 """Clear the current X selection."""
616 if 'displayof' not in kw: kw['displayof'] = self._w
617 self.tk.call(('selection', 'clear') + self._options(kw))
618 def selection_get(self, **kw):
619 """Return the contents of the current X selection.
621 A keyword parameter selection specifies the name of
622 the selection and defaults to PRIMARY. A keyword
623 parameter displayof specifies a widget on the display
624 to use."""
625 if 'displayof' not in kw: kw['displayof'] = self._w
626 return self.tk.call(('selection', 'get') + self._options(kw))
627 def selection_handle(self, command, **kw):
628 """Specify a function COMMAND to call if the X
629 selection owned by this widget is queried by another
630 application.
632 This function must return the contents of the
633 selection. The function will be called with the
634 arguments OFFSET and LENGTH which allows the chunking
635 of very long selections. The following keyword
636 parameters can be provided:
637 selection - name of the selection (default PRIMARY),
638 type - type of the selection (e.g. STRING, FILE_NAME)."""
639 name = self._register(command)
640 self.tk.call(('selection', 'handle') + self._options(kw)
641 + (self._w, name))
642 def selection_own(self, **kw):
643 """Become owner of X selection.
645 A keyword parameter selection specifies the name of
646 the selection (default PRIMARY)."""
647 self.tk.call(('selection', 'own') +
648 self._options(kw) + (self._w,))
649 def selection_own_get(self, **kw):
650 """Return owner of X selection.
652 The following keyword parameter can
653 be provided:
654 selection - name of the selection (default PRIMARY),
655 type - type of the selection (e.g. STRING, FILE_NAME)."""
656 if 'displayof' not in kw: kw['displayof'] = self._w
657 name = self.tk.call(('selection', 'own') + self._options(kw))
658 if not name: return None
659 return self._nametowidget(name)
660 def send(self, interp, cmd, *args):
661 """Send Tcl command CMD to different interpreter INTERP to be executed."""
662 return self.tk.call(('send', interp, cmd) + args)
663 def lower(self, belowThis=None):
664 """Lower this widget in the stacking order."""
665 self.tk.call('lower', self._w, belowThis)
666 def tkraise(self, aboveThis=None):
667 """Raise this widget in the stacking order."""
668 self.tk.call('raise', self._w, aboveThis)
669 lift = tkraise
670 def colormodel(self, value=None):
671 """Useless. Not implemented in Tk."""
672 return self.tk.call('tk', 'colormodel', self._w, value)
673 def winfo_atom(self, name, displayof=0):
674 """Return integer which represents atom NAME."""
675 args = ('winfo', 'atom') + self._displayof(displayof) + (name,)
676 return getint(self.tk.call(args))
677 def winfo_atomname(self, id, displayof=0):
678 """Return name of atom with identifier ID."""
679 args = ('winfo', 'atomname') \
680 + self._displayof(displayof) + (id,)
681 return self.tk.call(args)
682 def winfo_cells(self):
683 """Return number of cells in the colormap for this widget."""
684 return getint(
685 self.tk.call('winfo', 'cells', self._w))
686 def winfo_children(self):
687 """Return a list of all widgets which are children of this widget."""
688 result = []
689 for child in self.tk.splitlist(
690 self.tk.call('winfo', 'children', self._w)):
691 try:
692 # Tcl sometimes returns extra windows, e.g. for
693 # menus; those need to be skipped
694 result.append(self._nametowidget(child))
695 except KeyError:
696 pass
697 return result
699 def winfo_class(self):
700 """Return window class name of this widget."""
701 return self.tk.call('winfo', 'class', self._w)
702 def winfo_colormapfull(self):
703 """Return true if at the last color request the colormap was full."""
704 return self.tk.getboolean(
705 self.tk.call('winfo', 'colormapfull', self._w))
706 def winfo_containing(self, rootX, rootY, displayof=0):
707 """Return the widget which is at the root coordinates ROOTX, ROOTY."""
708 args = ('winfo', 'containing') \
709 + self._displayof(displayof) + (rootX, rootY)
710 name = self.tk.call(args)
711 if not name: return None
712 return self._nametowidget(name)
713 def winfo_depth(self):
714 """Return the number of bits per pixel."""
715 return getint(self.tk.call('winfo', 'depth', self._w))
716 def winfo_exists(self):
717 """Return true if this widget exists."""
718 return getint(
719 self.tk.call('winfo', 'exists', self._w))
720 def winfo_fpixels(self, number):
721 """Return the number of pixels for the given distance NUMBER
722 (e.g. "3c") as float."""
723 return getdouble(self.tk.call(
724 'winfo', 'fpixels', self._w, number))
725 def winfo_geometry(self):
726 """Return geometry string for this widget in the form "widthxheight+X+Y"."""
727 return self.tk.call('winfo', 'geometry', self._w)
728 def winfo_height(self):
729 """Return height of this widget."""
730 return getint(
731 self.tk.call('winfo', 'height', self._w))
732 def winfo_id(self):
733 """Return identifier ID for this widget."""
734 return self.tk.getint(
735 self.tk.call('winfo', 'id', self._w))
736 def winfo_interps(self, displayof=0):
737 """Return the name of all Tcl interpreters for this display."""
738 args = ('winfo', 'interps') + self._displayof(displayof)
739 return self.tk.splitlist(self.tk.call(args))
740 def winfo_ismapped(self):
741 """Return true if this widget is mapped."""
742 return getint(
743 self.tk.call('winfo', 'ismapped', self._w))
744 def winfo_manager(self):
745 """Return the window mananger name for this widget."""
746 return self.tk.call('winfo', 'manager', self._w)
747 def winfo_name(self):
748 """Return the name of this widget."""
749 return self.tk.call('winfo', 'name', self._w)
750 def winfo_parent(self):
751 """Return the name of the parent of this widget."""
752 return self.tk.call('winfo', 'parent', self._w)
753 def winfo_pathname(self, id, displayof=0):
754 """Return the pathname of the widget given by ID."""
755 args = ('winfo', 'pathname') \
756 + self._displayof(displayof) + (id,)
757 return self.tk.call(args)
758 def winfo_pixels(self, number):
759 """Rounded integer value of winfo_fpixels."""
760 return getint(
761 self.tk.call('winfo', 'pixels', self._w, number))
762 def winfo_pointerx(self):
763 """Return the x coordinate of the pointer on the root window."""
764 return getint(
765 self.tk.call('winfo', 'pointerx', self._w))
766 def winfo_pointerxy(self):
767 """Return a tuple of x and y coordinates of the pointer on the root window."""
768 return self._getints(
769 self.tk.call('winfo', 'pointerxy', self._w))
770 def winfo_pointery(self):
771 """Return the y coordinate of the pointer on the root window."""
772 return getint(
773 self.tk.call('winfo', 'pointery', self._w))
774 def winfo_reqheight(self):
775 """Return requested height of this widget."""
776 return getint(
777 self.tk.call('winfo', 'reqheight', self._w))
778 def winfo_reqwidth(self):
779 """Return requested width of this widget."""
780 return getint(
781 self.tk.call('winfo', 'reqwidth', self._w))
782 def winfo_rgb(self, color):
783 """Return tuple of decimal values for red, green, blue for
784 COLOR in this widget."""
785 return self._getints(
786 self.tk.call('winfo', 'rgb', self._w, color))
787 def winfo_rootx(self):
788 """Return x coordinate of upper left corner of this widget on the
789 root window."""
790 return getint(
791 self.tk.call('winfo', 'rootx', self._w))
792 def winfo_rooty(self):
793 """Return y coordinate of upper left corner of this widget on the
794 root window."""
795 return getint(
796 self.tk.call('winfo', 'rooty', self._w))
797 def winfo_screen(self):
798 """Return the screen name of this widget."""
799 return self.tk.call('winfo', 'screen', self._w)
800 def winfo_screencells(self):
801 """Return the number of the cells in the colormap of the screen
802 of this widget."""
803 return getint(
804 self.tk.call('winfo', 'screencells', self._w))
805 def winfo_screendepth(self):
806 """Return the number of bits per pixel of the root window of the
807 screen of this widget."""
808 return getint(
809 self.tk.call('winfo', 'screendepth', self._w))
810 def winfo_screenheight(self):
811 """Return the number of pixels of the height of the screen of this widget
812 in pixel."""
813 return getint(
814 self.tk.call('winfo', 'screenheight', self._w))
815 def winfo_screenmmheight(self):
816 """Return the number of pixels of the height of the screen of
817 this widget in mm."""
818 return getint(
819 self.tk.call('winfo', 'screenmmheight', self._w))
820 def winfo_screenmmwidth(self):
821 """Return the number of pixels of the width of the screen of
822 this widget in mm."""
823 return getint(
824 self.tk.call('winfo', 'screenmmwidth', self._w))
825 def winfo_screenvisual(self):
826 """Return one of the strings directcolor, grayscale, pseudocolor,
827 staticcolor, staticgray, or truecolor for the default
828 colormodel of this screen."""
829 return self.tk.call('winfo', 'screenvisual', self._w)
830 def winfo_screenwidth(self):
831 """Return the number of pixels of the width of the screen of
832 this widget in pixel."""
833 return getint(
834 self.tk.call('winfo', 'screenwidth', self._w))
835 def winfo_server(self):
836 """Return information of the X-Server of the screen of this widget in
837 the form "XmajorRminor vendor vendorVersion"."""
838 return self.tk.call('winfo', 'server', self._w)
839 def winfo_toplevel(self):
840 """Return the toplevel widget of this widget."""
841 return self._nametowidget(self.tk.call(
842 'winfo', 'toplevel', self._w))
843 def winfo_viewable(self):
844 """Return true if the widget and all its higher ancestors are mapped."""
845 return getint(
846 self.tk.call('winfo', 'viewable', self._w))
847 def winfo_visual(self):
848 """Return one of the strings directcolor, grayscale, pseudocolor,
849 staticcolor, staticgray, or truecolor for the
850 colormodel of this widget."""
851 return self.tk.call('winfo', 'visual', self._w)
852 def winfo_visualid(self):
853 """Return the X identifier for the visual for this widget."""
854 return self.tk.call('winfo', 'visualid', self._w)
855 def winfo_visualsavailable(self, includeids=0):
856 """Return a list of all visuals available for the screen
857 of this widget.
859 Each item in the list consists of a visual name (see winfo_visual), a
860 depth and if INCLUDEIDS=1 is given also the X identifier."""
861 data = self.tk.split(
862 self.tk.call('winfo', 'visualsavailable', self._w,
863 includeids and 'includeids' or None))
864 if type(data) is StringType:
865 data = [self.tk.split(data)]
866 return map(self.__winfo_parseitem, data)
867 def __winfo_parseitem(self, t):
868 """Internal function."""
869 return t[:1] + tuple(map(self.__winfo_getint, t[1:]))
870 def __winfo_getint(self, x):
871 """Internal function."""
872 return int(x, 0)
873 def winfo_vrootheight(self):
874 """Return the height of the virtual root window associated with this
875 widget in pixels. If there is no virtual root window return the
876 height of the screen."""
877 return getint(
878 self.tk.call('winfo', 'vrootheight', self._w))
879 def winfo_vrootwidth(self):
880 """Return the width of the virtual root window associated with this
881 widget in pixel. If there is no virtual root window return the
882 width of the screen."""
883 return getint(
884 self.tk.call('winfo', 'vrootwidth', self._w))
885 def winfo_vrootx(self):
886 """Return the x offset of the virtual root relative to the root
887 window of the screen of this widget."""
888 return getint(
889 self.tk.call('winfo', 'vrootx', self._w))
890 def winfo_vrooty(self):
891 """Return the y offset of the virtual root relative to the root
892 window of the screen of this widget."""
893 return getint(
894 self.tk.call('winfo', 'vrooty', self._w))
895 def winfo_width(self):
896 """Return the width of this widget."""
897 return getint(
898 self.tk.call('winfo', 'width', self._w))
899 def winfo_x(self):
900 """Return the x coordinate of the upper left corner of this widget
901 in the parent."""
902 return getint(
903 self.tk.call('winfo', 'x', self._w))
904 def winfo_y(self):
905 """Return the y coordinate of the upper left corner of this widget
906 in the parent."""
907 return getint(
908 self.tk.call('winfo', 'y', self._w))
909 def update(self):
910 """Enter event loop until all pending events have been processed by Tcl."""
911 self.tk.call('update')
912 def update_idletasks(self):
913 """Enter event loop until all idle callbacks have been called. This
914 will update the display of windows but not process events caused by
915 the user."""
916 self.tk.call('update', 'idletasks')
917 def bindtags(self, tagList=None):
918 """Set or get the list of bindtags for this widget.
920 With no argument return the list of all bindtags associated with
921 this widget. With a list of strings as argument the bindtags are
922 set to this list. The bindtags determine in which order events are
923 processed (see bind)."""
924 if tagList is None:
925 return self.tk.splitlist(
926 self.tk.call('bindtags', self._w))
927 else:
928 self.tk.call('bindtags', self._w, tagList)
929 def _bind(self, what, sequence, func, add, needcleanup=1):
930 """Internal function."""
931 if type(func) is StringType:
932 self.tk.call(what + (sequence, func))
933 elif func:
934 funcid = self._register(func, self._substitute,
935 needcleanup)
936 cmd = ('%sif {"[%s %s]" == "break"} break\n'
938 (add and '+' or '',
939 funcid, self._subst_format_str))
940 self.tk.call(what + (sequence, cmd))
941 return funcid
942 elif sequence:
943 return self.tk.call(what + (sequence,))
944 else:
945 return self.tk.splitlist(self.tk.call(what))
946 def bind(self, sequence=None, func=None, add=None):
947 """Bind to this widget at event SEQUENCE a call to function FUNC.
949 SEQUENCE is a string of concatenated event
950 patterns. An event pattern is of the form
951 <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
952 of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
953 Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
954 B3, Alt, Button4, B4, Double, Button5, B5 Triple,
955 Mod1, M1. TYPE is one of Activate, Enter, Map,
956 ButtonPress, Button, Expose, Motion, ButtonRelease
957 FocusIn, MouseWheel, Circulate, FocusOut, Property,
958 Colormap, Gravity Reparent, Configure, KeyPress, Key,
959 Unmap, Deactivate, KeyRelease Visibility, Destroy,
960 Leave and DETAIL is the button number for ButtonPress,
961 ButtonRelease and DETAIL is the Keysym for KeyPress and
962 KeyRelease. Examples are
963 <Control-Button-1> for pressing Control and mouse button 1 or
964 <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
965 An event pattern can also be a virtual event of the form
966 <<AString>> where AString can be arbitrary. This
967 event can be generated by event_generate.
968 If events are concatenated they must appear shortly
969 after each other.
971 FUNC will be called if the event sequence occurs with an
972 instance of Event as argument. If the return value of FUNC is
973 "break" no further bound function is invoked.
975 An additional boolean parameter ADD specifies whether FUNC will
976 be called additionally to the other bound function or whether
977 it will replace the previous function.
979 Bind will return an identifier to allow deletion of the bound function with
980 unbind without memory leak.
982 If FUNC or SEQUENCE is omitted the bound function or list
983 of bound events are returned."""
985 return self._bind(('bind', self._w), sequence, func, add)
986 def unbind(self, sequence, funcid=None):
987 """Unbind for this widget for event SEQUENCE the
988 function identified with FUNCID."""
989 self.tk.call('bind', self._w, sequence, '')
990 if funcid:
991 self.deletecommand(funcid)
992 def bind_all(self, sequence=None, func=None, add=None):
993 """Bind to all widgets at an event SEQUENCE a call to function FUNC.
994 An additional boolean parameter ADD specifies whether FUNC will
995 be called additionally to the other bound function or whether
996 it will replace the previous function. See bind for the return value."""
997 return self._bind(('bind', 'all'), sequence, func, add, 0)
998 def unbind_all(self, sequence):
999 """Unbind for all widgets for event SEQUENCE all functions."""
1000 self.tk.call('bind', 'all' , sequence, '')
1001 def bind_class(self, className, sequence=None, func=None, add=None):
1003 """Bind to widgets with bindtag CLASSNAME at event
1004 SEQUENCE a call of function FUNC. An additional
1005 boolean parameter ADD specifies whether FUNC will be
1006 called additionally to the other bound function or
1007 whether it will replace the previous function. See bind for
1008 the return value."""
1010 return self._bind(('bind', className), sequence, func, add, 0)
1011 def unbind_class(self, className, sequence):
1012 """Unbind for a all widgets with bindtag CLASSNAME for event SEQUENCE
1013 all functions."""
1014 self.tk.call('bind', className , sequence, '')
1015 def mainloop(self, n=0):
1016 """Call the mainloop of Tk."""
1017 self.tk.mainloop(n)
1018 def quit(self):
1019 """Quit the Tcl interpreter. All widgets will be destroyed."""
1020 self.tk.quit()
1021 def _getints(self, string):
1022 """Internal function."""
1023 if string:
1024 return tuple(map(getint, self.tk.splitlist(string)))
1025 def _getdoubles(self, string):
1026 """Internal function."""
1027 if string:
1028 return tuple(map(getdouble, self.tk.splitlist(string)))
1029 def _getboolean(self, string):
1030 """Internal function."""
1031 if string:
1032 return self.tk.getboolean(string)
1033 def _displayof(self, displayof):
1034 """Internal function."""
1035 if displayof:
1036 return ('-displayof', displayof)
1037 if displayof is None:
1038 return ('-displayof', self._w)
1039 return ()
1040 def _options(self, cnf, kw = None):
1041 """Internal function."""
1042 if kw:
1043 cnf = _cnfmerge((cnf, kw))
1044 else:
1045 cnf = _cnfmerge(cnf)
1046 res = ()
1047 for k, v in cnf.items():
1048 if v is not None:
1049 if k[-1] == '_': k = k[:-1]
1050 if hasattr(v, '__call__'):
1051 v = self._register(v)
1052 elif isinstance(v, (tuple, list)):
1053 nv = []
1054 for item in v:
1055 if not isinstance(item, (basestring, int)):
1056 break
1057 elif isinstance(item, int):
1058 nv.append('%d' % item)
1059 else:
1060 # format it to proper Tcl code if it contains space
1061 nv.append(('{%s}' if ' ' in item else '%s') % item)
1062 else:
1063 v = ' '.join(nv)
1064 res = res + ('-'+k, v)
1065 return res
1066 def nametowidget(self, name):
1067 """Return the Tkinter instance of a widget identified by
1068 its Tcl name NAME."""
1069 name = str(name).split('.')
1070 w = self
1072 if not name[0]:
1073 w = w._root()
1074 name = name[1:]
1076 for n in name:
1077 if not n:
1078 break
1079 w = w.children[n]
1081 return w
1082 _nametowidget = nametowidget
1083 def _register(self, func, subst=None, needcleanup=1):
1084 """Return a newly created Tcl function. If this
1085 function is called, the Python function FUNC will
1086 be executed. An optional function SUBST can
1087 be given which will be executed before FUNC."""
1088 f = CallWrapper(func, subst, self).__call__
1089 name = repr(id(f))
1090 try:
1091 func = func.im_func
1092 except AttributeError:
1093 pass
1094 try:
1095 name = name + func.__name__
1096 except AttributeError:
1097 pass
1098 self.tk.createcommand(name, f)
1099 if needcleanup:
1100 if self._tclCommands is None:
1101 self._tclCommands = []
1102 self._tclCommands.append(name)
1103 return name
1104 register = _register
1105 def _root(self):
1106 """Internal function."""
1107 w = self
1108 while w.master: w = w.master
1109 return w
1110 _subst_format = ('%#', '%b', '%f', '%h', '%k',
1111 '%s', '%t', '%w', '%x', '%y',
1112 '%A', '%E', '%K', '%N', '%W', '%T', '%X', '%Y', '%D')
1113 _subst_format_str = " ".join(_subst_format)
1114 def _substitute(self, *args):
1115 """Internal function."""
1116 if len(args) != len(self._subst_format): return args
1117 getboolean = self.tk.getboolean
1119 getint = int
1120 def getint_event(s):
1121 """Tk changed behavior in 8.4.2, returning "??" rather more often."""
1122 try:
1123 return int(s)
1124 except ValueError:
1125 return s
1127 nsign, b, f, h, k, s, t, w, x, y, A, E, K, N, W, T, X, Y, D = args
1128 # Missing: (a, c, d, m, o, v, B, R)
1129 e = Event()
1130 # serial field: valid vor all events
1131 # number of button: ButtonPress and ButtonRelease events only
1132 # height field: Configure, ConfigureRequest, Create,
1133 # ResizeRequest, and Expose events only
1134 # keycode field: KeyPress and KeyRelease events only
1135 # time field: "valid for events that contain a time field"
1136 # width field: Configure, ConfigureRequest, Create, ResizeRequest,
1137 # and Expose events only
1138 # x field: "valid for events that contain a x field"
1139 # y field: "valid for events that contain a y field"
1140 # keysym as decimal: KeyPress and KeyRelease events only
1141 # x_root, y_root fields: ButtonPress, ButtonRelease, KeyPress,
1142 # KeyRelease,and Motion events
1143 e.serial = getint(nsign)
1144 e.num = getint_event(b)
1145 try: e.focus = getboolean(f)
1146 except TclError: pass
1147 e.height = getint_event(h)
1148 e.keycode = getint_event(k)
1149 e.state = getint_event(s)
1150 e.time = getint_event(t)
1151 e.width = getint_event(w)
1152 e.x = getint_event(x)
1153 e.y = getint_event(y)
1154 e.char = A
1155 try: e.send_event = getboolean(E)
1156 except TclError: pass
1157 e.keysym = K
1158 e.keysym_num = getint_event(N)
1159 e.type = T
1160 try:
1161 e.widget = self._nametowidget(W)
1162 except KeyError:
1163 e.widget = W
1164 e.x_root = getint_event(X)
1165 e.y_root = getint_event(Y)
1166 try:
1167 e.delta = getint(D)
1168 except ValueError:
1169 e.delta = 0
1170 return (e,)
1171 def _report_exception(self):
1172 """Internal function."""
1173 import sys
1174 exc, val, tb = sys.exc_type, sys.exc_value, sys.exc_traceback
1175 root = self._root()
1176 root.report_callback_exception(exc, val, tb)
1177 def _configure(self, cmd, cnf, kw):
1178 """Internal function."""
1179 if kw:
1180 cnf = _cnfmerge((cnf, kw))
1181 elif cnf:
1182 cnf = _cnfmerge(cnf)
1183 if cnf is None:
1184 cnf = {}
1185 for x in self.tk.split(
1186 self.tk.call(_flatten((self._w, cmd)))):
1187 cnf[x[0][1:]] = (x[0][1:],) + x[1:]
1188 return cnf
1189 if type(cnf) is StringType:
1190 x = self.tk.split(
1191 self.tk.call(_flatten((self._w, cmd, '-'+cnf))))
1192 return (x[0][1:],) + x[1:]
1193 self.tk.call(_flatten((self._w, cmd)) + self._options(cnf))
1194 # These used to be defined in Widget:
1195 def configure(self, cnf=None, **kw):
1196 """Configure resources of a widget.
1198 The values for resources are specified as keyword
1199 arguments. To get an overview about
1200 the allowed keyword arguments call the method keys.
1202 return self._configure('configure', cnf, kw)
1203 config = configure
1204 def cget(self, key):
1205 """Return the resource value for a KEY given as string."""
1206 return self.tk.call(self._w, 'cget', '-' + key)
1207 __getitem__ = cget
1208 def __setitem__(self, key, value):
1209 self.configure({key: value})
1210 def __contains__(self, key):
1211 raise TypeError("Tkinter objects don't support 'in' tests.")
1212 def keys(self):
1213 """Return a list of all resource names of this widget."""
1214 return map(lambda x: x[0][1:],
1215 self.tk.split(self.tk.call(self._w, 'configure')))
1216 def __str__(self):
1217 """Return the window path name of this widget."""
1218 return self._w
1219 # Pack methods that apply to the master
1220 _noarg_ = ['_noarg_']
1221 def pack_propagate(self, flag=_noarg_):
1222 """Set or get the status for propagation of geometry information.
1224 A boolean argument specifies whether the geometry information
1225 of the slaves will determine the size of this widget. If no argument
1226 is given the current setting will be returned.
1228 if flag is Misc._noarg_:
1229 return self._getboolean(self.tk.call(
1230 'pack', 'propagate', self._w))
1231 else:
1232 self.tk.call('pack', 'propagate', self._w, flag)
1233 propagate = pack_propagate
1234 def pack_slaves(self):
1235 """Return a list of all slaves of this widget
1236 in its packing order."""
1237 return map(self._nametowidget,
1238 self.tk.splitlist(
1239 self.tk.call('pack', 'slaves', self._w)))
1240 slaves = pack_slaves
1241 # Place method that applies to the master
1242 def place_slaves(self):
1243 """Return a list of all slaves of this widget
1244 in its packing order."""
1245 return map(self._nametowidget,
1246 self.tk.splitlist(
1247 self.tk.call(
1248 'place', 'slaves', self._w)))
1249 # Grid methods that apply to the master
1250 def grid_bbox(self, column=None, row=None, col2=None, row2=None):
1251 """Return a tuple of integer coordinates for the bounding
1252 box of this widget controlled by the geometry manager grid.
1254 If COLUMN, ROW is given the bounding box applies from
1255 the cell with row and column 0 to the specified
1256 cell. If COL2 and ROW2 are given the bounding box
1257 starts at that cell.
1259 The returned integers specify the offset of the upper left
1260 corner in the master widget and the width and height.
1262 args = ('grid', 'bbox', self._w)
1263 if column is not None and row is not None:
1264 args = args + (column, row)
1265 if col2 is not None and row2 is not None:
1266 args = args + (col2, row2)
1267 return self._getints(self.tk.call(*args)) or None
1269 bbox = grid_bbox
1270 def _grid_configure(self, command, index, cnf, kw):
1271 """Internal function."""
1272 if type(cnf) is StringType and not kw:
1273 if cnf[-1:] == '_':
1274 cnf = cnf[:-1]
1275 if cnf[:1] != '-':
1276 cnf = '-'+cnf
1277 options = (cnf,)
1278 else:
1279 options = self._options(cnf, kw)
1280 if not options:
1281 res = self.tk.call('grid',
1282 command, self._w, index)
1283 words = self.tk.splitlist(res)
1284 dict = {}
1285 for i in range(0, len(words), 2):
1286 key = words[i][1:]
1287 value = words[i+1]
1288 if not value:
1289 value = None
1290 elif '.' in value:
1291 value = getdouble(value)
1292 else:
1293 value = getint(value)
1294 dict[key] = value
1295 return dict
1296 res = self.tk.call(
1297 ('grid', command, self._w, index)
1298 + options)
1299 if len(options) == 1:
1300 if not res: return None
1301 # In Tk 7.5, -width can be a float
1302 if '.' in res: return getdouble(res)
1303 return getint(res)
1304 def grid_columnconfigure(self, index, cnf={}, **kw):
1305 """Configure column INDEX of a grid.
1307 Valid resources are minsize (minimum size of the column),
1308 weight (how much does additional space propagate to this column)
1309 and pad (how much space to let additionally)."""
1310 return self._grid_configure('columnconfigure', index, cnf, kw)
1311 columnconfigure = grid_columnconfigure
1312 def grid_location(self, x, y):
1313 """Return a tuple of column and row which identify the cell
1314 at which the pixel at position X and Y inside the master
1315 widget is located."""
1316 return self._getints(
1317 self.tk.call(
1318 'grid', 'location', self._w, x, y)) or None
1319 def grid_propagate(self, flag=_noarg_):
1320 """Set or get the status for propagation of geometry information.
1322 A boolean argument specifies whether the geometry information
1323 of the slaves will determine the size of this widget. If no argument
1324 is given, the current setting will be returned.
1326 if flag is Misc._noarg_:
1327 return self._getboolean(self.tk.call(
1328 'grid', 'propagate', self._w))
1329 else:
1330 self.tk.call('grid', 'propagate', self._w, flag)
1331 def grid_rowconfigure(self, index, cnf={}, **kw):
1332 """Configure row INDEX of a grid.
1334 Valid resources are minsize (minimum size of the row),
1335 weight (how much does additional space propagate to this row)
1336 and pad (how much space to let additionally)."""
1337 return self._grid_configure('rowconfigure', index, cnf, kw)
1338 rowconfigure = grid_rowconfigure
1339 def grid_size(self):
1340 """Return a tuple of the number of column and rows in the grid."""
1341 return self._getints(
1342 self.tk.call('grid', 'size', self._w)) or None
1343 size = grid_size
1344 def grid_slaves(self, row=None, column=None):
1345 """Return a list of all slaves of this widget
1346 in its packing order."""
1347 args = ()
1348 if row is not None:
1349 args = args + ('-row', row)
1350 if column is not None:
1351 args = args + ('-column', column)
1352 return map(self._nametowidget,
1353 self.tk.splitlist(self.tk.call(
1354 ('grid', 'slaves', self._w) + args)))
1356 # Support for the "event" command, new in Tk 4.2.
1357 # By Case Roole.
1359 def event_add(self, virtual, *sequences):
1360 """Bind a virtual event VIRTUAL (of the form <<Name>>)
1361 to an event SEQUENCE such that the virtual event is triggered
1362 whenever SEQUENCE occurs."""
1363 args = ('event', 'add', virtual) + sequences
1364 self.tk.call(args)
1366 def event_delete(self, virtual, *sequences):
1367 """Unbind a virtual event VIRTUAL from SEQUENCE."""
1368 args = ('event', 'delete', virtual) + sequences
1369 self.tk.call(args)
1371 def event_generate(self, sequence, **kw):
1372 """Generate an event SEQUENCE. Additional
1373 keyword arguments specify parameter of the event
1374 (e.g. x, y, rootx, rooty)."""
1375 args = ('event', 'generate', self._w, sequence)
1376 for k, v in kw.items():
1377 args = args + ('-%s' % k, str(v))
1378 self.tk.call(args)
1380 def event_info(self, virtual=None):
1381 """Return a list of all virtual events or the information
1382 about the SEQUENCE bound to the virtual event VIRTUAL."""
1383 return self.tk.splitlist(
1384 self.tk.call('event', 'info', virtual))
1386 # Image related commands
1388 def image_names(self):
1389 """Return a list of all existing image names."""
1390 return self.tk.call('image', 'names')
1392 def image_types(self):
1393 """Return a list of all available image types (e.g. phote bitmap)."""
1394 return self.tk.call('image', 'types')
1397 class CallWrapper:
1398 """Internal class. Stores function to call when some user
1399 defined Tcl function is called e.g. after an event occurred."""
1400 def __init__(self, func, subst, widget):
1401 """Store FUNC, SUBST and WIDGET as members."""
1402 self.func = func
1403 self.subst = subst
1404 self.widget = widget
1405 def __call__(self, *args):
1406 """Apply first function SUBST to arguments, than FUNC."""
1407 try:
1408 if self.subst:
1409 args = self.subst(*args)
1410 return self.func(*args)
1411 except SystemExit, msg:
1412 raise SystemExit, msg
1413 except:
1414 self.widget._report_exception()
1417 class XView:
1418 """Mix-in class for querying and changing the horizontal position
1419 of a widget's window."""
1421 def xview(self, *args):
1422 """Query and change the horizontal position of the view."""
1423 res = self.tk.call(self._w, 'xview', *args)
1424 if not args:
1425 return self._getdoubles(res)
1427 def xview_moveto(self, fraction):
1428 """Adjusts the view in the window so that FRACTION of the
1429 total width of the canvas is off-screen to the left."""
1430 self.tk.call(self._w, 'xview', 'moveto', fraction)
1432 def xview_scroll(self, number, what):
1433 """Shift the x-view according to NUMBER which is measured in "units"
1434 or "pages" (WHAT)."""
1435 self.tk.call(self._w, 'xview', 'scroll', number, what)
1438 class YView:
1439 """Mix-in class for querying and changing the vertical position
1440 of a widget's window."""
1442 def yview(self, *args):
1443 """Query and change the vertical position of the view."""
1444 res = self.tk.call(self._w, 'yview', *args)
1445 if not args:
1446 return self._getdoubles(res)
1448 def yview_moveto(self, fraction):
1449 """Adjusts the view in the window so that FRACTION of the
1450 total height of the canvas is off-screen to the top."""
1451 self.tk.call(self._w, 'yview', 'moveto', fraction)
1453 def yview_scroll(self, number, what):
1454 """Shift the y-view according to NUMBER which is measured in
1455 "units" or "pages" (WHAT)."""
1456 self.tk.call(self._w, 'yview', 'scroll', number, what)
1459 class Wm:
1460 """Provides functions for the communication with the window manager."""
1462 def wm_aspect(self,
1463 minNumer=None, minDenom=None,
1464 maxNumer=None, maxDenom=None):
1465 """Instruct the window manager to set the aspect ratio (width/height)
1466 of this widget to be between MINNUMER/MINDENOM and MAXNUMER/MAXDENOM. Return a tuple
1467 of the actual values if no argument is given."""
1468 return self._getints(
1469 self.tk.call('wm', 'aspect', self._w,
1470 minNumer, minDenom,
1471 maxNumer, maxDenom))
1472 aspect = wm_aspect
1474 def wm_attributes(self, *args):
1475 """This subcommand returns or sets platform specific attributes
1477 The first form returns a list of the platform specific flags and
1478 their values. The second form returns the value for the specific
1479 option. The third form sets one or more of the values. The values
1480 are as follows:
1482 On Windows, -disabled gets or sets whether the window is in a
1483 disabled state. -toolwindow gets or sets the style of the window
1484 to toolwindow (as defined in the MSDN). -topmost gets or sets
1485 whether this is a topmost window (displays above all other
1486 windows).
1488 On Macintosh, XXXXX
1490 On Unix, there are currently no special attribute values.
1492 args = ('wm', 'attributes', self._w) + args
1493 return self.tk.call(args)
1494 attributes=wm_attributes
1496 def wm_client(self, name=None):
1497 """Store NAME in WM_CLIENT_MACHINE property of this widget. Return
1498 current value."""
1499 return self.tk.call('wm', 'client', self._w, name)
1500 client = wm_client
1501 def wm_colormapwindows(self, *wlist):
1502 """Store list of window names (WLIST) into WM_COLORMAPWINDOWS property
1503 of this widget. This list contains windows whose colormaps differ from their
1504 parents. Return current list of widgets if WLIST is empty."""
1505 if len(wlist) > 1:
1506 wlist = (wlist,) # Tk needs a list of windows here
1507 args = ('wm', 'colormapwindows', self._w) + wlist
1508 return map(self._nametowidget, self.tk.call(args))
1509 colormapwindows = wm_colormapwindows
1510 def wm_command(self, value=None):
1511 """Store VALUE in WM_COMMAND property. It is the command
1512 which shall be used to invoke the application. Return current
1513 command if VALUE is None."""
1514 return self.tk.call('wm', 'command', self._w, value)
1515 command = wm_command
1516 def wm_deiconify(self):
1517 """Deiconify this widget. If it was never mapped it will not be mapped.
1518 On Windows it will raise this widget and give it the focus."""
1519 return self.tk.call('wm', 'deiconify', self._w)
1520 deiconify = wm_deiconify
1521 def wm_focusmodel(self, model=None):
1522 """Set focus model to MODEL. "active" means that this widget will claim
1523 the focus itself, "passive" means that the window manager shall give
1524 the focus. Return current focus model if MODEL is None."""
1525 return self.tk.call('wm', 'focusmodel', self._w, model)
1526 focusmodel = wm_focusmodel
1527 def wm_frame(self):
1528 """Return identifier for decorative frame of this widget if present."""
1529 return self.tk.call('wm', 'frame', self._w)
1530 frame = wm_frame
1531 def wm_geometry(self, newGeometry=None):
1532 """Set geometry to NEWGEOMETRY of the form =widthxheight+x+y. Return
1533 current value if None is given."""
1534 return self.tk.call('wm', 'geometry', self._w, newGeometry)
1535 geometry = wm_geometry
1536 def wm_grid(self,
1537 baseWidth=None, baseHeight=None,
1538 widthInc=None, heightInc=None):
1539 """Instruct the window manager that this widget shall only be
1540 resized on grid boundaries. WIDTHINC and HEIGHTINC are the width and
1541 height of a grid unit in pixels. BASEWIDTH and BASEHEIGHT are the
1542 number of grid units requested in Tk_GeometryRequest."""
1543 return self._getints(self.tk.call(
1544 'wm', 'grid', self._w,
1545 baseWidth, baseHeight, widthInc, heightInc))
1546 grid = wm_grid
1547 def wm_group(self, pathName=None):
1548 """Set the group leader widgets for related widgets to PATHNAME. Return
1549 the group leader of this widget if None is given."""
1550 return self.tk.call('wm', 'group', self._w, pathName)
1551 group = wm_group
1552 def wm_iconbitmap(self, bitmap=None, default=None):
1553 """Set bitmap for the iconified widget to BITMAP. Return
1554 the bitmap if None is given.
1556 Under Windows, the DEFAULT parameter can be used to set the icon
1557 for the widget and any descendents that don't have an icon set
1558 explicitly. DEFAULT can be the relative path to a .ico file
1559 (example: root.iconbitmap(default='myicon.ico') ). See Tk
1560 documentation for more information."""
1561 if default:
1562 return self.tk.call('wm', 'iconbitmap', self._w, '-default', default)
1563 else:
1564 return self.tk.call('wm', 'iconbitmap', self._w, bitmap)
1565 iconbitmap = wm_iconbitmap
1566 def wm_iconify(self):
1567 """Display widget as icon."""
1568 return self.tk.call('wm', 'iconify', self._w)
1569 iconify = wm_iconify
1570 def wm_iconmask(self, bitmap=None):
1571 """Set mask for the icon bitmap of this widget. Return the
1572 mask if None is given."""
1573 return self.tk.call('wm', 'iconmask', self._w, bitmap)
1574 iconmask = wm_iconmask
1575 def wm_iconname(self, newName=None):
1576 """Set the name of the icon for this widget. Return the name if
1577 None is given."""
1578 return self.tk.call('wm', 'iconname', self._w, newName)
1579 iconname = wm_iconname
1580 def wm_iconposition(self, x=None, y=None):
1581 """Set the position of the icon of this widget to X and Y. Return
1582 a tuple of the current values of X and X if None is given."""
1583 return self._getints(self.tk.call(
1584 'wm', 'iconposition', self._w, x, y))
1585 iconposition = wm_iconposition
1586 def wm_iconwindow(self, pathName=None):
1587 """Set widget PATHNAME to be displayed instead of icon. Return the current
1588 value if None is given."""
1589 return self.tk.call('wm', 'iconwindow', self._w, pathName)
1590 iconwindow = wm_iconwindow
1591 def wm_maxsize(self, width=None, height=None):
1592 """Set max WIDTH and HEIGHT for this widget. If the window is gridded
1593 the values are given in grid units. Return the current values if None
1594 is given."""
1595 return self._getints(self.tk.call(
1596 'wm', 'maxsize', self._w, width, height))
1597 maxsize = wm_maxsize
1598 def wm_minsize(self, width=None, height=None):
1599 """Set min WIDTH and HEIGHT for this widget. If the window is gridded
1600 the values are given in grid units. Return the current values if None
1601 is given."""
1602 return self._getints(self.tk.call(
1603 'wm', 'minsize', self._w, width, height))
1604 minsize = wm_minsize
1605 def wm_overrideredirect(self, boolean=None):
1606 """Instruct the window manager to ignore this widget
1607 if BOOLEAN is given with 1. Return the current value if None
1608 is given."""
1609 return self._getboolean(self.tk.call(
1610 'wm', 'overrideredirect', self._w, boolean))
1611 overrideredirect = wm_overrideredirect
1612 def wm_positionfrom(self, who=None):
1613 """Instruct the window manager that the position of this widget shall
1614 be defined by the user if WHO is "user", and by its own policy if WHO is
1615 "program"."""
1616 return self.tk.call('wm', 'positionfrom', self._w, who)
1617 positionfrom = wm_positionfrom
1618 def wm_protocol(self, name=None, func=None):
1619 """Bind function FUNC to command NAME for this widget.
1620 Return the function bound to NAME if None is given. NAME could be
1621 e.g. "WM_SAVE_YOURSELF" or "WM_DELETE_WINDOW"."""
1622 if hasattr(func, '__call__'):
1623 command = self._register(func)
1624 else:
1625 command = func
1626 return self.tk.call(
1627 'wm', 'protocol', self._w, name, command)
1628 protocol = wm_protocol
1629 def wm_resizable(self, width=None, height=None):
1630 """Instruct the window manager whether this width can be resized
1631 in WIDTH or HEIGHT. Both values are boolean values."""
1632 return self.tk.call('wm', 'resizable', self._w, width, height)
1633 resizable = wm_resizable
1634 def wm_sizefrom(self, who=None):
1635 """Instruct the window manager that the size of this widget shall
1636 be defined by the user if WHO is "user", and by its own policy if WHO is
1637 "program"."""
1638 return self.tk.call('wm', 'sizefrom', self._w, who)
1639 sizefrom = wm_sizefrom
1640 def wm_state(self, newstate=None):
1641 """Query or set the state of this widget as one of normal, icon,
1642 iconic (see wm_iconwindow), withdrawn, or zoomed (Windows only)."""
1643 return self.tk.call('wm', 'state', self._w, newstate)
1644 state = wm_state
1645 def wm_title(self, string=None):
1646 """Set the title of this widget."""
1647 return self.tk.call('wm', 'title', self._w, string)
1648 title = wm_title
1649 def wm_transient(self, master=None):
1650 """Instruct the window manager that this widget is transient
1651 with regard to widget MASTER."""
1652 return self.tk.call('wm', 'transient', self._w, master)
1653 transient = wm_transient
1654 def wm_withdraw(self):
1655 """Withdraw this widget from the screen such that it is unmapped
1656 and forgotten by the window manager. Re-draw it with wm_deiconify."""
1657 return self.tk.call('wm', 'withdraw', self._w)
1658 withdraw = wm_withdraw
1661 class Tk(Misc, Wm):
1662 """Toplevel widget of Tk which represents mostly the main window
1663 of an appliation. It has an associated Tcl interpreter."""
1664 _w = '.'
1665 def __init__(self, screenName=None, baseName=None, className='Tk',
1666 useTk=1, sync=0, use=None):
1667 """Return a new Toplevel widget on screen SCREENNAME. A new Tcl interpreter will
1668 be created. BASENAME will be used for the identification of the profile file (see
1669 readprofile).
1670 It is constructed from sys.argv[0] without extensions if None is given. CLASSNAME
1671 is the name of the widget class."""
1672 self.master = None
1673 self.children = {}
1674 self._tkloaded = 0
1675 # to avoid recursions in the getattr code in case of failure, we
1676 # ensure that self.tk is always _something_.
1677 self.tk = None
1678 if baseName is None:
1679 import sys, os
1680 baseName = os.path.basename(sys.argv[0])
1681 baseName, ext = os.path.splitext(baseName)
1682 if ext not in ('.py', '.pyc', '.pyo'):
1683 baseName = baseName + ext
1684 interactive = 0
1685 self.tk = _tkinter.create(screenName, baseName, className, interactive, wantobjects, useTk, sync, use)
1686 if useTk:
1687 self._loadtk()
1688 self.readprofile(baseName, className)
1689 def loadtk(self):
1690 if not self._tkloaded:
1691 self.tk.loadtk()
1692 self._loadtk()
1693 def _loadtk(self):
1694 self._tkloaded = 1
1695 global _default_root
1696 # Version sanity checks
1697 tk_version = self.tk.getvar('tk_version')
1698 if tk_version != _tkinter.TK_VERSION:
1699 raise RuntimeError, \
1700 "tk.h version (%s) doesn't match libtk.a version (%s)" \
1701 % (_tkinter.TK_VERSION, tk_version)
1702 # Under unknown circumstances, tcl_version gets coerced to float
1703 tcl_version = str(self.tk.getvar('tcl_version'))
1704 if tcl_version != _tkinter.TCL_VERSION:
1705 raise RuntimeError, \
1706 "tcl.h version (%s) doesn't match libtcl.a version (%s)" \
1707 % (_tkinter.TCL_VERSION, tcl_version)
1708 if TkVersion < 4.0:
1709 raise RuntimeError, \
1710 "Tk 4.0 or higher is required; found Tk %s" \
1711 % str(TkVersion)
1712 # Create and register the tkerror and exit commands
1713 # We need to inline parts of _register here, _ register
1714 # would register differently-named commands.
1715 if self._tclCommands is None:
1716 self._tclCommands = []
1717 self.tk.createcommand('tkerror', _tkerror)
1718 self.tk.createcommand('exit', _exit)
1719 self._tclCommands.append('tkerror')
1720 self._tclCommands.append('exit')
1721 if _support_default_root and not _default_root:
1722 _default_root = self
1723 self.protocol("WM_DELETE_WINDOW", self.destroy)
1724 def destroy(self):
1725 """Destroy this and all descendants widgets. This will
1726 end the application of this Tcl interpreter."""
1727 for c in self.children.values(): c.destroy()
1728 self.tk.call('destroy', self._w)
1729 Misc.destroy(self)
1730 global _default_root
1731 if _support_default_root and _default_root is self:
1732 _default_root = None
1733 def readprofile(self, baseName, className):
1734 """Internal function. It reads BASENAME.tcl and CLASSNAME.tcl into
1735 the Tcl Interpreter and calls execfile on BASENAME.py and CLASSNAME.py if
1736 such a file exists in the home directory."""
1737 import os
1738 if 'HOME' in os.environ: home = os.environ['HOME']
1739 else: home = os.curdir
1740 class_tcl = os.path.join(home, '.%s.tcl' % className)
1741 class_py = os.path.join(home, '.%s.py' % className)
1742 base_tcl = os.path.join(home, '.%s.tcl' % baseName)
1743 base_py = os.path.join(home, '.%s.py' % baseName)
1744 dir = {'self': self}
1745 exec 'from Tkinter import *' in dir
1746 if os.path.isfile(class_tcl):
1747 self.tk.call('source', class_tcl)
1748 if os.path.isfile(class_py):
1749 execfile(class_py, dir)
1750 if os.path.isfile(base_tcl):
1751 self.tk.call('source', base_tcl)
1752 if os.path.isfile(base_py):
1753 execfile(base_py, dir)
1754 def report_callback_exception(self, exc, val, tb):
1755 """Internal function. It reports exception on sys.stderr."""
1756 import traceback, sys
1757 sys.stderr.write("Exception in Tkinter callback\n")
1758 sys.last_type = exc
1759 sys.last_value = val
1760 sys.last_traceback = tb
1761 traceback.print_exception(exc, val, tb)
1762 def __getattr__(self, attr):
1763 "Delegate attribute access to the interpreter object"
1764 return getattr(self.tk, attr)
1766 # Ideally, the classes Pack, Place and Grid disappear, the
1767 # pack/place/grid methods are defined on the Widget class, and
1768 # everybody uses w.pack_whatever(...) instead of Pack.whatever(w,
1769 # ...), with pack(), place() and grid() being short for
1770 # pack_configure(), place_configure() and grid_columnconfigure(), and
1771 # forget() being short for pack_forget(). As a practical matter, I'm
1772 # afraid that there is too much code out there that may be using the
1773 # Pack, Place or Grid class, so I leave them intact -- but only as
1774 # backwards compatibility features. Also note that those methods that
1775 # take a master as argument (e.g. pack_propagate) have been moved to
1776 # the Misc class (which now incorporates all methods common between
1777 # toplevel and interior widgets). Again, for compatibility, these are
1778 # copied into the Pack, Place or Grid class.
1781 def Tcl(screenName=None, baseName=None, className='Tk', useTk=0):
1782 return Tk(screenName, baseName, className, useTk)
1784 class Pack:
1785 """Geometry manager Pack.
1787 Base class to use the methods pack_* in every widget."""
1788 def pack_configure(self, cnf={}, **kw):
1789 """Pack a widget in the parent widget. Use as options:
1790 after=widget - pack it after you have packed widget
1791 anchor=NSEW (or subset) - position widget according to
1792 given direction
1793 before=widget - pack it before you will pack widget
1794 expand=bool - expand widget if parent size grows
1795 fill=NONE or X or Y or BOTH - fill widget if widget grows
1796 in=master - use master to contain this widget
1797 in_=master - see 'in' option description
1798 ipadx=amount - add internal padding in x direction
1799 ipady=amount - add internal padding in y direction
1800 padx=amount - add padding in x direction
1801 pady=amount - add padding in y direction
1802 side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
1804 self.tk.call(
1805 ('pack', 'configure', self._w)
1806 + self._options(cnf, kw))
1807 pack = configure = config = pack_configure
1808 def pack_forget(self):
1809 """Unmap this widget and do not use it for the packing order."""
1810 self.tk.call('pack', 'forget', self._w)
1811 forget = pack_forget
1812 def pack_info(self):
1813 """Return information about the packing options
1814 for this widget."""
1815 words = self.tk.splitlist(
1816 self.tk.call('pack', 'info', self._w))
1817 dict = {}
1818 for i in range(0, len(words), 2):
1819 key = words[i][1:]
1820 value = words[i+1]
1821 if value[:1] == '.':
1822 value = self._nametowidget(value)
1823 dict[key] = value
1824 return dict
1825 info = pack_info
1826 propagate = pack_propagate = Misc.pack_propagate
1827 slaves = pack_slaves = Misc.pack_slaves
1829 class Place:
1830 """Geometry manager Place.
1832 Base class to use the methods place_* in every widget."""
1833 def place_configure(self, cnf={}, **kw):
1834 """Place a widget in the parent widget. Use as options:
1835 in=master - master relative to which the widget is placed
1836 in_=master - see 'in' option description
1837 x=amount - locate anchor of this widget at position x of master
1838 y=amount - locate anchor of this widget at position y of master
1839 relx=amount - locate anchor of this widget between 0.0 and 1.0
1840 relative to width of master (1.0 is right edge)
1841 rely=amount - locate anchor of this widget between 0.0 and 1.0
1842 relative to height of master (1.0 is bottom edge)
1843 anchor=NSEW (or subset) - position anchor according to given direction
1844 width=amount - width of this widget in pixel
1845 height=amount - height of this widget in pixel
1846 relwidth=amount - width of this widget between 0.0 and 1.0
1847 relative to width of master (1.0 is the same width
1848 as the master)
1849 relheight=amount - height of this widget between 0.0 and 1.0
1850 relative to height of master (1.0 is the same
1851 height as the master)
1852 bordermode="inside" or "outside" - whether to take border width of
1853 master widget into account
1855 self.tk.call(
1856 ('place', 'configure', self._w)
1857 + self._options(cnf, kw))
1858 place = configure = config = place_configure
1859 def place_forget(self):
1860 """Unmap this widget."""
1861 self.tk.call('place', 'forget', self._w)
1862 forget = place_forget
1863 def place_info(self):
1864 """Return information about the placing options
1865 for this widget."""
1866 words = self.tk.splitlist(
1867 self.tk.call('place', 'info', self._w))
1868 dict = {}
1869 for i in range(0, len(words), 2):
1870 key = words[i][1:]
1871 value = words[i+1]
1872 if value[:1] == '.':
1873 value = self._nametowidget(value)
1874 dict[key] = value
1875 return dict
1876 info = place_info
1877 slaves = place_slaves = Misc.place_slaves
1879 class Grid:
1880 """Geometry manager Grid.
1882 Base class to use the methods grid_* in every widget."""
1883 # Thanks to Masazumi Yoshikawa (yosikawa@isi.edu)
1884 def grid_configure(self, cnf={}, **kw):
1885 """Position a widget in the parent widget in a grid. Use as options:
1886 column=number - use cell identified with given column (starting with 0)
1887 columnspan=number - this widget will span several columns
1888 in=master - use master to contain this widget
1889 in_=master - see 'in' option description
1890 ipadx=amount - add internal padding in x direction
1891 ipady=amount - add internal padding in y direction
1892 padx=amount - add padding in x direction
1893 pady=amount - add padding in y direction
1894 row=number - use cell identified with given row (starting with 0)
1895 rowspan=number - this widget will span several rows
1896 sticky=NSEW - if cell is larger on which sides will this
1897 widget stick to the cell boundary
1899 self.tk.call(
1900 ('grid', 'configure', self._w)
1901 + self._options(cnf, kw))
1902 grid = configure = config = grid_configure
1903 bbox = grid_bbox = Misc.grid_bbox
1904 columnconfigure = grid_columnconfigure = Misc.grid_columnconfigure
1905 def grid_forget(self):
1906 """Unmap this widget."""
1907 self.tk.call('grid', 'forget', self._w)
1908 forget = grid_forget
1909 def grid_remove(self):
1910 """Unmap this widget but remember the grid options."""
1911 self.tk.call('grid', 'remove', self._w)
1912 def grid_info(self):
1913 """Return information about the options
1914 for positioning this widget in a grid."""
1915 words = self.tk.splitlist(
1916 self.tk.call('grid', 'info', self._w))
1917 dict = {}
1918 for i in range(0, len(words), 2):
1919 key = words[i][1:]
1920 value = words[i+1]
1921 if value[:1] == '.':
1922 value = self._nametowidget(value)
1923 dict[key] = value
1924 return dict
1925 info = grid_info
1926 location = grid_location = Misc.grid_location
1927 propagate = grid_propagate = Misc.grid_propagate
1928 rowconfigure = grid_rowconfigure = Misc.grid_rowconfigure
1929 size = grid_size = Misc.grid_size
1930 slaves = grid_slaves = Misc.grid_slaves
1932 class BaseWidget(Misc):
1933 """Internal class."""
1934 def _setup(self, master, cnf):
1935 """Internal function. Sets up information about children."""
1936 if _support_default_root:
1937 global _default_root
1938 if not master:
1939 if not _default_root:
1940 _default_root = Tk()
1941 master = _default_root
1942 self.master = master
1943 self.tk = master.tk
1944 name = None
1945 if 'name' in cnf:
1946 name = cnf['name']
1947 del cnf['name']
1948 if not name:
1949 name = repr(id(self))
1950 self._name = name
1951 if master._w=='.':
1952 self._w = '.' + name
1953 else:
1954 self._w = master._w + '.' + name
1955 self.children = {}
1956 if self._name in self.master.children:
1957 self.master.children[self._name].destroy()
1958 self.master.children[self._name] = self
1959 def __init__(self, master, widgetName, cnf={}, kw={}, extra=()):
1960 """Construct a widget with the parent widget MASTER, a name WIDGETNAME
1961 and appropriate options."""
1962 if kw:
1963 cnf = _cnfmerge((cnf, kw))
1964 self.widgetName = widgetName
1965 BaseWidget._setup(self, master, cnf)
1966 if self._tclCommands is None:
1967 self._tclCommands = []
1968 classes = []
1969 for k in cnf.keys():
1970 if type(k) is ClassType:
1971 classes.append((k, cnf[k]))
1972 del cnf[k]
1973 self.tk.call(
1974 (widgetName, self._w) + extra + self._options(cnf))
1975 for k, v in classes:
1976 k.configure(self, v)
1977 def destroy(self):
1978 """Destroy this and all descendants widgets."""
1979 for c in self.children.values(): c.destroy()
1980 self.tk.call('destroy', self._w)
1981 if self._name in self.master.children:
1982 del self.master.children[self._name]
1983 Misc.destroy(self)
1984 def _do(self, name, args=()):
1985 # XXX Obsolete -- better use self.tk.call directly!
1986 return self.tk.call((self._w, name) + args)
1988 class Widget(BaseWidget, Pack, Place, Grid):
1989 """Internal class.
1991 Base class for a widget which can be positioned with the geometry managers
1992 Pack, Place or Grid."""
1993 pass
1995 class Toplevel(BaseWidget, Wm):
1996 """Toplevel widget, e.g. for dialogs."""
1997 def __init__(self, master=None, cnf={}, **kw):
1998 """Construct a toplevel widget with the parent MASTER.
2000 Valid resource names: background, bd, bg, borderwidth, class,
2001 colormap, container, cursor, height, highlightbackground,
2002 highlightcolor, highlightthickness, menu, relief, screen, takefocus,
2003 use, visual, width."""
2004 if kw:
2005 cnf = _cnfmerge((cnf, kw))
2006 extra = ()
2007 for wmkey in ['screen', 'class_', 'class', 'visual',
2008 'colormap']:
2009 if wmkey in cnf:
2010 val = cnf[wmkey]
2011 # TBD: a hack needed because some keys
2012 # are not valid as keyword arguments
2013 if wmkey[-1] == '_': opt = '-'+wmkey[:-1]
2014 else: opt = '-'+wmkey
2015 extra = extra + (opt, val)
2016 del cnf[wmkey]
2017 BaseWidget.__init__(self, master, 'toplevel', cnf, {}, extra)
2018 root = self._root()
2019 self.iconname(root.iconname())
2020 self.title(root.title())
2021 self.protocol("WM_DELETE_WINDOW", self.destroy)
2023 class Button(Widget):
2024 """Button widget."""
2025 def __init__(self, master=None, cnf={}, **kw):
2026 """Construct a button widget with the parent MASTER.
2028 STANDARD OPTIONS
2030 activebackground, activeforeground, anchor,
2031 background, bitmap, borderwidth, cursor,
2032 disabledforeground, font, foreground
2033 highlightbackground, highlightcolor,
2034 highlightthickness, image, justify,
2035 padx, pady, relief, repeatdelay,
2036 repeatinterval, takefocus, text,
2037 textvariable, underline, wraplength
2039 WIDGET-SPECIFIC OPTIONS
2041 command, compound, default, height,
2042 overrelief, state, width
2044 Widget.__init__(self, master, 'button', cnf, kw)
2046 def tkButtonEnter(self, *dummy):
2047 self.tk.call('tkButtonEnter', self._w)
2049 def tkButtonLeave(self, *dummy):
2050 self.tk.call('tkButtonLeave', self._w)
2052 def tkButtonDown(self, *dummy):
2053 self.tk.call('tkButtonDown', self._w)
2055 def tkButtonUp(self, *dummy):
2056 self.tk.call('tkButtonUp', self._w)
2058 def tkButtonInvoke(self, *dummy):
2059 self.tk.call('tkButtonInvoke', self._w)
2061 def flash(self):
2062 """Flash the button.
2064 This is accomplished by redisplaying
2065 the button several times, alternating between active and
2066 normal colors. At the end of the flash the button is left
2067 in the same normal/active state as when the command was
2068 invoked. This command is ignored if the button's state is
2069 disabled.
2071 self.tk.call(self._w, 'flash')
2073 def invoke(self):
2074 """Invoke the command associated with the button.
2076 The return value is the return value from the command,
2077 or an empty string if there is no command associated with
2078 the button. This command is ignored if the button's state
2079 is disabled.
2081 return self.tk.call(self._w, 'invoke')
2083 # Indices:
2084 # XXX I don't like these -- take them away
2085 def AtEnd():
2086 return 'end'
2087 def AtInsert(*args):
2088 s = 'insert'
2089 for a in args:
2090 if a: s = s + (' ' + a)
2091 return s
2092 def AtSelFirst():
2093 return 'sel.first'
2094 def AtSelLast():
2095 return 'sel.last'
2096 def At(x, y=None):
2097 if y is None:
2098 return '@%r' % (x,)
2099 else:
2100 return '@%r,%r' % (x, y)
2102 class Canvas(Widget, XView, YView):
2103 """Canvas widget to display graphical elements like lines or text."""
2104 def __init__(self, master=None, cnf={}, **kw):
2105 """Construct a canvas widget with the parent MASTER.
2107 Valid resource names: background, bd, bg, borderwidth, closeenough,
2108 confine, cursor, height, highlightbackground, highlightcolor,
2109 highlightthickness, insertbackground, insertborderwidth,
2110 insertofftime, insertontime, insertwidth, offset, relief,
2111 scrollregion, selectbackground, selectborderwidth, selectforeground,
2112 state, takefocus, width, xscrollcommand, xscrollincrement,
2113 yscrollcommand, yscrollincrement."""
2114 Widget.__init__(self, master, 'canvas', cnf, kw)
2115 def addtag(self, *args):
2116 """Internal function."""
2117 self.tk.call((self._w, 'addtag') + args)
2118 def addtag_above(self, newtag, tagOrId):
2119 """Add tag NEWTAG to all items above TAGORID."""
2120 self.addtag(newtag, 'above', tagOrId)
2121 def addtag_all(self, newtag):
2122 """Add tag NEWTAG to all items."""
2123 self.addtag(newtag, 'all')
2124 def addtag_below(self, newtag, tagOrId):
2125 """Add tag NEWTAG to all items below TAGORID."""
2126 self.addtag(newtag, 'below', tagOrId)
2127 def addtag_closest(self, newtag, x, y, halo=None, start=None):
2128 """Add tag NEWTAG to item which is closest to pixel at X, Y.
2129 If several match take the top-most.
2130 All items closer than HALO are considered overlapping (all are
2131 closests). If START is specified the next below this tag is taken."""
2132 self.addtag(newtag, 'closest', x, y, halo, start)
2133 def addtag_enclosed(self, newtag, x1, y1, x2, y2):
2134 """Add tag NEWTAG to all items in the rectangle defined
2135 by X1,Y1,X2,Y2."""
2136 self.addtag(newtag, 'enclosed', x1, y1, x2, y2)
2137 def addtag_overlapping(self, newtag, x1, y1, x2, y2):
2138 """Add tag NEWTAG to all items which overlap the rectangle
2139 defined by X1,Y1,X2,Y2."""
2140 self.addtag(newtag, 'overlapping', x1, y1, x2, y2)
2141 def addtag_withtag(self, newtag, tagOrId):
2142 """Add tag NEWTAG to all items with TAGORID."""
2143 self.addtag(newtag, 'withtag', tagOrId)
2144 def bbox(self, *args):
2145 """Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle
2146 which encloses all items with tags specified as arguments."""
2147 return self._getints(
2148 self.tk.call((self._w, 'bbox') + args)) or None
2149 def tag_unbind(self, tagOrId, sequence, funcid=None):
2150 """Unbind for all items with TAGORID for event SEQUENCE the
2151 function identified with FUNCID."""
2152 self.tk.call(self._w, 'bind', tagOrId, sequence, '')
2153 if funcid:
2154 self.deletecommand(funcid)
2155 def tag_bind(self, tagOrId, sequence=None, func=None, add=None):
2156 """Bind to all items with TAGORID at event SEQUENCE a call to function FUNC.
2158 An additional boolean parameter ADD specifies whether FUNC will be
2159 called additionally to the other bound function or whether it will
2160 replace the previous function. See bind for the return value."""
2161 return self._bind((self._w, 'bind', tagOrId),
2162 sequence, func, add)
2163 def canvasx(self, screenx, gridspacing=None):
2164 """Return the canvas x coordinate of pixel position SCREENX rounded
2165 to nearest multiple of GRIDSPACING units."""
2166 return getdouble(self.tk.call(
2167 self._w, 'canvasx', screenx, gridspacing))
2168 def canvasy(self, screeny, gridspacing=None):
2169 """Return the canvas y coordinate of pixel position SCREENY rounded
2170 to nearest multiple of GRIDSPACING units."""
2171 return getdouble(self.tk.call(
2172 self._w, 'canvasy', screeny, gridspacing))
2173 def coords(self, *args):
2174 """Return a list of coordinates for the item given in ARGS."""
2175 # XXX Should use _flatten on args
2176 return map(getdouble,
2177 self.tk.splitlist(
2178 self.tk.call((self._w, 'coords') + args)))
2179 def _create(self, itemType, args, kw): # Args: (val, val, ..., cnf={})
2180 """Internal function."""
2181 args = _flatten(args)
2182 cnf = args[-1]
2183 if type(cnf) in (DictionaryType, TupleType):
2184 args = args[:-1]
2185 else:
2186 cnf = {}
2187 return getint(self.tk.call(
2188 self._w, 'create', itemType,
2189 *(args + self._options(cnf, kw))))
2190 def create_arc(self, *args, **kw):
2191 """Create arc shaped region with coordinates x1,y1,x2,y2."""
2192 return self._create('arc', args, kw)
2193 def create_bitmap(self, *args, **kw):
2194 """Create bitmap with coordinates x1,y1."""
2195 return self._create('bitmap', args, kw)
2196 def create_image(self, *args, **kw):
2197 """Create image item with coordinates x1,y1."""
2198 return self._create('image', args, kw)
2199 def create_line(self, *args, **kw):
2200 """Create line with coordinates x1,y1,...,xn,yn."""
2201 return self._create('line', args, kw)
2202 def create_oval(self, *args, **kw):
2203 """Create oval with coordinates x1,y1,x2,y2."""
2204 return self._create('oval', args, kw)
2205 def create_polygon(self, *args, **kw):
2206 """Create polygon with coordinates x1,y1,...,xn,yn."""
2207 return self._create('polygon', args, kw)
2208 def create_rectangle(self, *args, **kw):
2209 """Create rectangle with coordinates x1,y1,x2,y2."""
2210 return self._create('rectangle', args, kw)
2211 def create_text(self, *args, **kw):
2212 """Create text with coordinates x1,y1."""
2213 return self._create('text', args, kw)
2214 def create_window(self, *args, **kw):
2215 """Create window with coordinates x1,y1,x2,y2."""
2216 return self._create('window', args, kw)
2217 def dchars(self, *args):
2218 """Delete characters of text items identified by tag or id in ARGS (possibly
2219 several times) from FIRST to LAST character (including)."""
2220 self.tk.call((self._w, 'dchars') + args)
2221 def delete(self, *args):
2222 """Delete items identified by all tag or ids contained in ARGS."""
2223 self.tk.call((self._w, 'delete') + args)
2224 def dtag(self, *args):
2225 """Delete tag or id given as last arguments in ARGS from items
2226 identified by first argument in ARGS."""
2227 self.tk.call((self._w, 'dtag') + args)
2228 def find(self, *args):
2229 """Internal function."""
2230 return self._getints(
2231 self.tk.call((self._w, 'find') + args)) or ()
2232 def find_above(self, tagOrId):
2233 """Return items above TAGORID."""
2234 return self.find('above', tagOrId)
2235 def find_all(self):
2236 """Return all items."""
2237 return self.find('all')
2238 def find_below(self, tagOrId):
2239 """Return all items below TAGORID."""
2240 return self.find('below', tagOrId)
2241 def find_closest(self, x, y, halo=None, start=None):
2242 """Return item which is closest to pixel at X, Y.
2243 If several match take the top-most.
2244 All items closer than HALO are considered overlapping (all are
2245 closests). If START is specified the next below this tag is taken."""
2246 return self.find('closest', x, y, halo, start)
2247 def find_enclosed(self, x1, y1, x2, y2):
2248 """Return all items in rectangle defined
2249 by X1,Y1,X2,Y2."""
2250 return self.find('enclosed', x1, y1, x2, y2)
2251 def find_overlapping(self, x1, y1, x2, y2):
2252 """Return all items which overlap the rectangle
2253 defined by X1,Y1,X2,Y2."""
2254 return self.find('overlapping', x1, y1, x2, y2)
2255 def find_withtag(self, tagOrId):
2256 """Return all items with TAGORID."""
2257 return self.find('withtag', tagOrId)
2258 def focus(self, *args):
2259 """Set focus to the first item specified in ARGS."""
2260 return self.tk.call((self._w, 'focus') + args)
2261 def gettags(self, *args):
2262 """Return tags associated with the first item specified in ARGS."""
2263 return self.tk.splitlist(
2264 self.tk.call((self._w, 'gettags') + args))
2265 def icursor(self, *args):
2266 """Set cursor at position POS in the item identified by TAGORID.
2267 In ARGS TAGORID must be first."""
2268 self.tk.call((self._w, 'icursor') + args)
2269 def index(self, *args):
2270 """Return position of cursor as integer in item specified in ARGS."""
2271 return getint(self.tk.call((self._w, 'index') + args))
2272 def insert(self, *args):
2273 """Insert TEXT in item TAGORID at position POS. ARGS must
2274 be TAGORID POS TEXT."""
2275 self.tk.call((self._w, 'insert') + args)
2276 def itemcget(self, tagOrId, option):
2277 """Return the resource value for an OPTION for item TAGORID."""
2278 return self.tk.call(
2279 (self._w, 'itemcget') + (tagOrId, '-'+option))
2280 def itemconfigure(self, tagOrId, cnf=None, **kw):
2281 """Configure resources of an item TAGORID.
2283 The values for resources are specified as keyword
2284 arguments. To get an overview about
2285 the allowed keyword arguments call the method without arguments.
2287 return self._configure(('itemconfigure', tagOrId), cnf, kw)
2288 itemconfig = itemconfigure
2289 # lower, tkraise/lift hide Misc.lower, Misc.tkraise/lift,
2290 # so the preferred name for them is tag_lower, tag_raise
2291 # (similar to tag_bind, and similar to the Text widget);
2292 # unfortunately can't delete the old ones yet (maybe in 1.6)
2293 def tag_lower(self, *args):
2294 """Lower an item TAGORID given in ARGS
2295 (optional below another item)."""
2296 self.tk.call((self._w, 'lower') + args)
2297 lower = tag_lower
2298 def move(self, *args):
2299 """Move an item TAGORID given in ARGS."""
2300 self.tk.call((self._w, 'move') + args)
2301 def postscript(self, cnf={}, **kw):
2302 """Print the contents of the canvas to a postscript
2303 file. Valid options: colormap, colormode, file, fontmap,
2304 height, pageanchor, pageheight, pagewidth, pagex, pagey,
2305 rotate, witdh, x, y."""
2306 return self.tk.call((self._w, 'postscript') +
2307 self._options(cnf, kw))
2308 def tag_raise(self, *args):
2309 """Raise an item TAGORID given in ARGS
2310 (optional above another item)."""
2311 self.tk.call((self._w, 'raise') + args)
2312 lift = tkraise = tag_raise
2313 def scale(self, *args):
2314 """Scale item TAGORID with XORIGIN, YORIGIN, XSCALE, YSCALE."""
2315 self.tk.call((self._w, 'scale') + args)
2316 def scan_mark(self, x, y):
2317 """Remember the current X, Y coordinates."""
2318 self.tk.call(self._w, 'scan', 'mark', x, y)
2319 def scan_dragto(self, x, y, gain=10):
2320 """Adjust the view of the canvas to GAIN times the
2321 difference between X and Y and the coordinates given in
2322 scan_mark."""
2323 self.tk.call(self._w, 'scan', 'dragto', x, y, gain)
2324 def select_adjust(self, tagOrId, index):
2325 """Adjust the end of the selection near the cursor of an item TAGORID to index."""
2326 self.tk.call(self._w, 'select', 'adjust', tagOrId, index)
2327 def select_clear(self):
2328 """Clear the selection if it is in this widget."""
2329 self.tk.call(self._w, 'select', 'clear')
2330 def select_from(self, tagOrId, index):
2331 """Set the fixed end of a selection in item TAGORID to INDEX."""
2332 self.tk.call(self._w, 'select', 'from', tagOrId, index)
2333 def select_item(self):
2334 """Return the item which has the selection."""
2335 return self.tk.call(self._w, 'select', 'item') or None
2336 def select_to(self, tagOrId, index):
2337 """Set the variable end of a selection in item TAGORID to INDEX."""
2338 self.tk.call(self._w, 'select', 'to', tagOrId, index)
2339 def type(self, tagOrId):
2340 """Return the type of the item TAGORID."""
2341 return self.tk.call(self._w, 'type', tagOrId) or None
2343 class Checkbutton(Widget):
2344 """Checkbutton widget which is either in on- or off-state."""
2345 def __init__(self, master=None, cnf={}, **kw):
2346 """Construct a checkbutton widget with the parent MASTER.
2348 Valid resource names: activebackground, activeforeground, anchor,
2349 background, bd, bg, bitmap, borderwidth, command, cursor,
2350 disabledforeground, fg, font, foreground, height,
2351 highlightbackground, highlightcolor, highlightthickness, image,
2352 indicatoron, justify, offvalue, onvalue, padx, pady, relief,
2353 selectcolor, selectimage, state, takefocus, text, textvariable,
2354 underline, variable, width, wraplength."""
2355 Widget.__init__(self, master, 'checkbutton', cnf, kw)
2356 def deselect(self):
2357 """Put the button in off-state."""
2358 self.tk.call(self._w, 'deselect')
2359 def flash(self):
2360 """Flash the button."""
2361 self.tk.call(self._w, 'flash')
2362 def invoke(self):
2363 """Toggle the button and invoke a command if given as resource."""
2364 return self.tk.call(self._w, 'invoke')
2365 def select(self):
2366 """Put the button in on-state."""
2367 self.tk.call(self._w, 'select')
2368 def toggle(self):
2369 """Toggle the button."""
2370 self.tk.call(self._w, 'toggle')
2372 class Entry(Widget, XView):
2373 """Entry widget which allows to display simple text."""
2374 def __init__(self, master=None, cnf={}, **kw):
2375 """Construct an entry widget with the parent MASTER.
2377 Valid resource names: background, bd, bg, borderwidth, cursor,
2378 exportselection, fg, font, foreground, highlightbackground,
2379 highlightcolor, highlightthickness, insertbackground,
2380 insertborderwidth, insertofftime, insertontime, insertwidth,
2381 invalidcommand, invcmd, justify, relief, selectbackground,
2382 selectborderwidth, selectforeground, show, state, takefocus,
2383 textvariable, validate, validatecommand, vcmd, width,
2384 xscrollcommand."""
2385 Widget.__init__(self, master, 'entry', cnf, kw)
2386 def delete(self, first, last=None):
2387 """Delete text from FIRST to LAST (not included)."""
2388 self.tk.call(self._w, 'delete', first, last)
2389 def get(self):
2390 """Return the text."""
2391 return self.tk.call(self._w, 'get')
2392 def icursor(self, index):
2393 """Insert cursor at INDEX."""
2394 self.tk.call(self._w, 'icursor', index)
2395 def index(self, index):
2396 """Return position of cursor."""
2397 return getint(self.tk.call(
2398 self._w, 'index', index))
2399 def insert(self, index, string):
2400 """Insert STRING at INDEX."""
2401 self.tk.call(self._w, 'insert', index, string)
2402 def scan_mark(self, x):
2403 """Remember the current X, Y coordinates."""
2404 self.tk.call(self._w, 'scan', 'mark', x)
2405 def scan_dragto(self, x):
2406 """Adjust the view of the canvas to 10 times the
2407 difference between X and Y and the coordinates given in
2408 scan_mark."""
2409 self.tk.call(self._w, 'scan', 'dragto', x)
2410 def selection_adjust(self, index):
2411 """Adjust the end of the selection near the cursor to INDEX."""
2412 self.tk.call(self._w, 'selection', 'adjust', index)
2413 select_adjust = selection_adjust
2414 def selection_clear(self):
2415 """Clear the selection if it is in this widget."""
2416 self.tk.call(self._w, 'selection', 'clear')
2417 select_clear = selection_clear
2418 def selection_from(self, index):
2419 """Set the fixed end of a selection to INDEX."""
2420 self.tk.call(self._w, 'selection', 'from', index)
2421 select_from = selection_from
2422 def selection_present(self):
2423 """Return True if there are characters selected in the entry, False
2424 otherwise."""
2425 return self.tk.getboolean(
2426 self.tk.call(self._w, 'selection', 'present'))
2427 select_present = selection_present
2428 def selection_range(self, start, end):
2429 """Set the selection from START to END (not included)."""
2430 self.tk.call(self._w, 'selection', 'range', start, end)
2431 select_range = selection_range
2432 def selection_to(self, index):
2433 """Set the variable end of a selection to INDEX."""
2434 self.tk.call(self._w, 'selection', 'to', index)
2435 select_to = selection_to
2437 class Frame(Widget):
2438 """Frame widget which may contain other widgets and can have a 3D border."""
2439 def __init__(self, master=None, cnf={}, **kw):
2440 """Construct a frame widget with the parent MASTER.
2442 Valid resource names: background, bd, bg, borderwidth, class,
2443 colormap, container, cursor, height, highlightbackground,
2444 highlightcolor, highlightthickness, relief, takefocus, visual, width."""
2445 cnf = _cnfmerge((cnf, kw))
2446 extra = ()
2447 if 'class_' in cnf:
2448 extra = ('-class', cnf['class_'])
2449 del cnf['class_']
2450 elif 'class' in cnf:
2451 extra = ('-class', cnf['class'])
2452 del cnf['class']
2453 Widget.__init__(self, master, 'frame', cnf, {}, extra)
2455 class Label(Widget):
2456 """Label widget which can display text and bitmaps."""
2457 def __init__(self, master=None, cnf={}, **kw):
2458 """Construct a label widget with the parent MASTER.
2460 STANDARD OPTIONS
2462 activebackground, activeforeground, anchor,
2463 background, bitmap, borderwidth, cursor,
2464 disabledforeground, font, foreground,
2465 highlightbackground, highlightcolor,
2466 highlightthickness, image, justify,
2467 padx, pady, relief, takefocus, text,
2468 textvariable, underline, wraplength
2470 WIDGET-SPECIFIC OPTIONS
2472 height, state, width
2475 Widget.__init__(self, master, 'label', cnf, kw)
2477 class Listbox(Widget, XView, YView):
2478 """Listbox widget which can display a list of strings."""
2479 def __init__(self, master=None, cnf={}, **kw):
2480 """Construct a listbox widget with the parent MASTER.
2482 Valid resource names: background, bd, bg, borderwidth, cursor,
2483 exportselection, fg, font, foreground, height, highlightbackground,
2484 highlightcolor, highlightthickness, relief, selectbackground,
2485 selectborderwidth, selectforeground, selectmode, setgrid, takefocus,
2486 width, xscrollcommand, yscrollcommand, listvariable."""
2487 Widget.__init__(self, master, 'listbox', cnf, kw)
2488 def activate(self, index):
2489 """Activate item identified by INDEX."""
2490 self.tk.call(self._w, 'activate', index)
2491 def bbox(self, *args):
2492 """Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle
2493 which encloses the item identified by index in ARGS."""
2494 return self._getints(
2495 self.tk.call((self._w, 'bbox') + args)) or None
2496 def curselection(self):
2497 """Return list of indices of currently selected item."""
2498 # XXX Ought to apply self._getints()...
2499 return self.tk.splitlist(self.tk.call(
2500 self._w, 'curselection'))
2501 def delete(self, first, last=None):
2502 """Delete items from FIRST to LAST (not included)."""
2503 self.tk.call(self._w, 'delete', first, last)
2504 def get(self, first, last=None):
2505 """Get list of items from FIRST to LAST (not included)."""
2506 if last:
2507 return self.tk.splitlist(self.tk.call(
2508 self._w, 'get', first, last))
2509 else:
2510 return self.tk.call(self._w, 'get', first)
2511 def index(self, index):
2512 """Return index of item identified with INDEX."""
2513 i = self.tk.call(self._w, 'index', index)
2514 if i == 'none': return None
2515 return getint(i)
2516 def insert(self, index, *elements):
2517 """Insert ELEMENTS at INDEX."""
2518 self.tk.call((self._w, 'insert', index) + elements)
2519 def nearest(self, y):
2520 """Get index of item which is nearest to y coordinate Y."""
2521 return getint(self.tk.call(
2522 self._w, 'nearest', y))
2523 def scan_mark(self, x, y):
2524 """Remember the current X, Y coordinates."""
2525 self.tk.call(self._w, 'scan', 'mark', x, y)
2526 def scan_dragto(self, x, y):
2527 """Adjust the view of the listbox to 10 times the
2528 difference between X and Y and the coordinates given in
2529 scan_mark."""
2530 self.tk.call(self._w, 'scan', 'dragto', x, y)
2531 def see(self, index):
2532 """Scroll such that INDEX is visible."""
2533 self.tk.call(self._w, 'see', index)
2534 def selection_anchor(self, index):
2535 """Set the fixed end oft the selection to INDEX."""
2536 self.tk.call(self._w, 'selection', 'anchor', index)
2537 select_anchor = selection_anchor
2538 def selection_clear(self, first, last=None):
2539 """Clear the selection from FIRST to LAST (not included)."""
2540 self.tk.call(self._w,
2541 'selection', 'clear', first, last)
2542 select_clear = selection_clear
2543 def selection_includes(self, index):
2544 """Return 1 if INDEX is part of the selection."""
2545 return self.tk.getboolean(self.tk.call(
2546 self._w, 'selection', 'includes', index))
2547 select_includes = selection_includes
2548 def selection_set(self, first, last=None):
2549 """Set the selection from FIRST to LAST (not included) without
2550 changing the currently selected elements."""
2551 self.tk.call(self._w, 'selection', 'set', first, last)
2552 select_set = selection_set
2553 def size(self):
2554 """Return the number of elements in the listbox."""
2555 return getint(self.tk.call(self._w, 'size'))
2556 def itemcget(self, index, option):
2557 """Return the resource value for an ITEM and an OPTION."""
2558 return self.tk.call(
2559 (self._w, 'itemcget') + (index, '-'+option))
2560 def itemconfigure(self, index, cnf=None, **kw):
2561 """Configure resources of an ITEM.
2563 The values for resources are specified as keyword arguments.
2564 To get an overview about the allowed keyword arguments
2565 call the method without arguments.
2566 Valid resource names: background, bg, foreground, fg,
2567 selectbackground, selectforeground."""
2568 return self._configure(('itemconfigure', index), cnf, kw)
2569 itemconfig = itemconfigure
2571 class Menu(Widget):
2572 """Menu widget which allows to display menu bars, pull-down menus and pop-up menus."""
2573 def __init__(self, master=None, cnf={}, **kw):
2574 """Construct menu widget with the parent MASTER.
2576 Valid resource names: activebackground, activeborderwidth,
2577 activeforeground, background, bd, bg, borderwidth, cursor,
2578 disabledforeground, fg, font, foreground, postcommand, relief,
2579 selectcolor, takefocus, tearoff, tearoffcommand, title, type."""
2580 Widget.__init__(self, master, 'menu', cnf, kw)
2581 def tk_bindForTraversal(self):
2582 pass # obsolete since Tk 4.0
2583 def tk_mbPost(self):
2584 self.tk.call('tk_mbPost', self._w)
2585 def tk_mbUnpost(self):
2586 self.tk.call('tk_mbUnpost')
2587 def tk_traverseToMenu(self, char):
2588 self.tk.call('tk_traverseToMenu', self._w, char)
2589 def tk_traverseWithinMenu(self, char):
2590 self.tk.call('tk_traverseWithinMenu', self._w, char)
2591 def tk_getMenuButtons(self):
2592 return self.tk.call('tk_getMenuButtons', self._w)
2593 def tk_nextMenu(self, count):
2594 self.tk.call('tk_nextMenu', count)
2595 def tk_nextMenuEntry(self, count):
2596 self.tk.call('tk_nextMenuEntry', count)
2597 def tk_invokeMenu(self):
2598 self.tk.call('tk_invokeMenu', self._w)
2599 def tk_firstMenu(self):
2600 self.tk.call('tk_firstMenu', self._w)
2601 def tk_mbButtonDown(self):
2602 self.tk.call('tk_mbButtonDown', self._w)
2603 def tk_popup(self, x, y, entry=""):
2604 """Post the menu at position X,Y with entry ENTRY."""
2605 self.tk.call('tk_popup', self._w, x, y, entry)
2606 def activate(self, index):
2607 """Activate entry at INDEX."""
2608 self.tk.call(self._w, 'activate', index)
2609 def add(self, itemType, cnf={}, **kw):
2610 """Internal function."""
2611 self.tk.call((self._w, 'add', itemType) +
2612 self._options(cnf, kw))
2613 def add_cascade(self, cnf={}, **kw):
2614 """Add hierarchical menu item."""
2615 self.add('cascade', cnf or kw)
2616 def add_checkbutton(self, cnf={}, **kw):
2617 """Add checkbutton menu item."""
2618 self.add('checkbutton', cnf or kw)
2619 def add_command(self, cnf={}, **kw):
2620 """Add command menu item."""
2621 self.add('command', cnf or kw)
2622 def add_radiobutton(self, cnf={}, **kw):
2623 """Addd radio menu item."""
2624 self.add('radiobutton', cnf or kw)
2625 def add_separator(self, cnf={}, **kw):
2626 """Add separator."""
2627 self.add('separator', cnf or kw)
2628 def insert(self, index, itemType, cnf={}, **kw):
2629 """Internal function."""
2630 self.tk.call((self._w, 'insert', index, itemType) +
2631 self._options(cnf, kw))
2632 def insert_cascade(self, index, cnf={}, **kw):
2633 """Add hierarchical menu item at INDEX."""
2634 self.insert(index, 'cascade', cnf or kw)
2635 def insert_checkbutton(self, index, cnf={}, **kw):
2636 """Add checkbutton menu item at INDEX."""
2637 self.insert(index, 'checkbutton', cnf or kw)
2638 def insert_command(self, index, cnf={}, **kw):
2639 """Add command menu item at INDEX."""
2640 self.insert(index, 'command', cnf or kw)
2641 def insert_radiobutton(self, index, cnf={}, **kw):
2642 """Addd radio menu item at INDEX."""
2643 self.insert(index, 'radiobutton', cnf or kw)
2644 def insert_separator(self, index, cnf={}, **kw):
2645 """Add separator at INDEX."""
2646 self.insert(index, 'separator', cnf or kw)
2647 def delete(self, index1, index2=None):
2648 """Delete menu items between INDEX1 and INDEX2 (included)."""
2649 if index2 is None:
2650 index2 = index1
2652 num_index1, num_index2 = self.index(index1), self.index(index2)
2653 if (num_index1 is None) or (num_index2 is None):
2654 num_index1, num_index2 = 0, -1
2656 for i in range(num_index1, num_index2 + 1):
2657 if 'command' in self.entryconfig(i):
2658 c = str(self.entrycget(i, 'command'))
2659 if c:
2660 self.deletecommand(c)
2661 self.tk.call(self._w, 'delete', index1, index2)
2662 def entrycget(self, index, option):
2663 """Return the resource value of an menu item for OPTION at INDEX."""
2664 return self.tk.call(self._w, 'entrycget', index, '-' + option)
2665 def entryconfigure(self, index, cnf=None, **kw):
2666 """Configure a menu item at INDEX."""
2667 return self._configure(('entryconfigure', index), cnf, kw)
2668 entryconfig = entryconfigure
2669 def index(self, index):
2670 """Return the index of a menu item identified by INDEX."""
2671 i = self.tk.call(self._w, 'index', index)
2672 if i == 'none': return None
2673 return getint(i)
2674 def invoke(self, index):
2675 """Invoke a menu item identified by INDEX and execute
2676 the associated command."""
2677 return self.tk.call(self._w, 'invoke', index)
2678 def post(self, x, y):
2679 """Display a menu at position X,Y."""
2680 self.tk.call(self._w, 'post', x, y)
2681 def type(self, index):
2682 """Return the type of the menu item at INDEX."""
2683 return self.tk.call(self._w, 'type', index)
2684 def unpost(self):
2685 """Unmap a menu."""
2686 self.tk.call(self._w, 'unpost')
2687 def yposition(self, index):
2688 """Return the y-position of the topmost pixel of the menu item at INDEX."""
2689 return getint(self.tk.call(
2690 self._w, 'yposition', index))
2692 class Menubutton(Widget):
2693 """Menubutton widget, obsolete since Tk8.0."""
2694 def __init__(self, master=None, cnf={}, **kw):
2695 Widget.__init__(self, master, 'menubutton', cnf, kw)
2697 class Message(Widget):
2698 """Message widget to display multiline text. Obsolete since Label does it too."""
2699 def __init__(self, master=None, cnf={}, **kw):
2700 Widget.__init__(self, master, 'message', cnf, kw)
2702 class Radiobutton(Widget):
2703 """Radiobutton widget which shows only one of several buttons in on-state."""
2704 def __init__(self, master=None, cnf={}, **kw):
2705 """Construct a radiobutton widget with the parent MASTER.
2707 Valid resource names: activebackground, activeforeground, anchor,
2708 background, bd, bg, bitmap, borderwidth, command, cursor,
2709 disabledforeground, fg, font, foreground, height,
2710 highlightbackground, highlightcolor, highlightthickness, image,
2711 indicatoron, justify, padx, pady, relief, selectcolor, selectimage,
2712 state, takefocus, text, textvariable, underline, value, variable,
2713 width, wraplength."""
2714 Widget.__init__(self, master, 'radiobutton', cnf, kw)
2715 def deselect(self):
2716 """Put the button in off-state."""
2718 self.tk.call(self._w, 'deselect')
2719 def flash(self):
2720 """Flash the button."""
2721 self.tk.call(self._w, 'flash')
2722 def invoke(self):
2723 """Toggle the button and invoke a command if given as resource."""
2724 return self.tk.call(self._w, 'invoke')
2725 def select(self):
2726 """Put the button in on-state."""
2727 self.tk.call(self._w, 'select')
2729 class Scale(Widget):
2730 """Scale widget which can display a numerical scale."""
2731 def __init__(self, master=None, cnf={}, **kw):
2732 """Construct a scale widget with the parent MASTER.
2734 Valid resource names: activebackground, background, bigincrement, bd,
2735 bg, borderwidth, command, cursor, digits, fg, font, foreground, from,
2736 highlightbackground, highlightcolor, highlightthickness, label,
2737 length, orient, relief, repeatdelay, repeatinterval, resolution,
2738 showvalue, sliderlength, sliderrelief, state, takefocus,
2739 tickinterval, to, troughcolor, variable, width."""
2740 Widget.__init__(self, master, 'scale', cnf, kw)
2741 def get(self):
2742 """Get the current value as integer or float."""
2743 value = self.tk.call(self._w, 'get')
2744 try:
2745 return getint(value)
2746 except ValueError:
2747 return getdouble(value)
2748 def set(self, value):
2749 """Set the value to VALUE."""
2750 self.tk.call(self._w, 'set', value)
2751 def coords(self, value=None):
2752 """Return a tuple (X,Y) of the point along the centerline of the
2753 trough that corresponds to VALUE or the current value if None is
2754 given."""
2756 return self._getints(self.tk.call(self._w, 'coords', value))
2757 def identify(self, x, y):
2758 """Return where the point X,Y lies. Valid return values are "slider",
2759 "though1" and "though2"."""
2760 return self.tk.call(self._w, 'identify', x, y)
2762 class Scrollbar(Widget):
2763 """Scrollbar widget which displays a slider at a certain position."""
2764 def __init__(self, master=None, cnf={}, **kw):
2765 """Construct a scrollbar widget with the parent MASTER.
2767 Valid resource names: activebackground, activerelief,
2768 background, bd, bg, borderwidth, command, cursor,
2769 elementborderwidth, highlightbackground,
2770 highlightcolor, highlightthickness, jump, orient,
2771 relief, repeatdelay, repeatinterval, takefocus,
2772 troughcolor, width."""
2773 Widget.__init__(self, master, 'scrollbar', cnf, kw)
2774 def activate(self, index):
2775 """Display the element at INDEX with activebackground and activerelief.
2776 INDEX can be "arrow1","slider" or "arrow2"."""
2777 self.tk.call(self._w, 'activate', index)
2778 def delta(self, deltax, deltay):
2779 """Return the fractional change of the scrollbar setting if it
2780 would be moved by DELTAX or DELTAY pixels."""
2781 return getdouble(
2782 self.tk.call(self._w, 'delta', deltax, deltay))
2783 def fraction(self, x, y):
2784 """Return the fractional value which corresponds to a slider
2785 position of X,Y."""
2786 return getdouble(self.tk.call(self._w, 'fraction', x, y))
2787 def identify(self, x, y):
2788 """Return the element under position X,Y as one of
2789 "arrow1","slider","arrow2" or ""."""
2790 return self.tk.call(self._w, 'identify', x, y)
2791 def get(self):
2792 """Return the current fractional values (upper and lower end)
2793 of the slider position."""
2794 return self._getdoubles(self.tk.call(self._w, 'get'))
2795 def set(self, *args):
2796 """Set the fractional values of the slider position (upper and
2797 lower ends as value between 0 and 1)."""
2798 self.tk.call((self._w, 'set') + args)
2802 class Text(Widget, XView, YView):
2803 """Text widget which can display text in various forms."""
2804 def __init__(self, master=None, cnf={}, **kw):
2805 """Construct a text widget with the parent MASTER.
2807 STANDARD OPTIONS
2809 background, borderwidth, cursor,
2810 exportselection, font, foreground,
2811 highlightbackground, highlightcolor,
2812 highlightthickness, insertbackground,
2813 insertborderwidth, insertofftime,
2814 insertontime, insertwidth, padx, pady,
2815 relief, selectbackground,
2816 selectborderwidth, selectforeground,
2817 setgrid, takefocus,
2818 xscrollcommand, yscrollcommand,
2820 WIDGET-SPECIFIC OPTIONS
2822 autoseparators, height, maxundo,
2823 spacing1, spacing2, spacing3,
2824 state, tabs, undo, width, wrap,
2827 Widget.__init__(self, master, 'text', cnf, kw)
2828 def bbox(self, *args):
2829 """Return a tuple of (x,y,width,height) which gives the bounding
2830 box of the visible part of the character at the index in ARGS."""
2831 return self._getints(
2832 self.tk.call((self._w, 'bbox') + args)) or None
2833 def tk_textSelectTo(self, index):
2834 self.tk.call('tk_textSelectTo', self._w, index)
2835 def tk_textBackspace(self):
2836 self.tk.call('tk_textBackspace', self._w)
2837 def tk_textIndexCloser(self, a, b, c):
2838 self.tk.call('tk_textIndexCloser', self._w, a, b, c)
2839 def tk_textResetAnchor(self, index):
2840 self.tk.call('tk_textResetAnchor', self._w, index)
2841 def compare(self, index1, op, index2):
2842 """Return whether between index INDEX1 and index INDEX2 the
2843 relation OP is satisfied. OP is one of <, <=, ==, >=, >, or !=."""
2844 return self.tk.getboolean(self.tk.call(
2845 self._w, 'compare', index1, op, index2))
2846 def debug(self, boolean=None):
2847 """Turn on the internal consistency checks of the B-Tree inside the text
2848 widget according to BOOLEAN."""
2849 return self.tk.getboolean(self.tk.call(
2850 self._w, 'debug', boolean))
2851 def delete(self, index1, index2=None):
2852 """Delete the characters between INDEX1 and INDEX2 (not included)."""
2853 self.tk.call(self._w, 'delete', index1, index2)
2854 def dlineinfo(self, index):
2855 """Return tuple (x,y,width,height,baseline) giving the bounding box
2856 and baseline position of the visible part of the line containing
2857 the character at INDEX."""
2858 return self._getints(self.tk.call(self._w, 'dlineinfo', index))
2859 def dump(self, index1, index2=None, command=None, **kw):
2860 """Return the contents of the widget between index1 and index2.
2862 The type of contents returned in filtered based on the keyword
2863 parameters; if 'all', 'image', 'mark', 'tag', 'text', or 'window' are
2864 given and true, then the corresponding items are returned. The result
2865 is a list of triples of the form (key, value, index). If none of the
2866 keywords are true then 'all' is used by default.
2868 If the 'command' argument is given, it is called once for each element
2869 of the list of triples, with the values of each triple serving as the
2870 arguments to the function. In this case the list is not returned."""
2871 args = []
2872 func_name = None
2873 result = None
2874 if not command:
2875 # Never call the dump command without the -command flag, since the
2876 # output could involve Tcl quoting and would be a pain to parse
2877 # right. Instead just set the command to build a list of triples
2878 # as if we had done the parsing.
2879 result = []
2880 def append_triple(key, value, index, result=result):
2881 result.append((key, value, index))
2882 command = append_triple
2883 try:
2884 if not isinstance(command, str):
2885 func_name = command = self._register(command)
2886 args += ["-command", command]
2887 for key in kw:
2888 if kw[key]: args.append("-" + key)
2889 args.append(index1)
2890 if index2:
2891 args.append(index2)
2892 self.tk.call(self._w, "dump", *args)
2893 return result
2894 finally:
2895 if func_name:
2896 self.deletecommand(func_name)
2898 ## new in tk8.4
2899 def edit(self, *args):
2900 """Internal method
2902 This method controls the undo mechanism and
2903 the modified flag. The exact behavior of the
2904 command depends on the option argument that
2905 follows the edit argument. The following forms
2906 of the command are currently supported:
2908 edit_modified, edit_redo, edit_reset, edit_separator
2909 and edit_undo
2912 return self.tk.call(self._w, 'edit', *args)
2914 def edit_modified(self, arg=None):
2915 """Get or Set the modified flag
2917 If arg is not specified, returns the modified
2918 flag of the widget. The insert, delete, edit undo and
2919 edit redo commands or the user can set or clear the
2920 modified flag. If boolean is specified, sets the
2921 modified flag of the widget to arg.
2923 return self.edit("modified", arg)
2925 def edit_redo(self):
2926 """Redo the last undone edit
2928 When the undo option is true, reapplies the last
2929 undone edits provided no other edits were done since
2930 then. Generates an error when the redo stack is empty.
2931 Does nothing when the undo option is false.
2933 return self.edit("redo")
2935 def edit_reset(self):
2936 """Clears the undo and redo stacks
2938 return self.edit("reset")
2940 def edit_separator(self):
2941 """Inserts a separator (boundary) on the undo stack.
2943 Does nothing when the undo option is false
2945 return self.edit("separator")
2947 def edit_undo(self):
2948 """Undoes the last edit action
2950 If the undo option is true. An edit action is defined
2951 as all the insert and delete commands that are recorded
2952 on the undo stack in between two separators. Generates
2953 an error when the undo stack is empty. Does nothing
2954 when the undo option is false
2956 return self.edit("undo")
2958 def get(self, index1, index2=None):
2959 """Return the text from INDEX1 to INDEX2 (not included)."""
2960 return self.tk.call(self._w, 'get', index1, index2)
2961 # (Image commands are new in 8.0)
2962 def image_cget(self, index, option):
2963 """Return the value of OPTION of an embedded image at INDEX."""
2964 if option[:1] != "-":
2965 option = "-" + option
2966 if option[-1:] == "_":
2967 option = option[:-1]
2968 return self.tk.call(self._w, "image", "cget", index, option)
2969 def image_configure(self, index, cnf=None, **kw):
2970 """Configure an embedded image at INDEX."""
2971 return self._configure(('image', 'configure', index), cnf, kw)
2972 def image_create(self, index, cnf={}, **kw):
2973 """Create an embedded image at INDEX."""
2974 return self.tk.call(
2975 self._w, "image", "create", index,
2976 *self._options(cnf, kw))
2977 def image_names(self):
2978 """Return all names of embedded images in this widget."""
2979 return self.tk.call(self._w, "image", "names")
2980 def index(self, index):
2981 """Return the index in the form line.char for INDEX."""
2982 return str(self.tk.call(self._w, 'index', index))
2983 def insert(self, index, chars, *args):
2984 """Insert CHARS before the characters at INDEX. An additional
2985 tag can be given in ARGS. Additional CHARS and tags can follow in ARGS."""
2986 self.tk.call((self._w, 'insert', index, chars) + args)
2987 def mark_gravity(self, markName, direction=None):
2988 """Change the gravity of a mark MARKNAME to DIRECTION (LEFT or RIGHT).
2989 Return the current value if None is given for DIRECTION."""
2990 return self.tk.call(
2991 (self._w, 'mark', 'gravity', markName, direction))
2992 def mark_names(self):
2993 """Return all mark names."""
2994 return self.tk.splitlist(self.tk.call(
2995 self._w, 'mark', 'names'))
2996 def mark_set(self, markName, index):
2997 """Set mark MARKNAME before the character at INDEX."""
2998 self.tk.call(self._w, 'mark', 'set', markName, index)
2999 def mark_unset(self, *markNames):
3000 """Delete all marks in MARKNAMES."""
3001 self.tk.call((self._w, 'mark', 'unset') + markNames)
3002 def mark_next(self, index):
3003 """Return the name of the next mark after INDEX."""
3004 return self.tk.call(self._w, 'mark', 'next', index) or None
3005 def mark_previous(self, index):
3006 """Return the name of the previous mark before INDEX."""
3007 return self.tk.call(self._w, 'mark', 'previous', index) or None
3008 def scan_mark(self, x, y):
3009 """Remember the current X, Y coordinates."""
3010 self.tk.call(self._w, 'scan', 'mark', x, y)
3011 def scan_dragto(self, x, y):
3012 """Adjust the view of the text to 10 times the
3013 difference between X and Y and the coordinates given in
3014 scan_mark."""
3015 self.tk.call(self._w, 'scan', 'dragto', x, y)
3016 def search(self, pattern, index, stopindex=None,
3017 forwards=None, backwards=None, exact=None,
3018 regexp=None, nocase=None, count=None, elide=None):
3019 """Search PATTERN beginning from INDEX until STOPINDEX.
3020 Return the index of the first character of a match or an
3021 empty string."""
3022 args = [self._w, 'search']
3023 if forwards: args.append('-forwards')
3024 if backwards: args.append('-backwards')
3025 if exact: args.append('-exact')
3026 if regexp: args.append('-regexp')
3027 if nocase: args.append('-nocase')
3028 if elide: args.append('-elide')
3029 if count: args.append('-count'); args.append(count)
3030 if pattern and pattern[0] == '-': args.append('--')
3031 args.append(pattern)
3032 args.append(index)
3033 if stopindex: args.append(stopindex)
3034 return str(self.tk.call(tuple(args)))
3035 def see(self, index):
3036 """Scroll such that the character at INDEX is visible."""
3037 self.tk.call(self._w, 'see', index)
3038 def tag_add(self, tagName, index1, *args):
3039 """Add tag TAGNAME to all characters between INDEX1 and index2 in ARGS.
3040 Additional pairs of indices may follow in ARGS."""
3041 self.tk.call(
3042 (self._w, 'tag', 'add', tagName, index1) + args)
3043 def tag_unbind(self, tagName, sequence, funcid=None):
3044 """Unbind for all characters with TAGNAME for event SEQUENCE the
3045 function identified with FUNCID."""
3046 self.tk.call(self._w, 'tag', 'bind', tagName, sequence, '')
3047 if funcid:
3048 self.deletecommand(funcid)
3049 def tag_bind(self, tagName, sequence, func, add=None):
3050 """Bind to all characters with TAGNAME at event SEQUENCE a call to function FUNC.
3052 An additional boolean parameter ADD specifies whether FUNC will be
3053 called additionally to the other bound function or whether it will
3054 replace the previous function. See bind for the return value."""
3055 return self._bind((self._w, 'tag', 'bind', tagName),
3056 sequence, func, add)
3057 def tag_cget(self, tagName, option):
3058 """Return the value of OPTION for tag TAGNAME."""
3059 if option[:1] != '-':
3060 option = '-' + option
3061 if option[-1:] == '_':
3062 option = option[:-1]
3063 return self.tk.call(self._w, 'tag', 'cget', tagName, option)
3064 def tag_configure(self, tagName, cnf=None, **kw):
3065 """Configure a tag TAGNAME."""
3066 return self._configure(('tag', 'configure', tagName), cnf, kw)
3067 tag_config = tag_configure
3068 def tag_delete(self, *tagNames):
3069 """Delete all tags in TAGNAMES."""
3070 self.tk.call((self._w, 'tag', 'delete') + tagNames)
3071 def tag_lower(self, tagName, belowThis=None):
3072 """Change the priority of tag TAGNAME such that it is lower
3073 than the priority of BELOWTHIS."""
3074 self.tk.call(self._w, 'tag', 'lower', tagName, belowThis)
3075 def tag_names(self, index=None):
3076 """Return a list of all tag names."""
3077 return self.tk.splitlist(
3078 self.tk.call(self._w, 'tag', 'names', index))
3079 def tag_nextrange(self, tagName, index1, index2=None):
3080 """Return a list of start and end index for the first sequence of
3081 characters between INDEX1 and INDEX2 which all have tag TAGNAME.
3082 The text is searched forward from INDEX1."""
3083 return self.tk.splitlist(self.tk.call(
3084 self._w, 'tag', 'nextrange', tagName, index1, index2))
3085 def tag_prevrange(self, tagName, index1, index2=None):
3086 """Return a list of start and end index for the first sequence of
3087 characters between INDEX1 and INDEX2 which all have tag TAGNAME.
3088 The text is searched backwards from INDEX1."""
3089 return self.tk.splitlist(self.tk.call(
3090 self._w, 'tag', 'prevrange', tagName, index1, index2))
3091 def tag_raise(self, tagName, aboveThis=None):
3092 """Change the priority of tag TAGNAME such that it is higher
3093 than the priority of ABOVETHIS."""
3094 self.tk.call(
3095 self._w, 'tag', 'raise', tagName, aboveThis)
3096 def tag_ranges(self, tagName):
3097 """Return a list of ranges of text which have tag TAGNAME."""
3098 return self.tk.splitlist(self.tk.call(
3099 self._w, 'tag', 'ranges', tagName))
3100 def tag_remove(self, tagName, index1, index2=None):
3101 """Remove tag TAGNAME from all characters between INDEX1 and INDEX2."""
3102 self.tk.call(
3103 self._w, 'tag', 'remove', tagName, index1, index2)
3104 def window_cget(self, index, option):
3105 """Return the value of OPTION of an embedded window at INDEX."""
3106 if option[:1] != '-':
3107 option = '-' + option
3108 if option[-1:] == '_':
3109 option = option[:-1]
3110 return self.tk.call(self._w, 'window', 'cget', index, option)
3111 def window_configure(self, index, cnf=None, **kw):
3112 """Configure an embedded window at INDEX."""
3113 return self._configure(('window', 'configure', index), cnf, kw)
3114 window_config = window_configure
3115 def window_create(self, index, cnf={}, **kw):
3116 """Create a window at INDEX."""
3117 self.tk.call(
3118 (self._w, 'window', 'create', index)
3119 + self._options(cnf, kw))
3120 def window_names(self):
3121 """Return all names of embedded windows in this widget."""
3122 return self.tk.splitlist(
3123 self.tk.call(self._w, 'window', 'names'))
3124 def yview_pickplace(self, *what):
3125 """Obsolete function, use see."""
3126 self.tk.call((self._w, 'yview', '-pickplace') + what)
3129 class _setit:
3130 """Internal class. It wraps the command in the widget OptionMenu."""
3131 def __init__(self, var, value, callback=None):
3132 self.__value = value
3133 self.__var = var
3134 self.__callback = callback
3135 def __call__(self, *args):
3136 self.__var.set(self.__value)
3137 if self.__callback:
3138 self.__callback(self.__value, *args)
3140 class OptionMenu(Menubutton):
3141 """OptionMenu which allows the user to select a value from a menu."""
3142 def __init__(self, master, variable, value, *values, **kwargs):
3143 """Construct an optionmenu widget with the parent MASTER, with
3144 the resource textvariable set to VARIABLE, the initially selected
3145 value VALUE, the other menu values VALUES and an additional
3146 keyword argument command."""
3147 kw = {"borderwidth": 2, "textvariable": variable,
3148 "indicatoron": 1, "relief": RAISED, "anchor": "c",
3149 "highlightthickness": 2}
3150 Widget.__init__(self, master, "menubutton", kw)
3151 self.widgetName = 'tk_optionMenu'
3152 menu = self.__menu = Menu(self, name="menu", tearoff=0)
3153 self.menuname = menu._w
3154 # 'command' is the only supported keyword
3155 callback = kwargs.get('command')
3156 if 'command' in kwargs:
3157 del kwargs['command']
3158 if kwargs:
3159 raise TclError, 'unknown option -'+kwargs.keys()[0]
3160 menu.add_command(label=value,
3161 command=_setit(variable, value, callback))
3162 for v in values:
3163 menu.add_command(label=v,
3164 command=_setit(variable, v, callback))
3165 self["menu"] = menu
3167 def __getitem__(self, name):
3168 if name == 'menu':
3169 return self.__menu
3170 return Widget.__getitem__(self, name)
3172 def destroy(self):
3173 """Destroy this widget and the associated menu."""
3174 Menubutton.destroy(self)
3175 self.__menu = None
3177 class Image:
3178 """Base class for images."""
3179 _last_id = 0
3180 def __init__(self, imgtype, name=None, cnf={}, master=None, **kw):
3181 self.name = None
3182 if not master:
3183 master = _default_root
3184 if not master:
3185 raise RuntimeError, 'Too early to create image'
3186 self.tk = master.tk
3187 if not name:
3188 Image._last_id += 1
3189 name = "pyimage%r" % (Image._last_id,) # tk itself would use image<x>
3190 # The following is needed for systems where id(x)
3191 # can return a negative number, such as Linux/m68k:
3192 if name[0] == '-': name = '_' + name[1:]
3193 if kw and cnf: cnf = _cnfmerge((cnf, kw))
3194 elif kw: cnf = kw
3195 options = ()
3196 for k, v in cnf.items():
3197 if hasattr(v, '__call__'):
3198 v = self._register(v)
3199 options = options + ('-'+k, v)
3200 self.tk.call(('image', 'create', imgtype, name,) + options)
3201 self.name = name
3202 def __str__(self): return self.name
3203 def __del__(self):
3204 if self.name:
3205 try:
3206 self.tk.call('image', 'delete', self.name)
3207 except TclError:
3208 # May happen if the root was destroyed
3209 pass
3210 def __setitem__(self, key, value):
3211 self.tk.call(self.name, 'configure', '-'+key, value)
3212 def __getitem__(self, key):
3213 return self.tk.call(self.name, 'configure', '-'+key)
3214 def configure(self, **kw):
3215 """Configure the image."""
3216 res = ()
3217 for k, v in _cnfmerge(kw).items():
3218 if v is not None:
3219 if k[-1] == '_': k = k[:-1]
3220 if hasattr(v, '__call__'):
3221 v = self._register(v)
3222 res = res + ('-'+k, v)
3223 self.tk.call((self.name, 'config') + res)
3224 config = configure
3225 def height(self):
3226 """Return the height of the image."""
3227 return getint(
3228 self.tk.call('image', 'height', self.name))
3229 def type(self):
3230 """Return the type of the imgage, e.g. "photo" or "bitmap"."""
3231 return self.tk.call('image', 'type', self.name)
3232 def width(self):
3233 """Return the width of the image."""
3234 return getint(
3235 self.tk.call('image', 'width', self.name))
3237 class PhotoImage(Image):
3238 """Widget which can display colored images in GIF, PPM/PGM format."""
3239 def __init__(self, name=None, cnf={}, master=None, **kw):
3240 """Create an image with NAME.
3242 Valid resource names: data, format, file, gamma, height, palette,
3243 width."""
3244 Image.__init__(self, 'photo', name, cnf, master, **kw)
3245 def blank(self):
3246 """Display a transparent image."""
3247 self.tk.call(self.name, 'blank')
3248 def cget(self, option):
3249 """Return the value of OPTION."""
3250 return self.tk.call(self.name, 'cget', '-' + option)
3251 # XXX config
3252 def __getitem__(self, key):
3253 return self.tk.call(self.name, 'cget', '-' + key)
3254 # XXX copy -from, -to, ...?
3255 def copy(self):
3256 """Return a new PhotoImage with the same image as this widget."""
3257 destImage = PhotoImage()
3258 self.tk.call(destImage, 'copy', self.name)
3259 return destImage
3260 def zoom(self,x,y=''):
3261 """Return a new PhotoImage with the same image as this widget
3262 but zoom it with X and Y."""
3263 destImage = PhotoImage()
3264 if y=='': y=x
3265 self.tk.call(destImage, 'copy', self.name, '-zoom',x,y)
3266 return destImage
3267 def subsample(self,x,y=''):
3268 """Return a new PhotoImage based on the same image as this widget
3269 but use only every Xth or Yth pixel."""
3270 destImage = PhotoImage()
3271 if y=='': y=x
3272 self.tk.call(destImage, 'copy', self.name, '-subsample',x,y)
3273 return destImage
3274 def get(self, x, y):
3275 """Return the color (red, green, blue) of the pixel at X,Y."""
3276 return self.tk.call(self.name, 'get', x, y)
3277 def put(self, data, to=None):
3278 """Put row formatted colors to image starting from
3279 position TO, e.g. image.put("{red green} {blue yellow}", to=(4,6))"""
3280 args = (self.name, 'put', data)
3281 if to:
3282 if to[0] == '-to':
3283 to = to[1:]
3284 args = args + ('-to',) + tuple(to)
3285 self.tk.call(args)
3286 # XXX read
3287 def write(self, filename, format=None, from_coords=None):
3288 """Write image to file FILENAME in FORMAT starting from
3289 position FROM_COORDS."""
3290 args = (self.name, 'write', filename)
3291 if format:
3292 args = args + ('-format', format)
3293 if from_coords:
3294 args = args + ('-from',) + tuple(from_coords)
3295 self.tk.call(args)
3297 class BitmapImage(Image):
3298 """Widget which can display a bitmap."""
3299 def __init__(self, name=None, cnf={}, master=None, **kw):
3300 """Create a bitmap with NAME.
3302 Valid resource names: background, data, file, foreground, maskdata, maskfile."""
3303 Image.__init__(self, 'bitmap', name, cnf, master, **kw)
3305 def image_names(): return _default_root.tk.call('image', 'names')
3306 def image_types(): return _default_root.tk.call('image', 'types')
3309 class Spinbox(Widget, XView):
3310 """spinbox widget."""
3311 def __init__(self, master=None, cnf={}, **kw):
3312 """Construct a spinbox widget with the parent MASTER.
3314 STANDARD OPTIONS
3316 activebackground, background, borderwidth,
3317 cursor, exportselection, font, foreground,
3318 highlightbackground, highlightcolor,
3319 highlightthickness, insertbackground,
3320 insertborderwidth, insertofftime,
3321 insertontime, insertwidth, justify, relief,
3322 repeatdelay, repeatinterval,
3323 selectbackground, selectborderwidth
3324 selectforeground, takefocus, textvariable
3325 xscrollcommand.
3327 WIDGET-SPECIFIC OPTIONS
3329 buttonbackground, buttoncursor,
3330 buttondownrelief, buttonuprelief,
3331 command, disabledbackground,
3332 disabledforeground, format, from,
3333 invalidcommand, increment,
3334 readonlybackground, state, to,
3335 validate, validatecommand values,
3336 width, wrap,
3338 Widget.__init__(self, master, 'spinbox', cnf, kw)
3340 def bbox(self, index):
3341 """Return a tuple of X1,Y1,X2,Y2 coordinates for a
3342 rectangle which encloses the character given by index.
3344 The first two elements of the list give the x and y
3345 coordinates of the upper-left corner of the screen
3346 area covered by the character (in pixels relative
3347 to the widget) and the last two elements give the
3348 width and height of the character, in pixels. The
3349 bounding box may refer to a region outside the
3350 visible area of the window.
3352 return self.tk.call(self._w, 'bbox', index)
3354 def delete(self, first, last=None):
3355 """Delete one or more elements of the spinbox.
3357 First is the index of the first character to delete,
3358 and last is the index of the character just after
3359 the last one to delete. If last isn't specified it
3360 defaults to first+1, i.e. a single character is
3361 deleted. This command returns an empty string.
3363 return self.tk.call(self._w, 'delete', first, last)
3365 def get(self):
3366 """Returns the spinbox's string"""
3367 return self.tk.call(self._w, 'get')
3369 def icursor(self, index):
3370 """Alter the position of the insertion cursor.
3372 The insertion cursor will be displayed just before
3373 the character given by index. Returns an empty string
3375 return self.tk.call(self._w, 'icursor', index)
3377 def identify(self, x, y):
3378 """Returns the name of the widget at position x, y
3380 Return value is one of: none, buttondown, buttonup, entry
3382 return self.tk.call(self._w, 'identify', x, y)
3384 def index(self, index):
3385 """Returns the numerical index corresponding to index
3387 return self.tk.call(self._w, 'index', index)
3389 def insert(self, index, s):
3390 """Insert string s at index
3392 Returns an empty string.
3394 return self.tk.call(self._w, 'insert', index, s)
3396 def invoke(self, element):
3397 """Causes the specified element to be invoked
3399 The element could be buttondown or buttonup
3400 triggering the action associated with it.
3402 return self.tk.call(self._w, 'invoke', element)
3404 def scan(self, *args):
3405 """Internal function."""
3406 return self._getints(
3407 self.tk.call((self._w, 'scan') + args)) or ()
3409 def scan_mark(self, x):
3410 """Records x and the current view in the spinbox window;
3412 used in conjunction with later scan dragto commands.
3413 Typically this command is associated with a mouse button
3414 press in the widget. It returns an empty string.
3416 return self.scan("mark", x)
3418 def scan_dragto(self, x):
3419 """Compute the difference between the given x argument
3420 and the x argument to the last scan mark command
3422 It then adjusts the view left or right by 10 times the
3423 difference in x-coordinates. This command is typically
3424 associated with mouse motion events in the widget, to
3425 produce the effect of dragging the spinbox at high speed
3426 through the window. The return value is an empty string.
3428 return self.scan("dragto", x)
3430 def selection(self, *args):
3431 """Internal function."""
3432 return self._getints(
3433 self.tk.call((self._w, 'selection') + args)) or ()
3435 def selection_adjust(self, index):
3436 """Locate the end of the selection nearest to the character
3437 given by index,
3439 Then adjust that end of the selection to be at index
3440 (i.e including but not going beyond index). The other
3441 end of the selection is made the anchor point for future
3442 select to commands. If the selection isn't currently in
3443 the spinbox, then a new selection is created to include
3444 the characters between index and the most recent selection
3445 anchor point, inclusive. Returns an empty string.
3447 return self.selection("adjust", index)
3449 def selection_clear(self):
3450 """Clear the selection
3452 If the selection isn't in this widget then the
3453 command has no effect. Returns an empty string.
3455 return self.selection("clear")
3457 def selection_element(self, element=None):
3458 """Sets or gets the currently selected element.
3460 If a spinbutton element is specified, it will be
3461 displayed depressed
3463 return self.selection("element", element)
3465 ###########################################################################
3467 class LabelFrame(Widget):
3468 """labelframe widget."""
3469 def __init__(self, master=None, cnf={}, **kw):
3470 """Construct a labelframe widget with the parent MASTER.
3472 STANDARD OPTIONS
3474 borderwidth, cursor, font, foreground,
3475 highlightbackground, highlightcolor,
3476 highlightthickness, padx, pady, relief,
3477 takefocus, text
3479 WIDGET-SPECIFIC OPTIONS
3481 background, class, colormap, container,
3482 height, labelanchor, labelwidget,
3483 visual, width
3485 Widget.__init__(self, master, 'labelframe', cnf, kw)
3487 ########################################################################
3489 class PanedWindow(Widget):
3490 """panedwindow widget."""
3491 def __init__(self, master=None, cnf={}, **kw):
3492 """Construct a panedwindow widget with the parent MASTER.
3494 STANDARD OPTIONS
3496 background, borderwidth, cursor, height,
3497 orient, relief, width
3499 WIDGET-SPECIFIC OPTIONS
3501 handlepad, handlesize, opaqueresize,
3502 sashcursor, sashpad, sashrelief,
3503 sashwidth, showhandle,
3505 Widget.__init__(self, master, 'panedwindow', cnf, kw)
3507 def add(self, child, **kw):
3508 """Add a child widget to the panedwindow in a new pane.
3510 The child argument is the name of the child widget
3511 followed by pairs of arguments that specify how to
3512 manage the windows. The possible options and values
3513 are the ones accepted by the paneconfigure method.
3515 self.tk.call((self._w, 'add', child) + self._options(kw))
3517 def remove(self, child):
3518 """Remove the pane containing child from the panedwindow
3520 All geometry management options for child will be forgotten.
3522 self.tk.call(self._w, 'forget', child)
3523 forget=remove
3525 def identify(self, x, y):
3526 """Identify the panedwindow component at point x, y
3528 If the point is over a sash or a sash handle, the result
3529 is a two element list containing the index of the sash or
3530 handle, and a word indicating whether it is over a sash
3531 or a handle, such as {0 sash} or {2 handle}. If the point
3532 is over any other part of the panedwindow, the result is
3533 an empty list.
3535 return self.tk.call(self._w, 'identify', x, y)
3537 def proxy(self, *args):
3538 """Internal function."""
3539 return self._getints(
3540 self.tk.call((self._w, 'proxy') + args)) or ()
3542 def proxy_coord(self):
3543 """Return the x and y pair of the most recent proxy location
3545 return self.proxy("coord")
3547 def proxy_forget(self):
3548 """Remove the proxy from the display.
3550 return self.proxy("forget")
3552 def proxy_place(self, x, y):
3553 """Place the proxy at the given x and y coordinates.
3555 return self.proxy("place", x, y)
3557 def sash(self, *args):
3558 """Internal function."""
3559 return self._getints(
3560 self.tk.call((self._w, 'sash') + args)) or ()
3562 def sash_coord(self, index):
3563 """Return the current x and y pair for the sash given by index.
3565 Index must be an integer between 0 and 1 less than the
3566 number of panes in the panedwindow. The coordinates given are
3567 those of the top left corner of the region containing the sash.
3568 pathName sash dragto index x y This command computes the
3569 difference between the given coordinates and the coordinates
3570 given to the last sash coord command for the given sash. It then
3571 moves that sash the computed difference. The return value is the
3572 empty string.
3574 return self.sash("coord", index)
3576 def sash_mark(self, index):
3577 """Records x and y for the sash given by index;
3579 Used in conjunction with later dragto commands to move the sash.
3581 return self.sash("mark", index)
3583 def sash_place(self, index, x, y):
3584 """Place the sash given by index at the given coordinates
3586 return self.sash("place", index, x, y)
3588 def panecget(self, child, option):
3589 """Query a management option for window.
3591 Option may be any value allowed by the paneconfigure subcommand
3593 return self.tk.call(
3594 (self._w, 'panecget') + (child, '-'+option))
3596 def paneconfigure(self, tagOrId, cnf=None, **kw):
3597 """Query or modify the management options for window.
3599 If no option is specified, returns a list describing all
3600 of the available options for pathName. If option is
3601 specified with no value, then the command returns a list
3602 describing the one named option (this list will be identical
3603 to the corresponding sublist of the value returned if no
3604 option is specified). If one or more option-value pairs are
3605 specified, then the command modifies the given widget
3606 option(s) to have the given value(s); in this case the
3607 command returns an empty string. The following options
3608 are supported:
3610 after window
3611 Insert the window after the window specified. window
3612 should be the name of a window already managed by pathName.
3613 before window
3614 Insert the window before the window specified. window
3615 should be the name of a window already managed by pathName.
3616 height size
3617 Specify a height for the window. The height will be the
3618 outer dimension of the window including its border, if
3619 any. If size is an empty string, or if -height is not
3620 specified, then the height requested internally by the
3621 window will be used initially; the height may later be
3622 adjusted by the movement of sashes in the panedwindow.
3623 Size may be any value accepted by Tk_GetPixels.
3624 minsize n
3625 Specifies that the size of the window cannot be made
3626 less than n. This constraint only affects the size of
3627 the widget in the paned dimension -- the x dimension
3628 for horizontal panedwindows, the y dimension for
3629 vertical panedwindows. May be any value accepted by
3630 Tk_GetPixels.
3631 padx n
3632 Specifies a non-negative value indicating how much
3633 extra space to leave on each side of the window in
3634 the X-direction. The value may have any of the forms
3635 accepted by Tk_GetPixels.
3636 pady n
3637 Specifies a non-negative value indicating how much
3638 extra space to leave on each side of the window in
3639 the Y-direction. The value may have any of the forms
3640 accepted by Tk_GetPixels.
3641 sticky style
3642 If a window's pane is larger than the requested
3643 dimensions of the window, this option may be used
3644 to position (or stretch) the window within its pane.
3645 Style is a string that contains zero or more of the
3646 characters n, s, e or w. The string can optionally
3647 contains spaces or commas, but they are ignored. Each
3648 letter refers to a side (north, south, east, or west)
3649 that the window will "stick" to. If both n and s
3650 (or e and w) are specified, the window will be
3651 stretched to fill the entire height (or width) of
3652 its cavity.
3653 width size
3654 Specify a width for the window. The width will be
3655 the outer dimension of the window including its
3656 border, if any. If size is an empty string, or
3657 if -width is not specified, then the width requested
3658 internally by the window will be used initially; the
3659 width may later be adjusted by the movement of sashes
3660 in the panedwindow. Size may be any value accepted by
3661 Tk_GetPixels.
3664 if cnf is None and not kw:
3665 cnf = {}
3666 for x in self.tk.split(
3667 self.tk.call(self._w,
3668 'paneconfigure', tagOrId)):
3669 cnf[x[0][1:]] = (x[0][1:],) + x[1:]
3670 return cnf
3671 if type(cnf) == StringType and not kw:
3672 x = self.tk.split(self.tk.call(
3673 self._w, 'paneconfigure', tagOrId, '-'+cnf))
3674 return (x[0][1:],) + x[1:]
3675 self.tk.call((self._w, 'paneconfigure', tagOrId) +
3676 self._options(cnf, kw))
3677 paneconfig = paneconfigure
3679 def panes(self):
3680 """Returns an ordered list of the child panes."""
3681 return self.tk.call(self._w, 'panes')
3683 ######################################################################
3684 # Extensions:
3686 class Studbutton(Button):
3687 def __init__(self, master=None, cnf={}, **kw):
3688 Widget.__init__(self, master, 'studbutton', cnf, kw)
3689 self.bind('<Any-Enter>', self.tkButtonEnter)
3690 self.bind('<Any-Leave>', self.tkButtonLeave)
3691 self.bind('<1>', self.tkButtonDown)
3692 self.bind('<ButtonRelease-1>', self.tkButtonUp)
3694 class Tributton(Button):
3695 def __init__(self, master=None, cnf={}, **kw):
3696 Widget.__init__(self, master, 'tributton', cnf, kw)
3697 self.bind('<Any-Enter>', self.tkButtonEnter)
3698 self.bind('<Any-Leave>', self.tkButtonLeave)
3699 self.bind('<1>', self.tkButtonDown)
3700 self.bind('<ButtonRelease-1>', self.tkButtonUp)
3701 self['fg'] = self['bg']
3702 self['activebackground'] = self['bg']
3704 ######################################################################
3705 # Test:
3707 def _test():
3708 root = Tk()
3709 text = "This is Tcl/Tk version %s" % TclVersion
3710 if TclVersion >= 8.1:
3711 try:
3712 text = text + unicode("\nThis should be a cedilla: \347",
3713 "iso-8859-1")
3714 except NameError:
3715 pass # no unicode support
3716 label = Label(root, text=text)
3717 label.pack()
3718 test = Button(root, text="Click me!",
3719 command=lambda root=root: root.test.configure(
3720 text="[%s]" % root.test['text']))
3721 test.pack()
3722 root.test = test
3723 quit = Button(root, text="QUIT", command=root.destroy)
3724 quit.pack()
3725 # The following three commands are needed so the window pops
3726 # up on top on Windows...
3727 root.iconify()
3728 root.update()
3729 root.deiconify()
3730 root.mainloop()
3732 if __name__ == '__main__':
3733 _test()