Mercurial > cpython-lru_cache-weakref
annotate Doc/mac/libframework.tex @ 8831:00a6bb65ff29 legacy-trunk
Getting rid of this ancient stuff.
| author | Guido van Rossum <guido@python.org> |
|---|---|
| date | Wed, 05 Aug 1998 21:10:09 +0000 |
| parents | c750c7a21e03 |
| children | 552c6b3aba3d |
| rev | line source |
|---|---|
|
7877
8e5223680a9d
Remove all uses of \sectcode; we can now use logical markup everywhere.
Fred Drake <fdrake@acm.org>
parents:
7866
diff
changeset
|
1 \section{Standard Module \module{FrameWork}} |
|
8715
c750c7a21e03
Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents:
7877
diff
changeset
|
2 \declaremodule{standard}{FrameWork} |
|
c750c7a21e03
Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents:
7877
diff
changeset
|
3 |
|
c750c7a21e03
Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents:
7877
diff
changeset
|
4 \modulesynopsis{Interactive application framework.} |
|
c750c7a21e03
Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents:
7877
diff
changeset
|
5 |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
6 |
| 7866 | 7 The \module{FrameWork} module contains classes that together provide a |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
8 framework for an interactive Macintosh application. The programmer |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
9 builds an application by creating subclasses that override various |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
10 methods of the bases classes, thereby implementing the functionality |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
11 wanted. Overriding functionality can often be done on various |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
12 different levels, i.e. to handle clicks in a single dialog window in a |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
13 non-standard way it is not necessary to override the complete event |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
14 handling. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
15 |
| 7866 | 16 The \module{FrameWork} is still very much work-in-progress, and the |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
17 documentation describes only the most important functionality, and not |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
18 in the most logical manner at that. Examine the source or the examples |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
19 for more details. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
20 |
| 7866 | 21 The \module{FrameWork} module defines the following functions: |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
22 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
23 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
24 \begin{funcdesc}{Application}{} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
25 An object representing the complete application. See below for a |
| 7866 | 26 description of the methods. The default \method{__init__()} routine |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
27 creates an empty window dictionary and a menu bar with an apple menu. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
28 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
29 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
30 \begin{funcdesc}{MenuBar}{} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
31 An object representing the menubar. This object is usually not created |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
32 by the user. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
33 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
34 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
35 \begin{funcdesc}{Menu}{bar, title\optional{, after}} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
36 An object representing a menu. Upon creation you pass the |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
37 \code{MenuBar} the menu appears in, the \var{title} string and a |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
38 position (1-based) \var{after} where the menu should appear (default: |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
39 at the end). |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
40 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
41 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
42 \begin{funcdesc}{MenuItem}{menu, title\optional{, shortcut, callback}} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
43 Create a menu item object. The arguments are the menu to crate the |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
44 item it, the item title string and optionally the keyboard shortcut |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
45 and a callback routine. The callback is called with the arguments |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
46 menu-id, item number within menu (1-based), current front window and |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
47 the event record. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
48 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
49 In stead of a callable object the callback can also be a string. In |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
50 this case menu selection causes the lookup of a method in the topmost |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
51 window and the application. The method name is the callback string |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
52 with \code{'domenu_'} prepended. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
53 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
54 Calling the \code{MenuBar} \code{fixmenudimstate} method sets the |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
55 correct dimming for all menu items based on the current front window. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
56 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
57 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
58 \begin{funcdesc}{Separator}{menu} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
59 Add a separator to the end of a menu. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
60 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
61 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
62 \begin{funcdesc}{SubMenu}{menu, label} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
63 Create a submenu named \var{label} under menu \var{menu}. The menu |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
64 object is returned. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
65 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
66 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
67 \begin{funcdesc}{Window}{parent} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
68 Creates a (modeless) window. \var{Parent} is the application object to |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
69 which the window belongs. The window is not displayed until later. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
70 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
71 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
72 \begin{funcdesc}{DialogWindow}{parent} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
73 Creates a modeless dialog window. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
74 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
75 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
76 \begin{funcdesc}{windowbounds}{width, height} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
77 Return a \code{(left, top, right, bottom)} tuple suitable for creation |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
78 of a window of given width and height. The window will be staggered |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
79 with respect to previous windows, and an attempt is made to keep the |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
80 whole window on-screen. The window will however always be exact the |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
81 size given, so parts may be offscreen. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
82 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
83 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
84 \begin{funcdesc}{setwatchcursor}{} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
85 Set the mouse cursor to a watch. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
86 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
87 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
88 \begin{funcdesc}{setarrowcursor}{} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
89 Set the mouse cursor to an arrow. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
90 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
91 |
| 7866 | 92 \subsection{Application Objects} |
| 93 \label{application-objects} | |
| 94 | |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
95 Application objects have the following methods, among others: |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
96 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
97 \setindexsubitem{(Application method)} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
98 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
99 \begin{funcdesc}{makeusermenus}{} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
100 Override this method if you need menus in your application. Append the |
| 7866 | 101 menus to the attribute \member{menubar}. |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
102 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
103 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
104 \begin{funcdesc}{getabouttext}{} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
105 Override this method to return a text string describing your |
| 7866 | 106 application. Alternatively, override the \method{do_about()} method |
| 107 for more elaborate ``about'' messages. | |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
108 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
109 |
| 7866 | 110 \begin{funcdesc}{mainloop}{\optional{mask\optional{, wait}}} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
111 This routine is the main event loop, call it to set your application |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
112 rolling. \var{Mask} is the mask of events you want to handle, |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
113 \var{wait} is the number of ticks you want to leave to other |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
114 concurrent application (default 0, which is probably not a good |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
115 idea). While raising \code{self} to exit the mainloop is still |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
116 supported it is not recommended, call \code{self._quit} instead. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
117 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
118 The event loop is split into many small parts, each of which can be |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
119 overridden. The default methods take care of dispatching events to |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
120 windows and dialogs, handling drags and resizes, Apple Events, events |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
121 for non-FrameWork windows, etc. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
122 |
| 7866 | 123 In general, all event handlers should return \code{1} if the event is fully |
| 124 handled and \code{0} otherwise (because the front window was not a FrameWork | |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
125 window, for instance). This is needed so that update events and such |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
126 can be passed on to other windows like the Sioux console window. |
| 7866 | 127 Calling \function{MacOS.HandleEvent()} is not allowed within |
| 128 \var{our_dispatch} or its callees, since this may result in an | |
| 129 infinite loop if the code is called through the Python inner-loop | |
| 130 event handler. | |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
131 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
132 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
133 \begin{funcdesc}{asyncevents}{onoff} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
134 Call this method with a nonzero parameter to enable |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
135 asynchronous event handling. This will tell the inner interpreter loop |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
136 to call the application event handler \var{async_dispatch} whenever events |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
137 are available. This will cause FrameWork window updates and the user |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
138 interface to remain working during long computations, but will slow the |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
139 interpreter down and may cause surprising results in non-reentrant code |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
140 (such as FrameWork itself). By default \var{async_dispatch} will immedeately |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
141 call \var{our_dispatch} but you may override this to handle only certain |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
142 events asynchronously. Events you do not handle will be passed to Sioux |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
143 and such. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
144 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
145 The old on/off value is returned. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
146 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
147 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
148 \begin{funcdesc}{_quit}{} |
| 7866 | 149 Terminate the running \method{mainloop()} call at the next convenient |
| 150 moment. | |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
151 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
152 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
153 \begin{funcdesc}{do_char}{c, event} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
154 The user typed character \var{c}. The complete details of the event |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
155 can be found in the \var{event} structure. This method can also be |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
156 provided in a \code{Window} object, which overrides the |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
157 application-wide handler if the window is frontmost. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
158 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
159 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
160 \begin{funcdesc}{do_dialogevent}{event} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
161 Called early in the event loop to handle modeless dialog events. The |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
162 default method simply dispatches the event to the relevant dialog (not |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
163 through the the \code{DialogWindow} object involved). Override if you |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
164 need special handling of dialog events (keyboard shortcuts, etc). |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
165 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
166 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
167 \begin{funcdesc}{idle}{event} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
168 Called by the main event loop when no events are available. The |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
169 null-event is passed (so you can look at mouse position, etc). |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
170 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
171 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
172 \subsection{Window Objects} |
| 7866 | 173 \label{window-objects} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
174 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
175 Window objects have the following methods, among others: |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
176 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
177 \setindexsubitem{(Window method)} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
178 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
179 \begin{funcdesc}{open}{} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
180 Override this method to open a window. Store the MacOS window-id in |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
181 \code{self.wid} and call \code{self.do_postopen} to register the |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
182 window with the parent application. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
183 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
184 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
185 \begin{funcdesc}{close}{} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
186 Override this method to do any special processing on window |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
187 close. Call \code{self.do_postclose} to cleanup the parent state. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
188 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
189 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
190 \begin{funcdesc}{do_postresize}{width, height, macoswindowid} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
191 Called after the window is resized. Override if more needs to be done |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
192 than calling \code{InvalRect}. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
193 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
194 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
195 \begin{funcdesc}{do_contentclick}{local, modifiers, event} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
196 The user clicked in the content part of a window. The arguments are |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
197 the coordinates (window-relative), the key modifiers and the raw |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
198 event. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
199 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
200 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
201 \begin{funcdesc}{do_update}{macoswindowid, event} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
202 An update event for the window was received. Redraw the window. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
203 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
204 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
205 \begin{funcdesc}{do_activate}{activate, event} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
206 The window was activated (\code{activate==1}) or deactivated |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
207 (\code{activate==0}). Handle things like focus highlighting, etc. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
208 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
209 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
210 \subsection{ControlsWindow Object} |
| 7866 | 211 \label{controlswindow-object} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
212 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
213 ControlsWindow objects have the following methods besides those of |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
214 \code{Window} objects: |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
215 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
216 \setindexsubitem{(ControlsWindow method)} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
217 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
218 \begin{funcdesc}{do_controlhit}{window, control, pcode, event} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
219 Part \code{pcode} of control \code{control} was hit by the |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
220 user. Tracking and such has already been taken care of. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
221 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
222 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
223 \subsection{ScrolledWindow Object} |
| 7866 | 224 \label{scrolledwindow-object} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
225 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
226 ScrolledWindow objects are ControlsWindow objects with the following |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
227 extra methods: |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
228 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
229 \setindexsubitem{(ScrolledWindow method)} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
230 |
| 7866 | 231 \begin{funcdesc}{scrollbars}{\optional{wantx\optional{, wanty}}} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
232 Create (or destroy) horizontal and vertical scrollbars. The arguments |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
233 specify which you want (default: both). The scrollbars always have |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
234 minimum \code{0} and maximum \code{32767}. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
235 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
236 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
237 \begin{funcdesc}{getscrollbarvalues}{} |
| 7866 | 238 You must supply this method. It should return a tuple \code{(\var{x}, |
| 239 \var{y})} giving the current position of the scrollbars (between | |
| 240 \code{0} and \code{32767}). You can return \code{None} for either to | |
| 241 indicate the whole document is visible in that direction. | |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
242 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
243 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
244 \begin{funcdesc}{updatescrollbars}{} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
245 Call this method when the document has changed. It will call |
| 7866 | 246 \method{getscrollbarvalues()} and update the scrollbars. |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
247 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
248 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
249 \begin{funcdesc}{scrollbar_callback}{which, what, value} |
| 7866 | 250 Supplied by you and called after user interaction. \var{which} will |
| 251 be \code{'x'} or \code{'y'}, \var{what} will be \code{'-'}, | |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
252 \code{'--'}, \code{'set'}, \code{'++'} or \code{'+'}. For |
| 7866 | 253 \code{'set'}, \var{value} will contain the new scrollbar position. |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
254 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
255 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
256 \begin{funcdesc}{scalebarvalues}{absmin, absmax, curmin, curmax} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
257 Auxiliary method to help you calculate values to return from |
| 7866 | 258 \method{getscrollbarvalues()}. You pass document minimum and maximum value |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
259 and topmost (leftmost) and bottommost (rightmost) visible values and |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
260 it returns the correct number or \code{None}. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
261 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
262 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
263 \begin{funcdesc}{do_activate}{onoff, event} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
264 Takes care of dimming/highlighting scrollbars when a window becomes |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
265 frontmost vv. If you override this method call this one at the end of |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
266 your method. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
267 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
268 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
269 \begin{funcdesc}{do_postresize}{width, height, window} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
270 Moves scrollbars to the correct position. Call this method initially |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
271 if you override it. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
272 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
273 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
274 \begin{funcdesc}{do_controlhit}{window, control, pcode, event} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
275 Handles scrollbar interaction. If you override it call this method |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
276 first, a nonzero return value indicates the hit was in the scrollbars |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
277 and has been handled. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
278 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
279 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
280 \subsection{DialogWindow Objects} |
| 7866 | 281 \label{dialogwindow-objects} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
282 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
283 DialogWindow objects have the following methods besides those of |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
284 \code{Window} objects: |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
285 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
286 \setindexsubitem{(DialogWindow method)} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
287 |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
288 \begin{funcdesc}{open}{resid} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
289 Create the dialog window, from the DLOG resource with id |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
290 \var{resid}. The dialog object is stored in \code{self.wid}. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
291 \end{funcdesc} |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
292 |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7372
diff
changeset
|
293 \begin{funcdesc}{do_itemhit}{item, event} |
|
7372
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
294 Item number \var{item} was hit. You are responsible for redrawing |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
295 toggle buttons, etc. |
|
1e66c4e31d15
Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
296 \end{funcdesc} |
