~ubuntu-branches/ubuntu/wily/tora/wily-proposed

« back to all changes in this revision

Viewing changes to doc/help/api/toTool.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Meskes
  • Date: 2009-04-07 13:16:05 UTC
  • mfrom: (1.2.7 upstream) (3.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20090407131605-u422yigfv7jgg0l0
Tags: 2.0.0-3
* Cleaned up packaging a little bit.
* Added homepage information to control file.
* Bumped Standards-Version to 3.8.1.
* Released to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<HTML>
2
 
<HEAD>
3
 
<TITLE>class toTool</TITLE>
4
 
 
5
 
<META NAME="Generator" CONTENT="KDOC ">
6
 
</HEAD>
7
 
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
8
 
<TABLE WIDTH="100%" BORDER="0">
9
 
<TR>
10
 
<TD>
11
 
        <TABLE BORDER="0">
12
 
                <TR><TD valign="top" align="left" cellspacing="10">
13
 
                <h1>class toTool</h1>
14
 
                </TD>
15
 
                <TD valign="top" align="right" colspan="1">
16
 
 Abstract baseclass for tools. <small><A HREF="#longdesc">More...</A></small></TD></TR>
17
 
        </TABLE>
18
 
        <HR>
19
 
        <TABLE BORDER="0">
20
 
                <TR><TH colspan="2">Contains pure virtuals</TH></TR><TR><TH>Definition</TH><TD><code>#include &lt;<A HREF="totool_h.html">totool.h</A>&gt;</code></TD></TR>
21
 
<TR><TH>Inherits</TH><TD><A HREF="/usr/lib/qt3/doc/html/qobject.html">QObject</A> <small>(qt)</small> <small>[public ]</small></TD></TR>
22
 
<TR><TH>Inherited by</TH><TD><A HREF="toHelpTool.html">toHelpTool</A></TD></TR>
23
 
<TR><TH><A HREF="full-list-toTool.html">List of all Methods</A></TH></TR>
24
 
        </TABLE>
25
 
        </TD>
26
 
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
27
 
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
28
 
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
29
 
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
30
 
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
31
 
</TABLE></TD></TR></TABLE>
32
 
<h4>Public Methods</h4><ul><LI><A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &nbsp;<b><A HREF="#ref9">name</A></b> ()  const
33
 
</LI>
34
 
<LI><A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &nbsp;<b><A HREF="#ref10">key</A></b> ()  const
35
 
</LI>
36
 
<LI>int &nbsp;<b><A HREF="#ref11">priority</A></b> ()  const
37
 
</LI>
38
 
<LI>&nbsp;<b><A HREF="#ref12">~toTool</A></b> () 
39
 
</LI>
40
 
<LI>&nbsp;<b><A HREF="#ref13">toTool</A></b> (int priority,const char *name) 
41
 
</LI>
42
 
<LI>virtual  const <A HREF="/usr/lib/qt3/doc/html/qpixmap.html">QPixmap</A> *&nbsp;<b><A HREF="#ref14">toolbarImage</A></b> () 
43
 
</LI>
44
 
<LI>virtual  const char *&nbsp;<b><A HREF="#ref15">menuItem</A></b> () 
45
 
</LI>
46
 
<LI>virtual  const char *&nbsp;<b><A HREF="#ref16">toolbarTip</A></b> () 
47
 
</LI>
48
 
<LI>virtual  bool &nbsp;<b><A HREF="#ref17">canHandle</A></b> (<A HREF="toConnection.html">toConnection</A> &conn) 
49
 
</LI>
50
 
<LI>virtual  void &nbsp;<b><A HREF="#ref18">customSetup</A></b> (int toolid) 
51
 
</LI>
52
 
<LI>virtual  <A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *&nbsp;<b><i><A HREF="#ref19">toolWindow</A></i></b> (<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent,<A HREF="toConnection.html">toConnection</A> &connection) 
53
 
</LI>
54
 
<LI>virtual  <A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *&nbsp;<b><A HREF="#ref20">configurationTab</A></b> (<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent) 
55
 
</LI>
56
 
<LI>virtual  void &nbsp;<b><A HREF="#ref21">about</A></b> (<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent) 
57
 
</LI>
58
 
<LI>virtual  bool &nbsp;<b><A HREF="#ref22">hasAbout</A></b> (void) 
59
 
</LI>
60
 
<LI>const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &&nbsp;<b><A HREF="#ref29">config</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &def) 
61
 
