buildframework/helium/doc/api/api.ftllib
author srilekhas <srilekhas@symbian.org>
Wed, 18 Aug 2010 11:18:38 +0100
changeset 627 cb3264f4c6e6
parent 587 85df38eb4012
permissions -rw-r--r--
Merge : re-applies missing part of fix for Bug 2901,Add export for s60ibymacros.pm
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
<#--
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
============================================================================ 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
Name        : 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
Part of     : Helium 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
Description:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
============================================================================
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
-->
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
<#if ant?keys?seq_contains("tracurl")>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
    <#assign helium_browser_trunk=ant.tracurl>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
<#else>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
    <#assign helium_browser_trunk="">
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
</#if>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
<#macro helium_api_navbar>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
<!-- ========= start of top navbar ======= -->
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
<a name="navbar_top"><!-- --></a>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
<a href="#skip-navbar_top" title="skip navigation links"></a>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
<table border="0" width="100%" cellpadding="1" cellspacing="0" summary="">
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
<tr>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
<td colspan="2" bgcolor="#eeeeff" class="navbarcell1">
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
<a name="navbar_top_firstrow"><!-- --></a>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
<table border="0" cellpadding="0" cellspacing="3" summary="">
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
  <tr align="center" valign="top">
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
  <td bgcolor="#ffffff" class="navbarcell1"> &#160;<a href="overview-summary.html"><font class="navbarfont1"><b>overview</b></font>&#160;</a></td>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
  <td bgcolor="#ffffff" class="navbarcell1">    <a href="deprecated-list.html"><font class="navbarfont1"><b>deprecated</b></font></a>&#160;</td>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="properties-table.html"><font class="navbarfont1"><b>properties-table</b></font></a>&#160;</td>  
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="index-1.html"><font class="navbarfont1"><b>index</b></font></a>&#160;</td>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="help.html"><font class="navbarfont1"><b>help</b></font></a>&#160;</td>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
  </tr>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
</table>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
</td>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
<td align="right" valign="top" rowspan="3"><em>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
<b>Helium API</b></em>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
</td>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
</tr>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
<tr>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
<td bgcolor="white" class="navbarcell2"><font size="-2">
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
&#160;prev&#160;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
&#160;next</font></td>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
<td bgcolor="white" class="navbarcell2"><font size="-2">
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
  <a href="index.html?overview-summary.html" target="_top"><b>frames</b></a>  &#160;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
&#160;<a href="overview-summary.html" target="_top"><b>no frames</b></a>  &#160;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
&#160;<script type="text/javascript">
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
  <!--
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
  if(window==top) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    66
    document.writeln('<a href="allclasses-noframe.html"><b>all classes</b></a>');
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
  }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    68
  //-->
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    69
</script>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    70
<noscript>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    71
  <a href="allclasses-noframe.html"><b>all classes</b></a>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    72
</noscript>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    73
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    74
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    75
</font></td>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    76
</tr>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    77
</table>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    78
<a name="skip-navbar_top"></a>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    79
<!-- ========= end of top navbar ========= -->
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    80
</#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    81
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    82
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    83
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    84
<#macro helium_api_head_section title>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    85
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    86
<head>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    87
    <meta name="keywords" content="helium"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    88
    <meta http-equiv="content-type" content="text/html+xml; charset=iso-8859-1"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    89
    <link rel="stylesheet" href="stylesheet.css" type="text/css" />
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    90
    <script type="text/javascript">
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    91
      var DOCUMENTATION_OPTIONS = {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    92
        URL_ROOT:   '',
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    93
        VERSION:    '0'
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    94
      };
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    95
    </script>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    96
    <script type="text/javascript" src="../_static/jquery.js"></script>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    97
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    98
    <script type="text/javascript" src="../_static/interface.js"></script>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    99
    <script type="text/javascript" src="../_static/doctools.js"></script>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   100
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   101
    <title>${title}</title>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   102
</head>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   103
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   104
</#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   105
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   106
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   107
<#macro helium_api_header title>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   108
<?xml version="1.0" encoding="utf-8"?>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   109
<!DOCTYPE HTML PUBLIC "-//w3c//dtd xhtml 1.0 strict//en"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   110
      "http://www.w3.org/tr/xhtml1/dtd/xhtml1-strict.dtd">
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   111
<html xmlns="http://www.w3.org/1999/xhtml">
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   112
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   113
<@helium_api_head_section title="${title}"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   114
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   115
<body>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   116
    <@helium_api_navbar/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   117
    <hr/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   118
</#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   119
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   120
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   121
<#macro helium_api_html_footer>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   122
    <hr/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   123
    <@helium_api_navbar/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   124
    <font size="-2">Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: http://www.eclipse.org/legal/epl-v10.html</font>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   125
 </body>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   126
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   127
</html>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   128
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   129
</#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   130
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   131
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   132
<#macro helium_api_location_path location>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   133
    <#assign target_line=""/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   134
    <#assign res = location?matches(":(\\d+):$") />
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   135
    <#list res as m>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   136
        <#assign target_line="#L${m?groups[1]}"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   137
    </#list>      
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   138
    <#assign location_path=location/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   139
    <#if location?index_of("helium\\") &gt; 0>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   140
        <#assign location_path=location?substring(location?last_index_of('helium\\'))/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   141
    </#if>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   142
       <#assign target_url=location_path?replace("\\", "/")?replace(":(\\d+):", "", 'ri') />
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   143
    <tt class="docutils literal"><a href="${helium_browser_trunk}/${target_url}${target_line}">${location_path}</a></tt>  
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   144
</#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   145
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   146
<#macro helium_project_path location>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   147
    <#assign location_path=location/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   148
    <#if location?index_of("helium\\") &gt; 0>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   149
        <#assign location_path=location?substring(location?last_index_of('helium\\'))/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   150
    </#if>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   151
       <#assign target_url=location_path?replace("\\", "/")?replace(":(\\d+):", "", 'ri') />
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   152
    <tt class="docutils literal"><a href="${helium_browser_trunk}/${target_url}">${target_url}</a></tt>  
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   153
</#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   154
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   155
<#-- Macros for recursively handling random HTML elements inside documentation elements. -->
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   156
<#macro tt> <tt><#recurse></tt> </#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   157
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   158
<#macro div><#recurse></#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   159
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   160
<#macro p><p><#recurse></p></#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   161
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   162
<#macro ul><ul><#recurse></ul></#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   163
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   164
<#macro li><li><#recurse></li></#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   165
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   166
<#macro b><b><#recurse></b></#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   167
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   168
<#macro pre><pre>${.node?html}</pre></#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   169
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   170
<#macro @text>${.node?trim}</#macro>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   171