Warning

This module is removed in 3.0.

Application Objects¶

Application objects have the following methods, among others:

Application.makeusermenus()¶

Override this method if you need menus in your application. Append the menus tothe attributemenubar.

Application.getabouttext()¶

Override this method to return a text string describing your application.Alternatively, override thedo_about() method for more elaborate “about”messages.

Application.mainloop([mask[,wait]])¶

This routine is the main event loop, call it to set your application rolling.Mask is the mask of events you want to handle,wait is the number of ticksyou want to leave to other concurrent application (default 0, which is probablynot a good idea). While raisingself to exit the mainloop is still supportedit is not recommended: callself._quit() instead.

The event loop is split into many small parts, each of which can be overridden.The default methods take care of dispatching events to windows and dialogs,handling drags and resizes, Apple Events, events for non-FrameWork windows, etc.

In general, all event handlers should return1 if the event is fully handledand0 otherwise (because the front window was not a FrameWork window, forinstance). This is needed so that update events and such can be passed on toother windows like the Sioux console window. CallingMacOS.HandleEvent()is not allowed withinour_dispatch or its callees, since this may result in aninfinite loop if the code is called through the Python inner-loop event handler.

Application.asyncevents(onoff)¶

Call this method with a nonzero parameter to enable asynchronous event handling.This will tell the inner interpreter loop to call the application event handlerasync_dispatch whenever events are available. This will cause FrameWork windowupdates and the user interface to remain working during long computations, butwill slow the interpreter down and may cause surprising results in non-reentrantcode (such as FrameWork itself). By defaultasync_dispatch will immediatelycallour_dispatch but you may override this to handle only certain eventsasynchronously. Events you do not handle will be passed to Sioux and such.

The old on/off value is returned.

Application._quit()¶

Terminate the runningmainloop() call at the next convenient moment.

Application.do_char(c,event)¶

The user typed characterc. The complete details of the event can be found intheevent structure. This method can also be provided in aWindow object,which overrides the application-wide handler if the window is frontmost.

Application.do_dialogevent(event)¶

Called early in the event loop to handle modeless dialog events. The defaultmethod simply dispatches the event to the relevant dialog (not through theDialogWindow object involved). Override if you need special handling ofdialog events (keyboard shortcuts, etc).

Application.idle(event)¶

Called by the main event loop when no events are available. The null-event ispassed (so you can look at mouse position, etc).

Window Objects¶

Window objects have the following methods, among others:

Window.open()¶

Override this method to open a window. Store the Mac OS window-id inself.wid and call thedo_postopen() method to register the windowwith the parent application.

Window.close()¶

Override this method to do any special processing on window close. Call thedo_postclose() method to cleanup the parent state.

Window.do_postresize(width,height,macoswindowid)¶

Called after the window is resized. Override if more needs to be done thancallingInvalRect.

Window.do_contentclick(local,modifiers,event)¶

The user clicked in the content part of a window. The arguments are thecoordinates (window-relative), the key modifiers and the raw event.

Window.do_update(macoswindowid,event)¶

An update event for the window was received. Redraw the window.

Window.do_activate(activate,event)¶

The window was activated (activate==1) or deactivated (activate==0).Handle things like focus highlighting, etc.

ControlsWindow Object¶

ControlsWindow objects have the following methods besides those ofWindowobjects:

ControlsWindow.do_controlhit(window,control,pcode,event)¶

Partpcode of controlcontrol was hit by the user. Tracking and such hasalready been taken care of.

ScrolledWindow Object¶

ScrolledWindow objects are ControlsWindow objects with the following extramethods:

ScrolledWindow.scrollbars([wantx[,wanty]])¶

Create (or destroy) horizontal and vertical scrollbars. The arguments specifywhich you want (default: both). The scrollbars always have minimum0 andmaximum32767.

ScrolledWindow.getscrollbarvalues()¶

You must supply this method. It should return a tuple(x,y) giving thecurrent position of the scrollbars (between0 and32767). You can returnNone for either to indicate the whole document is visible in that direction.

ScrolledWindow.updatescrollbars()¶

Call this method when the document has changed. It will callgetscrollbarvalues() and update the scrollbars.

ScrolledWindow.scrollbar_callback(which,what,value)¶

Supplied by you and called after user interaction.which will be'x' or'y',what will be'-','--','set','++' or'+'. For'set',value will contain the new scrollbar position.

ScrolledWindow.scalebarvalues(absmin,absmax,curmin,curmax)¶

Auxiliary method to help you calculate values to return fromgetscrollbarvalues(). You pass document minimum and maximum value andtopmost (leftmost) and bottommost (rightmost) visible values and it returns thecorrect number orNone.

ScrolledWindow.do_activate(onoff,event)¶

Takes care of dimming/highlighting scrollbars when a window becomes frontmost.If you override this method, call this one at the end of your method.

ScrolledWindow.do_postresize(width,height,window)¶

Moves scrollbars to the correct position. Call this method initially if youoverride it.

ScrolledWindow.do_controlhit(window,control,pcode,event)¶

Handles scrollbar interaction. If you override it call this method first, anonzero return value indicates the hit was in the scrollbars and has beenhandled.

DialogWindow Objects¶

DialogWindow objects have the following methods besides those ofWindowobjects:

DialogWindow.open(resid)¶

Create the dialog window, from the DLOG resource with idresid. The dialogobject is stored inself.wid.

DialogWindow.do_itemhit(item,event)¶

Item numberitem was hit. You are responsible for redrawing toggle buttons,etc.