</LI>
62
 
<LI>void &nbsp;<b><A HREF="#ref30">setConfig</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag,const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &value) 
63
 
</LI>
64
 
<LI>void &nbsp;<b><A HREF="#ref31">eraseConfig</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag) 
65
 
</LI>
66
 
</ul><h4>Public Slots</h4><ul><LI>void &nbsp;<b><A HREF="#ref34">createWindow</A></b> (void) 
67
 
</LI>
68
 
</ul><h4>Public Static Methods</h4><ul><LI>static  std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="toTool.html">toTool</A> *> &&nbsp;<b><A HREF="#ref23">tools</A></b> (void) 
69
 
</LI>
70
 
<LI>static  <A HREF="toTool.html">toTool</A> *&nbsp;<b><A HREF="#ref24">tool</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &key) 
71
 
</LI>
72
 
<LI>static  void &nbsp;<b><A HREF="#ref25">saveConfig</A></b> (void) 
73
 
</LI>
74
 
<LI>static  const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &&nbsp;<b><A HREF="#ref26">globalConfig</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &def) 
75
 
</LI>
76
 
<LI>static  void &nbsp;<b><A HREF="#ref27">globalSetConfig</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag,const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &value) 
77
 
</LI>
78
 
<LI>static  void &nbsp;<b><A HREF="#ref28">globalEraseConfig</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag) 
79
 
</LI>
80
 
<LI>static  void &nbsp;<b><A HREF="#ref32">loadMap</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &filename,std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> &map) 
81
 
</LI>
82
 
<LI>static  bool &nbsp;<b><A HREF="#ref33">saveMap</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &filename,std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> &map) 
83
 
</LI>
84
 
</ul><h4>Protected Methods</h4><ul><LI>virtual  const char **&nbsp;<b><A HREF="#ref8">pictureXPM</A></b> (void) 
85
 
</LI>
86
 
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
87
 
 Abstract baseclass for tools.
88
 
</p>
89
 
<p> This class is the baseclass of all classes defining tools. It
90
 
 contains functions for defining the priority and name of the tool,
91
 
 as well as virtual functions to define it's place in the user
92
 
 interface. Further it contains methods to access configuration
93
 
 settings.
94
 
</p>
95
 
<p> To use this class you create a child which is then instantiated once
96
 
 which inserts that tool in the global tool map (See <A HREF="toTool.html#tools">tools</A>). You
97
 
 should never delete a tool unless on exit. Usually tools are instantiated
98
 
 statically in the global scope.
99
 
 </p>
100
 
<A NAME="pictureXPM"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> const char **&nbsp;<strong>pictureXPM</strong> (void)
101
 
<br></td><td align="right"><h3><strong>pictureXPM</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
102
 
 Should return the xpm used to create the <A HREF="toTool.html#ButtonPicture">ButtonPicture</A>.
103
 
   </p>
104
 
<A NAME="name"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &nbsp;<strong>name</strong> ()
105
 
<br></td><td align="right"><h3><strong>name</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
106
 
 Get the name.
107
 
</p>
108
 
<p></p>
109
 
<p><b>Returns</b>: Name of tool.
110
 
   </p>
111
 
<A NAME="key"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &nbsp;<strong>key</strong> ()
112
 
<br></td><td align="right"><h3><strong>key</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
113
 
 Get the name.
114
 
</p>
115
 
<p></p>
116
 
<p><b>Returns</b>: Name of tool.
117
 
   </p>
118
 
<A NAME="priority"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int &nbsp;<strong>priority</strong> ()
119
 
<br></td><td align="right"><h3><strong>priority</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
120
 
 Get the priority.
121
 
</p>
122
 
<p></p>
123
 
<p><b>Returns</b>: Priority of tool.
124
 
   </p>
125
 
<A NAME="~toTool"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>&nbsp;<strong>~toTool</strong> ()
126
 
<br></td><td align="right"><h3><strong>~toTool</strong></h3></td></tr></table><p></p><p>
127
 
 This should never be called, but if it is. Erases the tool from the list of
128
 
 available tools. WARNING: It will not remove any of it's open tools.
129
 
   </p>
130
 
<A NAME="toTool"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>&nbsp;<strong>toTool</strong> (int priority,const char *name)
131
 
