blob: 6f00397650d019f2441eb3067aabb74bd45b45de [file] [log] [blame]
Guido van Rossum5917ecb2000-06-29 16:30:50 +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,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00006Checkbutton, Scale, Listbox, Scrollbar, OptionMenu, Spinbox
Raymond Hettingerff41c482003-04-06 09:01:11 +00007LabelFrame and PanedWindow.
Martin v. Löwis2ec36272002-10-13 10:22:08 +00008
Raymond Hettingerff41c482003-04-06 09:01:11 +00009Properties of the widgets are specified with keyword arguments.
10Keyword arguments have the same name as the corresponding resource
Martin v. Löwis2ec36272002-10-13 10:22:08 +000011under Tk.
Guido van Rossum5917ecb2000-06-29 16:30:50 +000012
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
Guido van Rossuma0adb922001-09-01 18:29:55 +000017Actions are bound to events by resources (e.g. keyword argument
18command) or with the method bind.
Guido van Rossum5917ecb2000-06-29 16:30:50 +000019
20Example (Hello, World):
21import Tkinter
22from Tkconstants import *
23tk = Tkinter.Tk()
24frame = Tkinter.Frame(tk, relief=RIDGE, borderwidth=2)
25frame.pack(fill=BOTH,expand=1)
26label = Tkinter.Label(frame, text="Hello, World")
27label.pack(fill=X, expand=1)
28button = Tkinter.Button(frame,text="Exit",command=tk.destroy)
29button.pack(side=BOTTOM)
30tk.mainloop()
31"""
Guido van Rossum2dcf5291994-07-06 09:23:20 +000032
Guido van Rossum37dcab11996-05-16 16:00:19 +000033__version__ = "$Revision$"
34
Guido van Rossumf8d579c1999-01-04 18:06:45 +000035import sys
36if sys.platform == "win32":
Fredrik Lundh06d28152000-08-09 18:03:12 +000037 import FixTk # Attempt to configure Tcl/Tk without requiring PATH
Guido van Rossumf8d579c1999-01-04 18:06:45 +000038import _tkinter # If this fails your Python may not be configured for Tk
Guido van Rossum95806091997-02-15 18:33:24 +000039tkinter = _tkinter # b/w compat for export
40TclError = _tkinter.TclError
Guido van Rossum7e9394a1995-03-17 16:21:33 +000041from types import *
Guido van Rossuma5773dd1995-09-07 19:22:00 +000042from Tkconstants import *
Guido van Rossumf0c891a1998-04-29 21:43:36 +000043try:
Fredrik Lundh06d28152000-08-09 18:03:12 +000044 import MacOS; _MacOS = MacOS; del MacOS
Guido van Rossumf0c891a1998-04-29 21:43:36 +000045except ImportError:
Fredrik Lundh06d28152000-08-09 18:03:12 +000046 _MacOS = None
Guido van Rossum18468821994-06-20 07:49:28 +000047
Martin v. Löwis8c8aa5d2002-11-26 21:39:48 +000048wantobjects = 1
Martin v. Löwisffad6332002-11-26 09:28:05 +000049
Eric S. Raymondfc170b12001-02-09 11:51:27 +000050TkVersion = float(_tkinter.TK_VERSION)
51TclVersion = float(_tkinter.TCL_VERSION)
Guido van Rossum18468821994-06-20 07:49:28 +000052
Guido van Rossumd6615ab1997-08-05 02:35:01 +000053READABLE = _tkinter.READABLE
54WRITABLE = _tkinter.WRITABLE
55EXCEPTION = _tkinter.EXCEPTION
Guido van Rossumf53c86c1997-08-14 14:15:54 +000056
57# These are not always defined, e.g. not on Win32 with Tk 8.0 :-(
58try: _tkinter.createfilehandler
59except AttributeError: _tkinter.createfilehandler = None
60try: _tkinter.deletefilehandler
61except AttributeError: _tkinter.deletefilehandler = None
Fredrik Lundh06d28152000-08-09 18:03:12 +000062
63
Guido van Rossum2dcf5291994-07-06 09:23:20 +000064def _flatten(tuple):
Fredrik Lundh06d28152000-08-09 18:03:12 +000065 """Internal function."""
66 res = ()
67 for item in tuple:
68 if type(item) in (TupleType, ListType):
69 res = res + _flatten(item)
70 elif item is not None:
71 res = res + (item,)
72 return res
Guido van Rossum2dcf5291994-07-06 09:23:20 +000073
Andrew M. Kuchlinge475e702000-06-18 18:45:50 +000074try: _flatten = _tkinter._flatten
75except AttributeError: pass
76
Guido van Rossum2dcf5291994-07-06 09:23:20 +000077def _cnfmerge(cnfs):
Fredrik Lundh06d28152000-08-09 18:03:12 +000078 """Internal function."""
79 if type(cnfs) is DictionaryType:
80 return cnfs
81 elif type(cnfs) in (NoneType, StringType):
82 return cnfs
83 else:
84 cnf = {}
85 for c in _flatten(cnfs):
86 try:
87 cnf.update(c)
88 except (AttributeError, TypeError), msg:
89 print "_cnfmerge: fallback due to:", msg
90 for k, v in c.items():
91 cnf[k] = v
92 return cnf
Guido van Rossum2dcf5291994-07-06 09:23:20 +000093
Andrew M. Kuchlinge475e702000-06-18 18:45:50 +000094try: _cnfmerge = _tkinter._cnfmerge
95except AttributeError: pass
96
Guido van Rossum2dcf5291994-07-06 09:23:20 +000097class Event:
Fredrik Lundh06d28152000-08-09 18:03:12 +000098 """Container for the properties of an event.
Guido van Rossum5917ecb2000-06-29 16:30:50 +000099
Fredrik Lundh06d28152000-08-09 18:03:12 +0000100 Instances of this type are generated if one of the following events occurs:
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000101
Fredrik Lundh06d28152000-08-09 18:03:12 +0000102 KeyPress, KeyRelease - for keyboard events
103 ButtonPress, ButtonRelease, Motion, Enter, Leave, MouseWheel - for mouse events
104 Visibility, Unmap, Map, Expose, FocusIn, FocusOut, Circulate,
105 Colormap, Gravity, Reparent, Property, Destroy, Activate,
106 Deactivate - for window events.
107
108 If a callback function for one of these events is registered
109 using bind, bind_all, bind_class, or tag_bind, the callback is
110 called with an Event as first argument. It will have the
111 following attributes (in braces are the event types for which
112 the attribute is valid):
113
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000114 serial - serial number of event
Fredrik Lundh06d28152000-08-09 18:03:12 +0000115 num - mouse button pressed (ButtonPress, ButtonRelease)
116 focus - whether the window has the focus (Enter, Leave)
117 height - height of the exposed window (Configure, Expose)
118 width - width of the exposed window (Configure, Expose)
119 keycode - keycode of the pressed key (KeyPress, KeyRelease)
120 state - state of the event as a number (ButtonPress, ButtonRelease,
121 Enter, KeyPress, KeyRelease,
122 Leave, Motion)
123 state - state as a string (Visibility)
124 time - when the event occurred
125 x - x-position of the mouse
126 y - y-position of the mouse
127 x_root - x-position of the mouse on the screen
128 (ButtonPress, ButtonRelease, KeyPress, KeyRelease, Motion)
129 y_root - y-position of the mouse on the screen
130 (ButtonPress, ButtonRelease, KeyPress, KeyRelease, Motion)
131 char - pressed character (KeyPress, KeyRelease)
132 send_event - see X/Windows documentation
Walter Dörwald966c2642005-11-09 17:12:43 +0000133 keysym - keysym of the event as a string (KeyPress, KeyRelease)
Fredrik Lundh06d28152000-08-09 18:03:12 +0000134 keysym_num - keysym of the event as a number (KeyPress, KeyRelease)
135 type - type of the event as a number
136 widget - widget in which the event occurred
137 delta - delta of wheel movement (MouseWheel)
138 """
139 pass
Guido van Rossum2dcf5291994-07-06 09:23:20 +0000140
Guido van Rossumc4570481998-03-20 20:45:49 +0000141_support_default_root = 1
Guido van Rossumaec5dc91994-06-27 07:55:12 +0000142_default_root = None
143
Guido van Rossumc4570481998-03-20 20:45:49 +0000144def NoDefaultRoot():
Fredrik Lundh06d28152000-08-09 18:03:12 +0000145 """Inhibit setting of default root window.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000146
Fredrik Lundh06d28152000-08-09 18:03:12 +0000147 Call this function to inhibit that the first instance of
148 Tk is used for windows without an explicit parent window.
149 """
150 global _support_default_root
151 _support_default_root = 0
152 global _default_root
153 _default_root = None
154 del _default_root
Guido van Rossumc4570481998-03-20 20:45:49 +0000155
Guido van Rossum45853db1994-06-20 12:19:19 +0000156def _tkerror(err):
Fredrik Lundh06d28152000-08-09 18:03:12 +0000157 """Internal function."""
158 pass
Guido van Rossum18468821994-06-20 07:49:28 +0000159
Guido van Rossum97aeca11994-07-07 13:12:12 +0000160def _exit(code='0'):
Fredrik Lundh06d28152000-08-09 18:03:12 +0000161 """Internal function. Calling it will throw the exception SystemExit."""
162 raise SystemExit, code
Guido van Rossum97aeca11994-07-07 13:12:12 +0000163
Guido van Rossumaec5dc91994-06-27 07:55:12 +0000164_varnum = 0
165class Variable:
Guido van Rossum2cd0a652003-04-16 20:10:03 +0000166 """Class to define value holders for e.g. buttons.
167
168 Subclasses StringVar, IntVar, DoubleVar, BooleanVar are specializations
169 that constrain the type of the value returned from get()."""
Fredrik Lundh06d28152000-08-09 18:03:12 +0000170 _default = ""
Martin v. Löwis337487e2006-06-17 09:15:14 +0000171 def __init__(self, master=None, value=None, name=None):
172 """Construct a variable
Tim Peters43bc3782006-06-19 07:45:16 +0000173
Martin v. Löwis337487e2006-06-17 09:15:14 +0000174 MASTER can be given as master widget.
175 VALUE is an optional value (defaults to "")
176 NAME is an optional Tcl name (defaults to PY_VARnum).
Tim Peters43bc3782006-06-19 07:45:16 +0000177
Martin v. Löwis337487e2006-06-17 09:15:14 +0000178 If NAME matches an existing variable and VALUE is omitted
179 then the existing value is retained.
Fredrik Lundh06d28152000-08-09 18:03:12 +0000180 """
181 global _varnum
182 if not master:
183 master = _default_root
184 self._master = master
185 self._tk = master.tk
Martin v. Löwis337487e2006-06-17 09:15:14 +0000186 if name:
187 self._name = name
188 else:
Martin v. Löwis426f4a12006-07-18 17:46:31 +0000189 self._name = 'PY_VAR' + repr(_varnum)
Martin v. Löwis337487e2006-06-17 09:15:14 +0000190 _varnum += 1
191 if value != None:
192 self.set(value)
193 elif not self._tk.call("info", "exists", self._name):
194 self.set(self._default)
Fredrik Lundh06d28152000-08-09 18:03:12 +0000195 def __del__(self):
196 """Unset the variable in Tcl."""
197 self._tk.globalunsetvar(self._name)
198 def __str__(self):
199 """Return the name of the variable in Tcl."""
200 return self._name
201 def set(self, value):
202 """Set the variable to VALUE."""
203 return self._tk.globalsetvar(self._name, value)
Guido van Rossum2cd0a652003-04-16 20:10:03 +0000204 def get(self):
205 """Return value of variable."""
206 return self._tk.globalgetvar(self._name)
Fredrik Lundh06d28152000-08-09 18:03:12 +0000207 def trace_variable(self, mode, callback):
208 """Define a trace callback for the variable.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000209
Fredrik Lundh06d28152000-08-09 18:03:12 +0000210 MODE is one of "r", "w", "u" for read, write, undefine.
211 CALLBACK must be a function which is called when
212 the variable is read, written or undefined.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000213
Fredrik Lundh06d28152000-08-09 18:03:12 +0000214 Return the name of the callback.
215 """
216 cbname = self._master._register(callback)
217 self._tk.call("trace", "variable", self._name, mode, cbname)
218 return cbname
219 trace = trace_variable
220 def trace_vdelete(self, mode, cbname):
221 """Delete the trace callback for a variable.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000222
Fredrik Lundh06d28152000-08-09 18:03:12 +0000223 MODE is one of "r", "w", "u" for read, write, undefine.
224 CBNAME is the name of the callback returned from trace_variable or trace.
225 """
226 self._tk.call("trace", "vdelete", self._name, mode, cbname)
227 self._master.deletecommand(cbname)
228 def trace_vinfo(self):
229 """Return all trace callback information."""
230 return map(self._tk.split, self._tk.splitlist(
231 self._tk.call("trace", "vinfo", self._name)))
Martin v. Löwis337487e2006-06-17 09:15:14 +0000232 def __eq__(self, other):
233 """Comparison for equality (==).
Tim Peters43bc3782006-06-19 07:45:16 +0000234
Martin v. Löwis337487e2006-06-17 09:15:14 +0000235 Note: if the Variable's master matters to behavior
236 also compare self._master == other._master
237 """
238 return self.__class__.__name__ == other.__class__.__name__ \
239 and self._name == other._name
Guido van Rossumaec5dc91994-06-27 07:55:12 +0000240
241class StringVar(Variable):
Fredrik Lundh06d28152000-08-09 18:03:12 +0000242 """Value holder for strings variables."""
243 _default = ""
Martin v. Löwis337487e2006-06-17 09:15:14 +0000244 def __init__(self, master=None, value=None, name=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +0000245 """Construct a string variable.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000246
Martin v. Löwis337487e2006-06-17 09:15:14 +0000247 MASTER can be given as master widget.
248 VALUE is an optional value (defaults to "")
249 NAME is an optional Tcl name (defaults to PY_VARnum).
Tim Peters43bc3782006-06-19 07:45:16 +0000250
Martin v. Löwis337487e2006-06-17 09:15:14 +0000251 If NAME matches an existing variable and VALUE is omitted
252 then the existing value is retained.
253 """
254 Variable.__init__(self, master, value, name)
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000255
Fredrik Lundh06d28152000-08-09 18:03:12 +0000256 def get(self):
257 """Return value of variable as string."""
Martin v. Löwisbfe175c2003-04-16 19:42:51 +0000258 value = self._tk.globalgetvar(self._name)
259 if isinstance(value, basestring):
260 return value
261 return str(value)
Guido van Rossumaec5dc91994-06-27 07:55:12 +0000262
263class IntVar(Variable):
Fredrik Lundh06d28152000-08-09 18:03:12 +0000264 """Value holder for integer variables."""
265 _default = 0
Martin v. Löwis337487e2006-06-17 09:15:14 +0000266 def __init__(self, master=None, value=None, name=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +0000267 """Construct an integer variable.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000268
Martin v. Löwis337487e2006-06-17 09:15:14 +0000269 MASTER can be given as master widget.
270 VALUE is an optional value (defaults to 0)
271 NAME is an optional Tcl name (defaults to PY_VARnum).
Tim Peters43bc3782006-06-19 07:45:16 +0000272
Martin v. Löwis337487e2006-06-17 09:15:14 +0000273 If NAME matches an existing variable and VALUE is omitted
274 then the existing value is retained.
275 """
276 Variable.__init__(self, master, value, name)
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000277
Martin v. Löwis70c3dda2003-01-22 09:17:38 +0000278 def set(self, value):
279 """Set the variable to value, converting booleans to integers."""
280 if isinstance(value, bool):
281 value = int(value)
282 return Variable.set(self, value)
283
Fredrik Lundh06d28152000-08-09 18:03:12 +0000284 def get(self):
285 """Return the value of the variable as an integer."""
286 return getint(self._tk.globalgetvar(self._name))
Guido van Rossumaec5dc91994-06-27 07:55:12 +0000287
288class DoubleVar(Variable):
Fredrik Lundh06d28152000-08-09 18:03:12 +0000289 """Value holder for float variables."""
290 _default = 0.0
Martin v. Löwis337487e2006-06-17 09:15:14 +0000291 def __init__(self, master=None, value=None, name=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +0000292 """Construct a float variable.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000293
Martin v. Löwis337487e2006-06-17 09:15:14 +0000294 MASTER can be given as master widget.
295 VALUE is an optional value (defaults to 0.0)
296 NAME is an optional Tcl name (defaults to PY_VARnum).
Tim Peters43bc3782006-06-19 07:45:16 +0000297
Martin v. Löwis337487e2006-06-17 09:15:14 +0000298 If NAME matches an existing variable and VALUE is omitted
299 then the existing value is retained.
300 """
301 Variable.__init__(self, master, value, name)
Fredrik Lundh06d28152000-08-09 18:03:12 +0000302
303 def get(self):
304 """Return the value of the variable as a float."""
305 return getdouble(self._tk.globalgetvar(self._name))
Guido van Rossumaec5dc91994-06-27 07:55:12 +0000306
307class BooleanVar(Variable):
Fredrik Lundh06d28152000-08-09 18:03:12 +0000308 """Value holder for boolean variables."""
Martin v. Löwis337487e2006-06-17 09:15:14 +0000309 _default = False
310 def __init__(self, master=None, value=None, name=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +0000311 """Construct a boolean variable.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000312
Martin v. Löwis337487e2006-06-17 09:15:14 +0000313 MASTER can be given as master widget.
314 VALUE is an optional value (defaults to False)
315 NAME is an optional Tcl name (defaults to PY_VARnum).
Tim Peters43bc3782006-06-19 07:45:16 +0000316
Martin v. Löwis337487e2006-06-17 09:15:14 +0000317 If NAME matches an existing variable and VALUE is omitted
318 then the existing value is retained.
319 """
320 Variable.__init__(self, master, value, name)
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000321
Fredrik Lundh06d28152000-08-09 18:03:12 +0000322 def get(self):
Martin v. Löwisbfe175c2003-04-16 19:42:51 +0000323 """Return the value of the variable as a bool."""
Fredrik Lundh06d28152000-08-09 18:03:12 +0000324 return self._tk.getboolean(self._tk.globalgetvar(self._name))
Guido van Rossumaec5dc91994-06-27 07:55:12 +0000325
Guido van Rossum35f67fb1995-08-04 03:50:29 +0000326def mainloop(n=0):
Fredrik Lundh06d28152000-08-09 18:03:12 +0000327 """Run the main loop of Tcl."""
328 _default_root.tk.mainloop(n)
Guido van Rossum2dcf5291994-07-06 09:23:20 +0000329
Guido van Rossum0132f691998-04-30 17:50:36 +0000330getint = int
Guido van Rossum2dcf5291994-07-06 09:23:20 +0000331
Guido van Rossum0132f691998-04-30 17:50:36 +0000332getdouble = float
Guido van Rossum2dcf5291994-07-06 09:23:20 +0000333
334def getboolean(s):
Fredrik Lundh06d28152000-08-09 18:03:12 +0000335 """Convert true and false to integer values 1 and 0."""
336 return _default_root.tk.getboolean(s)
Guido van Rossum2dcf5291994-07-06 09:23:20 +0000337
Guido van Rossum368e06b1997-11-07 20:38:49 +0000338# Methods defined on both toplevel and interior widgets
Guido van Rossum18468821994-06-20 07:49:28 +0000339class Misc:
Fredrik Lundh06d28152000-08-09 18:03:12 +0000340 """Internal class.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000341
Fredrik Lundh06d28152000-08-09 18:03:12 +0000342 Base class which defines methods common for interior widgets."""
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000343
Fredrik Lundh06d28152000-08-09 18:03:12 +0000344 # XXX font command?
345 _tclCommands = None
346 def destroy(self):
347 """Internal function.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000348
Fredrik Lundh06d28152000-08-09 18:03:12 +0000349 Delete all Tcl commands created for
350 this widget in the Tcl interpreter."""
351 if self._tclCommands is not None:
352 for name in self._tclCommands:
353 #print '- Tkinter: deleted command', name
354 self.tk.deletecommand(name)
355 self._tclCommands = None
356 def deletecommand(self, name):
357 """Internal function.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000358
Fredrik Lundh06d28152000-08-09 18:03:12 +0000359 Delete the Tcl command provided in NAME."""
360 #print '- Tkinter: deleted command', name
361 self.tk.deletecommand(name)
362 try:
363 self._tclCommands.remove(name)
364 except ValueError:
365 pass
366 def tk_strictMotif(self, boolean=None):
367 """Set Tcl internal variable, whether the look and feel
368 should adhere to Motif.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000369
Fredrik Lundh06d28152000-08-09 18:03:12 +0000370 A parameter of 1 means adhere to Motif (e.g. no color
371 change if mouse passes over slider).
372 Returns the set value."""
373 return self.tk.getboolean(self.tk.call(
374 'set', 'tk_strictMotif', boolean))
375 def tk_bisque(self):
376 """Change the color scheme to light brown as used in Tk 3.6 and before."""
377 self.tk.call('tk_bisque')
378 def tk_setPalette(self, *args, **kw):
379 """Set a new color scheme for all widget elements.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000380
Fredrik Lundh06d28152000-08-09 18:03:12 +0000381 A single color as argument will cause that all colors of Tk
382 widget elements are derived from this.
383 Alternatively several keyword parameters and its associated
384 colors can be given. The following keywords are valid:
385 activeBackground, foreground, selectColor,
386 activeForeground, highlightBackground, selectBackground,
387 background, highlightColor, selectForeground,
388 disabledForeground, insertBackground, troughColor."""
389 self.tk.call(('tk_setPalette',)
390 + _flatten(args) + _flatten(kw.items()))
391 def tk_menuBar(self, *args):
392 """Do not use. Needed in Tk 3.6 and earlier."""
393 pass # obsolete since Tk 4.0
394 def wait_variable(self, name='PY_VAR'):
395 """Wait until the variable is modified.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000396
Fredrik Lundh06d28152000-08-09 18:03:12 +0000397 A parameter of type IntVar, StringVar, DoubleVar or
398 BooleanVar must be given."""
399 self.tk.call('tkwait', 'variable', name)
400 waitvar = wait_variable # XXX b/w compat
401 def wait_window(self, window=None):
402 """Wait until a WIDGET is destroyed.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000403
Fredrik Lundh06d28152000-08-09 18:03:12 +0000404 If no parameter is given self is used."""
Fred Drake132dce22000-12-12 23:11:42 +0000405 if window is None:
Fredrik Lundh06d28152000-08-09 18:03:12 +0000406 window = self
407 self.tk.call('tkwait', 'window', window._w)
408 def wait_visibility(self, window=None):
409 """Wait until the visibility of a WIDGET changes
410 (e.g. it appears).
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000411
Fredrik Lundh06d28152000-08-09 18:03:12 +0000412 If no parameter is given self is used."""
Fred Drake132dce22000-12-12 23:11:42 +0000413 if window is None:
Fredrik Lundh06d28152000-08-09 18:03:12 +0000414 window = self
415 self.tk.call('tkwait', 'visibility', window._w)
416 def setvar(self, name='PY_VAR', value='1'):
417 """Set Tcl variable NAME to VALUE."""
418 self.tk.setvar(name, value)
419 def getvar(self, name='PY_VAR'):
420 """Return value of Tcl variable NAME."""
421 return self.tk.getvar(name)
422 getint = int
423 getdouble = float
424 def getboolean(self, s):
Neal Norwitz6e5be222003-04-17 13:13:55 +0000425 """Return a boolean value for Tcl boolean values true and false given as parameter."""
Fredrik Lundh06d28152000-08-09 18:03:12 +0000426 return self.tk.getboolean(s)
427 def focus_set(self):
428 """Direct input focus to this widget.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000429
Fredrik Lundh06d28152000-08-09 18:03:12 +0000430 If the application currently does not have the focus
431 this widget will get the focus if the application gets
432 the focus through the window manager."""
433 self.tk.call('focus', self._w)
434 focus = focus_set # XXX b/w compat?
435 def focus_force(self):
436 """Direct input focus to this widget even if the
437 application does not have the focus. Use with
438 caution!"""
439 self.tk.call('focus', '-force', self._w)
440 def focus_get(self):
441 """Return the widget which has currently the focus in the
442 application.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000443
Fredrik Lundh06d28152000-08-09 18:03:12 +0000444 Use focus_displayof to allow working with several
445 displays. Return None if application does not have
446 the focus."""
447 name = self.tk.call('focus')
448 if name == 'none' or not name: return None
449 return self._nametowidget(name)
450 def focus_displayof(self):
451 """Return the widget which has currently the focus on the
452 display where this widget is located.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000453
Fredrik Lundh06d28152000-08-09 18:03:12 +0000454 Return None if the application does not have the focus."""
455 name = self.tk.call('focus', '-displayof', self._w)
456 if name == 'none' or not name: return None
457 return self._nametowidget(name)
458 def focus_lastfor(self):
459 """Return the widget which would have the focus if top level
460 for this widget gets the focus from the window manager."""
461 name = self.tk.call('focus', '-lastfor', self._w)
462 if name == 'none' or not name: return None
463 return self._nametowidget(name)
464 def tk_focusFollowsMouse(self):
465 """The widget under mouse will get automatically focus. Can not
466 be disabled easily."""
467 self.tk.call('tk_focusFollowsMouse')
468 def tk_focusNext(self):
469 """Return the next widget in the focus order which follows
470 widget which has currently the focus.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000471
Fredrik Lundh06d28152000-08-09 18:03:12 +0000472 The focus order first goes to the next child, then to
473 the children of the child recursively and then to the
474 next sibling which is higher in the stacking order. A
475 widget is omitted if it has the takefocus resource set
476 to 0."""
477 name = self.tk.call('tk_focusNext', self._w)
478 if not name: return None
479 return self._nametowidget(name)
480 def tk_focusPrev(self):
481 """Return previous widget in the focus order. See tk_focusNext for details."""
482 name = self.tk.call('tk_focusPrev', self._w)
483 if not name: return None
484 return self._nametowidget(name)
485 def after(self, ms, func=None, *args):
486 """Call function once after given time.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000487
Fredrik Lundh06d28152000-08-09 18:03:12 +0000488 MS specifies the time in milliseconds. FUNC gives the
489 function which shall be called. Additional parameters
490 are given as parameters to the function call. Return
491 identifier to cancel scheduling with after_cancel."""
492 if not func:
493 # I'd rather use time.sleep(ms*0.001)
494 self.tk.call('after', ms)
495 else:
Georg Brandl4696ffb2006-04-02 21:09:51 +0000496 def callit():
Fredrik Lundh06d28152000-08-09 18:03:12 +0000497 try:
Raymond Hettingerff41c482003-04-06 09:01:11 +0000498 func(*args)
Fredrik Lundh06d28152000-08-09 18:03:12 +0000499 finally:
500 try:
Georg Brandl4696ffb2006-04-02 21:09:51 +0000501 self.deletecommand(name)
Fredrik Lundh06d28152000-08-09 18:03:12 +0000502 except TclError:
503 pass
504 name = self._register(callit)
Fredrik Lundh06d28152000-08-09 18:03:12 +0000505 return self.tk.call('after', ms, name)
506 def after_idle(self, func, *args):
507 """Call FUNC once if the Tcl main loop has no event to
508 process.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000509
Fredrik Lundh06d28152000-08-09 18:03:12 +0000510 Return an identifier to cancel the scheduling with
511 after_cancel."""
Raymond Hettingerff41c482003-04-06 09:01:11 +0000512 return self.after('idle', func, *args)
Fredrik Lundh06d28152000-08-09 18:03:12 +0000513 def after_cancel(self, id):
514 """Cancel scheduling of function identified with ID.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000515
Fredrik Lundh06d28152000-08-09 18:03:12 +0000516 Identifier returned by after or after_idle must be
517 given as first parameter."""
Martin v. Löwis0f9e5252003-06-07 19:52:38 +0000518 try:
Neal Norwitz3c0f2c92003-07-01 21:12:47 +0000519 data = self.tk.call('after', 'info', id)
520 # In Tk 8.3, splitlist returns: (script, type)
521 # In Tk 8.4, splitlist may return (script, type) or (script,)
522 script = self.tk.splitlist(data)[0]
Martin v. Löwis0f9e5252003-06-07 19:52:38 +0000523 self.deletecommand(script)
524 except TclError:
525 pass
Fredrik Lundh06d28152000-08-09 18:03:12 +0000526 self.tk.call('after', 'cancel', id)
527 def bell(self, displayof=0):
528 """Ring a display's bell."""
529 self.tk.call(('bell',) + self._displayof(displayof))
Tim Petersaa220a72006-04-16 22:22:36 +0000530
Fredrik Lundh06d28152000-08-09 18:03:12 +0000531 # Clipboard handling:
Martin v. Löwis0db2a982006-04-16 20:55:38 +0000532 def clipboard_get(self, **kw):
533 """Retrieve data from the clipboard on window's display.
Tim Petersaa220a72006-04-16 22:22:36 +0000534
535 The window keyword defaults to the root window of the Tkinter
Martin v. Löwis0db2a982006-04-16 20:55:38 +0000536 application.
Tim Petersaa220a72006-04-16 22:22:36 +0000537
538 The type keyword specifies the form in which the data is
539 to be returned and should be an atom name such as STRING
540 or FILE_NAME. Type defaults to STRING.
541
Martin v. Löwis0db2a982006-04-16 20:55:38 +0000542 This command is equivalent to:
Tim Petersaa220a72006-04-16 22:22:36 +0000543
Martin v. Löwis0db2a982006-04-16 20:55:38 +0000544 selection_get(CLIPBOARD)
545 """
546 return self.tk.call(('clipboard', 'get') + self._options(kw))
Tim Petersaa220a72006-04-16 22:22:36 +0000547
Fredrik Lundh06d28152000-08-09 18:03:12 +0000548 def clipboard_clear(self, **kw):
549 """Clear the data in the Tk clipboard.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000550
Fredrik Lundh06d28152000-08-09 18:03:12 +0000551 A widget specified for the optional displayof keyword
552 argument specifies the target display."""
553 if not kw.has_key('displayof'): kw['displayof'] = self._w
554 self.tk.call(('clipboard', 'clear') + self._options(kw))
555 def clipboard_append(self, string, **kw):
556 """Append STRING to the Tk clipboard.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000557
Fredrik Lundh06d28152000-08-09 18:03:12 +0000558 A widget specified at the optional displayof keyword
559 argument specifies the target display. The clipboard
560 can be retrieved with selection_get."""
561 if not kw.has_key('displayof'): kw['displayof'] = self._w
562 self.tk.call(('clipboard', 'append') + self._options(kw)
563 + ('--', string))
564 # XXX grab current w/o window argument
565 def grab_current(self):
566 """Return widget which has currently the grab in this application
567 or None."""
568 name = self.tk.call('grab', 'current', self._w)
569 if not name: return None
570 return self._nametowidget(name)
571 def grab_release(self):
572 """Release grab for this widget if currently set."""
573 self.tk.call('grab', 'release', self._w)
574 def grab_set(self):
575 """Set grab for this widget.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000576
Fredrik Lundh06d28152000-08-09 18:03:12 +0000577 A grab directs all events to this and descendant
578 widgets in the application."""
579 self.tk.call('grab', 'set', self._w)
580 def grab_set_global(self):
581 """Set global grab for this widget.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000582
Fredrik Lundh06d28152000-08-09 18:03:12 +0000583 A global grab directs all events to this and
584 descendant widgets on the display. Use with caution -
585 other applications do not get events anymore."""
586 self.tk.call('grab', 'set', '-global', self._w)
587 def grab_status(self):
588 """Return None, "local" or "global" if this widget has
589 no, a local or a global grab."""
590 status = self.tk.call('grab', 'status', self._w)
591 if status == 'none': status = None
592 return status
593 def lower(self, belowThis=None):
594 """Lower this widget in the stacking order."""
595 self.tk.call('lower', self._w, belowThis)
596 def option_add(self, pattern, value, priority = None):
597 """Set a VALUE (second parameter) for an option
598 PATTERN (first parameter).
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000599
Fredrik Lundh06d28152000-08-09 18:03:12 +0000600 An optional third parameter gives the numeric priority
601 (defaults to 80)."""
602 self.tk.call('option', 'add', pattern, value, priority)
603 def option_clear(self):
604 """Clear the option database.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000605
Fredrik Lundh06d28152000-08-09 18:03:12 +0000606 It will be reloaded if option_add is called."""
607 self.tk.call('option', 'clear')
608 def option_get(self, name, className):
609 """Return the value for an option NAME for this widget
610 with CLASSNAME.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000611
Fredrik Lundh06d28152000-08-09 18:03:12 +0000612 Values with higher priority override lower values."""
613 return self.tk.call('option', 'get', self._w, name, className)
614 def option_readfile(self, fileName, priority = None):
615 """Read file FILENAME into the option database.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000616
Fredrik Lundh06d28152000-08-09 18:03:12 +0000617 An optional second parameter gives the numeric
618 priority."""
619 self.tk.call('option', 'readfile', fileName, priority)
620 def selection_clear(self, **kw):
621 """Clear the current X selection."""
622 if not kw.has_key('displayof'): kw['displayof'] = self._w
623 self.tk.call(('selection', 'clear') + self._options(kw))
624 def selection_get(self, **kw):
625 """Return the contents of the current X selection.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000626
Fredrik Lundh06d28152000-08-09 18:03:12 +0000627 A keyword parameter selection specifies the name of
628 the selection and defaults to PRIMARY. A keyword
629 parameter displayof specifies a widget on the display
630 to use."""
631 if not kw.has_key('displayof'): kw['displayof'] = self._w
632 return self.tk.call(('selection', 'get') + self._options(kw))
633 def selection_handle(self, command, **kw):
634 """Specify a function COMMAND to call if the X
635 selection owned by this widget is queried by another
636 application.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000637
Fredrik Lundh06d28152000-08-09 18:03:12 +0000638 This function must return the contents of the
639 selection. The function will be called with the
640 arguments OFFSET and LENGTH which allows the chunking
641 of very long selections. The following keyword
642 parameters can be provided:
643 selection - name of the selection (default PRIMARY),
644 type - type of the selection (e.g. STRING, FILE_NAME)."""
645 name = self._register(command)
646 self.tk.call(('selection', 'handle') + self._options(kw)
647 + (self._w, name))
648 def selection_own(self, **kw):
649 """Become owner of X selection.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000650
Fredrik Lundh06d28152000-08-09 18:03:12 +0000651 A keyword parameter selection specifies the name of
652 the selection (default PRIMARY)."""
653 self.tk.call(('selection', 'own') +
654 self._options(kw) + (self._w,))
655 def selection_own_get(self, **kw):
656 """Return owner of X selection.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000657
Fredrik Lundh06d28152000-08-09 18:03:12 +0000658 The following keyword parameter can
659 be provided:
660 selection - name of the selection (default PRIMARY),
661 type - type of the selection (e.g. STRING, FILE_NAME)."""
662 if not kw.has_key('displayof'): kw['displayof'] = self._w
663 name = self.tk.call(('selection', 'own') + self._options(kw))
664 if not name: return None
665 return self._nametowidget(name)
666 def send(self, interp, cmd, *args):
667 """Send Tcl command CMD to different interpreter INTERP to be executed."""
668 return self.tk.call(('send', interp, cmd) + args)
669 def lower(self, belowThis=None):
670 """Lower this widget in the stacking order."""
671 self.tk.call('lower', self._w, belowThis)
672 def tkraise(self, aboveThis=None):
673 """Raise this widget in the stacking order."""
674 self.tk.call('raise', self._w, aboveThis)
675 lift = tkraise
676 def colormodel(self, value=None):
677 """Useless. Not implemented in Tk."""
678 return self.tk.call('tk', 'colormodel', self._w, value)
679 def winfo_atom(self, name, displayof=0):
680 """Return integer which represents atom NAME."""
681 args = ('winfo', 'atom') + self._displayof(displayof) + (name,)
682 return getint(self.tk.call(args))
683 def winfo_atomname(self, id, displayof=0):
684 """Return name of atom with identifier ID."""
685 args = ('winfo', 'atomname') \
686 + self._displayof(displayof) + (id,)
687 return self.tk.call(args)
688 def winfo_cells(self):
689 """Return number of cells in the colormap for this widget."""
690 return getint(
691 self.tk.call('winfo', 'cells', self._w))
692 def winfo_children(self):
693 """Return a list of all widgets which are children of this widget."""
Martin v. Löwisf2041b82002-03-27 17:15:57 +0000694 result = []
695 for child in self.tk.splitlist(
696 self.tk.call('winfo', 'children', self._w)):
697 try:
698 # Tcl sometimes returns extra windows, e.g. for
699 # menus; those need to be skipped
700 result.append(self._nametowidget(child))
701 except KeyError:
702 pass
703 return result
704
Fredrik Lundh06d28152000-08-09 18:03:12 +0000705 def winfo_class(self):
706 """Return window class name of this widget."""
707 return self.tk.call('winfo', 'class', self._w)
708 def winfo_colormapfull(self):
709 """Return true if at the last color request the colormap was full."""
710 return self.tk.getboolean(
711 self.tk.call('winfo', 'colormapfull', self._w))
712 def winfo_containing(self, rootX, rootY, displayof=0):
713 """Return the widget which is at the root coordinates ROOTX, ROOTY."""
714 args = ('winfo', 'containing') \
715 + self._displayof(displayof) + (rootX, rootY)
716 name = self.tk.call(args)
717 if not name: return None
718 return self._nametowidget(name)
719 def winfo_depth(self):
720 """Return the number of bits per pixel."""
721 return getint(self.tk.call('winfo', 'depth', self._w))
722 def winfo_exists(self):
723 """Return true if this widget exists."""
724 return getint(
725 self.tk.call('winfo', 'exists', self._w))
726 def winfo_fpixels(self, number):
727 """Return the number of pixels for the given distance NUMBER
728 (e.g. "3c") as float."""
729 return getdouble(self.tk.call(
730 'winfo', 'fpixels', self._w, number))
731 def winfo_geometry(self):
732 """Return geometry string for this widget in the form "widthxheight+X+Y"."""
733 return self.tk.call('winfo', 'geometry', self._w)
734 def winfo_height(self):
735 """Return height of this widget."""
736 return getint(
737 self.tk.call('winfo', 'height', self._w))
738 def winfo_id(self):
739 """Return identifier ID for this widget."""
740 return self.tk.getint(
741 self.tk.call('winfo', 'id', self._w))
742 def winfo_interps(self, displayof=0):
743 """Return the name of all Tcl interpreters for this display."""
744 args = ('winfo', 'interps') + self._displayof(displayof)
745 return self.tk.splitlist(self.tk.call(args))
746 def winfo_ismapped(self):
747 """Return true if this widget is mapped."""
748 return getint(
749 self.tk.call('winfo', 'ismapped', self._w))
750 def winfo_manager(self):
751 """Return the window mananger name for this widget."""
752 return self.tk.call('winfo', 'manager', self._w)
753 def winfo_name(self):
754 """Return the name of this widget."""
755 return self.tk.call('winfo', 'name', self._w)
756 def winfo_parent(self):
757 """Return the name of the parent of this widget."""
758 return self.tk.call('winfo', 'parent', self._w)
759 def winfo_pathname(self, id, displayof=0):
760 """Return the pathname of the widget given by ID."""
761 args = ('winfo', 'pathname') \
762 + self._displayof(displayof) + (id,)
763 return self.tk.call(args)
764 def winfo_pixels(self, number):
765 """Rounded integer value of winfo_fpixels."""
766 return getint(
767 self.tk.call('winfo', 'pixels', self._w, number))
768 def winfo_pointerx(self):
769 """Return the x coordinate of the pointer on the root window."""
770 return getint(
771 self.tk.call('winfo', 'pointerx', self._w))
772 def winfo_pointerxy(self):
773 """Return a tuple of x and y coordinates of the pointer on the root window."""
774 return self._getints(
775 self.tk.call('winfo', 'pointerxy', self._w))
776 def winfo_pointery(self):
777 """Return the y coordinate of the pointer on the root window."""
778 return getint(
779 self.tk.call('winfo', 'pointery', self._w))
780 def winfo_reqheight(self):
781 """Return requested height of this widget."""
782 return getint(
783 self.tk.call('winfo', 'reqheight', self._w))
784 def winfo_reqwidth(self):
785 """Return requested width of this widget."""
786 return getint(
787 self.tk.call('winfo', 'reqwidth', self._w))
788 def winfo_rgb(self, color):
789 """Return tuple of decimal values for red, green, blue for
790 COLOR in this widget."""
791 return self._getints(
792 self.tk.call('winfo', 'rgb', self._w, color))
793 def winfo_rootx(self):
794 """Return x coordinate of upper left corner of this widget on the
795 root window."""
796 return getint(
797 self.tk.call('winfo', 'rootx', self._w))
798 def winfo_rooty(self):
799 """Return y coordinate of upper left corner of this widget on the
800 root window."""
801 return getint(
802 self.tk.call('winfo', 'rooty', self._w))
803 def winfo_screen(self):
804 """Return the screen name of this widget."""
805 return self.tk.call('winfo', 'screen', self._w)
806 def winfo_screencells(self):
807 """Return the number of the cells in the colormap of the screen
808 of this widget."""
809 return getint(
810 self.tk.call('winfo', 'screencells', self._w))
811 def winfo_screendepth(self):
812 """Return the number of bits per pixel of the root window of the
813 screen of this widget."""
814 return getint(
815 self.tk.call('winfo', 'screendepth', self._w))
816 def winfo_screenheight(self):
817 """Return the number of pixels of the height of the screen of this widget
818 in pixel."""
819 return getint(
820 self.tk.call('winfo', 'screenheight', self._w))
821 def winfo_screenmmheight(self):
822 """Return the number of pixels of the height of the screen of
823 this widget in mm."""
824 return getint(
825 self.tk.call('winfo', 'screenmmheight', self._w))
826 def winfo_screenmmwidth(self):
827 """Return the number of pixels of the width of the screen of
828 this widget in mm."""
829 return getint(
830 self.tk.call('winfo', 'screenmmwidth', self._w))
831 def winfo_screenvisual(self):
832 """Return one of the strings directcolor, grayscale, pseudocolor,
833 staticcolor, staticgray, or truecolor for the default
834 colormodel of this screen."""
835 return self.tk.call('winfo', 'screenvisual', self._w)
836 def winfo_screenwidth(self):
837 """Return the number of pixels of the width of the screen of
838 this widget in pixel."""
839 return getint(
840 self.tk.call('winfo', 'screenwidth', self._w))
841 def winfo_server(self):
842 """Return information of the X-Server of the screen of this widget in
843 the form "XmajorRminor vendor vendorVersion"."""
844 return self.tk.call('winfo', 'server', self._w)
845 def winfo_toplevel(self):
846 """Return the toplevel widget of this widget."""
847 return self._nametowidget(self.tk.call(
848 'winfo', 'toplevel', self._w))
849 def winfo_viewable(self):
850 """Return true if the widget and all its higher ancestors are mapped."""
851 return getint(
852 self.tk.call('winfo', 'viewable', self._w))
853 def winfo_visual(self):
854 """Return one of the strings directcolor, grayscale, pseudocolor,
855 staticcolor, staticgray, or truecolor for the
856 colormodel of this widget."""
857 return self.tk.call('winfo', 'visual', self._w)
858 def winfo_visualid(self):
859 """Return the X identifier for the visual for this widget."""
860 return self.tk.call('winfo', 'visualid', self._w)
861 def winfo_visualsavailable(self, includeids=0):
862 """Return a list of all visuals available for the screen
863 of this widget.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000864
Fredrik Lundh06d28152000-08-09 18:03:12 +0000865 Each item in the list consists of a visual name (see winfo_visual), a
866 depth and if INCLUDEIDS=1 is given also the X identifier."""
867 data = self.tk.split(
868 self.tk.call('winfo', 'visualsavailable', self._w,
869 includeids and 'includeids' or None))
Fredrik Lundh24037f72000-08-09 19:26:47 +0000870 if type(data) is StringType:
871 data = [self.tk.split(data)]
Fredrik Lundh06d28152000-08-09 18:03:12 +0000872 return map(self.__winfo_parseitem, data)
873 def __winfo_parseitem(self, t):
874 """Internal function."""
875 return t[:1] + tuple(map(self.__winfo_getint, t[1:]))
876 def __winfo_getint(self, x):
877 """Internal function."""
Eric S. Raymondfc170b12001-02-09 11:51:27 +0000878 return int(x, 0)
Fredrik Lundh06d28152000-08-09 18:03:12 +0000879 def winfo_vrootheight(self):
880 """Return the height of the virtual root window associated with this
881 widget in pixels. If there is no virtual root window return the
882 height of the screen."""
883 return getint(
884 self.tk.call('winfo', 'vrootheight', self._w))
885 def winfo_vrootwidth(self):
886 """Return the width of the virtual root window associated with this
887 widget in pixel. If there is no virtual root window return the
888 width of the screen."""
889 return getint(
890 self.tk.call('winfo', 'vrootwidth', self._w))
891 def winfo_vrootx(self):
892 """Return the x offset of the virtual root relative to the root
893 window of the screen of this widget."""
894 return getint(
895 self.tk.call('winfo', 'vrootx', self._w))
896 def winfo_vrooty(self):
897 """Return the y offset of the virtual root relative to the root
898 window of the screen of this widget."""
899 return getint(
900 self.tk.call('winfo', 'vrooty', self._w))
901 def winfo_width(self):
902 """Return the width of this widget."""
903 return getint(
904 self.tk.call('winfo', 'width', self._w))
905 def winfo_x(self):
906 """Return the x coordinate of the upper left corner of this widget
907 in the parent."""
908 return getint(
909 self.tk.call('winfo', 'x', self._w))
910 def winfo_y(self):
911 """Return the y coordinate of the upper left corner of this widget
912 in the parent."""
913 return getint(
914 self.tk.call('winfo', 'y', self._w))
915 def update(self):
916 """Enter event loop until all pending events have been processed by Tcl."""
917 self.tk.call('update')
918 def update_idletasks(self):
919 """Enter event loop until all idle callbacks have been called. This
920 will update the display of windows but not process events caused by
921 the user."""
922 self.tk.call('update', 'idletasks')
923 def bindtags(self, tagList=None):
924 """Set or get the list of bindtags for this widget.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000925
Fredrik Lundh06d28152000-08-09 18:03:12 +0000926 With no argument return the list of all bindtags associated with
927 this widget. With a list of strings as argument the bindtags are
928 set to this list. The bindtags determine in which order events are
929 processed (see bind)."""
930 if tagList is None:
931 return self.tk.splitlist(
932 self.tk.call('bindtags', self._w))
933 else:
934 self.tk.call('bindtags', self._w, tagList)
935 def _bind(self, what, sequence, func, add, needcleanup=1):
936 """Internal function."""
937 if type(func) is StringType:
938 self.tk.call(what + (sequence, func))
939 elif func:
940 funcid = self._register(func, self._substitute,
941 needcleanup)
942 cmd = ('%sif {"[%s %s]" == "break"} break\n'
943 %
944 (add and '+' or '',
Martin v. Löwisc8718c12001-08-09 16:57:33 +0000945 funcid, self._subst_format_str))
Fredrik Lundh06d28152000-08-09 18:03:12 +0000946 self.tk.call(what + (sequence, cmd))
947 return funcid
948 elif sequence:
949 return self.tk.call(what + (sequence,))
950 else:
951 return self.tk.splitlist(self.tk.call(what))
952 def bind(self, sequence=None, func=None, add=None):
953 """Bind to this widget at event SEQUENCE a call to function FUNC.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000954
Fredrik Lundh06d28152000-08-09 18:03:12 +0000955 SEQUENCE is a string of concatenated event
956 patterns. An event pattern is of the form
957 <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
958 of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
959 Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
960 B3, Alt, Button4, B4, Double, Button5, B5 Triple,
961 Mod1, M1. TYPE is one of Activate, Enter, Map,
962 ButtonPress, Button, Expose, Motion, ButtonRelease
963 FocusIn, MouseWheel, Circulate, FocusOut, Property,
964 Colormap, Gravity Reparent, Configure, KeyPress, Key,
965 Unmap, Deactivate, KeyRelease Visibility, Destroy,
966 Leave and DETAIL is the button number for ButtonPress,
967 ButtonRelease and DETAIL is the Keysym for KeyPress and
968 KeyRelease. Examples are
969 <Control-Button-1> for pressing Control and mouse button 1 or
970 <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
971 An event pattern can also be a virtual event of the form
972 <<AString>> where AString can be arbitrary. This
973 event can be generated by event_generate.
974 If events are concatenated they must appear shortly
975 after each other.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000976
Fredrik Lundh06d28152000-08-09 18:03:12 +0000977 FUNC will be called if the event sequence occurs with an
978 instance of Event as argument. If the return value of FUNC is
979 "break" no further bound function is invoked.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000980
Fredrik Lundh06d28152000-08-09 18:03:12 +0000981 An additional boolean parameter ADD specifies whether FUNC will
982 be called additionally to the other bound function or whether
983 it will replace the previous function.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000984
Fredrik Lundh06d28152000-08-09 18:03:12 +0000985 Bind will return an identifier to allow deletion of the bound function with
986 unbind without memory leak.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000987
Fredrik Lundh06d28152000-08-09 18:03:12 +0000988 If FUNC or SEQUENCE is omitted the bound function or list
989 of bound events are returned."""
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000990
Fredrik Lundh06d28152000-08-09 18:03:12 +0000991 return self._bind(('bind', self._w), sequence, func, add)
992 def unbind(self, sequence, funcid=None):
993 """Unbind for this widget for event SEQUENCE the
994 function identified with FUNCID."""
995 self.tk.call('bind', self._w, sequence, '')
996 if funcid:
997 self.deletecommand(funcid)
998 def bind_all(self, sequence=None, func=None, add=None):
999 """Bind to all widgets at an event SEQUENCE a call to function FUNC.
1000 An additional boolean parameter ADD specifies whether FUNC will
1001 be called additionally to the other bound function or whether
1002 it will replace the previous function. See bind for the return value."""
1003 return self._bind(('bind', 'all'), sequence, func, add, 0)
1004 def unbind_all(self, sequence):
1005 """Unbind for all widgets for event SEQUENCE all functions."""
1006 self.tk.call('bind', 'all' , sequence, '')
1007 def bind_class(self, className, sequence=None, func=None, add=None):
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001008
Fredrik Lundh06d28152000-08-09 18:03:12 +00001009 """Bind to widgets with bindtag CLASSNAME at event
1010 SEQUENCE a call of function FUNC. An additional
1011 boolean parameter ADD specifies whether FUNC will be
1012 called additionally to the other bound function or
1013 whether it will replace the previous function. See bind for
1014 the return value."""
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001015
Fredrik Lundh06d28152000-08-09 18:03:12 +00001016 return self._bind(('bind', className), sequence, func, add, 0)
1017 def unbind_class(self, className, sequence):
1018 """Unbind for a all widgets with bindtag CLASSNAME for event SEQUENCE
1019 all functions."""
1020 self.tk.call('bind', className , sequence, '')
1021 def mainloop(self, n=0):
1022 """Call the mainloop of Tk."""
1023 self.tk.mainloop(n)
1024 def quit(self):
1025 """Quit the Tcl interpreter. All widgets will be destroyed."""
1026 self.tk.quit()
1027 def _getints(self, string):
1028 """Internal function."""
1029 if string:
1030 return tuple(map(getint, self.tk.splitlist(string)))
1031 def _getdoubles(self, string):
1032 """Internal function."""
1033 if string:
1034 return tuple(map(getdouble, self.tk.splitlist(string)))
1035 def _getboolean(self, string):
1036 """Internal function."""
1037 if string:
1038 return self.tk.getboolean(string)
1039 def _displayof(self, displayof):
1040 """Internal function."""
1041 if displayof:
1042 return ('-displayof', displayof)
1043 if displayof is None:
1044 return ('-displayof', self._w)
1045 return ()
1046 def _options(self, cnf, kw = None):
1047 """Internal function."""
1048 if kw:
1049 cnf = _cnfmerge((cnf, kw))
1050 else:
1051 cnf = _cnfmerge(cnf)
1052 res = ()
1053 for k, v in cnf.items():
1054 if v is not None:
1055 if k[-1] == '_': k = k[:-1]
1056 if callable(v):
1057 v = self._register(v)
Georg Brandl1a348342008-05-31 18:34:27 +00001058 elif isinstance(v, (tuple, list)):
Georg Brandl7eb4a822008-06-03 10:26:21 +00001059 nv = []
Georg Brandl1a348342008-05-31 18:34:27 +00001060 for item in v:
1061 if not isinstance(item, (basestring, int)):
1062 break
Georg Brandl7eb4a822008-06-03 10:26:21 +00001063 elif isinstance(item, int):
1064 nv.append('%d' % item)
1065 else:
1066 # format it to proper Tcl code if it contains space
1067 nv.append(('{%s}' if ' ' in item else '%s') % item)
Georg Brandl1a348342008-05-31 18:34:27 +00001068 else:
Georg Brandl7eb4a822008-06-03 10:26:21 +00001069 v = ' '.join(nv)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001070 res = res + ('-'+k, v)
1071 return res
1072 def nametowidget(self, name):
1073 """Return the Tkinter instance of a widget identified by
1074 its Tcl name NAME."""
Martin v. Löwisc7af7f32008-08-02 07:21:06 +00001075 name = str(name).split('.')
Fredrik Lundh06d28152000-08-09 18:03:12 +00001076 w = self
Martin v. Löwisc7af7f32008-08-02 07:21:06 +00001077
1078 if not name[0]:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001079 w = w._root()
1080 name = name[1:]
Martin v. Löwisc7af7f32008-08-02 07:21:06 +00001081
1082 for n in name:
1083 if not n:
1084 break
1085 w = w.children[n]
1086
Fredrik Lundh06d28152000-08-09 18:03:12 +00001087 return w
1088 _nametowidget = nametowidget
1089 def _register(self, func, subst=None, needcleanup=1):
1090 """Return a newly created Tcl function. If this
1091 function is called, the Python function FUNC will
1092 be executed. An optional function SUBST can
1093 be given which will be executed before FUNC."""
1094 f = CallWrapper(func, subst, self).__call__
Walter Dörwald70a6b492004-02-12 17:35:32 +00001095 name = repr(id(f))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001096 try:
1097 func = func.im_func
1098 except AttributeError:
1099 pass
1100 try:
1101 name = name + func.__name__
1102 except AttributeError:
1103 pass
1104 self.tk.createcommand(name, f)
1105 if needcleanup:
1106 if self._tclCommands is None:
1107 self._tclCommands = []
1108 self._tclCommands.append(name)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001109 return name
1110 register = _register
1111 def _root(self):
1112 """Internal function."""
1113 w = self
1114 while w.master: w = w.master
1115 return w
1116 _subst_format = ('%#', '%b', '%f', '%h', '%k',
1117 '%s', '%t', '%w', '%x', '%y',
1118 '%A', '%E', '%K', '%N', '%W', '%T', '%X', '%Y', '%D')
Martin v. Löwisc8718c12001-08-09 16:57:33 +00001119 _subst_format_str = " ".join(_subst_format)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001120 def _substitute(self, *args):
1121 """Internal function."""
1122 if len(args) != len(self._subst_format): return args
1123 getboolean = self.tk.getboolean
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001124
Fredrik Lundh06d28152000-08-09 18:03:12 +00001125 getint = int
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001126 def getint_event(s):
1127 """Tk changed behavior in 8.4.2, returning "??" rather more often."""
1128 try:
1129 return int(s)
1130 except ValueError:
1131 return s
1132
Fredrik Lundh06d28152000-08-09 18:03:12 +00001133 nsign, b, f, h, k, s, t, w, x, y, A, E, K, N, W, T, X, Y, D = args
1134 # Missing: (a, c, d, m, o, v, B, R)
1135 e = Event()
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001136 # serial field: valid vor all events
1137 # number of button: ButtonPress and ButtonRelease events only
1138 # height field: Configure, ConfigureRequest, Create,
1139 # ResizeRequest, and Expose events only
1140 # keycode field: KeyPress and KeyRelease events only
1141 # time field: "valid for events that contain a time field"
1142 # width field: Configure, ConfigureRequest, Create, ResizeRequest,
1143 # and Expose events only
1144 # x field: "valid for events that contain a x field"
1145 # y field: "valid for events that contain a y field"
1146 # keysym as decimal: KeyPress and KeyRelease events only
1147 # x_root, y_root fields: ButtonPress, ButtonRelease, KeyPress,
1148 # KeyRelease,and Motion events
Fredrik Lundh06d28152000-08-09 18:03:12 +00001149 e.serial = getint(nsign)
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001150 e.num = getint_event(b)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001151 try: e.focus = getboolean(f)
1152 except TclError: pass
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001153 e.height = getint_event(h)
1154 e.keycode = getint_event(k)
1155 e.state = getint_event(s)
1156 e.time = getint_event(t)
1157 e.width = getint_event(w)
1158 e.x = getint_event(x)
1159 e.y = getint_event(y)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001160 e.char = A
1161 try: e.send_event = getboolean(E)
1162 except TclError: pass
1163 e.keysym = K
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001164 e.keysym_num = getint_event(N)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001165 e.type = T
1166 try:
1167 e.widget = self._nametowidget(W)
1168 except KeyError:
1169 e.widget = W
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001170 e.x_root = getint_event(X)
1171 e.y_root = getint_event(Y)
Fredrik Lundha249f162000-09-07 15:05:09 +00001172 try:
1173 e.delta = getint(D)
1174 except ValueError:
1175 e.delta = 0
Fredrik Lundh06d28152000-08-09 18:03:12 +00001176 return (e,)
1177 def _report_exception(self):
1178 """Internal function."""
1179 import sys
1180 exc, val, tb = sys.exc_type, sys.exc_value, sys.exc_traceback
1181 root = self._root()
1182 root.report_callback_exception(exc, val, tb)
Martin v. Löwis6ce13152002-10-10 14:36:13 +00001183 def _configure(self, cmd, cnf, kw):
1184 """Internal function."""
1185 if kw:
1186 cnf = _cnfmerge((cnf, kw))
1187 elif cnf:
1188 cnf = _cnfmerge(cnf)
1189 if cnf is None:
1190 cnf = {}
1191 for x in self.tk.split(
1192 self.tk.call(_flatten((self._w, cmd)))):
1193 cnf[x[0][1:]] = (x[0][1:],) + x[1:]
1194 return cnf
1195 if type(cnf) is StringType:
1196 x = self.tk.split(
1197 self.tk.call(_flatten((self._w, cmd, '-'+cnf))))
1198 return (x[0][1:],) + x[1:]
1199 self.tk.call(_flatten((self._w, cmd)) + self._options(cnf))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001200 # These used to be defined in Widget:
1201 def configure(self, cnf=None, **kw):
1202 """Configure resources of a widget.
Barry Warsaw107e6231998-12-15 00:44:15 +00001203
Fredrik Lundh06d28152000-08-09 18:03:12 +00001204 The values for resources are specified as keyword
1205 arguments. To get an overview about
1206 the allowed keyword arguments call the method keys.
1207 """
Martin v. Löwis6ce13152002-10-10 14:36:13 +00001208 return self._configure('configure', cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001209 config = configure
1210 def cget(self, key):
1211 """Return the resource value for a KEY given as string."""
1212 return self.tk.call(self._w, 'cget', '-' + key)
1213 __getitem__ = cget
1214 def __setitem__(self, key, value):
1215 self.configure({key: value})
1216 def keys(self):
1217 """Return a list of all resource names of this widget."""
1218 return map(lambda x: x[0][1:],
1219 self.tk.split(self.tk.call(self._w, 'configure')))
1220 def __str__(self):
1221 """Return the window path name of this widget."""
1222 return self._w
1223 # Pack methods that apply to the master
1224 _noarg_ = ['_noarg_']
1225 def pack_propagate(self, flag=_noarg_):
1226 """Set or get the status for propagation of geometry information.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001227
Fredrik Lundh06d28152000-08-09 18:03:12 +00001228 A boolean argument specifies whether the geometry information
1229 of the slaves will determine the size of this widget. If no argument
1230 is given the current setting will be returned.
1231 """
1232 if flag is Misc._noarg_:
1233 return self._getboolean(self.tk.call(
1234 'pack', 'propagate', self._w))
1235 else:
1236 self.tk.call('pack', 'propagate', self._w, flag)
1237 propagate = pack_propagate
1238 def pack_slaves(self):
1239 """Return a list of all slaves of this widget
1240 in its packing order."""
1241 return map(self._nametowidget,
1242 self.tk.splitlist(
1243 self.tk.call('pack', 'slaves', self._w)))
1244 slaves = pack_slaves
1245 # Place method that applies to the master
1246 def place_slaves(self):
1247 """Return a list of all slaves of this widget
1248 in its packing order."""
1249 return map(self._nametowidget,
1250 self.tk.splitlist(
1251 self.tk.call(
1252 'place', 'slaves', self._w)))
1253 # Grid methods that apply to the master
1254 def grid_bbox(self, column=None, row=None, col2=None, row2=None):
1255 """Return a tuple of integer coordinates for the bounding
1256 box of this widget controlled by the geometry manager grid.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001257
Fredrik Lundh06d28152000-08-09 18:03:12 +00001258 If COLUMN, ROW is given the bounding box applies from
1259 the cell with row and column 0 to the specified
1260 cell. If COL2 and ROW2 are given the bounding box
1261 starts at that cell.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001262
Fredrik Lundh06d28152000-08-09 18:03:12 +00001263 The returned integers specify the offset of the upper left
1264 corner in the master widget and the width and height.
1265 """
1266 args = ('grid', 'bbox', self._w)
1267 if column is not None and row is not None:
1268 args = args + (column, row)
1269 if col2 is not None and row2 is not None:
1270 args = args + (col2, row2)
Raymond Hettingerff41c482003-04-06 09:01:11 +00001271 return self._getints(self.tk.call(*args)) or None
Guido van Rossum18468821994-06-20 07:49:28 +00001272
Fredrik Lundh06d28152000-08-09 18:03:12 +00001273 bbox = grid_bbox
1274 def _grid_configure(self, command, index, cnf, kw):
1275 """Internal function."""
1276 if type(cnf) is StringType and not kw:
1277 if cnf[-1:] == '_':
1278 cnf = cnf[:-1]
1279 if cnf[:1] != '-':
1280 cnf = '-'+cnf
1281 options = (cnf,)
1282 else:
1283 options = self._options(cnf, kw)
1284 if not options:
1285 res = self.tk.call('grid',
1286 command, self._w, index)
1287 words = self.tk.splitlist(res)
1288 dict = {}
1289 for i in range(0, len(words), 2):
1290 key = words[i][1:]
1291 value = words[i+1]
1292 if not value:
1293 value = None
1294 elif '.' in value:
1295 value = getdouble(value)
1296 else:
1297 value = getint(value)
1298 dict[key] = value
1299 return dict
1300 res = self.tk.call(
1301 ('grid', command, self._w, index)
1302 + options)
1303 if len(options) == 1:
1304 if not res: return None
1305 # In Tk 7.5, -width can be a float
1306 if '.' in res: return getdouble(res)
1307 return getint(res)
1308 def grid_columnconfigure(self, index, cnf={}, **kw):
1309 """Configure column INDEX of a grid.
Guido van Rossum80f8be81997-12-02 19:51:39 +00001310
Fredrik Lundh06d28152000-08-09 18:03:12 +00001311 Valid resources are minsize (minimum size of the column),
1312 weight (how much does additional space propagate to this column)
1313 and pad (how much space to let additionally)."""
1314 return self._grid_configure('columnconfigure', index, cnf, kw)
1315 columnconfigure = grid_columnconfigure
Martin v. Löwisdc579092001-10-13 09:33:51 +00001316 def grid_location(self, x, y):
1317 """Return a tuple of column and row which identify the cell
1318 at which the pixel at position X and Y inside the master
1319 widget is located."""
1320 return self._getints(
1321 self.tk.call(
1322 'grid', 'location', self._w, x, y)) or None
Fredrik Lundh06d28152000-08-09 18:03:12 +00001323 def grid_propagate(self, flag=_noarg_):
1324 """Set or get the status for propagation of geometry information.
Guido van Rossum80f8be81997-12-02 19:51:39 +00001325
Fredrik Lundh06d28152000-08-09 18:03:12 +00001326 A boolean argument specifies whether the geometry information
1327 of the slaves will determine the size of this widget. If no argument
1328 is given, the current setting will be returned.
1329 """
1330 if flag is Misc._noarg_:
1331 return self._getboolean(self.tk.call(
1332 'grid', 'propagate', self._w))
1333 else:
1334 self.tk.call('grid', 'propagate', self._w, flag)
1335 def grid_rowconfigure(self, index, cnf={}, **kw):
1336 """Configure row INDEX of a grid.
Guido van Rossum80f8be81997-12-02 19:51:39 +00001337
Fredrik Lundh06d28152000-08-09 18:03:12 +00001338 Valid resources are minsize (minimum size of the row),
1339 weight (how much does additional space propagate to this row)
1340 and pad (how much space to let additionally)."""
1341 return self._grid_configure('rowconfigure', index, cnf, kw)
1342 rowconfigure = grid_rowconfigure
1343 def grid_size(self):
1344 """Return a tuple of the number of column and rows in the grid."""
1345 return self._getints(
1346 self.tk.call('grid', 'size', self._w)) or None
1347 size = grid_size
1348 def grid_slaves(self, row=None, column=None):
1349 """Return a list of all slaves of this widget
1350 in its packing order."""
1351 args = ()
1352 if row is not None:
1353 args = args + ('-row', row)
1354 if column is not None:
1355 args = args + ('-column', column)
1356 return map(self._nametowidget,
1357 self.tk.splitlist(self.tk.call(
1358 ('grid', 'slaves', self._w) + args)))
Guido van Rossum80f8be81997-12-02 19:51:39 +00001359
Fredrik Lundh06d28152000-08-09 18:03:12 +00001360 # Support for the "event" command, new in Tk 4.2.
1361 # By Case Roole.
Guido van Rossum80f8be81997-12-02 19:51:39 +00001362
Fredrik Lundh06d28152000-08-09 18:03:12 +00001363 def event_add(self, virtual, *sequences):
1364 """Bind a virtual event VIRTUAL (of the form <<Name>>)
1365 to an event SEQUENCE such that the virtual event is triggered
1366 whenever SEQUENCE occurs."""
1367 args = ('event', 'add', virtual) + sequences
1368 self.tk.call(args)
Guido van Rossumc2966511998-04-10 19:16:10 +00001369
Fredrik Lundh06d28152000-08-09 18:03:12 +00001370 def event_delete(self, virtual, *sequences):
1371 """Unbind a virtual event VIRTUAL from SEQUENCE."""
1372 args = ('event', 'delete', virtual) + sequences
1373 self.tk.call(args)
Guido van Rossumc2966511998-04-10 19:16:10 +00001374
Fredrik Lundh06d28152000-08-09 18:03:12 +00001375 def event_generate(self, sequence, **kw):
1376 """Generate an event SEQUENCE. Additional
1377 keyword arguments specify parameter of the event
1378 (e.g. x, y, rootx, rooty)."""
1379 args = ('event', 'generate', self._w, sequence)
1380 for k, v in kw.items():
1381 args = args + ('-%s' % k, str(v))
1382 self.tk.call(args)
1383
1384 def event_info(self, virtual=None):
1385 """Return a list of all virtual events or the information
1386 about the SEQUENCE bound to the virtual event VIRTUAL."""
1387 return self.tk.splitlist(
1388 self.tk.call('event', 'info', virtual))
1389
1390 # Image related commands
1391
1392 def image_names(self):
1393 """Return a list of all existing image names."""
1394 return self.tk.call('image', 'names')
1395
1396 def image_types(self):
1397 """Return a list of all available image types (e.g. phote bitmap)."""
1398 return self.tk.call('image', 'types')
Guido van Rossumc2966511998-04-10 19:16:10 +00001399
Guido van Rossum80f8be81997-12-02 19:51:39 +00001400
Guido van Rossuma5773dd1995-09-07 19:22:00 +00001401class CallWrapper:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001402 """Internal class. Stores function to call when some user
1403 defined Tcl function is called e.g. after an event occurred."""
1404 def __init__(self, func, subst, widget):
1405 """Store FUNC, SUBST and WIDGET as members."""
1406 self.func = func
1407 self.subst = subst
1408 self.widget = widget
1409 def __call__(self, *args):
1410 """Apply first function SUBST to arguments, than FUNC."""
1411 try:
1412 if self.subst:
Raymond Hettingerff41c482003-04-06 09:01:11 +00001413 args = self.subst(*args)
1414 return self.func(*args)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001415 except SystemExit, msg:
1416 raise SystemExit, msg
1417 except:
1418 self.widget._report_exception()
Guido van Rossum18468821994-06-20 07:49:28 +00001419
Guido van Rossume365a591998-05-01 19:48:20 +00001420
Guido van Rossum18468821994-06-20 07:49:28 +00001421class Wm:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001422 """Provides functions for the communication with the window manager."""
Raymond Hettingerff41c482003-04-06 09:01:11 +00001423
Fredrik Lundh06d28152000-08-09 18:03:12 +00001424 def wm_aspect(self,
1425 minNumer=None, minDenom=None,
1426 maxNumer=None, maxDenom=None):
1427 """Instruct the window manager to set the aspect ratio (width/height)
1428 of this widget to be between MINNUMER/MINDENOM and MAXNUMER/MAXDENOM. Return a tuple
1429 of the actual values if no argument is given."""
1430 return self._getints(
1431 self.tk.call('wm', 'aspect', self._w,
1432 minNumer, minDenom,
1433 maxNumer, maxDenom))
1434 aspect = wm_aspect
Raymond Hettingerff41c482003-04-06 09:01:11 +00001435
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001436 def wm_attributes(self, *args):
1437 """This subcommand returns or sets platform specific attributes
Raymond Hettingerff41c482003-04-06 09:01:11 +00001438
1439 The first form returns a list of the platform specific flags and
1440 their values. The second form returns the value for the specific
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001441 option. The third form sets one or more of the values. The values
1442 are as follows:
Raymond Hettingerff41c482003-04-06 09:01:11 +00001443
1444 On Windows, -disabled gets or sets whether the window is in a
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001445 disabled state. -toolwindow gets or sets the style of the window
Raymond Hettingerff41c482003-04-06 09:01:11 +00001446 to toolwindow (as defined in the MSDN). -topmost gets or sets
1447 whether this is a topmost window (displays above all other
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001448 windows).
Raymond Hettingerff41c482003-04-06 09:01:11 +00001449
1450 On Macintosh, XXXXX
1451
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001452 On Unix, there are currently no special attribute values.
1453 """
1454 args = ('wm', 'attributes', self._w) + args
1455 return self.tk.call(args)
1456 attributes=wm_attributes
Raymond Hettingerff41c482003-04-06 09:01:11 +00001457
Fredrik Lundh06d28152000-08-09 18:03:12 +00001458 def wm_client(self, name=None):
1459 """Store NAME in WM_CLIENT_MACHINE property of this widget. Return
1460 current value."""
1461 return self.tk.call('wm', 'client', self._w, name)
1462 client = wm_client
1463 def wm_colormapwindows(self, *wlist):
1464 """Store list of window names (WLIST) into WM_COLORMAPWINDOWS property
1465 of this widget. This list contains windows whose colormaps differ from their
1466 parents. Return current list of widgets if WLIST is empty."""
1467 if len(wlist) > 1:
1468 wlist = (wlist,) # Tk needs a list of windows here
1469 args = ('wm', 'colormapwindows', self._w) + wlist
1470 return map(self._nametowidget, self.tk.call(args))
1471 colormapwindows = wm_colormapwindows
1472 def wm_command(self, value=None):
1473 """Store VALUE in WM_COMMAND property. It is the command
1474 which shall be used to invoke the application. Return current
1475 command if VALUE is None."""
1476 return self.tk.call('wm', 'command', self._w, value)
1477 command = wm_command
1478 def wm_deiconify(self):
1479 """Deiconify this widget. If it was never mapped it will not be mapped.
1480 On Windows it will raise this widget and give it the focus."""
1481 return self.tk.call('wm', 'deiconify', self._w)
1482 deiconify = wm_deiconify
1483 def wm_focusmodel(self, model=None):
1484 """Set focus model to MODEL. "active" means that this widget will claim
1485 the focus itself, "passive" means that the window manager shall give
1486 the focus. Return current focus model if MODEL is None."""
1487 return self.tk.call('wm', 'focusmodel', self._w, model)
1488 focusmodel = wm_focusmodel
1489 def wm_frame(self):
1490 """Return identifier for decorative frame of this widget if present."""
1491 return self.tk.call('wm', 'frame', self._w)
1492 frame = wm_frame
1493 def wm_geometry(self, newGeometry=None):
1494 """Set geometry to NEWGEOMETRY of the form =widthxheight+x+y. Return
1495 current value if None is given."""
1496 return self.tk.call('wm', 'geometry', self._w, newGeometry)
1497 geometry = wm_geometry
1498 def wm_grid(self,
1499 baseWidth=None, baseHeight=None,
1500 widthInc=None, heightInc=None):
1501 """Instruct the window manager that this widget shall only be
1502 resized on grid boundaries. WIDTHINC and HEIGHTINC are the width and
1503 height of a grid unit in pixels. BASEWIDTH and BASEHEIGHT are the
1504 number of grid units requested in Tk_GeometryRequest."""
1505 return self._getints(self.tk.call(
1506 'wm', 'grid', self._w,
1507 baseWidth, baseHeight, widthInc, heightInc))
1508 grid = wm_grid
1509 def wm_group(self, pathName=None):
1510 """Set the group leader widgets for related widgets to PATHNAME. Return
1511 the group leader of this widget if None is given."""
1512 return self.tk.call('wm', 'group', self._w, pathName)
1513 group = wm_group
Martin v. Löwis5ecad9c2006-06-17 09:20:41 +00001514 def wm_iconbitmap(self, bitmap=None, default=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001515 """Set bitmap for the iconified widget to BITMAP. Return
Martin v. Löwis5ecad9c2006-06-17 09:20:41 +00001516 the bitmap if None is given.
1517
Tim Peters43bc3782006-06-19 07:45:16 +00001518 Under Windows, the DEFAULT parameter can be used to set the icon
Martin v. Löwis5ecad9c2006-06-17 09:20:41 +00001519 for the widget and any descendents that don't have an icon set
Neal Norwitz210262c2006-06-17 22:37:45 +00001520 explicitly. DEFAULT can be the relative path to a .ico file
Martin v. Löwis5ecad9c2006-06-17 09:20:41 +00001521 (example: root.iconbitmap(default='myicon.ico') ). See Tk
1522 documentation for more information."""
1523 if default:
1524 return self.tk.call('wm', 'iconbitmap', self._w, '-default', default)
1525 else:
1526 return self.tk.call('wm', 'iconbitmap', self._w, bitmap)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001527 iconbitmap = wm_iconbitmap
1528 def wm_iconify(self):
1529 """Display widget as icon."""
1530 return self.tk.call('wm', 'iconify', self._w)
1531 iconify = wm_iconify
1532 def wm_iconmask(self, bitmap=None):
1533 """Set mask for the icon bitmap of this widget. Return the
1534 mask if None is given."""
1535 return self.tk.call('wm', 'iconmask', self._w, bitmap)
1536 iconmask = wm_iconmask
1537 def wm_iconname(self, newName=None):
1538 """Set the name of the icon for this widget. Return the name if
1539 None is given."""
1540 return self.tk.call('wm', 'iconname', self._w, newName)
1541 iconname = wm_iconname
1542 def wm_iconposition(self, x=None, y=None):
1543 """Set the position of the icon of this widget to X and Y. Return
1544 a tuple of the current values of X and X if None is given."""
1545 return self._getints(self.tk.call(
1546 'wm', 'iconposition', self._w, x, y))
1547 iconposition = wm_iconposition
1548 def wm_iconwindow(self, pathName=None):
1549 """Set widget PATHNAME to be displayed instead of icon. Return the current
1550 value if None is given."""
1551 return self.tk.call('wm', 'iconwindow', self._w, pathName)
1552 iconwindow = wm_iconwindow
1553 def wm_maxsize(self, width=None, height=None):
1554 """Set max WIDTH and HEIGHT for this widget. If the window is gridded
1555 the values are given in grid units. Return the current values if None
1556 is given."""
1557 return self._getints(self.tk.call(
1558 'wm', 'maxsize', self._w, width, height))
1559 maxsize = wm_maxsize
1560 def wm_minsize(self, width=None, height=None):
1561 """Set min WIDTH and HEIGHT for this widget. If the window is gridded
1562 the values are given in grid units. Return the current values if None
1563 is given."""
1564 return self._getints(self.tk.call(
1565 'wm', 'minsize', self._w, width, height))
1566 minsize = wm_minsize
1567 def wm_overrideredirect(self, boolean=None):
1568 """Instruct the window manager to ignore this widget
1569 if BOOLEAN is given with 1. Return the current value if None
1570 is given."""
1571 return self._getboolean(self.tk.call(
1572 'wm', 'overrideredirect', self._w, boolean))
1573 overrideredirect = wm_overrideredirect
1574 def wm_positionfrom(self, who=None):
1575 """Instruct the window manager that the position of this widget shall
1576 be defined by the user if WHO is "user", and by its own policy if WHO is
1577 "program"."""
1578 return self.tk.call('wm', 'positionfrom', self._w, who)
1579 positionfrom = wm_positionfrom
1580 def wm_protocol(self, name=None, func=None):
1581 """Bind function FUNC to command NAME for this widget.
1582 Return the function bound to NAME if None is given. NAME could be
1583 e.g. "WM_SAVE_YOURSELF" or "WM_DELETE_WINDOW"."""
1584 if callable(func):
1585 command = self._register(func)
1586 else:
1587 command = func
1588 return self.tk.call(
1589 'wm', 'protocol', self._w, name, command)
1590 protocol = wm_protocol
1591 def wm_resizable(self, width=None, height=None):
1592 """Instruct the window manager whether this width can be resized
1593 in WIDTH or HEIGHT. Both values are boolean values."""
1594 return self.tk.call('wm', 'resizable', self._w, width, height)
1595 resizable = wm_resizable
1596 def wm_sizefrom(self, who=None):
1597 """Instruct the window manager that the size of this widget shall
1598 be defined by the user if WHO is "user", and by its own policy if WHO is
1599 "program"."""
1600 return self.tk.call('wm', 'sizefrom', self._w, who)
1601 sizefrom = wm_sizefrom
Fredrik Lundh289ad8f2000-08-09 19:11:59 +00001602 def wm_state(self, newstate=None):
1603 """Query or set the state of this widget as one of normal, icon,
1604 iconic (see wm_iconwindow), withdrawn, or zoomed (Windows only)."""
1605 return self.tk.call('wm', 'state', self._w, newstate)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001606 state = wm_state
1607 def wm_title(self, string=None):
1608 """Set the title of this widget."""
1609 return self.tk.call('wm', 'title', self._w, string)
1610 title = wm_title
1611 def wm_transient(self, master=None):
1612 """Instruct the window manager that this widget is transient
1613 with regard to widget MASTER."""
1614 return self.tk.call('wm', 'transient', self._w, master)
1615 transient = wm_transient
1616 def wm_withdraw(self):
1617 """Withdraw this widget from the screen such that it is unmapped
1618 and forgotten by the window manager. Re-draw it with wm_deiconify."""
1619 return self.tk.call('wm', 'withdraw', self._w)
1620 withdraw = wm_withdraw
Guido van Rossume365a591998-05-01 19:48:20 +00001621
Guido van Rossum18468821994-06-20 07:49:28 +00001622
1623class Tk(Misc, Wm):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001624 """Toplevel widget of Tk which represents mostly the main window
1625 of an appliation. It has an associated Tcl interpreter."""
1626 _w = '.'
Martin v. Löwis9441c072004-08-03 18:36:25 +00001627 def __init__(self, screenName=None, baseName=None, className='Tk',
1628 useTk=1, sync=0, use=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001629 """Return a new Toplevel widget on screen SCREENNAME. A new Tcl interpreter will
1630 be created. BASENAME will be used for the identification of the profile file (see
1631 readprofile).
1632 It is constructed from sys.argv[0] without extensions if None is given. CLASSNAME
1633 is the name of the widget class."""
Fredrik Lundh06d28152000-08-09 18:03:12 +00001634 self.master = None
1635 self.children = {}
David Aschere2b4b322004-02-18 05:59:53 +00001636 self._tkloaded = 0
1637 # to avoid recursions in the getattr code in case of failure, we
1638 # ensure that self.tk is always _something_.
Tim Peters182b5ac2004-07-18 06:16:08 +00001639 self.tk = None
Fredrik Lundh06d28152000-08-09 18:03:12 +00001640 if baseName is None:
1641 import sys, os
1642 baseName = os.path.basename(sys.argv[0])
1643 baseName, ext = os.path.splitext(baseName)
1644 if ext not in ('.py', '.pyc', '.pyo'):
1645 baseName = baseName + ext
David Aschere2b4b322004-02-18 05:59:53 +00001646 interactive = 0
Martin v. Löwis9441c072004-08-03 18:36:25 +00001647 self.tk = _tkinter.create(screenName, baseName, className, interactive, wantobjects, useTk, sync, use)
David Aschere2b4b322004-02-18 05:59:53 +00001648 if useTk:
1649 self._loadtk()
1650 self.readprofile(baseName, className)
1651 def loadtk(self):
1652 if not self._tkloaded:
1653 self.tk.loadtk()
1654 self._loadtk()
1655 def _loadtk(self):
1656 self._tkloaded = 1
1657 global _default_root
Jack Jansenbe92af02001-08-23 13:25:59 +00001658 if _MacOS and hasattr(_MacOS, 'SchedParams'):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001659 # Disable event scanning except for Command-Period
1660 _MacOS.SchedParams(1, 0)
1661 # Work around nasty MacTk bug
1662 # XXX Is this one still needed?
1663 self.update()
1664 # Version sanity checks
1665 tk_version = self.tk.getvar('tk_version')
1666 if tk_version != _tkinter.TK_VERSION:
1667 raise RuntimeError, \
1668 "tk.h version (%s) doesn't match libtk.a version (%s)" \
1669 % (_tkinter.TK_VERSION, tk_version)
Martin v. Löwis54895972003-05-24 11:37:15 +00001670 # Under unknown circumstances, tcl_version gets coerced to float
1671 tcl_version = str(self.tk.getvar('tcl_version'))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001672 if tcl_version != _tkinter.TCL_VERSION:
1673 raise RuntimeError, \
1674 "tcl.h version (%s) doesn't match libtcl.a version (%s)" \
1675 % (_tkinter.TCL_VERSION, tcl_version)
1676 if TkVersion < 4.0:
1677 raise RuntimeError, \
1678 "Tk 4.0 or higher is required; found Tk %s" \
1679 % str(TkVersion)
Martin v. Löwis4afe1542005-03-01 08:09:28 +00001680 # Create and register the tkerror and exit commands
1681 # We need to inline parts of _register here, _ register
1682 # would register differently-named commands.
1683 if self._tclCommands is None:
1684 self._tclCommands = []
Fredrik Lundh06d28152000-08-09 18:03:12 +00001685 self.tk.createcommand('tkerror', _tkerror)
1686 self.tk.createcommand('exit', _exit)
Martin v. Löwis4afe1542005-03-01 08:09:28 +00001687 self._tclCommands.append('tkerror')
1688 self._tclCommands.append('exit')
Fredrik Lundh06d28152000-08-09 18:03:12 +00001689 if _support_default_root and not _default_root:
1690 _default_root = self
1691 self.protocol("WM_DELETE_WINDOW", self.destroy)
1692 def destroy(self):
1693 """Destroy this and all descendants widgets. This will
1694 end the application of this Tcl interpreter."""
1695 for c in self.children.values(): c.destroy()
1696 self.tk.call('destroy', self._w)
1697 Misc.destroy(self)
1698 global _default_root
1699 if _support_default_root and _default_root is self:
1700 _default_root = None
1701 def readprofile(self, baseName, className):
1702 """Internal function. It reads BASENAME.tcl and CLASSNAME.tcl into
1703 the Tcl Interpreter and calls execfile on BASENAME.py and CLASSNAME.py if
1704 such a file exists in the home directory."""
1705 import os
1706 if os.environ.has_key('HOME'): home = os.environ['HOME']
1707 else: home = os.curdir
1708 class_tcl = os.path.join(home, '.%s.tcl' % className)
1709 class_py = os.path.join(home, '.%s.py' % className)
1710 base_tcl = os.path.join(home, '.%s.tcl' % baseName)
1711 base_py = os.path.join(home, '.%s.py' % baseName)
1712 dir = {'self': self}
1713 exec 'from Tkinter import *' in dir
1714 if os.path.isfile(class_tcl):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001715 self.tk.call('source', class_tcl)
1716 if os.path.isfile(class_py):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001717 execfile(class_py, dir)
1718 if os.path.isfile(base_tcl):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001719 self.tk.call('source', base_tcl)
1720 if os.path.isfile(base_py):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001721 execfile(base_py, dir)
1722 def report_callback_exception(self, exc, val, tb):
1723 """Internal function. It reports exception on sys.stderr."""
1724 import traceback, sys
1725 sys.stderr.write("Exception in Tkinter callback\n")
1726 sys.last_type = exc
1727 sys.last_value = val
1728 sys.last_traceback = tb
1729 traceback.print_exception(exc, val, tb)
David Aschere2b4b322004-02-18 05:59:53 +00001730 def __getattr__(self, attr):
1731 "Delegate attribute access to the interpreter object"
1732 return getattr(self.tk, attr)
Guido van Rossum18468821994-06-20 07:49:28 +00001733
Guido van Rossum368e06b1997-11-07 20:38:49 +00001734# Ideally, the classes Pack, Place and Grid disappear, the
1735# pack/place/grid methods are defined on the Widget class, and
1736# everybody uses w.pack_whatever(...) instead of Pack.whatever(w,
1737# ...), with pack(), place() and grid() being short for
1738# pack_configure(), place_configure() and grid_columnconfigure(), and
1739# forget() being short for pack_forget(). As a practical matter, I'm
1740# afraid that there is too much code out there that may be using the
1741# Pack, Place or Grid class, so I leave them intact -- but only as
1742# backwards compatibility features. Also note that those methods that
1743# take a master as argument (e.g. pack_propagate) have been moved to
1744# the Misc class (which now incorporates all methods common between
1745# toplevel and interior widgets). Again, for compatibility, these are
1746# copied into the Pack, Place or Grid class.
1747
David Aschere2b4b322004-02-18 05:59:53 +00001748
1749def Tcl(screenName=None, baseName=None, className='Tk', useTk=0):
1750 return Tk(screenName, baseName, className, useTk)
1751
Guido van Rossum18468821994-06-20 07:49:28 +00001752class Pack:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001753 """Geometry manager Pack.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001754
Fredrik Lundh06d28152000-08-09 18:03:12 +00001755 Base class to use the methods pack_* in every widget."""
1756 def pack_configure(self, cnf={}, **kw):
1757 """Pack a widget in the parent widget. Use as options:
1758 after=widget - pack it after you have packed widget
1759 anchor=NSEW (or subset) - position widget according to
1760 given direction
Georg Brandl1a348342008-05-31 18:34:27 +00001761 before=widget - pack it before you will pack widget
Martin v. Löwisbfe175c2003-04-16 19:42:51 +00001762 expand=bool - expand widget if parent size grows
Fredrik Lundh06d28152000-08-09 18:03:12 +00001763 fill=NONE or X or Y or BOTH - fill widget if widget grows
1764 in=master - use master to contain this widget
Georg Brandl1a348342008-05-31 18:34:27 +00001765 in_=master - see 'in' option description
Fredrik Lundh06d28152000-08-09 18:03:12 +00001766 ipadx=amount - add internal padding in x direction
1767 ipady=amount - add internal padding in y direction
1768 padx=amount - add padding in x direction
1769 pady=amount - add padding in y direction
1770 side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
1771 """
1772 self.tk.call(
1773 ('pack', 'configure', self._w)
1774 + self._options(cnf, kw))
1775 pack = configure = config = pack_configure
1776 def pack_forget(self):
1777 """Unmap this widget and do not use it for the packing order."""
1778 self.tk.call('pack', 'forget', self._w)
1779 forget = pack_forget
1780 def pack_info(self):
1781 """Return information about the packing options
1782 for this widget."""
1783 words = self.tk.splitlist(
1784 self.tk.call('pack', 'info', self._w))
1785 dict = {}
1786 for i in range(0, len(words), 2):
1787 key = words[i][1:]
1788 value = words[i+1]
1789 if value[:1] == '.':
1790 value = self._nametowidget(value)
1791 dict[key] = value
1792 return dict
1793 info = pack_info
1794 propagate = pack_propagate = Misc.pack_propagate
1795 slaves = pack_slaves = Misc.pack_slaves
Guido van Rossum18468821994-06-20 07:49:28 +00001796
1797class Place:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001798 """Geometry manager Place.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001799
Fredrik Lundh06d28152000-08-09 18:03:12 +00001800 Base class to use the methods place_* in every widget."""
1801 def place_configure(self, cnf={}, **kw):
1802 """Place a widget in the parent widget. Use as options:
Georg Brandl1a348342008-05-31 18:34:27 +00001803 in=master - master relative to which the widget is placed
1804 in_=master - see 'in' option description
Fredrik Lundh06d28152000-08-09 18:03:12 +00001805 x=amount - locate anchor of this widget at position x of master
1806 y=amount - locate anchor of this widget at position y of master
1807 relx=amount - locate anchor of this widget between 0.0 and 1.0
1808 relative to width of master (1.0 is right edge)
Georg Brandl1a348342008-05-31 18:34:27 +00001809 rely=amount - locate anchor of this widget between 0.0 and 1.0
Fredrik Lundh06d28152000-08-09 18:03:12 +00001810 relative to height of master (1.0 is bottom edge)
Georg Brandl1a348342008-05-31 18:34:27 +00001811 anchor=NSEW (or subset) - position anchor according to given direction
Fredrik Lundh06d28152000-08-09 18:03:12 +00001812 width=amount - width of this widget in pixel
1813 height=amount - height of this widget in pixel
1814 relwidth=amount - width of this widget between 0.0 and 1.0
1815 relative to width of master (1.0 is the same width
Georg Brandl1a348342008-05-31 18:34:27 +00001816 as the master)
1817 relheight=amount - height of this widget between 0.0 and 1.0
Fredrik Lundh06d28152000-08-09 18:03:12 +00001818 relative to height of master (1.0 is the same
Georg Brandl1a348342008-05-31 18:34:27 +00001819 height as the master)
1820 bordermode="inside" or "outside" - whether to take border width of
1821 master widget into account
1822 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00001823 self.tk.call(
1824 ('place', 'configure', self._w)
1825 + self._options(cnf, kw))
1826 place = configure = config = place_configure
1827 def place_forget(self):
1828 """Unmap this widget."""
1829 self.tk.call('place', 'forget', self._w)
1830 forget = place_forget
1831 def place_info(self):
1832 """Return information about the placing options
1833 for this widget."""
1834 words = self.tk.splitlist(
1835 self.tk.call('place', 'info', self._w))
1836 dict = {}
1837 for i in range(0, len(words), 2):
1838 key = words[i][1:]
1839 value = words[i+1]
1840 if value[:1] == '.':
1841 value = self._nametowidget(value)
1842 dict[key] = value
1843 return dict
1844 info = place_info
1845 slaves = place_slaves = Misc.place_slaves
Guido van Rossum18468821994-06-20 07:49:28 +00001846
Guido van Rossum37dcab11996-05-16 16:00:19 +00001847class Grid:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001848 """Geometry manager Grid.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001849
Fredrik Lundh06d28152000-08-09 18:03:12 +00001850 Base class to use the methods grid_* in every widget."""
1851 # Thanks to Masazumi Yoshikawa (yosikawa@isi.edu)
1852 def grid_configure(self, cnf={}, **kw):
1853 """Position a widget in the parent widget in a grid. Use as options:
1854 column=number - use cell identified with given column (starting with 0)
1855 columnspan=number - this widget will span several columns
1856 in=master - use master to contain this widget
Georg Brandl1a348342008-05-31 18:34:27 +00001857 in_=master - see 'in' option description
Fredrik Lundh06d28152000-08-09 18:03:12 +00001858 ipadx=amount - add internal padding in x direction
1859 ipady=amount - add internal padding in y direction
1860 padx=amount - add padding in x direction
1861 pady=amount - add padding in y direction
1862 row=number - use cell identified with given row (starting with 0)
1863 rowspan=number - this widget will span several rows
1864 sticky=NSEW - if cell is larger on which sides will this
1865 widget stick to the cell boundary
1866 """
1867 self.tk.call(
1868 ('grid', 'configure', self._w)
1869 + self._options(cnf, kw))
1870 grid = configure = config = grid_configure
1871 bbox = grid_bbox = Misc.grid_bbox
1872 columnconfigure = grid_columnconfigure = Misc.grid_columnconfigure
1873 def grid_forget(self):
1874 """Unmap this widget."""
1875 self.tk.call('grid', 'forget', self._w)
1876 forget = grid_forget
1877 def grid_remove(self):
1878 """Unmap this widget but remember the grid options."""
1879 self.tk.call('grid', 'remove', self._w)
1880 def grid_info(self):
1881 """Return information about the options
1882 for positioning this widget in a grid."""
1883 words = self.tk.splitlist(
1884 self.tk.call('grid', 'info', self._w))
1885 dict = {}
1886 for i in range(0, len(words), 2):
1887 key = words[i][1:]
1888 value = words[i+1]
1889 if value[:1] == '.':
1890 value = self._nametowidget(value)
1891 dict[key] = value
1892 return dict
1893 info = grid_info
Martin v. Löwisdc579092001-10-13 09:33:51 +00001894 location = grid_location = Misc.grid_location
Fredrik Lundh06d28152000-08-09 18:03:12 +00001895 propagate = grid_propagate = Misc.grid_propagate
1896 rowconfigure = grid_rowconfigure = Misc.grid_rowconfigure
1897 size = grid_size = Misc.grid_size
1898 slaves = grid_slaves = Misc.grid_slaves
Guido van Rossum37dcab11996-05-16 16:00:19 +00001899
Guido van Rossum368e06b1997-11-07 20:38:49 +00001900class BaseWidget(Misc):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001901 """Internal class."""
1902 def _setup(self, master, cnf):
1903 """Internal function. Sets up information about children."""
1904 if _support_default_root:
1905 global _default_root
1906 if not master:
1907 if not _default_root:
1908 _default_root = Tk()
1909 master = _default_root
1910 self.master = master
1911 self.tk = master.tk
1912 name = None
1913 if cnf.has_key('name'):
1914 name = cnf['name']
1915 del cnf['name']
1916 if not name:
Walter Dörwald70a6b492004-02-12 17:35:32 +00001917 name = repr(id(self))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001918 self._name = name
1919 if master._w=='.':
1920 self._w = '.' + name
1921 else:
1922 self._w = master._w + '.' + name
1923 self.children = {}
1924 if self.master.children.has_key(self._name):
1925 self.master.children[self._name].destroy()
1926 self.master.children[self._name] = self
1927 def __init__(self, master, widgetName, cnf={}, kw={}, extra=()):
1928 """Construct a widget with the parent widget MASTER, a name WIDGETNAME
1929 and appropriate options."""
1930 if kw:
1931 cnf = _cnfmerge((cnf, kw))
1932 self.widgetName = widgetName
1933 BaseWidget._setup(self, master, cnf)
1934 classes = []
1935 for k in cnf.keys():
1936 if type(k) is ClassType:
1937 classes.append((k, cnf[k]))
1938 del cnf[k]
1939 self.tk.call(
1940 (widgetName, self._w) + extra + self._options(cnf))
1941 for k, v in classes:
1942 k.configure(self, v)
1943 def destroy(self):
1944 """Destroy this and all descendants widgets."""
1945 for c in self.children.values(): c.destroy()
Martin v. Löwis92733be2006-06-17 09:25:15 +00001946 self.tk.call('destroy', self._w)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001947 if self.master.children.has_key(self._name):
1948 del self.master.children[self._name]
Fredrik Lundh06d28152000-08-09 18:03:12 +00001949 Misc.destroy(self)
1950 def _do(self, name, args=()):
1951 # XXX Obsolete -- better use self.tk.call directly!
1952 return self.tk.call((self._w, name) + args)
Guido van Rossum18468821994-06-20 07:49:28 +00001953
Guido van Rossum368e06b1997-11-07 20:38:49 +00001954class Widget(BaseWidget, Pack, Place, Grid):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001955 """Internal class.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001956
Fredrik Lundh06d28152000-08-09 18:03:12 +00001957 Base class for a widget which can be positioned with the geometry managers
1958 Pack, Place or Grid."""
1959 pass
Guido van Rossum368e06b1997-11-07 20:38:49 +00001960
1961class Toplevel(BaseWidget, Wm):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001962 """Toplevel widget, e.g. for dialogs."""
1963 def __init__(self, master=None, cnf={}, **kw):
1964 """Construct a toplevel widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001965
Fredrik Lundh06d28152000-08-09 18:03:12 +00001966 Valid resource names: background, bd, bg, borderwidth, class,
1967 colormap, container, cursor, height, highlightbackground,
1968 highlightcolor, highlightthickness, menu, relief, screen, takefocus,
1969 use, visual, width."""
1970 if kw:
1971 cnf = _cnfmerge((cnf, kw))
1972 extra = ()
1973 for wmkey in ['screen', 'class_', 'class', 'visual',
1974 'colormap']:
1975 if cnf.has_key(wmkey):
1976 val = cnf[wmkey]
1977 # TBD: a hack needed because some keys
1978 # are not valid as keyword arguments
1979 if wmkey[-1] == '_': opt = '-'+wmkey[:-1]
1980 else: opt = '-'+wmkey
1981 extra = extra + (opt, val)
1982 del cnf[wmkey]
1983 BaseWidget.__init__(self, master, 'toplevel', cnf, {}, extra)
1984 root = self._root()
1985 self.iconname(root.iconname())
1986 self.title(root.title())
1987 self.protocol("WM_DELETE_WINDOW", self.destroy)
Guido van Rossum18468821994-06-20 07:49:28 +00001988
1989class Button(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001990 """Button widget."""
1991 def __init__(self, master=None, cnf={}, **kw):
1992 """Construct a button widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00001993
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001994 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00001995
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001996 activebackground, activeforeground, anchor,
1997 background, bitmap, borderwidth, cursor,
Raymond Hettingerff41c482003-04-06 09:01:11 +00001998 disabledforeground, font, foreground
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001999 highlightbackground, highlightcolor,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002000 highlightthickness, image, justify,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002001 padx, pady, relief, repeatdelay,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002002 repeatinterval, takefocus, text,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002003 textvariable, underline, wraplength
Raymond Hettingerff41c482003-04-06 09:01:11 +00002004
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002005 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002006
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002007 command, compound, default, height,
2008 overrelief, state, width
2009 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002010 Widget.__init__(self, master, 'button', cnf, kw)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002011
Fredrik Lundh06d28152000-08-09 18:03:12 +00002012 def tkButtonEnter(self, *dummy):
2013 self.tk.call('tkButtonEnter', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002014
Fredrik Lundh06d28152000-08-09 18:03:12 +00002015 def tkButtonLeave(self, *dummy):
2016 self.tk.call('tkButtonLeave', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002017
Fredrik Lundh06d28152000-08-09 18:03:12 +00002018 def tkButtonDown(self, *dummy):
2019 self.tk.call('tkButtonDown', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002020
Fredrik Lundh06d28152000-08-09 18:03:12 +00002021 def tkButtonUp(self, *dummy):
2022 self.tk.call('tkButtonUp', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002023
Fredrik Lundh06d28152000-08-09 18:03:12 +00002024 def tkButtonInvoke(self, *dummy):
2025 self.tk.call('tkButtonInvoke', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002026
Fredrik Lundh06d28152000-08-09 18:03:12 +00002027 def flash(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00002028 """Flash the button.
2029
2030 This is accomplished by redisplaying
2031 the button several times, alternating between active and
2032 normal colors. At the end of the flash the button is left
2033 in the same normal/active state as when the command was
2034 invoked. This command is ignored if the button's state is
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002035 disabled.
2036 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002037 self.tk.call(self._w, 'flash')
Raymond Hettingerff41c482003-04-06 09:01:11 +00002038
Fredrik Lundh06d28152000-08-09 18:03:12 +00002039 def invoke(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00002040 """Invoke the command associated with the button.
2041
2042 The return value is the return value from the command,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002043 or an empty string if there is no command associated with
2044 the button. This command is ignored if the button's state
2045 is disabled.
2046 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002047 return self.tk.call(self._w, 'invoke')
Guido van Rossum18468821994-06-20 07:49:28 +00002048
2049# Indices:
Guido van Rossum35f67fb1995-08-04 03:50:29 +00002050# XXX I don't like these -- take them away
Guido van Rossum18468821994-06-20 07:49:28 +00002051def AtEnd():
Fredrik Lundh06d28152000-08-09 18:03:12 +00002052 return 'end'
Guido van Rossum1e9e4001994-06-20 09:09:51 +00002053def AtInsert(*args):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002054 s = 'insert'
2055 for a in args:
2056 if a: s = s + (' ' + a)
2057 return s
Guido van Rossum18468821994-06-20 07:49:28 +00002058def AtSelFirst():
Fredrik Lundh06d28152000-08-09 18:03:12 +00002059 return 'sel.first'
Guido van Rossum18468821994-06-20 07:49:28 +00002060def AtSelLast():
Fredrik Lundh06d28152000-08-09 18:03:12 +00002061 return 'sel.last'
Guido van Rossum18468821994-06-20 07:49:28 +00002062def At(x, y=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002063 if y is None:
Walter Dörwald70a6b492004-02-12 17:35:32 +00002064 return '@%r' % (x,)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002065 else:
Walter Dörwald70a6b492004-02-12 17:35:32 +00002066 return '@%r,%r' % (x, y)
Guido van Rossum18468821994-06-20 07:49:28 +00002067
2068class Canvas(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002069 """Canvas widget to display graphical elements like lines or text."""
2070 def __init__(self, master=None, cnf={}, **kw):
2071 """Construct a canvas widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002072
Fredrik Lundh06d28152000-08-09 18:03:12 +00002073 Valid resource names: background, bd, bg, borderwidth, closeenough,
2074 confine, cursor, height, highlightbackground, highlightcolor,
2075 highlightthickness, insertbackground, insertborderwidth,
2076 insertofftime, insertontime, insertwidth, offset, relief,
2077 scrollregion, selectbackground, selectborderwidth, selectforeground,
2078 state, takefocus, width, xscrollcommand, xscrollincrement,
2079 yscrollcommand, yscrollincrement."""
2080 Widget.__init__(self, master, 'canvas', cnf, kw)
2081 def addtag(self, *args):
2082 """Internal function."""
2083 self.tk.call((self._w, 'addtag') + args)
2084 def addtag_above(self, newtag, tagOrId):
2085 """Add tag NEWTAG to all items above TAGORID."""
2086 self.addtag(newtag, 'above', tagOrId)
2087 def addtag_all(self, newtag):
2088 """Add tag NEWTAG to all items."""
2089 self.addtag(newtag, 'all')
2090 def addtag_below(self, newtag, tagOrId):
2091 """Add tag NEWTAG to all items below TAGORID."""
2092 self.addtag(newtag, 'below', tagOrId)
2093 def addtag_closest(self, newtag, x, y, halo=None, start=None):
2094 """Add tag NEWTAG to item which is closest to pixel at X, Y.
2095 If several match take the top-most.
2096 All items closer than HALO are considered overlapping (all are
2097 closests). If START is specified the next below this tag is taken."""
2098 self.addtag(newtag, 'closest', x, y, halo, start)
2099 def addtag_enclosed(self, newtag, x1, y1, x2, y2):
2100 """Add tag NEWTAG to all items in the rectangle defined
2101 by X1,Y1,X2,Y2."""
2102 self.addtag(newtag, 'enclosed', x1, y1, x2, y2)
2103 def addtag_overlapping(self, newtag, x1, y1, x2, y2):
2104 """Add tag NEWTAG to all items which overlap the rectangle
2105 defined by X1,Y1,X2,Y2."""
2106 self.addtag(newtag, 'overlapping', x1, y1, x2, y2)
2107 def addtag_withtag(self, newtag, tagOrId):
2108 """Add tag NEWTAG to all items with TAGORID."""
2109 self.addtag(newtag, 'withtag', tagOrId)
2110 def bbox(self, *args):
2111 """Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle
2112 which encloses all items with tags specified as arguments."""
2113 return self._getints(
2114 self.tk.call((self._w, 'bbox') + args)) or None
2115 def tag_unbind(self, tagOrId, sequence, funcid=None):
2116 """Unbind for all items with TAGORID for event SEQUENCE the
2117 function identified with FUNCID."""
2118 self.tk.call(self._w, 'bind', tagOrId, sequence, '')
2119 if funcid:
2120 self.deletecommand(funcid)
2121 def tag_bind(self, tagOrId, sequence=None, func=None, add=None):
2122 """Bind to all items with TAGORID at event SEQUENCE a call to function FUNC.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002123
Fredrik Lundh06d28152000-08-09 18:03:12 +00002124 An additional boolean parameter ADD specifies whether FUNC will be
2125 called additionally to the other bound function or whether it will
2126 replace the previous function. See bind for the return value."""
2127 return self._bind((self._w, 'bind', tagOrId),
2128 sequence, func, add)
2129 def canvasx(self, screenx, gridspacing=None):
2130 """Return the canvas x coordinate of pixel position SCREENX rounded
2131 to nearest multiple of GRIDSPACING units."""
2132 return getdouble(self.tk.call(
2133 self._w, 'canvasx', screenx, gridspacing))
2134 def canvasy(self, screeny, gridspacing=None):
2135 """Return the canvas y coordinate of pixel position SCREENY rounded
2136 to nearest multiple of GRIDSPACING units."""
2137 return getdouble(self.tk.call(
2138 self._w, 'canvasy', screeny, gridspacing))
2139 def coords(self, *args):
2140 """Return a list of coordinates for the item given in ARGS."""
2141 # XXX Should use _flatten on args
2142 return map(getdouble,
Guido van Rossum0bd54331998-05-19 21:18:13 +00002143 self.tk.splitlist(
Fredrik Lundh06d28152000-08-09 18:03:12 +00002144 self.tk.call((self._w, 'coords') + args)))
2145 def _create(self, itemType, args, kw): # Args: (val, val, ..., cnf={})
2146 """Internal function."""
2147 args = _flatten(args)
2148 cnf = args[-1]
2149 if type(cnf) in (DictionaryType, TupleType):
2150 args = args[:-1]
2151 else:
2152 cnf = {}
Raymond Hettingerff41c482003-04-06 09:01:11 +00002153 return getint(self.tk.call(
2154 self._w, 'create', itemType,
2155 *(args + self._options(cnf, kw))))
Fredrik Lundh06d28152000-08-09 18:03:12 +00002156 def create_arc(self, *args, **kw):
2157 """Create arc shaped region with coordinates x1,y1,x2,y2."""
2158 return self._create('arc', args, kw)
2159 def create_bitmap(self, *args, **kw):
2160 """Create bitmap with coordinates x1,y1."""
2161 return self._create('bitmap', args, kw)
2162 def create_image(self, *args, **kw):
2163 """Create image item with coordinates x1,y1."""
2164 return self._create('image', args, kw)
2165 def create_line(self, *args, **kw):
2166 """Create line with coordinates x1,y1,...,xn,yn."""
2167 return self._create('line', args, kw)
2168 def create_oval(self, *args, **kw):
2169 """Create oval with coordinates x1,y1,x2,y2."""
2170 return self._create('oval', args, kw)
2171 def create_polygon(self, *args, **kw):
2172 """Create polygon with coordinates x1,y1,...,xn,yn."""
2173 return self._create('polygon', args, kw)
2174 def create_rectangle(self, *args, **kw):
2175 """Create rectangle with coordinates x1,y1,x2,y2."""
2176 return self._create('rectangle', args, kw)
2177 def create_text(self, *args, **kw):
2178 """Create text with coordinates x1,y1."""
2179 return self._create('text', args, kw)
2180 def create_window(self, *args, **kw):
2181 """Create window with coordinates x1,y1,x2,y2."""
2182 return self._create('window', args, kw)
2183 def dchars(self, *args):
2184 """Delete characters of text items identified by tag or id in ARGS (possibly
2185 several times) from FIRST to LAST character (including)."""
2186 self.tk.call((self._w, 'dchars') + args)
2187 def delete(self, *args):
2188 """Delete items identified by all tag or ids contained in ARGS."""
2189 self.tk.call((self._w, 'delete') + args)
2190 def dtag(self, *args):
2191 """Delete tag or id given as last arguments in ARGS from items
2192 identified by first argument in ARGS."""
2193 self.tk.call((self._w, 'dtag') + args)
2194 def find(self, *args):
2195 """Internal function."""
2196 return self._getints(
2197 self.tk.call((self._w, 'find') + args)) or ()
2198 def find_above(self, tagOrId):
2199 """Return items above TAGORID."""
2200 return self.find('above', tagOrId)
2201 def find_all(self):
2202 """Return all items."""
2203 return self.find('all')
2204 def find_below(self, tagOrId):
2205 """Return all items below TAGORID."""
2206 return self.find('below', tagOrId)
2207 def find_closest(self, x, y, halo=None, start=None):
2208 """Return item which is closest to pixel at X, Y.
2209 If several match take the top-most.
2210 All items closer than HALO are considered overlapping (all are
2211 closests). If START is specified the next below this tag is taken."""
2212 return self.find('closest', x, y, halo, start)
2213 def find_enclosed(self, x1, y1, x2, y2):
2214 """Return all items in rectangle defined
2215 by X1,Y1,X2,Y2."""
2216 return self.find('enclosed', x1, y1, x2, y2)
2217 def find_overlapping(self, x1, y1, x2, y2):
2218 """Return all items which overlap the rectangle
2219 defined by X1,Y1,X2,Y2."""
2220 return self.find('overlapping', x1, y1, x2, y2)
2221 def find_withtag(self, tagOrId):
2222 """Return all items with TAGORID."""
2223 return self.find('withtag', tagOrId)
2224 def focus(self, *args):
2225 """Set focus to the first item specified in ARGS."""
2226 return self.tk.call((self._w, 'focus') + args)
2227 def gettags(self, *args):
2228 """Return tags associated with the first item specified in ARGS."""
2229 return self.tk.splitlist(
2230 self.tk.call((self._w, 'gettags') + args))
2231 def icursor(self, *args):
2232 """Set cursor at position POS in the item identified by TAGORID.
2233 In ARGS TAGORID must be first."""
2234 self.tk.call((self._w, 'icursor') + args)
2235 def index(self, *args):
2236 """Return position of cursor as integer in item specified in ARGS."""
2237 return getint(self.tk.call((self._w, 'index') + args))
2238 def insert(self, *args):
2239 """Insert TEXT in item TAGORID at position POS. ARGS must
2240 be TAGORID POS TEXT."""
2241 self.tk.call((self._w, 'insert') + args)
2242 def itemcget(self, tagOrId, option):
2243 """Return the resource value for an OPTION for item TAGORID."""
2244 return self.tk.call(
2245 (self._w, 'itemcget') + (tagOrId, '-'+option))
2246 def itemconfigure(self, tagOrId, cnf=None, **kw):
2247 """Configure resources of an item TAGORID.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002248
Fredrik Lundh06d28152000-08-09 18:03:12 +00002249 The values for resources are specified as keyword
2250 arguments. To get an overview about
2251 the allowed keyword arguments call the method without arguments.
2252 """
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002253 return self._configure(('itemconfigure', tagOrId), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002254 itemconfig = itemconfigure
2255 # lower, tkraise/lift hide Misc.lower, Misc.tkraise/lift,
2256 # so the preferred name for them is tag_lower, tag_raise
2257 # (similar to tag_bind, and similar to the Text widget);
2258 # unfortunately can't delete the old ones yet (maybe in 1.6)
2259 def tag_lower(self, *args):
2260 """Lower an item TAGORID given in ARGS
2261 (optional below another item)."""
2262 self.tk.call((self._w, 'lower') + args)
2263 lower = tag_lower
2264 def move(self, *args):
2265 """Move an item TAGORID given in ARGS."""
2266 self.tk.call((self._w, 'move') + args)
2267 def postscript(self, cnf={}, **kw):
2268 """Print the contents of the canvas to a postscript
2269 file. Valid options: colormap, colormode, file, fontmap,
2270 height, pageanchor, pageheight, pagewidth, pagex, pagey,
2271 rotate, witdh, x, y."""
2272 return self.tk.call((self._w, 'postscript') +
2273 self._options(cnf, kw))
2274 def tag_raise(self, *args):
2275 """Raise an item TAGORID given in ARGS
2276 (optional above another item)."""
2277 self.tk.call((self._w, 'raise') + args)
2278 lift = tkraise = tag_raise
2279 def scale(self, *args):
2280 """Scale item TAGORID with XORIGIN, YORIGIN, XSCALE, YSCALE."""
2281 self.tk.call((self._w, 'scale') + args)
2282 def scan_mark(self, x, y):
2283 """Remember the current X, Y coordinates."""
2284 self.tk.call(self._w, 'scan', 'mark', x, y)
Neal Norwitze931ed52003-01-10 23:24:32 +00002285 def scan_dragto(self, x, y, gain=10):
2286 """Adjust the view of the canvas to GAIN times the
Fredrik Lundh06d28152000-08-09 18:03:12 +00002287 difference between X and Y and the coordinates given in
2288 scan_mark."""
Neal Norwitze931ed52003-01-10 23:24:32 +00002289 self.tk.call(self._w, 'scan', 'dragto', x, y, gain)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002290 def select_adjust(self, tagOrId, index):
2291 """Adjust the end of the selection near the cursor of an item TAGORID to index."""
2292 self.tk.call(self._w, 'select', 'adjust', tagOrId, index)
2293 def select_clear(self):
2294 """Clear the selection if it is in this widget."""
2295 self.tk.call(self._w, 'select', 'clear')
2296 def select_from(self, tagOrId, index):
2297 """Set the fixed end of a selection in item TAGORID to INDEX."""
2298 self.tk.call(self._w, 'select', 'from', tagOrId, index)
2299 def select_item(self):
2300 """Return the item which has the selection."""
Neal Norwitz58b63bf2002-07-23 02:52:58 +00002301 return self.tk.call(self._w, 'select', 'item') or None
Fredrik Lundh06d28152000-08-09 18:03:12 +00002302 def select_to(self, tagOrId, index):
2303 """Set the variable end of a selection in item TAGORID to INDEX."""
2304 self.tk.call(self._w, 'select', 'to', tagOrId, index)
2305 def type(self, tagOrId):
2306 """Return the type of the item TAGORID."""
2307 return self.tk.call(self._w, 'type', tagOrId) or None
2308 def xview(self, *args):
2309 """Query and change horizontal position of the view."""
2310 if not args:
2311 return self._getdoubles(self.tk.call(self._w, 'xview'))
2312 self.tk.call((self._w, 'xview') + args)
2313 def xview_moveto(self, fraction):
2314 """Adjusts the view in the window so that FRACTION of the
2315 total width of the canvas is off-screen to the left."""
2316 self.tk.call(self._w, 'xview', 'moveto', fraction)
2317 def xview_scroll(self, number, what):
2318 """Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2319 self.tk.call(self._w, 'xview', 'scroll', number, what)
2320 def yview(self, *args):
2321 """Query and change vertical position of the view."""
2322 if not args:
2323 return self._getdoubles(self.tk.call(self._w, 'yview'))
2324 self.tk.call((self._w, 'yview') + args)
2325 def yview_moveto(self, fraction):
2326 """Adjusts the view in the window so that FRACTION of the
2327 total height of the canvas is off-screen to the top."""
2328 self.tk.call(self._w, 'yview', 'moveto', fraction)
2329 def yview_scroll(self, number, what):
2330 """Shift the y-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2331 self.tk.call(self._w, 'yview', 'scroll', number, what)
Guido van Rossum18468821994-06-20 07:49:28 +00002332
2333class Checkbutton(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002334 """Checkbutton widget which is either in on- or off-state."""
2335 def __init__(self, master=None, cnf={}, **kw):
2336 """Construct a checkbutton widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002337
Fredrik Lundh06d28152000-08-09 18:03:12 +00002338 Valid resource names: activebackground, activeforeground, anchor,
2339 background, bd, bg, bitmap, borderwidth, command, cursor,
2340 disabledforeground, fg, font, foreground, height,
2341 highlightbackground, highlightcolor, highlightthickness, image,
2342 indicatoron, justify, offvalue, onvalue, padx, pady, relief,
2343 selectcolor, selectimage, state, takefocus, text, textvariable,
2344 underline, variable, width, wraplength."""
2345 Widget.__init__(self, master, 'checkbutton', cnf, kw)
2346 def deselect(self):
2347 """Put the button in off-state."""
2348 self.tk.call(self._w, 'deselect')
2349 def flash(self):
2350 """Flash the button."""
2351 self.tk.call(self._w, 'flash')
2352 def invoke(self):
2353 """Toggle the button and invoke a command if given as resource."""
2354 return self.tk.call(self._w, 'invoke')
2355 def select(self):
2356 """Put the button in on-state."""
2357 self.tk.call(self._w, 'select')
2358 def toggle(self):
2359 """Toggle the button."""
2360 self.tk.call(self._w, 'toggle')
Guido van Rossum18468821994-06-20 07:49:28 +00002361
2362class Entry(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002363 """Entry widget which allows to display simple text."""
2364 def __init__(self, master=None, cnf={}, **kw):
2365 """Construct an entry widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002366
Fredrik Lundh06d28152000-08-09 18:03:12 +00002367 Valid resource names: background, bd, bg, borderwidth, cursor,
2368 exportselection, fg, font, foreground, highlightbackground,
2369 highlightcolor, highlightthickness, insertbackground,
2370 insertborderwidth, insertofftime, insertontime, insertwidth,
2371 invalidcommand, invcmd, justify, relief, selectbackground,
2372 selectborderwidth, selectforeground, show, state, takefocus,
2373 textvariable, validate, validatecommand, vcmd, width,
2374 xscrollcommand."""
2375 Widget.__init__(self, master, 'entry', cnf, kw)
2376 def delete(self, first, last=None):
2377 """Delete text from FIRST to LAST (not included)."""
2378 self.tk.call(self._w, 'delete', first, last)
2379 def get(self):
2380 """Return the text."""
2381 return self.tk.call(self._w, 'get')
2382 def icursor(self, index):
2383 """Insert cursor at INDEX."""
2384 self.tk.call(self._w, 'icursor', index)
2385 def index(self, index):
2386 """Return position of cursor."""
2387 return getint(self.tk.call(
2388 self._w, 'index', index))
2389 def insert(self, index, string):
2390 """Insert STRING at INDEX."""
2391 self.tk.call(self._w, 'insert', index, string)
2392 def scan_mark(self, x):
2393 """Remember the current X, Y coordinates."""
2394 self.tk.call(self._w, 'scan', 'mark', x)
2395 def scan_dragto(self, x):
2396 """Adjust the view of the canvas to 10 times the
2397 difference between X and Y and the coordinates given in
2398 scan_mark."""
2399 self.tk.call(self._w, 'scan', 'dragto', x)
2400 def selection_adjust(self, index):
2401 """Adjust the end of the selection near the cursor to INDEX."""
2402 self.tk.call(self._w, 'selection', 'adjust', index)
2403 select_adjust = selection_adjust
2404 def selection_clear(self):
2405 """Clear the selection if it is in this widget."""
2406 self.tk.call(self._w, 'selection', 'clear')
2407 select_clear = selection_clear
2408 def selection_from(self, index):
2409 """Set the fixed end of a selection to INDEX."""
2410 self.tk.call(self._w, 'selection', 'from', index)
2411 select_from = selection_from
2412 def selection_present(self):
2413 """Return whether the widget has the selection."""
2414 return self.tk.getboolean(
2415 self.tk.call(self._w, 'selection', 'present'))
2416 select_present = selection_present
2417 def selection_range(self, start, end):
2418 """Set the selection from START to END (not included)."""
2419 self.tk.call(self._w, 'selection', 'range', start, end)
2420 select_range = selection_range
2421 def selection_to(self, index):
2422 """Set the variable end of a selection to INDEX."""
2423 self.tk.call(self._w, 'selection', 'to', index)
2424 select_to = selection_to
2425 def xview(self, index):
2426 """Query and change horizontal position of the view."""
2427 self.tk.call(self._w, 'xview', index)
2428 def xview_moveto(self, fraction):
2429 """Adjust the view in the window so that FRACTION of the
2430 total width of the entry is off-screen to the left."""
2431 self.tk.call(self._w, 'xview', 'moveto', fraction)
2432 def xview_scroll(self, number, what):
2433 """Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2434 self.tk.call(self._w, 'xview', 'scroll', number, what)
Guido van Rossum18468821994-06-20 07:49:28 +00002435
2436class Frame(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002437 """Frame widget which may contain other widgets and can have a 3D border."""
2438 def __init__(self, master=None, cnf={}, **kw):
2439 """Construct a frame widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002440
Fredrik Lundh06d28152000-08-09 18:03:12 +00002441 Valid resource names: background, bd, bg, borderwidth, class,
2442 colormap, container, cursor, height, highlightbackground,
2443 highlightcolor, highlightthickness, relief, takefocus, visual, width."""
2444 cnf = _cnfmerge((cnf, kw))
2445 extra = ()
2446 if cnf.has_key('class_'):
2447 extra = ('-class', cnf['class_'])
2448 del cnf['class_']
2449 elif cnf.has_key('class'):
2450 extra = ('-class', cnf['class'])
2451 del cnf['class']
2452 Widget.__init__(self, master, 'frame', cnf, {}, extra)
Guido van Rossum18468821994-06-20 07:49:28 +00002453
2454class Label(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002455 """Label widget which can display text and bitmaps."""
2456 def __init__(self, master=None, cnf={}, **kw):
2457 """Construct a label widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00002458
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002459 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002460
2461 activebackground, activeforeground, anchor,
2462 background, bitmap, borderwidth, cursor,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002463 disabledforeground, font, foreground,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002464 highlightbackground, highlightcolor,
2465 highlightthickness, image, justify,
2466 padx, pady, relief, takefocus, text,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002467 textvariable, underline, wraplength
Raymond Hettingerff41c482003-04-06 09:01:11 +00002468
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002469 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002470
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002471 height, state, width
Raymond Hettingerff41c482003-04-06 09:01:11 +00002472
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002473 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002474 Widget.__init__(self, master, 'label', cnf, kw)
Guido van Rossum761c5ab1995-07-14 15:29:10 +00002475
Guido van Rossum18468821994-06-20 07:49:28 +00002476class Listbox(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002477 """Listbox widget which can display a list of strings."""
2478 def __init__(self, master=None, cnf={}, **kw):
2479 """Construct a listbox widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002480
Fredrik Lundh06d28152000-08-09 18:03:12 +00002481 Valid resource names: background, bd, bg, borderwidth, cursor,
2482 exportselection, fg, font, foreground, height, highlightbackground,
2483 highlightcolor, highlightthickness, relief, selectbackground,
2484 selectborderwidth, selectforeground, selectmode, setgrid, takefocus,
2485 width, xscrollcommand, yscrollcommand, listvariable."""
2486 Widget.__init__(self, master, 'listbox', cnf, kw)
2487 def activate(self, index):
2488 """Activate item identified by INDEX."""
2489 self.tk.call(self._w, 'activate', index)
2490 def bbox(self, *args):
2491 """Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle
2492 which encloses the item identified by index in ARGS."""
2493 return self._getints(
2494 self.tk.call((self._w, 'bbox') + args)) or None
2495 def curselection(self):
2496 """Return list of indices of currently selected item."""
2497 # XXX Ought to apply self._getints()...
2498 return self.tk.splitlist(self.tk.call(
2499 self._w, 'curselection'))
2500 def delete(self, first, last=None):
2501 """Delete items from FIRST to LAST (not included)."""
2502 self.tk.call(self._w, 'delete', first, last)
2503 def get(self, first, last=None):
2504 """Get list of items from FIRST to LAST (not included)."""
2505 if last:
2506 return self.tk.splitlist(self.tk.call(
2507 self._w, 'get', first, last))
2508 else:
2509 return self.tk.call(self._w, 'get', first)
2510 def index(self, index):
2511 """Return index of item identified with INDEX."""
2512 i = self.tk.call(self._w, 'index', index)
2513 if i == 'none': return None
2514 return getint(i)
2515 def insert(self, index, *elements):
2516 """Insert ELEMENTS at INDEX."""
2517 self.tk.call((self._w, 'insert', index) + elements)
2518 def nearest(self, y):
2519 """Get index of item which is nearest to y coordinate Y."""
2520 return getint(self.tk.call(
2521 self._w, 'nearest', y))
2522 def scan_mark(self, x, y):
2523 """Remember the current X, Y coordinates."""
2524 self.tk.call(self._w, 'scan', 'mark', x, y)
2525 def scan_dragto(self, x, y):
2526 """Adjust the view of the listbox to 10 times the
2527 difference between X and Y and the coordinates given in
2528 scan_mark."""
2529 self.tk.call(self._w, 'scan', 'dragto', x, y)
2530 def see(self, index):
2531 """Scroll such that INDEX is visible."""
2532 self.tk.call(self._w, 'see', index)
2533 def selection_anchor(self, index):
2534 """Set the fixed end oft the selection to INDEX."""
2535 self.tk.call(self._w, 'selection', 'anchor', index)
2536 select_anchor = selection_anchor
2537 def selection_clear(self, first, last=None):
2538 """Clear the selection from FIRST to LAST (not included)."""
2539 self.tk.call(self._w,
2540 'selection', 'clear', first, last)
2541 select_clear = selection_clear
2542 def selection_includes(self, index):
2543 """Return 1 if INDEX is part of the selection."""
2544 return self.tk.getboolean(self.tk.call(
2545 self._w, 'selection', 'includes', index))
2546 select_includes = selection_includes
2547 def selection_set(self, first, last=None):
2548 """Set the selection from FIRST to LAST (not included) without
2549 changing the currently selected elements."""
2550 self.tk.call(self._w, 'selection', 'set', first, last)
2551 select_set = selection_set
2552 def size(self):
2553 """Return the number of elements in the listbox."""
2554 return getint(self.tk.call(self._w, 'size'))
2555 def xview(self, *what):
2556 """Query and change horizontal position of the view."""
2557 if not what:
2558 return self._getdoubles(self.tk.call(self._w, 'xview'))
2559 self.tk.call((self._w, 'xview') + what)
2560 def xview_moveto(self, fraction):
2561 """Adjust the view in the window so that FRACTION of the
2562 total width of the entry is off-screen to the left."""
2563 self.tk.call(self._w, 'xview', 'moveto', fraction)
2564 def xview_scroll(self, number, what):
2565 """Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2566 self.tk.call(self._w, 'xview', 'scroll', number, what)
2567 def yview(self, *what):
2568 """Query and change vertical position of the view."""
2569 if not what:
2570 return self._getdoubles(self.tk.call(self._w, 'yview'))
2571 self.tk.call((self._w, 'yview') + what)
2572 def yview_moveto(self, fraction):
2573 """Adjust the view in the window so that FRACTION of the
2574 total width of the entry is off-screen to the top."""
2575 self.tk.call(self._w, 'yview', 'moveto', fraction)
2576 def yview_scroll(self, number, what):
2577 """Shift the y-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2578 self.tk.call(self._w, 'yview', 'scroll', number, what)
Guido van Rossum09f1ad82001-09-05 19:29:56 +00002579 def itemcget(self, index, option):
2580 """Return the resource value for an ITEM and an OPTION."""
2581 return self.tk.call(
2582 (self._w, 'itemcget') + (index, '-'+option))
Guido van Rossuma0adb922001-09-01 18:29:55 +00002583 def itemconfigure(self, index, cnf=None, **kw):
Guido van Rossum09f1ad82001-09-05 19:29:56 +00002584 """Configure resources of an ITEM.
Guido van Rossuma0adb922001-09-01 18:29:55 +00002585
2586 The values for resources are specified as keyword arguments.
2587 To get an overview about the allowed keyword arguments
2588 call the method without arguments.
2589 Valid resource names: background, bg, foreground, fg,
2590 selectbackground, selectforeground."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002591 return self._configure(('itemconfigure', index), cnf, kw)
Guido van Rossuma0adb922001-09-01 18:29:55 +00002592 itemconfig = itemconfigure
Guido van Rossum18468821994-06-20 07:49:28 +00002593
2594class Menu(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002595 """Menu widget which allows to display menu bars, pull-down menus and pop-up menus."""
2596 def __init__(self, master=None, cnf={}, **kw):
2597 """Construct menu widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002598
Fredrik Lundh06d28152000-08-09 18:03:12 +00002599 Valid resource names: activebackground, activeborderwidth,
2600 activeforeground, background, bd, bg, borderwidth, cursor,
2601 disabledforeground, fg, font, foreground, postcommand, relief,
2602 selectcolor, takefocus, tearoff, tearoffcommand, title, type."""
2603 Widget.__init__(self, master, 'menu', cnf, kw)
2604 def tk_bindForTraversal(self):
2605 pass # obsolete since Tk 4.0
2606 def tk_mbPost(self):
2607 self.tk.call('tk_mbPost', self._w)
2608 def tk_mbUnpost(self):
2609 self.tk.call('tk_mbUnpost')
2610 def tk_traverseToMenu(self, char):
2611 self.tk.call('tk_traverseToMenu', self._w, char)
2612 def tk_traverseWithinMenu(self, char):
2613 self.tk.call('tk_traverseWithinMenu', self._w, char)
2614 def tk_getMenuButtons(self):
2615 return self.tk.call('tk_getMenuButtons', self._w)
2616 def tk_nextMenu(self, count):
2617 self.tk.call('tk_nextMenu', count)
2618 def tk_nextMenuEntry(self, count):
2619 self.tk.call('tk_nextMenuEntry', count)
2620 def tk_invokeMenu(self):
2621 self.tk.call('tk_invokeMenu', self._w)
2622 def tk_firstMenu(self):
2623 self.tk.call('tk_firstMenu', self._w)
2624 def tk_mbButtonDown(self):
2625 self.tk.call('tk_mbButtonDown', self._w)
2626 def tk_popup(self, x, y, entry=""):
2627 """Post the menu at position X,Y with entry ENTRY."""
2628 self.tk.call('tk_popup', self._w, x, y, entry)
2629 def activate(self, index):
2630 """Activate entry at INDEX."""
2631 self.tk.call(self._w, 'activate', index)
2632 def add(self, itemType, cnf={}, **kw):
2633 """Internal function."""
2634 self.tk.call((self._w, 'add', itemType) +
2635 self._options(cnf, kw))
2636 def add_cascade(self, cnf={}, **kw):
2637 """Add hierarchical menu item."""
2638 self.add('cascade', cnf or kw)
2639 def add_checkbutton(self, cnf={}, **kw):
2640 """Add checkbutton menu item."""
2641 self.add('checkbutton', cnf or kw)
2642 def add_command(self, cnf={}, **kw):
2643 """Add command menu item."""
2644 self.add('command', cnf or kw)
2645 def add_radiobutton(self, cnf={}, **kw):
2646 """Addd radio menu item."""
2647 self.add('radiobutton', cnf or kw)
2648 def add_separator(self, cnf={}, **kw):
2649 """Add separator."""
2650 self.add('separator', cnf or kw)
2651 def insert(self, index, itemType, cnf={}, **kw):
2652 """Internal function."""
2653 self.tk.call((self._w, 'insert', index, itemType) +
2654 self._options(cnf, kw))
2655 def insert_cascade(self, index, cnf={}, **kw):
2656 """Add hierarchical menu item at INDEX."""
2657 self.insert(index, 'cascade', cnf or kw)
2658 def insert_checkbutton(self, index, cnf={}, **kw):
2659 """Add checkbutton menu item at INDEX."""
2660 self.insert(index, 'checkbutton', cnf or kw)
2661 def insert_command(self, index, cnf={}, **kw):
2662 """Add command menu item at INDEX."""
2663 self.insert(index, 'command', cnf or kw)
2664 def insert_radiobutton(self, index, cnf={}, **kw):
2665 """Addd radio menu item at INDEX."""
2666 self.insert(index, 'radiobutton', cnf or kw)
2667 def insert_separator(self, index, cnf={}, **kw):
2668 """Add separator at INDEX."""
2669 self.insert(index, 'separator', cnf or kw)
2670 def delete(self, index1, index2=None):
2671 """Delete menu items between INDEX1 and INDEX2 (not included)."""
2672 self.tk.call(self._w, 'delete', index1, index2)
2673 def entrycget(self, index, option):
2674 """Return the resource value of an menu item for OPTION at INDEX."""
2675 return self.tk.call(self._w, 'entrycget', index, '-' + option)
2676 def entryconfigure(self, index, cnf=None, **kw):
2677 """Configure a menu item at INDEX."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002678 return self._configure(('entryconfigure', index), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002679 entryconfig = entryconfigure
2680 def index(self, index):
2681 """Return the index of a menu item identified by INDEX."""
2682 i = self.tk.call(self._w, 'index', index)
2683 if i == 'none': return None
2684 return getint(i)
2685 def invoke(self, index):
2686 """Invoke a menu item identified by INDEX and execute
2687 the associated command."""
2688 return self.tk.call(self._w, 'invoke', index)
2689 def post(self, x, y):
2690 """Display a menu at position X,Y."""
2691 self.tk.call(self._w, 'post', x, y)
2692 def type(self, index):
2693 """Return the type of the menu item at INDEX."""
2694 return self.tk.call(self._w, 'type', index)
2695 def unpost(self):
2696 """Unmap a menu."""
2697 self.tk.call(self._w, 'unpost')
2698 def yposition(self, index):
2699 """Return the y-position of the topmost pixel of the menu item at INDEX."""
2700 return getint(self.tk.call(
2701 self._w, 'yposition', index))
Guido van Rossum18468821994-06-20 07:49:28 +00002702
2703class Menubutton(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002704 """Menubutton widget, obsolete since Tk8.0."""
2705 def __init__(self, master=None, cnf={}, **kw):
2706 Widget.__init__(self, master, 'menubutton', cnf, kw)
Guido van Rossum18468821994-06-20 07:49:28 +00002707
2708class Message(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002709 """Message widget to display multiline text. Obsolete since Label does it too."""
2710 def __init__(self, master=None, cnf={}, **kw):
2711 Widget.__init__(self, master, 'message', cnf, kw)
Guido van Rossum18468821994-06-20 07:49:28 +00002712
2713class Radiobutton(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002714 """Radiobutton widget which shows only one of several buttons in on-state."""
2715 def __init__(self, master=None, cnf={}, **kw):
2716 """Construct a radiobutton widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002717
Fredrik Lundh06d28152000-08-09 18:03:12 +00002718 Valid resource names: activebackground, activeforeground, anchor,
2719 background, bd, bg, bitmap, borderwidth, command, cursor,
2720 disabledforeground, fg, font, foreground, height,
2721 highlightbackground, highlightcolor, highlightthickness, image,
2722 indicatoron, justify, padx, pady, relief, selectcolor, selectimage,
2723 state, takefocus, text, textvariable, underline, value, variable,
2724 width, wraplength."""
2725 Widget.__init__(self, master, 'radiobutton', cnf, kw)
2726 def deselect(self):
2727 """Put the button in off-state."""
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002728
Fredrik Lundh06d28152000-08-09 18:03:12 +00002729 self.tk.call(self._w, 'deselect')
2730 def flash(self):
2731 """Flash the button."""
2732 self.tk.call(self._w, 'flash')
2733 def invoke(self):
2734 """Toggle the button and invoke a command if given as resource."""
2735 return self.tk.call(self._w, 'invoke')
2736 def select(self):
2737 """Put the button in on-state."""
2738 self.tk.call(self._w, 'select')
Guido van Rossum18468821994-06-20 07:49:28 +00002739
2740class Scale(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002741 """Scale widget which can display a numerical scale."""
2742 def __init__(self, master=None, cnf={}, **kw):
2743 """Construct a scale widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002744
Fredrik Lundh06d28152000-08-09 18:03:12 +00002745 Valid resource names: activebackground, background, bigincrement, bd,
2746 bg, borderwidth, command, cursor, digits, fg, font, foreground, from,
2747 highlightbackground, highlightcolor, highlightthickness, label,
2748 length, orient, relief, repeatdelay, repeatinterval, resolution,
2749 showvalue, sliderlength, sliderrelief, state, takefocus,
2750 tickinterval, to, troughcolor, variable, width."""
2751 Widget.__init__(self, master, 'scale', cnf, kw)
2752 def get(self):
2753 """Get the current value as integer or float."""
2754 value = self.tk.call(self._w, 'get')
2755 try:
2756 return getint(value)
2757 except ValueError:
2758 return getdouble(value)
2759 def set(self, value):
2760 """Set the value to VALUE."""
2761 self.tk.call(self._w, 'set', value)
2762 def coords(self, value=None):
2763 """Return a tuple (X,Y) of the point along the centerline of the
2764 trough that corresponds to VALUE or the current value if None is
2765 given."""
2766
2767 return self._getints(self.tk.call(self._w, 'coords', value))
2768 def identify(self, x, y):
2769 """Return where the point X,Y lies. Valid return values are "slider",
2770 "though1" and "though2"."""
2771 return self.tk.call(self._w, 'identify', x, y)
Guido van Rossum18468821994-06-20 07:49:28 +00002772
2773class Scrollbar(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002774 """Scrollbar widget which displays a slider at a certain position."""
2775 def __init__(self, master=None, cnf={}, **kw):
2776 """Construct a scrollbar widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002777
Fredrik Lundh06d28152000-08-09 18:03:12 +00002778 Valid resource names: activebackground, activerelief,
2779 background, bd, bg, borderwidth, command, cursor,
2780 elementborderwidth, highlightbackground,
2781 highlightcolor, highlightthickness, jump, orient,
2782 relief, repeatdelay, repeatinterval, takefocus,
2783 troughcolor, width."""
2784 Widget.__init__(self, master, 'scrollbar', cnf, kw)
2785 def activate(self, index):
2786 """Display the element at INDEX with activebackground and activerelief.
2787 INDEX can be "arrow1","slider" or "arrow2"."""
2788 self.tk.call(self._w, 'activate', index)
2789 def delta(self, deltax, deltay):
2790 """Return the fractional change of the scrollbar setting if it
2791 would be moved by DELTAX or DELTAY pixels."""
2792 return getdouble(
2793 self.tk.call(self._w, 'delta', deltax, deltay))
2794 def fraction(self, x, y):
2795 """Return the fractional value which corresponds to a slider
2796 position of X,Y."""
2797 return getdouble(self.tk.call(self._w, 'fraction', x, y))
2798 def identify(self, x, y):
2799 """Return the element under position X,Y as one of
2800 "arrow1","slider","arrow2" or ""."""
2801 return self.tk.call(self._w, 'identify', x, y)
2802 def get(self):
2803 """Return the current fractional values (upper and lower end)
2804 of the slider position."""
2805 return self._getdoubles(self.tk.call(self._w, 'get'))
2806 def set(self, *args):
2807 """Set the fractional values of the slider position (upper and
2808 lower ends as value between 0 and 1)."""
2809 self.tk.call((self._w, 'set') + args)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002810
2811
2812
Guido van Rossum18468821994-06-20 07:49:28 +00002813class Text(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002814 """Text widget which can display text in various forms."""
Fredrik Lundh06d28152000-08-09 18:03:12 +00002815 def __init__(self, master=None, cnf={}, **kw):
2816 """Construct a text widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00002817
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002818 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002819
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002820 background, borderwidth, cursor,
2821 exportselection, font, foreground,
2822 highlightbackground, highlightcolor,
2823 highlightthickness, insertbackground,
2824 insertborderwidth, insertofftime,
2825 insertontime, insertwidth, padx, pady,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002826 relief, selectbackground,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002827 selectborderwidth, selectforeground,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002828 setgrid, takefocus,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002829 xscrollcommand, yscrollcommand,
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002830
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002831 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002832
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002833 autoseparators, height, maxundo,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002834 spacing1, spacing2, spacing3,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002835 state, tabs, undo, width, wrap,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002836
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002837 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002838 Widget.__init__(self, master, 'text', cnf, kw)
2839 def bbox(self, *args):
2840 """Return a tuple of (x,y,width,height) which gives the bounding
2841 box of the visible part of the character at the index in ARGS."""
2842 return self._getints(
2843 self.tk.call((self._w, 'bbox') + args)) or None
2844 def tk_textSelectTo(self, index):
2845 self.tk.call('tk_textSelectTo', self._w, index)
2846 def tk_textBackspace(self):
2847 self.tk.call('tk_textBackspace', self._w)
2848 def tk_textIndexCloser(self, a, b, c):
2849 self.tk.call('tk_textIndexCloser', self._w, a, b, c)
2850 def tk_textResetAnchor(self, index):
2851 self.tk.call('tk_textResetAnchor', self._w, index)
2852 def compare(self, index1, op, index2):
2853 """Return whether between index INDEX1 and index INDEX2 the
2854 relation OP is satisfied. OP is one of <, <=, ==, >=, >, or !=."""
2855 return self.tk.getboolean(self.tk.call(
2856 self._w, 'compare', index1, op, index2))
2857 def debug(self, boolean=None):
2858 """Turn on the internal consistency checks of the B-Tree inside the text
2859 widget according to BOOLEAN."""
2860 return self.tk.getboolean(self.tk.call(
2861 self._w, 'debug', boolean))
2862 def delete(self, index1, index2=None):
2863 """Delete the characters between INDEX1 and INDEX2 (not included)."""
2864 self.tk.call(self._w, 'delete', index1, index2)
2865 def dlineinfo(self, index):
2866 """Return tuple (x,y,width,height,baseline) giving the bounding box
2867 and baseline position of the visible part of the line containing
2868 the character at INDEX."""
2869 return self._getints(self.tk.call(self._w, 'dlineinfo', index))
Guido van Rossum256705b2002-04-23 13:29:43 +00002870 def dump(self, index1, index2=None, command=None, **kw):
2871 """Return the contents of the widget between index1 and index2.
Raymond Hettingerff41c482003-04-06 09:01:11 +00002872
Guido van Rossum256705b2002-04-23 13:29:43 +00002873 The type of contents returned in filtered based on the keyword
2874 parameters; if 'all', 'image', 'mark', 'tag', 'text', or 'window' are
2875 given and true, then the corresponding items are returned. The result
2876 is a list of triples of the form (key, value, index). If none of the
2877 keywords are true then 'all' is used by default.
Raymond Hettingerff41c482003-04-06 09:01:11 +00002878
Guido van Rossum256705b2002-04-23 13:29:43 +00002879 If the 'command' argument is given, it is called once for each element
2880 of the list of triples, with the values of each triple serving as the
2881 arguments to the function. In this case the list is not returned."""
2882 args = []
2883 func_name = None
2884 result = None
2885 if not command:
2886 # Never call the dump command without the -command flag, since the
2887 # output could involve Tcl quoting and would be a pain to parse
2888 # right. Instead just set the command to build a list of triples
2889 # as if we had done the parsing.
2890 result = []
2891 def append_triple(key, value, index, result=result):
2892 result.append((key, value, index))
2893 command = append_triple
2894 try:
2895 if not isinstance(command, str):
2896 func_name = command = self._register(command)
2897 args += ["-command", command]
2898 for key in kw:
2899 if kw[key]: args.append("-" + key)
2900 args.append(index1)
2901 if index2:
2902 args.append(index2)
2903 self.tk.call(self._w, "dump", *args)
2904 return result
2905 finally:
2906 if func_name:
2907 self.deletecommand(func_name)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002908
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002909 ## new in tk8.4
2910 def edit(self, *args):
2911 """Internal method
Raymond Hettingerff41c482003-04-06 09:01:11 +00002912
2913 This method controls the undo mechanism and
2914 the modified flag. The exact behavior of the
2915 command depends on the option argument that
2916 follows the edit argument. The following forms
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002917 of the command are currently supported:
Raymond Hettingerff41c482003-04-06 09:01:11 +00002918
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002919 edit_modified, edit_redo, edit_reset, edit_separator
2920 and edit_undo
Raymond Hettingerff41c482003-04-06 09:01:11 +00002921
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002922 """
2923 return self._getints(
2924 self.tk.call((self._w, 'edit') + args)) or ()
2925
2926 def edit_modified(self, arg=None):
2927 """Get or Set the modified flag
Raymond Hettingerff41c482003-04-06 09:01:11 +00002928
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002929 If arg is not specified, returns the modified
Raymond Hettingerff41c482003-04-06 09:01:11 +00002930 flag of the widget. The insert, delete, edit undo and
2931 edit redo commands or the user can set or clear the
2932 modified flag. If boolean is specified, sets the
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002933 modified flag of the widget to arg.
2934 """
2935 return self.edit("modified", arg)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002936
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002937 def edit_redo(self):
2938 """Redo the last undone edit
Raymond Hettingerff41c482003-04-06 09:01:11 +00002939
2940 When the undo option is true, reapplies the last
2941 undone edits provided no other edits were done since
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002942 then. Generates an error when the redo stack is empty.
2943 Does nothing when the undo option is false.
2944 """
2945 return self.edit("redo")
Raymond Hettingerff41c482003-04-06 09:01:11 +00002946
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002947 def edit_reset(self):
2948 """Clears the undo and redo stacks
2949 """
2950 return self.edit("reset")
Raymond Hettingerff41c482003-04-06 09:01:11 +00002951
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002952 def edit_separator(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00002953 """Inserts a separator (boundary) on the undo stack.
2954
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002955 Does nothing when the undo option is false
2956 """
2957 return self.edit("separator")
Raymond Hettingerff41c482003-04-06 09:01:11 +00002958
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002959 def edit_undo(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00002960 """Undoes the last edit action
2961
2962 If the undo option is true. An edit action is defined
2963 as all the insert and delete commands that are recorded
2964 on the undo stack in between two separators. Generates
2965 an error when the undo stack is empty. Does nothing
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002966 when the undo option is false
2967 """
2968 return self.edit("undo")
Raymond Hettingerff41c482003-04-06 09:01:11 +00002969
Fredrik Lundh06d28152000-08-09 18:03:12 +00002970 def get(self, index1, index2=None):
2971 """Return the text from INDEX1 to INDEX2 (not included)."""
2972 return self.tk.call(self._w, 'get', index1, index2)
2973 # (Image commands are new in 8.0)
2974 def image_cget(self, index, option):
2975 """Return the value of OPTION of an embedded image at INDEX."""
2976 if option[:1] != "-":
2977 option = "-" + option
2978 if option[-1:] == "_":
2979 option = option[:-1]
2980 return self.tk.call(self._w, "image", "cget", index, option)
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002981 def image_configure(self, index, cnf=None, **kw):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002982 """Configure an embedded image at INDEX."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002983 return self._configure(('image', 'configure', index), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002984 def image_create(self, index, cnf={}, **kw):
2985 """Create an embedded image at INDEX."""
Raymond Hettingerff41c482003-04-06 09:01:11 +00002986 return self.tk.call(
2987 self._w, "image", "create", index,
2988 *self._options(cnf, kw))
Fredrik Lundh06d28152000-08-09 18:03:12 +00002989 def image_names(self):
2990 """Return all names of embedded images in this widget."""
2991 return self.tk.call(self._w, "image", "names")
2992 def index(self, index):
2993 """Return the index in the form line.char for INDEX."""
2994 return self.tk.call(self._w, 'index', index)
2995 def insert(self, index, chars, *args):
2996 """Insert CHARS before the characters at INDEX. An additional
2997 tag can be given in ARGS. Additional CHARS and tags can follow in ARGS."""
2998 self.tk.call((self._w, 'insert', index, chars) + args)
2999 def mark_gravity(self, markName, direction=None):
3000 """Change the gravity of a mark MARKNAME to DIRECTION (LEFT or RIGHT).
3001 Return the current value if None is given for DIRECTION."""
3002 return self.tk.call(
3003 (self._w, 'mark', 'gravity', markName, direction))
3004 def mark_names(self):
3005 """Return all mark names."""
3006 return self.tk.splitlist(self.tk.call(
3007 self._w, 'mark', 'names'))
3008 def mark_set(self, markName, index):
3009 """Set mark MARKNAME before the character at INDEX."""
3010 self.tk.call(self._w, 'mark', 'set', markName, index)
3011 def mark_unset(self, *markNames):
3012 """Delete all marks in MARKNAMES."""
3013 self.tk.call((self._w, 'mark', 'unset') + markNames)
3014 def mark_next(self, index):
3015 """Return the name of the next mark after INDEX."""
3016 return self.tk.call(self._w, 'mark', 'next', index) or None
3017 def mark_previous(self, index):
3018 """Return the name of the previous mark before INDEX."""
3019 return self.tk.call(self._w, 'mark', 'previous', index) or None
3020 def scan_mark(self, x, y):
3021 """Remember the current X, Y coordinates."""
3022 self.tk.call(self._w, 'scan', 'mark', x, y)
3023 def scan_dragto(self, x, y):
3024 """Adjust the view of the text to 10 times the
3025 difference between X and Y and the coordinates given in
3026 scan_mark."""
3027 self.tk.call(self._w, 'scan', 'dragto', x, y)
3028 def search(self, pattern, index, stopindex=None,
3029 forwards=None, backwards=None, exact=None,
3030 regexp=None, nocase=None, count=None):
3031 """Search PATTERN beginning from INDEX until STOPINDEX.
3032 Return the index of the first character of a match or an empty string."""
3033 args = [self._w, 'search']
3034 if forwards: args.append('-forwards')
3035 if backwards: args.append('-backwards')
3036 if exact: args.append('-exact')
3037 if regexp: args.append('-regexp')
3038 if nocase: args.append('-nocase')
3039 if count: args.append('-count'); args.append(count)
3040 if pattern[0] == '-': args.append('--')
3041 args.append(pattern)
3042 args.append(index)
3043 if stopindex: args.append(stopindex)
3044 return self.tk.call(tuple(args))
3045 def see(self, index):
3046 """Scroll such that the character at INDEX is visible."""
3047 self.tk.call(self._w, 'see', index)
3048 def tag_add(self, tagName, index1, *args):
3049 """Add tag TAGNAME to all characters between INDEX1 and index2 in ARGS.
3050 Additional pairs of indices may follow in ARGS."""
3051 self.tk.call(
3052 (self._w, 'tag', 'add', tagName, index1) + args)
3053 def tag_unbind(self, tagName, sequence, funcid=None):
3054 """Unbind for all characters with TAGNAME for event SEQUENCE the
3055 function identified with FUNCID."""
3056 self.tk.call(self._w, 'tag', 'bind', tagName, sequence, '')
3057 if funcid:
3058 self.deletecommand(funcid)
3059 def tag_bind(self, tagName, sequence, func, add=None):
3060 """Bind to all characters with TAGNAME at event SEQUENCE a call to function FUNC.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00003061
Fredrik Lundh06d28152000-08-09 18:03:12 +00003062 An additional boolean parameter ADD specifies whether FUNC will be
3063 called additionally to the other bound function or whether it will
3064 replace the previous function. See bind for the return value."""
3065 return self._bind((self._w, 'tag', 'bind', tagName),
3066 sequence, func, add)
3067 def tag_cget(self, tagName, option):
3068 """Return the value of OPTION for tag TAGNAME."""
3069 if option[:1] != '-':
3070 option = '-' + option
3071 if option[-1:] == '_':
3072 option = option[:-1]
3073 return self.tk.call(self._w, 'tag', 'cget', tagName, option)
Martin v. Löwis6ce13152002-10-10 14:36:13 +00003074 def tag_configure(self, tagName, cnf=None, **kw):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003075 """Configure a tag TAGNAME."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00003076 return self._configure(('tag', 'configure', tagName), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00003077 tag_config = tag_configure
3078 def tag_delete(self, *tagNames):
3079 """Delete all tags in TAGNAMES."""
3080 self.tk.call((self._w, 'tag', 'delete') + tagNames)
3081 def tag_lower(self, tagName, belowThis=None):
3082 """Change the priority of tag TAGNAME such that it is lower
3083 than the priority of BELOWTHIS."""
3084 self.tk.call(self._w, 'tag', 'lower', tagName, belowThis)
3085 def tag_names(self, index=None):
3086 """Return a list of all tag names."""
3087 return self.tk.splitlist(
3088 self.tk.call(self._w, 'tag', 'names', index))
3089 def tag_nextrange(self, tagName, index1, index2=None):
3090 """Return a list of start and end index for the first sequence of
3091 characters between INDEX1 and INDEX2 which all have tag TAGNAME.
3092 The text is searched forward from INDEX1."""
3093 return self.tk.splitlist(self.tk.call(
3094 self._w, 'tag', 'nextrange', tagName, index1, index2))
3095 def tag_prevrange(self, tagName, index1, index2=None):
3096 """Return a list of start and end index for the first sequence of
3097 characters between INDEX1 and INDEX2 which all have tag TAGNAME.
3098 The text is searched backwards from INDEX1."""
3099 return self.tk.splitlist(self.tk.call(
3100 self._w, 'tag', 'prevrange', tagName, index1, index2))
3101 def tag_raise(self, tagName, aboveThis=None):
3102 """Change the priority of tag TAGNAME such that it is higher
3103 than the priority of ABOVETHIS."""
3104 self.tk.call(
3105 self._w, 'tag', 'raise', tagName, aboveThis)
3106 def tag_ranges(self, tagName):
3107 """Return a list of ranges of text which have tag TAGNAME."""
3108 return self.tk.splitlist(self.tk.call(
3109 self._w, 'tag', 'ranges', tagName))
3110 def tag_remove(self, tagName, index1, index2=None):
3111 """Remove tag TAGNAME from all characters between INDEX1 and INDEX2."""
3112 self.tk.call(
3113 self._w, 'tag', 'remove', tagName, index1, index2)
3114 def window_cget(self, index, option):
3115 """Return the value of OPTION of an embedded window at INDEX."""
3116 if option[:1] != '-':
3117 option = '-' + option
3118 if option[-1:] == '_':
3119 option = option[:-1]
3120 return self.tk.call(self._w, 'window', 'cget', index, option)
Martin v. Löwis6ce13152002-10-10 14:36:13 +00003121 def window_configure(self, index, cnf=None, **kw):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003122 """Configure an embedded window at INDEX."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00003123 return self._configure(('window', 'configure', index), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00003124 window_config = window_configure
3125 def window_create(self, index, cnf={}, **kw):
3126 """Create a window at INDEX."""
3127 self.tk.call(
3128 (self._w, 'window', 'create', index)
3129 + self._options(cnf, kw))
3130 def window_names(self):
3131 """Return all names of embedded windows in this widget."""
3132 return self.tk.splitlist(
3133 self.tk.call(self._w, 'window', 'names'))
3134 def xview(self, *what):
3135 """Query and change horizontal position of the view."""
3136 if not what:
3137 return self._getdoubles(self.tk.call(self._w, 'xview'))
3138 self.tk.call((self._w, 'xview') + what)
Fredrik Lundh5bd2cd62000-08-09 18:29:51 +00003139 def xview_moveto(self, fraction):
3140 """Adjusts the view in the window so that FRACTION of the
3141 total width of the canvas is off-screen to the left."""
3142 self.tk.call(self._w, 'xview', 'moveto', fraction)
3143 def xview_scroll(self, number, what):
3144 """Shift the x-view according to NUMBER which is measured
3145 in "units" or "pages" (WHAT)."""
3146 self.tk.call(self._w, 'xview', 'scroll', number, what)
Fredrik Lundh8fffa202000-08-09 18:51:01 +00003147 def yview(self, *what):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003148 """Query and change vertical position of the view."""
Fredrik Lundh8fffa202000-08-09 18:51:01 +00003149 if not what:
Fredrik Lundh06d28152000-08-09 18:03:12 +00003150 return self._getdoubles(self.tk.call(self._w, 'yview'))
Fredrik Lundh8fffa202000-08-09 18:51:01 +00003151 self.tk.call((self._w, 'yview') + what)
Fredrik Lundh5bd2cd62000-08-09 18:29:51 +00003152 def yview_moveto(self, fraction):
3153 """Adjusts the view in the window so that FRACTION of the
3154 total height of the canvas is off-screen to the top."""
3155 self.tk.call(self._w, 'yview', 'moveto', fraction)
3156 def yview_scroll(self, number, what):
3157 """Shift the y-view according to NUMBER which is measured
3158 in "units" or "pages" (WHAT)."""
3159 self.tk.call(self._w, 'yview', 'scroll', number, what)
Fredrik Lundh06d28152000-08-09 18:03:12 +00003160 def yview_pickplace(self, *what):
3161 """Obsolete function, use see."""
3162 self.tk.call((self._w, 'yview', '-pickplace') + what)
Guido van Rossum18468821994-06-20 07:49:28 +00003163
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003164
Guido van Rossum28574b51996-10-21 15:16:51 +00003165class _setit:
Fredrik Lundh06d28152000-08-09 18:03:12 +00003166 """Internal class. It wraps the command in the widget OptionMenu."""
3167 def __init__(self, var, value, callback=None):
3168 self.__value = value
3169 self.__var = var
3170 self.__callback = callback
3171 def __call__(self, *args):
3172 self.__var.set(self.__value)
3173 if self.__callback:
Raymond Hettingerff41c482003-04-06 09:01:11 +00003174 self.__callback(self.__value, *args)
Guido van Rossum28574b51996-10-21 15:16:51 +00003175
3176class OptionMenu(Menubutton):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003177 """OptionMenu which allows the user to select a value from a menu."""
3178 def __init__(self, master, variable, value, *values, **kwargs):
3179 """Construct an optionmenu widget with the parent MASTER, with
3180 the resource textvariable set to VARIABLE, the initially selected
3181 value VALUE, the other menu values VALUES and an additional
3182 keyword argument command."""
3183 kw = {"borderwidth": 2, "textvariable": variable,
3184 "indicatoron": 1, "relief": RAISED, "anchor": "c",
3185 "highlightthickness": 2}
3186 Widget.__init__(self, master, "menubutton", kw)
3187 self.widgetName = 'tk_optionMenu'
3188 menu = self.__menu = Menu(self, name="menu", tearoff=0)
3189 self.menuname = menu._w
3190 # 'command' is the only supported keyword
3191 callback = kwargs.get('command')
3192 if kwargs.has_key('command'):
3193 del kwargs['command']
3194 if kwargs:
3195 raise TclError, 'unknown option -'+kwargs.keys()[0]
3196 menu.add_command(label=value,
3197 command=_setit(variable, value, callback))
3198 for v in values:
3199 menu.add_command(label=v,
3200 command=_setit(variable, v, callback))
3201 self["menu"] = menu
Guido van Rossum28574b51996-10-21 15:16:51 +00003202
Fredrik Lundh06d28152000-08-09 18:03:12 +00003203 def __getitem__(self, name):
3204 if name == 'menu':
3205 return self.__menu
3206 return Widget.__getitem__(self, name)
Guido van Rossum28574b51996-10-21 15:16:51 +00003207
Fredrik Lundh06d28152000-08-09 18:03:12 +00003208 def destroy(self):
3209 """Destroy this widget and the associated menu."""
3210 Menubutton.destroy(self)
3211 self.__menu = None
Guido van Rossumbf4d8f91995-09-01 20:35:37 +00003212
Guido van Rossum35f67fb1995-08-04 03:50:29 +00003213class Image:
Fredrik Lundh06d28152000-08-09 18:03:12 +00003214 """Base class for images."""
Martin v. Löwis0d8ce612000-09-08 16:28:30 +00003215 _last_id = 0
Fredrik Lundh06d28152000-08-09 18:03:12 +00003216 def __init__(self, imgtype, name=None, cnf={}, master=None, **kw):
3217 self.name = None
3218 if not master:
3219 master = _default_root
3220 if not master:
3221 raise RuntimeError, 'Too early to create image'
3222 self.tk = master.tk
3223 if not name:
Martin v. Löwis0d8ce612000-09-08 16:28:30 +00003224 Image._last_id += 1
Walter Dörwald70a6b492004-02-12 17:35:32 +00003225 name = "pyimage%r" % (Image._last_id,) # tk itself would use image<x>
Fredrik Lundh06d28152000-08-09 18:03:12 +00003226 # The following is needed for systems where id(x)
3227 # can return a negative number, such as Linux/m68k:
3228 if name[0] == '-': name = '_' + name[1:]
3229 if kw and cnf: cnf = _cnfmerge((cnf, kw))
3230 elif kw: cnf = kw
3231 options = ()
3232 for k, v in cnf.items():
3233 if callable(v):
3234 v = self._register(v)
3235 options = options + ('-'+k, v)
3236 self.tk.call(('image', 'create', imgtype, name,) + options)
3237 self.name = name
3238 def __str__(self): return self.name
3239 def __del__(self):
3240 if self.name:
3241 try:
3242 self.tk.call('image', 'delete', self.name)
3243 except TclError:
3244 # May happen if the root was destroyed
3245 pass
3246 def __setitem__(self, key, value):
3247 self.tk.call(self.name, 'configure', '-'+key, value)
3248 def __getitem__(self, key):
3249 return self.tk.call(self.name, 'configure', '-'+key)
3250 def configure(self, **kw):
3251 """Configure the image."""
3252 res = ()
3253 for k, v in _cnfmerge(kw).items():
3254 if v is not None:
3255 if k[-1] == '_': k = k[:-1]
3256 if callable(v):
3257 v = self._register(v)
3258 res = res + ('-'+k, v)
3259 self.tk.call((self.name, 'config') + res)
3260 config = configure
3261 def height(self):
3262 """Return the height of the image."""
3263 return getint(
3264 self.tk.call('image', 'height', self.name))
3265 def type(self):
3266 """Return the type of the imgage, e.g. "photo" or "bitmap"."""
3267 return self.tk.call('image', 'type', self.name)
3268 def width(self):
3269 """Return the width of the image."""
3270 return getint(
3271 self.tk.call('image', 'width', self.name))
Guido van Rossum35f67fb1995-08-04 03:50:29 +00003272
3273class PhotoImage(Image):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003274 """Widget which can display colored images in GIF, PPM/PGM format."""
3275 def __init__(self, name=None, cnf={}, master=None, **kw):
3276 """Create an image with NAME.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00003277
Fredrik Lundh06d28152000-08-09 18:03:12 +00003278 Valid resource names: data, format, file, gamma, height, palette,
3279 width."""
Raymond Hettingerff41c482003-04-06 09:01:11 +00003280 Image.__init__(self, 'photo', name, cnf, master, **kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00003281 def blank(self):
3282 """Display a transparent image."""
3283 self.tk.call(self.name, 'blank')
3284 def cget(self, option):
3285 """Return the value of OPTION."""
3286 return self.tk.call(self.name, 'cget', '-' + option)
3287 # XXX config
3288 def __getitem__(self, key):
3289 return self.tk.call(self.name, 'cget', '-' + key)
3290 # XXX copy -from, -to, ...?
3291 def copy(self):
3292 """Return a new PhotoImage with the same image as this widget."""
3293 destImage = PhotoImage()
3294 self.tk.call(destImage, 'copy', self.name)
3295 return destImage
3296 def zoom(self,x,y=''):
3297 """Return a new PhotoImage with the same image as this widget
3298 but zoom it with X and Y."""
3299 destImage = PhotoImage()
3300 if y=='': y=x
3301 self.tk.call(destImage, 'copy', self.name, '-zoom',x,y)
3302 return destImage
3303 def subsample(self,x,y=''):
3304 """Return a new PhotoImage based on the same image as this widget
3305 but use only every Xth or Yth pixel."""
3306 destImage = PhotoImage()
3307 if y=='': y=x
3308 self.tk.call(destImage, 'copy', self.name, '-subsample',x,y)
3309 return destImage
3310 def get(self, x, y):
3311 """Return the color (red, green, blue) of the pixel at X,Y."""
3312 return self.tk.call(self.name, 'get', x, y)
3313 def put(self, data, to=None):
3314 """Put row formated colors to image starting from
3315 position TO, e.g. image.put("{red green} {blue yellow}", to=(4,6))"""
3316 args = (self.name, 'put', data)
3317 if to:
3318 if to[0] == '-to':
3319 to = to[1:]
3320 args = args + ('-to',) + tuple(to)
3321 self.tk.call(args)
3322 # XXX read
3323 def write(self, filename, format=None, from_coords=None):
3324 """Write image to file FILENAME in FORMAT starting from
3325 position FROM_COORDS."""
3326 args = (self.name, 'write', filename)
3327 if format:
3328 args = args + ('-format', format)
3329 if from_coords:
3330 args = args + ('-from',) + tuple(from_coords)
3331 self.tk.call(args)
Guido van Rossum35f67fb1995-08-04 03:50:29 +00003332
3333class BitmapImage(Image):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003334 """Widget which can display a bitmap."""
3335 def __init__(self, name=None, cnf={}, master=None, **kw):
3336 """Create a bitmap with NAME.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00003337
Fredrik Lundh06d28152000-08-09 18:03:12 +00003338 Valid resource names: background, data, file, foreground, maskdata, maskfile."""
Raymond Hettingerff41c482003-04-06 09:01:11 +00003339 Image.__init__(self, 'bitmap', name, cnf, master, **kw)
Guido van Rossum35f67fb1995-08-04 03:50:29 +00003340
3341def image_names(): return _default_root.tk.call('image', 'names')
3342def image_types(): return _default_root.tk.call('image', 'types')
3343
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003344
3345class Spinbox(Widget):
3346 """spinbox widget."""
3347 def __init__(self, master=None, cnf={}, **kw):
3348 """Construct a spinbox widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003349
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003350 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003351
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003352 activebackground, background, borderwidth,
3353 cursor, exportselection, font, foreground,
3354 highlightbackground, highlightcolor,
3355 highlightthickness, insertbackground,
3356 insertborderwidth, insertofftime,
Raymond Hettingerff41c482003-04-06 09:01:11 +00003357 insertontime, insertwidth, justify, relief,
3358 repeatdelay, repeatinterval,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003359 selectbackground, selectborderwidth
3360 selectforeground, takefocus, textvariable
3361 xscrollcommand.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003362
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003363 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003364
3365 buttonbackground, buttoncursor,
3366 buttondownrelief, buttonuprelief,
3367 command, disabledbackground,
3368 disabledforeground, format, from,
3369 invalidcommand, increment,
3370 readonlybackground, state, to,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003371 validate, validatecommand values,
3372 width, wrap,
3373 """
3374 Widget.__init__(self, master, 'spinbox', cnf, kw)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003375
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003376 def bbox(self, index):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003377 """Return a tuple of X1,Y1,X2,Y2 coordinates for a
3378 rectangle which encloses the character given by index.
3379
3380 The first two elements of the list give the x and y
3381 coordinates of the upper-left corner of the screen
3382 area covered by the character (in pixels relative
3383 to the widget) and the last two elements give the
3384 width and height of the character, in pixels. The
3385 bounding box may refer to a region outside the
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003386 visible area of the window.
3387 """
3388 return self.tk.call(self._w, 'bbox', index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003389
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003390 def delete(self, first, last=None):
3391 """Delete one or more elements of the spinbox.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003392
3393 First is the index of the first character to delete,
3394 and last is the index of the character just after
3395 the last one to delete. If last isn't specified it
3396 defaults to first+1, i.e. a single character is
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003397 deleted. This command returns an empty string.
3398 """
3399 return self.tk.call(self._w, 'delete', first, last)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003400
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003401 def get(self):
3402 """Returns the spinbox's string"""
3403 return self.tk.call(self._w, 'get')
Raymond Hettingerff41c482003-04-06 09:01:11 +00003404
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003405 def icursor(self, index):
3406 """Alter the position of the insertion cursor.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003407
3408 The insertion cursor will be displayed just before
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003409 the character given by index. Returns an empty string
3410 """
3411 return self.tk.call(self._w, 'icursor', index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003412
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003413 def identify(self, x, y):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003414 """Returns the name of the widget at position x, y
3415
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003416 Return value is one of: none, buttondown, buttonup, entry
3417 """
3418 return self.tk.call(self._w, 'identify', x, y)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003419
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003420 def index(self, index):
3421 """Returns the numerical index corresponding to index
3422 """
3423 return self.tk.call(self._w, 'index', index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003424
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003425 def insert(self, index, s):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003426 """Insert string s at index
3427
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003428 Returns an empty string.
3429 """
3430 return self.tk.call(self._w, 'insert', index, s)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003431
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003432 def invoke(self, element):
3433 """Causes the specified element to be invoked
Raymond Hettingerff41c482003-04-06 09:01:11 +00003434
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003435 The element could be buttondown or buttonup
3436 triggering the action associated with it.
3437 """
3438 return self.tk.call(self._w, 'invoke', element)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003439
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003440 def scan(self, *args):
3441 """Internal function."""
3442 return self._getints(
3443 self.tk.call((self._w, 'scan') + args)) or ()
Raymond Hettingerff41c482003-04-06 09:01:11 +00003444
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003445 def scan_mark(self, x):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003446 """Records x and the current view in the spinbox window;
3447
3448 used in conjunction with later scan dragto commands.
3449 Typically this command is associated with a mouse button
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003450 press in the widget. It returns an empty string.
3451 """
3452 return self.scan("mark", x)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003453
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003454 def scan_dragto(self, x):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003455 """Compute the difference between the given x argument
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003456 and the x argument to the last scan mark command
Raymond Hettingerff41c482003-04-06 09:01:11 +00003457
3458 It then adjusts the view left or right by 10 times the
3459 difference in x-coordinates. This command is typically
3460 associated with mouse motion events in the widget, to
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003461 produce the effect of dragging the spinbox at high speed
3462 through the window. The return value is an empty string.
3463 """
3464 return self.scan("dragto", x)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003465
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003466 def selection(self, *args):
3467 """Internal function."""
3468 return self._getints(
3469 self.tk.call((self._w, 'selection') + args)) or ()
Raymond Hettingerff41c482003-04-06 09:01:11 +00003470
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003471 def selection_adjust(self, index):
3472 """Locate the end of the selection nearest to the character
Raymond Hettingerff41c482003-04-06 09:01:11 +00003473 given by index,
3474
3475 Then adjust that end of the selection to be at index
3476 (i.e including but not going beyond index). The other
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003477 end of the selection is made the anchor point for future
Raymond Hettingerff41c482003-04-06 09:01:11 +00003478 select to commands. If the selection isn't currently in
3479 the spinbox, then a new selection is created to include
3480 the characters between index and the most recent selection
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003481 anchor point, inclusive. Returns an empty string.
3482 """
3483 return self.selection("adjust", index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003484
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003485 def selection_clear(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003486 """Clear the selection
3487
3488 If the selection isn't in this widget then the
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003489 command has no effect. Returns an empty string.
3490 """
3491 return self.selection("clear")
Raymond Hettingerff41c482003-04-06 09:01:11 +00003492
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003493 def selection_element(self, element=None):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003494 """Sets or gets the currently selected element.
3495
3496 If a spinbutton element is specified, it will be
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003497 displayed depressed
3498 """
3499 return self.selection("element", element)
3500
3501###########################################################################
3502
3503class LabelFrame(Widget):
3504 """labelframe widget."""
3505 def __init__(self, master=None, cnf={}, **kw):
3506 """Construct a labelframe widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003507
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003508 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003509
3510 borderwidth, cursor, font, foreground,
3511 highlightbackground, highlightcolor,
3512 highlightthickness, padx, pady, relief,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003513 takefocus, text
Raymond Hettingerff41c482003-04-06 09:01:11 +00003514
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003515 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003516
3517 background, class, colormap, container,
3518 height, labelanchor, labelwidget,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003519 visual, width
3520 """
3521 Widget.__init__(self, master, 'labelframe', cnf, kw)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003522
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003523########################################################################
3524
3525class PanedWindow(Widget):
3526 """panedwindow widget."""
3527 def __init__(self, master=None, cnf={}, **kw):
3528 """Construct a panedwindow widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003529
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003530 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003531
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003532 background, borderwidth, cursor, height,
3533 orient, relief, width
Raymond Hettingerff41c482003-04-06 09:01:11 +00003534
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003535 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003536
3537 handlepad, handlesize, opaqueresize,
3538 sashcursor, sashpad, sashrelief,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003539 sashwidth, showhandle,
3540 """
3541 Widget.__init__(self, master, 'panedwindow', cnf, kw)
3542
3543 def add(self, child, **kw):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003544 """Add a child widget to the panedwindow in a new pane.
3545
3546 The child argument is the name of the child widget
3547 followed by pairs of arguments that specify how to
3548 manage the windows. Options may have any of the values
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003549 accepted by the configure subcommand.
3550 """
3551 self.tk.call((self._w, 'add', child) + self._options(kw))
Raymond Hettingerff41c482003-04-06 09:01:11 +00003552
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003553 def remove(self, child):
3554 """Remove the pane containing child from the panedwindow
Raymond Hettingerff41c482003-04-06 09:01:11 +00003555
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003556 All geometry management options for child will be forgotten.
3557 """
3558 self.tk.call(self._w, 'forget', child)
3559 forget=remove
Raymond Hettingerff41c482003-04-06 09:01:11 +00003560
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003561 def identify(self, x, y):
3562 """Identify the panedwindow component at point x, y
Raymond Hettingerff41c482003-04-06 09:01:11 +00003563
3564 If the point is over a sash or a sash handle, the result
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003565 is a two element list containing the index of the sash or
Raymond Hettingerff41c482003-04-06 09:01:11 +00003566 handle, and a word indicating whether it is over a sash
3567 or a handle, such as {0 sash} or {2 handle}. If the point
3568 is over any other part of the panedwindow, the result is
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003569 an empty list.
3570 """
3571 return self.tk.call(self._w, 'identify', x, y)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003572
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003573 def proxy(self, *args):
3574 """Internal function."""
3575 return self._getints(
Raymond Hettingerff41c482003-04-06 09:01:11 +00003576 self.tk.call((self._w, 'proxy') + args)) or ()
3577
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003578 def proxy_coord(self):
3579 """Return the x and y pair of the most recent proxy location
3580 """
3581 return self.proxy("coord")
Raymond Hettingerff41c482003-04-06 09:01:11 +00003582
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003583 def proxy_forget(self):
3584 """Remove the proxy from the display.
3585 """
3586 return self.proxy("forget")
Raymond Hettingerff41c482003-04-06 09:01:11 +00003587
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003588 def proxy_place(self, x, y):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003589 """Place the proxy at the given x and y coordinates.
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003590 """
3591 return self.proxy("place", x, y)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003592
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003593 def sash(self, *args):
3594 """Internal function."""
3595 return self._getints(
3596 self.tk.call((self._w, 'sash') + args)) or ()
Raymond Hettingerff41c482003-04-06 09:01:11 +00003597
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003598 def sash_coord(self, index):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003599 """Return the current x and y pair for the sash given by index.
3600
3601 Index must be an integer between 0 and 1 less than the
3602 number of panes in the panedwindow. The coordinates given are
3603 those of the top left corner of the region containing the sash.
3604 pathName sash dragto index x y This command computes the
3605 difference between the given coordinates and the coordinates
3606 given to the last sash coord command for the given sash. It then
3607 moves that sash the computed difference. The return value is the
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003608 empty string.
3609 """
3610 return self.sash("coord", index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003611
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003612 def sash_mark(self, index):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003613 """Records x and y for the sash given by index;
3614
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003615 Used in conjunction with later dragto commands to move the sash.
3616 """
3617 return self.sash("mark", index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003618
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003619 def sash_place(self, index, x, y):
3620 """Place the sash given by index at the given coordinates
3621 """
3622 return self.sash("place", index, x, y)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003623
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003624 def panecget(self, child, option):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003625 """Query a management option for window.
3626
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003627 Option may be any value allowed by the paneconfigure subcommand
3628 """
3629 return self.tk.call(
3630 (self._w, 'panecget') + (child, '-'+option))
Raymond Hettingerff41c482003-04-06 09:01:11 +00003631
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003632 def paneconfigure(self, tagOrId, cnf=None, **kw):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003633 """Query or modify the management options for window.
3634
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003635 If no option is specified, returns a list describing all
Raymond Hettingerff41c482003-04-06 09:01:11 +00003636 of the available options for pathName. If option is
3637 specified with no value, then the command returns a list
3638 describing the one named option (this list will be identical
3639 to the corresponding sublist of the value returned if no
3640 option is specified). If one or more option-value pairs are
3641 specified, then the command modifies the given widget
3642 option(s) to have the given value(s); in this case the
3643 command returns an empty string. The following options
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003644 are supported:
Raymond Hettingerff41c482003-04-06 09:01:11 +00003645
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003646 after window
Raymond Hettingerff41c482003-04-06 09:01:11 +00003647 Insert the window after the window specified. window
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003648 should be the name of a window already managed by pathName.
3649 before window
Raymond Hettingerff41c482003-04-06 09:01:11 +00003650 Insert the window before the window specified. window
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003651 should be the name of a window already managed by pathName.
3652 height size
Raymond Hettingerff41c482003-04-06 09:01:11 +00003653 Specify a height for the window. The height will be the
3654 outer dimension of the window including its border, if
3655 any. If size is an empty string, or if -height is not
3656 specified, then the height requested internally by the
3657 window will be used initially; the height may later be
3658 adjusted by the movement of sashes in the panedwindow.
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003659 Size may be any value accepted by Tk_GetPixels.
3660 minsize n
Raymond Hettingerff41c482003-04-06 09:01:11 +00003661 Specifies that the size of the window cannot be made
3662 less than n. This constraint only affects the size of
3663 the widget in the paned dimension -- the x dimension
3664 for horizontal panedwindows, the y dimension for
3665 vertical panedwindows. May be any value accepted by
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003666 Tk_GetPixels.
3667 padx n
Raymond Hettingerff41c482003-04-06 09:01:11 +00003668 Specifies a non-negative value indicating how much
3669 extra space to leave on each side of the window in
3670 the X-direction. The value may have any of the forms
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003671 accepted by Tk_GetPixels.
3672 pady n
3673 Specifies a non-negative value indicating how much
Raymond Hettingerff41c482003-04-06 09:01:11 +00003674 extra space to leave on each side of the window in
3675 the Y-direction. The value may have any of the forms
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003676 accepted by Tk_GetPixels.
3677 sticky style
Raymond Hettingerff41c482003-04-06 09:01:11 +00003678 If a window's pane is larger than the requested
3679 dimensions of the window, this option may be used
3680 to position (or stretch) the window within its pane.
3681 Style is a string that contains zero or more of the
3682 characters n, s, e or w. The string can optionally
3683 contains spaces or commas, but they are ignored. Each
3684 letter refers to a side (north, south, east, or west)
3685 that the window will "stick" to. If both n and s
3686 (or e and w) are specified, the window will be
3687 stretched to fill the entire height (or width) of
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003688 its cavity.
3689 width size
Raymond Hettingerff41c482003-04-06 09:01:11 +00003690 Specify a width for the window. The width will be
3691 the outer dimension of the window including its
3692 border, if any. If size is an empty string, or
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003693 if -width is not specified, then the width requested
Raymond Hettingerff41c482003-04-06 09:01:11 +00003694 internally by the window will be used initially; the
3695 width may later be adjusted by the movement of sashes
3696 in the panedwindow. Size may be any value accepted by
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003697 Tk_GetPixels.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003698
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003699 """
3700 if cnf is None and not kw:
3701 cnf = {}
3702 for x in self.tk.split(
3703 self.tk.call(self._w,
3704 'paneconfigure', tagOrId)):
3705 cnf[x[0][1:]] = (x[0][1:],) + x[1:]
3706 return cnf
3707 if type(cnf) == StringType and not kw:
3708 x = self.tk.split(self.tk.call(
3709 self._w, 'paneconfigure', tagOrId, '-'+cnf))
3710 return (x[0][1:],) + x[1:]
3711 self.tk.call((self._w, 'paneconfigure', tagOrId) +
3712 self._options(cnf, kw))
3713 paneconfig = paneconfigure
3714
3715 def panes(self):
3716 """Returns an ordered list of the child panes."""
3717 return self.tk.call(self._w, 'panes')
3718
Guido van Rossumaec5dc91994-06-27 07:55:12 +00003719######################################################################
3720# Extensions:
3721
3722class Studbutton(Button):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003723 def __init__(self, master=None, cnf={}, **kw):
3724 Widget.__init__(self, master, 'studbutton', cnf, kw)
3725 self.bind('<Any-Enter>', self.tkButtonEnter)
3726 self.bind('<Any-Leave>', self.tkButtonLeave)
3727 self.bind('<1>', self.tkButtonDown)
3728 self.bind('<ButtonRelease-1>', self.tkButtonUp)
Guido van Rossumaec5dc91994-06-27 07:55:12 +00003729
3730class Tributton(Button):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003731 def __init__(self, master=None, cnf={}, **kw):
3732 Widget.__init__(self, master, 'tributton', cnf, kw)
3733 self.bind('<Any-Enter>', self.tkButtonEnter)
3734 self.bind('<Any-Leave>', self.tkButtonLeave)
3735 self.bind('<1>', self.tkButtonDown)
3736 self.bind('<ButtonRelease-1>', self.tkButtonUp)
3737 self['fg'] = self['bg']
3738 self['activebackground'] = self['bg']
Guido van Rossum37dcab11996-05-16 16:00:19 +00003739
Guido van Rossumc417ef81996-08-21 23:38:59 +00003740######################################################################
3741# Test:
3742
3743def _test():
Fredrik Lundh06d28152000-08-09 18:03:12 +00003744 root = Tk()
3745 text = "This is Tcl/Tk version %s" % TclVersion
3746 if TclVersion >= 8.1:
Fredrik Lundh8fffa202000-08-09 18:51:01 +00003747 try:
3748 text = text + unicode("\nThis should be a cedilla: \347",
3749 "iso-8859-1")
3750 except NameError:
3751 pass # no unicode support
Fredrik Lundh06d28152000-08-09 18:03:12 +00003752 label = Label(root, text=text)
3753 label.pack()
3754 test = Button(root, text="Click me!",
3755 command=lambda root=root: root.test.configure(
3756 text="[%s]" % root.test['text']))
3757 test.pack()
3758 root.test = test
3759 quit = Button(root, text="QUIT", command=root.destroy)
3760 quit.pack()
3761 # The following three commands are needed so the window pops
3762 # up on top on Windows...
3763 root.iconify()
3764 root.update()
3765 root.deiconify()
3766 root.mainloop()
Guido van Rossumc417ef81996-08-21 23:38:59 +00003767
3768if __name__ == '__main__':
Fredrik Lundh06d28152000-08-09 18:03:12 +00003769 _test()