← Back to branch summary

~ubuntu-branches/debian/lenny/epydoc/lenny

« back to all changes in this revision

Viewing changes to doc/api/private/docutils.nodes.NodeVisitor-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2008-02-03 13:22:12 UTC
  • mfrom: (1.2.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080203132212-u2uohl6rswmlz2ra
Tags: 3.0.1-1
* New upstream release.
* Removed #! from top of epydoc/gui.py
* Got rid of version mangling in debian/watch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/private/docutils.nodes.NodeVisitor-class.html
1
 
<?xml version="1.0" encoding="iso-8859-1"?>
2
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
 
          "DTD/xhtml1-transitional.dtd">
4
 
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<head>
6
 
  <title>docutils.nodes.NodeVisitor</title>
7
 
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
8
 
</head>
9
 
<body bgcolor="white" text="black" link="blue" vlink="#204080"
10
 
      alink="#204080">
11
 
 
12
 
<!-- =========== START OF NAVBAR =========== -->
13
 
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14
 
  <tr valign="center">
15
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
16
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
17
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
18
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
19
 
    <th class="navbar" align="right" width="100%">
20
 
      <table border="0" cellpadding="0" cellspacing="0">
21
 
      <tr><th class="navbar" align="center">
22
 
        <p class="nomargin">
23
 
          <a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
24
 
      </p></th></tr></table>
25
 
    </th>
26
 
  </tr>
27
 
</table>
28
 
<table width="100%" cellpadding="0" cellspacing="0">
29
 
  <tr valign="top">
30
 
    <td width="100%">
31
 
      <font size="-1"><b class="breadcrumbs">
32
 
        Package&nbsp;docutils ::
33
 
        Module&nbsp;nodes ::
34
 
        Class&nbsp;NodeVisitor
35
 
      </b></font></br>
36
 
    </td>
37
 
    <td><table cellpadding="0" cellspacing="0">
38
 
      <tr><td align="right"><font size="-2">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/docutils.nodes.NodeVisitor-class.html">hide&nbsp;private</a>]</font></td></tr>
39
 
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="docutils.nodes.NodeVisitor-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
40
 
    </table></td>
41
 
</tr></table>
42
 
 
43
 
<!-- =========== START OF CLASS DESCRIPTION =========== -->
44
 
<h2 class="class">Class NodeVisitor</h2>
45
 
 
46
 
<dl><dt><b>Known Subclasses:</b></dt>
47
 
<dd>
48
 
    <a href="docutils.writers.html4css1.HTMLTranslator-class.html"><code>HTMLTranslator</code></a>,
49
 
    <a href="../private/epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html"><code>_SplitFieldsTranslator</code></a>,
50
 
    <a href="../private/epydoc.markup.restructuredtext._SummaryExtractor-class.html"><code>_SummaryExtractor</code></a></dd></dl>
51
 
 
52
 
<hr/>
53
 
 
54
 
<p>&quot;Visitor&quot; pattern <a class="citation-reference" href="#rst-gof95" id="id1" name="id1">[GoF95]</a> abstract superclass implementation for document
55
 
tree traversals.</p>
56
 
<p>Each node class has corresponding methods, doing nothing by default;
57
 
override individual methods for specific and useful behaviour.  The
58
 
&quot;<tt class="literal"><span class="pre">visit_</span></tt> + node class name&quot; method is called by <code>Node.walk()</code> upon
59
 
entering a node.  <code>Node.walkabout()</code> also calls the &quot;<tt class="literal"><span class="pre">depart_</span></tt> + node
60
 
class name&quot; method before exiting a node.</p>
61
 
<p>This is a base class for visitors whose <tt class="literal"><span class="pre">visit_...</span></tt> &amp; <tt class="literal"><span class="pre">depart_...</span></tt>
62
 
methods should be implemented for <em>all</em> node types encountered (such as
63
 
for <a href="docutils.writers.Writer-class.html" class="link"><code>docutils.writers.Writer</code></a> subclasses).  Unimplemented methods will
64
 
raise exceptions.</p>
65
 
<p>For sparse traversals, where only certain node types are of interest,
66
 
subclass <code>SparseNodeVisitor</code> instead.  When (mostly or entirely) uniform
67
 
processing is desired, subclass <code>GenericNodeVisitor</code>.</p>
68
 
<table class="citation" frame="void" id="gof95" rules="none">
69
 
<colgroup><col class="label" /><col /></colgroup>
70
 
<col />
71
 
<tbody valign="top">
72
 
<tr><td class="label"><a class="fn-backref" href="#id1" name="gof95">[GoF95]</a></td><td>Gamma, Helm, Johnson, Vlissides. <em>Design Patterns: Elements of
73
 
Reusable Object-Oriented Software</em>. Addison-Wesley, Reading, MA, USA,
74
 
1995.</td></tr>
75
 
</tbody>
76
 
</table>
77
 
<hr/>
78
 
 
79
 
 
80
 
<!-- =========== START OF METHOD SUMMARY =========== -->
81
 
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
82
 
<tr bgcolor="#70b0f0" class="summary">
83
 
  <th colspan="2">Method Summary</th></tr>
84
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
85
 
  <td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
86
 
          <span class=summary-sig-arg>document</span>)</span></code>