<br></td><td align="right"><h3><strong>toTool</strong></h3></td></tr></table><p></p><p>
132
 
 Create a tool. Remember that usually the main window is not created here.
133
 
</p>
134
 
<p></p>
135
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
136
 
<TR><TD align="left" valign="top"><i>priority</i></TD><TD align="left" valign="top">Priority of the created tool.
137
 
</TD></TR>
138
 
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">Name of tool.
139
 
   </TD></TR>
140
 
</TABLE></P>
141
 
<A NAME="toolbarImage"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> const <A HREF="/usr/lib/qt3/doc/html/qpixmap.html">QPixmap</A> *&nbsp;<strong>toolbarImage</strong> ()
142
 
<br></td><td align="right"><h3><strong>toolbarImage</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
143
 
 Get the image to display in the toolbar.
144
 
</p>
145
 
<p></p>
146
 
<p><b>Returns</b>: Pointer to image in toolbar or NULL if no image should be displayed.
147
 
   </p>
148
 
<A NAME="menuItem"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> const char *&nbsp;<strong>menuItem</strong> ()
149
 
<br></td><td align="right"><h3><strong>menuItem</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
150
 
 Get the name of the menuitem to be displayed in the menu.
151
 
</p>
152
 
<p></p>
153
 
<p><b>Returns</b>: A string containing the name of the menuentry or NULL if no menuentry should
154
 
         be created.
155
 
   </p>
156
 
<A NAME="toolbarTip"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td> const char *&nbsp;<strong>toolbarTip</strong> ()
157
 
<br></td><td align="right"><h3><strong>toolbarTip</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
158
 
 Get toolbar tip of the toolbar button. Defaults to same as <A HREF="toTool.html#menuItem">menuItem</A>.
159
 
</p>
160
 
<p></p>
161
 
<p><b>Returns</b>: Toolbar tip string.
162
 
   </p>
163
 
<A NAME="canHandle"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>canHandle</strong> (<A HREF="toConnection.html">toConnection</A> &conn)
164
 
<br></td><td align="right"><h3><strong>canHandle</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p> Check if the tool can handle a specific connection. Default is to only handle
165
 
 connections from the provider Oracle.
166
 
</p>
167
 
<p><b>Returns</b>: True if connection can be handled.
168
 
   </p>
169
 
<A NAME="customSetup"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>customSetup</strong> (int toolid)
170
 
<br></td><td align="right"><h3><strong>customSetup</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
171
 
 This function is called as a last step after the main widget is created. It could
172
 
 be used to insert the tool pretty much anywhere in the user interface if the toolmenu,
173
 
 toolbar is not sufficient.
174
 
</p>
175
 
<p></p>
176
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
177
 
<TR><TD align="left" valign="top"><i>toolid</i></TD><TD align="left" valign="top">The tool menu id that should be used if it inserts a custom menu entry.
178
 
   </TD></TR>
179
 
</TABLE></P>
180
 
<A NAME="toolWindow"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *&nbsp;<i><strong>toolWindow</strong></i> (<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent,<A HREF="toConnection.html">toConnection</A> &connection)
181
 
<br></td><td align="right"><h3><i><strong>toolWindow</strong></i></h3></td></tr></table><p> <small>[pure virtual]</small></p><p>
182
 
 Create a new tool window.
183
 
</p>
184
 
<p></p>
185
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
186
 
<TR><TD align="left" valign="top"><i>parent</i></TD><TD align="left" valign="top">Parent window, which is the worksheet of the main window.
187
 
</TD></TR>
188
 
<TR><TD align="left" valign="top"><i>connection</i></TD><TD align="left" valign="top">The database connection that this tool should operate on.
189
 
   </TD></TR>
190
 
</TABLE></P>
191
 
<A NAME="configurationTab"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *&nbsp;<strong>configurationTab</strong> (<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent)
192
 
<br></td><td align="right"><h3><strong>configurationTab</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
193
 
 Create and return configuration tab for this tool. The returned widget should also
194
 
 be a childclass of <A HREF="toSettingTab.html">toSettingTab</A>.
195
 
</p>
196
 
<p></p>
197
 
<p><b>Returns</b>: A pointer to the widget containing the setup tab for this tool or NULL of
198
 
 no settings are available.
199
 
   </p>
200
 
<A NAME="about"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>about</strong> (<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent)
201
 
<br></td><td align="right"><h3><strong>about</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p> Display an about dialog for this tool.
202
 
