doc/api/python/help.html
author Brendan Donegan <brendand@symbian.org>
Wed, 14 Apr 2010 14:12:43 +0100
changeset 970 ac316618673b
parent 432 f2ddfa555b0f
permissions -rw-r--r--
Merged changes from MCL
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
432
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
     1
<?xml version="1.0" encoding="ascii"?>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
     2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
     3
          "DTD/xhtml1-transitional.dtd">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
     4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
     5
<head>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
     6
  <title>Help</title>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
     7
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
     8
  <script type="text/javascript" src="epydoc.js"></script>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
     9
</head>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    10
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    12
      alink="#204080">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    13
<!-- ==================== NAVIGATION BAR ==================== -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    14
<table class="navbar" border="0" width="100%" cellpadding="0"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    15
       bgcolor="#a0c0ff" cellspacing="0">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    16
  <tr valign="middle">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    17
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    18
  <!-- Tree link -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    19
      <th>&nbsp;&nbsp;&nbsp;<a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    20
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    21
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    22
  <!-- Index link -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    23
      <th>&nbsp;&nbsp;&nbsp;<a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    24
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    25
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    26
  <!-- Help link -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    27
      <th bgcolor="#70b0f0" class="navbar-select"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    28
          >&nbsp;&nbsp;&nbsp;Help&nbsp;&nbsp;&nbsp;</th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    29
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    30
      <th class="navbar" width="100%"></th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    31
  </tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    32
</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    33
<table width="100%" cellpadding="0" cellspacing="0">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    34
  <tr valign="top">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    35
    <td width="100%">&nbsp;</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    36
    <td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    37
      <table cellpadding="0" cellspacing="0">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    38
        <!-- hide/show private -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    39
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    40
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    41
        <tr><td align="right"><span class="options"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    42
            >[<a href="frames.html" target="_top">frames</a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    43
            >]&nbsp;|&nbsp;<a href="help.html"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    44
            target="_top">no&nbsp;frames</a>]</span></td></tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    45
      </table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    46
    </td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    47
  </tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    48
</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    49
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    50
<h1 class="epydoc"> API Documentation </h1>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    51
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    52
<p> This document contains the API (Application Programming Interface)
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    53
documentation for this project.  Documentation for the Python
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    54
objects defined by the project is divided into separate pages for each
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    55
package, module, and class.  The API documentation also includes two
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    56
pages containing information about the project as a whole: a trees
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    57
page, and an index page.  </p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    58
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    59
<h2> Object Documentation </h2>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    60
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    61
  <p>Each <strong>Package Documentation</strong> page contains: </p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    62
  <ul>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    63
    <li> A description of the package. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    64
    <li> A list of the modules and sub-packages contained by the
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    65
    package.  </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    66
    <li> A summary of the classes defined by the package. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    67
    <li> A summary of the functions defined by the package. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    68
    <li> A summary of the variables defined by the package. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    69
    <li> A detailed description of each function defined by the
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    70
    package. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    71
    <li> A detailed description of each variable defined by the
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    72
    package. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    73
  </ul>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    74
  
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    75
  <p>Each <strong>Module Documentation</strong> page contains:</p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    76
  <ul>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    77
    <li> A description of the module. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    78
    <li> A summary of the classes defined by the module. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    79
    <li> A summary of the functions defined by the module. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    80
    <li> A summary of the variables defined by the module. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    81
    <li> A detailed description of each function defined by the
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    82
    module. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    83
    <li> A detailed description of each variable defined by the
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    84
    module. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    85
  </ul>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    86
  
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    87
  <p>Each <strong>Class Documentation</strong> page contains: </p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    88
  <ul>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    89
    <li> A class inheritance diagram. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    90
    <li> A list of known subclasses. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    91
    <li> A description of the class. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    92
    <li> A summary of the methods defined by the class. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    93
    <li> A summary of the instance variables defined by the class. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    94
    <li> A summary of the class (static) variables defined by the
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    95
    class. </li> 
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    96
    <li> A detailed description of each method defined by the
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    97
    class. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    98
    <li> A detailed description of each instance variable defined by the
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
    99
    class. </li> 
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   100
    <li> A detailed description of each class (static) variable defined
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   101
    by the class. </li> 
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   102
  </ul>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   103
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   104
<h2> Project Documentation </h2>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   105
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   106
  <p> The <strong>Trees</strong> page contains the module and class hierarchies: </p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   107
  <ul>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   108
    <li> The <em>module hierarchy</em> lists every package and module, with
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   109
    modules grouped into packages.  At the top level, and within each
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   110
    package, modules and sub-packages are listed alphabetically. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   111
    <li> The <em>class hierarchy</em> lists every class, grouped by base
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   112
    class.  If a class has more than one base class, then it will be
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   113
    listed under each base class.  At the top level, and under each base
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   114
    class, classes are listed alphabetically. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   115
  </ul>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   116
  
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   117
  <p> The <strong>Index</strong> page contains indices of terms and
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   118
  identifiers: </p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   119
  <ul>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   120
    <li> The <em>term index</em> lists every term indexed by any object's
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   121
    documentation.  For each term, the index provides links to each
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   122
    place where the term is indexed. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   123
    <li> The <em>identifier index</em> lists the (short) name of every package,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   124
    module, class, method, function, variable, and parameter.  For each
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   125
    identifier, the index provides a short description, and a link to
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   126
    its documentation. </li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   127
  </ul>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   128
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   129
<h2> The Table of Contents </h2>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   130
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   131
<p> The table of contents occupies the two frames on the left side of
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   132
the window.  The upper-left frame displays the <em>project
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   133
contents</em>, and the lower-left frame displays the <em>module
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   134
contents</em>: </p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   135
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   136
<table class="help summary" border="1" cellspacing="0" cellpadding="3">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   137
  <tr style="height: 30%">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   138
    <td align="center" style="font-size: small">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   139
       Project<br />Contents<hr />...</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   140
    <td align="center" style="font-size: small" rowspan="2" width="70%">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   141
      API<br />Documentation<br />Frame<br /><br /><br />
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   142
    </td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   143
  </tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   144
  <tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   145
    <td align="center" style="font-size: small">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   146
      Module<br />Contents<hr />&nbsp;<br />...<br />&nbsp;
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   147
    </td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   148
  </tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   149
