File: toolbar.html

package info (click to toggle)
erlang-doc-html 1%3A10.b.1a-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 22,488 kB
  • ctags: 9,933
  • sloc: erlang: 505; ansic: 323; perl: 61; sh: 45; makefile: 39
file content (120 lines) | stat: -rw-r--r-- 3,018 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
  <TITLE>toolbar
</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
  <STYLE TYPE="text/css">
<!--
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
  <IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>toolbar
</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
toolbar
</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
 GUI for Starting Tools and User Contributions

</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P> 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.


<P> 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 <CODE>.tool</CODE> suffix.


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

</DIV>

<H3>EXPORTS</H3>

<P><A NAME="start/0"><STRONG><CODE>start() -&#62; ok | already_started</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY>

<P>Creates a window containing tool icons.

</DIV>

<P><A NAME="version/0"><STRONG><CODE>version() -&#62; string()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY>

<P>Returns the current version number of Toolbar.

</DIV>

<P><A NAME="update/0"><STRONG><CODE>update() -&#62; ok | {error,not_started}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY>

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

</DIV>

<P><A NAME="quit/0"><STRONG><CODE>quit() -&#62; ok | {error,not_started}</CODE></STRONG></A><BR>

<P><A NAME="create_tool_file/0"><STRONG><CODE>create_tool_file() -&#62; ok | {error,not_started}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY>

<P>Starts the GUI used for creating and editing tool files.

</DIV>

<P><A NAME="add_gs_contribs/0"><STRONG><CODE>add_gs_contribs() -&#62; ok | {error,not_started}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY>

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

</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Gunilla Hugosson - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>toolbar 1.2<BR>
Copyright &copy; 1991-2004
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>