Komodo User Guide

Using the Toolbox

Use the Toolbox to store a variety of items for easy access. You can export the contents of the Toolbox as a Komodo Project file and import previously-exported Toolbox items. To open the Toolbox, select View|Toolbox Pane, or click theShow/Hide the Toolbox Pane button to the right of the vertical scroll bar in the Komodo Workspace.

You can access the Toolbox context menu by clicking the arrow button at the top right of the Toolbox Pane. Alternatively, you can right-click in an empty area in the Toolbox (right-clicking on a file or object will display the context menu specific to that file or object). The items on the menu vary depending on the context from which the menu was invoked. For example, the context menu for files has an "Open File" option, while the context menu for folders has a "Add New Folder" option. Many of the options available on the folders context menu are also available on the Toolbox context menu.

The Komodo Toolbox is used to store the following items:

Items remain in the Toolbox from session to session, regardless of the project.

Shortcuts

You can create shortcut links in the Toolbox to directories on disk. To add a shortcut to the Toolbox, right-click in the Toolbox and select Add "Open..." Shortcut. Then select the directory that you want using the Browse for Folder dialog box and click OK. The shortcut will be added to the Toolbox.

The following items are available on the context menu:

  • Export as Project File: use this option to export shortcuts as Komodo project files.
  • Rename: to change the name of a folder, select this option and enter a new name.
  • Remove: to remove the file from the Toolbox, select this option.
  • Open: to open the directory specified in the shortcut, select this option.
  • Properties: to view the properties of a shortcut or to assign a new name to a shortcut, select this option.
Top

Folders

In a similar manner to the Project Manager, you can create virtual folders to organize items within the Toolbox. Folders are metaphorical; that is, they do not correspond to a directory on disk.

Adding Folders

To add a folder to the Toolbox, right-click in the Toolbox and select Add New Folder. Alternatively, click the arrow next to the "Toolbar" text and select Add New Folder from the drop-down list. If a folder is selected in the Toolbox, the new folder will be added beneath the existing folder.

Using Folders in the Toolbox

Folders are used to organize objects in the Toolbox. To add a new item, right-click the folder name and select the type of item you wish to add. To add an existing item, click and drag the item (using the left mouse button) from either the Toolbox or the Project Manager and drop it into the desired folder.

Right-click a folder to access a context menu with the following options:

  • Import from File System: see adding multiple files to a project for a description of the import options.
  • Properties: view and change the name of a virtual folder.
  • Export as Project File: to export folders from the Toolbox as Komodo Project files, select this option.
  • Rename: to change the name of a folder, select this option and enter a new name.
  • Remove: to remove a folder from a project, select this option.
  • Add "Open..." Shortcut: to add a shortcut link to a directory on disk to the Toolbox, select this option and then use the Browse for Folder dialog box to choose a directory.
  • Add New Folder: to add a sub-folder to the selected folder, select this option. You will be prompted to specify a name for the new folder.
  • Add Existing File: to add a file to the selected folder, select this option.
  • Add Existing Remote File: to add files stored on an FTP server to a folder, select this option. In order to access remote servers, you must configure access to the server. See Opening Remote Files for information on accessing files stored on remote FTP servers.
  • Add New Snippet: to add a code snippet to the current folder, select this option. See Snippets for more information.
  • Add New Command: using Komodo's Run Command function, you can create and save command-line interactions. These commands can be stored in folders using the Add Command menu option. This menu option will display the Command Properties dialog, which is described in the Running Commands section of the User Guide.
  • Add Template: to add a template to the current folder, select this option.
  • Add URL: to add a link to a URL in the current folder, select this option.
  • Add New Dialog: to add a GUI Dialog to the current folder, select this option. See Using the GUI Builder for information about building dialogs.
  • Add New WebService: to add a Web service reference to the current folder, select this menu option. See Web Services for more information.
  • Add New Macro: to add a macro to the current folder, select this option. See Macros for more information.
  • Source Control on Contents: a sub-set of Komodo's Source Code Control functions can be performed on the files stored within the selected folder. See Source Code Control for a description of these options.
Top

Files

Adding Files

Files can be added to the Toolbox by any of the following methods:

  • From Windows Explorer: Drag and drop from Windows Explorer to the Toolbox.
  • From the Komodo Editor Pane: Drag and drop from the file tab at the top of the Komodo Editor Pane to the Toolbox.
  • From the Komodo Project Manager Pane: Drag and drop files from the Project Manager Pane to the Toolbox.
  • Toolbox Context Menu: Right-click in the Toolbox area of Komodo, and select the option Add Existing File or Add Existing Remote File. See Opening Remote Files for more information.
  • Toolbox Menu: Click the arrow to the right of the "Toolbox" text label, and select Add Existing File or Add Existing Remote File. See Opening Remote Files for more information.

