carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/reference/extension-points/com_nokia_carbide_templatewizard_wizardTemplate.html
author cawthron
Tue, 24 Mar 2009 22:20:21 -0500
changeset 2 d760517a8095
child 106 aa8d5ca0cab2
permissions -rw-r--r--
new
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
cawthron
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
cawthron
parents:
diff changeset
     2
<HTML>
cawthron
parents:
diff changeset
     3
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
cawthron
parents:
diff changeset
     4
<title>Wizard Template</title>
cawthron
parents:
diff changeset
     5
<style type="text/css">@import url("PLUGINS_ROOT/org.eclipse.cdt.doc.isv/book.css");</style>
cawthron
parents:
diff changeset
     6
<style type="text/css">@import url("PLUGINS_ROOT/org.eclipse.cdt.doc.isv/schema.css");</style>
cawthron
parents:
diff changeset
     7
</HEAD>
cawthron
parents:
diff changeset
     8
<BODY>
cawthron
parents:
diff changeset
     9
<H1 style="text-align:center">Wizard Template</H1>
cawthron
parents:
diff changeset
    10
<p></p>
cawthron
parents:
diff changeset
    11
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>com.nokia.carbide.templatewizard.wizardTemplate<p></p>
cawthron
parents:
diff changeset
    12
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>Carbide.c++ 1.2
cawthron
parents:
diff changeset
    13
<p></p>
cawthron
parents:
diff changeset
    14
cawthron
parents:
diff changeset
    15
<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>The wizard template extension point registers a template with the Carbide.c++ template wizard. Templates may create projects or classes.
cawthron
parents:
diff changeset
    16
cawthron
parents:
diff changeset
    17
See the the documentation under Tasks > Creating Wizard Templates for more information.<p></p>
cawthron
parents:
diff changeset
    18
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
cawthron
parents:
diff changeset
    19
<p></p>
cawthron
parents:
diff changeset
    20
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.template">template</a>+)&gt;</p>
cawthron
parents:
diff changeset
    21
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
cawthron
parents:
diff changeset
    22
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
cawthron
parents:
diff changeset
    23
<p></p>
cawthron
parents:
diff changeset
    24
<ul class="ConfigMarkupAttlistDesc">
cawthron
parents:
diff changeset
    25
</ul>
cawthron
parents:
diff changeset
    26
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.template">template</a> EMPTY&gt;</p>
cawthron
parents:
diff changeset
    27
<p class="code SchemaDtd">&lt;!ATTLIST template</p>
cawthron
parents:
diff changeset
    28
<p class="code SchemaDtdAttlist">templateId&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">location&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">wizardId&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">groupLabel&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">filterArguments&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">image&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">extraPagesProvider&nbsp;CDATA #IMPLIED&gt;</p>
cawthron
parents:
diff changeset
    29
<p></p>
cawthron
parents:
diff changeset
    30
<p class="ConfigMarkupElementDesc">
cawthron
parents:
diff changeset
    31
The template element registers a single template with the template wizard.</p>
cawthron
parents:
diff changeset
    32
<br>
cawthron
parents:
diff changeset
    33
<ul class="ConfigMarkupAttlistDesc">
cawthron
parents:
diff changeset
    34
<li><b>templateId</b> - The unique id for this template</li>
cawthron
parents:
diff changeset
    35
<li><b>location</b> - The plugin-relative path to the template xml file</li>
cawthron
parents:
diff changeset
    36
<li><b>wizardId</b> - The id of the wizard in which this template is used</li>
cawthron
parents:
diff changeset
    37
<li><b>groupLabel</b> - The group label under which this template will appear in the template choice page of the appropriate template wizard</li>
cawthron
parents:
diff changeset
    38
<li><b>filterArguments</b> - The optional wizard-specific data available for the IFilter implementing a filter checkbox, optionally shown in some template wizards</li>
cawthron
parents:
diff changeset
    39
<li><b>image</b> - The optional plugin-relative location of a 16x16 pixel image file to use when showing this template in the choose template wizard page</li>
cawthron
parents:
diff changeset
    40
<li><b>extraPagesProvider</b> - An optional provider of extra wizard pages</li>
cawthron
parents:
diff changeset
    41
</ul>
cawthron
parents:
diff changeset
    42
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6><pre class="Example"><span class="code SchemaTag">
cawthron
parents:
diff changeset
    43
&lt;extension point=</span><span class="code SchemaCstring">&quot;com.nokia.carbide.templatewizard.wizardTemplate&quot;</span><span class="code SchemaTag">&gt;
cawthron
parents:
diff changeset
    44
  &lt;template
cawthron
parents:
diff changeset
    45
   templateId=</span><span class="code SchemaCstring">&quot;com.nokia.cdt.templates.s60.controlapplication&quot;</span><span class="code SchemaTag">
cawthron
parents:
diff changeset
    46
   location=</span><span class="code SchemaCstring">&quot;templates/projecttemplates/S60-ControlApplication/template.xml&quot;</span><span class="code SchemaTag">
cawthron
parents:
diff changeset
    47
   wizardId=</span><span class="code SchemaCstring">&quot;com.nokia.carbide.cpp.project.ui.wizards.NewSymbianOSCppProjectWizard&quot;</span><span class="code SchemaTag"> 
cawthron
parents:
diff changeset
    48
   groupLabel=</span><span class="code SchemaCstring">&quot;S60&quot;</span><span class="code SchemaTag">
cawthron
parents:
diff changeset
    49
   filterArguments=</span><span class="code SchemaCstring">&quot;S60:1.2;2.0-2.9&quot;</span><span class="code SchemaTag">
cawthron
parents:
diff changeset
    50
   image=</span><span class="code SchemaCstring">&quot;icons/icon_S60.png&quot;</span><span class="code SchemaTag">
cawthron
parents:
diff changeset
    51
  /&gt;
cawthron
parents:
diff changeset
    52
&lt;/extension&gt;
cawthron
parents:
diff changeset
    53
</span></pre>
cawthron
parents:
diff changeset
    54
<p></p>
cawthron
parents:
diff changeset
    55
cawthron
parents:
diff changeset
    56
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>This extension point registers an XML template. Implementation is not required.
cawthron
parents:
diff changeset
    57
<p></p>
cawthron
parents:
diff changeset
    58
cawthron
parents:
diff changeset
    59
<br>
cawthron
parents:
diff changeset
    60
<p class="note SchemaCopyright">
cawthron
parents:
diff changeset
    61
(C) Copyright 2007 Nokia Corporation.
cawthron
parents:
diff changeset
    62
cawthron
parents:
diff changeset
    63
</p>
cawthron
parents:
diff changeset
    64
</BODY>
cawthron
parents:
diff changeset
    65
</HTML>