Class

Summary

The class supporting application menus and message processing for a Cocoa application.

Package

capi

Superclasses

interface

Initargs

:message-callback

A function or nil .

:application-menu

nil , a menu, or the name of a slot containing a menu in the application interface.

:dock-menu

nil , a menu, or a function designator.

Accessors

application-interface-message-callback
application-interface-application-menu
application-interface-dock-menu

Description

The class cocoa-default-application-interface supports the application menu, application messages and other functionality for a Cocoa application.

All Cocoa applications in LispWorks for Macintosh have an application interface, which is a hidden interface that provides the following:

1. The application menu (the leftmost menu in the menu bar, named after the application). See application-menu below.
2. The menu bar items that are displayed when no other interfaces are on the screen. See menu-bar-items in interface and menu-bar in define-interface.
3. An optional Dock context menu. See dock-menu below.
4. Optional application message processing. See message-callback below.
5. Control over the lifecycle and display-state of the application as a whole.

If you wish to override the defaults, then you should first define a subclass of cocoa-default-application-interface with your changes. Then set a single instance of this subclass as the application interface by calling set-application-interface before any CAPI functions that make the screen object (such as convert-to-screen and display).

Do not call display with a subclass of cocoa-default-application-interface - the application interface does not have a window on the screen and should be created in addition to the visible interfaces in your application.

When non-nil, message-callback should be a function with signature

interface message &rest args

message-callback will be called for various application messages. The interface argument will be the application interface and the message argument will be a keyword. The message argument will be one of the following:

:open-file

This message is invoked when the user double-clicks on a document associated with the application or drags a document into the application icon. The args contain the name of the file to open.

:finished-launching

This message is invoked just after the user has started the application and all other initialization has been done (including any :open-file message if applicable). You can use it to open a default document for example. There are no args .

application-menu controls the application's main menu. If this is nil , then a minimal application menu will be made using the title of the application interface, otherwise it should be a menu containing the usual items or the name of a slot containing such a menu in the application interface. Note that the Quit item in the application-menu needs to call destroy on the interface, rather than call lw:quit .

dock-menu provides a menu for use by the Mac OS X Dock icon. If the value is nil (the default), then the standard menu is used. If dock-menu is a function designator, it is called with the application interface as its argument when the menu is popped up and should return a menu. Otherwise dock-menu should be a menu, which is used directly. The Dock will add the standard items such as Quit to the end of the menu you supply.

interface initargs are interpreted as follows:

• The activate-callback is called when the application is activated or deactivated.
• The create-callback is called when the application starts up.
• The destroy-callback is called when the application shuts down.
• The confirm-destroy-function is called to confirm whether the application should shut down.

All of these callbacks execute in the thread that runs the Cocoa event loop, so they can call CAPI and GP functions.

The application interface also allows you to control aspects of the application. In particular:

• The function destroy will cause the application to shut down.
• The function top-level-interface-display-state will return :hidden if the whole application is hidden and will return :normal otherwise.
• The function (setf top-level-interface-display-state) can be used to perform some operations typically found on the application menu.

The display-state value can one of:

:normal

Show the application and activate it

:restore

Show the application again without activating it

:hidden

Hide

:others-hidden

Hide Others

:all-normal

Show All

Note: cocoa-default-application-interface is implemented only in LispWorks for Macintosh with the Cocoa IDE.

Example

See these files in the examples subdirectory of the LispWorks library:

capi/applications/cocoa-application.lisp

capi/applications/cocoa-application-single-window.lisp

delivery/macos/multiple-window-application.lisp

delivery/macos/single-window-application.lisp

See also

set-application-interface