Jack Jansen | ebed45f | 1995-08-14 13:40:05 +0000 | [diff] [blame] | 1 | \section{Built-in Module \sectcode{MacOS}} |
Guido van Rossum | e47da0a | 1997-07-17 16:34:52 +0000 | [diff] [blame] | 2 | \label{module-MacOS} |
Jack Jansen | ebed45f | 1995-08-14 13:40:05 +0000 | [diff] [blame] | 3 | \bimodindex{MacOS} |
| 4 | |
| 5 | \renewcommand{\indexsubitem}{(in module MacOS)} |
| 6 | |
| 7 | This module provides access to MacOS specific functionality in the |
| 8 | python interpreter, such as how the interpreter eventloop functions |
| 9 | and the like. Use with care. |
| 10 | |
| 11 | Note the capitalisation of the module name, this is a historical |
| 12 | artefact. |
| 13 | |
| 14 | \begin{excdesc}{Error} |
| 15 | This exception is raised on MacOS generated errors, either from |
| 16 | functions in this module or from other mac-specific modules like the |
| 17 | toolbox interfaces. The arguments are the integer error code (the |
| 18 | \var{OSErr} value) and a textual description of the error code. |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 19 | Symbolic names for all known error codes are defined in the standard |
| 20 | module \var{macerrors}. |
Jack Jansen | ebed45f | 1995-08-14 13:40:05 +0000 | [diff] [blame] | 21 | \end{excdesc} |
| 22 | |
Guido van Rossum | e229d86 | 1997-08-18 15:14:26 +0000 | [diff] [blame] | 23 | \begin{funcdesc}{SetEventHandler}{handler} |
| 24 | In the inner interpreter loop Python will occasionally check for events, |
| 25 | unless disabled with \var{ScheduleParams}. With this function you |
| 26 | can pass a Python event-handler function that will be called if an event |
| 27 | is available. The event is passed as parameter and the function should return |
| 28 | non-zero if the event has been fully processed, otherwise event processing |
| 29 | continues (by passing the event to the console window package, for instance). |
Jack Jansen | ebed45f | 1995-08-14 13:40:05 +0000 | [diff] [blame] | 30 | |
Guido van Rossum | e229d86 | 1997-08-18 15:14:26 +0000 | [diff] [blame] | 31 | Call SetEventHandler without parameter to clear the event handler. Setting |
| 32 | an eventhandler while one is already set is an error. |
Jack Jansen | ebed45f | 1995-08-14 13:40:05 +0000 | [diff] [blame] | 33 | \end{funcdesc} |
| 34 | |
Fred Drake | 671fe9d | 1997-12-29 18:53:31 +0000 | [diff] [blame] | 35 | \begin{funcdesc}{SchedParams}{\optional{doint, evtmask, besocial, interval, bgyield}} |
Guido van Rossum | e229d86 | 1997-08-18 15:14:26 +0000 | [diff] [blame] | 36 | Influence the interpreter inner loop event handling. \var{Interval} |
| 37 | specifies how often (in seconds, floating point) the interpreter |
| 38 | should enter the event processing code. When true, \var{doint} causes |
| 39 | interrupt (command-dot) checking to be done. \var{Evtmask} tells the |
| 40 | interpreter to do event processing for events in the mask (redraws, |
Fred Drake | 289f97d | 1997-08-22 13:51:31 +0000 | [diff] [blame] | 41 | mouseclicks to switch to other applications, etc). The \var{besocial} |
| 42 | flag gives other processes a chance to run. They are granted minimal |
Guido van Rossum | e229d86 | 1997-08-18 15:14:26 +0000 | [diff] [blame] | 43 | runtime when Python is in the foreground and \var{bgyield} seconds per |
| 44 | \var{interval} when Python runs in the background. |
Jack Jansen | ebed45f | 1995-08-14 13:40:05 +0000 | [diff] [blame] | 45 | |
Guido van Rossum | e229d86 | 1997-08-18 15:14:26 +0000 | [diff] [blame] | 46 | All parameters are optional, and default to the current value. The return |
| 47 | value of this function is a tuple with the old values of these options. |
| 48 | Initial defaults are that all processing is enabled, checking is done every |
| 49 | quarter second and the CPU is given up for a quarter second when in the |
| 50 | background. |
Jack Jansen | ebed45f | 1995-08-14 13:40:05 +0000 | [diff] [blame] | 51 | \end{funcdesc} |
| 52 | |
| 53 | \begin{funcdesc}{HandleEvent}{ev} |
| 54 | Pass the event record \code{ev} back to the python event loop, or |
| 55 | possibly to the handler for the \code{sys.stdout} window (based on the |
| 56 | compiler used to build python). This allows python programs that do |
| 57 | their own event handling to still have some command-period and |
| 58 | window-switching capability. |
Guido van Rossum | e229d86 | 1997-08-18 15:14:26 +0000 | [diff] [blame] | 59 | |
| 60 | If you attempt to call this function from an event handler set through |
| 61 | \code{SetEventHandler} you will get an exception. |
Jack Jansen | ebed45f | 1995-08-14 13:40:05 +0000 | [diff] [blame] | 62 | \end{funcdesc} |
| 63 | |
| 64 | \begin{funcdesc}{GetErrorString}{errno} |
| 65 | Return the textual description of MacOS error code \var{errno}. |
| 66 | \end{funcdesc} |
Guido van Rossum | 66774a9 | 1996-07-21 02:20:58 +0000 | [diff] [blame] | 67 | |
| 68 | \begin{funcdesc}{splash}{resid} |
| 69 | This function will put a splash window |
| 70 | on-screen, with the contents of the DLOG resource specified by |
| 71 | \code{resid}. Calling with a zero argument will remove the splash |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 72 | screen. This function is useful if you want an applet to post a splash screen |
Guido van Rossum | 66774a9 | 1996-07-21 02:20:58 +0000 | [diff] [blame] | 73 | early in initialization without first having to load numerous |
| 74 | extension modules. |
| 75 | \end{funcdesc} |
| 76 | |
Fred Drake | 671fe9d | 1997-12-29 18:53:31 +0000 | [diff] [blame] | 77 | \begin{funcdesc}{DebugStr}{message \optional{, object}} |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 78 | Drop to the low-level debugger with message \var{message}. The |
| 79 | optional \var{object} argument is not used, but can easily be |
| 80 | inspected from the debugger. |
| 81 | |
| 82 | Note that you should use this function with extreme care: if no |
| 83 | low-level debugger like MacsBug is installed this call will crash your |
| 84 | system. It is intended mainly for developers of Python extension |
| 85 | modules. |
| 86 | \end{funcdesc} |
| 87 | |
Fred Drake | 671fe9d | 1997-12-29 18:53:31 +0000 | [diff] [blame] | 88 | \begin{funcdesc}{openrf}{name \optional{, mode}} |
Guido van Rossum | 66774a9 | 1996-07-21 02:20:58 +0000 | [diff] [blame] | 89 | Open the resource fork of a file. Arguments are the same as for the |
| 90 | builtin function \code{open}. The object returned has file-like |
| 91 | semantics, but it is not a python file object, so there may be subtle |
| 92 | differences. |
| 93 | \end{funcdesc} |