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