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

« back to all changes in this revision

Viewing changes to help/api/toTemplateProvider.html

  • Committer: Bazaar Package Importer
  • Author(s): Albin Tonnerre
  • Date: 2007-05-29 13:13:36 UTC
  • mfrom: (1.2.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070529131336-85ygaddivvmkd3xc
Tags: 1.3.21pre22-1ubuntu1
* Merge from Debian unstable. Remaining Ubuntu changes:
  - debian/rules: call dh_iconcache
  - Remove g++ build dependency
* Modify Maintainer value to match Debian-Maintainer-Field Spec

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<HTML>
2
 
<HEAD>
3
 
<TITLE>class toTemplateProvider</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 toTemplateProvider</h1>
14
 
                </TD>
15
 
                <TD valign="top" align="right" colspan="1">
16
 
 This is the base class of a provider of template items. <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="totemplate_h.html">totemplate.h</A>&gt;</code></TD></TR>
21
 
<TR><TH><A HREF="full-list-toTemplateProvider.html">List of all Methods</A></TH></TR>
22
 
        </TABLE>
23
 
        </TD>
24
 
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
25
 
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
26
 
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
27
 
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
28
 
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
29
 
</TABLE></TD></TR></TABLE>
30
 
<h4>Public Methods</h4><ul><LI>&nbsp;<b><A HREF="#ref6">toTemplateProvider</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &name) 
31
 
</LI>
32
 
<LI>virtual  &nbsp;<b><A HREF="#ref7">~toTemplateProvider</A></b> () 
33
 
</LI>
34
 
<LI>const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &nbsp;<b><A HREF="#ref8">name</A></b> () 
35
 
</LI>
36
 
<LI>virtual  void &nbsp;<b><i><A HREF="#ref9">insertItems</A></i></b> (<A HREF="/usr/lib/qt3/doc/html/qlistview.html">QListView</A> *parent,<A HREF="/usr/lib/qt3/doc/html/qtoolbar.html">QToolBar</A> *toolbar) 
37
 
</LI>
38
 
<LI>virtual  void &nbsp;<b><A HREF="#ref10">exportData</A></b> (std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> &data,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &prefix) 
39
 
</LI>
40
 
<LI>virtual  void &nbsp;<b><A HREF="#ref12">importData</A></b> (std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> &data,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &prefix) 
41
 
</LI>
42
 
</ul><h4>Public Static Methods</h4><ul><LI>static  void &nbsp;<b><A HREF="#ref11">exportAllData</A></b> (std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> &data,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &prefix) 
43
 
</LI>
44
 
<LI>static  void &nbsp;<b><A HREF="#ref13">importAllData</A></b> (std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> &data,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &prefix) 
45
 
</LI>
46
 
<LI>static  void &nbsp;<b><A HREF="#ref14">setShown</A></b> (bool shown) 
47
 
</LI>
48
 
<LI>static  void &nbsp;<b><A HREF="#ref15">setToolKey</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &key) 
49
 
</LI>
50
 
</ul><h4>Public Members</h4><ul><LI>friend class <b><A HREF="#ref16">toTemplate</A></b></LI>
51
 
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
52
 
 This is the base class of a provider of template items. Usually it is created with
53
 
 a static object just like the tools. It can also be assumed that a maximum of one
54
 
 template window will be opened.
55
 
 </p>
56
 
<A NAME="toTemplateProvider"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>&nbsp;<strong>toTemplateProvider</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &name)
57
 
<br></td><td align="right"><h3><strong>toTemplateProvider</strong></h3></td></tr></table><p></p><p> List of currently available template providers.
58
 
   </p>
59
 
<A NAME="~toTemplateProvider"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> &nbsp;<strong>~toTemplateProvider</strong> ()
60
 
<br></td><td align="right"><h3><strong>~toTemplateProvider</strong></h3></td></tr></table><p> <small>[virtual]</small></p><A NAME="name"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &nbsp;<strong>name</strong> ()
61
 