</p>
203
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
204
 
<TR><TD align="left" valign="top"><i>parent</i></TD><TD align="left" valign="top">The parent widget of the about dialog.
205
 
   </TD></TR>
206
 
</TABLE></P>
207
 
<A NAME="hasAbout"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>hasAbout</strong> (void)
208
 
<br></td><td align="right"><h3><strong>hasAbout</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p> Indicate whether or not this tool has an about dialog.
209
 
   </p>
210
 
<A NAME="tools"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td> std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="toTool.html">toTool</A> *> &&nbsp;<strong>tools</strong> (void)
211
 
<br></td><td align="right"><h3><strong>tools</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
212
 
 Get access to the map of tools. Don't modify it. Observe that the index string is not
213
 
 the name of the tool but an internal key used to get tools sorted in the correct
214
 
 priority order.
215
 
</p>
216
 
<p></p>
217
 
<p><b>Returns</b>: A reference to the tool map.
218
 
   </p>
219
 
<p><b>See also</b>: Tools</p>
220
 
<A NAME="tool"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="toTool.html">toTool</A> *&nbsp;<strong>tool</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &key)
221
 
<br></td><td align="right"><h3><strong>tool</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
222
 
 Get a pointer to the tool with a specified key.
223
 
</p>
224
 
<p></p>
225
 
<p><b>Returns</b>: A pointer to the tool or NULL if tool doesn't exist.
226
 
   </p>
227
 
<p><b>See also</b>: Tools</p>
228
 
<A NAME="saveConfig"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>saveConfig</strong> (void)
229
 
<br></td><td align="right"><h3><strong>saveConfig</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
230
 
 Save configuration to file.
231
 
   </p>
232
 
<A NAME="globalConfig"></A><A NAME="ref26"></A><table width="100%"><tr bgcolor="#eeeeee"><td> const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &&nbsp;<strong>globalConfig</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &def)
233
 
<br></td><td align="right"><h3><strong>globalConfig</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
234
 
 Get value of a setting.
235
 
</p>
236
 
<p> Setting names are hierachical separated by ':' instead of '/' usually used
237
 
 in filenames. As an example all settings for the tool 'Example' would be
238
 
 under the 'Example:{settingname}' name.
239
 
</p>
240
 
<p></p>
241
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
242
 
<TR><TD align="left" valign="top"><i>tag</i></TD><TD align="left" valign="top">The name of the configuration setting.
243
 
</TD></TR>
244
 
<TR><TD align="left" valign="top"><i>def</i></TD><TD align="left" valign="top">Default value of the setting, if it is not available.
245
 
   </TD></TR>
246
 
</TABLE></P>
247
 
<A NAME="globalSetConfig"></A><A NAME="ref27"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>globalSetConfig</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag,const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &value)
248
 
<br></td><td align="right"><h3><strong>globalSetConfig</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
249
 
 Change a setting. Depending on the implementation this can change the
250
 
 contents on disk or not.
251
 
</p>
252
 
<p> Setting names are hierachical separated by ':' instead of '/' usually used
253
 
 in filenames. As an example all settings for the tool 'Example' would be
254
 
 under the 'Example:{settingname}' name.
255
 
</p>
256
 
<p></p>
257
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
258
 
<TR><TD align="left" valign="top"><i>tag</i></TD><TD align="left" valign="top">The name of the configuration setting.
259
 
</TD></TR>
260
 
<TR><TD align="left" valign="top"><i>def</i></TD><TD align="left" valign="top">Contents of this setting.
261
 
   </TD></TR>
262
 
</TABLE></P>
263
 
<A NAME="globalEraseConfig"></A><A NAME="ref28"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>globalEraseConfig</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag)
264
 
<br></td><td align="right"><h3><strong>globalEraseConfig</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
265
 
 Remove a setting. Can be usefull for removing sensetive information.
266
 
</p>
267
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
268
 
<TR><TD align="left" valign="top"><i>tag</i></TD><TD align="left" valign="top">The name of the configuration setting to remove.
269
 
   </TD></TR>
270
 
</TABLE></P>
271
 
<A NAME="config"></A><A NAME="ref29"></A><table width="100%"><tr bgcolor="#eeeeee"><td>const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &&nbsp;<strong>config</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &def)
272
 
<br></td><td align="right"><h3><strong>config</strong></h3></td></tr></table><p></p><p>
273
 
 Get tool specific settings.