Using Files in the Toolbox

Double-click a file in the Toolbox to open it in the Editor Pane.

The following items are available on the context menu:

  • Open File: to open the file in the Editor Pane, select this option.
  • Make "Open..." Shortcut: to create a shortcut in the Toolbox to the directory containing this file, select this option.
  • Refresh Status: use this option to refresh the status of the file. See File Setting in the Komodo Preferences for more information.
  • Properties: use this option to view the file's properties and source code control status.
  • Compare File With: use this option to select a file to compare with the current file. The file will open in a separate window, where you can press F8 to jump to the next change, F7 to jump to the previous change, and ESC to close the window.
  • Export as Project File: to export files from the Toolbox as a Komodo Project files, select this option.
  • Remove: use this option to remove the file from the Toolbox.
  • Source Control: access source code control commands from this submenu. See SCC Commands for a description of each command.
Top

Snippets

Adding Snippets

Code Snippets can be added to the Toolbox by any of the following methods:

  • From the Komodo Projects Pane: Drag and drop a snippet from the Projects Pane to the Toolbox.
  • Toolbox Context Menu: Right-click in the Toolbox area of Komodo, and select the option Add New Snippet.
  • Toolbox Menu: Click the arrow to the right of the "Toolbox" text label, and select Add New Snippet.

See Code Snippets for more information about creating snippets.

Using Snippets in the Toolbox

To insert a snippet in the Editor Pane, double-click the snippet.

The following options are available on the context menu:

  • Insert Snippet: To insert the snippet at the cursor position in the current document, select this option.
  • Properties: displays the name and contents of the snippet, and has preferences for snippet insertion. See Code Snippets for more information.
  • Export as Project File: to export snippets from the Toolbox as Komodo Project files, select this option.
  • Rename: is used to change the name of the command.
  • Remove: is used to remove the command from the Toolbox.
Top

Commands

Adding Commands

Commands can be added to the Toolbox by any of the following methods:

  • From the Komodo Projects Pane: Drag and drop a command from the Projects Pane to the Toolbox.
  • Toolbox Context Menu: Right-click in the Toolbox area of Komodo, and select the option Add New Command.
  • Toolbox Menu: Click the arrow to the right of the "Toolbox" text label, and select Add New Command.

See Running Commands for more information about creating commands.

Using Commands in the Toolbox

To run a command, double-click it in the Toolbox.

The following options are available on the context menu:

  • Run: is used to run the selected command.
  • Properties: displays the name and contents of the command, and has a variety of run options. See Running Commands for more information.
  • Export as Project File: to export commands from the Toolbox as Komodo Project files, select this option.
  • Rename: is used to change the name of the command.
  • Remove: is used to remove the command from the Toolbox.
Top

Templates

Adding Templates

Templates can be added to the Toolbox by either of the following methods:

  • Toolbox Context Menu: Right-click in an empty area of the Toolbox, and select the option Add Template.
  • From the Komodo Projects Pane: Drag and drop files from the Projects Pane to the Toolbox.

Using Templates

Double-click on a template to open it in the Editor Pane.

The following options are available on the context menu:

  • Open Template: to open the template in the Editor Pane, select this option.
  • Export as Project File: to export templates from the Toolbox as Komodo Project files, select this option.
  • Rename: is used to change the name of the command.
  • Remove: is used to remove a command from the Toolbox.
Top

URLs

Adding URLs

You can add a URL link to the Toolbox by using the Toolbox context menu, or by dragging and dropping.

To add a URL link to the Toolbox using the context menu:

  1. From the Toolbox context menu, select Add URL. The Create New URL dialog box will open.
  2. In the "link" field, enter a name that you want to appear next to the URL link in the Toolbox.
  3. In the Value field, enter the URL.
  4. Click OK.

To add a URL link to the Toolbox by dragging and dropping:

From a browser address bar or from the Editor Pane, select a URL and drag it with the mouse into the Toolbox. When using this method, ensure that URLs have the prefix "http://".

Using URLs

Double-click a link to open your system's default browser and load the URL.

The following options are available on the context menu:

  • Open URL in Browser: to open the linked URL in the default browser, select this option.
  • Properties: to view the properties of a URL link or to assign a new name to a URL link, select this option.
  • Export as Project File: to export URLs as Komodo Project files, select this option.
  • Rename: change the name of the URL.
  • Remove: remove the URL from the Toolbox.
Top

Dialogs

Adding Dialogs

Dialogs can be added to the Toolbox by any of the following methods:

  • From the Komodo Project Manager Pane: Drag and drop a dialog project from the Projects Pane to the Toolbox.
  • Toolbox Context Menu: Right-click in the Toolbox area of Komodo, and select the option Add New Dialog.
  • Toolbox Menu: Click the arrow to the right of the "Toolbox" text label, and select Add New Dialog.