</table><br />
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   150
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   151
<p> The <strong>project contents frame</strong> contains a list of all packages
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   152
and modules that are defined by the project.  Clicking on an entry
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   153
will display its contents in the module contents frame.  Clicking on a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   154
special entry, labeled "Everything," will display the contents of
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   155
the entire project. </p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   156
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   157
<p> The <strong>module contents frame</strong> contains a list of every
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   158
submodule, class, type, exception, function, and variable defined by a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   159
module or package.  Clicking on an entry will display its
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   160
documentation in the API documentation frame.  Clicking on the name of
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   161
the module, at the top of the frame, will display the documentation
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   162
for the module itself. </p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   163
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   164
<p> The "<strong>frames</strong>" and "<strong>no frames</strong>" buttons below the top
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   165
navigation bar can be used to control whether the table of contents is
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   166
displayed or not. </p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   167
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   168
<h2> The Navigation Bar </h2>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   169
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   170
<p> A navigation bar is located at the top and bottom of every page.
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   171
It indicates what type of page you are currently viewing, and allows
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   172
you to go to related pages.  The following table describes the labels
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   173
on the navigation bar.  Note that not some labels (such as
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   174
[Parent]) are not displayed on all pages. </p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   175
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   176
<table class="summary" border="1" cellspacing="0" cellpadding="3" width="100%">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   177
<tr class="summary">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   178
  <th>Label</th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   179
  <th>Highlighted when...</th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   180
  <th>Links to...</th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   181
</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   182
  <tr><td valign="top"><strong>[Parent]</strong></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   183
      <td valign="top"><em>(never highlighted)</em></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   184
      <td valign="top"> the parent of the current package </td></tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   185
  <tr><td valign="top"><strong>[Package]</strong></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   186
      <td valign="top">viewing a package</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   187
      <td valign="top">the package containing the current object
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   188
      </td></tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   189
  <tr><td valign="top"><strong>[Module]</strong></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   190
      <td valign="top">viewing a module</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   191
      <td valign="top">the module containing the current object
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   192
      </td></tr> 
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   193
  <tr><td valign="top"><strong>[Class]</strong></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   194
      <td valign="top">viewing a class </td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   195
      <td valign="top">the class containing the current object</td></tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   196
  <tr><td valign="top"><strong>[Trees]</strong></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   197
      <td valign="top">viewing the trees page</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   198
      <td valign="top"> the trees page </td></tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   199
  <tr><td valign="top"><strong>[Index]</strong></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   200
      <td valign="top">viewing the index page</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   201
      <td valign="top"> the index page </td></tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   202
  <tr><td valign="top"><strong>[Help]</strong></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   203
      <td valign="top">viewing the help page</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   204
      <td valign="top"> the help page </td></tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   205
</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   206
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   207
<p> The "<strong>show private</strong>" and "<strong>hide private</strong>" buttons below
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   208
the top navigation bar can be used to control whether documentation
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   209
for private objects is displayed.  Private objects are usually defined
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   210
as objects whose (short) names begin with a single underscore, but do
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   211
not end with an underscore.  For example, "<code>_x</code>",
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   212
"<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   213
are private objects; but "<code>re.sub</code>",
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   214
"<code>__init__</code>", and "<code>type_</code>" are not.  However,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   215
if a module defines the "<code>__all__</code>" variable, then its
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   216
contents are used to decide which objects are private. </p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   217
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   218
<p> A timestamp below the bottom navigation bar indicates when each
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   219
page was last updated. </p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   220
<!-- ==================== NAVIGATION BAR ==================== -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   221
<table class="navbar" border="0" width="100%" cellpadding="0"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   222
       bgcolor="#a0c0ff" cellspacing="0">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   223
  <tr valign="middle">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   224
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   225
  <!-- Tree link -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   226
      <th>&nbsp;&nbsp;&nbsp;<a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   227
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   228
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   229
  <!-- Index link -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   230
      <th>&nbsp;&nbsp;&nbsp;<a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   231
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   232
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   233
  <!-- Help link -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   234
      <th bgcolor="#70b0f0" class="navbar-select"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   235
          >&nbsp;&nbsp;&nbsp;Help&nbsp;&nbsp;&nbsp;</th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   236
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   237
      <th class="navbar" width="100%"></th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   238
  </tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   239
</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   240
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   241
  <tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   242
    <td align="left" class="footer">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   243
    Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:15 2009
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   244
    </td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   245
    <td align="right" class="footer">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   246
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   247
    </td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   248
  </tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   249
</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   250
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   251
<script type="text/javascript">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   252
  <!--
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   253
  // Private objects are initially displayed (because if
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   254
  // javascript is turned off then we want them to be
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   255
  // visible); but by default, we want to hide them.  So hide
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   256
  // them unless we have a cookie that says to show them.
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   257
  checkCookie()
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   258
  // -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   259
</script>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   260
  
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   261
</body>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e
Shabe Razvi <shaber@symbian.org>
parents:
diff changeset
   262
</html>