User's Guide
Reference Manual
Release Notes
PDF
Top

Toolbar
Reference Manual
Version 1.4.1

Expand All
Contract All

Table of Contents

- toolbar
  - Top of manual page
  - start/0
  - version/0
  - update/0
  - quit/0
  - create_tool_file/0
  - add_gs_contribs/0

# toolbar

### MODULE

toolbar

### MODULE SUMMARY

GUI for Starting Tools and User Contributions

### DESCRIPTION

Toolbar makes it easier to use the different Erlang tools - and the user contributions - which are provided. It has a graphical user interface with an icon for each tool. Clicking the icon activates the corresponding tool.

All tools to be included on Toolbar must have a configuration file containing information about the tool, for example its start function and help information location. Configuration files must have the .tool suffix.

When started, Toolbar automatically checks for *.tool files in the current path and adds the corresponding tools. For each ebin directory found in the path, it will also look in a priv directory next to it. This is a feature of the Erlang file structure.

### EXPORTS

start() -> ok | already_started

Creates a window containing tool icons.

version() -> string()

Returns the current version number of Toolbar.

update() -> ok | {error,not_started}

Makes a search for new tool files in the current path and adds the corresponding tools to Toolbar window.

quit() -> ok | {error,not_started}

create_tool_file() -> ok | {error,not_started}

Starts the GUI used for creating and editing tool files.

add_gs_contribs() -> ok | {error,not_started}

Adds the path to the directory where the GS contributions are situated and add the tools found there, if any.