87
 
</td></tr>
88
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
89
 
  <td><code><span class="summary-sig"><a href="docutils.nodes.NodeVisitor-class.html#unknown_departure" class="summary-sig-name"><code>unknown_departure</code></a>(<span class=summary-sig-arg>self</span>,
90
 
          <span class=summary-sig-arg>node</span>)</span></code>
91
 
<br />
92
 
Called before exiting unknown <code>Node</code> types.</td></tr>
93
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
94
 
  <td><code><span class="summary-sig"><a href="docutils.nodes.NodeVisitor-class.html#unknown_visit" class="summary-sig-name"><code>unknown_visit</code></a>(<span class=summary-sig-arg>self</span>,
95
 
          <span class=summary-sig-arg>node</span>)</span></code>
96
 
<br />
97
 
Called when entering unknown <code>Node</code> types.</td></tr>
98
 
</table><br />
99
 
 
100
 
 
101
 
<!-- =========== START OF METHOD DETAILS =========== -->
102
 
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
103
 
<tr bgcolor="#70b0f0" class="details">
104
 
  <th colspan="2">Method Details</th></tr>
105
 
</table>
106
 
 
107
 
<a name="unknown_departure"></a>
108
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
109
 
  <h3><span class="sig"><span class="sig-name">unknown_departure</span>(<span class=sig-arg>self</span>,
110
 
          <span class=sig-arg>node</span>)</span>
111
 
  </h3>
112
 
<p>Called before exiting unknown <code>Node</code> types.</p>
113
 
<p>Raise exception unless overridden.</p>
114
 
  <dl><dt></dt><dd>
115
 
  </dd></dl>
116
 
</td></tr></table>
117
 
 
118
 
<a name="unknown_visit"></a>
119
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
120
 
  <h3><span class="sig"><span class="sig-name">unknown_visit</span>(<span class=sig-arg>self</span>,
121
 
          <span class=sig-arg>node</span>)</span>
122
 
  </h3>
123
 
<p>Called when entering unknown <code>Node</code> types.</p>
124
 
<p>Raise an exception unless overridden.</p>
125
 
  <dl><dt></dt><dd>
126
 
  </dd></dl>
127
 
</td></tr></table>
128
 
<br />
129
 
 
130
 
 
131
 
<!-- =========== START OF NAVBAR =========== -->
132
 
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
133
 
  <tr valign="center">
134
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
135
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
136
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
137
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
138
 
    <th class="navbar" align="right" width="100%">
139
 
      <table border="0" cellpadding="0" cellspacing="0">
140
 
      <tr><th class="navbar" align="center">
141
 
        <p class="nomargin">
142
 
          <a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
143
 
      </p></th></tr></table>
144
 
    </th>
145
 
  </tr>
146
 
</table>
147
 
 
148
 
<table border="0" cellpadding="0" cellspacing="0" width="100%">
149
 
  <tr>
150
 
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:17 2004</font></td>
151
 
    <td align="right"><a href="http://epydoc.sourceforge.net"
152
 
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
153
 
  </tr>
154
 
</table>
155
 
</body>
156
 
</html>