<br></td><td align="right"><h3><strong>name</strong></h3></td></tr></table><p></p><p> Get name of this template provider.
62
 
   </p>
63
 
<A NAME="insertItems"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<i><strong>insertItems</strong></i> (<A HREF="/usr/lib/qt3/doc/html/qlistview.html">QListView</A> *parent,<A HREF="/usr/lib/qt3/doc/html/qtoolbar.html">QToolBar</A> *toolbar)
64
 
<br></td><td align="right"><h3><i><strong>insertItems</strong></i></h3></td></tr></table><p> <small>[pure virtual]</small></p><p> Insert a parent item for this template provider into a list view.
65
 
</p>
66
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
67
 
<TR><TD align="left" valign="top"><i>parent</i></TD><TD align="left" valign="top">The list into which to insert the item.
68
 
</TD></TR>
69
 
<TR><TD align="left" valign="top"><i>toolbar</i></TD><TD align="left" valign="top">The template toolbar if any buttons are to be added on it.
70
 
   </TD></TR>
71
 
</TABLE></P>
72
 
<A NAME="exportData"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>exportData</strong> (std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> &data,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &prefix)
73
 
<br></td><td align="right"><h3><strong>exportData</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p> Save settings for this template provider.
74
 
</p>
75
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
76
 
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Map of data.
77
 
</TD></TR>
78
 
<TR><TD align="left" valign="top"><i>prefix</i></TD><TD align="left" valign="top">Prefix of where to save info.
79
 
   </TD></TR>
80
 
</TABLE></P>
81
 
<A NAME="exportAllData"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>exportAllData</strong> (std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> &data,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &prefix)
82
 
<br></td><td align="right"><h3><strong>exportAllData</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Save settings for all template providers.
83
 
</p>
84
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
85
 
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Map of data.
86
 
</TD></TR>
87
 
<TR><TD align="left" valign="top"><i>prefix</i></TD><TD align="left" valign="top">Prefix of where to save info.
88
 
   </TD></TR>
89
 
</TABLE></P>
90
 
<A NAME="importData"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>importData</strong> (std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> &data,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &prefix)
91
 
<br></td><td align="right"><h3><strong>importData</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p> Import data
92
 
</p>
93
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
94
 
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Data to read from a map.
95
 
</TD></TR>
96
 
<TR><TD align="left" valign="top"><i>prefix</i></TD><TD align="left" valign="top">Prefix to read data from.
97
 
   </TD></TR>
98
 
</TABLE></P>
99
 
<A NAME="importAllData"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>importAllData</strong> (std::map<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>,<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> &data,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &prefix)
100
 
<br></td><td align="right"><h3><strong>importAllData</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Import data for all template providers.
101
 
</p>
102
 
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
103
 
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Data to read from a map.
104
 
</TD></TR>
105
 
<TR><TD align="left" valign="top"><i>prefix</i></TD><TD align="left" valign="top">Prefix to read data from.
106
 
   </TD></TR>
107
 
</TABLE></P>
108
 
<A NAME="setShown"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>setShown</strong> (bool shown)
109
 
<br></td><td align="right"><h3><strong>setShown</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Used internally to indicate if template help is shown.
110
 
   </p>
111
 
<A NAME="setToolKey"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>setToolKey</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &key)
112
 
<br></td><td align="right"><h3><strong>setToolKey</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Used internally to indicate tool key string
113
 
   </p>
114
 
<A NAME="toTemplate"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>friend class  <strong>toTemplate</strong>
115
 
</td><td align="right"><h3><strong>toTemplate</strong></h3></td></tr></table><p></p><HR>
116
 
        <table>
117
 
        <tr><td><small>Generated by: nneul on skyhawk on Wed Feb 23 19:49:58 2005, using kdoc 2.0a54.</small></td></tr>
118
 
        </table>
119
 
</BODY>
120
 
</HTML>