Called when the plug-in to which the handler is attached is loaded.

You typically use this handler to create any interface items you are adding to Xcode (such as menus or menu items) and to create any scripts to handle actions involving those interface items.

Syntax

Parameters

reference

a reference to the object whose plugin loaded handler is called

Examples

This example describes how to create a plug-in application and use it to add a menu and a simple menu item to Xcode.

To create an AppleScript plug-in project in Xcode, you follow these steps:

1. Choose File > New Project

2. In the New Project Assistant window, scroll down to the section for Standard Apple Plug-ins.

3. Select AppleScript Xcode Plugin

To hook up the plugin handler for the application, you follow these steps:

1. Select the project in the Groups & Files list in Xcode. The project’s files should then be visible in the detail view.

2. Double-click the nib file to open it in Interface Builder.

3. In Interface Builder, select “File’s Owner” in the nib window.

4. Open an Info window (type Command-Shift-I or choose Tools > Show Info).

5. Display the AppleScript pane (type Command-7, or use the pop-up menu).

6. Open the Plugin group and select the plugin loaded handler.

7. Select the script file below, then click the Edit Script button. That will take you back to Xcode, with an open script file containing an empty plugin loaded handler.

Listing 10-1 provides an example of code you might put in your plugin loaded handler. This example adds a “Plug-ins” menu to Xcode and adds a “Display Dialog” menu item to the menu. It also defines a script and attaches the script to the menu item. The script displays a dialog.

Remember that after you build your plug-in, you place it in the one of the locations described in plugin, so that it will be loaded the next time Xcode is launched.

Listing 10-1  A sample plugin loaded handler

on plugin loaded theBundle

    -- Make a new script

    script pluginScript

        property someVariable : "Display Dialog"

        on choose menu item theObject

            display dialog someVariable

        end choose menu item

    end script

    -- Make a new plugin menu

    set pluginMenu to make new menu at end of menus of main menu  with properties  {title:"Plug-ins", name:"plugins"}

    -- Make a new Display Dialog menu item in the plugin menu

    set pluginItem to make new menu item at beginning of menu items  of pluginMenu  with properties {title:"Display Dialog", name:"display  dialog"}

    -- Set the script of the new menu item

    set script of pluginItem to pluginScript

end plugin loaded

Version Notes

The plugin loaded event handler was added in AppleScript Studio version 1.3.