annotate Doc/mac/libframework.tex @ 13163:a09e8635534d legacy-trunk

Don't try to guess the name of a .def file -- if one is supplied, use it, otherwise just generate an '/export:' option.
author Greg Ward <gward@python.net>
date Thu, 29 Jun 2000 23:09:20 +0000
parents 61224459bb09
children e470a9618ca7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8915
552c6b3aba3d New style section headers.
Fred Drake <fdrake@acm.org>
parents: 8715
diff changeset
1 \section{\module{FrameWork} ---
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
2 Interactive application framework}
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
3
8715
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
4 \declaremodule{standard}{FrameWork}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
5 \platform{Mac}
8715
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
6 \modulesynopsis{Interactive application framework.}
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
7
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
8
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
9 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
10 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
11 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
12 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
13 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
14 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
15 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
16 handling.
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
17
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
18 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
19 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
20 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
21 for more details.
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
22
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
23 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
24
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
25
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
26 \begin{funcdesc}{Application}{}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
27 An object representing the complete application. See below for a
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
28 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
29 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
30 \end{funcdesc}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
31
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
32 \begin{funcdesc}{MenuBar}{}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
33 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
34 by the user.
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
35 \end{funcdesc}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
36
7712
0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents: 7372
diff changeset
37 \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
38 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
39 \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
40 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
41 at the end).
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
42 \end{funcdesc}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
43
7712
0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents: 7372
diff changeset
44 \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
45 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
46 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
47 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
48 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
49 the event record.
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
50
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
51 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
52 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
53 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
54 with \code{'domenu_'} prepended.
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
55
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
56 Calling the \code{MenuBar} \method{fixmenudimstate()} method sets the
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
57 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
58 \end{funcdesc}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
59
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
60 \begin{funcdesc}{Separator}{menu}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
61 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
62 \end{funcdesc}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
63
7712
0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents: 7372
diff changeset
64 \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
65 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
66 object is returned.
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
67 \end{funcdesc}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
68
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
69 \begin{funcdesc}{Window}{parent}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
70 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
71 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
72 \end{funcdesc}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
73
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
74 \begin{funcdesc}{DialogWindow}{parent}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
75 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
76 \end{funcdesc}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
77
7712
0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents: 7372
diff changeset
78 \begin{funcdesc}{windowbounds}{width, height}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
79 Return a \code{(\var{left}, \var{top}, \var{right}, \var{bottom})}
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
80 tuple suitable for creation of a window of given width and height. The
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
81 window will be staggered with respect to previous windows, and an
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
82 attempt is made to keep the whole window on-screen. The window will
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
83 however always be exact the size given, so parts may be offscreen.
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
84 \end{funcdesc}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
85
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
86 \begin{funcdesc}{setwatchcursor}{}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
87 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
88 \end{funcdesc}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
89
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
90 \begin{funcdesc}{setarrowcursor}{}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
91 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
92 \end{funcdesc}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
93
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
94
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
95 \subsection{Application Objects \label{application-objects}}
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
96
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
97 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
98
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
99
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
100 \begin{methoddesc}[Application]{makeusermenus}{}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
101 Override this method if you need menus in your application. Append the
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
102 menus to the attribute \member{menubar}.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
103 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
104
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
105 \begin{methoddesc}[Application]{getabouttext}{}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
106 Override this method to return a text string describing your
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
107 application. Alternatively, override the \method{do_about()} method
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
108 for more elaborate ``about'' messages.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
109 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
110
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
111 \begin{methoddesc}[Application]{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
112 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
113 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
114 \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
115 concurrent application (default 0, which is probably not a good
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
116 idea). While raising \var{self} to exit the mainloop is still
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
117 supported it is not recommended: call \code{self._quit()} instead.
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
118
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
119 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
120 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
121 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
122 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
123
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
124 In general, all event handlers should return \code{1} if the event is fully
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
125 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
126 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
127 can be passed on to other windows like the Sioux console window.
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
128 Calling \function{MacOS.HandleEvent()} is not allowed within
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
129 \var{our_dispatch} or its callees, since this may result in an
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
130 infinite loop if the code is called through the Python inner-loop
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
131 event handler.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
132 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
133
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
134 \begin{methoddesc}[Application]{asyncevents}{onoff}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
135 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
136 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
137 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
138 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
139 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
140 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
141 (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
142 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
143 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
144 and such.
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
145
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
146 The old on/off value is returned.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
147 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
148
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
149 \begin{methoddesc}[Application]{_quit}{}
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
150 Terminate the running \method{mainloop()} call at the next convenient
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
151 moment.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
152 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
153
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
154 \begin{methoddesc}[Application]{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
155 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
156 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
157 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
158 application-wide handler if the window is frontmost.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
159 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
160
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
161 \begin{methoddesc}[Application]{do_dialogevent}{event}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
162 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
163 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
164 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
165 need special handling of dialog events (keyboard shortcuts, etc).
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
166 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
167
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
168 \begin{methoddesc}[Application]{idle}{event}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
169 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
170 null-event is passed (so you can look at mouse position, etc).
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
171 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
172
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
173
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
174 \subsection{Window Objects \label{window-objects}}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
175
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
176 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
177
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
178 \setindexsubitem{(Window method)}
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
179
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
180 \begin{methoddesc}[Window]{open}{}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
181 Override this method to open a window. Store the MacOS window-id in
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
182 \member{self.wid} and call the \method{do_postopen()} method to
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
183 register the window with the parent application.
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
184 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
185
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
186 \begin{methoddesc}[Window]{close}{}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
187 Override this method to do any special processing on window
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
188 close. Call the \method{do_postclose()} method to cleanup the parent
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
189 state.
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
190 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
191
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
192 \begin{methoddesc}[Window]{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
193 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
194 than calling \code{InvalRect}.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
195 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
196
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
197 \begin{methoddesc}[Window]{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
198 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
199 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
200 event.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
201 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
202
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
203 \begin{methoddesc}[Window]{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
204 An update event for the window was received. Redraw the window.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
205 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
206
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
207 \begin{methoddesc}{do_activate}{activate, event}
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
208 The window was activated (\code{\var{activate} == 1}) or deactivated
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
209 (\code{\var{activate} == 0}). Handle things like focus highlighting,
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
210 etc.
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
211 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
212
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
213
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
214 \subsection{ControlsWindow Object \label{controlswindow-object}}
7372
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 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
217 \code{Window} objects:
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
218
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
219
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
220 \begin{methoddesc}[ControlsWindow]{do_controlhit}{window, control,
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
221 pcode, event}
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
222 Part \var{pcode} of control \var{control} was hit by the
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
223 user. Tracking and such has already been taken care of.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
224 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
225
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
226
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
227 \subsection{ScrolledWindow Object \label{scrolledwindow-object}}
7372
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 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
230 extra methods:
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
231
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
232
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
233 \begin{methoddesc}[ScrolledWindow]{scrollbars}{\optional{wantx\optional{,
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
234 wanty}}}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
235 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
236 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
237 minimum \code{0} and maximum \code{32767}.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
238 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
239
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
240 \begin{methoddesc}[ScrolledWindow]{getscrollbarvalues}{}
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
241 You must supply this method. It should return a tuple \code{(\var{x},
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
242 \var{y})} giving the current position of the scrollbars (between
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
243 \code{0} and \code{32767}). You can return \code{None} for either to
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
244 indicate the whole document is visible in that direction.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
245 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
246
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
247 \begin{methoddesc}[ScrolledWindow]{updatescrollbars}{}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
248 Call this method when the document has changed. It will call
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
249 \method{getscrollbarvalues()} and update the scrollbars.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
250 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
251
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
252 \begin{methoddesc}[ScrolledWindow]{scrollbar_callback}{which, what, value}
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
253 Supplied by you and called after user interaction. \var{which} will
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
254 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
255 \code{'--'}, \code{'set'}, \code{'++'} or \code{'+'}. For
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
256 \code{'set'}, \var{value} will contain the new scrollbar position.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
257 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
258
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
259 \begin{methoddesc}[ScrolledWindow]{scalebarvalues}{absmin, absmax,
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
260 curmin, curmax}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
261 Auxiliary method to help you calculate values to return from
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7833
diff changeset
262 \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
263 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
264 it returns the correct number or \code{None}.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
265 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
266
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
267 \begin{methoddesc}[ScrolledWindow]{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
268 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
269 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
270 your method.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
271 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
272
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
273 \begin{methoddesc}[ScrolledWindow]{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
274 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
275 if you override it.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
276 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
277
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
278 \begin{methoddesc}[ScrolledWindow]{do_controlhit}{window, control,
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
279 pcode, event}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
280 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
281 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
282 and has been handled.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
283 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
284
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
285
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
286 \subsection{DialogWindow Objects \label{dialogwindow-objects}}
7372
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 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
289 \code{Window} objects:
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
290
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
291
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
292 \begin{methoddesc}[DialogWindow]{open}{resid}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
293 Create the dialog window, from the DLOG resource with id
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
294 \var{resid}. The dialog object is stored in \member{self.wid}.
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
295 \end{methoddesc}
7372
1e66c4e31d15 Separate Mac user interface modules into separate files, to better support
Fred Drake <fdrake@acm.org>
parents:
diff changeset
296
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
297 \begin{methoddesc}[DialogWindow]{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
298 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
299 toggle buttons, etc.
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
300 \end{methoddesc}