blob: e1a7629e3e5f2eb2839f5a9ef28de4e8e475cb5b [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)):
1059 for item in v:
1060 if not isinstance(item, (basestring, int)):
1061 break
1062 else:
1063 v = ' '.join(map(str, v))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001064 res = res + ('-'+k, v)
1065 return res
1066 def nametowidget(self, name):
1067 """Return the Tkinter instance of a widget identified by
1068 its Tcl name NAME."""
1069 w = self
1070 if name[0] == '.':
1071 w = w._root()
1072 name = name[1:]
Fredrik Lundh06d28152000-08-09 18:03:12 +00001073 while name:
Eric S. Raymondfc170b12001-02-09 11:51:27 +00001074 i = name.find('.')
Fredrik Lundh06d28152000-08-09 18:03:12 +00001075 if i >= 0:
1076 name, tail = name[:i], name[i+1:]
1077 else:
1078 tail = ''
1079 w = w.children[name]
1080 name = tail
1081 return w
1082 _nametowidget = nametowidget
1083 def _register(self, func, subst=None, needcleanup=1):
1084 """Return a newly created Tcl function. If this
1085 function is called, the Python function FUNC will
1086 be executed. An optional function SUBST can
1087 be given which will be executed before FUNC."""
1088 f = CallWrapper(func, subst, self).__call__
Walter Dörwald70a6b492004-02-12 17:35:32 +00001089 name = repr(id(f))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001090 try:
1091 func = func.im_func
1092 except AttributeError:
1093 pass
1094 try:
1095 name = name + func.__name__
1096 except AttributeError:
1097 pass
1098 self.tk.createcommand(name, f)
1099 if needcleanup:
1100 if self._tclCommands is None:
1101 self._tclCommands = []
1102 self._tclCommands.append(name)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001103 return name
1104 register = _register
1105 def _root(self):
1106 """Internal function."""
1107 w = self
1108 while w.master: w = w.master
1109 return w
1110 _subst_format = ('%#', '%b', '%f', '%h', '%k',
1111 '%s', '%t', '%w', '%x', '%y',
1112 '%A', '%E', '%K', '%N', '%W', '%T', '%X', '%Y', '%D')
Martin v. Löwisc8718c12001-08-09 16:57:33 +00001113 _subst_format_str = " ".join(_subst_format)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001114 def _substitute(self, *args):
1115 """Internal function."""
1116 if len(args) != len(self._subst_format): return args
1117 getboolean = self.tk.getboolean
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001118
Fredrik Lundh06d28152000-08-09 18:03:12 +00001119 getint = int
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001120 def getint_event(s):
1121 """Tk changed behavior in 8.4.2, returning "??" rather more often."""
1122 try:
1123 return int(s)
1124 except ValueError:
1125 return s
1126
Fredrik Lundh06d28152000-08-09 18:03:12 +00001127 nsign, b, f, h, k, s, t, w, x, y, A, E, K, N, W, T, X, Y, D = args
1128 # Missing: (a, c, d, m, o, v, B, R)
1129 e = Event()
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001130 # serial field: valid vor all events
1131 # number of button: ButtonPress and ButtonRelease events only
1132 # height field: Configure, ConfigureRequest, Create,
1133 # ResizeRequest, and Expose events only
1134 # keycode field: KeyPress and KeyRelease events only
1135 # time field: "valid for events that contain a time field"
1136 # width field: Configure, ConfigureRequest, Create, ResizeRequest,
1137 # and Expose events only
1138 # x field: "valid for events that contain a x field"
1139 # y field: "valid for events that contain a y field"
1140 # keysym as decimal: KeyPress and KeyRelease events only
1141 # x_root, y_root fields: ButtonPress, ButtonRelease, KeyPress,
1142 # KeyRelease,and Motion events
Fredrik Lundh06d28152000-08-09 18:03:12 +00001143 e.serial = getint(nsign)
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001144 e.num = getint_event(b)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001145 try: e.focus = getboolean(f)
1146 except TclError: pass
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001147 e.height = getint_event(h)
1148 e.keycode = getint_event(k)
1149 e.state = getint_event(s)
1150 e.time = getint_event(t)
1151 e.width = getint_event(w)
1152 e.x = getint_event(x)
1153 e.y = getint_event(y)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001154 e.char = A
1155 try: e.send_event = getboolean(E)
1156 except TclError: pass
1157 e.keysym = K
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001158 e.keysym_num = getint_event(N)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001159 e.type = T
1160 try:
1161 e.widget = self._nametowidget(W)
1162 except KeyError:
1163 e.widget = W
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001164 e.x_root = getint_event(X)
1165 e.y_root = getint_event(Y)
Fredrik Lundha249f162000-09-07 15:05:09 +00001166 try:
1167 e.delta = getint(D)
1168 except ValueError:
1169 e.delta = 0
Fredrik Lundh06d28152000-08-09 18:03:12 +00001170 return (e,)
1171 def _report_exception(self):
1172 """Internal function."""
1173 import sys
1174 exc, val, tb = sys.exc_type, sys.exc_value, sys.exc_traceback
1175 root = self._root()
1176 root.report_callback_exception(exc, val, tb)
Martin v. Löwis6ce13152002-10-10 14:36:13 +00001177 def _configure(self, cmd, cnf, kw):
1178 """Internal function."""
1179 if kw:
1180 cnf = _cnfmerge((cnf, kw))
1181 elif cnf:
1182 cnf = _cnfmerge(cnf)
1183 if cnf is None:
1184 cnf = {}
1185 for x in self.tk.split(
1186 self.tk.call(_flatten((self._w, cmd)))):
1187 cnf[x[0][1:]] = (x[0][1:],) + x[1:]
1188 return cnf
1189 if type(cnf) is StringType:
1190 x = self.tk.split(
1191 self.tk.call(_flatten((self._w, cmd, '-'+cnf))))
1192 return (x[0][1:],) + x[1:]
1193 self.tk.call(_flatten((self._w, cmd)) + self._options(cnf))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001194 # These used to be defined in Widget:
1195 def configure(self, cnf=None, **kw):
1196 """Configure resources of a widget.
Barry Warsaw107e6231998-12-15 00:44:15 +00001197
Fredrik Lundh06d28152000-08-09 18:03:12 +00001198 The values for resources are specified as keyword
1199 arguments. To get an overview about
1200 the allowed keyword arguments call the method keys.
1201 """
Martin v. Löwis6ce13152002-10-10 14:36:13 +00001202 return self._configure('configure', cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001203 config = configure
1204 def cget(self, key):
1205 """Return the resource value for a KEY given as string."""
1206 return self.tk.call(self._w, 'cget', '-' + key)
1207 __getitem__ = cget
1208 def __setitem__(self, key, value):
1209 self.configure({key: value})
1210 def keys(self):
1211 """Return a list of all resource names of this widget."""
1212 return map(lambda x: x[0][1:],
1213 self.tk.split(self.tk.call(self._w, 'configure')))
1214 def __str__(self):
1215 """Return the window path name of this widget."""
1216 return self._w
1217 # Pack methods that apply to the master
1218 _noarg_ = ['_noarg_']
1219 def pack_propagate(self, flag=_noarg_):
1220 """Set or get the status for propagation of geometry information.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001221
Fredrik Lundh06d28152000-08-09 18:03:12 +00001222 A boolean argument specifies whether the geometry information
1223 of the slaves will determine the size of this widget. If no argument
1224 is given the current setting will be returned.
1225 """
1226 if flag is Misc._noarg_:
1227 return self._getboolean(self.tk.call(
1228 'pack', 'propagate', self._w))
1229 else:
1230 self.tk.call('pack', 'propagate', self._w, flag)
1231 propagate = pack_propagate
1232 def pack_slaves(self):
1233 """Return a list of all slaves of this widget
1234 in its packing order."""
1235 return map(self._nametowidget,
1236 self.tk.splitlist(
1237 self.tk.call('pack', 'slaves', self._w)))
1238 slaves = pack_slaves
1239 # Place method that applies to the master
1240 def place_slaves(self):
1241 """Return a list of all slaves of this widget
1242 in its packing order."""
1243 return map(self._nametowidget,
1244 self.tk.splitlist(
1245 self.tk.call(
1246 'place', 'slaves', self._w)))
1247 # Grid methods that apply to the master
1248 def grid_bbox(self, column=None, row=None, col2=None, row2=None):
1249 """Return a tuple of integer coordinates for the bounding
1250 box of this widget controlled by the geometry manager grid.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001251
Fredrik Lundh06d28152000-08-09 18:03:12 +00001252 If COLUMN, ROW is given the bounding box applies from
1253 the cell with row and column 0 to the specified
1254 cell. If COL2 and ROW2 are given the bounding box
1255 starts at that cell.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001256
Fredrik Lundh06d28152000-08-09 18:03:12 +00001257 The returned integers specify the offset of the upper left
1258 corner in the master widget and the width and height.
1259 """
1260 args = ('grid', 'bbox', self._w)
1261 if column is not None and row is not None:
1262 args = args + (column, row)
1263 if col2 is not None and row2 is not None:
1264 args = args + (col2, row2)
Raymond Hettingerff41c482003-04-06 09:01:11 +00001265 return self._getints(self.tk.call(*args)) or None
Guido van Rossum18468821994-06-20 07:49:28 +00001266
Fredrik Lundh06d28152000-08-09 18:03:12 +00001267 bbox = grid_bbox
1268 def _grid_configure(self, command, index, cnf, kw):
1269 """Internal function."""
1270 if type(cnf) is StringType and not kw:
1271 if cnf[-1:] == '_':
1272 cnf = cnf[:-1]
1273 if cnf[:1] != '-':
1274 cnf = '-'+cnf
1275 options = (cnf,)
1276 else:
1277 options = self._options(cnf, kw)
1278 if not options:
1279 res = self.tk.call('grid',
1280 command, self._w, index)
1281 words = self.tk.splitlist(res)
1282 dict = {}
1283 for i in range(0, len(words), 2):
1284 key = words[i][1:]
1285 value = words[i+1]
1286 if not value:
1287 value = None
1288 elif '.' in value:
1289 value = getdouble(value)
1290 else:
1291 value = getint(value)
1292 dict[key] = value
1293 return dict
1294 res = self.tk.call(
1295 ('grid', command, self._w, index)
1296 + options)
1297 if len(options) == 1:
1298 if not res: return None
1299 # In Tk 7.5, -width can be a float
1300 if '.' in res: return getdouble(res)
1301 return getint(res)
1302 def grid_columnconfigure(self, index, cnf={}, **kw):
1303 """Configure column INDEX of a grid.
Guido van Rossum80f8be81997-12-02 19:51:39 +00001304
Fredrik Lundh06d28152000-08-09 18:03:12 +00001305 Valid resources are minsize (minimum size of the column),
1306 weight (how much does additional space propagate to this column)
1307 and pad (how much space to let additionally)."""
1308 return self._grid_configure('columnconfigure', index, cnf, kw)
1309 columnconfigure = grid_columnconfigure
Martin v. Löwisdc579092001-10-13 09:33:51 +00001310 def grid_location(self, x, y):
1311 """Return a tuple of column and row which identify the cell
1312 at which the pixel at position X and Y inside the master
1313 widget is located."""
1314 return self._getints(
1315 self.tk.call(
1316 'grid', 'location', self._w, x, y)) or None
Fredrik Lundh06d28152000-08-09 18:03:12 +00001317 def grid_propagate(self, flag=_noarg_):
1318 """Set or get the status for propagation of geometry information.
Guido van Rossum80f8be81997-12-02 19:51:39 +00001319
Fredrik Lundh06d28152000-08-09 18:03:12 +00001320 A boolean argument specifies whether the geometry information
1321 of the slaves will determine the size of this widget. If no argument
1322 is given, the current setting will be returned.
1323 """
1324 if flag is Misc._noarg_:
1325 return self._getboolean(self.tk.call(
1326 'grid', 'propagate', self._w))
1327 else:
1328 self.tk.call('grid', 'propagate', self._w, flag)
1329 def grid_rowconfigure(self, index, cnf={}, **kw):
1330 """Configure row INDEX of a grid.
Guido van Rossum80f8be81997-12-02 19:51:39 +00001331
Fredrik Lundh06d28152000-08-09 18:03:12 +00001332 Valid resources are minsize (minimum size of the row),
1333 weight (how much does additional space propagate to this row)
1334 and pad (how much space to let additionally)."""
1335 return self._grid_configure('rowconfigure', index, cnf, kw)
1336 rowconfigure = grid_rowconfigure
1337 def grid_size(self):
1338 """Return a tuple of the number of column and rows in the grid."""
1339 return self._getints(
1340 self.tk.call('grid', 'size', self._w)) or None
1341 size = grid_size
1342 def grid_slaves(self, row=None, column=None):
1343 """Return a list of all slaves of this widget
1344 in its packing order."""
1345 args = ()
1346 if row is not None:
1347 args = args + ('-row', row)
1348 if column is not None:
1349 args = args + ('-column', column)
1350 return map(self._nametowidget,
1351 self.tk.splitlist(self.tk.call(
1352 ('grid', 'slaves', self._w) + args)))
Guido van Rossum80f8be81997-12-02 19:51:39 +00001353
Fredrik Lundh06d28152000-08-09 18:03:12 +00001354 # Support for the "event" command, new in Tk 4.2.
1355 # By Case Roole.
Guido van Rossum80f8be81997-12-02 19:51:39 +00001356
Fredrik Lundh06d28152000-08-09 18:03:12 +00001357 def event_add(self, virtual, *sequences):
1358 """Bind a virtual event VIRTUAL (of the form <<Name>>)
1359 to an event SEQUENCE such that the virtual event is triggered
1360 whenever SEQUENCE occurs."""
1361 args = ('event', 'add', virtual) + sequences
1362 self.tk.call(args)
Guido van Rossumc2966511998-04-10 19:16:10 +00001363
Fredrik Lundh06d28152000-08-09 18:03:12 +00001364 def event_delete(self, virtual, *sequences):
1365 """Unbind a virtual event VIRTUAL from SEQUENCE."""
1366 args = ('event', 'delete', virtual) + sequences
1367 self.tk.call(args)
Guido van Rossumc2966511998-04-10 19:16:10 +00001368
Fredrik Lundh06d28152000-08-09 18:03:12 +00001369 def event_generate(self, sequence, **kw):
1370 """Generate an event SEQUENCE. Additional
1371 keyword arguments specify parameter of the event
1372 (e.g. x, y, rootx, rooty)."""
1373 args = ('event', 'generate', self._w, sequence)
1374 for k, v in kw.items():
1375 args = args + ('-%s' % k, str(v))
1376 self.tk.call(args)
1377
1378 def event_info(self, virtual=None):
1379 """Return a list of all virtual events or the information
1380 about the SEQUENCE bound to the virtual event VIRTUAL."""
1381 return self.tk.splitlist(
1382 self.tk.call('event', 'info', virtual))
1383
1384 # Image related commands
1385
1386 def image_names(self):
1387 """Return a list of all existing image names."""
1388 return self.tk.call('image', 'names')
1389
1390 def image_types(self):
1391 """Return a list of all available image types (e.g. phote bitmap)."""
1392 return self.tk.call('image', 'types')
Guido van Rossumc2966511998-04-10 19:16:10 +00001393
Guido van Rossum80f8be81997-12-02 19:51:39 +00001394
Guido van Rossuma5773dd1995-09-07 19:22:00 +00001395class CallWrapper:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001396 """Internal class. Stores function to call when some user
1397 defined Tcl function is called e.g. after an event occurred."""
1398 def __init__(self, func, subst, widget):
1399 """Store FUNC, SUBST and WIDGET as members."""
1400 self.func = func
1401 self.subst = subst
1402 self.widget = widget
1403 def __call__(self, *args):
1404 """Apply first function SUBST to arguments, than FUNC."""
1405 try:
1406 if self.subst:
Raymond Hettingerff41c482003-04-06 09:01:11 +00001407 args = self.subst(*args)
1408 return self.func(*args)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001409 except SystemExit, msg:
1410 raise SystemExit, msg
1411 except:
1412 self.widget._report_exception()
Guido van Rossum18468821994-06-20 07:49:28 +00001413
Guido van Rossume365a591998-05-01 19:48:20 +00001414
Guido van Rossum18468821994-06-20 07:49:28 +00001415class Wm:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001416 """Provides functions for the communication with the window manager."""
Raymond Hettingerff41c482003-04-06 09:01:11 +00001417
Fredrik Lundh06d28152000-08-09 18:03:12 +00001418 def wm_aspect(self,
1419 minNumer=None, minDenom=None,
1420 maxNumer=None, maxDenom=None):
1421 """Instruct the window manager to set the aspect ratio (width/height)
1422 of this widget to be between MINNUMER/MINDENOM and MAXNUMER/MAXDENOM. Return a tuple
1423 of the actual values if no argument is given."""
1424 return self._getints(
1425 self.tk.call('wm', 'aspect', self._w,
1426 minNumer, minDenom,
1427 maxNumer, maxDenom))
1428 aspect = wm_aspect
Raymond Hettingerff41c482003-04-06 09:01:11 +00001429
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001430 def wm_attributes(self, *args):
1431 """This subcommand returns or sets platform specific attributes
Raymond Hettingerff41c482003-04-06 09:01:11 +00001432
1433 The first form returns a list of the platform specific flags and
1434 their values. The second form returns the value for the specific
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001435 option. The third form sets one or more of the values. The values
1436 are as follows:
Raymond Hettingerff41c482003-04-06 09:01:11 +00001437
1438 On Windows, -disabled gets or sets whether the window is in a
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001439 disabled state. -toolwindow gets or sets the style of the window
Raymond Hettingerff41c482003-04-06 09:01:11 +00001440 to toolwindow (as defined in the MSDN). -topmost gets or sets
1441 whether this is a topmost window (displays above all other
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001442 windows).
Raymond Hettingerff41c482003-04-06 09:01:11 +00001443
1444 On Macintosh, XXXXX
1445
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001446 On Unix, there are currently no special attribute values.
1447 """
1448 args = ('wm', 'attributes', self._w) + args
1449 return self.tk.call(args)
1450 attributes=wm_attributes
Raymond Hettingerff41c482003-04-06 09:01:11 +00001451
Fredrik Lundh06d28152000-08-09 18:03:12 +00001452 def wm_client(self, name=None):
1453 """Store NAME in WM_CLIENT_MACHINE property of this widget. Return
1454 current value."""
1455 return self.tk.call('wm', 'client', self._w, name)
1456 client = wm_client
1457 def wm_colormapwindows(self, *wlist):
1458 """Store list of window names (WLIST) into WM_COLORMAPWINDOWS property
1459 of this widget. This list contains windows whose colormaps differ from their
1460 parents. Return current list of widgets if WLIST is empty."""
1461 if len(wlist) > 1:
1462 wlist = (wlist,) # Tk needs a list of windows here
1463 args = ('wm', 'colormapwindows', self._w) + wlist
1464 return map(self._nametowidget, self.tk.call(args))
1465 colormapwindows = wm_colormapwindows
1466 def wm_command(self, value=None):
1467 """Store VALUE in WM_COMMAND property. It is the command
1468 which shall be used to invoke the application. Return current
1469 command if VALUE is None."""
1470 return self.tk.call('wm', 'command', self._w, value)
1471 command = wm_command
1472 def wm_deiconify(self):
1473 """Deiconify this widget. If it was never mapped it will not be mapped.
1474 On Windows it will raise this widget and give it the focus."""
1475 return self.tk.call('wm', 'deiconify', self._w)
1476 deiconify = wm_deiconify
1477 def wm_focusmodel(self, model=None):
1478 """Set focus model to MODEL. "active" means that this widget will claim
1479 the focus itself, "passive" means that the window manager shall give
1480 the focus. Return current focus model if MODEL is None."""
1481 return self.tk.call('wm', 'focusmodel', self._w, model)
1482 focusmodel = wm_focusmodel
1483 def wm_frame(self):
1484 """Return identifier for decorative frame of this widget if present."""
1485 return self.tk.call('wm', 'frame', self._w)
1486 frame = wm_frame
1487 def wm_geometry(self, newGeometry=None):
1488 """Set geometry to NEWGEOMETRY of the form =widthxheight+x+y. Return
1489 current value if None is given."""
1490 return self.tk.call('wm', 'geometry', self._w, newGeometry)
1491 geometry = wm_geometry
1492 def wm_grid(self,
1493 baseWidth=None, baseHeight=None,
1494 widthInc=None, heightInc=None):
1495 """Instruct the window manager that this widget shall only be
1496 resized on grid boundaries. WIDTHINC and HEIGHTINC are the width and
1497 height of a grid unit in pixels. BASEWIDTH and BASEHEIGHT are the
1498 number of grid units requested in Tk_GeometryRequest."""
1499 return self._getints(self.tk.call(
1500 'wm', 'grid', self._w,
1501 baseWidth, baseHeight, widthInc, heightInc))
1502 grid = wm_grid
1503 def wm_group(self, pathName=None):
1504 """Set the group leader widgets for related widgets to PATHNAME. Return
1505 the group leader of this widget if None is given."""
1506 return self.tk.call('wm', 'group', self._w, pathName)
1507 group = wm_group
Martin v. Löwis5ecad9c2006-06-17 09:20:41 +00001508 def wm_iconbitmap(self, bitmap=None, default=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001509 """Set bitmap for the iconified widget to BITMAP. Return
Martin v. Löwis5ecad9c2006-06-17 09:20:41 +00001510 the bitmap if None is given.
1511
Tim Peters43bc3782006-06-19 07:45:16 +00001512 Under Windows, the DEFAULT parameter can be used to set the icon
Martin v. Löwis5ecad9c2006-06-17 09:20:41 +00001513 for the widget and any descendents that don't have an icon set
Neal Norwitz210262c2006-06-17 22:37:45 +00001514 explicitly. DEFAULT can be the relative path to a .ico file
Martin v. Löwis5ecad9c2006-06-17 09:20:41 +00001515 (example: root.iconbitmap(default='myicon.ico') ). See Tk
1516 documentation for more information."""
1517 if default:
1518 return self.tk.call('wm', 'iconbitmap', self._w, '-default', default)
1519 else:
1520 return self.tk.call('wm', 'iconbitmap', self._w, bitmap)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001521 iconbitmap = wm_iconbitmap
1522 def wm_iconify(self):
1523 """Display widget as icon."""
1524 return self.tk.call('wm', 'iconify', self._w)
1525 iconify = wm_iconify
1526 def wm_iconmask(self, bitmap=None):
1527 """Set mask for the icon bitmap of this widget. Return the
1528 mask if None is given."""
1529 return self.tk.call('wm', 'iconmask', self._w, bitmap)
1530 iconmask = wm_iconmask
1531 def wm_iconname(self, newName=None):
1532 """Set the name of the icon for this widget. Return the name if
1533 None is given."""
1534 return self.tk.call('wm', 'iconname', self._w, newName)
1535 iconname = wm_iconname
1536 def wm_iconposition(self, x=None, y=None):
1537 """Set the position of the icon of this widget to X and Y. Return
1538 a tuple of the current values of X and X if None is given."""
1539 return self._getints(self.tk.call(
1540 'wm', 'iconposition', self._w, x, y))
1541 iconposition = wm_iconposition
1542 def wm_iconwindow(self, pathName=None):
1543 """Set widget PATHNAME to be displayed instead of icon. Return the current
1544 value if None is given."""
1545 return self.tk.call('wm', 'iconwindow', self._w, pathName)
1546 iconwindow = wm_iconwindow
1547 def wm_maxsize(self, width=None, height=None):
1548 """Set max WIDTH and HEIGHT for this widget. If the window is gridded
1549 the values are given in grid units. Return the current values if None
1550 is given."""
1551 return self._getints(self.tk.call(
1552 'wm', 'maxsize', self._w, width, height))
1553 maxsize = wm_maxsize
1554 def wm_minsize(self, width=None, height=None):
1555 """Set min WIDTH and HEIGHT for this widget. If the window is gridded
1556 the values are given in grid units. Return the current values if None
1557 is given."""
1558 return self._getints(self.tk.call(
1559 'wm', 'minsize', self._w, width, height))
1560 minsize = wm_minsize
1561 def wm_overrideredirect(self, boolean=None):
1562 """Instruct the window manager to ignore this widget
1563 if BOOLEAN is given with 1. Return the current value if None
1564 is given."""
1565 return self._getboolean(self.tk.call(
1566 'wm', 'overrideredirect', self._w, boolean))
1567 overrideredirect = wm_overrideredirect
1568 def wm_positionfrom(self, who=None):
1569 """Instruct the window manager that the position of this widget shall
1570 be defined by the user if WHO is "user", and by its own policy if WHO is
1571 "program"."""
1572 return self.tk.call('wm', 'positionfrom', self._w, who)
1573 positionfrom = wm_positionfrom
1574 def wm_protocol(self, name=None, func=None):
1575 """Bind function FUNC to command NAME for this widget.
1576 Return the function bound to NAME if None is given. NAME could be
1577 e.g. "WM_SAVE_YOURSELF" or "WM_DELETE_WINDOW"."""
1578 if callable(func):
1579 command = self._register(func)
1580 else:
1581 command = func
1582 return self.tk.call(
1583 'wm', 'protocol', self._w, name, command)
1584 protocol = wm_protocol
1585 def wm_resizable(self, width=None, height=None):
1586 """Instruct the window manager whether this width can be resized
1587 in WIDTH or HEIGHT. Both values are boolean values."""
1588 return self.tk.call('wm', 'resizable', self._w, width, height)
1589 resizable = wm_resizable
1590 def wm_sizefrom(self, who=None):
1591 """Instruct the window manager that the size of this widget shall
1592 be defined by the user if WHO is "user", and by its own policy if WHO is
1593 "program"."""
1594 return self.tk.call('wm', 'sizefrom', self._w, who)
1595 sizefrom = wm_sizefrom
Fredrik Lundh289ad8f2000-08-09 19:11:59 +00001596 def wm_state(self, newstate=None):
1597 """Query or set the state of this widget as one of normal, icon,
1598 iconic (see wm_iconwindow), withdrawn, or zoomed (Windows only)."""
1599 return self.tk.call('wm', 'state', self._w, newstate)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001600 state = wm_state
1601 def wm_title(self, string=None):
1602 """Set the title of this widget."""
1603 return self.tk.call('wm', 'title', self._w, string)
1604 title = wm_title
1605 def wm_transient(self, master=None):
1606 """Instruct the window manager that this widget is transient
1607 with regard to widget MASTER."""
1608 return self.tk.call('wm', 'transient', self._w, master)
1609 transient = wm_transient
1610 def wm_withdraw(self):
1611 """Withdraw this widget from the screen such that it is unmapped
1612 and forgotten by the window manager. Re-draw it with wm_deiconify."""
1613 return self.tk.call('wm', 'withdraw', self._w)
1614 withdraw = wm_withdraw
Guido van Rossume365a591998-05-01 19:48:20 +00001615
Guido van Rossum18468821994-06-20 07:49:28 +00001616
1617class Tk(Misc, Wm):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001618 """Toplevel widget of Tk which represents mostly the main window
1619 of an appliation. It has an associated Tcl interpreter."""
1620 _w = '.'
Martin v. Löwis9441c072004-08-03 18:36:25 +00001621 def __init__(self, screenName=None, baseName=None, className='Tk',
1622 useTk=1, sync=0, use=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001623 """Return a new Toplevel widget on screen SCREENNAME. A new Tcl interpreter will
1624 be created. BASENAME will be used for the identification of the profile file (see
1625 readprofile).
1626 It is constructed from sys.argv[0] without extensions if None is given. CLASSNAME
1627 is the name of the widget class."""
Fredrik Lundh06d28152000-08-09 18:03:12 +00001628 self.master = None
1629 self.children = {}
David Aschere2b4b322004-02-18 05:59:53 +00001630 self._tkloaded = 0
1631 # to avoid recursions in the getattr code in case of failure, we
1632 # ensure that self.tk is always _something_.
Tim Peters182b5ac2004-07-18 06:16:08 +00001633 self.tk = None
Fredrik Lundh06d28152000-08-09 18:03:12 +00001634 if baseName is None:
1635 import sys, os
1636 baseName = os.path.basename(sys.argv[0])
1637 baseName, ext = os.path.splitext(baseName)
1638 if ext not in ('.py', '.pyc', '.pyo'):
1639 baseName = baseName + ext
David Aschere2b4b322004-02-18 05:59:53 +00001640 interactive = 0
Martin v. Löwis9441c072004-08-03 18:36:25 +00001641 self.tk = _tkinter.create(screenName, baseName, className, interactive, wantobjects, useTk, sync, use)
David Aschere2b4b322004-02-18 05:59:53 +00001642 if useTk:
1643 self._loadtk()
1644 self.readprofile(baseName, className)
1645 def loadtk(self):
1646 if not self._tkloaded:
1647 self.tk.loadtk()
1648 self._loadtk()
1649 def _loadtk(self):
1650 self._tkloaded = 1
1651 global _default_root
Jack Jansenbe92af02001-08-23 13:25:59 +00001652 if _MacOS and hasattr(_MacOS, 'SchedParams'):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001653 # Disable event scanning except for Command-Period
1654 _MacOS.SchedParams(1, 0)
1655 # Work around nasty MacTk bug
1656 # XXX Is this one still needed?
1657 self.update()
1658 # Version sanity checks
1659 tk_version = self.tk.getvar('tk_version')
1660 if tk_version != _tkinter.TK_VERSION:
1661 raise RuntimeError, \
1662 "tk.h version (%s) doesn't match libtk.a version (%s)" \
1663 % (_tkinter.TK_VERSION, tk_version)
Martin v. Löwis54895972003-05-24 11:37:15 +00001664 # Under unknown circumstances, tcl_version gets coerced to float
1665 tcl_version = str(self.tk.getvar('tcl_version'))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001666 if tcl_version != _tkinter.TCL_VERSION:
1667 raise RuntimeError, \
1668 "tcl.h version (%s) doesn't match libtcl.a version (%s)" \
1669 % (_tkinter.TCL_VERSION, tcl_version)
1670 if TkVersion < 4.0:
1671 raise RuntimeError, \
1672 "Tk 4.0 or higher is required; found Tk %s" \
1673 % str(TkVersion)
Martin v. Löwis4afe1542005-03-01 08:09:28 +00001674 # Create and register the tkerror and exit commands
1675 # We need to inline parts of _register here, _ register
1676 # would register differently-named commands.
1677 if self._tclCommands is None:
1678 self._tclCommands = []
Fredrik Lundh06d28152000-08-09 18:03:12 +00001679 self.tk.createcommand('tkerror', _tkerror)
1680 self.tk.createcommand('exit', _exit)
Martin v. Löwis4afe1542005-03-01 08:09:28 +00001681 self._tclCommands.append('tkerror')
1682 self._tclCommands.append('exit')
Fredrik Lundh06d28152000-08-09 18:03:12 +00001683 if _support_default_root and not _default_root:
1684 _default_root = self
1685 self.protocol("WM_DELETE_WINDOW", self.destroy)
1686 def destroy(self):
1687 """Destroy this and all descendants widgets. This will
1688 end the application of this Tcl interpreter."""
1689 for c in self.children.values(): c.destroy()
1690 self.tk.call('destroy', self._w)
1691 Misc.destroy(self)
1692 global _default_root
1693 if _support_default_root and _default_root is self:
1694 _default_root = None
1695 def readprofile(self, baseName, className):
1696 """Internal function. It reads BASENAME.tcl and CLASSNAME.tcl into
1697 the Tcl Interpreter and calls execfile on BASENAME.py and CLASSNAME.py if
1698 such a file exists in the home directory."""
1699 import os
1700 if os.environ.has_key('HOME'): home = os.environ['HOME']
1701 else: home = os.curdir
1702 class_tcl = os.path.join(home, '.%s.tcl' % className)
1703 class_py = os.path.join(home, '.%s.py' % className)
1704 base_tcl = os.path.join(home, '.%s.tcl' % baseName)
1705 base_py = os.path.join(home, '.%s.py' % baseName)
1706 dir = {'self': self}
1707 exec 'from Tkinter import *' in dir
1708 if os.path.isfile(class_tcl):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001709 self.tk.call('source', class_tcl)
1710 if os.path.isfile(class_py):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001711 execfile(class_py, dir)
1712 if os.path.isfile(base_tcl):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001713 self.tk.call('source', base_tcl)
1714 if os.path.isfile(base_py):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001715 execfile(base_py, dir)
1716 def report_callback_exception(self, exc, val, tb):
1717 """Internal function. It reports exception on sys.stderr."""
1718 import traceback, sys
1719 sys.stderr.write("Exception in Tkinter callback\n")
1720 sys.last_type = exc
1721 sys.last_value = val
1722 sys.last_traceback = tb
1723 traceback.print_exception(exc, val, tb)
David Aschere2b4b322004-02-18 05:59:53 +00001724 def __getattr__(self, attr):
1725 "Delegate attribute access to the interpreter object"
1726 return getattr(self.tk, attr)
Guido van Rossum18468821994-06-20 07:49:28 +00001727
Guido van Rossum368e06b1997-11-07 20:38:49 +00001728# Ideally, the classes Pack, Place and Grid disappear, the
1729# pack/place/grid methods are defined on the Widget class, and
1730# everybody uses w.pack_whatever(...) instead of Pack.whatever(w,
1731# ...), with pack(), place() and grid() being short for
1732# pack_configure(), place_configure() and grid_columnconfigure(), and
1733# forget() being short for pack_forget(). As a practical matter, I'm
1734# afraid that there is too much code out there that may be using the
1735# Pack, Place or Grid class, so I leave them intact -- but only as
1736# backwards compatibility features. Also note that those methods that
1737# take a master as argument (e.g. pack_propagate) have been moved to
1738# the Misc class (which now incorporates all methods common between
1739# toplevel and interior widgets). Again, for compatibility, these are
1740# copied into the Pack, Place or Grid class.
1741
David Aschere2b4b322004-02-18 05:59:53 +00001742
1743def Tcl(screenName=None, baseName=None, className='Tk', useTk=0):
1744 return Tk(screenName, baseName, className, useTk)
1745
Guido van Rossum18468821994-06-20 07:49:28 +00001746class Pack:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001747 """Geometry manager Pack.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001748
Fredrik Lundh06d28152000-08-09 18:03:12 +00001749 Base class to use the methods pack_* in every widget."""
1750 def pack_configure(self, cnf={}, **kw):
1751 """Pack a widget in the parent widget. Use as options:
1752 after=widget - pack it after you have packed widget
1753 anchor=NSEW (or subset) - position widget according to
1754 given direction
Georg Brandl1a348342008-05-31 18:34:27 +00001755 before=widget - pack it before you will pack widget
Martin v. Löwisbfe175c2003-04-16 19:42:51 +00001756 expand=bool - expand widget if parent size grows
Fredrik Lundh06d28152000-08-09 18:03:12 +00001757 fill=NONE or X or Y or BOTH - fill widget if widget grows
1758 in=master - use master to contain this widget
Georg Brandl1a348342008-05-31 18:34:27 +00001759 in_=master - see 'in' option description
Fredrik Lundh06d28152000-08-09 18:03:12 +00001760 ipadx=amount - add internal padding in x direction
1761 ipady=amount - add internal padding in y direction
1762 padx=amount - add padding in x direction
1763 pady=amount - add padding in y direction
1764 side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
1765 """
1766 self.tk.call(
1767 ('pack', 'configure', self._w)
1768 + self._options(cnf, kw))
1769 pack = configure = config = pack_configure
1770 def pack_forget(self):
1771 """Unmap this widget and do not use it for the packing order."""
1772 self.tk.call('pack', 'forget', self._w)
1773 forget = pack_forget
1774 def pack_info(self):
1775 """Return information about the packing options
1776 for this widget."""
1777 words = self.tk.splitlist(
1778 self.tk.call('pack', 'info', self._w))
1779 dict = {}
1780 for i in range(0, len(words), 2):
1781 key = words[i][1:]
1782 value = words[i+1]
1783 if value[:1] == '.':
1784 value = self._nametowidget(value)
1785 dict[key] = value
1786 return dict
1787 info = pack_info
1788 propagate = pack_propagate = Misc.pack_propagate
1789 slaves = pack_slaves = Misc.pack_slaves
Guido van Rossum18468821994-06-20 07:49:28 +00001790
1791class Place:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001792 """Geometry manager Place.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001793
Fredrik Lundh06d28152000-08-09 18:03:12 +00001794 Base class to use the methods place_* in every widget."""
1795 def place_configure(self, cnf={}, **kw):
1796 """Place a widget in the parent widget. Use as options:
Georg Brandl1a348342008-05-31 18:34:27 +00001797 in=master - master relative to which the widget is placed
1798 in_=master - see 'in' option description
Fredrik Lundh06d28152000-08-09 18:03:12 +00001799 x=amount - locate anchor of this widget at position x of master
1800 y=amount - locate anchor of this widget at position y of master
1801 relx=amount - locate anchor of this widget between 0.0 and 1.0
1802 relative to width of master (1.0 is right edge)
Georg Brandl1a348342008-05-31 18:34:27 +00001803 rely=amount - locate anchor of this widget between 0.0 and 1.0
Fredrik Lundh06d28152000-08-09 18:03:12 +00001804 relative to height of master (1.0 is bottom edge)
Georg Brandl1a348342008-05-31 18:34:27 +00001805 anchor=NSEW (or subset) - position anchor according to given direction
Fredrik Lundh06d28152000-08-09 18:03:12 +00001806 width=amount - width of this widget in pixel
1807 height=amount - height of this widget in pixel
1808 relwidth=amount - width of this widget between 0.0 and 1.0
1809 relative to width of master (1.0 is the same width
Georg Brandl1a348342008-05-31 18:34:27 +00001810 as the master)
1811 relheight=amount - height of this widget between 0.0 and 1.0
Fredrik Lundh06d28152000-08-09 18:03:12 +00001812 relative to height of master (1.0 is the same
Georg Brandl1a348342008-05-31 18:34:27 +00001813 height as the master)
1814 bordermode="inside" or "outside" - whether to take border width of
1815 master widget into account
1816 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00001817 self.tk.call(
1818 ('place', 'configure', self._w)
1819 + self._options(cnf, kw))
1820 place = configure = config = place_configure
1821 def place_forget(self):
1822 """Unmap this widget."""
1823 self.tk.call('place', 'forget', self._w)
1824 forget = place_forget
1825 def place_info(self):
1826 """Return information about the placing options
1827 for this widget."""
1828 words = self.tk.splitlist(
1829 self.tk.call('place', 'info', self._w))
1830 dict = {}
1831 for i in range(0, len(words), 2):
1832 key = words[i][1:]
1833 value = words[i+1]
1834 if value[:1] == '.':
1835 value = self._nametowidget(value)
1836 dict[key] = value
1837 return dict
1838 info = place_info
1839 slaves = place_slaves = Misc.place_slaves
Guido van Rossum18468821994-06-20 07:49:28 +00001840
Guido van Rossum37dcab11996-05-16 16:00:19 +00001841class Grid:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001842 """Geometry manager Grid.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001843
Fredrik Lundh06d28152000-08-09 18:03:12 +00001844 Base class to use the methods grid_* in every widget."""
1845 # Thanks to Masazumi Yoshikawa (yosikawa@isi.edu)
1846 def grid_configure(self, cnf={}, **kw):
1847 """Position a widget in the parent widget in a grid. Use as options:
1848 column=number - use cell identified with given column (starting with 0)
1849 columnspan=number - this widget will span several columns
1850 in=master - use master to contain this widget
Georg Brandl1a348342008-05-31 18:34:27 +00001851 in_=master - see 'in' option description
Fredrik Lundh06d28152000-08-09 18:03:12 +00001852 ipadx=amount - add internal padding in x direction
1853 ipady=amount - add internal padding in y direction
1854 padx=amount - add padding in x direction
1855 pady=amount - add padding in y direction
1856 row=number - use cell identified with given row (starting with 0)
1857 rowspan=number - this widget will span several rows
1858 sticky=NSEW - if cell is larger on which sides will this
1859 widget stick to the cell boundary
1860 """
1861 self.tk.call(
1862 ('grid', 'configure', self._w)
1863 + self._options(cnf, kw))
1864 grid = configure = config = grid_configure
1865 bbox = grid_bbox = Misc.grid_bbox
1866 columnconfigure = grid_columnconfigure = Misc.grid_columnconfigure
1867 def grid_forget(self):
1868 """Unmap this widget."""
1869 self.tk.call('grid', 'forget', self._w)
1870 forget = grid_forget
1871 def grid_remove(self):
1872 """Unmap this widget but remember the grid options."""
1873 self.tk.call('grid', 'remove', self._w)
1874 def grid_info(self):
1875 """Return information about the options
1876 for positioning this widget in a grid."""
1877 words = self.tk.splitlist(
1878 self.tk.call('grid', 'info', self._w))
1879 dict = {}
1880 for i in range(0, len(words), 2):
1881 key = words[i][1:]
1882 value = words[i+1]
1883 if value[:1] == '.':
1884 value = self._nametowidget(value)
1885 dict[key] = value
1886 return dict
1887 info = grid_info
Martin v. Löwisdc579092001-10-13 09:33:51 +00001888 location = grid_location = Misc.grid_location
Fredrik Lundh06d28152000-08-09 18:03:12 +00001889 propagate = grid_propagate = Misc.grid_propagate
1890 rowconfigure = grid_rowconfigure = Misc.grid_rowconfigure
1891 size = grid_size = Misc.grid_size
1892 slaves = grid_slaves = Misc.grid_slaves
Guido van Rossum37dcab11996-05-16 16:00:19 +00001893
Guido van Rossum368e06b1997-11-07 20:38:49 +00001894class BaseWidget(Misc):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001895 """Internal class."""
1896 def _setup(self, master, cnf):
1897 """Internal function. Sets up information about children."""
1898 if _support_default_root:
1899 global _default_root
1900 if not master:
1901 if not _default_root:
1902 _default_root = Tk()
1903 master = _default_root
1904 self.master = master
1905 self.tk = master.tk
1906 name = None
1907 if cnf.has_key('name'):
1908 name = cnf['name']
1909 del cnf['name']
1910 if not name:
Walter Dörwald70a6b492004-02-12 17:35:32 +00001911 name = repr(id(self))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001912 self._name = name
1913 if master._w=='.':
1914 self._w = '.' + name
1915 else:
1916 self._w = master._w + '.' + name
1917 self.children = {}
1918 if self.master.children.has_key(self._name):
1919 self.master.children[self._name].destroy()
1920 self.master.children[self._name] = self
1921 def __init__(self, master, widgetName, cnf={}, kw={}, extra=()):
1922 """Construct a widget with the parent widget MASTER, a name WIDGETNAME
1923 and appropriate options."""
1924 if kw:
1925 cnf = _cnfmerge((cnf, kw))
1926 self.widgetName = widgetName
1927 BaseWidget._setup(self, master, cnf)
1928 classes = []
1929 for k in cnf.keys():
1930 if type(k) is ClassType:
1931 classes.append((k, cnf[k]))
1932 del cnf[k]
1933 self.tk.call(
1934 (widgetName, self._w) + extra + self._options(cnf))
1935 for k, v in classes:
1936 k.configure(self, v)
1937 def destroy(self):
1938 """Destroy this and all descendants widgets."""
1939 for c in self.children.values(): c.destroy()
Martin v. Löwis92733be2006-06-17 09:25:15 +00001940 self.tk.call('destroy', self._w)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001941 if self.master.children.has_key(self._name):
1942 del self.master.children[self._name]
Fredrik Lundh06d28152000-08-09 18:03:12 +00001943 Misc.destroy(self)
1944 def _do(self, name, args=()):
1945 # XXX Obsolete -- better use self.tk.call directly!
1946 return self.tk.call((self._w, name) + args)
Guido van Rossum18468821994-06-20 07:49:28 +00001947
Guido van Rossum368e06b1997-11-07 20:38:49 +00001948class Widget(BaseWidget, Pack, Place, Grid):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001949 """Internal class.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001950
Fredrik Lundh06d28152000-08-09 18:03:12 +00001951 Base class for a widget which can be positioned with the geometry managers
1952 Pack, Place or Grid."""
1953 pass
Guido van Rossum368e06b1997-11-07 20:38:49 +00001954
1955class Toplevel(BaseWidget, Wm):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001956 """Toplevel widget, e.g. for dialogs."""
1957 def __init__(self, master=None, cnf={}, **kw):
1958 """Construct a toplevel widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001959
Fredrik Lundh06d28152000-08-09 18:03:12 +00001960 Valid resource names: background, bd, bg, borderwidth, class,
1961 colormap, container, cursor, height, highlightbackground,
1962 highlightcolor, highlightthickness, menu, relief, screen, takefocus,
1963 use, visual, width."""
1964 if kw:
1965 cnf = _cnfmerge((cnf, kw))
1966 extra = ()
1967 for wmkey in ['screen', 'class_', 'class', 'visual',
1968 'colormap']:
1969 if cnf.has_key(wmkey):
1970 val = cnf[wmkey]
1971 # TBD: a hack needed because some keys
1972 # are not valid as keyword arguments
1973 if wmkey[-1] == '_': opt = '-'+wmkey[:-1]
1974 else: opt = '-'+wmkey
1975 extra = extra + (opt, val)
1976 del cnf[wmkey]
1977 BaseWidget.__init__(self, master, 'toplevel', cnf, {}, extra)
1978 root = self._root()
1979 self.iconname(root.iconname())
1980 self.title(root.title())
1981 self.protocol("WM_DELETE_WINDOW", self.destroy)
Guido van Rossum18468821994-06-20 07:49:28 +00001982
1983class Button(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001984 """Button widget."""
1985 def __init__(self, master=None, cnf={}, **kw):
1986 """Construct a button widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00001987
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001988 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00001989
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001990 activebackground, activeforeground, anchor,
1991 background, bitmap, borderwidth, cursor,
Raymond Hettingerff41c482003-04-06 09:01:11 +00001992 disabledforeground, font, foreground
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001993 highlightbackground, highlightcolor,
Raymond Hettingerff41c482003-04-06 09:01:11 +00001994 highlightthickness, image, justify,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001995 padx, pady, relief, repeatdelay,
Raymond Hettingerff41c482003-04-06 09:01:11 +00001996 repeatinterval, takefocus, text,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001997 textvariable, underline, wraplength
Raymond Hettingerff41c482003-04-06 09:01:11 +00001998
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001999 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002000
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002001 command, compound, default, height,
2002 overrelief, state, width
2003 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002004 Widget.__init__(self, master, 'button', cnf, kw)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002005
Fredrik Lundh06d28152000-08-09 18:03:12 +00002006 def tkButtonEnter(self, *dummy):
2007 self.tk.call('tkButtonEnter', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002008
Fredrik Lundh06d28152000-08-09 18:03:12 +00002009 def tkButtonLeave(self, *dummy):
2010 self.tk.call('tkButtonLeave', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002011
Fredrik Lundh06d28152000-08-09 18:03:12 +00002012 def tkButtonDown(self, *dummy):
2013 self.tk.call('tkButtonDown', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002014
Fredrik Lundh06d28152000-08-09 18:03:12 +00002015 def tkButtonUp(self, *dummy):
2016 self.tk.call('tkButtonUp', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002017
Fredrik Lundh06d28152000-08-09 18:03:12 +00002018 def tkButtonInvoke(self, *dummy):
2019 self.tk.call('tkButtonInvoke', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002020
Fredrik Lundh06d28152000-08-09 18:03:12 +00002021 def flash(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00002022 """Flash the button.
2023
2024 This is accomplished by redisplaying
2025 the button several times, alternating between active and
2026 normal colors. At the end of the flash the button is left
2027 in the same normal/active state as when the command was
2028 invoked. This command is ignored if the button's state is
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002029 disabled.
2030 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002031 self.tk.call(self._w, 'flash')
Raymond Hettingerff41c482003-04-06 09:01:11 +00002032
Fredrik Lundh06d28152000-08-09 18:03:12 +00002033 def invoke(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00002034 """Invoke the command associated with the button.
2035
2036 The return value is the return value from the command,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002037 or an empty string if there is no command associated with
2038 the button. This command is ignored if the button's state
2039 is disabled.
2040 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002041 return self.tk.call(self._w, 'invoke')
Guido van Rossum18468821994-06-20 07:49:28 +00002042
2043# Indices:
Guido van Rossum35f67fb1995-08-04 03:50:29 +00002044# XXX I don't like these -- take them away
Guido van Rossum18468821994-06-20 07:49:28 +00002045def AtEnd():
Fredrik Lundh06d28152000-08-09 18:03:12 +00002046 return 'end'
Guido van Rossum1e9e4001994-06-20 09:09:51 +00002047def AtInsert(*args):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002048 s = 'insert'
2049 for a in args:
2050 if a: s = s + (' ' + a)
2051 return s
Guido van Rossum18468821994-06-20 07:49:28 +00002052def AtSelFirst():
Fredrik Lundh06d28152000-08-09 18:03:12 +00002053 return 'sel.first'
Guido van Rossum18468821994-06-20 07:49:28 +00002054def AtSelLast():
Fredrik Lundh06d28152000-08-09 18:03:12 +00002055 return 'sel.last'
Guido van Rossum18468821994-06-20 07:49:28 +00002056def At(x, y=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002057 if y is None:
Walter Dörwald70a6b492004-02-12 17:35:32 +00002058 return '@%r' % (x,)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002059 else:
Walter Dörwald70a6b492004-02-12 17:35:32 +00002060 return '@%r,%r' % (x, y)
Guido van Rossum18468821994-06-20 07:49:28 +00002061
2062class Canvas(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002063 """Canvas widget to display graphical elements like lines or text."""
2064 def __init__(self, master=None, cnf={}, **kw):
2065 """Construct a canvas widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002066
Fredrik Lundh06d28152000-08-09 18:03:12 +00002067 Valid resource names: background, bd, bg, borderwidth, closeenough,
2068 confine, cursor, height, highlightbackground, highlightcolor,
2069 highlightthickness, insertbackground, insertborderwidth,
2070 insertofftime, insertontime, insertwidth, offset, relief,
2071 scrollregion, selectbackground, selectborderwidth, selectforeground,
2072 state, takefocus, width, xscrollcommand, xscrollincrement,
2073 yscrollcommand, yscrollincrement."""
2074 Widget.__init__(self, master, 'canvas', cnf, kw)
2075 def addtag(self, *args):
2076 """Internal function."""
2077 self.tk.call((self._w, 'addtag') + args)
2078 def addtag_above(self, newtag, tagOrId):
2079 """Add tag NEWTAG to all items above TAGORID."""
2080 self.addtag(newtag, 'above', tagOrId)
2081 def addtag_all(self, newtag):
2082 """Add tag NEWTAG to all items."""
2083 self.addtag(newtag, 'all')
2084 def addtag_below(self, newtag, tagOrId):
2085 """Add tag NEWTAG to all items below TAGORID."""
2086 self.addtag(newtag, 'below', tagOrId)
2087 def addtag_closest(self, newtag, x, y, halo=None, start=None):
2088 """Add tag NEWTAG to item which is closest to pixel at X, Y.
2089 If several match take the top-most.
2090 All items closer than HALO are considered overlapping (all are
2091 closests). If START is specified the next below this tag is taken."""
2092 self.addtag(newtag, 'closest', x, y, halo, start)
2093 def addtag_enclosed(self, newtag, x1, y1, x2, y2):
2094 """Add tag NEWTAG to all items in the rectangle defined
2095 by X1,Y1,X2,Y2."""
2096 self.addtag(newtag, 'enclosed', x1, y1, x2, y2)
2097 def addtag_overlapping(self, newtag, x1, y1, x2, y2):
2098 """Add tag NEWTAG to all items which overlap the rectangle
2099 defined by X1,Y1,X2,Y2."""
2100 self.addtag(newtag, 'overlapping', x1, y1, x2, y2)
2101 def addtag_withtag(self, newtag, tagOrId):
2102 """Add tag NEWTAG to all items with TAGORID."""
2103 self.addtag(newtag, 'withtag', tagOrId)
2104 def bbox(self, *args):
2105 """Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle
2106 which encloses all items with tags specified as arguments."""
2107 return self._getints(
2108 self.tk.call((self._w, 'bbox') + args)) or None
2109 def tag_unbind(self, tagOrId, sequence, funcid=None):
2110 """Unbind for all items with TAGORID for event SEQUENCE the
2111 function identified with FUNCID."""
2112 self.tk.call(self._w, 'bind', tagOrId, sequence, '')
2113 if funcid:
2114 self.deletecommand(funcid)
2115 def tag_bind(self, tagOrId, sequence=None, func=None, add=None):
2116 """Bind to all items with TAGORID at event SEQUENCE a call to function FUNC.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002117
Fredrik Lundh06d28152000-08-09 18:03:12 +00002118 An additional boolean parameter ADD specifies whether FUNC will be
2119 called additionally to the other bound function or whether it will
2120 replace the previous function. See bind for the return value."""
2121 return self._bind((self._w, 'bind', tagOrId),
2122 sequence, func, add)
2123 def canvasx(self, screenx, gridspacing=None):
2124 """Return the canvas x coordinate of pixel position SCREENX rounded
2125 to nearest multiple of GRIDSPACING units."""
2126 return getdouble(self.tk.call(
2127 self._w, 'canvasx', screenx, gridspacing))
2128 def canvasy(self, screeny, gridspacing=None):
2129 """Return the canvas y coordinate of pixel position SCREENY rounded
2130 to nearest multiple of GRIDSPACING units."""
2131 return getdouble(self.tk.call(
2132 self._w, 'canvasy', screeny, gridspacing))
2133 def coords(self, *args):
2134 """Return a list of coordinates for the item given in ARGS."""
2135 # XXX Should use _flatten on args
2136 return map(getdouble,
Guido van Rossum0bd54331998-05-19 21:18:13 +00002137 self.tk.splitlist(
Fredrik Lundh06d28152000-08-09 18:03:12 +00002138 self.tk.call((self._w, 'coords') + args)))
2139 def _create(self, itemType, args, kw): # Args: (val, val, ..., cnf={})
2140 """Internal function."""
2141 args = _flatten(args)
2142 cnf = args[-1]
2143 if type(cnf) in (DictionaryType, TupleType):
2144 args = args[:-1]
2145 else:
2146 cnf = {}
Raymond Hettingerff41c482003-04-06 09:01:11 +00002147 return getint(self.tk.call(
2148 self._w, 'create', itemType,
2149 *(args + self._options(cnf, kw))))
Fredrik Lundh06d28152000-08-09 18:03:12 +00002150 def create_arc(self, *args, **kw):
2151 """Create arc shaped region with coordinates x1,y1,x2,y2."""
2152 return self._create('arc', args, kw)
2153 def create_bitmap(self, *args, **kw):
2154 """Create bitmap with coordinates x1,y1."""
2155 return self._create('bitmap', args, kw)
2156 def create_image(self, *args, **kw):
2157 """Create image item with coordinates x1,y1."""
2158 return self._create('image', args, kw)
2159 def create_line(self, *args, **kw):
2160 """Create line with coordinates x1,y1,...,xn,yn."""
2161 return self._create('line', args, kw)
2162 def create_oval(self, *args, **kw):
2163 """Create oval with coordinates x1,y1,x2,y2."""
2164 return self._create('oval', args, kw)
2165 def create_polygon(self, *args, **kw):
2166 """Create polygon with coordinates x1,y1,...,xn,yn."""
2167 return self._create('polygon', args, kw)
2168 def create_rectangle(self, *args, **kw):
2169 """Create rectangle with coordinates x1,y1,x2,y2."""
2170 return self._create('rectangle', args, kw)
2171 def create_text(self, *args, **kw):
2172 """Create text with coordinates x1,y1."""
2173 return self._create('text', args, kw)
2174 def create_window(self, *args, **kw):
2175 """Create window with coordinates x1,y1,x2,y2."""
2176 return self._create('window', args, kw)
2177 def dchars(self, *args):
2178 """Delete characters of text items identified by tag or id in ARGS (possibly
2179 several times) from FIRST to LAST character (including)."""
2180 self.tk.call((self._w, 'dchars') + args)
2181 def delete(self, *args):
2182 """Delete items identified by all tag or ids contained in ARGS."""
2183 self.tk.call((self._w, 'delete') + args)
2184 def dtag(self, *args):
2185 """Delete tag or id given as last arguments in ARGS from items
2186 identified by first argument in ARGS."""
2187 self.tk.call((self._w, 'dtag') + args)
2188 def find(self, *args):
2189 """Internal function."""
2190 return self._getints(
2191 self.tk.call((self._w, 'find') + args)) or ()
2192 def find_above(self, tagOrId):
2193 """Return items above TAGORID."""
2194 return self.find('above', tagOrId)
2195 def find_all(self):
2196 """Return all items."""
2197 return self.find('all')
2198 def find_below(self, tagOrId):
2199 """Return all items below TAGORID."""
2200 return self.find('below', tagOrId)
2201 def find_closest(self, x, y, halo=None, start=None):
2202 """Return item which is closest to pixel at X, Y.
2203 If several match take the top-most.
2204 All items closer than HALO are considered overlapping (all are
2205 closests). If START is specified the next below this tag is taken."""
2206 return self.find('closest', x, y, halo, start)
2207 def find_enclosed(self, x1, y1, x2, y2):
2208 """Return all items in rectangle defined
2209 by X1,Y1,X2,Y2."""
2210 return self.find('enclosed', x1, y1, x2, y2)
2211 def find_overlapping(self, x1, y1, x2, y2):
2212 """Return all items which overlap the rectangle
2213 defined by X1,Y1,X2,Y2."""
2214 return self.find('overlapping', x1, y1, x2, y2)
2215 def find_withtag(self, tagOrId):
2216 """Return all items with TAGORID."""
2217 return self.find('withtag', tagOrId)
2218 def focus(self, *args):
2219 """Set focus to the first item specified in ARGS."""
2220 return self.tk.call((self._w, 'focus') + args)
2221 def gettags(self, *args):
2222 """Return tags associated with the first item specified in ARGS."""
2223 return self.tk.splitlist(
2224 self.tk.call((self._w, 'gettags') + args))
2225 def icursor(self, *args):
2226 """Set cursor at position POS in the item identified by TAGORID.
2227 In ARGS TAGORID must be first."""
2228 self.tk.call((self._w, 'icursor') + args)
2229 def index(self, *args):
2230 """Return position of cursor as integer in item specified in ARGS."""
2231 return getint(self.tk.call((self._w, 'index') + args))
2232 def insert(self, *args):
2233 """Insert TEXT in item TAGORID at position POS. ARGS must
2234 be TAGORID POS TEXT."""
2235 self.tk.call((self._w, 'insert') + args)
2236 def itemcget(self, tagOrId, option):
2237 """Return the resource value for an OPTION for item TAGORID."""
2238 return self.tk.call(
2239 (self._w, 'itemcget') + (tagOrId, '-'+option))
2240 def itemconfigure(self, tagOrId, cnf=None, **kw):
2241 """Configure resources of an item TAGORID.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002242
Fredrik Lundh06d28152000-08-09 18:03:12 +00002243 The values for resources are specified as keyword
2244 arguments. To get an overview about
2245 the allowed keyword arguments call the method without arguments.
2246 """
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002247 return self._configure(('itemconfigure', tagOrId), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002248 itemconfig = itemconfigure
2249 # lower, tkraise/lift hide Misc.lower, Misc.tkraise/lift,
2250 # so the preferred name for them is tag_lower, tag_raise
2251 # (similar to tag_bind, and similar to the Text widget);
2252 # unfortunately can't delete the old ones yet (maybe in 1.6)
2253 def tag_lower(self, *args):
2254 """Lower an item TAGORID given in ARGS
2255 (optional below another item)."""
2256 self.tk.call((self._w, 'lower') + args)
2257 lower = tag_lower
2258 def move(self, *args):
2259 """Move an item TAGORID given in ARGS."""
2260 self.tk.call((self._w, 'move') + args)
2261 def postscript(self, cnf={}, **kw):
2262 """Print the contents of the canvas to a postscript
2263 file. Valid options: colormap, colormode, file, fontmap,
2264 height, pageanchor, pageheight, pagewidth, pagex, pagey,
2265 rotate, witdh, x, y."""
2266 return self.tk.call((self._w, 'postscript') +
2267 self._options(cnf, kw))
2268 def tag_raise(self, *args):
2269 """Raise an item TAGORID given in ARGS
2270 (optional above another item)."""
2271 self.tk.call((self._w, 'raise') + args)
2272 lift = tkraise = tag_raise
2273 def scale(self, *args):
2274 """Scale item TAGORID with XORIGIN, YORIGIN, XSCALE, YSCALE."""
2275 self.tk.call((self._w, 'scale') + args)
2276 def scan_mark(self, x, y):
2277 """Remember the current X, Y coordinates."""
2278 self.tk.call(self._w, 'scan', 'mark', x, y)
Neal Norwitze931ed52003-01-10 23:24:32 +00002279 def scan_dragto(self, x, y, gain=10):
2280 """Adjust the view of the canvas to GAIN times the
Fredrik Lundh06d28152000-08-09 18:03:12 +00002281 difference between X and Y and the coordinates given in
2282 scan_mark."""
Neal Norwitze931ed52003-01-10 23:24:32 +00002283 self.tk.call(self._w, 'scan', 'dragto', x, y, gain)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002284 def select_adjust(self, tagOrId, index):
2285 """Adjust the end of the selection near the cursor of an item TAGORID to index."""
2286 self.tk.call(self._w, 'select', 'adjust', tagOrId, index)
2287 def select_clear(self):
2288 """Clear the selection if it is in this widget."""
2289 self.tk.call(self._w, 'select', 'clear')
2290 def select_from(self, tagOrId, index):
2291 """Set the fixed end of a selection in item TAGORID to INDEX."""
2292 self.tk.call(self._w, 'select', 'from', tagOrId, index)
2293 def select_item(self):
2294 """Return the item which has the selection."""
Neal Norwitz58b63bf2002-07-23 02:52:58 +00002295 return self.tk.call(self._w, 'select', 'item') or None
Fredrik Lundh06d28152000-08-09 18:03:12 +00002296 def select_to(self, tagOrId, index):
2297 """Set the variable end of a selection in item TAGORID to INDEX."""
2298 self.tk.call(self._w, 'select', 'to', tagOrId, index)
2299 def type(self, tagOrId):
2300 """Return the type of the item TAGORID."""
2301 return self.tk.call(self._w, 'type', tagOrId) or None
2302 def xview(self, *args):
2303 """Query and change horizontal position of the view."""
2304 if not args:
2305 return self._getdoubles(self.tk.call(self._w, 'xview'))
2306 self.tk.call((self._w, 'xview') + args)
2307 def xview_moveto(self, fraction):
2308 """Adjusts the view in the window so that FRACTION of the
2309 total width of the canvas is off-screen to the left."""
2310 self.tk.call(self._w, 'xview', 'moveto', fraction)
2311 def xview_scroll(self, number, what):
2312 """Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2313 self.tk.call(self._w, 'xview', 'scroll', number, what)
2314 def yview(self, *args):
2315 """Query and change vertical position of the view."""
2316 if not args:
2317 return self._getdoubles(self.tk.call(self._w, 'yview'))
2318 self.tk.call((self._w, 'yview') + args)
2319 def yview_moveto(self, fraction):
2320 """Adjusts the view in the window so that FRACTION of the
2321 total height of the canvas is off-screen to the top."""
2322 self.tk.call(self._w, 'yview', 'moveto', fraction)
2323 def yview_scroll(self, number, what):
2324 """Shift the y-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2325 self.tk.call(self._w, 'yview', 'scroll', number, what)
Guido van Rossum18468821994-06-20 07:49:28 +00002326
2327class Checkbutton(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002328 """Checkbutton widget which is either in on- or off-state."""
2329 def __init__(self, master=None, cnf={}, **kw):
2330 """Construct a checkbutton widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002331
Fredrik Lundh06d28152000-08-09 18:03:12 +00002332 Valid resource names: activebackground, activeforeground, anchor,
2333 background, bd, bg, bitmap, borderwidth, command, cursor,
2334 disabledforeground, fg, font, foreground, height,
2335 highlightbackground, highlightcolor, highlightthickness, image,
2336 indicatoron, justify, offvalue, onvalue, padx, pady, relief,
2337 selectcolor, selectimage, state, takefocus, text, textvariable,
2338 underline, variable, width, wraplength."""
2339 Widget.__init__(self, master, 'checkbutton', cnf, kw)
2340 def deselect(self):
2341 """Put the button in off-state."""
2342 self.tk.call(self._w, 'deselect')
2343 def flash(self):
2344 """Flash the button."""
2345 self.tk.call(self._w, 'flash')
2346 def invoke(self):
2347 """Toggle the button and invoke a command if given as resource."""
2348 return self.tk.call(self._w, 'invoke')
2349 def select(self):
2350 """Put the button in on-state."""
2351 self.tk.call(self._w, 'select')
2352 def toggle(self):
2353 """Toggle the button."""
2354 self.tk.call(self._w, 'toggle')
Guido van Rossum18468821994-06-20 07:49:28 +00002355
2356class Entry(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002357 """Entry widget which allows to display simple text."""
2358 def __init__(self, master=None, cnf={}, **kw):
2359 """Construct an entry widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002360
Fredrik Lundh06d28152000-08-09 18:03:12 +00002361 Valid resource names: background, bd, bg, borderwidth, cursor,
2362 exportselection, fg, font, foreground, highlightbackground,
2363 highlightcolor, highlightthickness, insertbackground,
2364 insertborderwidth, insertofftime, insertontime, insertwidth,
2365 invalidcommand, invcmd, justify, relief, selectbackground,
2366 selectborderwidth, selectforeground, show, state, takefocus,
2367 textvariable, validate, validatecommand, vcmd, width,
2368 xscrollcommand."""
2369 Widget.__init__(self, master, 'entry', cnf, kw)
2370 def delete(self, first, last=None):
2371 """Delete text from FIRST to LAST (not included)."""
2372 self.tk.call(self._w, 'delete', first, last)
2373 def get(self):
2374 """Return the text."""
2375 return self.tk.call(self._w, 'get')
2376 def icursor(self, index):
2377 """Insert cursor at INDEX."""
2378 self.tk.call(self._w, 'icursor', index)
2379 def index(self, index):
2380 """Return position of cursor."""
2381 return getint(self.tk.call(
2382 self._w, 'index', index))
2383 def insert(self, index, string):
2384 """Insert STRING at INDEX."""
2385 self.tk.call(self._w, 'insert', index, string)
2386 def scan_mark(self, x):
2387 """Remember the current X, Y coordinates."""
2388 self.tk.call(self._w, 'scan', 'mark', x)
2389 def scan_dragto(self, x):
2390 """Adjust the view of the canvas to 10 times the
2391 difference between X and Y and the coordinates given in
2392 scan_mark."""
2393 self.tk.call(self._w, 'scan', 'dragto', x)
2394 def selection_adjust(self, index):
2395 """Adjust the end of the selection near the cursor to INDEX."""
2396 self.tk.call(self._w, 'selection', 'adjust', index)
2397 select_adjust = selection_adjust
2398 def selection_clear(self):
2399 """Clear the selection if it is in this widget."""
2400 self.tk.call(self._w, 'selection', 'clear')
2401 select_clear = selection_clear
2402 def selection_from(self, index):
2403 """Set the fixed end of a selection to INDEX."""
2404 self.tk.call(self._w, 'selection', 'from', index)
2405 select_from = selection_from
2406 def selection_present(self):
2407 """Return whether the widget has the selection."""
2408 return self.tk.getboolean(
2409 self.tk.call(self._w, 'selection', 'present'))
2410 select_present = selection_present
2411 def selection_range(self, start, end):
2412 """Set the selection from START to END (not included)."""
2413 self.tk.call(self._w, 'selection', 'range', start, end)
2414 select_range = selection_range
2415 def selection_to(self, index):
2416 """Set the variable end of a selection to INDEX."""
2417 self.tk.call(self._w, 'selection', 'to', index)
2418 select_to = selection_to
2419 def xview(self, index):
2420 """Query and change horizontal position of the view."""
2421 self.tk.call(self._w, 'xview', index)
2422 def xview_moveto(self, fraction):
2423 """Adjust the view in the window so that FRACTION of the
2424 total width of the entry is off-screen to the left."""
2425 self.tk.call(self._w, 'xview', 'moveto', fraction)
2426 def xview_scroll(self, number, what):
2427 """Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2428 self.tk.call(self._w, 'xview', 'scroll', number, what)
Guido van Rossum18468821994-06-20 07:49:28 +00002429
2430class Frame(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002431 """Frame widget which may contain other widgets and can have a 3D border."""
2432 def __init__(self, master=None, cnf={}, **kw):
2433 """Construct a frame widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002434
Fredrik Lundh06d28152000-08-09 18:03:12 +00002435 Valid resource names: background, bd, bg, borderwidth, class,
2436 colormap, container, cursor, height, highlightbackground,
2437 highlightcolor, highlightthickness, relief, takefocus, visual, width."""
2438 cnf = _cnfmerge((cnf, kw))
2439 extra = ()
2440 if cnf.has_key('class_'):
2441 extra = ('-class', cnf['class_'])
2442 del cnf['class_']
2443 elif cnf.has_key('class'):
2444 extra = ('-class', cnf['class'])
2445 del cnf['class']
2446 Widget.__init__(self, master, 'frame', cnf, {}, extra)
Guido van Rossum18468821994-06-20 07:49:28 +00002447
2448class Label(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002449 """Label widget which can display text and bitmaps."""
2450 def __init__(self, master=None, cnf={}, **kw):
2451 """Construct a label widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00002452
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002453 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002454
2455 activebackground, activeforeground, anchor,
2456 background, bitmap, borderwidth, cursor,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002457 disabledforeground, font, foreground,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002458 highlightbackground, highlightcolor,
2459 highlightthickness, image, justify,
2460 padx, pady, relief, takefocus, text,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002461 textvariable, underline, wraplength
Raymond Hettingerff41c482003-04-06 09:01:11 +00002462
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002463 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002464
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002465 height, state, width
Raymond Hettingerff41c482003-04-06 09:01:11 +00002466
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002467 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002468 Widget.__init__(self, master, 'label', cnf, kw)
Guido van Rossum761c5ab1995-07-14 15:29:10 +00002469
Guido van Rossum18468821994-06-20 07:49:28 +00002470class Listbox(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002471 """Listbox widget which can display a list of strings."""
2472 def __init__(self, master=None, cnf={}, **kw):
2473 """Construct a listbox widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002474
Fredrik Lundh06d28152000-08-09 18:03:12 +00002475 Valid resource names: background, bd, bg, borderwidth, cursor,
2476 exportselection, fg, font, foreground, height, highlightbackground,
2477 highlightcolor, highlightthickness, relief, selectbackground,
2478 selectborderwidth, selectforeground, selectmode, setgrid, takefocus,
2479 width, xscrollcommand, yscrollcommand, listvariable."""
2480 Widget.__init__(self, master, 'listbox', cnf, kw)
2481 def activate(self, index):
2482 """Activate item identified by INDEX."""
2483 self.tk.call(self._w, 'activate', index)
2484 def bbox(self, *args):
2485 """Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle
2486 which encloses the item identified by index in ARGS."""
2487 return self._getints(
2488 self.tk.call((self._w, 'bbox') + args)) or None
2489 def curselection(self):
2490 """Return list of indices of currently selected item."""
2491 # XXX Ought to apply self._getints()...
2492 return self.tk.splitlist(self.tk.call(
2493 self._w, 'curselection'))
2494 def delete(self, first, last=None):
2495 """Delete items from FIRST to LAST (not included)."""
2496 self.tk.call(self._w, 'delete', first, last)
2497 def get(self, first, last=None):
2498 """Get list of items from FIRST to LAST (not included)."""
2499 if last:
2500 return self.tk.splitlist(self.tk.call(
2501 self._w, 'get', first, last))
2502 else:
2503 return self.tk.call(self._w, 'get', first)
2504 def index(self, index):
2505 """Return index of item identified with INDEX."""
2506 i = self.tk.call(self._w, 'index', index)
2507 if i == 'none': return None
2508 return getint(i)
2509 def insert(self, index, *elements):
2510 """Insert ELEMENTS at INDEX."""
2511 self.tk.call((self._w, 'insert', index) + elements)
2512 def nearest(self, y):
2513 """Get index of item which is nearest to y coordinate Y."""
2514 return getint(self.tk.call(
2515 self._w, 'nearest', y))
2516 def scan_mark(self, x, y):
2517 """Remember the current X, Y coordinates."""
2518 self.tk.call(self._w, 'scan', 'mark', x, y)
2519 def scan_dragto(self, x, y):
2520 """Adjust the view of the listbox to 10 times the
2521 difference between X and Y and the coordinates given in
2522 scan_mark."""
2523 self.tk.call(self._w, 'scan', 'dragto', x, y)
2524 def see(self, index):
2525 """Scroll such that INDEX is visible."""
2526 self.tk.call(self._w, 'see', index)
2527 def selection_anchor(self, index):
2528 """Set the fixed end oft the selection to INDEX."""
2529 self.tk.call(self._w, 'selection', 'anchor', index)
2530 select_anchor = selection_anchor
2531 def selection_clear(self, first, last=None):
2532 """Clear the selection from FIRST to LAST (not included)."""
2533 self.tk.call(self._w,
2534 'selection', 'clear', first, last)
2535 select_clear = selection_clear
2536 def selection_includes(self, index):
2537 """Return 1 if INDEX is part of the selection."""
2538 return self.tk.getboolean(self.tk.call(
2539 self._w, 'selection', 'includes', index))
2540 select_includes = selection_includes
2541 def selection_set(self, first, last=None):
2542 """Set the selection from FIRST to LAST (not included) without
2543 changing the currently selected elements."""
2544 self.tk.call(self._w, 'selection', 'set', first, last)
2545 select_set = selection_set
2546 def size(self):
2547 """Return the number of elements in the listbox."""
2548 return getint(self.tk.call(self._w, 'size'))
2549 def xview(self, *what):
2550 """Query and change horizontal position of the view."""
2551 if not what:
2552 return self._getdoubles(self.tk.call(self._w, 'xview'))
2553 self.tk.call((self._w, 'xview') + what)
2554 def xview_moveto(self, fraction):
2555 """Adjust the view in the window so that FRACTION of the
2556 total width of the entry is off-screen to the left."""
2557 self.tk.call(self._w, 'xview', 'moveto', fraction)
2558 def xview_scroll(self, number, what):
2559 """Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2560 self.tk.call(self._w, 'xview', 'scroll', number, what)
2561 def yview(self, *what):
2562 """Query and change vertical position of the view."""
2563 if not what:
2564 return self._getdoubles(self.tk.call(self._w, 'yview'))
2565 self.tk.call((self._w, 'yview') + what)
2566 def yview_moveto(self, fraction):
2567 """Adjust the view in the window so that FRACTION of the
2568 total width of the entry is off-screen to the top."""
2569 self.tk.call(self._w, 'yview', 'moveto', fraction)
2570 def yview_scroll(self, number, what):
2571 """Shift the y-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2572 self.tk.call(self._w, 'yview', 'scroll', number, what)
Guido van Rossum09f1ad82001-09-05 19:29:56 +00002573 def itemcget(self, index, option):
2574 """Return the resource value for an ITEM and an OPTION."""
2575 return self.tk.call(
2576 (self._w, 'itemcget') + (index, '-'+option))
Guido van Rossuma0adb922001-09-01 18:29:55 +00002577 def itemconfigure(self, index, cnf=None, **kw):
Guido van Rossum09f1ad82001-09-05 19:29:56 +00002578 """Configure resources of an ITEM.
Guido van Rossuma0adb922001-09-01 18:29:55 +00002579
2580 The values for resources are specified as keyword arguments.
2581 To get an overview about the allowed keyword arguments
2582 call the method without arguments.
2583 Valid resource names: background, bg, foreground, fg,
2584 selectbackground, selectforeground."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002585 return self._configure(('itemconfigure', index), cnf, kw)
Guido van Rossuma0adb922001-09-01 18:29:55 +00002586 itemconfig = itemconfigure
Guido van Rossum18468821994-06-20 07:49:28 +00002587
2588class Menu(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002589 """Menu widget which allows to display menu bars, pull-down menus and pop-up menus."""
2590 def __init__(self, master=None, cnf={}, **kw):
2591 """Construct menu widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002592
Fredrik Lundh06d28152000-08-09 18:03:12 +00002593 Valid resource names: activebackground, activeborderwidth,
2594 activeforeground, background, bd, bg, borderwidth, cursor,
2595 disabledforeground, fg, font, foreground, postcommand, relief,
2596 selectcolor, takefocus, tearoff, tearoffcommand, title, type."""
2597 Widget.__init__(self, master, 'menu', cnf, kw)
2598 def tk_bindForTraversal(self):
2599 pass # obsolete since Tk 4.0
2600 def tk_mbPost(self):
2601 self.tk.call('tk_mbPost', self._w)
2602 def tk_mbUnpost(self):
2603 self.tk.call('tk_mbUnpost')
2604 def tk_traverseToMenu(self, char):
2605 self.tk.call('tk_traverseToMenu', self._w, char)
2606 def tk_traverseWithinMenu(self, char):
2607 self.tk.call('tk_traverseWithinMenu', self._w, char)
2608 def tk_getMenuButtons(self):
2609 return self.tk.call('tk_getMenuButtons', self._w)
2610 def tk_nextMenu(self, count):
2611 self.tk.call('tk_nextMenu', count)
2612 def tk_nextMenuEntry(self, count):
2613 self.tk.call('tk_nextMenuEntry', count)
2614 def tk_invokeMenu(self):
2615 self.tk.call('tk_invokeMenu', self._w)
2616 def tk_firstMenu(self):
2617 self.tk.call('tk_firstMenu', self._w)
2618 def tk_mbButtonDown(self):
2619 self.tk.call('tk_mbButtonDown', self._w)
2620 def tk_popup(self, x, y, entry=""):
2621 """Post the menu at position X,Y with entry ENTRY."""
2622 self.tk.call('tk_popup', self._w, x, y, entry)
2623 def activate(self, index):
2624 """Activate entry at INDEX."""
2625 self.tk.call(self._w, 'activate', index)
2626 def add(self, itemType, cnf={}, **kw):
2627 """Internal function."""
2628 self.tk.call((self._w, 'add', itemType) +
2629 self._options(cnf, kw))
2630 def add_cascade(self, cnf={}, **kw):
2631 """Add hierarchical menu item."""
2632 self.add('cascade', cnf or kw)
2633 def add_checkbutton(self, cnf={}, **kw):
2634 """Add checkbutton menu item."""
2635 self.add('checkbutton', cnf or kw)
2636 def add_command(self, cnf={}, **kw):
2637 """Add command menu item."""
2638 self.add('command', cnf or kw)
2639 def add_radiobutton(self, cnf={}, **kw):
2640 """Addd radio menu item."""
2641 self.add('radiobutton', cnf or kw)
2642 def add_separator(self, cnf={}, **kw):
2643 """Add separator."""
2644 self.add('separator', cnf or kw)
2645 def insert(self, index, itemType, cnf={}, **kw):
2646 """Internal function."""
2647 self.tk.call((self._w, 'insert', index, itemType) +
2648 self._options(cnf, kw))
2649 def insert_cascade(self, index, cnf={}, **kw):
2650 """Add hierarchical menu item at INDEX."""
2651 self.insert(index, 'cascade', cnf or kw)
2652 def insert_checkbutton(self, index, cnf={}, **kw):
2653 """Add checkbutton menu item at INDEX."""
2654 self.insert(index, 'checkbutton', cnf or kw)
2655 def insert_command(self, index, cnf={}, **kw):
2656 """Add command menu item at INDEX."""
2657 self.insert(index, 'command', cnf or kw)
2658 def insert_radiobutton(self, index, cnf={}, **kw):
2659 """Addd radio menu item at INDEX."""
2660 self.insert(index, 'radiobutton', cnf or kw)
2661 def insert_separator(self, index, cnf={}, **kw):
2662 """Add separator at INDEX."""
2663 self.insert(index, 'separator', cnf or kw)
2664 def delete(self, index1, index2=None):
2665 """Delete menu items between INDEX1 and INDEX2 (not included)."""
2666 self.tk.call(self._w, 'delete', index1, index2)
2667 def entrycget(self, index, option):
2668 """Return the resource value of an menu item for OPTION at INDEX."""
2669 return self.tk.call(self._w, 'entrycget', index, '-' + option)
2670 def entryconfigure(self, index, cnf=None, **kw):
2671 """Configure a menu item at INDEX."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002672 return self._configure(('entryconfigure', index), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002673 entryconfig = entryconfigure
2674 def index(self, index):
2675 """Return the index of a menu item identified by INDEX."""
2676 i = self.tk.call(self._w, 'index', index)
2677 if i == 'none': return None
2678 return getint(i)
2679 def invoke(self, index):
2680 """Invoke a menu item identified by INDEX and execute
2681 the associated command."""
2682 return self.tk.call(self._w, 'invoke', index)
2683 def post(self, x, y):
2684 """Display a menu at position X,Y."""
2685 self.tk.call(self._w, 'post', x, y)
2686 def type(self, index):
2687 """Return the type of the menu item at INDEX."""
2688 return self.tk.call(self._w, 'type', index)
2689 def unpost(self):
2690 """Unmap a menu."""
2691 self.tk.call(self._w, 'unpost')
2692 def yposition(self, index):
2693 """Return the y-position of the topmost pixel of the menu item at INDEX."""
2694 return getint(self.tk.call(
2695 self._w, 'yposition', index))
Guido van Rossum18468821994-06-20 07:49:28 +00002696
2697class Menubutton(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002698 """Menubutton widget, obsolete since Tk8.0."""
2699 def __init__(self, master=None, cnf={}, **kw):
2700 Widget.__init__(self, master, 'menubutton', cnf, kw)
Guido van Rossum18468821994-06-20 07:49:28 +00002701
2702class Message(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002703 """Message widget to display multiline text. Obsolete since Label does it too."""
2704 def __init__(self, master=None, cnf={}, **kw):
2705 Widget.__init__(self, master, 'message', cnf, kw)
Guido van Rossum18468821994-06-20 07:49:28 +00002706
2707class Radiobutton(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002708 """Radiobutton widget which shows only one of several buttons in on-state."""
2709 def __init__(self, master=None, cnf={}, **kw):
2710 """Construct a radiobutton widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002711
Fredrik Lundh06d28152000-08-09 18:03:12 +00002712 Valid resource names: activebackground, activeforeground, anchor,
2713 background, bd, bg, bitmap, borderwidth, command, cursor,
2714 disabledforeground, fg, font, foreground, height,
2715 highlightbackground, highlightcolor, highlightthickness, image,
2716 indicatoron, justify, padx, pady, relief, selectcolor, selectimage,
2717 state, takefocus, text, textvariable, underline, value, variable,
2718 width, wraplength."""
2719 Widget.__init__(self, master, 'radiobutton', cnf, kw)
2720 def deselect(self):
2721 """Put the button in off-state."""
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002722
Fredrik Lundh06d28152000-08-09 18:03:12 +00002723 self.tk.call(self._w, 'deselect')
2724 def flash(self):
2725 """Flash the button."""
2726 self.tk.call(self._w, 'flash')
2727 def invoke(self):
2728 """Toggle the button and invoke a command if given as resource."""
2729 return self.tk.call(self._w, 'invoke')
2730 def select(self):
2731 """Put the button in on-state."""
2732 self.tk.call(self._w, 'select')
Guido van Rossum18468821994-06-20 07:49:28 +00002733
2734class Scale(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002735 """Scale widget which can display a numerical scale."""
2736 def __init__(self, master=None, cnf={}, **kw):
2737 """Construct a scale widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002738
Fredrik Lundh06d28152000-08-09 18:03:12 +00002739 Valid resource names: activebackground, background, bigincrement, bd,
2740 bg, borderwidth, command, cursor, digits, fg, font, foreground, from,
2741 highlightbackground, highlightcolor, highlightthickness, label,
2742 length, orient, relief, repeatdelay, repeatinterval, resolution,
2743 showvalue, sliderlength, sliderrelief, state, takefocus,
2744 tickinterval, to, troughcolor, variable, width."""
2745 Widget.__init__(self, master, 'scale', cnf, kw)
2746 def get(self):
2747 """Get the current value as integer or float."""
2748 value = self.tk.call(self._w, 'get')
2749 try:
2750 return getint(value)
2751 except ValueError:
2752 return getdouble(value)
2753 def set(self, value):
2754 """Set the value to VALUE."""
2755 self.tk.call(self._w, 'set', value)
2756 def coords(self, value=None):
2757 """Return a tuple (X,Y) of the point along the centerline of the
2758 trough that corresponds to VALUE or the current value if None is
2759 given."""
2760
2761 return self._getints(self.tk.call(self._w, 'coords', value))
2762 def identify(self, x, y):
2763 """Return where the point X,Y lies. Valid return values are "slider",
2764 "though1" and "though2"."""
2765 return self.tk.call(self._w, 'identify', x, y)
Guido van Rossum18468821994-06-20 07:49:28 +00002766
2767class Scrollbar(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002768 """Scrollbar widget which displays a slider at a certain position."""
2769 def __init__(self, master=None, cnf={}, **kw):
2770 """Construct a scrollbar widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002771
Fredrik Lundh06d28152000-08-09 18:03:12 +00002772 Valid resource names: activebackground, activerelief,
2773 background, bd, bg, borderwidth, command, cursor,
2774 elementborderwidth, highlightbackground,
2775 highlightcolor, highlightthickness, jump, orient,
2776 relief, repeatdelay, repeatinterval, takefocus,
2777 troughcolor, width."""
2778 Widget.__init__(self, master, 'scrollbar', cnf, kw)
2779 def activate(self, index):
2780 """Display the element at INDEX with activebackground and activerelief.
2781 INDEX can be "arrow1","slider" or "arrow2"."""
2782 self.tk.call(self._w, 'activate', index)
2783 def delta(self, deltax, deltay):
2784 """Return the fractional change of the scrollbar setting if it
2785 would be moved by DELTAX or DELTAY pixels."""
2786 return getdouble(
2787 self.tk.call(self._w, 'delta', deltax, deltay))
2788 def fraction(self, x, y):
2789 """Return the fractional value which corresponds to a slider
2790 position of X,Y."""
2791 return getdouble(self.tk.call(self._w, 'fraction', x, y))
2792 def identify(self, x, y):
2793 """Return the element under position X,Y as one of
2794 "arrow1","slider","arrow2" or ""."""
2795 return self.tk.call(self._w, 'identify', x, y)
2796 def get(self):
2797 """Return the current fractional values (upper and lower end)
2798 of the slider position."""
2799 return self._getdoubles(self.tk.call(self._w, 'get'))
2800 def set(self, *args):
2801 """Set the fractional values of the slider position (upper and
2802 lower ends as value between 0 and 1)."""
2803 self.tk.call((self._w, 'set') + args)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002804
2805
2806
Guido van Rossum18468821994-06-20 07:49:28 +00002807class Text(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002808 """Text widget which can display text in various forms."""
Fredrik Lundh06d28152000-08-09 18:03:12 +00002809 def __init__(self, master=None, cnf={}, **kw):
2810 """Construct a text widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00002811
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002812 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002813
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002814 background, borderwidth, cursor,
2815 exportselection, font, foreground,
2816 highlightbackground, highlightcolor,
2817 highlightthickness, insertbackground,
2818 insertborderwidth, insertofftime,
2819 insertontime, insertwidth, padx, pady,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002820 relief, selectbackground,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002821 selectborderwidth, selectforeground,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002822 setgrid, takefocus,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002823 xscrollcommand, yscrollcommand,
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002824
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002825 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002826
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002827 autoseparators, height, maxundo,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002828 spacing1, spacing2, spacing3,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002829 state, tabs, undo, width, wrap,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002830
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002831 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002832 Widget.__init__(self, master, 'text', cnf, kw)
2833 def bbox(self, *args):
2834 """Return a tuple of (x,y,width,height) which gives the bounding
2835 box of the visible part of the character at the index in ARGS."""
2836 return self._getints(
2837 self.tk.call((self._w, 'bbox') + args)) or None
2838 def tk_textSelectTo(self, index):
2839 self.tk.call('tk_textSelectTo', self._w, index)
2840 def tk_textBackspace(self):
2841 self.tk.call('tk_textBackspace', self._w)
2842 def tk_textIndexCloser(self, a, b, c):
2843 self.tk.call('tk_textIndexCloser', self._w, a, b, c)
2844 def tk_textResetAnchor(self, index):
2845 self.tk.call('tk_textResetAnchor', self._w, index)
2846 def compare(self, index1, op, index2):
2847 """Return whether between index INDEX1 and index INDEX2 the
2848 relation OP is satisfied. OP is one of <, <=, ==, >=, >, or !=."""
2849 return self.tk.getboolean(self.tk.call(
2850 self._w, 'compare', index1, op, index2))
2851 def debug(self, boolean=None):
2852 """Turn on the internal consistency checks of the B-Tree inside the text
2853 widget according to BOOLEAN."""
2854 return self.tk.getboolean(self.tk.call(
2855 self._w, 'debug', boolean))
2856 def delete(self, index1, index2=None):
2857 """Delete the characters between INDEX1 and INDEX2 (not included)."""
2858 self.tk.call(self._w, 'delete', index1, index2)
2859 def dlineinfo(self, index):
2860 """Return tuple (x,y,width,height,baseline) giving the bounding box
2861 and baseline position of the visible part of the line containing
2862 the character at INDEX."""
2863 return self._getints(self.tk.call(self._w, 'dlineinfo', index))
Guido van Rossum256705b2002-04-23 13:29:43 +00002864 def dump(self, index1, index2=None, command=None, **kw):
2865 """Return the contents of the widget between index1 and index2.
Raymond Hettingerff41c482003-04-06 09:01:11 +00002866
Guido van Rossum256705b2002-04-23 13:29:43 +00002867 The type of contents returned in filtered based on the keyword
2868 parameters; if 'all', 'image', 'mark', 'tag', 'text', or 'window' are
2869 given and true, then the corresponding items are returned. The result
2870 is a list of triples of the form (key, value, index). If none of the
2871 keywords are true then 'all' is used by default.
Raymond Hettingerff41c482003-04-06 09:01:11 +00002872
Guido van Rossum256705b2002-04-23 13:29:43 +00002873 If the 'command' argument is given, it is called once for each element
2874 of the list of triples, with the values of each triple serving as the
2875 arguments to the function. In this case the list is not returned."""
2876 args = []
2877 func_name = None
2878 result = None
2879 if not command:
2880 # Never call the dump command without the -command flag, since the
2881 # output could involve Tcl quoting and would be a pain to parse
2882 # right. Instead just set the command to build a list of triples
2883 # as if we had done the parsing.
2884 result = []
2885 def append_triple(key, value, index, result=result):
2886 result.append((key, value, index))
2887 command = append_triple
2888 try:
2889 if not isinstance(command, str):
2890 func_name = command = self._register(command)
2891 args += ["-command", command]
2892 for key in kw:
2893 if kw[key]: args.append("-" + key)
2894 args.append(index1)
2895 if index2:
2896 args.append(index2)
2897 self.tk.call(self._w, "dump", *args)
2898 return result
2899 finally:
2900 if func_name:
2901 self.deletecommand(func_name)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002902
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002903 ## new in tk8.4
2904 def edit(self, *args):
2905 """Internal method
Raymond Hettingerff41c482003-04-06 09:01:11 +00002906
2907 This method controls the undo mechanism and
2908 the modified flag. The exact behavior of the
2909 command depends on the option argument that
2910 follows the edit argument. The following forms
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002911 of the command are currently supported:
Raymond Hettingerff41c482003-04-06 09:01:11 +00002912
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002913 edit_modified, edit_redo, edit_reset, edit_separator
2914 and edit_undo
Raymond Hettingerff41c482003-04-06 09:01:11 +00002915
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002916 """
2917 return self._getints(
2918 self.tk.call((self._w, 'edit') + args)) or ()
2919
2920 def edit_modified(self, arg=None):
2921 """Get or Set the modified flag
Raymond Hettingerff41c482003-04-06 09:01:11 +00002922
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002923 If arg is not specified, returns the modified
Raymond Hettingerff41c482003-04-06 09:01:11 +00002924 flag of the widget. The insert, delete, edit undo and
2925 edit redo commands or the user can set or clear the
2926 modified flag. If boolean is specified, sets the
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002927 modified flag of the widget to arg.
2928 """
2929 return self.edit("modified", arg)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002930
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002931 def edit_redo(self):
2932 """Redo the last undone edit
Raymond Hettingerff41c482003-04-06 09:01:11 +00002933
2934 When the undo option is true, reapplies the last
2935 undone edits provided no other edits were done since
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002936 then. Generates an error when the redo stack is empty.
2937 Does nothing when the undo option is false.
2938 """
2939 return self.edit("redo")
Raymond Hettingerff41c482003-04-06 09:01:11 +00002940
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002941 def edit_reset(self):
2942 """Clears the undo and redo stacks
2943 """
2944 return self.edit("reset")
Raymond Hettingerff41c482003-04-06 09:01:11 +00002945
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002946 def edit_separator(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00002947 """Inserts a separator (boundary) on the undo stack.
2948
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002949 Does nothing when the undo option is false
2950 """
2951 return self.edit("separator")
Raymond Hettingerff41c482003-04-06 09:01:11 +00002952
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002953 def edit_undo(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00002954 """Undoes the last edit action
2955
2956 If the undo option is true. An edit action is defined
2957 as all the insert and delete commands that are recorded
2958 on the undo stack in between two separators. Generates
2959 an error when the undo stack is empty. Does nothing
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002960 when the undo option is false
2961 """
2962 return self.edit("undo")
Raymond Hettingerff41c482003-04-06 09:01:11 +00002963
Fredrik Lundh06d28152000-08-09 18:03:12 +00002964 def get(self, index1, index2=None):
2965 """Return the text from INDEX1 to INDEX2 (not included)."""
2966 return self.tk.call(self._w, 'get', index1, index2)
2967 # (Image commands are new in 8.0)
2968 def image_cget(self, index, option):
2969 """Return the value of OPTION of an embedded image at INDEX."""
2970 if option[:1] != "-":
2971 option = "-" + option
2972 if option[-1:] == "_":
2973 option = option[:-1]
2974 return self.tk.call(self._w, "image", "cget", index, option)
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002975 def image_configure(self, index, cnf=None, **kw):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002976 """Configure an embedded image at INDEX."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002977 return self._configure(('image', 'configure', index), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002978 def image_create(self, index, cnf={}, **kw):
2979 """Create an embedded image at INDEX."""
Raymond Hettingerff41c482003-04-06 09:01:11 +00002980 return self.tk.call(
2981 self._w, "image", "create", index,
2982 *self._options(cnf, kw))
Fredrik Lundh06d28152000-08-09 18:03:12 +00002983 def image_names(self):
2984 """Return all names of embedded images in this widget."""
2985 return self.tk.call(self._w, "image", "names")
2986 def index(self, index):
2987 """Return the index in the form line.char for INDEX."""
2988 return self.tk.call(self._w, 'index', index)
2989 def insert(self, index, chars, *args):
2990 """Insert CHARS before the characters at INDEX. An additional
2991 tag can be given in ARGS. Additional CHARS and tags can follow in ARGS."""
2992 self.tk.call((self._w, 'insert', index, chars) + args)
2993 def mark_gravity(self, markName, direction=None):
2994 """Change the gravity of a mark MARKNAME to DIRECTION (LEFT or RIGHT).
2995 Return the current value if None is given for DIRECTION."""
2996 return self.tk.call(
2997 (self._w, 'mark', 'gravity', markName, direction))
2998 def mark_names(self):
2999 """Return all mark names."""
3000 return self.tk.splitlist(self.tk.call(
3001 self._w, 'mark', 'names'))
3002 def mark_set(self, markName, index):
3003 """Set mark MARKNAME before the character at INDEX."""
3004 self.tk.call(self._w, 'mark', 'set', markName, index)
3005 def mark_unset(self, *markNames):
3006 """Delete all marks in MARKNAMES."""
3007 self.tk.call((self._w, 'mark', 'unset') + markNames)
3008 def mark_next(self, index):
3009 """Return the name of the next mark after INDEX."""
3010 return self.tk.call(self._w, 'mark', 'next', index) or None
3011 def mark_previous(self, index):
3012 """Return the name of the previous mark before INDEX."""
3013 return self.tk.call(self._w, 'mark', 'previous', index) or None
3014 def scan_mark(self, x, y):
3015 """Remember the current X, Y coordinates."""
3016 self.tk.call(self._w, 'scan', 'mark', x, y)
3017 def scan_dragto(self, x, y):
3018 """Adjust the view of the text to 10 times the
3019 difference between X and Y and the coordinates given in
3020 scan_mark."""
3021 self.tk.call(self._w, 'scan', 'dragto', x, y)
3022 def search(self, pattern, index, stopindex=None,
3023 forwards=None, backwards=None, exact=None,
3024 regexp=None, nocase=None, count=None):
3025 """Search PATTERN beginning from INDEX until STOPINDEX.
3026 Return the index of the first character of a match or an empty string."""
3027 args = [self._w, 'search']
3028 if forwards: args.append('-forwards')
3029 if backwards: args.append('-backwards')
3030 if exact: args.append('-exact')
3031 if regexp: args.append('-regexp')
3032 if nocase: args.append('-nocase')
3033 if count: args.append('-count'); args.append(count)
3034 if pattern[0] == '-': args.append('--')
3035 args.append(pattern)
3036 args.append(index)
3037 if stopindex: args.append(stopindex)
3038 return self.tk.call(tuple(args))
3039 def see(self, index):
3040 """Scroll such that the character at INDEX is visible."""
3041 self.tk.call(self._w, 'see', index)
3042 def tag_add(self, tagName, index1, *args):
3043 """Add tag TAGNAME to all characters between INDEX1 and index2 in ARGS.
3044 Additional pairs of indices may follow in ARGS."""
3045 self.tk.call(
3046 (self._w, 'tag', 'add', tagName, index1) + args)
3047 def tag_unbind(self, tagName, sequence, funcid=None):
3048 """Unbind for all characters with TAGNAME for event SEQUENCE the
3049 function identified with FUNCID."""
3050 self.tk.call(self._w, 'tag', 'bind', tagName, sequence, '')
3051 if funcid:
3052 self.deletecommand(funcid)
3053 def tag_bind(self, tagName, sequence, func, add=None):
3054 """Bind to all characters with TAGNAME at event SEQUENCE a call to function FUNC.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00003055
Fredrik Lundh06d28152000-08-09 18:03:12 +00003056 An additional boolean parameter ADD specifies whether FUNC will be
3057 called additionally to the other bound function or whether it will
3058 replace the previous function. See bind for the return value."""
3059 return self._bind((self._w, 'tag', 'bind', tagName),
3060 sequence, func, add)
3061 def tag_cget(self, tagName, option):
3062 """Return the value of OPTION for tag TAGNAME."""
3063 if option[:1] != '-':
3064 option = '-' + option
3065 if option[-1:] == '_':
3066 option = option[:-1]
3067 return self.tk.call(self._w, 'tag', 'cget', tagName, option)
Martin v. Löwis6ce13152002-10-10 14:36:13 +00003068 def tag_configure(self, tagName, cnf=None, **kw):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003069 """Configure a tag TAGNAME."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00003070 return self._configure(('tag', 'configure', tagName), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00003071 tag_config = tag_configure
3072 def tag_delete(self, *tagNames):
3073 """Delete all tags in TAGNAMES."""
3074 self.tk.call((self._w, 'tag', 'delete') + tagNames)
3075 def tag_lower(self, tagName, belowThis=None):
3076 """Change the priority of tag TAGNAME such that it is lower
3077 than the priority of BELOWTHIS."""
3078 self.tk.call(self._w, 'tag', 'lower', tagName, belowThis)
3079 def tag_names(self, index=None):
3080 """Return a list of all tag names."""
3081 return self.tk.splitlist(
3082 self.tk.call(self._w, 'tag', 'names', index))
3083 def tag_nextrange(self, tagName, index1, index2=None):
3084 """Return a list of start and end index for the first sequence of
3085 characters between INDEX1 and INDEX2 which all have tag TAGNAME.
3086 The text is searched forward from INDEX1."""
3087 return self.tk.splitlist(self.tk.call(
3088 self._w, 'tag', 'nextrange', tagName, index1, index2))
3089 def tag_prevrange(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 backwards from INDEX1."""
3093 return self.tk.splitlist(self.tk.call(
3094 self._w, 'tag', 'prevrange', tagName, index1, index2))
3095 def tag_raise(self, tagName, aboveThis=None):
3096 """Change the priority of tag TAGNAME such that it is higher
3097 than the priority of ABOVETHIS."""
3098 self.tk.call(
3099 self._w, 'tag', 'raise', tagName, aboveThis)
3100 def tag_ranges(self, tagName):
3101 """Return a list of ranges of text which have tag TAGNAME."""
3102 return self.tk.splitlist(self.tk.call(
3103 self._w, 'tag', 'ranges', tagName))
3104 def tag_remove(self, tagName, index1, index2=None):
3105 """Remove tag TAGNAME from all characters between INDEX1 and INDEX2."""
3106 self.tk.call(
3107 self._w, 'tag', 'remove', tagName, index1, index2)
3108 def window_cget(self, index, option):
3109 """Return the value of OPTION of an embedded window at INDEX."""
3110 if option[:1] != '-':
3111 option = '-' + option
3112 if option[-1:] == '_':
3113 option = option[:-1]
3114 return self.tk.call(self._w, 'window', 'cget', index, option)
Martin v. Löwis6ce13152002-10-10 14:36:13 +00003115 def window_configure(self, index, cnf=None, **kw):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003116 """Configure an embedded window at INDEX."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00003117 return self._configure(('window', 'configure', index), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00003118 window_config = window_configure
3119 def window_create(self, index, cnf={}, **kw):
3120 """Create a window at INDEX."""
3121 self.tk.call(
3122 (self._w, 'window', 'create', index)
3123 + self._options(cnf, kw))
3124 def window_names(self):
3125 """Return all names of embedded windows in this widget."""
3126 return self.tk.splitlist(
3127 self.tk.call(self._w, 'window', 'names'))
3128 def xview(self, *what):
3129 """Query and change horizontal position of the view."""
3130 if not what:
3131 return self._getdoubles(self.tk.call(self._w, 'xview'))
3132 self.tk.call((self._w, 'xview') + what)
Fredrik Lundh5bd2cd62000-08-09 18:29:51 +00003133 def xview_moveto(self, fraction):
3134 """Adjusts the view in the window so that FRACTION of the
3135 total width of the canvas is off-screen to the left."""
3136 self.tk.call(self._w, 'xview', 'moveto', fraction)
3137 def xview_scroll(self, number, what):
3138 """Shift the x-view according to NUMBER which is measured
3139 in "units" or "pages" (WHAT)."""
3140 self.tk.call(self._w, 'xview', 'scroll', number, what)
Fredrik Lundh8fffa202000-08-09 18:51:01 +00003141 def yview(self, *what):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003142 """Query and change vertical position of the view."""
Fredrik Lundh8fffa202000-08-09 18:51:01 +00003143 if not what:
Fredrik Lundh06d28152000-08-09 18:03:12 +00003144 return self._getdoubles(self.tk.call(self._w, 'yview'))
Fredrik Lundh8fffa202000-08-09 18:51:01 +00003145 self.tk.call((self._w, 'yview') + what)
Fredrik Lundh5bd2cd62000-08-09 18:29:51 +00003146 def yview_moveto(self, fraction):
3147 """Adjusts the view in the window so that FRACTION of the
3148 total height of the canvas is off-screen to the top."""
3149 self.tk.call(self._w, 'yview', 'moveto', fraction)
3150 def yview_scroll(self, number, what):
3151 """Shift the y-view according to NUMBER which is measured
3152 in "units" or "pages" (WHAT)."""
3153 self.tk.call(self._w, 'yview', 'scroll', number, what)
Fredrik Lundh06d28152000-08-09 18:03:12 +00003154 def yview_pickplace(self, *what):
3155 """Obsolete function, use see."""
3156 self.tk.call((self._w, 'yview', '-pickplace') + what)
Guido van Rossum18468821994-06-20 07:49:28 +00003157
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003158
Guido van Rossum28574b51996-10-21 15:16:51 +00003159class _setit:
Fredrik Lundh06d28152000-08-09 18:03:12 +00003160 """Internal class. It wraps the command in the widget OptionMenu."""
3161 def __init__(self, var, value, callback=None):
3162 self.__value = value
3163 self.__var = var
3164 self.__callback = callback
3165 def __call__(self, *args):
3166 self.__var.set(self.__value)
3167 if self.__callback:
Raymond Hettingerff41c482003-04-06 09:01:11 +00003168 self.__callback(self.__value, *args)
Guido van Rossum28574b51996-10-21 15:16:51 +00003169
3170class OptionMenu(Menubutton):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003171 """OptionMenu which allows the user to select a value from a menu."""
3172 def __init__(self, master, variable, value, *values, **kwargs):
3173 """Construct an optionmenu widget with the parent MASTER, with
3174 the resource textvariable set to VARIABLE, the initially selected
3175 value VALUE, the other menu values VALUES and an additional
3176 keyword argument command."""
3177 kw = {"borderwidth": 2, "textvariable": variable,
3178 "indicatoron": 1, "relief": RAISED, "anchor": "c",
3179 "highlightthickness": 2}
3180 Widget.__init__(self, master, "menubutton", kw)
3181 self.widgetName = 'tk_optionMenu'
3182 menu = self.__menu = Menu(self, name="menu", tearoff=0)
3183 self.menuname = menu._w
3184 # 'command' is the only supported keyword
3185 callback = kwargs.get('command')
3186 if kwargs.has_key('command'):
3187 del kwargs['command']
3188 if kwargs:
3189 raise TclError, 'unknown option -'+kwargs.keys()[0]
3190 menu.add_command(label=value,
3191 command=_setit(variable, value, callback))
3192 for v in values:
3193 menu.add_command(label=v,
3194 command=_setit(variable, v, callback))
3195 self["menu"] = menu
Guido van Rossum28574b51996-10-21 15:16:51 +00003196
Fredrik Lundh06d28152000-08-09 18:03:12 +00003197 def __getitem__(self, name):
3198 if name == 'menu':
3199 return self.__menu
3200 return Widget.__getitem__(self, name)
Guido van Rossum28574b51996-10-21 15:16:51 +00003201
Fredrik Lundh06d28152000-08-09 18:03:12 +00003202 def destroy(self):
3203 """Destroy this widget and the associated menu."""
3204 Menubutton.destroy(self)
3205 self.__menu = None
Guido van Rossumbf4d8f91995-09-01 20:35:37 +00003206
Guido van Rossum35f67fb1995-08-04 03:50:29 +00003207class Image:
Fredrik Lundh06d28152000-08-09 18:03:12 +00003208 """Base class for images."""
Martin v. Löwis0d8ce612000-09-08 16:28:30 +00003209 _last_id = 0
Fredrik Lundh06d28152000-08-09 18:03:12 +00003210 def __init__(self, imgtype, name=None, cnf={}, master=None, **kw):
3211 self.name = None
3212 if not master:
3213 master = _default_root
3214 if not master:
3215 raise RuntimeError, 'Too early to create image'
3216 self.tk = master.tk
3217 if not name:
Martin v. Löwis0d8ce612000-09-08 16:28:30 +00003218 Image._last_id += 1
Walter Dörwald70a6b492004-02-12 17:35:32 +00003219 name = "pyimage%r" % (Image._last_id,) # tk itself would use image<x>
Fredrik Lundh06d28152000-08-09 18:03:12 +00003220 # The following is needed for systems where id(x)
3221 # can return a negative number, such as Linux/m68k:
3222 if name[0] == '-': name = '_' + name[1:]
3223 if kw and cnf: cnf = _cnfmerge((cnf, kw))
3224 elif kw: cnf = kw
3225 options = ()
3226 for k, v in cnf.items():
3227 if callable(v):
3228 v = self._register(v)
3229 options = options + ('-'+k, v)
3230 self.tk.call(('image', 'create', imgtype, name,) + options)
3231 self.name = name
3232 def __str__(self): return self.name
3233 def __del__(self):
3234 if self.name:
3235 try:
3236 self.tk.call('image', 'delete', self.name)
3237 except TclError:
3238 # May happen if the root was destroyed
3239 pass
3240 def __setitem__(self, key, value):
3241 self.tk.call(self.name, 'configure', '-'+key, value)
3242 def __getitem__(self, key):
3243 return self.tk.call(self.name, 'configure', '-'+key)
3244 def configure(self, **kw):
3245 """Configure the image."""
3246 res = ()
3247 for k, v in _cnfmerge(kw).items():
3248 if v is not None:
3249 if k[-1] == '_': k = k[:-1]
3250 if callable(v):
3251 v = self._register(v)
3252 res = res + ('-'+k, v)
3253 self.tk.call((self.name, 'config') + res)
3254 config = configure
3255 def height(self):
3256 """Return the height of the image."""
3257 return getint(
3258 self.tk.call('image', 'height', self.name))
3259 def type(self):
3260 """Return the type of the imgage, e.g. "photo" or "bitmap"."""
3261 return self.tk.call('image', 'type', self.name)
3262 def width(self):
3263 """Return the width of the image."""
3264 return getint(
3265 self.tk.call('image', 'width', self.name))
Guido van Rossum35f67fb1995-08-04 03:50:29 +00003266
3267class PhotoImage(Image):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003268 """Widget which can display colored images in GIF, PPM/PGM format."""
3269 def __init__(self, name=None, cnf={}, master=None, **kw):
3270 """Create an image with NAME.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00003271
Fredrik Lundh06d28152000-08-09 18:03:12 +00003272 Valid resource names: data, format, file, gamma, height, palette,
3273 width."""
Raymond Hettingerff41c482003-04-06 09:01:11 +00003274 Image.__init__(self, 'photo', name, cnf, master, **kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00003275 def blank(self):
3276 """Display a transparent image."""
3277 self.tk.call(self.name, 'blank')
3278 def cget(self, option):
3279 """Return the value of OPTION."""
3280 return self.tk.call(self.name, 'cget', '-' + option)
3281 # XXX config
3282 def __getitem__(self, key):
3283 return self.tk.call(self.name, 'cget', '-' + key)
3284 # XXX copy -from, -to, ...?
3285 def copy(self):
3286 """Return a new PhotoImage with the same image as this widget."""
3287 destImage = PhotoImage()
3288 self.tk.call(destImage, 'copy', self.name)
3289 return destImage
3290 def zoom(self,x,y=''):
3291 """Return a new PhotoImage with the same image as this widget
3292 but zoom it with X and Y."""
3293 destImage = PhotoImage()
3294 if y=='': y=x
3295 self.tk.call(destImage, 'copy', self.name, '-zoom',x,y)
3296 return destImage
3297 def subsample(self,x,y=''):
3298 """Return a new PhotoImage based on the same image as this widget
3299 but use only every Xth or Yth pixel."""
3300 destImage = PhotoImage()
3301 if y=='': y=x
3302 self.tk.call(destImage, 'copy', self.name, '-subsample',x,y)
3303 return destImage
3304 def get(self, x, y):
3305 """Return the color (red, green, blue) of the pixel at X,Y."""
3306 return self.tk.call(self.name, 'get', x, y)
3307 def put(self, data, to=None):
3308 """Put row formated colors to image starting from
3309 position TO, e.g. image.put("{red green} {blue yellow}", to=(4,6))"""
3310 args = (self.name, 'put', data)
3311 if to:
3312 if to[0] == '-to':
3313 to = to[1:]
3314 args = args + ('-to',) + tuple(to)
3315 self.tk.call(args)
3316 # XXX read
3317 def write(self, filename, format=None, from_coords=None):
3318 """Write image to file FILENAME in FORMAT starting from
3319 position FROM_COORDS."""
3320 args = (self.name, 'write', filename)
3321 if format:
3322 args = args + ('-format', format)
3323 if from_coords:
3324 args = args + ('-from',) + tuple(from_coords)
3325 self.tk.call(args)
Guido van Rossum35f67fb1995-08-04 03:50:29 +00003326
3327class BitmapImage(Image):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003328 """Widget which can display a bitmap."""
3329 def __init__(self, name=None, cnf={}, master=None, **kw):
3330 """Create a bitmap with NAME.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00003331
Fredrik Lundh06d28152000-08-09 18:03:12 +00003332 Valid resource names: background, data, file, foreground, maskdata, maskfile."""
Raymond Hettingerff41c482003-04-06 09:01:11 +00003333 Image.__init__(self, 'bitmap', name, cnf, master, **kw)
Guido van Rossum35f67fb1995-08-04 03:50:29 +00003334
3335def image_names(): return _default_root.tk.call('image', 'names')
3336def image_types(): return _default_root.tk.call('image', 'types')
3337
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003338
3339class Spinbox(Widget):
3340 """spinbox widget."""
3341 def __init__(self, master=None, cnf={}, **kw):
3342 """Construct a spinbox widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003343
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003344 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003345
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003346 activebackground, background, borderwidth,
3347 cursor, exportselection, font, foreground,
3348 highlightbackground, highlightcolor,
3349 highlightthickness, insertbackground,
3350 insertborderwidth, insertofftime,
Raymond Hettingerff41c482003-04-06 09:01:11 +00003351 insertontime, insertwidth, justify, relief,
3352 repeatdelay, repeatinterval,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003353 selectbackground, selectborderwidth
3354 selectforeground, takefocus, textvariable
3355 xscrollcommand.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003356
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003357 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003358
3359 buttonbackground, buttoncursor,
3360 buttondownrelief, buttonuprelief,
3361 command, disabledbackground,
3362 disabledforeground, format, from,
3363 invalidcommand, increment,
3364 readonlybackground, state, to,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003365 validate, validatecommand values,
3366 width, wrap,
3367 """
3368 Widget.__init__(self, master, 'spinbox', cnf, kw)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003369
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003370 def bbox(self, index):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003371 """Return a tuple of X1,Y1,X2,Y2 coordinates for a
3372 rectangle which encloses the character given by index.
3373
3374 The first two elements of the list give the x and y
3375 coordinates of the upper-left corner of the screen
3376 area covered by the character (in pixels relative
3377 to the widget) and the last two elements give the
3378 width and height of the character, in pixels. The
3379 bounding box may refer to a region outside the
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003380 visible area of the window.
3381 """
3382 return self.tk.call(self._w, 'bbox', index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003383
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003384 def delete(self, first, last=None):
3385 """Delete one or more elements of the spinbox.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003386
3387 First is the index of the first character to delete,
3388 and last is the index of the character just after
3389 the last one to delete. If last isn't specified it
3390 defaults to first+1, i.e. a single character is
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003391 deleted. This command returns an empty string.
3392 """
3393 return self.tk.call(self._w, 'delete', first, last)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003394
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003395 def get(self):
3396 """Returns the spinbox's string"""
3397 return self.tk.call(self._w, 'get')
Raymond Hettingerff41c482003-04-06 09:01:11 +00003398
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003399 def icursor(self, index):
3400 """Alter the position of the insertion cursor.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003401
3402 The insertion cursor will be displayed just before
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003403 the character given by index. Returns an empty string
3404 """
3405 return self.tk.call(self._w, 'icursor', index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003406
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003407 def identify(self, x, y):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003408 """Returns the name of the widget at position x, y
3409
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003410 Return value is one of: none, buttondown, buttonup, entry
3411 """
3412 return self.tk.call(self._w, 'identify', x, y)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003413
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003414 def index(self, index):
3415 """Returns the numerical index corresponding to index
3416 """
3417 return self.tk.call(self._w, 'index', index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003418
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003419 def insert(self, index, s):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003420 """Insert string s at index
3421
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003422 Returns an empty string.
3423 """
3424 return self.tk.call(self._w, 'insert', index, s)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003425
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003426 def invoke(self, element):
3427 """Causes the specified element to be invoked
Raymond Hettingerff41c482003-04-06 09:01:11 +00003428
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003429 The element could be buttondown or buttonup
3430 triggering the action associated with it.
3431 """
3432 return self.tk.call(self._w, 'invoke', element)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003433
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003434 def scan(self, *args):
3435 """Internal function."""
3436 return self._getints(
3437 self.tk.call((self._w, 'scan') + args)) or ()
Raymond Hettingerff41c482003-04-06 09:01:11 +00003438
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003439 def scan_mark(self, x):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003440 """Records x and the current view in the spinbox window;
3441
3442 used in conjunction with later scan dragto commands.
3443 Typically this command is associated with a mouse button
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003444 press in the widget. It returns an empty string.
3445 """
3446 return self.scan("mark", x)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003447
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003448 def scan_dragto(self, x):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003449 """Compute the difference between the given x argument
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003450 and the x argument to the last scan mark command
Raymond Hettingerff41c482003-04-06 09:01:11 +00003451
3452 It then adjusts the view left or right by 10 times the
3453 difference in x-coordinates. This command is typically
3454 associated with mouse motion events in the widget, to
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003455 produce the effect of dragging the spinbox at high speed
3456 through the window. The return value is an empty string.
3457 """
3458 return self.scan("dragto", x)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003459
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003460 def selection(self, *args):
3461 """Internal function."""
3462 return self._getints(
3463 self.tk.call((self._w, 'selection') + args)) or ()
Raymond Hettingerff41c482003-04-06 09:01:11 +00003464
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003465 def selection_adjust(self, index):
3466 """Locate the end of the selection nearest to the character
Raymond Hettingerff41c482003-04-06 09:01:11 +00003467 given by index,
3468
3469 Then adjust that end of the selection to be at index
3470 (i.e including but not going beyond index). The other
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003471 end of the selection is made the anchor point for future
Raymond Hettingerff41c482003-04-06 09:01:11 +00003472 select to commands. If the selection isn't currently in
3473 the spinbox, then a new selection is created to include
3474 the characters between index and the most recent selection
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003475 anchor point, inclusive. Returns an empty string.
3476 """
3477 return self.selection("adjust", index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003478
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003479 def selection_clear(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003480 """Clear the selection
3481
3482 If the selection isn't in this widget then the
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003483 command has no effect. Returns an empty string.
3484 """
3485 return self.selection("clear")
Raymond Hettingerff41c482003-04-06 09:01:11 +00003486
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003487 def selection_element(self, element=None):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003488 """Sets or gets the currently selected element.
3489
3490 If a spinbutton element is specified, it will be
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003491 displayed depressed
3492 """
3493 return self.selection("element", element)
3494
3495###########################################################################
3496
3497class LabelFrame(Widget):
3498 """labelframe widget."""
3499 def __init__(self, master=None, cnf={}, **kw):
3500 """Construct a labelframe widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003501
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003502 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003503
3504 borderwidth, cursor, font, foreground,
3505 highlightbackground, highlightcolor,
3506 highlightthickness, padx, pady, relief,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003507 takefocus, text
Raymond Hettingerff41c482003-04-06 09:01:11 +00003508
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003509 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003510
3511 background, class, colormap, container,
3512 height, labelanchor, labelwidget,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003513 visual, width
3514 """
3515 Widget.__init__(self, master, 'labelframe', cnf, kw)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003516
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003517########################################################################
3518
3519class PanedWindow(Widget):
3520 """panedwindow widget."""
3521 def __init__(self, master=None, cnf={}, **kw):
3522 """Construct a panedwindow widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003523
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003524 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003525
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003526 background, borderwidth, cursor, height,
3527 orient, relief, width
Raymond Hettingerff41c482003-04-06 09:01:11 +00003528
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003529 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003530
3531 handlepad, handlesize, opaqueresize,
3532 sashcursor, sashpad, sashrelief,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003533 sashwidth, showhandle,
3534 """
3535 Widget.__init__(self, master, 'panedwindow', cnf, kw)
3536
3537 def add(self, child, **kw):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003538 """Add a child widget to the panedwindow in a new pane.
3539
3540 The child argument is the name of the child widget
3541 followed by pairs of arguments that specify how to
3542 manage the windows. Options may have any of the values
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003543 accepted by the configure subcommand.
3544 """
3545 self.tk.call((self._w, 'add', child) + self._options(kw))
Raymond Hettingerff41c482003-04-06 09:01:11 +00003546
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003547 def remove(self, child):
3548 """Remove the pane containing child from the panedwindow
Raymond Hettingerff41c482003-04-06 09:01:11 +00003549
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003550 All geometry management options for child will be forgotten.
3551 """
3552 self.tk.call(self._w, 'forget', child)
3553 forget=remove
Raymond Hettingerff41c482003-04-06 09:01:11 +00003554
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003555 def identify(self, x, y):
3556 """Identify the panedwindow component at point x, y
Raymond Hettingerff41c482003-04-06 09:01:11 +00003557
3558 If the point is over a sash or a sash handle, the result
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003559 is a two element list containing the index of the sash or
Raymond Hettingerff41c482003-04-06 09:01:11 +00003560 handle, and a word indicating whether it is over a sash
3561 or a handle, such as {0 sash} or {2 handle}. If the point
3562 is over any other part of the panedwindow, the result is
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003563 an empty list.
3564 """
3565 return self.tk.call(self._w, 'identify', x, y)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003566
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003567 def proxy(self, *args):
3568 """Internal function."""
3569 return self._getints(
Raymond Hettingerff41c482003-04-06 09:01:11 +00003570 self.tk.call((self._w, 'proxy') + args)) or ()
3571
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003572 def proxy_coord(self):
3573 """Return the x and y pair of the most recent proxy location
3574 """
3575 return self.proxy("coord")
Raymond Hettingerff41c482003-04-06 09:01:11 +00003576
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003577 def proxy_forget(self):
3578 """Remove the proxy from the display.
3579 """
3580 return self.proxy("forget")
Raymond Hettingerff41c482003-04-06 09:01:11 +00003581
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003582 def proxy_place(self, x, y):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003583 """Place the proxy at the given x and y coordinates.
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003584 """
3585 return self.proxy("place", x, y)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003586
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003587 def sash(self, *args):
3588 """Internal function."""
3589 return self._getints(
3590 self.tk.call((self._w, 'sash') + args)) or ()
Raymond Hettingerff41c482003-04-06 09:01:11 +00003591
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003592 def sash_coord(self, index):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003593 """Return the current x and y pair for the sash given by index.
3594
3595 Index must be an integer between 0 and 1 less than the
3596 number of panes in the panedwindow. The coordinates given are
3597 those of the top left corner of the region containing the sash.
3598 pathName sash dragto index x y This command computes the
3599 difference between the given coordinates and the coordinates
3600 given to the last sash coord command for the given sash. It then
3601 moves that sash the computed difference. The return value is the
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003602 empty string.
3603 """
3604 return self.sash("coord", index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003605
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003606 def sash_mark(self, index):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003607 """Records x and y for the sash given by index;
3608
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003609 Used in conjunction with later dragto commands to move the sash.
3610 """
3611 return self.sash("mark", index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003612
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003613 def sash_place(self, index, x, y):
3614 """Place the sash given by index at the given coordinates
3615 """
3616 return self.sash("place", index, x, y)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003617
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003618 def panecget(self, child, option):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003619 """Query a management option for window.
3620
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003621 Option may be any value allowed by the paneconfigure subcommand
3622 """
3623 return self.tk.call(
3624 (self._w, 'panecget') + (child, '-'+option))
Raymond Hettingerff41c482003-04-06 09:01:11 +00003625
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003626 def paneconfigure(self, tagOrId, cnf=None, **kw):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003627 """Query or modify the management options for window.
3628
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003629 If no option is specified, returns a list describing all
Raymond Hettingerff41c482003-04-06 09:01:11 +00003630 of the available options for pathName. If option is
3631 specified with no value, then the command returns a list
3632 describing the one named option (this list will be identical
3633 to the corresponding sublist of the value returned if no
3634 option is specified). If one or more option-value pairs are
3635 specified, then the command modifies the given widget
3636 option(s) to have the given value(s); in this case the
3637 command returns an empty string. The following options
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003638 are supported:
Raymond Hettingerff41c482003-04-06 09:01:11 +00003639
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003640 after window
Raymond Hettingerff41c482003-04-06 09:01:11 +00003641 Insert the window after the window specified. window
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003642 should be the name of a window already managed by pathName.
3643 before window
Raymond Hettingerff41c482003-04-06 09:01:11 +00003644 Insert the window before the window specified. window
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003645 should be the name of a window already managed by pathName.
3646 height size
Raymond Hettingerff41c482003-04-06 09:01:11 +00003647 Specify a height for the window. The height will be the
3648 outer dimension of the window including its border, if
3649 any. If size is an empty string, or if -height is not
3650 specified, then the height requested internally by the
3651 window will be used initially; the height may later be
3652 adjusted by the movement of sashes in the panedwindow.
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003653 Size may be any value accepted by Tk_GetPixels.
3654 minsize n
Raymond Hettingerff41c482003-04-06 09:01:11 +00003655 Specifies that the size of the window cannot be made
3656 less than n. This constraint only affects the size of
3657 the widget in the paned dimension -- the x dimension
3658 for horizontal panedwindows, the y dimension for
3659 vertical panedwindows. May be any value accepted by
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003660 Tk_GetPixels.
3661 padx n
Raymond Hettingerff41c482003-04-06 09:01:11 +00003662 Specifies a non-negative value indicating how much
3663 extra space to leave on each side of the window in
3664 the X-direction. The value may have any of the forms
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003665 accepted by Tk_GetPixels.
3666 pady n
3667 Specifies a non-negative value indicating how much
Raymond Hettingerff41c482003-04-06 09:01:11 +00003668 extra space to leave on each side of the window in
3669 the Y-direction. The value may have any of the forms
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003670 accepted by Tk_GetPixels.
3671 sticky style
Raymond Hettingerff41c482003-04-06 09:01:11 +00003672 If a window's pane is larger than the requested
3673 dimensions of the window, this option may be used
3674 to position (or stretch) the window within its pane.
3675 Style is a string that contains zero or more of the
3676 characters n, s, e or w. The string can optionally
3677 contains spaces or commas, but they are ignored. Each
3678 letter refers to a side (north, south, east, or west)
3679 that the window will "stick" to. If both n and s
3680 (or e and w) are specified, the window will be
3681 stretched to fill the entire height (or width) of
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003682 its cavity.
3683 width size
Raymond Hettingerff41c482003-04-06 09:01:11 +00003684 Specify a width for the window. The width will be
3685 the outer dimension of the window including its
3686 border, if any. If size is an empty string, or
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003687 if -width is not specified, then the width requested
Raymond Hettingerff41c482003-04-06 09:01:11 +00003688 internally by the window will be used initially; the
3689 width may later be adjusted by the movement of sashes
3690 in the panedwindow. Size may be any value accepted by
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003691 Tk_GetPixels.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003692
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003693 """
3694 if cnf is None and not kw:
3695 cnf = {}
3696 for x in self.tk.split(
3697 self.tk.call(self._w,
3698 'paneconfigure', tagOrId)):
3699 cnf[x[0][1:]] = (x[0][1:],) + x[1:]
3700 return cnf
3701 if type(cnf) == StringType and not kw:
3702 x = self.tk.split(self.tk.call(
3703 self._w, 'paneconfigure', tagOrId, '-'+cnf))
3704 return (x[0][1:],) + x[1:]
3705 self.tk.call((self._w, 'paneconfigure', tagOrId) +
3706 self._options(cnf, kw))
3707 paneconfig = paneconfigure
3708
3709 def panes(self):
3710 """Returns an ordered list of the child panes."""
3711 return self.tk.call(self._w, 'panes')
3712
Guido van Rossumaec5dc91994-06-27 07:55:12 +00003713######################################################################
3714# Extensions:
3715
3716class Studbutton(Button):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003717 def __init__(self, master=None, cnf={}, **kw):
3718 Widget.__init__(self, master, 'studbutton', cnf, kw)
3719 self.bind('<Any-Enter>', self.tkButtonEnter)
3720 self.bind('<Any-Leave>', self.tkButtonLeave)
3721 self.bind('<1>', self.tkButtonDown)
3722 self.bind('<ButtonRelease-1>', self.tkButtonUp)
Guido van Rossumaec5dc91994-06-27 07:55:12 +00003723
3724class Tributton(Button):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003725 def __init__(self, master=None, cnf={}, **kw):
3726 Widget.__init__(self, master, 'tributton', cnf, kw)
3727 self.bind('<Any-Enter>', self.tkButtonEnter)
3728 self.bind('<Any-Leave>', self.tkButtonLeave)
3729 self.bind('<1>', self.tkButtonDown)
3730 self.bind('<ButtonRelease-1>', self.tkButtonUp)
3731 self['fg'] = self['bg']
3732 self['activebackground'] = self['bg']
Guido van Rossum37dcab11996-05-16 16:00:19 +00003733
Guido van Rossumc417ef81996-08-21 23:38:59 +00003734######################################################################
3735# Test:
3736
3737def _test():
Fredrik Lundh06d28152000-08-09 18:03:12 +00003738 root = Tk()
3739 text = "This is Tcl/Tk version %s" % TclVersion
3740 if TclVersion >= 8.1:
Fredrik Lundh8fffa202000-08-09 18:51:01 +00003741 try:
3742 text = text + unicode("\nThis should be a cedilla: \347",
3743 "iso-8859-1")
3744 except NameError:
3745 pass # no unicode support
Fredrik Lundh06d28152000-08-09 18:03:12 +00003746 label = Label(root, text=text)
3747 label.pack()
3748 test = Button(root, text="Click me!",
3749 command=lambda root=root: root.test.configure(
3750 text="[%s]" % root.test['text']))
3751 test.pack()
3752 root.test = test
3753 quit = Button(root, text="QUIT", command=root.destroy)
3754 quit.pack()
3755 # The following three commands are needed so the window pops
3756 # up on top on Windows...
3757 root.iconify()
3758 root.update()
3759 root.deiconify()
3760 root.mainloop()
Guido van Rossumc417ef81996-08-21 23:38:59 +00003761
3762if __name__ == '__main__':
Fredrik Lundh06d28152000-08-09 18:03:12 +00003763 _test()