274
 
</p>
275
 
<p> Setting names are hierachical separated by ':' instead of '/' usually used
276
 
 in filenames. As an example all settings for the tool 'Example' would be
277
 
 under the 'Example:{settingname}' name.
278
 
</p>
279
 
<p></p>
280
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
281
 
<TR><TD align="left" valign="top"><i>tag</i></TD><TD align="left" valign="top">The name of the configuration setting.
282
 
</TD></TR>
283
 
<TR><TD align="left" valign="top"><i>def</i></TD><TD align="left" valign="top">Contents of this setting.
284
 
   </TD></TR>
285
 
</TABLE></P>
286
 
<A NAME="setConfig"></A><A NAME="ref30"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void &nbsp;<strong>setConfig</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag,const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &value)
287
 
<br></td><td align="right"><h3><strong>setConfig</strong></h3></td></tr></table><p></p><p>
288
 
 Change toolspecific setting. Depending on the implementation this can change the
289
 
 contents on disk or not.
290
 
</p>
291
 
<p> Setting names are hierachical separated by ':' instead of '/' usually used
292
 
 in filenames. As an example all settings for the tool 'Example' would be
293
 
 under the 'Example:{settingname}' name.
294
 
</p>
295
 
<p></p>
296
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
297
 
<TR><TD align="left" valign="top"><i>tag</i></TD><TD align="left" valign="top">The name of the configuration setting.
298
 
</TD></TR>
299
 
<TR><TD align="left" valign="top"><i>def</i></TD><TD align="left" valign="top">Default value of the setting, if it is not available.
300
 
   </TD></TR>
301
 
</TABLE></P>
302
 
<A NAME="eraseConfig"></A><A NAME="ref31"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void &nbsp;<strong>eraseConfig</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag)
303
 
<br></td><td align="right"><h3><strong>eraseConfig</strong></h3></td></tr></table><p></p><p>
304
 
 Remove a toolspecific setting. Can be usefull for removing sensetive information.
305
 
</p>
306
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
307
 
<TR><TD align="left" valign="top"><i>tag</i></TD><TD align="left" valign="top">The name of the configuration setting to remove.
308
 
   </TD></TR>
309
 
</TABLE></P>
310
 
<A NAME="loadMap"></A><A NAME="ref32"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>loadMap</strong> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &filename,std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> &map)
311
 
<br></td><td align="right"><h3><strong>loadMap</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
312
 
 Load a string to string map from file saved by the <A HREF="toTool.html#saveMap">saveMap</A> function.
313
 
</p>
314
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
315
 
<TR><TD align="left" valign="top"><i>filename</i></TD><TD align="left" valign="top">Filename to load
316
 
</TD></TR>
317
 
<TR><TD align="left" valign="top"><i>map</i></TD><TD align="left" valign="top">Reference to the map to fill with the new values.
318
 
   </TD></TR>
319
 
</TABLE></P>
320
 
<A NAME="saveMap"></A><A NAME="ref33"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>saveMap</strong> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &filename,std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> &map)
321
 
<br></td><td align="right"><h3><strong>saveMap</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
322
 
 Save a string to string map to file.
323
 
</p>
324
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
325
 
<TR><TD align="left" valign="top"><i>filename</i></TD><TD align="left" valign="top">Filename to load
326
 
</TD></TR>
327
 
<TR><TD align="left" valign="top"><i>map</i></TD><TD align="left" valign="top">Reference to the map to fill with the new values.
328
 
   </TD></TR>
329
 
</TABLE></P>
330
 
<p><b>See also</b>: loadMap</p>
331
 
<A NAME="createWindow"></A><A NAME="ref34"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void &nbsp;<strong>createWindow</strong> (void)
332
 
<br></td><td align="right"><h3><strong>createWindow</strong></h3></td></tr></table><p> <small>[slot]</small></p><p>
333
 
 Create a window of the current tool. This function sets up a toolwindow for
334
 
 this tool. It calls the <A HREF="toTool.html#toolWindow">toolWindow</A> function to get widget and sets it
335
 
 up properly.
336
 
   </p>
337
 
<HR>
338
 
        <table>
339
 
        <tr><td><small>Generated by: nneul on skyhawk on Wed Feb 23 19:49:58 2005, using kdoc 2.0a54.</small></td></tr>
340
 
        </table>
341
 
</BODY>
342
 
</HTML>