See Using the GUI Builder for more information about creating dialogs.

Using Dialogs in the Toolbox

Dialog Project Files

Double-click a dialog project file to load it in the GUI Builder.

The following options are also available on the context menu:

  • Edit Dialog: to open a dialog in the GUI Builder for editing, select this option.
  • Test: will generate a graphical model of the dialog.
  • Refresh Status: use this option to refresh the status of the file. See File Setting in the Komodo Preferences for more information.
  • Properties: displays the name and contents of the project file and a summary of its source control status.
  • Remove: is used to remove the dialog from the Toolbox.
  • Source Control: access source code control commands for the dialog project file from from this submenu. See SCC Commands for a description of each command.
  • Source Control on Contents: access source code control commands for the files contained in the dialog project file. See SCC Commands for a description of each command.

Dialog Files

Double-click a dialog file in the Toolbox to open it in the Editor Pane. Note that you should not edit the dialog file with the "_ui.lang" name, as your changes will be overwritten if you edit the dialog.

  • Open File: To open a dialog file in the Editor Pane, select this option.
  • Refresh Status: use this option to refresh the status of the file. See File Setting in the Komodo Preferences for more information.
  • Properties: use this option to view the file's properties and source code control status.
  • Remove: use this option to remove the file from the Toolbox.
  • Source Control: access source code control commands from this submenu. See SCC Commands for a description of each command.
Top

Web Services

Adding Web Services

Web Services can be added to the Toolbox by any of the following methods:

  • Drag and Drop: drag and drop a WSDL URL from a browser address bar or editor onto the Toolbox or onto a folder in the Toolbox or Project.
  • From the Komodo Project Manager Pane: Drag and drop a Web service from the Projects Pane to the Toolbox.
  • Toolbox Context Menu: Right-click in the Toolbox area of Komodo, and select the option Add New WebService.
  • Toolbox Menu: Click the arrow to the right of the "Toolbox" text label, and select Add New WebService.

See Web Services for more information.

Using Web Services in the Toolbox

To insert a web service into the current document, double-click it in the Toolbox.

The following options are available on the context menu:

  • View WSDL: use this option to load the WSDL XML file in the Komodo Editor Pane.
  • Edit Service: use this option to edit the bookmark. See Adding Web Service Bookmarks for a description of the fields.
  • Generate Proxy: use this option to generate a Perl module from the WSDL. This is only an option when using Web services within Perl programs.
  • Service Help: use this option to display the relevant Web Services Library page in the Komodo User Guide.
  • Remove: select this item to remove the Web service bookmark from the project or the Toolbox. The bookmark will still be available in the Web Services Bookmark Manager dialog (Tools | Web Services | Manage Bookmarks). To permanently delete the bookmark, use the Web Services Bookmark Manager dialog, as described below.
Top

Macros

Adding Macros

Macros can be added to the Toolbox by any of the following methods:

  • From the Komodo Project Manager Pane: Drag and drop a macro from the Project Manager Pane to the Toolbox.
  • Toolbox Context Menu: Right-click in the Toolbox area of Komodo, and select the option Add New Macro. You will be prompted to enter the location of an existing macro file.
  • Toolbox Menu: Click the arrow to the right of the "Toolbox" text label, and select Add New Macro. You will be prompted to enter the location of an existing macro file.
  • Macro Drop-Down Menu: After recording a macro, use the Tools | Macros | Save to Toolbox command to save the macro to the Toolbox.

See Macros for more information.

Using Macros in the Toolbox

Double-click a macro in the Toolbox to execute it. Alternatively, right-click the macro and select Execute Macro from the context menu.

The following options are also available on the context menu:

  • Edit Macro: will open the macro in the Editor Pane. Note that this version of Komodo does not include an API for macro programming.
  • Properties: is used to view the name and file name of the macro, and to configure Key Bindings.
  • Rename: use this option to change the name of the macro.
  • Remove: use this option to remove the macro from the Toolbox. Note that the macro file will not be deleted.
Top

Exporting and Importing

Exporting the Toolbox

Use the Toolbox context menu to export the Toolbox as a Komodo Project file and to import previously-exported Toolbox items.

To export the Toolbox as a project (.kpf) file:

  1. From the Toolbox context menu, select Export Toolbox.
  2. In the Export Toolbox To dialog box, choose the destination directory and enter a filename.
  3. Click Save.

Importing to the Toolbox

To import a previously-exported Toolbox item:

  1. From the Toolbox context menu, select Import into Toolbox.
  2. In the Select File dialog box, select the project file containing the item(s) that you want to import.
  3. Click Open.
Top