blob: e8b47a4f1e771242d80c68a38824f39bc481766d [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
Benjamin Peterson5b63acd2008-03-29 15:24:25 +0000191 if value is not None:
Martin v. Löwis337487e2006-06-17 09:15:14 +0000192 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
Fredrik Lundh06d28152000-08-09 18:03:12 +0000593 def option_add(self, pattern, value, priority = None):
594 """Set a VALUE (second parameter) for an option
595 PATTERN (first parameter).
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000596
Fredrik Lundh06d28152000-08-09 18:03:12 +0000597 An optional third parameter gives the numeric priority
598 (defaults to 80)."""
599 self.tk.call('option', 'add', pattern, value, priority)
600 def option_clear(self):
601 """Clear the option database.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000602
Fredrik Lundh06d28152000-08-09 18:03:12 +0000603 It will be reloaded if option_add is called."""
604 self.tk.call('option', 'clear')
605 def option_get(self, name, className):
606 """Return the value for an option NAME for this widget
607 with CLASSNAME.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000608
Fredrik Lundh06d28152000-08-09 18:03:12 +0000609 Values with higher priority override lower values."""
610 return self.tk.call('option', 'get', self._w, name, className)
611 def option_readfile(self, fileName, priority = None):
612 """Read file FILENAME into the option database.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000613
Fredrik Lundh06d28152000-08-09 18:03:12 +0000614 An optional second parameter gives the numeric
615 priority."""
616 self.tk.call('option', 'readfile', fileName, priority)
617 def selection_clear(self, **kw):
618 """Clear the current X selection."""
619 if not kw.has_key('displayof'): kw['displayof'] = self._w
620 self.tk.call(('selection', 'clear') + self._options(kw))
621 def selection_get(self, **kw):
622 """Return the contents of the current X selection.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000623
Fredrik Lundh06d28152000-08-09 18:03:12 +0000624 A keyword parameter selection specifies the name of
625 the selection and defaults to PRIMARY. A keyword
626 parameter displayof specifies a widget on the display
627 to use."""
628 if not kw.has_key('displayof'): kw['displayof'] = self._w
629 return self.tk.call(('selection', 'get') + self._options(kw))
630 def selection_handle(self, command, **kw):
631 """Specify a function COMMAND to call if the X
632 selection owned by this widget is queried by another
633 application.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000634
Fredrik Lundh06d28152000-08-09 18:03:12 +0000635 This function must return the contents of the
636 selection. The function will be called with the
637 arguments OFFSET and LENGTH which allows the chunking
638 of very long selections. The following keyword
639 parameters can be provided:
640 selection - name of the selection (default PRIMARY),
641 type - type of the selection (e.g. STRING, FILE_NAME)."""
642 name = self._register(command)
643 self.tk.call(('selection', 'handle') + self._options(kw)
644 + (self._w, name))
645 def selection_own(self, **kw):
646 """Become owner of X selection.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000647
Fredrik Lundh06d28152000-08-09 18:03:12 +0000648 A keyword parameter selection specifies the name of
649 the selection (default PRIMARY)."""
650 self.tk.call(('selection', 'own') +
651 self._options(kw) + (self._w,))
652 def selection_own_get(self, **kw):
653 """Return owner of X selection.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000654
Fredrik Lundh06d28152000-08-09 18:03:12 +0000655 The following keyword parameter can
656 be provided:
657 selection - name of the selection (default PRIMARY),
658 type - type of the selection (e.g. STRING, FILE_NAME)."""
659 if not kw.has_key('displayof'): kw['displayof'] = self._w
660 name = self.tk.call(('selection', 'own') + self._options(kw))
661 if not name: return None
662 return self._nametowidget(name)
663 def send(self, interp, cmd, *args):
664 """Send Tcl command CMD to different interpreter INTERP to be executed."""
665 return self.tk.call(('send', interp, cmd) + args)
666 def lower(self, belowThis=None):
667 """Lower this widget in the stacking order."""
668 self.tk.call('lower', self._w, belowThis)
669 def tkraise(self, aboveThis=None):
670 """Raise this widget in the stacking order."""
671 self.tk.call('raise', self._w, aboveThis)
672 lift = tkraise
673 def colormodel(self, value=None):
674 """Useless. Not implemented in Tk."""
675 return self.tk.call('tk', 'colormodel', self._w, value)
676 def winfo_atom(self, name, displayof=0):
677 """Return integer which represents atom NAME."""
678 args = ('winfo', 'atom') + self._displayof(displayof) + (name,)
679 return getint(self.tk.call(args))
680 def winfo_atomname(self, id, displayof=0):
681 """Return name of atom with identifier ID."""
682 args = ('winfo', 'atomname') \
683 + self._displayof(displayof) + (id,)
684 return self.tk.call(args)
685 def winfo_cells(self):
686 """Return number of cells in the colormap for this widget."""
687 return getint(
688 self.tk.call('winfo', 'cells', self._w))
689 def winfo_children(self):
690 """Return a list of all widgets which are children of this widget."""
Martin v. Löwisf2041b82002-03-27 17:15:57 +0000691 result = []
692 for child in self.tk.splitlist(
693 self.tk.call('winfo', 'children', self._w)):
694 try:
695 # Tcl sometimes returns extra windows, e.g. for
696 # menus; those need to be skipped
697 result.append(self._nametowidget(child))
698 except KeyError:
699 pass
700 return result
701
Fredrik Lundh06d28152000-08-09 18:03:12 +0000702 def winfo_class(self):
703 """Return window class name of this widget."""
704 return self.tk.call('winfo', 'class', self._w)
705 def winfo_colormapfull(self):
706 """Return true if at the last color request the colormap was full."""
707 return self.tk.getboolean(
708 self.tk.call('winfo', 'colormapfull', self._w))
709 def winfo_containing(self, rootX, rootY, displayof=0):
710 """Return the widget which is at the root coordinates ROOTX, ROOTY."""
711 args = ('winfo', 'containing') \
712 + self._displayof(displayof) + (rootX, rootY)
713 name = self.tk.call(args)
714 if not name: return None
715 return self._nametowidget(name)
716 def winfo_depth(self):
717 """Return the number of bits per pixel."""
718 return getint(self.tk.call('winfo', 'depth', self._w))
719 def winfo_exists(self):
720 """Return true if this widget exists."""
721 return getint(
722 self.tk.call('winfo', 'exists', self._w))
723 def winfo_fpixels(self, number):
724 """Return the number of pixels for the given distance NUMBER
725 (e.g. "3c") as float."""
726 return getdouble(self.tk.call(
727 'winfo', 'fpixels', self._w, number))
728 def winfo_geometry(self):
729 """Return geometry string for this widget in the form "widthxheight+X+Y"."""
730 return self.tk.call('winfo', 'geometry', self._w)
731 def winfo_height(self):
732 """Return height of this widget."""
733 return getint(
734 self.tk.call('winfo', 'height', self._w))
735 def winfo_id(self):
736 """Return identifier ID for this widget."""
737 return self.tk.getint(
738 self.tk.call('winfo', 'id', self._w))
739 def winfo_interps(self, displayof=0):
740 """Return the name of all Tcl interpreters for this display."""
741 args = ('winfo', 'interps') + self._displayof(displayof)
742 return self.tk.splitlist(self.tk.call(args))
743 def winfo_ismapped(self):
744 """Return true if this widget is mapped."""
745 return getint(
746 self.tk.call('winfo', 'ismapped', self._w))
747 def winfo_manager(self):
748 """Return the window mananger name for this widget."""
749 return self.tk.call('winfo', 'manager', self._w)
750 def winfo_name(self):
751 """Return the name of this widget."""
752 return self.tk.call('winfo', 'name', self._w)
753 def winfo_parent(self):
754 """Return the name of the parent of this widget."""
755 return self.tk.call('winfo', 'parent', self._w)
756 def winfo_pathname(self, id, displayof=0):
757 """Return the pathname of the widget given by ID."""
758 args = ('winfo', 'pathname') \
759 + self._displayof(displayof) + (id,)
760 return self.tk.call(args)
761 def winfo_pixels(self, number):
762 """Rounded integer value of winfo_fpixels."""
763 return getint(
764 self.tk.call('winfo', 'pixels', self._w, number))
765 def winfo_pointerx(self):
766 """Return the x coordinate of the pointer on the root window."""
767 return getint(
768 self.tk.call('winfo', 'pointerx', self._w))
769 def winfo_pointerxy(self):
770 """Return a tuple of x and y coordinates of the pointer on the root window."""
771 return self._getints(
772 self.tk.call('winfo', 'pointerxy', self._w))
773 def winfo_pointery(self):
774 """Return the y coordinate of the pointer on the root window."""
775 return getint(
776 self.tk.call('winfo', 'pointery', self._w))
777 def winfo_reqheight(self):
778 """Return requested height of this widget."""
779 return getint(
780 self.tk.call('winfo', 'reqheight', self._w))
781 def winfo_reqwidth(self):
782 """Return requested width of this widget."""
783 return getint(
784 self.tk.call('winfo', 'reqwidth', self._w))
785 def winfo_rgb(self, color):
786 """Return tuple of decimal values for red, green, blue for
787 COLOR in this widget."""
788 return self._getints(
789 self.tk.call('winfo', 'rgb', self._w, color))
790 def winfo_rootx(self):
791 """Return x coordinate of upper left corner of this widget on the
792 root window."""
793 return getint(
794 self.tk.call('winfo', 'rootx', self._w))
795 def winfo_rooty(self):
796 """Return y coordinate of upper left corner of this widget on the
797 root window."""
798 return getint(
799 self.tk.call('winfo', 'rooty', self._w))
800 def winfo_screen(self):
801 """Return the screen name of this widget."""
802 return self.tk.call('winfo', 'screen', self._w)
803 def winfo_screencells(self):
804 """Return the number of the cells in the colormap of the screen
805 of this widget."""
806 return getint(
807 self.tk.call('winfo', 'screencells', self._w))
808 def winfo_screendepth(self):
809 """Return the number of bits per pixel of the root window of the
810 screen of this widget."""
811 return getint(
812 self.tk.call('winfo', 'screendepth', self._w))
813 def winfo_screenheight(self):
814 """Return the number of pixels of the height of the screen of this widget
815 in pixel."""
816 return getint(
817 self.tk.call('winfo', 'screenheight', self._w))
818 def winfo_screenmmheight(self):
819 """Return the number of pixels of the height of the screen of
820 this widget in mm."""
821 return getint(
822 self.tk.call('winfo', 'screenmmheight', self._w))
823 def winfo_screenmmwidth(self):
824 """Return the number of pixels of the width of the screen of
825 this widget in mm."""
826 return getint(
827 self.tk.call('winfo', 'screenmmwidth', self._w))
828 def winfo_screenvisual(self):
829 """Return one of the strings directcolor, grayscale, pseudocolor,
830 staticcolor, staticgray, or truecolor for the default
831 colormodel of this screen."""
832 return self.tk.call('winfo', 'screenvisual', self._w)
833 def winfo_screenwidth(self):
834 """Return the number of pixels of the width of the screen of
835 this widget in pixel."""
836 return getint(
837 self.tk.call('winfo', 'screenwidth', self._w))
838 def winfo_server(self):
839 """Return information of the X-Server of the screen of this widget in
840 the form "XmajorRminor vendor vendorVersion"."""
841 return self.tk.call('winfo', 'server', self._w)
842 def winfo_toplevel(self):
843 """Return the toplevel widget of this widget."""
844 return self._nametowidget(self.tk.call(
845 'winfo', 'toplevel', self._w))
846 def winfo_viewable(self):
847 """Return true if the widget and all its higher ancestors are mapped."""
848 return getint(
849 self.tk.call('winfo', 'viewable', self._w))
850 def winfo_visual(self):
851 """Return one of the strings directcolor, grayscale, pseudocolor,
852 staticcolor, staticgray, or truecolor for the
853 colormodel of this widget."""
854 return self.tk.call('winfo', 'visual', self._w)
855 def winfo_visualid(self):
856 """Return the X identifier for the visual for this widget."""
857 return self.tk.call('winfo', 'visualid', self._w)
858 def winfo_visualsavailable(self, includeids=0):
859 """Return a list of all visuals available for the screen
860 of this widget.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000861
Fredrik Lundh06d28152000-08-09 18:03:12 +0000862 Each item in the list consists of a visual name (see winfo_visual), a
863 depth and if INCLUDEIDS=1 is given also the X identifier."""
864 data = self.tk.split(
865 self.tk.call('winfo', 'visualsavailable', self._w,
866 includeids and 'includeids' or None))
Fredrik Lundh24037f72000-08-09 19:26:47 +0000867 if type(data) is StringType:
868 data = [self.tk.split(data)]
Fredrik Lundh06d28152000-08-09 18:03:12 +0000869 return map(self.__winfo_parseitem, data)
870 def __winfo_parseitem(self, t):
871 """Internal function."""
872 return t[:1] + tuple(map(self.__winfo_getint, t[1:]))
873 def __winfo_getint(self, x):
874 """Internal function."""
Eric S. Raymondfc170b12001-02-09 11:51:27 +0000875 return int(x, 0)
Fredrik Lundh06d28152000-08-09 18:03:12 +0000876 def winfo_vrootheight(self):
877 """Return the height of the virtual root window associated with this
878 widget in pixels. If there is no virtual root window return the
879 height of the screen."""
880 return getint(
881 self.tk.call('winfo', 'vrootheight', self._w))
882 def winfo_vrootwidth(self):
883 """Return the width of the virtual root window associated with this
884 widget in pixel. If there is no virtual root window return the
885 width of the screen."""
886 return getint(
887 self.tk.call('winfo', 'vrootwidth', self._w))
888 def winfo_vrootx(self):
889 """Return the x offset of the virtual root relative to the root
890 window of the screen of this widget."""
891 return getint(
892 self.tk.call('winfo', 'vrootx', self._w))
893 def winfo_vrooty(self):
894 """Return the y offset of the virtual root relative to the root
895 window of the screen of this widget."""
896 return getint(
897 self.tk.call('winfo', 'vrooty', self._w))
898 def winfo_width(self):
899 """Return the width of this widget."""
900 return getint(
901 self.tk.call('winfo', 'width', self._w))
902 def winfo_x(self):
903 """Return the x coordinate of the upper left corner of this widget
904 in the parent."""
905 return getint(
906 self.tk.call('winfo', 'x', self._w))
907 def winfo_y(self):
908 """Return the y coordinate of the upper left corner of this widget
909 in the parent."""
910 return getint(
911 self.tk.call('winfo', 'y', self._w))
912 def update(self):
913 """Enter event loop until all pending events have been processed by Tcl."""
914 self.tk.call('update')
915 def update_idletasks(self):
916 """Enter event loop until all idle callbacks have been called. This
917 will update the display of windows but not process events caused by
918 the user."""
919 self.tk.call('update', 'idletasks')
920 def bindtags(self, tagList=None):
921 """Set or get the list of bindtags for this widget.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000922
Fredrik Lundh06d28152000-08-09 18:03:12 +0000923 With no argument return the list of all bindtags associated with
924 this widget. With a list of strings as argument the bindtags are
925 set to this list. The bindtags determine in which order events are
926 processed (see bind)."""
927 if tagList is None:
928 return self.tk.splitlist(
929 self.tk.call('bindtags', self._w))
930 else:
931 self.tk.call('bindtags', self._w, tagList)
932 def _bind(self, what, sequence, func, add, needcleanup=1):
933 """Internal function."""
934 if type(func) is StringType:
935 self.tk.call(what + (sequence, func))
936 elif func:
937 funcid = self._register(func, self._substitute,
938 needcleanup)
939 cmd = ('%sif {"[%s %s]" == "break"} break\n'
940 %
941 (add and '+' or '',
Martin v. Löwisc8718c12001-08-09 16:57:33 +0000942 funcid, self._subst_format_str))
Fredrik Lundh06d28152000-08-09 18:03:12 +0000943 self.tk.call(what + (sequence, cmd))
944 return funcid
945 elif sequence:
946 return self.tk.call(what + (sequence,))
947 else:
948 return self.tk.splitlist(self.tk.call(what))
949 def bind(self, sequence=None, func=None, add=None):
950 """Bind to this widget at event SEQUENCE a call to function FUNC.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000951
Fredrik Lundh06d28152000-08-09 18:03:12 +0000952 SEQUENCE is a string of concatenated event
953 patterns. An event pattern is of the form
954 <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
955 of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
956 Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
957 B3, Alt, Button4, B4, Double, Button5, B5 Triple,
958 Mod1, M1. TYPE is one of Activate, Enter, Map,
959 ButtonPress, Button, Expose, Motion, ButtonRelease
960 FocusIn, MouseWheel, Circulate, FocusOut, Property,
961 Colormap, Gravity Reparent, Configure, KeyPress, Key,
962 Unmap, Deactivate, KeyRelease Visibility, Destroy,
963 Leave and DETAIL is the button number for ButtonPress,
964 ButtonRelease and DETAIL is the Keysym for KeyPress and
965 KeyRelease. Examples are
966 <Control-Button-1> for pressing Control and mouse button 1 or
967 <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
968 An event pattern can also be a virtual event of the form
969 <<AString>> where AString can be arbitrary. This
970 event can be generated by event_generate.
971 If events are concatenated they must appear shortly
972 after each other.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000973
Fredrik Lundh06d28152000-08-09 18:03:12 +0000974 FUNC will be called if the event sequence occurs with an
975 instance of Event as argument. If the return value of FUNC is
976 "break" no further bound function is invoked.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000977
Fredrik Lundh06d28152000-08-09 18:03:12 +0000978 An additional boolean parameter ADD specifies whether FUNC will
979 be called additionally to the other bound function or whether
980 it will replace the previous function.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000981
Fredrik Lundh06d28152000-08-09 18:03:12 +0000982 Bind will return an identifier to allow deletion of the bound function with
983 unbind without memory leak.
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000984
Fredrik Lundh06d28152000-08-09 18:03:12 +0000985 If FUNC or SEQUENCE is omitted the bound function or list
986 of bound events are returned."""
Guido van Rossum5917ecb2000-06-29 16:30:50 +0000987
Fredrik Lundh06d28152000-08-09 18:03:12 +0000988 return self._bind(('bind', self._w), sequence, func, add)
989 def unbind(self, sequence, funcid=None):
990 """Unbind for this widget for event SEQUENCE the
991 function identified with FUNCID."""
992 self.tk.call('bind', self._w, sequence, '')
993 if funcid:
994 self.deletecommand(funcid)
995 def bind_all(self, sequence=None, func=None, add=None):
996 """Bind to all widgets at an event SEQUENCE a call to function FUNC.
997 An additional boolean parameter ADD specifies whether FUNC will
998 be called additionally to the other bound function or whether
999 it will replace the previous function. See bind for the return value."""
1000 return self._bind(('bind', 'all'), sequence, func, add, 0)
1001 def unbind_all(self, sequence):
1002 """Unbind for all widgets for event SEQUENCE all functions."""
1003 self.tk.call('bind', 'all' , sequence, '')
1004 def bind_class(self, className, sequence=None, func=None, add=None):
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001005
Fredrik Lundh06d28152000-08-09 18:03:12 +00001006 """Bind to widgets with bindtag CLASSNAME at event
1007 SEQUENCE a call of function FUNC. An additional
1008 boolean parameter ADD specifies whether FUNC will be
1009 called additionally to the other bound function or
1010 whether it will replace the previous function. See bind for
1011 the return value."""
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001012
Fredrik Lundh06d28152000-08-09 18:03:12 +00001013 return self._bind(('bind', className), sequence, func, add, 0)
1014 def unbind_class(self, className, sequence):
1015 """Unbind for a all widgets with bindtag CLASSNAME for event SEQUENCE
1016 all functions."""
1017 self.tk.call('bind', className , sequence, '')
1018 def mainloop(self, n=0):
1019 """Call the mainloop of Tk."""
1020 self.tk.mainloop(n)
1021 def quit(self):
1022 """Quit the Tcl interpreter. All widgets will be destroyed."""
1023 self.tk.quit()
1024 def _getints(self, string):
1025 """Internal function."""
1026 if string:
1027 return tuple(map(getint, self.tk.splitlist(string)))
1028 def _getdoubles(self, string):
1029 """Internal function."""
1030 if string:
1031 return tuple(map(getdouble, self.tk.splitlist(string)))
1032 def _getboolean(self, string):
1033 """Internal function."""
1034 if string:
1035 return self.tk.getboolean(string)
1036 def _displayof(self, displayof):
1037 """Internal function."""
1038 if displayof:
1039 return ('-displayof', displayof)
1040 if displayof is None:
1041 return ('-displayof', self._w)
1042 return ()
1043 def _options(self, cnf, kw = None):
1044 """Internal function."""
1045 if kw:
1046 cnf = _cnfmerge((cnf, kw))
1047 else:
1048 cnf = _cnfmerge(cnf)
1049 res = ()
1050 for k, v in cnf.items():
1051 if v is not None:
1052 if k[-1] == '_': k = k[:-1]
1053 if callable(v):
1054 v = self._register(v)
1055 res = res + ('-'+k, v)
1056 return res
1057 def nametowidget(self, name):
1058 """Return the Tkinter instance of a widget identified by
1059 its Tcl name NAME."""
1060 w = self
1061 if name[0] == '.':
1062 w = w._root()
1063 name = name[1:]
Fredrik Lundh06d28152000-08-09 18:03:12 +00001064 while name:
Eric S. Raymondfc170b12001-02-09 11:51:27 +00001065 i = name.find('.')
Fredrik Lundh06d28152000-08-09 18:03:12 +00001066 if i >= 0:
1067 name, tail = name[:i], name[i+1:]
1068 else:
1069 tail = ''
1070 w = w.children[name]
1071 name = tail
1072 return w
1073 _nametowidget = nametowidget
1074 def _register(self, func, subst=None, needcleanup=1):
1075 """Return a newly created Tcl function. If this
1076 function is called, the Python function FUNC will
1077 be executed. An optional function SUBST can
1078 be given which will be executed before FUNC."""
1079 f = CallWrapper(func, subst, self).__call__
Walter Dörwald70a6b492004-02-12 17:35:32 +00001080 name = repr(id(f))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001081 try:
1082 func = func.im_func
1083 except AttributeError:
1084 pass
1085 try:
1086 name = name + func.__name__
1087 except AttributeError:
1088 pass
1089 self.tk.createcommand(name, f)
1090 if needcleanup:
1091 if self._tclCommands is None:
1092 self._tclCommands = []
1093 self._tclCommands.append(name)
1094 #print '+ Tkinter created command', name
1095 return name
1096 register = _register
1097 def _root(self):
1098 """Internal function."""
1099 w = self
1100 while w.master: w = w.master
1101 return w
1102 _subst_format = ('%#', '%b', '%f', '%h', '%k',
1103 '%s', '%t', '%w', '%x', '%y',
1104 '%A', '%E', '%K', '%N', '%W', '%T', '%X', '%Y', '%D')
Martin v. Löwisc8718c12001-08-09 16:57:33 +00001105 _subst_format_str = " ".join(_subst_format)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001106 def _substitute(self, *args):
1107 """Internal function."""
1108 if len(args) != len(self._subst_format): return args
1109 getboolean = self.tk.getboolean
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001110
Fredrik Lundh06d28152000-08-09 18:03:12 +00001111 getint = int
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001112 def getint_event(s):
1113 """Tk changed behavior in 8.4.2, returning "??" rather more often."""
1114 try:
1115 return int(s)
1116 except ValueError:
1117 return s
1118
Fredrik Lundh06d28152000-08-09 18:03:12 +00001119 nsign, b, f, h, k, s, t, w, x, y, A, E, K, N, W, T, X, Y, D = args
1120 # Missing: (a, c, d, m, o, v, B, R)
1121 e = Event()
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001122 # serial field: valid vor all events
1123 # number of button: ButtonPress and ButtonRelease events only
1124 # height field: Configure, ConfigureRequest, Create,
1125 # ResizeRequest, and Expose events only
1126 # keycode field: KeyPress and KeyRelease events only
1127 # time field: "valid for events that contain a time field"
1128 # width field: Configure, ConfigureRequest, Create, ResizeRequest,
1129 # and Expose events only
1130 # x field: "valid for events that contain a x field"
1131 # y field: "valid for events that contain a y field"
1132 # keysym as decimal: KeyPress and KeyRelease events only
1133 # x_root, y_root fields: ButtonPress, ButtonRelease, KeyPress,
1134 # KeyRelease,and Motion events
Fredrik Lundh06d28152000-08-09 18:03:12 +00001135 e.serial = getint(nsign)
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001136 e.num = getint_event(b)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001137 try: e.focus = getboolean(f)
1138 except TclError: pass
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001139 e.height = getint_event(h)
1140 e.keycode = getint_event(k)
1141 e.state = getint_event(s)
1142 e.time = getint_event(t)
1143 e.width = getint_event(w)
1144 e.x = getint_event(x)
1145 e.y = getint_event(y)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001146 e.char = A
1147 try: e.send_event = getboolean(E)
1148 except TclError: pass
1149 e.keysym = K
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001150 e.keysym_num = getint_event(N)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001151 e.type = T
1152 try:
1153 e.widget = self._nametowidget(W)
1154 except KeyError:
1155 e.widget = W
Martin v. Löwis043bbc72003-03-29 09:47:21 +00001156 e.x_root = getint_event(X)
1157 e.y_root = getint_event(Y)
Fredrik Lundha249f162000-09-07 15:05:09 +00001158 try:
1159 e.delta = getint(D)
1160 except ValueError:
1161 e.delta = 0
Fredrik Lundh06d28152000-08-09 18:03:12 +00001162 return (e,)
1163 def _report_exception(self):
1164 """Internal function."""
1165 import sys
1166 exc, val, tb = sys.exc_type, sys.exc_value, sys.exc_traceback
1167 root = self._root()
1168 root.report_callback_exception(exc, val, tb)
Martin v. Löwis6ce13152002-10-10 14:36:13 +00001169 def _configure(self, cmd, cnf, kw):
1170 """Internal function."""
1171 if kw:
1172 cnf = _cnfmerge((cnf, kw))
1173 elif cnf:
1174 cnf = _cnfmerge(cnf)
1175 if cnf is None:
1176 cnf = {}
1177 for x in self.tk.split(
1178 self.tk.call(_flatten((self._w, cmd)))):
1179 cnf[x[0][1:]] = (x[0][1:],) + x[1:]
1180 return cnf
1181 if type(cnf) is StringType:
1182 x = self.tk.split(
1183 self.tk.call(_flatten((self._w, cmd, '-'+cnf))))
1184 return (x[0][1:],) + x[1:]
1185 self.tk.call(_flatten((self._w, cmd)) + self._options(cnf))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001186 # These used to be defined in Widget:
1187 def configure(self, cnf=None, **kw):
1188 """Configure resources of a widget.
Barry Warsaw107e6231998-12-15 00:44:15 +00001189
Fredrik Lundh06d28152000-08-09 18:03:12 +00001190 The values for resources are specified as keyword
1191 arguments. To get an overview about
1192 the allowed keyword arguments call the method keys.
1193 """
Martin v. Löwis6ce13152002-10-10 14:36:13 +00001194 return self._configure('configure', cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001195 config = configure
1196 def cget(self, key):
1197 """Return the resource value for a KEY given as string."""
1198 return self.tk.call(self._w, 'cget', '-' + key)
1199 __getitem__ = cget
1200 def __setitem__(self, key, value):
1201 self.configure({key: value})
1202 def keys(self):
1203 """Return a list of all resource names of this widget."""
1204 return map(lambda x: x[0][1:],
1205 self.tk.split(self.tk.call(self._w, 'configure')))
1206 def __str__(self):
1207 """Return the window path name of this widget."""
1208 return self._w
1209 # Pack methods that apply to the master
1210 _noarg_ = ['_noarg_']
1211 def pack_propagate(self, flag=_noarg_):
1212 """Set or get the status for propagation of geometry information.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001213
Fredrik Lundh06d28152000-08-09 18:03:12 +00001214 A boolean argument specifies whether the geometry information
1215 of the slaves will determine the size of this widget. If no argument
1216 is given the current setting will be returned.
1217 """
1218 if flag is Misc._noarg_:
1219 return self._getboolean(self.tk.call(
1220 'pack', 'propagate', self._w))
1221 else:
1222 self.tk.call('pack', 'propagate', self._w, flag)
1223 propagate = pack_propagate
1224 def pack_slaves(self):
1225 """Return a list of all slaves of this widget
1226 in its packing order."""
1227 return map(self._nametowidget,
1228 self.tk.splitlist(
1229 self.tk.call('pack', 'slaves', self._w)))
1230 slaves = pack_slaves
1231 # Place method that applies to the master
1232 def place_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(
1238 'place', 'slaves', self._w)))
1239 # Grid methods that apply to the master
1240 def grid_bbox(self, column=None, row=None, col2=None, row2=None):
1241 """Return a tuple of integer coordinates for the bounding
1242 box of this widget controlled by the geometry manager grid.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001243
Fredrik Lundh06d28152000-08-09 18:03:12 +00001244 If COLUMN, ROW is given the bounding box applies from
1245 the cell with row and column 0 to the specified
1246 cell. If COL2 and ROW2 are given the bounding box
1247 starts at that cell.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001248
Fredrik Lundh06d28152000-08-09 18:03:12 +00001249 The returned integers specify the offset of the upper left
1250 corner in the master widget and the width and height.
1251 """
1252 args = ('grid', 'bbox', self._w)
1253 if column is not None and row is not None:
1254 args = args + (column, row)
1255 if col2 is not None and row2 is not None:
1256 args = args + (col2, row2)
Raymond Hettingerff41c482003-04-06 09:01:11 +00001257 return self._getints(self.tk.call(*args)) or None
Guido van Rossum18468821994-06-20 07:49:28 +00001258
Fredrik Lundh06d28152000-08-09 18:03:12 +00001259 bbox = grid_bbox
1260 def _grid_configure(self, command, index, cnf, kw):
1261 """Internal function."""
1262 if type(cnf) is StringType and not kw:
1263 if cnf[-1:] == '_':
1264 cnf = cnf[:-1]
1265 if cnf[:1] != '-':
1266 cnf = '-'+cnf
1267 options = (cnf,)
1268 else:
1269 options = self._options(cnf, kw)
1270 if not options:
1271 res = self.tk.call('grid',
1272 command, self._w, index)
1273 words = self.tk.splitlist(res)
1274 dict = {}
1275 for i in range(0, len(words), 2):
1276 key = words[i][1:]
1277 value = words[i+1]
1278 if not value:
1279 value = None
1280 elif '.' in value:
1281 value = getdouble(value)
1282 else:
1283 value = getint(value)
1284 dict[key] = value
1285 return dict
1286 res = self.tk.call(
1287 ('grid', command, self._w, index)
1288 + options)
1289 if len(options) == 1:
1290 if not res: return None
1291 # In Tk 7.5, -width can be a float
1292 if '.' in res: return getdouble(res)
1293 return getint(res)
1294 def grid_columnconfigure(self, index, cnf={}, **kw):
1295 """Configure column INDEX of a grid.
Guido van Rossum80f8be81997-12-02 19:51:39 +00001296
Fredrik Lundh06d28152000-08-09 18:03:12 +00001297 Valid resources are minsize (minimum size of the column),
1298 weight (how much does additional space propagate to this column)
1299 and pad (how much space to let additionally)."""
1300 return self._grid_configure('columnconfigure', index, cnf, kw)
1301 columnconfigure = grid_columnconfigure
Martin v. Löwisdc579092001-10-13 09:33:51 +00001302 def grid_location(self, x, y):
1303 """Return a tuple of column and row which identify the cell
1304 at which the pixel at position X and Y inside the master
1305 widget is located."""
1306 return self._getints(
1307 self.tk.call(
1308 'grid', 'location', self._w, x, y)) or None
Fredrik Lundh06d28152000-08-09 18:03:12 +00001309 def grid_propagate(self, flag=_noarg_):
1310 """Set or get the status for propagation of geometry information.
Guido van Rossum80f8be81997-12-02 19:51:39 +00001311
Fredrik Lundh06d28152000-08-09 18:03:12 +00001312 A boolean argument specifies whether the geometry information
1313 of the slaves will determine the size of this widget. If no argument
1314 is given, the current setting will be returned.
1315 """
1316 if flag is Misc._noarg_:
1317 return self._getboolean(self.tk.call(
1318 'grid', 'propagate', self._w))
1319 else:
1320 self.tk.call('grid', 'propagate', self._w, flag)
1321 def grid_rowconfigure(self, index, cnf={}, **kw):
1322 """Configure row INDEX of a grid.
Guido van Rossum80f8be81997-12-02 19:51:39 +00001323
Fredrik Lundh06d28152000-08-09 18:03:12 +00001324 Valid resources are minsize (minimum size of the row),
1325 weight (how much does additional space propagate to this row)
1326 and pad (how much space to let additionally)."""
1327 return self._grid_configure('rowconfigure', index, cnf, kw)
1328 rowconfigure = grid_rowconfigure
1329 def grid_size(self):
1330 """Return a tuple of the number of column and rows in the grid."""
1331 return self._getints(
1332 self.tk.call('grid', 'size', self._w)) or None
1333 size = grid_size
1334 def grid_slaves(self, row=None, column=None):
1335 """Return a list of all slaves of this widget
1336 in its packing order."""
1337 args = ()
1338 if row is not None:
1339 args = args + ('-row', row)
1340 if column is not None:
1341 args = args + ('-column', column)
1342 return map(self._nametowidget,
1343 self.tk.splitlist(self.tk.call(
1344 ('grid', 'slaves', self._w) + args)))
Guido van Rossum80f8be81997-12-02 19:51:39 +00001345
Fredrik Lundh06d28152000-08-09 18:03:12 +00001346 # Support for the "event" command, new in Tk 4.2.
1347 # By Case Roole.
Guido van Rossum80f8be81997-12-02 19:51:39 +00001348
Fredrik Lundh06d28152000-08-09 18:03:12 +00001349 def event_add(self, virtual, *sequences):
1350 """Bind a virtual event VIRTUAL (of the form <<Name>>)
1351 to an event SEQUENCE such that the virtual event is triggered
1352 whenever SEQUENCE occurs."""
1353 args = ('event', 'add', virtual) + sequences
1354 self.tk.call(args)
Guido van Rossumc2966511998-04-10 19:16:10 +00001355
Fredrik Lundh06d28152000-08-09 18:03:12 +00001356 def event_delete(self, virtual, *sequences):
1357 """Unbind a virtual event VIRTUAL from SEQUENCE."""
1358 args = ('event', 'delete', virtual) + sequences
1359 self.tk.call(args)
Guido van Rossumc2966511998-04-10 19:16:10 +00001360
Fredrik Lundh06d28152000-08-09 18:03:12 +00001361 def event_generate(self, sequence, **kw):
1362 """Generate an event SEQUENCE. Additional
1363 keyword arguments specify parameter of the event
1364 (e.g. x, y, rootx, rooty)."""
1365 args = ('event', 'generate', self._w, sequence)
1366 for k, v in kw.items():
1367 args = args + ('-%s' % k, str(v))
1368 self.tk.call(args)
1369
1370 def event_info(self, virtual=None):
1371 """Return a list of all virtual events or the information
1372 about the SEQUENCE bound to the virtual event VIRTUAL."""
1373 return self.tk.splitlist(
1374 self.tk.call('event', 'info', virtual))
1375
1376 # Image related commands
1377
1378 def image_names(self):
1379 """Return a list of all existing image names."""
1380 return self.tk.call('image', 'names')
1381
1382 def image_types(self):
1383 """Return a list of all available image types (e.g. phote bitmap)."""
1384 return self.tk.call('image', 'types')
Guido van Rossumc2966511998-04-10 19:16:10 +00001385
Guido van Rossum80f8be81997-12-02 19:51:39 +00001386
Guido van Rossuma5773dd1995-09-07 19:22:00 +00001387class CallWrapper:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001388 """Internal class. Stores function to call when some user
1389 defined Tcl function is called e.g. after an event occurred."""
1390 def __init__(self, func, subst, widget):
1391 """Store FUNC, SUBST and WIDGET as members."""
1392 self.func = func
1393 self.subst = subst
1394 self.widget = widget
1395 def __call__(self, *args):
1396 """Apply first function SUBST to arguments, than FUNC."""
1397 try:
1398 if self.subst:
Raymond Hettingerff41c482003-04-06 09:01:11 +00001399 args = self.subst(*args)
1400 return self.func(*args)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001401 except SystemExit, msg:
1402 raise SystemExit, msg
1403 except:
1404 self.widget._report_exception()
Guido van Rossum18468821994-06-20 07:49:28 +00001405
Guido van Rossume365a591998-05-01 19:48:20 +00001406
Guido van Rossum18468821994-06-20 07:49:28 +00001407class Wm:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001408 """Provides functions for the communication with the window manager."""
Raymond Hettingerff41c482003-04-06 09:01:11 +00001409
Fredrik Lundh06d28152000-08-09 18:03:12 +00001410 def wm_aspect(self,
1411 minNumer=None, minDenom=None,
1412 maxNumer=None, maxDenom=None):
1413 """Instruct the window manager to set the aspect ratio (width/height)
1414 of this widget to be between MINNUMER/MINDENOM and MAXNUMER/MAXDENOM. Return a tuple
1415 of the actual values if no argument is given."""
1416 return self._getints(
1417 self.tk.call('wm', 'aspect', self._w,
1418 minNumer, minDenom,
1419 maxNumer, maxDenom))
1420 aspect = wm_aspect
Raymond Hettingerff41c482003-04-06 09:01:11 +00001421
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001422 def wm_attributes(self, *args):
1423 """This subcommand returns or sets platform specific attributes
Raymond Hettingerff41c482003-04-06 09:01:11 +00001424
1425 The first form returns a list of the platform specific flags and
1426 their values. The second form returns the value for the specific
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001427 option. The third form sets one or more of the values. The values
1428 are as follows:
Raymond Hettingerff41c482003-04-06 09:01:11 +00001429
1430 On Windows, -disabled gets or sets whether the window is in a
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001431 disabled state. -toolwindow gets or sets the style of the window
Raymond Hettingerff41c482003-04-06 09:01:11 +00001432 to toolwindow (as defined in the MSDN). -topmost gets or sets
1433 whether this is a topmost window (displays above all other
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001434 windows).
Raymond Hettingerff41c482003-04-06 09:01:11 +00001435
1436 On Macintosh, XXXXX
1437
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001438 On Unix, there are currently no special attribute values.
1439 """
1440 args = ('wm', 'attributes', self._w) + args
1441 return self.tk.call(args)
1442 attributes=wm_attributes
Raymond Hettingerff41c482003-04-06 09:01:11 +00001443
Fredrik Lundh06d28152000-08-09 18:03:12 +00001444 def wm_client(self, name=None):
1445 """Store NAME in WM_CLIENT_MACHINE property of this widget. Return
1446 current value."""
1447 return self.tk.call('wm', 'client', self._w, name)
1448 client = wm_client
1449 def wm_colormapwindows(self, *wlist):
1450 """Store list of window names (WLIST) into WM_COLORMAPWINDOWS property
1451 of this widget. This list contains windows whose colormaps differ from their
1452 parents. Return current list of widgets if WLIST is empty."""
1453 if len(wlist) > 1:
1454 wlist = (wlist,) # Tk needs a list of windows here
1455 args = ('wm', 'colormapwindows', self._w) + wlist
1456 return map(self._nametowidget, self.tk.call(args))
1457 colormapwindows = wm_colormapwindows
1458 def wm_command(self, value=None):
1459 """Store VALUE in WM_COMMAND property. It is the command
1460 which shall be used to invoke the application. Return current
1461 command if VALUE is None."""
1462 return self.tk.call('wm', 'command', self._w, value)
1463 command = wm_command
1464 def wm_deiconify(self):
1465 """Deiconify this widget. If it was never mapped it will not be mapped.
1466 On Windows it will raise this widget and give it the focus."""
1467 return self.tk.call('wm', 'deiconify', self._w)
1468 deiconify = wm_deiconify
1469 def wm_focusmodel(self, model=None):
1470 """Set focus model to MODEL. "active" means that this widget will claim
1471 the focus itself, "passive" means that the window manager shall give
1472 the focus. Return current focus model if MODEL is None."""
1473 return self.tk.call('wm', 'focusmodel', self._w, model)
1474 focusmodel = wm_focusmodel
1475 def wm_frame(self):
1476 """Return identifier for decorative frame of this widget if present."""
1477 return self.tk.call('wm', 'frame', self._w)
1478 frame = wm_frame
1479 def wm_geometry(self, newGeometry=None):
1480 """Set geometry to NEWGEOMETRY of the form =widthxheight+x+y. Return
1481 current value if None is given."""
1482 return self.tk.call('wm', 'geometry', self._w, newGeometry)
1483 geometry = wm_geometry
1484 def wm_grid(self,
1485 baseWidth=None, baseHeight=None,
1486 widthInc=None, heightInc=None):
1487 """Instruct the window manager that this widget shall only be
1488 resized on grid boundaries. WIDTHINC and HEIGHTINC are the width and
1489 height of a grid unit in pixels. BASEWIDTH and BASEHEIGHT are the
1490 number of grid units requested in Tk_GeometryRequest."""
1491 return self._getints(self.tk.call(
1492 'wm', 'grid', self._w,
1493 baseWidth, baseHeight, widthInc, heightInc))
1494 grid = wm_grid
1495 def wm_group(self, pathName=None):
1496 """Set the group leader widgets for related widgets to PATHNAME. Return
1497 the group leader of this widget if None is given."""
1498 return self.tk.call('wm', 'group', self._w, pathName)
1499 group = wm_group
Martin v. Löwis5ecad9c2006-06-17 09:20:41 +00001500 def wm_iconbitmap(self, bitmap=None, default=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001501 """Set bitmap for the iconified widget to BITMAP. Return
Martin v. Löwis5ecad9c2006-06-17 09:20:41 +00001502 the bitmap if None is given.
1503
Tim Peters43bc3782006-06-19 07:45:16 +00001504 Under Windows, the DEFAULT parameter can be used to set the icon
Martin v. Löwis5ecad9c2006-06-17 09:20:41 +00001505 for the widget and any descendents that don't have an icon set
Neal Norwitz210262c2006-06-17 22:37:45 +00001506 explicitly. DEFAULT can be the relative path to a .ico file
Martin v. Löwis5ecad9c2006-06-17 09:20:41 +00001507 (example: root.iconbitmap(default='myicon.ico') ). See Tk
1508 documentation for more information."""
1509 if default:
1510 return self.tk.call('wm', 'iconbitmap', self._w, '-default', default)
1511 else:
1512 return self.tk.call('wm', 'iconbitmap', self._w, bitmap)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001513 iconbitmap = wm_iconbitmap
1514 def wm_iconify(self):
1515 """Display widget as icon."""
1516 return self.tk.call('wm', 'iconify', self._w)
1517 iconify = wm_iconify
1518 def wm_iconmask(self, bitmap=None):
1519 """Set mask for the icon bitmap of this widget. Return the
1520 mask if None is given."""
1521 return self.tk.call('wm', 'iconmask', self._w, bitmap)
1522 iconmask = wm_iconmask
1523 def wm_iconname(self, newName=None):
1524 """Set the name of the icon for this widget. Return the name if
1525 None is given."""
1526 return self.tk.call('wm', 'iconname', self._w, newName)
1527 iconname = wm_iconname
1528 def wm_iconposition(self, x=None, y=None):
1529 """Set the position of the icon of this widget to X and Y. Return
1530 a tuple of the current values of X and X if None is given."""
1531 return self._getints(self.tk.call(
1532 'wm', 'iconposition', self._w, x, y))
1533 iconposition = wm_iconposition
1534 def wm_iconwindow(self, pathName=None):
1535 """Set widget PATHNAME to be displayed instead of icon. Return the current
1536 value if None is given."""
1537 return self.tk.call('wm', 'iconwindow', self._w, pathName)
1538 iconwindow = wm_iconwindow
1539 def wm_maxsize(self, width=None, height=None):
1540 """Set max WIDTH and HEIGHT for this widget. If the window is gridded
1541 the values are given in grid units. Return the current values if None
1542 is given."""
1543 return self._getints(self.tk.call(
1544 'wm', 'maxsize', self._w, width, height))
1545 maxsize = wm_maxsize
1546 def wm_minsize(self, width=None, height=None):
1547 """Set min WIDTH and HEIGHT for this widget. If the window is gridded
1548 the values are given in grid units. Return the current values if None
1549 is given."""
1550 return self._getints(self.tk.call(
1551 'wm', 'minsize', self._w, width, height))
1552 minsize = wm_minsize
1553 def wm_overrideredirect(self, boolean=None):
1554 """Instruct the window manager to ignore this widget
1555 if BOOLEAN is given with 1. Return the current value if None
1556 is given."""
1557 return self._getboolean(self.tk.call(
1558 'wm', 'overrideredirect', self._w, boolean))
1559 overrideredirect = wm_overrideredirect
1560 def wm_positionfrom(self, who=None):
1561 """Instruct the window manager that the position of this widget shall
1562 be defined by the user if WHO is "user", and by its own policy if WHO is
1563 "program"."""
1564 return self.tk.call('wm', 'positionfrom', self._w, who)
1565 positionfrom = wm_positionfrom
1566 def wm_protocol(self, name=None, func=None):
1567 """Bind function FUNC to command NAME for this widget.
1568 Return the function bound to NAME if None is given. NAME could be
1569 e.g. "WM_SAVE_YOURSELF" or "WM_DELETE_WINDOW"."""
1570 if callable(func):
1571 command = self._register(func)
1572 else:
1573 command = func
1574 return self.tk.call(
1575 'wm', 'protocol', self._w, name, command)
1576 protocol = wm_protocol
1577 def wm_resizable(self, width=None, height=None):
1578 """Instruct the window manager whether this width can be resized
1579 in WIDTH or HEIGHT. Both values are boolean values."""
1580 return self.tk.call('wm', 'resizable', self._w, width, height)
1581 resizable = wm_resizable
1582 def wm_sizefrom(self, who=None):
1583 """Instruct the window manager that the size of this widget shall
1584 be defined by the user if WHO is "user", and by its own policy if WHO is
1585 "program"."""
1586 return self.tk.call('wm', 'sizefrom', self._w, who)
1587 sizefrom = wm_sizefrom
Fredrik Lundh289ad8f2000-08-09 19:11:59 +00001588 def wm_state(self, newstate=None):
1589 """Query or set the state of this widget as one of normal, icon,
1590 iconic (see wm_iconwindow), withdrawn, or zoomed (Windows only)."""
1591 return self.tk.call('wm', 'state', self._w, newstate)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001592 state = wm_state
1593 def wm_title(self, string=None):
1594 """Set the title of this widget."""
1595 return self.tk.call('wm', 'title', self._w, string)
1596 title = wm_title
1597 def wm_transient(self, master=None):
1598 """Instruct the window manager that this widget is transient
1599 with regard to widget MASTER."""
1600 return self.tk.call('wm', 'transient', self._w, master)
1601 transient = wm_transient
1602 def wm_withdraw(self):
1603 """Withdraw this widget from the screen such that it is unmapped
1604 and forgotten by the window manager. Re-draw it with wm_deiconify."""
1605 return self.tk.call('wm', 'withdraw', self._w)
1606 withdraw = wm_withdraw
Guido van Rossume365a591998-05-01 19:48:20 +00001607
Guido van Rossum18468821994-06-20 07:49:28 +00001608
1609class Tk(Misc, Wm):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001610 """Toplevel widget of Tk which represents mostly the main window
1611 of an appliation. It has an associated Tcl interpreter."""
1612 _w = '.'
Martin v. Löwis9441c072004-08-03 18:36:25 +00001613 def __init__(self, screenName=None, baseName=None, className='Tk',
1614 useTk=1, sync=0, use=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001615 """Return a new Toplevel widget on screen SCREENNAME. A new Tcl interpreter will
1616 be created. BASENAME will be used for the identification of the profile file (see
1617 readprofile).
1618 It is constructed from sys.argv[0] without extensions if None is given. CLASSNAME
1619 is the name of the widget class."""
Fredrik Lundh06d28152000-08-09 18:03:12 +00001620 self.master = None
1621 self.children = {}
David Aschere2b4b322004-02-18 05:59:53 +00001622 self._tkloaded = 0
1623 # to avoid recursions in the getattr code in case of failure, we
1624 # ensure that self.tk is always _something_.
Tim Peters182b5ac2004-07-18 06:16:08 +00001625 self.tk = None
Fredrik Lundh06d28152000-08-09 18:03:12 +00001626 if baseName is None:
1627 import sys, os
1628 baseName = os.path.basename(sys.argv[0])
1629 baseName, ext = os.path.splitext(baseName)
1630 if ext not in ('.py', '.pyc', '.pyo'):
1631 baseName = baseName + ext
David Aschere2b4b322004-02-18 05:59:53 +00001632 interactive = 0
Martin v. Löwis9441c072004-08-03 18:36:25 +00001633 self.tk = _tkinter.create(screenName, baseName, className, interactive, wantobjects, useTk, sync, use)
David Aschere2b4b322004-02-18 05:59:53 +00001634 if useTk:
1635 self._loadtk()
1636 self.readprofile(baseName, className)
1637 def loadtk(self):
1638 if not self._tkloaded:
1639 self.tk.loadtk()
1640 self._loadtk()
1641 def _loadtk(self):
1642 self._tkloaded = 1
1643 global _default_root
Jack Jansenbe92af02001-08-23 13:25:59 +00001644 if _MacOS and hasattr(_MacOS, 'SchedParams'):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001645 # Disable event scanning except for Command-Period
1646 _MacOS.SchedParams(1, 0)
1647 # Work around nasty MacTk bug
1648 # XXX Is this one still needed?
1649 self.update()
1650 # Version sanity checks
1651 tk_version = self.tk.getvar('tk_version')
1652 if tk_version != _tkinter.TK_VERSION:
1653 raise RuntimeError, \
1654 "tk.h version (%s) doesn't match libtk.a version (%s)" \
1655 % (_tkinter.TK_VERSION, tk_version)
Martin v. Löwis54895972003-05-24 11:37:15 +00001656 # Under unknown circumstances, tcl_version gets coerced to float
1657 tcl_version = str(self.tk.getvar('tcl_version'))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001658 if tcl_version != _tkinter.TCL_VERSION:
1659 raise RuntimeError, \
1660 "tcl.h version (%s) doesn't match libtcl.a version (%s)" \
1661 % (_tkinter.TCL_VERSION, tcl_version)
1662 if TkVersion < 4.0:
1663 raise RuntimeError, \
1664 "Tk 4.0 or higher is required; found Tk %s" \
1665 % str(TkVersion)
Martin v. Löwis4afe1542005-03-01 08:09:28 +00001666 # Create and register the tkerror and exit commands
1667 # We need to inline parts of _register here, _ register
1668 # would register differently-named commands.
1669 if self._tclCommands is None:
1670 self._tclCommands = []
Fredrik Lundh06d28152000-08-09 18:03:12 +00001671 self.tk.createcommand('tkerror', _tkerror)
1672 self.tk.createcommand('exit', _exit)
Martin v. Löwis4afe1542005-03-01 08:09:28 +00001673 self._tclCommands.append('tkerror')
1674 self._tclCommands.append('exit')
Fredrik Lundh06d28152000-08-09 18:03:12 +00001675 if _support_default_root and not _default_root:
1676 _default_root = self
1677 self.protocol("WM_DELETE_WINDOW", self.destroy)
1678 def destroy(self):
1679 """Destroy this and all descendants widgets. This will
1680 end the application of this Tcl interpreter."""
1681 for c in self.children.values(): c.destroy()
1682 self.tk.call('destroy', self._w)
1683 Misc.destroy(self)
1684 global _default_root
1685 if _support_default_root and _default_root is self:
1686 _default_root = None
1687 def readprofile(self, baseName, className):
1688 """Internal function. It reads BASENAME.tcl and CLASSNAME.tcl into
1689 the Tcl Interpreter and calls execfile on BASENAME.py and CLASSNAME.py if
1690 such a file exists in the home directory."""
1691 import os
1692 if os.environ.has_key('HOME'): home = os.environ['HOME']
1693 else: home = os.curdir
1694 class_tcl = os.path.join(home, '.%s.tcl' % className)
1695 class_py = os.path.join(home, '.%s.py' % className)
1696 base_tcl = os.path.join(home, '.%s.tcl' % baseName)
1697 base_py = os.path.join(home, '.%s.py' % baseName)
1698 dir = {'self': self}
1699 exec 'from Tkinter import *' in dir
1700 if os.path.isfile(class_tcl):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001701 self.tk.call('source', class_tcl)
1702 if os.path.isfile(class_py):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001703 execfile(class_py, dir)
1704 if os.path.isfile(base_tcl):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001705 self.tk.call('source', base_tcl)
1706 if os.path.isfile(base_py):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001707 execfile(base_py, dir)
1708 def report_callback_exception(self, exc, val, tb):
1709 """Internal function. It reports exception on sys.stderr."""
1710 import traceback, sys
1711 sys.stderr.write("Exception in Tkinter callback\n")
1712 sys.last_type = exc
1713 sys.last_value = val
1714 sys.last_traceback = tb
1715 traceback.print_exception(exc, val, tb)
David Aschere2b4b322004-02-18 05:59:53 +00001716 def __getattr__(self, attr):
1717 "Delegate attribute access to the interpreter object"
1718 return getattr(self.tk, attr)
Guido van Rossum18468821994-06-20 07:49:28 +00001719
Guido van Rossum368e06b1997-11-07 20:38:49 +00001720# Ideally, the classes Pack, Place and Grid disappear, the
1721# pack/place/grid methods are defined on the Widget class, and
1722# everybody uses w.pack_whatever(...) instead of Pack.whatever(w,
1723# ...), with pack(), place() and grid() being short for
1724# pack_configure(), place_configure() and grid_columnconfigure(), and
1725# forget() being short for pack_forget(). As a practical matter, I'm
1726# afraid that there is too much code out there that may be using the
1727# Pack, Place or Grid class, so I leave them intact -- but only as
1728# backwards compatibility features. Also note that those methods that
1729# take a master as argument (e.g. pack_propagate) have been moved to
1730# the Misc class (which now incorporates all methods common between
1731# toplevel and interior widgets). Again, for compatibility, these are
1732# copied into the Pack, Place or Grid class.
1733
David Aschere2b4b322004-02-18 05:59:53 +00001734
1735def Tcl(screenName=None, baseName=None, className='Tk', useTk=0):
1736 return Tk(screenName, baseName, className, useTk)
1737
Guido van Rossum18468821994-06-20 07:49:28 +00001738class Pack:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001739 """Geometry manager Pack.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001740
Fredrik Lundh06d28152000-08-09 18:03:12 +00001741 Base class to use the methods pack_* in every widget."""
1742 def pack_configure(self, cnf={}, **kw):
1743 """Pack a widget in the parent widget. Use as options:
1744 after=widget - pack it after you have packed widget
1745 anchor=NSEW (or subset) - position widget according to
1746 given direction
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001747 before=widget - pack it before you will pack widget
Martin v. Löwisbfe175c2003-04-16 19:42:51 +00001748 expand=bool - expand widget if parent size grows
Fredrik Lundh06d28152000-08-09 18:03:12 +00001749 fill=NONE or X or Y or BOTH - fill widget if widget grows
1750 in=master - use master to contain this widget
1751 ipadx=amount - add internal padding in x direction
1752 ipady=amount - add internal padding in y direction
1753 padx=amount - add padding in x direction
1754 pady=amount - add padding in y direction
1755 side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
1756 """
1757 self.tk.call(
1758 ('pack', 'configure', self._w)
1759 + self._options(cnf, kw))
1760 pack = configure = config = pack_configure
1761 def pack_forget(self):
1762 """Unmap this widget and do not use it for the packing order."""
1763 self.tk.call('pack', 'forget', self._w)
1764 forget = pack_forget
1765 def pack_info(self):
1766 """Return information about the packing options
1767 for this widget."""
1768 words = self.tk.splitlist(
1769 self.tk.call('pack', 'info', self._w))
1770 dict = {}
1771 for i in range(0, len(words), 2):
1772 key = words[i][1:]
1773 value = words[i+1]
1774 if value[:1] == '.':
1775 value = self._nametowidget(value)
1776 dict[key] = value
1777 return dict
1778 info = pack_info
1779 propagate = pack_propagate = Misc.pack_propagate
1780 slaves = pack_slaves = Misc.pack_slaves
Guido van Rossum18468821994-06-20 07:49:28 +00001781
1782class Place:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001783 """Geometry manager Place.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001784
Fredrik Lundh06d28152000-08-09 18:03:12 +00001785 Base class to use the methods place_* in every widget."""
1786 def place_configure(self, cnf={}, **kw):
1787 """Place a widget in the parent widget. Use as options:
1788 in=master - master relative to which the widget is placed.
1789 x=amount - locate anchor of this widget at position x of master
1790 y=amount - locate anchor of this widget at position y of master
1791 relx=amount - locate anchor of this widget between 0.0 and 1.0
1792 relative to width of master (1.0 is right edge)
1793 rely=amount - locate anchor of this widget between 0.0 and 1.0
1794 relative to height of master (1.0 is bottom edge)
1795 anchor=NSEW (or subset) - position anchor according to given direction
1796 width=amount - width of this widget in pixel
1797 height=amount - height of this widget in pixel
1798 relwidth=amount - width of this widget between 0.0 and 1.0
1799 relative to width of master (1.0 is the same width
1800 as the master)
1801 relheight=amount - height of this widget between 0.0 and 1.0
1802 relative to height of master (1.0 is the same
1803 height as the master)
1804 bordermode="inside" or "outside" - whether to take border width of master widget
1805 into account
1806 """
1807 for k in ['in_']:
1808 if kw.has_key(k):
1809 kw[k[:-1]] = kw[k]
1810 del kw[k]
1811 self.tk.call(
1812 ('place', 'configure', self._w)
1813 + self._options(cnf, kw))
1814 place = configure = config = place_configure
1815 def place_forget(self):
1816 """Unmap this widget."""
1817 self.tk.call('place', 'forget', self._w)
1818 forget = place_forget
1819 def place_info(self):
1820 """Return information about the placing options
1821 for this widget."""
1822 words = self.tk.splitlist(
1823 self.tk.call('place', 'info', self._w))
1824 dict = {}
1825 for i in range(0, len(words), 2):
1826 key = words[i][1:]
1827 value = words[i+1]
1828 if value[:1] == '.':
1829 value = self._nametowidget(value)
1830 dict[key] = value
1831 return dict
1832 info = place_info
1833 slaves = place_slaves = Misc.place_slaves
Guido van Rossum18468821994-06-20 07:49:28 +00001834
Guido van Rossum37dcab11996-05-16 16:00:19 +00001835class Grid:
Fredrik Lundh06d28152000-08-09 18:03:12 +00001836 """Geometry manager Grid.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001837
Fredrik Lundh06d28152000-08-09 18:03:12 +00001838 Base class to use the methods grid_* in every widget."""
1839 # Thanks to Masazumi Yoshikawa (yosikawa@isi.edu)
1840 def grid_configure(self, cnf={}, **kw):
1841 """Position a widget in the parent widget in a grid. Use as options:
1842 column=number - use cell identified with given column (starting with 0)
1843 columnspan=number - this widget will span several columns
1844 in=master - use master to contain this widget
1845 ipadx=amount - add internal padding in x direction
1846 ipady=amount - add internal padding in y direction
1847 padx=amount - add padding in x direction
1848 pady=amount - add padding in y direction
1849 row=number - use cell identified with given row (starting with 0)
1850 rowspan=number - this widget will span several rows
1851 sticky=NSEW - if cell is larger on which sides will this
1852 widget stick to the cell boundary
1853 """
1854 self.tk.call(
1855 ('grid', 'configure', self._w)
1856 + self._options(cnf, kw))
1857 grid = configure = config = grid_configure
1858 bbox = grid_bbox = Misc.grid_bbox
1859 columnconfigure = grid_columnconfigure = Misc.grid_columnconfigure
1860 def grid_forget(self):
1861 """Unmap this widget."""
1862 self.tk.call('grid', 'forget', self._w)
1863 forget = grid_forget
1864 def grid_remove(self):
1865 """Unmap this widget but remember the grid options."""
1866 self.tk.call('grid', 'remove', self._w)
1867 def grid_info(self):
1868 """Return information about the options
1869 for positioning this widget in a grid."""
1870 words = self.tk.splitlist(
1871 self.tk.call('grid', 'info', self._w))
1872 dict = {}
1873 for i in range(0, len(words), 2):
1874 key = words[i][1:]
1875 value = words[i+1]
1876 if value[:1] == '.':
1877 value = self._nametowidget(value)
1878 dict[key] = value
1879 return dict
1880 info = grid_info
Martin v. Löwisdc579092001-10-13 09:33:51 +00001881 location = grid_location = Misc.grid_location
Fredrik Lundh06d28152000-08-09 18:03:12 +00001882 propagate = grid_propagate = Misc.grid_propagate
1883 rowconfigure = grid_rowconfigure = Misc.grid_rowconfigure
1884 size = grid_size = Misc.grid_size
1885 slaves = grid_slaves = Misc.grid_slaves
Guido van Rossum37dcab11996-05-16 16:00:19 +00001886
Guido van Rossum368e06b1997-11-07 20:38:49 +00001887class BaseWidget(Misc):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001888 """Internal class."""
1889 def _setup(self, master, cnf):
1890 """Internal function. Sets up information about children."""
1891 if _support_default_root:
1892 global _default_root
1893 if not master:
1894 if not _default_root:
1895 _default_root = Tk()
1896 master = _default_root
1897 self.master = master
1898 self.tk = master.tk
1899 name = None
1900 if cnf.has_key('name'):
1901 name = cnf['name']
1902 del cnf['name']
1903 if not name:
Walter Dörwald70a6b492004-02-12 17:35:32 +00001904 name = repr(id(self))
Fredrik Lundh06d28152000-08-09 18:03:12 +00001905 self._name = name
1906 if master._w=='.':
1907 self._w = '.' + name
1908 else:
1909 self._w = master._w + '.' + name
1910 self.children = {}
1911 if self.master.children.has_key(self._name):
1912 self.master.children[self._name].destroy()
1913 self.master.children[self._name] = self
1914 def __init__(self, master, widgetName, cnf={}, kw={}, extra=()):
1915 """Construct a widget with the parent widget MASTER, a name WIDGETNAME
1916 and appropriate options."""
1917 if kw:
1918 cnf = _cnfmerge((cnf, kw))
1919 self.widgetName = widgetName
1920 BaseWidget._setup(self, master, cnf)
1921 classes = []
1922 for k in cnf.keys():
1923 if type(k) is ClassType:
1924 classes.append((k, cnf[k]))
1925 del cnf[k]
1926 self.tk.call(
1927 (widgetName, self._w) + extra + self._options(cnf))
1928 for k, v in classes:
1929 k.configure(self, v)
1930 def destroy(self):
1931 """Destroy this and all descendants widgets."""
1932 for c in self.children.values(): c.destroy()
Martin v. Löwis92733be2006-06-17 09:25:15 +00001933 self.tk.call('destroy', self._w)
Fredrik Lundh06d28152000-08-09 18:03:12 +00001934 if self.master.children.has_key(self._name):
1935 del self.master.children[self._name]
Fredrik Lundh06d28152000-08-09 18:03:12 +00001936 Misc.destroy(self)
1937 def _do(self, name, args=()):
1938 # XXX Obsolete -- better use self.tk.call directly!
1939 return self.tk.call((self._w, name) + args)
Guido van Rossum18468821994-06-20 07:49:28 +00001940
Guido van Rossum368e06b1997-11-07 20:38:49 +00001941class Widget(BaseWidget, Pack, Place, Grid):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001942 """Internal class.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001943
Fredrik Lundh06d28152000-08-09 18:03:12 +00001944 Base class for a widget which can be positioned with the geometry managers
1945 Pack, Place or Grid."""
1946 pass
Guido van Rossum368e06b1997-11-07 20:38:49 +00001947
1948class Toplevel(BaseWidget, Wm):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001949 """Toplevel widget, e.g. for dialogs."""
1950 def __init__(self, master=None, cnf={}, **kw):
1951 """Construct a toplevel widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00001952
Fredrik Lundh06d28152000-08-09 18:03:12 +00001953 Valid resource names: background, bd, bg, borderwidth, class,
1954 colormap, container, cursor, height, highlightbackground,
1955 highlightcolor, highlightthickness, menu, relief, screen, takefocus,
1956 use, visual, width."""
1957 if kw:
1958 cnf = _cnfmerge((cnf, kw))
1959 extra = ()
1960 for wmkey in ['screen', 'class_', 'class', 'visual',
1961 'colormap']:
1962 if cnf.has_key(wmkey):
1963 val = cnf[wmkey]
1964 # TBD: a hack needed because some keys
1965 # are not valid as keyword arguments
1966 if wmkey[-1] == '_': opt = '-'+wmkey[:-1]
1967 else: opt = '-'+wmkey
1968 extra = extra + (opt, val)
1969 del cnf[wmkey]
1970 BaseWidget.__init__(self, master, 'toplevel', cnf, {}, extra)
1971 root = self._root()
1972 self.iconname(root.iconname())
1973 self.title(root.title())
1974 self.protocol("WM_DELETE_WINDOW", self.destroy)
Guido van Rossum18468821994-06-20 07:49:28 +00001975
1976class Button(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00001977 """Button widget."""
1978 def __init__(self, master=None, cnf={}, **kw):
1979 """Construct a button widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00001980
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001981 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00001982
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001983 activebackground, activeforeground, anchor,
1984 background, bitmap, borderwidth, cursor,
Raymond Hettingerff41c482003-04-06 09:01:11 +00001985 disabledforeground, font, foreground
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001986 highlightbackground, highlightcolor,
Raymond Hettingerff41c482003-04-06 09:01:11 +00001987 highlightthickness, image, justify,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001988 padx, pady, relief, repeatdelay,
Raymond Hettingerff41c482003-04-06 09:01:11 +00001989 repeatinterval, takefocus, text,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001990 textvariable, underline, wraplength
Raymond Hettingerff41c482003-04-06 09:01:11 +00001991
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001992 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00001993
Martin v. Löwis2ec36272002-10-13 10:22:08 +00001994 command, compound, default, height,
1995 overrelief, state, width
1996 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00001997 Widget.__init__(self, master, 'button', cnf, kw)
Raymond Hettingerff41c482003-04-06 09:01:11 +00001998
Fredrik Lundh06d28152000-08-09 18:03:12 +00001999 def tkButtonEnter(self, *dummy):
2000 self.tk.call('tkButtonEnter', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002001
Fredrik Lundh06d28152000-08-09 18:03:12 +00002002 def tkButtonLeave(self, *dummy):
2003 self.tk.call('tkButtonLeave', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002004
Fredrik Lundh06d28152000-08-09 18:03:12 +00002005 def tkButtonDown(self, *dummy):
2006 self.tk.call('tkButtonDown', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002007
Fredrik Lundh06d28152000-08-09 18:03:12 +00002008 def tkButtonUp(self, *dummy):
2009 self.tk.call('tkButtonUp', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002010
Fredrik Lundh06d28152000-08-09 18:03:12 +00002011 def tkButtonInvoke(self, *dummy):
2012 self.tk.call('tkButtonInvoke', self._w)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002013
Fredrik Lundh06d28152000-08-09 18:03:12 +00002014 def flash(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00002015 """Flash the button.
2016
2017 This is accomplished by redisplaying
2018 the button several times, alternating between active and
2019 normal colors. At the end of the flash the button is left
2020 in the same normal/active state as when the command was
2021 invoked. This command is ignored if the button's state is
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002022 disabled.
2023 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002024 self.tk.call(self._w, 'flash')
Raymond Hettingerff41c482003-04-06 09:01:11 +00002025
Fredrik Lundh06d28152000-08-09 18:03:12 +00002026 def invoke(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00002027 """Invoke the command associated with the button.
2028
2029 The return value is the return value from the command,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002030 or an empty string if there is no command associated with
2031 the button. This command is ignored if the button's state
2032 is disabled.
2033 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002034 return self.tk.call(self._w, 'invoke')
Guido van Rossum18468821994-06-20 07:49:28 +00002035
2036# Indices:
Guido van Rossum35f67fb1995-08-04 03:50:29 +00002037# XXX I don't like these -- take them away
Guido van Rossum18468821994-06-20 07:49:28 +00002038def AtEnd():
Fredrik Lundh06d28152000-08-09 18:03:12 +00002039 return 'end'
Guido van Rossum1e9e4001994-06-20 09:09:51 +00002040def AtInsert(*args):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002041 s = 'insert'
2042 for a in args:
2043 if a: s = s + (' ' + a)
2044 return s
Guido van Rossum18468821994-06-20 07:49:28 +00002045def AtSelFirst():
Fredrik Lundh06d28152000-08-09 18:03:12 +00002046 return 'sel.first'
Guido van Rossum18468821994-06-20 07:49:28 +00002047def AtSelLast():
Fredrik Lundh06d28152000-08-09 18:03:12 +00002048 return 'sel.last'
Guido van Rossum18468821994-06-20 07:49:28 +00002049def At(x, y=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002050 if y is None:
Walter Dörwald70a6b492004-02-12 17:35:32 +00002051 return '@%r' % (x,)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002052 else:
Walter Dörwald70a6b492004-02-12 17:35:32 +00002053 return '@%r,%r' % (x, y)
Guido van Rossum18468821994-06-20 07:49:28 +00002054
2055class Canvas(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002056 """Canvas widget to display graphical elements like lines or text."""
2057 def __init__(self, master=None, cnf={}, **kw):
2058 """Construct a canvas widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002059
Fredrik Lundh06d28152000-08-09 18:03:12 +00002060 Valid resource names: background, bd, bg, borderwidth, closeenough,
2061 confine, cursor, height, highlightbackground, highlightcolor,
2062 highlightthickness, insertbackground, insertborderwidth,
2063 insertofftime, insertontime, insertwidth, offset, relief,
2064 scrollregion, selectbackground, selectborderwidth, selectforeground,
2065 state, takefocus, width, xscrollcommand, xscrollincrement,
2066 yscrollcommand, yscrollincrement."""
2067 Widget.__init__(self, master, 'canvas', cnf, kw)
2068 def addtag(self, *args):
2069 """Internal function."""
2070 self.tk.call((self._w, 'addtag') + args)
2071 def addtag_above(self, newtag, tagOrId):
2072 """Add tag NEWTAG to all items above TAGORID."""
2073 self.addtag(newtag, 'above', tagOrId)
2074 def addtag_all(self, newtag):
2075 """Add tag NEWTAG to all items."""
2076 self.addtag(newtag, 'all')
2077 def addtag_below(self, newtag, tagOrId):
2078 """Add tag NEWTAG to all items below TAGORID."""
2079 self.addtag(newtag, 'below', tagOrId)
2080 def addtag_closest(self, newtag, x, y, halo=None, start=None):
2081 """Add tag NEWTAG to item which is closest to pixel at X, Y.
2082 If several match take the top-most.
2083 All items closer than HALO are considered overlapping (all are
2084 closests). If START is specified the next below this tag is taken."""
2085 self.addtag(newtag, 'closest', x, y, halo, start)
2086 def addtag_enclosed(self, newtag, x1, y1, x2, y2):
2087 """Add tag NEWTAG to all items in the rectangle defined
2088 by X1,Y1,X2,Y2."""
2089 self.addtag(newtag, 'enclosed', x1, y1, x2, y2)
2090 def addtag_overlapping(self, newtag, x1, y1, x2, y2):
2091 """Add tag NEWTAG to all items which overlap the rectangle
2092 defined by X1,Y1,X2,Y2."""
2093 self.addtag(newtag, 'overlapping', x1, y1, x2, y2)
2094 def addtag_withtag(self, newtag, tagOrId):
2095 """Add tag NEWTAG to all items with TAGORID."""
2096 self.addtag(newtag, 'withtag', tagOrId)
2097 def bbox(self, *args):
2098 """Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle
2099 which encloses all items with tags specified as arguments."""
2100 return self._getints(
2101 self.tk.call((self._w, 'bbox') + args)) or None
2102 def tag_unbind(self, tagOrId, sequence, funcid=None):
2103 """Unbind for all items with TAGORID for event SEQUENCE the
2104 function identified with FUNCID."""
2105 self.tk.call(self._w, 'bind', tagOrId, sequence, '')
2106 if funcid:
2107 self.deletecommand(funcid)
2108 def tag_bind(self, tagOrId, sequence=None, func=None, add=None):
2109 """Bind to all items with TAGORID at event SEQUENCE a call to function FUNC.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002110
Fredrik Lundh06d28152000-08-09 18:03:12 +00002111 An additional boolean parameter ADD specifies whether FUNC will be
2112 called additionally to the other bound function or whether it will
2113 replace the previous function. See bind for the return value."""
2114 return self._bind((self._w, 'bind', tagOrId),
2115 sequence, func, add)
2116 def canvasx(self, screenx, gridspacing=None):
2117 """Return the canvas x coordinate of pixel position SCREENX rounded
2118 to nearest multiple of GRIDSPACING units."""
2119 return getdouble(self.tk.call(
2120 self._w, 'canvasx', screenx, gridspacing))
2121 def canvasy(self, screeny, gridspacing=None):
2122 """Return the canvas y coordinate of pixel position SCREENY rounded
2123 to nearest multiple of GRIDSPACING units."""
2124 return getdouble(self.tk.call(
2125 self._w, 'canvasy', screeny, gridspacing))
2126 def coords(self, *args):
2127 """Return a list of coordinates for the item given in ARGS."""
2128 # XXX Should use _flatten on args
2129 return map(getdouble,
Guido van Rossum0bd54331998-05-19 21:18:13 +00002130 self.tk.splitlist(
Fredrik Lundh06d28152000-08-09 18:03:12 +00002131 self.tk.call((self._w, 'coords') + args)))
2132 def _create(self, itemType, args, kw): # Args: (val, val, ..., cnf={})
2133 """Internal function."""
2134 args = _flatten(args)
2135 cnf = args[-1]
2136 if type(cnf) in (DictionaryType, TupleType):
2137 args = args[:-1]
2138 else:
2139 cnf = {}
Raymond Hettingerff41c482003-04-06 09:01:11 +00002140 return getint(self.tk.call(
2141 self._w, 'create', itemType,
2142 *(args + self._options(cnf, kw))))
Fredrik Lundh06d28152000-08-09 18:03:12 +00002143 def create_arc(self, *args, **kw):
2144 """Create arc shaped region with coordinates x1,y1,x2,y2."""
2145 return self._create('arc', args, kw)
2146 def create_bitmap(self, *args, **kw):
2147 """Create bitmap with coordinates x1,y1."""
2148 return self._create('bitmap', args, kw)
2149 def create_image(self, *args, **kw):
2150 """Create image item with coordinates x1,y1."""
2151 return self._create('image', args, kw)
2152 def create_line(self, *args, **kw):
2153 """Create line with coordinates x1,y1,...,xn,yn."""
2154 return self._create('line', args, kw)
2155 def create_oval(self, *args, **kw):
2156 """Create oval with coordinates x1,y1,x2,y2."""
2157 return self._create('oval', args, kw)
2158 def create_polygon(self, *args, **kw):
2159 """Create polygon with coordinates x1,y1,...,xn,yn."""
2160 return self._create('polygon', args, kw)
2161 def create_rectangle(self, *args, **kw):
2162 """Create rectangle with coordinates x1,y1,x2,y2."""
2163 return self._create('rectangle', args, kw)
2164 def create_text(self, *args, **kw):
2165 """Create text with coordinates x1,y1."""
2166 return self._create('text', args, kw)
2167 def create_window(self, *args, **kw):
2168 """Create window with coordinates x1,y1,x2,y2."""
2169 return self._create('window', args, kw)
2170 def dchars(self, *args):
2171 """Delete characters of text items identified by tag or id in ARGS (possibly
2172 several times) from FIRST to LAST character (including)."""
2173 self.tk.call((self._w, 'dchars') + args)
2174 def delete(self, *args):
2175 """Delete items identified by all tag or ids contained in ARGS."""
2176 self.tk.call((self._w, 'delete') + args)
2177 def dtag(self, *args):
2178 """Delete tag or id given as last arguments in ARGS from items
2179 identified by first argument in ARGS."""
2180 self.tk.call((self._w, 'dtag') + args)
2181 def find(self, *args):
2182 """Internal function."""
2183 return self._getints(
2184 self.tk.call((self._w, 'find') + args)) or ()
2185 def find_above(self, tagOrId):
2186 """Return items above TAGORID."""
2187 return self.find('above', tagOrId)
2188 def find_all(self):
2189 """Return all items."""
2190 return self.find('all')
2191 def find_below(self, tagOrId):
2192 """Return all items below TAGORID."""
2193 return self.find('below', tagOrId)
2194 def find_closest(self, x, y, halo=None, start=None):
2195 """Return item which is closest to pixel at X, Y.
2196 If several match take the top-most.
2197 All items closer than HALO are considered overlapping (all are
2198 closests). If START is specified the next below this tag is taken."""
2199 return self.find('closest', x, y, halo, start)
2200 def find_enclosed(self, x1, y1, x2, y2):
2201 """Return all items in rectangle defined
2202 by X1,Y1,X2,Y2."""
2203 return self.find('enclosed', x1, y1, x2, y2)
2204 def find_overlapping(self, x1, y1, x2, y2):
2205 """Return all items which overlap the rectangle
2206 defined by X1,Y1,X2,Y2."""
2207 return self.find('overlapping', x1, y1, x2, y2)
2208 def find_withtag(self, tagOrId):
2209 """Return all items with TAGORID."""
2210 return self.find('withtag', tagOrId)
2211 def focus(self, *args):
2212 """Set focus to the first item specified in ARGS."""
2213 return self.tk.call((self._w, 'focus') + args)
2214 def gettags(self, *args):
2215 """Return tags associated with the first item specified in ARGS."""
2216 return self.tk.splitlist(
2217 self.tk.call((self._w, 'gettags') + args))
2218 def icursor(self, *args):
2219 """Set cursor at position POS in the item identified by TAGORID.
2220 In ARGS TAGORID must be first."""
2221 self.tk.call((self._w, 'icursor') + args)
2222 def index(self, *args):
2223 """Return position of cursor as integer in item specified in ARGS."""
2224 return getint(self.tk.call((self._w, 'index') + args))
2225 def insert(self, *args):
2226 """Insert TEXT in item TAGORID at position POS. ARGS must
2227 be TAGORID POS TEXT."""
2228 self.tk.call((self._w, 'insert') + args)
2229 def itemcget(self, tagOrId, option):
2230 """Return the resource value for an OPTION for item TAGORID."""
2231 return self.tk.call(
2232 (self._w, 'itemcget') + (tagOrId, '-'+option))
2233 def itemconfigure(self, tagOrId, cnf=None, **kw):
2234 """Configure resources of an item TAGORID.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002235
Fredrik Lundh06d28152000-08-09 18:03:12 +00002236 The values for resources are specified as keyword
2237 arguments. To get an overview about
2238 the allowed keyword arguments call the method without arguments.
2239 """
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002240 return self._configure(('itemconfigure', tagOrId), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002241 itemconfig = itemconfigure
2242 # lower, tkraise/lift hide Misc.lower, Misc.tkraise/lift,
2243 # so the preferred name for them is tag_lower, tag_raise
2244 # (similar to tag_bind, and similar to the Text widget);
2245 # unfortunately can't delete the old ones yet (maybe in 1.6)
2246 def tag_lower(self, *args):
2247 """Lower an item TAGORID given in ARGS
2248 (optional below another item)."""
2249 self.tk.call((self._w, 'lower') + args)
2250 lower = tag_lower
2251 def move(self, *args):
2252 """Move an item TAGORID given in ARGS."""
2253 self.tk.call((self._w, 'move') + args)
2254 def postscript(self, cnf={}, **kw):
2255 """Print the contents of the canvas to a postscript
2256 file. Valid options: colormap, colormode, file, fontmap,
2257 height, pageanchor, pageheight, pagewidth, pagex, pagey,
2258 rotate, witdh, x, y."""
2259 return self.tk.call((self._w, 'postscript') +
2260 self._options(cnf, kw))
2261 def tag_raise(self, *args):
2262 """Raise an item TAGORID given in ARGS
2263 (optional above another item)."""
2264 self.tk.call((self._w, 'raise') + args)
2265 lift = tkraise = tag_raise
2266 def scale(self, *args):
2267 """Scale item TAGORID with XORIGIN, YORIGIN, XSCALE, YSCALE."""
2268 self.tk.call((self._w, 'scale') + args)
2269 def scan_mark(self, x, y):
2270 """Remember the current X, Y coordinates."""
2271 self.tk.call(self._w, 'scan', 'mark', x, y)
Neal Norwitze931ed52003-01-10 23:24:32 +00002272 def scan_dragto(self, x, y, gain=10):
2273 """Adjust the view of the canvas to GAIN times the
Fredrik Lundh06d28152000-08-09 18:03:12 +00002274 difference between X and Y and the coordinates given in
2275 scan_mark."""
Neal Norwitze931ed52003-01-10 23:24:32 +00002276 self.tk.call(self._w, 'scan', 'dragto', x, y, gain)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002277 def select_adjust(self, tagOrId, index):
2278 """Adjust the end of the selection near the cursor of an item TAGORID to index."""
2279 self.tk.call(self._w, 'select', 'adjust', tagOrId, index)
2280 def select_clear(self):
2281 """Clear the selection if it is in this widget."""
2282 self.tk.call(self._w, 'select', 'clear')
2283 def select_from(self, tagOrId, index):
2284 """Set the fixed end of a selection in item TAGORID to INDEX."""
2285 self.tk.call(self._w, 'select', 'from', tagOrId, index)
2286 def select_item(self):
2287 """Return the item which has the selection."""
Neal Norwitz58b63bf2002-07-23 02:52:58 +00002288 return self.tk.call(self._w, 'select', 'item') or None
Fredrik Lundh06d28152000-08-09 18:03:12 +00002289 def select_to(self, tagOrId, index):
2290 """Set the variable end of a selection in item TAGORID to INDEX."""
2291 self.tk.call(self._w, 'select', 'to', tagOrId, index)
2292 def type(self, tagOrId):
2293 """Return the type of the item TAGORID."""
2294 return self.tk.call(self._w, 'type', tagOrId) or None
2295 def xview(self, *args):
2296 """Query and change horizontal position of the view."""
2297 if not args:
2298 return self._getdoubles(self.tk.call(self._w, 'xview'))
2299 self.tk.call((self._w, 'xview') + args)
2300 def xview_moveto(self, fraction):
2301 """Adjusts the view in the window so that FRACTION of the
2302 total width of the canvas is off-screen to the left."""
2303 self.tk.call(self._w, 'xview', 'moveto', fraction)
2304 def xview_scroll(self, number, what):
2305 """Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2306 self.tk.call(self._w, 'xview', 'scroll', number, what)
2307 def yview(self, *args):
2308 """Query and change vertical position of the view."""
2309 if not args:
2310 return self._getdoubles(self.tk.call(self._w, 'yview'))
2311 self.tk.call((self._w, 'yview') + args)
2312 def yview_moveto(self, fraction):
2313 """Adjusts the view in the window so that FRACTION of the
2314 total height of the canvas is off-screen to the top."""
2315 self.tk.call(self._w, 'yview', 'moveto', fraction)
2316 def yview_scroll(self, number, what):
2317 """Shift the y-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2318 self.tk.call(self._w, 'yview', 'scroll', number, what)
Guido van Rossum18468821994-06-20 07:49:28 +00002319
2320class Checkbutton(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002321 """Checkbutton widget which is either in on- or off-state."""
2322 def __init__(self, master=None, cnf={}, **kw):
2323 """Construct a checkbutton widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002324
Fredrik Lundh06d28152000-08-09 18:03:12 +00002325 Valid resource names: activebackground, activeforeground, anchor,
2326 background, bd, bg, bitmap, borderwidth, command, cursor,
2327 disabledforeground, fg, font, foreground, height,
2328 highlightbackground, highlightcolor, highlightthickness, image,
2329 indicatoron, justify, offvalue, onvalue, padx, pady, relief,
2330 selectcolor, selectimage, state, takefocus, text, textvariable,
2331 underline, variable, width, wraplength."""
2332 Widget.__init__(self, master, 'checkbutton', cnf, kw)
2333 def deselect(self):
2334 """Put the button in off-state."""
2335 self.tk.call(self._w, 'deselect')
2336 def flash(self):
2337 """Flash the button."""
2338 self.tk.call(self._w, 'flash')
2339 def invoke(self):
2340 """Toggle the button and invoke a command if given as resource."""
2341 return self.tk.call(self._w, 'invoke')
2342 def select(self):
2343 """Put the button in on-state."""
2344 self.tk.call(self._w, 'select')
2345 def toggle(self):
2346 """Toggle the button."""
2347 self.tk.call(self._w, 'toggle')
Guido van Rossum18468821994-06-20 07:49:28 +00002348
2349class Entry(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002350 """Entry widget which allows to display simple text."""
2351 def __init__(self, master=None, cnf={}, **kw):
2352 """Construct an entry widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002353
Fredrik Lundh06d28152000-08-09 18:03:12 +00002354 Valid resource names: background, bd, bg, borderwidth, cursor,
2355 exportselection, fg, font, foreground, highlightbackground,
2356 highlightcolor, highlightthickness, insertbackground,
2357 insertborderwidth, insertofftime, insertontime, insertwidth,
2358 invalidcommand, invcmd, justify, relief, selectbackground,
2359 selectborderwidth, selectforeground, show, state, takefocus,
2360 textvariable, validate, validatecommand, vcmd, width,
2361 xscrollcommand."""
2362 Widget.__init__(self, master, 'entry', cnf, kw)
2363 def delete(self, first, last=None):
2364 """Delete text from FIRST to LAST (not included)."""
2365 self.tk.call(self._w, 'delete', first, last)
2366 def get(self):
2367 """Return the text."""
2368 return self.tk.call(self._w, 'get')
2369 def icursor(self, index):
2370 """Insert cursor at INDEX."""
2371 self.tk.call(self._w, 'icursor', index)
2372 def index(self, index):
2373 """Return position of cursor."""
2374 return getint(self.tk.call(
2375 self._w, 'index', index))
2376 def insert(self, index, string):
2377 """Insert STRING at INDEX."""
2378 self.tk.call(self._w, 'insert', index, string)
2379 def scan_mark(self, x):
2380 """Remember the current X, Y coordinates."""
2381 self.tk.call(self._w, 'scan', 'mark', x)
2382 def scan_dragto(self, x):
2383 """Adjust the view of the canvas to 10 times the
2384 difference between X and Y and the coordinates given in
2385 scan_mark."""
2386 self.tk.call(self._w, 'scan', 'dragto', x)
2387 def selection_adjust(self, index):
2388 """Adjust the end of the selection near the cursor to INDEX."""
2389 self.tk.call(self._w, 'selection', 'adjust', index)
2390 select_adjust = selection_adjust
2391 def selection_clear(self):
2392 """Clear the selection if it is in this widget."""
2393 self.tk.call(self._w, 'selection', 'clear')
2394 select_clear = selection_clear
2395 def selection_from(self, index):
2396 """Set the fixed end of a selection to INDEX."""
2397 self.tk.call(self._w, 'selection', 'from', index)
2398 select_from = selection_from
2399 def selection_present(self):
2400 """Return whether the widget has the selection."""
2401 return self.tk.getboolean(
2402 self.tk.call(self._w, 'selection', 'present'))
2403 select_present = selection_present
2404 def selection_range(self, start, end):
2405 """Set the selection from START to END (not included)."""
2406 self.tk.call(self._w, 'selection', 'range', start, end)
2407 select_range = selection_range
2408 def selection_to(self, index):
2409 """Set the variable end of a selection to INDEX."""
2410 self.tk.call(self._w, 'selection', 'to', index)
2411 select_to = selection_to
2412 def xview(self, index):
2413 """Query and change horizontal position of the view."""
2414 self.tk.call(self._w, 'xview', index)
2415 def xview_moveto(self, fraction):
2416 """Adjust the view in the window so that FRACTION of the
2417 total width of the entry is off-screen to the left."""
2418 self.tk.call(self._w, 'xview', 'moveto', fraction)
2419 def xview_scroll(self, number, what):
2420 """Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2421 self.tk.call(self._w, 'xview', 'scroll', number, what)
Guido van Rossum18468821994-06-20 07:49:28 +00002422
2423class Frame(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002424 """Frame widget which may contain other widgets and can have a 3D border."""
2425 def __init__(self, master=None, cnf={}, **kw):
2426 """Construct a frame widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002427
Fredrik Lundh06d28152000-08-09 18:03:12 +00002428 Valid resource names: background, bd, bg, borderwidth, class,
2429 colormap, container, cursor, height, highlightbackground,
2430 highlightcolor, highlightthickness, relief, takefocus, visual, width."""
2431 cnf = _cnfmerge((cnf, kw))
2432 extra = ()
2433 if cnf.has_key('class_'):
2434 extra = ('-class', cnf['class_'])
2435 del cnf['class_']
2436 elif cnf.has_key('class'):
2437 extra = ('-class', cnf['class'])
2438 del cnf['class']
2439 Widget.__init__(self, master, 'frame', cnf, {}, extra)
Guido van Rossum18468821994-06-20 07:49:28 +00002440
2441class Label(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002442 """Label widget which can display text and bitmaps."""
2443 def __init__(self, master=None, cnf={}, **kw):
2444 """Construct a label widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00002445
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002446 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002447
2448 activebackground, activeforeground, anchor,
2449 background, bitmap, borderwidth, cursor,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002450 disabledforeground, font, foreground,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002451 highlightbackground, highlightcolor,
2452 highlightthickness, image, justify,
2453 padx, pady, relief, takefocus, text,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002454 textvariable, underline, wraplength
Raymond Hettingerff41c482003-04-06 09:01:11 +00002455
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002456 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002457
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002458 height, state, width
Raymond Hettingerff41c482003-04-06 09:01:11 +00002459
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002460 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002461 Widget.__init__(self, master, 'label', cnf, kw)
Guido van Rossum761c5ab1995-07-14 15:29:10 +00002462
Guido van Rossum18468821994-06-20 07:49:28 +00002463class Listbox(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002464 """Listbox widget which can display a list of strings."""
2465 def __init__(self, master=None, cnf={}, **kw):
2466 """Construct a listbox widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002467
Fredrik Lundh06d28152000-08-09 18:03:12 +00002468 Valid resource names: background, bd, bg, borderwidth, cursor,
2469 exportselection, fg, font, foreground, height, highlightbackground,
2470 highlightcolor, highlightthickness, relief, selectbackground,
2471 selectborderwidth, selectforeground, selectmode, setgrid, takefocus,
2472 width, xscrollcommand, yscrollcommand, listvariable."""
2473 Widget.__init__(self, master, 'listbox', cnf, kw)
2474 def activate(self, index):
2475 """Activate item identified by INDEX."""
2476 self.tk.call(self._w, 'activate', index)
2477 def bbox(self, *args):
2478 """Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle
2479 which encloses the item identified by index in ARGS."""
2480 return self._getints(
2481 self.tk.call((self._w, 'bbox') + args)) or None
2482 def curselection(self):
2483 """Return list of indices of currently selected item."""
2484 # XXX Ought to apply self._getints()...
2485 return self.tk.splitlist(self.tk.call(
2486 self._w, 'curselection'))
2487 def delete(self, first, last=None):
2488 """Delete items from FIRST to LAST (not included)."""
2489 self.tk.call(self._w, 'delete', first, last)
2490 def get(self, first, last=None):
2491 """Get list of items from FIRST to LAST (not included)."""
2492 if last:
2493 return self.tk.splitlist(self.tk.call(
2494 self._w, 'get', first, last))
2495 else:
2496 return self.tk.call(self._w, 'get', first)
2497 def index(self, index):
2498 """Return index of item identified with INDEX."""
2499 i = self.tk.call(self._w, 'index', index)
2500 if i == 'none': return None
2501 return getint(i)
2502 def insert(self, index, *elements):
2503 """Insert ELEMENTS at INDEX."""
2504 self.tk.call((self._w, 'insert', index) + elements)
2505 def nearest(self, y):
2506 """Get index of item which is nearest to y coordinate Y."""
2507 return getint(self.tk.call(
2508 self._w, 'nearest', y))
2509 def scan_mark(self, x, y):
2510 """Remember the current X, Y coordinates."""
2511 self.tk.call(self._w, 'scan', 'mark', x, y)
2512 def scan_dragto(self, x, y):
2513 """Adjust the view of the listbox to 10 times the
2514 difference between X and Y and the coordinates given in
2515 scan_mark."""
2516 self.tk.call(self._w, 'scan', 'dragto', x, y)
2517 def see(self, index):
2518 """Scroll such that INDEX is visible."""
2519 self.tk.call(self._w, 'see', index)
2520 def selection_anchor(self, index):
2521 """Set the fixed end oft the selection to INDEX."""
2522 self.tk.call(self._w, 'selection', 'anchor', index)
2523 select_anchor = selection_anchor
2524 def selection_clear(self, first, last=None):
2525 """Clear the selection from FIRST to LAST (not included)."""
2526 self.tk.call(self._w,
2527 'selection', 'clear', first, last)
2528 select_clear = selection_clear
2529 def selection_includes(self, index):
2530 """Return 1 if INDEX is part of the selection."""
2531 return self.tk.getboolean(self.tk.call(
2532 self._w, 'selection', 'includes', index))
2533 select_includes = selection_includes
2534 def selection_set(self, first, last=None):
2535 """Set the selection from FIRST to LAST (not included) without
2536 changing the currently selected elements."""
2537 self.tk.call(self._w, 'selection', 'set', first, last)
2538 select_set = selection_set
2539 def size(self):
2540 """Return the number of elements in the listbox."""
2541 return getint(self.tk.call(self._w, 'size'))
2542 def xview(self, *what):
2543 """Query and change horizontal position of the view."""
2544 if not what:
2545 return self._getdoubles(self.tk.call(self._w, 'xview'))
2546 self.tk.call((self._w, 'xview') + what)
2547 def xview_moveto(self, fraction):
2548 """Adjust the view in the window so that FRACTION of the
2549 total width of the entry is off-screen to the left."""
2550 self.tk.call(self._w, 'xview', 'moveto', fraction)
2551 def xview_scroll(self, number, what):
2552 """Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2553 self.tk.call(self._w, 'xview', 'scroll', number, what)
2554 def yview(self, *what):
2555 """Query and change vertical position of the view."""
2556 if not what:
2557 return self._getdoubles(self.tk.call(self._w, 'yview'))
2558 self.tk.call((self._w, 'yview') + what)
2559 def yview_moveto(self, fraction):
2560 """Adjust the view in the window so that FRACTION of the
2561 total width of the entry is off-screen to the top."""
2562 self.tk.call(self._w, 'yview', 'moveto', fraction)
2563 def yview_scroll(self, number, what):
2564 """Shift the y-view according to NUMBER which is measured in "units" or "pages" (WHAT)."""
2565 self.tk.call(self._w, 'yview', 'scroll', number, what)
Guido van Rossum09f1ad82001-09-05 19:29:56 +00002566 def itemcget(self, index, option):
2567 """Return the resource value for an ITEM and an OPTION."""
2568 return self.tk.call(
2569 (self._w, 'itemcget') + (index, '-'+option))
Guido van Rossuma0adb922001-09-01 18:29:55 +00002570 def itemconfigure(self, index, cnf=None, **kw):
Guido van Rossum09f1ad82001-09-05 19:29:56 +00002571 """Configure resources of an ITEM.
Guido van Rossuma0adb922001-09-01 18:29:55 +00002572
2573 The values for resources are specified as keyword arguments.
2574 To get an overview about the allowed keyword arguments
2575 call the method without arguments.
2576 Valid resource names: background, bg, foreground, fg,
2577 selectbackground, selectforeground."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002578 return self._configure(('itemconfigure', index), cnf, kw)
Guido van Rossuma0adb922001-09-01 18:29:55 +00002579 itemconfig = itemconfigure
Guido van Rossum18468821994-06-20 07:49:28 +00002580
2581class Menu(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002582 """Menu widget which allows to display menu bars, pull-down menus and pop-up menus."""
2583 def __init__(self, master=None, cnf={}, **kw):
2584 """Construct menu widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002585
Fredrik Lundh06d28152000-08-09 18:03:12 +00002586 Valid resource names: activebackground, activeborderwidth,
2587 activeforeground, background, bd, bg, borderwidth, cursor,
2588 disabledforeground, fg, font, foreground, postcommand, relief,
2589 selectcolor, takefocus, tearoff, tearoffcommand, title, type."""
2590 Widget.__init__(self, master, 'menu', cnf, kw)
2591 def tk_bindForTraversal(self):
2592 pass # obsolete since Tk 4.0
2593 def tk_mbPost(self):
2594 self.tk.call('tk_mbPost', self._w)
2595 def tk_mbUnpost(self):
2596 self.tk.call('tk_mbUnpost')
2597 def tk_traverseToMenu(self, char):
2598 self.tk.call('tk_traverseToMenu', self._w, char)
2599 def tk_traverseWithinMenu(self, char):
2600 self.tk.call('tk_traverseWithinMenu', self._w, char)
2601 def tk_getMenuButtons(self):
2602 return self.tk.call('tk_getMenuButtons', self._w)
2603 def tk_nextMenu(self, count):
2604 self.tk.call('tk_nextMenu', count)
2605 def tk_nextMenuEntry(self, count):
2606 self.tk.call('tk_nextMenuEntry', count)
2607 def tk_invokeMenu(self):
2608 self.tk.call('tk_invokeMenu', self._w)
2609 def tk_firstMenu(self):
2610 self.tk.call('tk_firstMenu', self._w)
2611 def tk_mbButtonDown(self):
2612 self.tk.call('tk_mbButtonDown', self._w)
2613 def tk_popup(self, x, y, entry=""):
2614 """Post the menu at position X,Y with entry ENTRY."""
2615 self.tk.call('tk_popup', self._w, x, y, entry)
2616 def activate(self, index):
2617 """Activate entry at INDEX."""
2618 self.tk.call(self._w, 'activate', index)
2619 def add(self, itemType, cnf={}, **kw):
2620 """Internal function."""
2621 self.tk.call((self._w, 'add', itemType) +
2622 self._options(cnf, kw))
2623 def add_cascade(self, cnf={}, **kw):
2624 """Add hierarchical menu item."""
2625 self.add('cascade', cnf or kw)
2626 def add_checkbutton(self, cnf={}, **kw):
2627 """Add checkbutton menu item."""
2628 self.add('checkbutton', cnf or kw)
2629 def add_command(self, cnf={}, **kw):
2630 """Add command menu item."""
2631 self.add('command', cnf or kw)
2632 def add_radiobutton(self, cnf={}, **kw):
2633 """Addd radio menu item."""
2634 self.add('radiobutton', cnf or kw)
2635 def add_separator(self, cnf={}, **kw):
2636 """Add separator."""
2637 self.add('separator', cnf or kw)
2638 def insert(self, index, itemType, cnf={}, **kw):
2639 """Internal function."""
2640 self.tk.call((self._w, 'insert', index, itemType) +
2641 self._options(cnf, kw))
2642 def insert_cascade(self, index, cnf={}, **kw):
2643 """Add hierarchical menu item at INDEX."""
2644 self.insert(index, 'cascade', cnf or kw)
2645 def insert_checkbutton(self, index, cnf={}, **kw):
2646 """Add checkbutton menu item at INDEX."""
2647 self.insert(index, 'checkbutton', cnf or kw)
2648 def insert_command(self, index, cnf={}, **kw):
2649 """Add command menu item at INDEX."""
2650 self.insert(index, 'command', cnf or kw)
2651 def insert_radiobutton(self, index, cnf={}, **kw):
2652 """Addd radio menu item at INDEX."""
2653 self.insert(index, 'radiobutton', cnf or kw)
2654 def insert_separator(self, index, cnf={}, **kw):
2655 """Add separator at INDEX."""
2656 self.insert(index, 'separator', cnf or kw)
2657 def delete(self, index1, index2=None):
2658 """Delete menu items between INDEX1 and INDEX2 (not included)."""
2659 self.tk.call(self._w, 'delete', index1, index2)
2660 def entrycget(self, index, option):
2661 """Return the resource value of an menu item for OPTION at INDEX."""
2662 return self.tk.call(self._w, 'entrycget', index, '-' + option)
2663 def entryconfigure(self, index, cnf=None, **kw):
2664 """Configure a menu item at INDEX."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002665 return self._configure(('entryconfigure', index), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002666 entryconfig = entryconfigure
2667 def index(self, index):
2668 """Return the index of a menu item identified by INDEX."""
2669 i = self.tk.call(self._w, 'index', index)
2670 if i == 'none': return None
2671 return getint(i)
2672 def invoke(self, index):
2673 """Invoke a menu item identified by INDEX and execute
2674 the associated command."""
2675 return self.tk.call(self._w, 'invoke', index)
2676 def post(self, x, y):
2677 """Display a menu at position X,Y."""
2678 self.tk.call(self._w, 'post', x, y)
2679 def type(self, index):
2680 """Return the type of the menu item at INDEX."""
2681 return self.tk.call(self._w, 'type', index)
2682 def unpost(self):
2683 """Unmap a menu."""
2684 self.tk.call(self._w, 'unpost')
2685 def yposition(self, index):
2686 """Return the y-position of the topmost pixel of the menu item at INDEX."""
2687 return getint(self.tk.call(
2688 self._w, 'yposition', index))
Guido van Rossum18468821994-06-20 07:49:28 +00002689
2690class Menubutton(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002691 """Menubutton widget, obsolete since Tk8.0."""
2692 def __init__(self, master=None, cnf={}, **kw):
2693 Widget.__init__(self, master, 'menubutton', cnf, kw)
Guido van Rossum18468821994-06-20 07:49:28 +00002694
2695class Message(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002696 """Message widget to display multiline text. Obsolete since Label does it too."""
2697 def __init__(self, master=None, cnf={}, **kw):
2698 Widget.__init__(self, master, 'message', cnf, kw)
Guido van Rossum18468821994-06-20 07:49:28 +00002699
2700class Radiobutton(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002701 """Radiobutton widget which shows only one of several buttons in on-state."""
2702 def __init__(self, master=None, cnf={}, **kw):
2703 """Construct a radiobutton widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002704
Fredrik Lundh06d28152000-08-09 18:03:12 +00002705 Valid resource names: activebackground, activeforeground, anchor,
2706 background, bd, bg, bitmap, borderwidth, command, cursor,
2707 disabledforeground, fg, font, foreground, height,
2708 highlightbackground, highlightcolor, highlightthickness, image,
2709 indicatoron, justify, padx, pady, relief, selectcolor, selectimage,
2710 state, takefocus, text, textvariable, underline, value, variable,
2711 width, wraplength."""
2712 Widget.__init__(self, master, 'radiobutton', cnf, kw)
2713 def deselect(self):
2714 """Put the button in off-state."""
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002715
Fredrik Lundh06d28152000-08-09 18:03:12 +00002716 self.tk.call(self._w, 'deselect')
2717 def flash(self):
2718 """Flash the button."""
2719 self.tk.call(self._w, 'flash')
2720 def invoke(self):
2721 """Toggle the button and invoke a command if given as resource."""
2722 return self.tk.call(self._w, 'invoke')
2723 def select(self):
2724 """Put the button in on-state."""
2725 self.tk.call(self._w, 'select')
Guido van Rossum18468821994-06-20 07:49:28 +00002726
2727class Scale(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002728 """Scale widget which can display a numerical scale."""
2729 def __init__(self, master=None, cnf={}, **kw):
2730 """Construct a scale widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002731
Fredrik Lundh06d28152000-08-09 18:03:12 +00002732 Valid resource names: activebackground, background, bigincrement, bd,
2733 bg, borderwidth, command, cursor, digits, fg, font, foreground, from,
2734 highlightbackground, highlightcolor, highlightthickness, label,
2735 length, orient, relief, repeatdelay, repeatinterval, resolution,
2736 showvalue, sliderlength, sliderrelief, state, takefocus,
2737 tickinterval, to, troughcolor, variable, width."""
2738 Widget.__init__(self, master, 'scale', cnf, kw)
2739 def get(self):
2740 """Get the current value as integer or float."""
2741 value = self.tk.call(self._w, 'get')
2742 try:
2743 return getint(value)
2744 except ValueError:
2745 return getdouble(value)
2746 def set(self, value):
2747 """Set the value to VALUE."""
2748 self.tk.call(self._w, 'set', value)
2749 def coords(self, value=None):
2750 """Return a tuple (X,Y) of the point along the centerline of the
2751 trough that corresponds to VALUE or the current value if None is
2752 given."""
2753
2754 return self._getints(self.tk.call(self._w, 'coords', value))
2755 def identify(self, x, y):
2756 """Return where the point X,Y lies. Valid return values are "slider",
2757 "though1" and "though2"."""
2758 return self.tk.call(self._w, 'identify', x, y)
Guido van Rossum18468821994-06-20 07:49:28 +00002759
2760class Scrollbar(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002761 """Scrollbar widget which displays a slider at a certain position."""
2762 def __init__(self, master=None, cnf={}, **kw):
2763 """Construct a scrollbar widget with the parent MASTER.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002764
Fredrik Lundh06d28152000-08-09 18:03:12 +00002765 Valid resource names: activebackground, activerelief,
2766 background, bd, bg, borderwidth, command, cursor,
2767 elementborderwidth, highlightbackground,
2768 highlightcolor, highlightthickness, jump, orient,
2769 relief, repeatdelay, repeatinterval, takefocus,
2770 troughcolor, width."""
2771 Widget.__init__(self, master, 'scrollbar', cnf, kw)
2772 def activate(self, index):
2773 """Display the element at INDEX with activebackground and activerelief.
2774 INDEX can be "arrow1","slider" or "arrow2"."""
2775 self.tk.call(self._w, 'activate', index)
2776 def delta(self, deltax, deltay):
2777 """Return the fractional change of the scrollbar setting if it
2778 would be moved by DELTAX or DELTAY pixels."""
2779 return getdouble(
2780 self.tk.call(self._w, 'delta', deltax, deltay))
2781 def fraction(self, x, y):
2782 """Return the fractional value which corresponds to a slider
2783 position of X,Y."""
2784 return getdouble(self.tk.call(self._w, 'fraction', x, y))
2785 def identify(self, x, y):
2786 """Return the element under position X,Y as one of
2787 "arrow1","slider","arrow2" or ""."""
2788 return self.tk.call(self._w, 'identify', x, y)
2789 def get(self):
2790 """Return the current fractional values (upper and lower end)
2791 of the slider position."""
2792 return self._getdoubles(self.tk.call(self._w, 'get'))
2793 def set(self, *args):
2794 """Set the fractional values of the slider position (upper and
2795 lower ends as value between 0 and 1)."""
2796 self.tk.call((self._w, 'set') + args)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002797
2798
2799
Guido van Rossum18468821994-06-20 07:49:28 +00002800class Text(Widget):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002801 """Text widget which can display text in various forms."""
Fredrik Lundh06d28152000-08-09 18:03:12 +00002802 def __init__(self, master=None, cnf={}, **kw):
2803 """Construct a text widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00002804
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002805 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002806
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002807 background, borderwidth, cursor,
2808 exportselection, font, foreground,
2809 highlightbackground, highlightcolor,
2810 highlightthickness, insertbackground,
2811 insertborderwidth, insertofftime,
2812 insertontime, insertwidth, padx, pady,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002813 relief, selectbackground,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002814 selectborderwidth, selectforeground,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002815 setgrid, takefocus,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002816 xscrollcommand, yscrollcommand,
Guido van Rossum5917ecb2000-06-29 16:30:50 +00002817
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002818 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00002819
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002820 autoseparators, height, maxundo,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002821 spacing1, spacing2, spacing3,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002822 state, tabs, undo, width, wrap,
Raymond Hettingerff41c482003-04-06 09:01:11 +00002823
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002824 """
Fredrik Lundh06d28152000-08-09 18:03:12 +00002825 Widget.__init__(self, master, 'text', cnf, kw)
2826 def bbox(self, *args):
2827 """Return a tuple of (x,y,width,height) which gives the bounding
2828 box of the visible part of the character at the index in ARGS."""
2829 return self._getints(
2830 self.tk.call((self._w, 'bbox') + args)) or None
2831 def tk_textSelectTo(self, index):
2832 self.tk.call('tk_textSelectTo', self._w, index)
2833 def tk_textBackspace(self):
2834 self.tk.call('tk_textBackspace', self._w)
2835 def tk_textIndexCloser(self, a, b, c):
2836 self.tk.call('tk_textIndexCloser', self._w, a, b, c)
2837 def tk_textResetAnchor(self, index):
2838 self.tk.call('tk_textResetAnchor', self._w, index)
2839 def compare(self, index1, op, index2):
2840 """Return whether between index INDEX1 and index INDEX2 the
2841 relation OP is satisfied. OP is one of <, <=, ==, >=, >, or !=."""
2842 return self.tk.getboolean(self.tk.call(
2843 self._w, 'compare', index1, op, index2))
2844 def debug(self, boolean=None):
2845 """Turn on the internal consistency checks of the B-Tree inside the text
2846 widget according to BOOLEAN."""
2847 return self.tk.getboolean(self.tk.call(
2848 self._w, 'debug', boolean))
2849 def delete(self, index1, index2=None):
2850 """Delete the characters between INDEX1 and INDEX2 (not included)."""
2851 self.tk.call(self._w, 'delete', index1, index2)
2852 def dlineinfo(self, index):
2853 """Return tuple (x,y,width,height,baseline) giving the bounding box
2854 and baseline position of the visible part of the line containing
2855 the character at INDEX."""
2856 return self._getints(self.tk.call(self._w, 'dlineinfo', index))
Guido van Rossum256705b2002-04-23 13:29:43 +00002857 def dump(self, index1, index2=None, command=None, **kw):
2858 """Return the contents of the widget between index1 and index2.
Raymond Hettingerff41c482003-04-06 09:01:11 +00002859
Guido van Rossum256705b2002-04-23 13:29:43 +00002860 The type of contents returned in filtered based on the keyword
2861 parameters; if 'all', 'image', 'mark', 'tag', 'text', or 'window' are
2862 given and true, then the corresponding items are returned. The result
2863 is a list of triples of the form (key, value, index). If none of the
2864 keywords are true then 'all' is used by default.
Raymond Hettingerff41c482003-04-06 09:01:11 +00002865
Guido van Rossum256705b2002-04-23 13:29:43 +00002866 If the 'command' argument is given, it is called once for each element
2867 of the list of triples, with the values of each triple serving as the
2868 arguments to the function. In this case the list is not returned."""
2869 args = []
2870 func_name = None
2871 result = None
2872 if not command:
2873 # Never call the dump command without the -command flag, since the
2874 # output could involve Tcl quoting and would be a pain to parse
2875 # right. Instead just set the command to build a list of triples
2876 # as if we had done the parsing.
2877 result = []
2878 def append_triple(key, value, index, result=result):
2879 result.append((key, value, index))
2880 command = append_triple
2881 try:
2882 if not isinstance(command, str):
2883 func_name = command = self._register(command)
2884 args += ["-command", command]
2885 for key in kw:
2886 if kw[key]: args.append("-" + key)
2887 args.append(index1)
2888 if index2:
2889 args.append(index2)
2890 self.tk.call(self._w, "dump", *args)
2891 return result
2892 finally:
2893 if func_name:
2894 self.deletecommand(func_name)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002895
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002896 ## new in tk8.4
2897 def edit(self, *args):
2898 """Internal method
Raymond Hettingerff41c482003-04-06 09:01:11 +00002899
2900 This method controls the undo mechanism and
2901 the modified flag. The exact behavior of the
2902 command depends on the option argument that
2903 follows the edit argument. The following forms
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002904 of the command are currently supported:
Raymond Hettingerff41c482003-04-06 09:01:11 +00002905
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002906 edit_modified, edit_redo, edit_reset, edit_separator
2907 and edit_undo
Raymond Hettingerff41c482003-04-06 09:01:11 +00002908
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002909 """
2910 return self._getints(
2911 self.tk.call((self._w, 'edit') + args)) or ()
2912
2913 def edit_modified(self, arg=None):
2914 """Get or Set the modified flag
Raymond Hettingerff41c482003-04-06 09:01:11 +00002915
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002916 If arg is not specified, returns the modified
Raymond Hettingerff41c482003-04-06 09:01:11 +00002917 flag of the widget. The insert, delete, edit undo and
2918 edit redo commands or the user can set or clear the
2919 modified flag. If boolean is specified, sets the
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002920 modified flag of the widget to arg.
2921 """
2922 return self.edit("modified", arg)
Raymond Hettingerff41c482003-04-06 09:01:11 +00002923
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002924 def edit_redo(self):
2925 """Redo the last undone edit
Raymond Hettingerff41c482003-04-06 09:01:11 +00002926
2927 When the undo option is true, reapplies the last
2928 undone edits provided no other edits were done since
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002929 then. Generates an error when the redo stack is empty.
2930 Does nothing when the undo option is false.
2931 """
2932 return self.edit("redo")
Raymond Hettingerff41c482003-04-06 09:01:11 +00002933
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002934 def edit_reset(self):
2935 """Clears the undo and redo stacks
2936 """
2937 return self.edit("reset")
Raymond Hettingerff41c482003-04-06 09:01:11 +00002938
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002939 def edit_separator(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00002940 """Inserts a separator (boundary) on the undo stack.
2941
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002942 Does nothing when the undo option is false
2943 """
2944 return self.edit("separator")
Raymond Hettingerff41c482003-04-06 09:01:11 +00002945
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002946 def edit_undo(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00002947 """Undoes the last edit action
2948
2949 If the undo option is true. An edit action is defined
2950 as all the insert and delete commands that are recorded
2951 on the undo stack in between two separators. Generates
2952 an error when the undo stack is empty. Does nothing
Martin v. Löwis2ec36272002-10-13 10:22:08 +00002953 when the undo option is false
2954 """
2955 return self.edit("undo")
Raymond Hettingerff41c482003-04-06 09:01:11 +00002956
Fredrik Lundh06d28152000-08-09 18:03:12 +00002957 def get(self, index1, index2=None):
2958 """Return the text from INDEX1 to INDEX2 (not included)."""
2959 return self.tk.call(self._w, 'get', index1, index2)
2960 # (Image commands are new in 8.0)
2961 def image_cget(self, index, option):
2962 """Return the value of OPTION of an embedded image at INDEX."""
2963 if option[:1] != "-":
2964 option = "-" + option
2965 if option[-1:] == "_":
2966 option = option[:-1]
2967 return self.tk.call(self._w, "image", "cget", index, option)
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002968 def image_configure(self, index, cnf=None, **kw):
Fredrik Lundh06d28152000-08-09 18:03:12 +00002969 """Configure an embedded image at INDEX."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00002970 return self._configure(('image', 'configure', index), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00002971 def image_create(self, index, cnf={}, **kw):
2972 """Create an embedded image at INDEX."""
Raymond Hettingerff41c482003-04-06 09:01:11 +00002973 return self.tk.call(
2974 self._w, "image", "create", index,
2975 *self._options(cnf, kw))
Fredrik Lundh06d28152000-08-09 18:03:12 +00002976 def image_names(self):
2977 """Return all names of embedded images in this widget."""
2978 return self.tk.call(self._w, "image", "names")
2979 def index(self, index):
2980 """Return the index in the form line.char for INDEX."""
Martin v. Löwisf5d902f2008-01-01 21:08:18 +00002981 return str(self.tk.call(self._w, 'index', index))
Fredrik Lundh06d28152000-08-09 18:03:12 +00002982 def insert(self, index, chars, *args):
2983 """Insert CHARS before the characters at INDEX. An additional
2984 tag can be given in ARGS. Additional CHARS and tags can follow in ARGS."""
2985 self.tk.call((self._w, 'insert', index, chars) + args)
2986 def mark_gravity(self, markName, direction=None):
2987 """Change the gravity of a mark MARKNAME to DIRECTION (LEFT or RIGHT).
2988 Return the current value if None is given for DIRECTION."""
2989 return self.tk.call(
2990 (self._w, 'mark', 'gravity', markName, direction))
2991 def mark_names(self):
2992 """Return all mark names."""
2993 return self.tk.splitlist(self.tk.call(
2994 self._w, 'mark', 'names'))
2995 def mark_set(self, markName, index):
2996 """Set mark MARKNAME before the character at INDEX."""
2997 self.tk.call(self._w, 'mark', 'set', markName, index)
2998 def mark_unset(self, *markNames):
2999 """Delete all marks in MARKNAMES."""
3000 self.tk.call((self._w, 'mark', 'unset') + markNames)
3001 def mark_next(self, index):
3002 """Return the name of the next mark after INDEX."""
3003 return self.tk.call(self._w, 'mark', 'next', index) or None
3004 def mark_previous(self, index):
3005 """Return the name of the previous mark before INDEX."""
3006 return self.tk.call(self._w, 'mark', 'previous', index) or None
3007 def scan_mark(self, x, y):
3008 """Remember the current X, Y coordinates."""
3009 self.tk.call(self._w, 'scan', 'mark', x, y)
3010 def scan_dragto(self, x, y):
3011 """Adjust the view of the text to 10 times the
3012 difference between X and Y and the coordinates given in
3013 scan_mark."""
3014 self.tk.call(self._w, 'scan', 'dragto', x, y)
3015 def search(self, pattern, index, stopindex=None,
3016 forwards=None, backwards=None, exact=None,
Martin v. Löwis038cad72006-11-09 11:27:32 +00003017 regexp=None, nocase=None, count=None, elide=None):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003018 """Search PATTERN beginning from INDEX until STOPINDEX.
3019 Return the index of the first character of a match or an empty string."""
3020 args = [self._w, 'search']
3021 if forwards: args.append('-forwards')
3022 if backwards: args.append('-backwards')
3023 if exact: args.append('-exact')
3024 if regexp: args.append('-regexp')
3025 if nocase: args.append('-nocase')
Martin v. Löwis038cad72006-11-09 11:27:32 +00003026 if elide: args.append('-elide')
Fredrik Lundh06d28152000-08-09 18:03:12 +00003027 if count: args.append('-count'); args.append(count)
3028 if pattern[0] == '-': args.append('--')
3029 args.append(pattern)
3030 args.append(index)
3031 if stopindex: args.append(stopindex)
3032 return self.tk.call(tuple(args))
3033 def see(self, index):
3034 """Scroll such that the character at INDEX is visible."""
3035 self.tk.call(self._w, 'see', index)
3036 def tag_add(self, tagName, index1, *args):
3037 """Add tag TAGNAME to all characters between INDEX1 and index2 in ARGS.
3038 Additional pairs of indices may follow in ARGS."""
3039 self.tk.call(
3040 (self._w, 'tag', 'add', tagName, index1) + args)
3041 def tag_unbind(self, tagName, sequence, funcid=None):
3042 """Unbind for all characters with TAGNAME for event SEQUENCE the
3043 function identified with FUNCID."""
3044 self.tk.call(self._w, 'tag', 'bind', tagName, sequence, '')
3045 if funcid:
3046 self.deletecommand(funcid)
3047 def tag_bind(self, tagName, sequence, func, add=None):
3048 """Bind to all characters with TAGNAME at event SEQUENCE a call to function FUNC.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00003049
Fredrik Lundh06d28152000-08-09 18:03:12 +00003050 An additional boolean parameter ADD specifies whether FUNC will be
3051 called additionally to the other bound function or whether it will
3052 replace the previous function. See bind for the return value."""
3053 return self._bind((self._w, 'tag', 'bind', tagName),
3054 sequence, func, add)
3055 def tag_cget(self, tagName, option):
3056 """Return the value of OPTION for tag TAGNAME."""
3057 if option[:1] != '-':
3058 option = '-' + option
3059 if option[-1:] == '_':
3060 option = option[:-1]
3061 return self.tk.call(self._w, 'tag', 'cget', tagName, option)
Martin v. Löwis6ce13152002-10-10 14:36:13 +00003062 def tag_configure(self, tagName, cnf=None, **kw):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003063 """Configure a tag TAGNAME."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00003064 return self._configure(('tag', 'configure', tagName), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00003065 tag_config = tag_configure
3066 def tag_delete(self, *tagNames):
3067 """Delete all tags in TAGNAMES."""
3068 self.tk.call((self._w, 'tag', 'delete') + tagNames)
3069 def tag_lower(self, tagName, belowThis=None):
3070 """Change the priority of tag TAGNAME such that it is lower
3071 than the priority of BELOWTHIS."""
3072 self.tk.call(self._w, 'tag', 'lower', tagName, belowThis)
3073 def tag_names(self, index=None):
3074 """Return a list of all tag names."""
3075 return self.tk.splitlist(
3076 self.tk.call(self._w, 'tag', 'names', index))
3077 def tag_nextrange(self, tagName, index1, index2=None):
3078 """Return a list of start and end index for the first sequence of
3079 characters between INDEX1 and INDEX2 which all have tag TAGNAME.
3080 The text is searched forward from INDEX1."""
3081 return self.tk.splitlist(self.tk.call(
3082 self._w, 'tag', 'nextrange', tagName, index1, index2))
3083 def tag_prevrange(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 backwards from INDEX1."""
3087 return self.tk.splitlist(self.tk.call(
3088 self._w, 'tag', 'prevrange', tagName, index1, index2))
3089 def tag_raise(self, tagName, aboveThis=None):
3090 """Change the priority of tag TAGNAME such that it is higher
3091 than the priority of ABOVETHIS."""
3092 self.tk.call(
3093 self._w, 'tag', 'raise', tagName, aboveThis)
3094 def tag_ranges(self, tagName):
3095 """Return a list of ranges of text which have tag TAGNAME."""
3096 return self.tk.splitlist(self.tk.call(
3097 self._w, 'tag', 'ranges', tagName))
3098 def tag_remove(self, tagName, index1, index2=None):
3099 """Remove tag TAGNAME from all characters between INDEX1 and INDEX2."""
3100 self.tk.call(
3101 self._w, 'tag', 'remove', tagName, index1, index2)
3102 def window_cget(self, index, option):
3103 """Return the value of OPTION of an embedded window at INDEX."""
3104 if option[:1] != '-':
3105 option = '-' + option
3106 if option[-1:] == '_':
3107 option = option[:-1]
3108 return self.tk.call(self._w, 'window', 'cget', index, option)
Martin v. Löwis6ce13152002-10-10 14:36:13 +00003109 def window_configure(self, index, cnf=None, **kw):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003110 """Configure an embedded window at INDEX."""
Martin v. Löwis6ce13152002-10-10 14:36:13 +00003111 return self._configure(('window', 'configure', index), cnf, kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00003112 window_config = window_configure
3113 def window_create(self, index, cnf={}, **kw):
3114 """Create a window at INDEX."""
3115 self.tk.call(
3116 (self._w, 'window', 'create', index)
3117 + self._options(cnf, kw))
3118 def window_names(self):
3119 """Return all names of embedded windows in this widget."""
3120 return self.tk.splitlist(
3121 self.tk.call(self._w, 'window', 'names'))
3122 def xview(self, *what):
3123 """Query and change horizontal position of the view."""
3124 if not what:
3125 return self._getdoubles(self.tk.call(self._w, 'xview'))
3126 self.tk.call((self._w, 'xview') + what)
Fredrik Lundh5bd2cd62000-08-09 18:29:51 +00003127 def xview_moveto(self, fraction):
3128 """Adjusts the view in the window so that FRACTION of the
3129 total width of the canvas is off-screen to the left."""
3130 self.tk.call(self._w, 'xview', 'moveto', fraction)
3131 def xview_scroll(self, number, what):
3132 """Shift the x-view according to NUMBER which is measured
3133 in "units" or "pages" (WHAT)."""
3134 self.tk.call(self._w, 'xview', 'scroll', number, what)
Fredrik Lundh8fffa202000-08-09 18:51:01 +00003135 def yview(self, *what):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003136 """Query and change vertical position of the view."""
Fredrik Lundh8fffa202000-08-09 18:51:01 +00003137 if not what:
Fredrik Lundh06d28152000-08-09 18:03:12 +00003138 return self._getdoubles(self.tk.call(self._w, 'yview'))
Fredrik Lundh8fffa202000-08-09 18:51:01 +00003139 self.tk.call((self._w, 'yview') + what)
Fredrik Lundh5bd2cd62000-08-09 18:29:51 +00003140 def yview_moveto(self, fraction):
3141 """Adjusts the view in the window so that FRACTION of the
3142 total height of the canvas is off-screen to the top."""
3143 self.tk.call(self._w, 'yview', 'moveto', fraction)
3144 def yview_scroll(self, number, what):
3145 """Shift the y-view according to NUMBER which is measured
3146 in "units" or "pages" (WHAT)."""
3147 self.tk.call(self._w, 'yview', 'scroll', number, what)
Fredrik Lundh06d28152000-08-09 18:03:12 +00003148 def yview_pickplace(self, *what):
3149 """Obsolete function, use see."""
3150 self.tk.call((self._w, 'yview', '-pickplace') + what)
Guido van Rossum18468821994-06-20 07:49:28 +00003151
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003152
Guido van Rossum28574b51996-10-21 15:16:51 +00003153class _setit:
Fredrik Lundh06d28152000-08-09 18:03:12 +00003154 """Internal class. It wraps the command in the widget OptionMenu."""
3155 def __init__(self, var, value, callback=None):
3156 self.__value = value
3157 self.__var = var
3158 self.__callback = callback
3159 def __call__(self, *args):
3160 self.__var.set(self.__value)
3161 if self.__callback:
Raymond Hettingerff41c482003-04-06 09:01:11 +00003162 self.__callback(self.__value, *args)
Guido van Rossum28574b51996-10-21 15:16:51 +00003163
3164class OptionMenu(Menubutton):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003165 """OptionMenu which allows the user to select a value from a menu."""
3166 def __init__(self, master, variable, value, *values, **kwargs):
3167 """Construct an optionmenu widget with the parent MASTER, with
3168 the resource textvariable set to VARIABLE, the initially selected
3169 value VALUE, the other menu values VALUES and an additional
3170 keyword argument command."""
3171 kw = {"borderwidth": 2, "textvariable": variable,
3172 "indicatoron": 1, "relief": RAISED, "anchor": "c",
3173 "highlightthickness": 2}
3174 Widget.__init__(self, master, "menubutton", kw)
3175 self.widgetName = 'tk_optionMenu'
3176 menu = self.__menu = Menu(self, name="menu", tearoff=0)
3177 self.menuname = menu._w
3178 # 'command' is the only supported keyword
3179 callback = kwargs.get('command')
3180 if kwargs.has_key('command'):
3181 del kwargs['command']
3182 if kwargs:
3183 raise TclError, 'unknown option -'+kwargs.keys()[0]
3184 menu.add_command(label=value,
3185 command=_setit(variable, value, callback))
3186 for v in values:
3187 menu.add_command(label=v,
3188 command=_setit(variable, v, callback))
3189 self["menu"] = menu
Guido van Rossum28574b51996-10-21 15:16:51 +00003190
Fredrik Lundh06d28152000-08-09 18:03:12 +00003191 def __getitem__(self, name):
3192 if name == 'menu':
3193 return self.__menu
3194 return Widget.__getitem__(self, name)
Guido van Rossum28574b51996-10-21 15:16:51 +00003195
Fredrik Lundh06d28152000-08-09 18:03:12 +00003196 def destroy(self):
3197 """Destroy this widget and the associated menu."""
3198 Menubutton.destroy(self)
3199 self.__menu = None
Guido van Rossumbf4d8f91995-09-01 20:35:37 +00003200
Guido van Rossum35f67fb1995-08-04 03:50:29 +00003201class Image:
Fredrik Lundh06d28152000-08-09 18:03:12 +00003202 """Base class for images."""
Martin v. Löwis0d8ce612000-09-08 16:28:30 +00003203 _last_id = 0
Fredrik Lundh06d28152000-08-09 18:03:12 +00003204 def __init__(self, imgtype, name=None, cnf={}, master=None, **kw):
3205 self.name = None
3206 if not master:
3207 master = _default_root
3208 if not master:
3209 raise RuntimeError, 'Too early to create image'
3210 self.tk = master.tk
3211 if not name:
Martin v. Löwis0d8ce612000-09-08 16:28:30 +00003212 Image._last_id += 1
Walter Dörwald70a6b492004-02-12 17:35:32 +00003213 name = "pyimage%r" % (Image._last_id,) # tk itself would use image<x>
Fredrik Lundh06d28152000-08-09 18:03:12 +00003214 # The following is needed for systems where id(x)
3215 # can return a negative number, such as Linux/m68k:
3216 if name[0] == '-': name = '_' + name[1:]
3217 if kw and cnf: cnf = _cnfmerge((cnf, kw))
3218 elif kw: cnf = kw
3219 options = ()
3220 for k, v in cnf.items():
3221 if callable(v):
3222 v = self._register(v)
3223 options = options + ('-'+k, v)
3224 self.tk.call(('image', 'create', imgtype, name,) + options)
3225 self.name = name
3226 def __str__(self): return self.name
3227 def __del__(self):
3228 if self.name:
3229 try:
3230 self.tk.call('image', 'delete', self.name)
3231 except TclError:
3232 # May happen if the root was destroyed
3233 pass
3234 def __setitem__(self, key, value):
3235 self.tk.call(self.name, 'configure', '-'+key, value)
3236 def __getitem__(self, key):
3237 return self.tk.call(self.name, 'configure', '-'+key)
3238 def configure(self, **kw):
3239 """Configure the image."""
3240 res = ()
3241 for k, v in _cnfmerge(kw).items():
3242 if v is not None:
3243 if k[-1] == '_': k = k[:-1]
3244 if callable(v):
3245 v = self._register(v)
3246 res = res + ('-'+k, v)
3247 self.tk.call((self.name, 'config') + res)
3248 config = configure
3249 def height(self):
3250 """Return the height of the image."""
3251 return getint(
3252 self.tk.call('image', 'height', self.name))
3253 def type(self):
3254 """Return the type of the imgage, e.g. "photo" or "bitmap"."""
3255 return self.tk.call('image', 'type', self.name)
3256 def width(self):
3257 """Return the width of the image."""
3258 return getint(
3259 self.tk.call('image', 'width', self.name))
Guido van Rossum35f67fb1995-08-04 03:50:29 +00003260
3261class PhotoImage(Image):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003262 """Widget which can display colored images in GIF, PPM/PGM format."""
3263 def __init__(self, name=None, cnf={}, master=None, **kw):
3264 """Create an image with NAME.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00003265
Fredrik Lundh06d28152000-08-09 18:03:12 +00003266 Valid resource names: data, format, file, gamma, height, palette,
3267 width."""
Raymond Hettingerff41c482003-04-06 09:01:11 +00003268 Image.__init__(self, 'photo', name, cnf, master, **kw)
Fredrik Lundh06d28152000-08-09 18:03:12 +00003269 def blank(self):
3270 """Display a transparent image."""
3271 self.tk.call(self.name, 'blank')
3272 def cget(self, option):
3273 """Return the value of OPTION."""
3274 return self.tk.call(self.name, 'cget', '-' + option)
3275 # XXX config
3276 def __getitem__(self, key):
3277 return self.tk.call(self.name, 'cget', '-' + key)
3278 # XXX copy -from, -to, ...?
3279 def copy(self):
3280 """Return a new PhotoImage with the same image as this widget."""
3281 destImage = PhotoImage()
3282 self.tk.call(destImage, 'copy', self.name)
3283 return destImage
3284 def zoom(self,x,y=''):
3285 """Return a new PhotoImage with the same image as this widget
3286 but zoom it with X and Y."""
3287 destImage = PhotoImage()
3288 if y=='': y=x
3289 self.tk.call(destImage, 'copy', self.name, '-zoom',x,y)
3290 return destImage
3291 def subsample(self,x,y=''):
3292 """Return a new PhotoImage based on the same image as this widget
3293 but use only every Xth or Yth pixel."""
3294 destImage = PhotoImage()
3295 if y=='': y=x
3296 self.tk.call(destImage, 'copy', self.name, '-subsample',x,y)
3297 return destImage
3298 def get(self, x, y):
3299 """Return the color (red, green, blue) of the pixel at X,Y."""
3300 return self.tk.call(self.name, 'get', x, y)
3301 def put(self, data, to=None):
3302 """Put row formated colors to image starting from
3303 position TO, e.g. image.put("{red green} {blue yellow}", to=(4,6))"""
3304 args = (self.name, 'put', data)
3305 if to:
3306 if to[0] == '-to':
3307 to = to[1:]
3308 args = args + ('-to',) + tuple(to)
3309 self.tk.call(args)
3310 # XXX read
3311 def write(self, filename, format=None, from_coords=None):
3312 """Write image to file FILENAME in FORMAT starting from
3313 position FROM_COORDS."""
3314 args = (self.name, 'write', filename)
3315 if format:
3316 args = args + ('-format', format)
3317 if from_coords:
3318 args = args + ('-from',) + tuple(from_coords)
3319 self.tk.call(args)
Guido van Rossum35f67fb1995-08-04 03:50:29 +00003320
3321class BitmapImage(Image):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003322 """Widget which can display a bitmap."""
3323 def __init__(self, name=None, cnf={}, master=None, **kw):
3324 """Create a bitmap with NAME.
Guido van Rossum5917ecb2000-06-29 16:30:50 +00003325
Fredrik Lundh06d28152000-08-09 18:03:12 +00003326 Valid resource names: background, data, file, foreground, maskdata, maskfile."""
Raymond Hettingerff41c482003-04-06 09:01:11 +00003327 Image.__init__(self, 'bitmap', name, cnf, master, **kw)
Guido van Rossum35f67fb1995-08-04 03:50:29 +00003328
3329def image_names(): return _default_root.tk.call('image', 'names')
3330def image_types(): return _default_root.tk.call('image', 'types')
3331
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003332
3333class Spinbox(Widget):
3334 """spinbox widget."""
3335 def __init__(self, master=None, cnf={}, **kw):
3336 """Construct a spinbox widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003337
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003338 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003339
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003340 activebackground, background, borderwidth,
3341 cursor, exportselection, font, foreground,
3342 highlightbackground, highlightcolor,
3343 highlightthickness, insertbackground,
3344 insertborderwidth, insertofftime,
Raymond Hettingerff41c482003-04-06 09:01:11 +00003345 insertontime, insertwidth, justify, relief,
3346 repeatdelay, repeatinterval,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003347 selectbackground, selectborderwidth
3348 selectforeground, takefocus, textvariable
3349 xscrollcommand.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003350
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003351 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003352
3353 buttonbackground, buttoncursor,
3354 buttondownrelief, buttonuprelief,
3355 command, disabledbackground,
3356 disabledforeground, format, from,
3357 invalidcommand, increment,
3358 readonlybackground, state, to,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003359 validate, validatecommand values,
3360 width, wrap,
3361 """
3362 Widget.__init__(self, master, 'spinbox', cnf, kw)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003363
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003364 def bbox(self, index):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003365 """Return a tuple of X1,Y1,X2,Y2 coordinates for a
3366 rectangle which encloses the character given by index.
3367
3368 The first two elements of the list give the x and y
3369 coordinates of the upper-left corner of the screen
3370 area covered by the character (in pixels relative
3371 to the widget) and the last two elements give the
3372 width and height of the character, in pixels. The
3373 bounding box may refer to a region outside the
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003374 visible area of the window.
3375 """
3376 return self.tk.call(self._w, 'bbox', index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003377
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003378 def delete(self, first, last=None):
3379 """Delete one or more elements of the spinbox.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003380
3381 First is the index of the first character to delete,
3382 and last is the index of the character just after
3383 the last one to delete. If last isn't specified it
3384 defaults to first+1, i.e. a single character is
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003385 deleted. This command returns an empty string.
3386 """
3387 return self.tk.call(self._w, 'delete', first, last)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003388
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003389 def get(self):
3390 """Returns the spinbox's string"""
3391 return self.tk.call(self._w, 'get')
Raymond Hettingerff41c482003-04-06 09:01:11 +00003392
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003393 def icursor(self, index):
3394 """Alter the position of the insertion cursor.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003395
3396 The insertion cursor will be displayed just before
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003397 the character given by index. Returns an empty string
3398 """
3399 return self.tk.call(self._w, 'icursor', index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003400
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003401 def identify(self, x, y):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003402 """Returns the name of the widget at position x, y
3403
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003404 Return value is one of: none, buttondown, buttonup, entry
3405 """
3406 return self.tk.call(self._w, 'identify', x, y)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003407
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003408 def index(self, index):
3409 """Returns the numerical index corresponding to index
3410 """
3411 return self.tk.call(self._w, 'index', index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003412
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003413 def insert(self, index, s):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003414 """Insert string s at index
3415
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003416 Returns an empty string.
3417 """
3418 return self.tk.call(self._w, 'insert', index, s)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003419
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003420 def invoke(self, element):
3421 """Causes the specified element to be invoked
Raymond Hettingerff41c482003-04-06 09:01:11 +00003422
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003423 The element could be buttondown or buttonup
3424 triggering the action associated with it.
3425 """
3426 return self.tk.call(self._w, 'invoke', element)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003427
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003428 def scan(self, *args):
3429 """Internal function."""
3430 return self._getints(
3431 self.tk.call((self._w, 'scan') + args)) or ()
Raymond Hettingerff41c482003-04-06 09:01:11 +00003432
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003433 def scan_mark(self, x):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003434 """Records x and the current view in the spinbox window;
3435
3436 used in conjunction with later scan dragto commands.
3437 Typically this command is associated with a mouse button
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003438 press in the widget. It returns an empty string.
3439 """
3440 return self.scan("mark", x)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003441
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003442 def scan_dragto(self, x):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003443 """Compute the difference between the given x argument
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003444 and the x argument to the last scan mark command
Raymond Hettingerff41c482003-04-06 09:01:11 +00003445
3446 It then adjusts the view left or right by 10 times the
3447 difference in x-coordinates. This command is typically
3448 associated with mouse motion events in the widget, to
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003449 produce the effect of dragging the spinbox at high speed
3450 through the window. The return value is an empty string.
3451 """
3452 return self.scan("dragto", x)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003453
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003454 def selection(self, *args):
3455 """Internal function."""
3456 return self._getints(
3457 self.tk.call((self._w, 'selection') + args)) or ()
Raymond Hettingerff41c482003-04-06 09:01:11 +00003458
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003459 def selection_adjust(self, index):
3460 """Locate the end of the selection nearest to the character
Raymond Hettingerff41c482003-04-06 09:01:11 +00003461 given by index,
3462
3463 Then adjust that end of the selection to be at index
3464 (i.e including but not going beyond index). The other
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003465 end of the selection is made the anchor point for future
Raymond Hettingerff41c482003-04-06 09:01:11 +00003466 select to commands. If the selection isn't currently in
3467 the spinbox, then a new selection is created to include
3468 the characters between index and the most recent selection
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003469 anchor point, inclusive. Returns an empty string.
3470 """
3471 return self.selection("adjust", index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003472
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003473 def selection_clear(self):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003474 """Clear the selection
3475
3476 If the selection isn't in this widget then the
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003477 command has no effect. Returns an empty string.
3478 """
3479 return self.selection("clear")
Raymond Hettingerff41c482003-04-06 09:01:11 +00003480
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003481 def selection_element(self, element=None):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003482 """Sets or gets the currently selected element.
3483
3484 If a spinbutton element is specified, it will be
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003485 displayed depressed
3486 """
3487 return self.selection("element", element)
3488
3489###########################################################################
3490
3491class LabelFrame(Widget):
3492 """labelframe widget."""
3493 def __init__(self, master=None, cnf={}, **kw):
3494 """Construct a labelframe widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003495
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003496 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003497
3498 borderwidth, cursor, font, foreground,
3499 highlightbackground, highlightcolor,
3500 highlightthickness, padx, pady, relief,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003501 takefocus, text
Raymond Hettingerff41c482003-04-06 09:01:11 +00003502
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003503 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003504
3505 background, class, colormap, container,
3506 height, labelanchor, labelwidget,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003507 visual, width
3508 """
3509 Widget.__init__(self, master, 'labelframe', cnf, kw)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003510
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003511########################################################################
3512
3513class PanedWindow(Widget):
3514 """panedwindow widget."""
3515 def __init__(self, master=None, cnf={}, **kw):
3516 """Construct a panedwindow widget with the parent MASTER.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003517
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003518 STANDARD OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003519
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003520 background, borderwidth, cursor, height,
3521 orient, relief, width
Raymond Hettingerff41c482003-04-06 09:01:11 +00003522
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003523 WIDGET-SPECIFIC OPTIONS
Raymond Hettingerff41c482003-04-06 09:01:11 +00003524
3525 handlepad, handlesize, opaqueresize,
3526 sashcursor, sashpad, sashrelief,
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003527 sashwidth, showhandle,
3528 """
3529 Widget.__init__(self, master, 'panedwindow', cnf, kw)
3530
3531 def add(self, child, **kw):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003532 """Add a child widget to the panedwindow in a new pane.
3533
3534 The child argument is the name of the child widget
3535 followed by pairs of arguments that specify how to
3536 manage the windows. Options may have any of the values
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003537 accepted by the configure subcommand.
3538 """
3539 self.tk.call((self._w, 'add', child) + self._options(kw))
Raymond Hettingerff41c482003-04-06 09:01:11 +00003540
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003541 def remove(self, child):
3542 """Remove the pane containing child from the panedwindow
Raymond Hettingerff41c482003-04-06 09:01:11 +00003543
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003544 All geometry management options for child will be forgotten.
3545 """
3546 self.tk.call(self._w, 'forget', child)
3547 forget=remove
Raymond Hettingerff41c482003-04-06 09:01:11 +00003548
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003549 def identify(self, x, y):
3550 """Identify the panedwindow component at point x, y
Raymond Hettingerff41c482003-04-06 09:01:11 +00003551
3552 If the point is over a sash or a sash handle, the result
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003553 is a two element list containing the index of the sash or
Raymond Hettingerff41c482003-04-06 09:01:11 +00003554 handle, and a word indicating whether it is over a sash
3555 or a handle, such as {0 sash} or {2 handle}. If the point
3556 is over any other part of the panedwindow, the result is
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003557 an empty list.
3558 """
3559 return self.tk.call(self._w, 'identify', x, y)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003560
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003561 def proxy(self, *args):
3562 """Internal function."""
3563 return self._getints(
Raymond Hettingerff41c482003-04-06 09:01:11 +00003564 self.tk.call((self._w, 'proxy') + args)) or ()
3565
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003566 def proxy_coord(self):
3567 """Return the x and y pair of the most recent proxy location
3568 """
3569 return self.proxy("coord")
Raymond Hettingerff41c482003-04-06 09:01:11 +00003570
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003571 def proxy_forget(self):
3572 """Remove the proxy from the display.
3573 """
3574 return self.proxy("forget")
Raymond Hettingerff41c482003-04-06 09:01:11 +00003575
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003576 def proxy_place(self, x, y):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003577 """Place the proxy at the given x and y coordinates.
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003578 """
3579 return self.proxy("place", x, y)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003580
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003581 def sash(self, *args):
3582 """Internal function."""
3583 return self._getints(
3584 self.tk.call((self._w, 'sash') + args)) or ()
Raymond Hettingerff41c482003-04-06 09:01:11 +00003585
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003586 def sash_coord(self, index):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003587 """Return the current x and y pair for the sash given by index.
3588
3589 Index must be an integer between 0 and 1 less than the
3590 number of panes in the panedwindow. The coordinates given are
3591 those of the top left corner of the region containing the sash.
3592 pathName sash dragto index x y This command computes the
3593 difference between the given coordinates and the coordinates
3594 given to the last sash coord command for the given sash. It then
3595 moves that sash the computed difference. The return value is the
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003596 empty string.
3597 """
3598 return self.sash("coord", index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003599
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003600 def sash_mark(self, index):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003601 """Records x and y for the sash given by index;
3602
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003603 Used in conjunction with later dragto commands to move the sash.
3604 """
3605 return self.sash("mark", index)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003606
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003607 def sash_place(self, index, x, y):
3608 """Place the sash given by index at the given coordinates
3609 """
3610 return self.sash("place", index, x, y)
Raymond Hettingerff41c482003-04-06 09:01:11 +00003611
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003612 def panecget(self, child, option):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003613 """Query a management option for window.
3614
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003615 Option may be any value allowed by the paneconfigure subcommand
3616 """
3617 return self.tk.call(
3618 (self._w, 'panecget') + (child, '-'+option))
Raymond Hettingerff41c482003-04-06 09:01:11 +00003619
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003620 def paneconfigure(self, tagOrId, cnf=None, **kw):
Raymond Hettingerff41c482003-04-06 09:01:11 +00003621 """Query or modify the management options for window.
3622
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003623 If no option is specified, returns a list describing all
Raymond Hettingerff41c482003-04-06 09:01:11 +00003624 of the available options for pathName. If option is
3625 specified with no value, then the command returns a list
3626 describing the one named option (this list will be identical
3627 to the corresponding sublist of the value returned if no
3628 option is specified). If one or more option-value pairs are
3629 specified, then the command modifies the given widget
3630 option(s) to have the given value(s); in this case the
3631 command returns an empty string. The following options
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003632 are supported:
Raymond Hettingerff41c482003-04-06 09:01:11 +00003633
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003634 after window
Raymond Hettingerff41c482003-04-06 09:01:11 +00003635 Insert the window after the window specified. window
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003636 should be the name of a window already managed by pathName.
3637 before window
Raymond Hettingerff41c482003-04-06 09:01:11 +00003638 Insert the window before the window specified. window
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003639 should be the name of a window already managed by pathName.
3640 height size
Raymond Hettingerff41c482003-04-06 09:01:11 +00003641 Specify a height for the window. The height will be the
3642 outer dimension of the window including its border, if
3643 any. If size is an empty string, or if -height is not
3644 specified, then the height requested internally by the
3645 window will be used initially; the height may later be
3646 adjusted by the movement of sashes in the panedwindow.
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003647 Size may be any value accepted by Tk_GetPixels.
3648 minsize n
Raymond Hettingerff41c482003-04-06 09:01:11 +00003649 Specifies that the size of the window cannot be made
3650 less than n. This constraint only affects the size of
3651 the widget in the paned dimension -- the x dimension
3652 for horizontal panedwindows, the y dimension for
3653 vertical panedwindows. May be any value accepted by
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003654 Tk_GetPixels.
3655 padx n
Raymond Hettingerff41c482003-04-06 09:01:11 +00003656 Specifies a non-negative value indicating how much
3657 extra space to leave on each side of the window in
3658 the X-direction. The value may have any of the forms
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003659 accepted by Tk_GetPixels.
3660 pady n
3661 Specifies a non-negative value indicating how much
Raymond Hettingerff41c482003-04-06 09:01:11 +00003662 extra space to leave on each side of the window in
3663 the Y-direction. The value may have any of the forms
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003664 accepted by Tk_GetPixels.
3665 sticky style
Raymond Hettingerff41c482003-04-06 09:01:11 +00003666 If a window's pane is larger than the requested
3667 dimensions of the window, this option may be used
3668 to position (or stretch) the window within its pane.
3669 Style is a string that contains zero or more of the
3670 characters n, s, e or w. The string can optionally
3671 contains spaces or commas, but they are ignored. Each
3672 letter refers to a side (north, south, east, or west)
3673 that the window will "stick" to. If both n and s
3674 (or e and w) are specified, the window will be
3675 stretched to fill the entire height (or width) of
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003676 its cavity.
3677 width size
Raymond Hettingerff41c482003-04-06 09:01:11 +00003678 Specify a width for the window. The width will be
3679 the outer dimension of the window including its
3680 border, if any. If size is an empty string, or
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003681 if -width is not specified, then the width requested
Raymond Hettingerff41c482003-04-06 09:01:11 +00003682 internally by the window will be used initially; the
3683 width may later be adjusted by the movement of sashes
3684 in the panedwindow. Size may be any value accepted by
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003685 Tk_GetPixels.
Raymond Hettingerff41c482003-04-06 09:01:11 +00003686
Martin v. Löwis2ec36272002-10-13 10:22:08 +00003687 """
3688 if cnf is None and not kw:
3689 cnf = {}
3690 for x in self.tk.split(
3691 self.tk.call(self._w,
3692 'paneconfigure', tagOrId)):
3693 cnf[x[0][1:]] = (x[0][1:],) + x[1:]
3694 return cnf
3695 if type(cnf) == StringType and not kw:
3696 x = self.tk.split(self.tk.call(
3697 self._w, 'paneconfigure', tagOrId, '-'+cnf))
3698 return (x[0][1:],) + x[1:]
3699 self.tk.call((self._w, 'paneconfigure', tagOrId) +
3700 self._options(cnf, kw))
3701 paneconfig = paneconfigure
3702
3703 def panes(self):
3704 """Returns an ordered list of the child panes."""
3705 return self.tk.call(self._w, 'panes')
3706
Guido van Rossumaec5dc91994-06-27 07:55:12 +00003707######################################################################
3708# Extensions:
3709
3710class Studbutton(Button):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003711 def __init__(self, master=None, cnf={}, **kw):
3712 Widget.__init__(self, master, 'studbutton', cnf, kw)
3713 self.bind('<Any-Enter>', self.tkButtonEnter)
3714 self.bind('<Any-Leave>', self.tkButtonLeave)
3715 self.bind('<1>', self.tkButtonDown)
3716 self.bind('<ButtonRelease-1>', self.tkButtonUp)
Guido van Rossumaec5dc91994-06-27 07:55:12 +00003717
3718class Tributton(Button):
Fredrik Lundh06d28152000-08-09 18:03:12 +00003719 def __init__(self, master=None, cnf={}, **kw):
3720 Widget.__init__(self, master, 'tributton', cnf, kw)
3721 self.bind('<Any-Enter>', self.tkButtonEnter)
3722 self.bind('<Any-Leave>', self.tkButtonLeave)
3723 self.bind('<1>', self.tkButtonDown)
3724 self.bind('<ButtonRelease-1>', self.tkButtonUp)
3725 self['fg'] = self['bg']
3726 self['activebackground'] = self['bg']
Guido van Rossum37dcab11996-05-16 16:00:19 +00003727
Guido van Rossumc417ef81996-08-21 23:38:59 +00003728######################################################################
3729# Test:
3730
3731def _test():
Fredrik Lundh06d28152000-08-09 18:03:12 +00003732 root = Tk()
3733 text = "This is Tcl/Tk version %s" % TclVersion
3734 if TclVersion >= 8.1:
Fredrik Lundh8fffa202000-08-09 18:51:01 +00003735 try:
3736 text = text + unicode("\nThis should be a cedilla: \347",
3737 "iso-8859-1")
3738 except NameError:
3739 pass # no unicode support
Fredrik Lundh06d28152000-08-09 18:03:12 +00003740 label = Label(root, text=text)
3741 label.pack()
3742 test = Button(root, text="Click me!",
3743 command=lambda root=root: root.test.configure(
3744 text="[%s]" % root.test['text']))
3745 test.pack()
3746 root.test = test
3747 quit = Button(root, text="QUIT", command=root.destroy)
3748 quit.pack()
3749 # The following three commands are needed so the window pops
3750 # up on top on Windows...
3751 root.iconify()
3752 root.update()
3753 root.deiconify()
3754 root.mainloop()
Guido van Rossumc417ef81996-08-21 23:38:59 +00003755
3756if __name__ == '__main__':
Fredrik Lundh06d28152000-08-09 18:03:12 +00003757 _test()