Mercurial > cpython-lru_cache-weakref

annotate Lib/idlelib/WidgetRedirector.py @ 54294:dba767bc3155 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
remove mention of old ctypes version
author Benjamin Peterson <benjamin@python.org>
date Sat, 23 May 2009 20:59:09 +0000
parents b53604fad54b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
47183
b53604fad54b Tkinter rename reversal: remove tkinter package, adapt imports and docs.
Georg Brandl <georg@python.org>
parents: 47101
diff changeset
1 from Tkinter import *
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
2
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
3 class WidgetRedirector:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
4
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
5 """Support for redirecting arbitrary widget subcommands.
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
6
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
7 Some Tk operations don't normally pass through Tkinter. For example, if a
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
8 character is inserted into a Text widget by pressing a key, a default Tk
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
9 binding to the widget's 'insert' operation is activated, and the Tk library
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
10 processes the insert without calling back into Tkinter.
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
11
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
12 Although a binding to <Key> could be made via Tkinter, what we really want
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
13 to do is to hook the Tk 'insert' operation itself.
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
14
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
15 When a widget is instantiated, a Tcl command is created whose name is the
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
16 same as the pathname widget._w. This command is used to invoke the various
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
17 widget operations, e.g. insert (for a Text widget). We are going to hook
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
18 this command and provide a facility ('register') to intercept the widget
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
19 operation.
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
20
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
21 In IDLE, the function being registered provides access to the top of a
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
22 Percolator chain. At the bottom of the chain is a call to the original
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
23 Tk widget operation.
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
24
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
25 """
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
26 def __init__(self, widget):
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
27 self._operations = {}
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
28 self.widget = widget # widget instance
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
29 self.tk = tk = widget.tk # widget's root
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
30 w = widget._w # widget's (full) Tk pathname
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
31 self.orig = w + "_orig"
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
32 # Rename the Tcl command within Tcl:
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
33 tk.call("rename", w, self.orig)
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
34 # Create a new Tcl command whose name is the widget's pathname, and
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
35 # whose action is to dispatch on the operation passed to the widget:
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
36 tk.createcommand(w, self.dispatch)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
37
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
38 def __repr__(self):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
39 return "WidgetRedirector(%s<%s>)" % (self.widget.__class__.__name__,
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
40 self.widget._w)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
41
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
42 def close(self):
44340
15fbe7c79284 Fixed #1649: IDLE error: dictionary changed size during iteration
Christian Heimes <christian@cheimes.de>
parents: 43683
diff changeset
43 for operation in list(self._operations):
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
44 self.unregister(operation)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
45 widget = self.widget; del self.widget
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
46 orig = self.orig; del self.orig
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
47 tk = widget.tk
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
48 w = widget._w
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
49 tk.deletecommand(w)
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
50 # restore the original widget Tcl command:
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
51 tk.call("rename", orig, w)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
52
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
53 def register(self, operation, function):
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
54 self._operations[operation] = function
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
55 setattr(self.widget, operation, function)
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
56 return OriginalCommand(self, operation)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
57
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
58 def unregister(self, operation):
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
59 if operation in self._operations:
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
60 function = self._operations[operation]
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
61 del self._operations[operation]
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
62 if hasattr(self.widget, operation):
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
63 delattr(self.widget, operation)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
64 return function
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
65 else:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
66 return None
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
67
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
68 def dispatch(self, operation, *args):
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
69 '''Callback from Tcl which runs when the widget is referenced.
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
70
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
71 If an operation has been registered in self._operations, apply the
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
72 associated function to the args passed into Tcl. Otherwise, pass the
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
73 operation through to Tk via the original Tcl function.
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
74
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
75 Note that if a registered function is called, the operation is not
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
76 passed through to Tk. Apply the function returned by self.register()
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
77 to *args to accomplish that. For an example, see ColorDelegator.py.
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
78
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
79 '''
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
80 m = self._operations.get(operation)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
81 try:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
82 if m:
29794
94e5d1b8f696 SF patch #768187: replace apply(f, args, kwds) with f(*args, **kwds)
Raymond Hettinger <python@rcn.com>
parents: 13975
diff changeset
83 return m(*args)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
84 else:
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
85 return self.tk.call((self.orig, operation) + args)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
86 except TclError:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
87 return ""
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
88
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
89
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
90 class OriginalCommand:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
91
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
92 def __init__(self, redir, operation):
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
93 self.redir = redir
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
94 self.operation = operation
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
95 self.tk = redir.tk
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
96 self.orig = redir.orig
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
97 self.tk_call = self.tk.call
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
98 self.orig_and_operation = (self.orig, self.operation)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
99
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
100 def __repr__(self):
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
101 return "OriginalCommand(%r, %r)" % (self.redir, self.operation)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
102
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
103 def __call__(self, *args):
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
104 return self.tk_call(self.orig_and_operation + args)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
105
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
106
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
107 def main():
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
108 root = Tk()
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
109 root.wm_protocol("WM_DELETE_WINDOW", root.quit)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
110 text = Text()
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
111 text.pack()
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
112 text.focus_set()
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
113 redir = WidgetRedirector(text)
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
114 global previous_tcl_fcn
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
115 def my_insert(*args):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
116 print "insert", args
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
117 previous_tcl_fcn(*args)
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
118 previous_tcl_fcn = redir.register("insert", my_insert)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
119 root.mainloop()
43683
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
120 redir.unregister("insert") # runs after first 'close window'
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
121 redir.close()
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
122 root.mainloop()
d3bf009fbba9 1. Add comments to provide top-level documentation.
Kurt B. Kaiser <kbk@shore.net>
parents: 43679
diff changeset
123 root.destroy()
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
124
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
125 if __name__ == "__main__":
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
126 main()