← Back to branch summary

~ubuntu-branches/ubuntu/raring/genshi/raring-proposed

« back to all changes in this revision

Viewing changes to doc/api/genshi.template.directives.IfDirective-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Fontaine
  • Date: 2007-04-16 17:49:03 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20070416174903-x2p3n9g890v18d0m
Tags: 0.4-1
* New upstream release.
* Remove useless python-markup transition package.
* Add Provides against python-markup.
* Add doc-base.
* Add depends against python-xml.
* Add suggests to python-setuptools.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/genshi.template.directives.IfDirective-class.html
 
1
<?xml version="1.0" encoding="ascii"?>
 
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>genshi.template.directives.IfDirective</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
 
8
  <script type="text/javascript" src="epydoc.js"></script>
 
9
</head>
 
10
 
 
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
12
      alink="#204080">
 
13
<!-- ==================== NAVIGATION BAR ==================== -->
 
14
<table class="navbar" border="0" width="100%" cellpadding="0"
 
15
       bgcolor="#a0c0ff" cellspacing="0">
 
16
  <tr valign="middle">
 
17
  <!-- Home link -->
 
18
      <th>&nbsp;&nbsp;&nbsp;<a
 
19
        href="genshi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
20
 
 
21
  <!-- Tree link -->
 
22
      <th>&nbsp;&nbsp;&nbsp;<a
 
23
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
24
 
 
25
  <!-- Index link -->
 
26
      <th>&nbsp;&nbsp;&nbsp;<a
 
27
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
28
 
 
29
  <!-- Help link -->
 
30
      <th>&nbsp;&nbsp;&nbsp;<a
 
31
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
32
 
 
33
  <!-- Project homepage -->
 
34
      <th class="navbar" align="right" width="100%">
 
35
        <table border="0" cellpadding="0" cellspacing="0">
 
36
          <tr><th class="navbar" align="center"
 
37
            ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
 
38
          </tr></table></th>
 
39
  </tr>
 
40
</table>
 
41
<table width="100%" cellpadding="0" cellspacing="0">
 
42
  <tr valign="top">
 
43
    <td width="100%">
 
44
      <span class="breadcrumbs">
 
45
        <a href="genshi-module.html">Package&nbsp;genshi</a> ::
 
46
        <a href="genshi.template-module.html">Package&nbsp;template</a> ::
 
47
        <a href="genshi.template.directives-module.html">Module&nbsp;directives</a> ::
 
48
        Class&nbsp;IfDirective
 
49
      </span>
 
50
    </td>
 
51
    <td>
 
52
      <table cellpadding="0" cellspacing="0">
 
53
        <!-- hide/show private -->
 
54
      </table>
 
55
    </td>
 
56
  </tr>
 
57
</table>
 
58
<!-- ==================== CLASS DESCRIPTION ==================== -->
 
59
<h1 class="epydoc">Class IfDirective</h1><br /><br />
 
60
<pre class="base-tree">
 
61
object --+    
 
62
         |    
 
63
 Directive --+
 
64
             |
 
65
            <strong class="uidshort">IfDirective</strong>
 
66
</pre>
 
67
 
 
68
<hr />
 
69
<p>Implementation of the <tt class="rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal"><span class="pre">py:if</span></tt> template directive for conditionally
 
70
excluding elements from being output.</p>
 
71
<pre class="py-doctest">
 
72
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">from</span> genshi.template <span class="py-keyword">import</span> MarkupTemplate
 
73
<span class="py-prompt">&gt;&gt;&gt; </span>tmpl = MarkupTemplate(<span class="py-string">'''&lt;div xmlns:py=&quot;http://genshi.edgewall.org/&quot;&gt;</span>
 
74
<span class="py-more">... </span><span class="py-string">  &lt;b py:if=&quot;foo&quot;&gt;${bar}&lt;/b&gt;</span>
 
75
<span class="py-more">... </span><span class="py-string">&lt;/div&gt;'''</span>)
 
76
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">print</span> tmpl.generate(foo=True, bar=<span class="py-string">'Hello'</span>)
 
77
<span class="py-output">&lt;div&gt;</span>
 
78
<span class="py-output">  &lt;b&gt;Hello&lt;/b&gt;</span>
 
79
<span class="py-output">&lt;/div&gt;</span></pre><br /><br />
 
80
 
 
81
<!-- ==================== NESTED CLASSES ==================== -->
 
82
<a name="section-NestedClasses"></a>
 
83
<table class="summary" border="1" cellpadding="3"
 
84
       cellspacing="0" width="100%" bgcolor="white">
 
85
<tr bgcolor="#70b0f0" class="table-header">
 
86
  <td align="left" colspan="2" class="table-header">
 
87
    <span class="table-header">Nested Classes</span></td>
 
88
</tr>
 
89
  <tr>
 
90
    <td colspan="2" class="summary">
 
91
    <p class="indent-wrapped-lines"><b>Inherited from <code>Directive</code></b>:
 
92
      <code><a href="genshi.template.directives.DirectiveMeta-class.html">__metaclass__</a></code>
 
93
      </p>
 
94
    </td>
 
95
  </tr>
 
96
</table>
 
97
<!-- ==================== INSTANCE METHODS ==================== -->
 
98
<a name="section-InstanceMethods"></a>
 
99
<table class="summary" border="1" cellpadding="3"
 
100
       cellspacing="0" width="100%" bgcolor="white">
 
101
<tr bgcolor="#70b0f0" class="table-header">
 
102
  <td align="left" colspan="2" class="table-header">
 
103
    <span class="table-header">Instance Methods</span></td>
 
104
</tr>
 
105
<tr>
 
106
    <td width="15%" align="right" valign="top" class="summary">
 
107
      <span class="summary-type">&nbsp;</span>
 
108
    </td><td class="summary">
 
109
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
110
        <tr>
 
111
          <td><span class="summary-sig"><a href="genshi.template.directives.IfDirective-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,
 
112
        <span class="summary-sig-arg">stream</span>,
 
113
        <span class="summary-sig-arg">ctxt</span>,
 
114
        <span class="summary-sig-arg">directives</span>)</span><br />
 
115
      Apply the directive to the given stream.</td>
 
116
          <td align="right" valign="top">
 
117
            
 
118
            
 
119
          </td>
 
120
        </tr>
 
121
      </table>
 
122
      
 
123
    </td>
 
124
  </tr>
 
125
  <tr>
 
126
    <td colspan="2" class="summary">
 
127
    <p class="indent-wrapped-lines"><b>Inherited from <code>Directive</code></b>:
 
128
      <code>__init__</code>,
 
129
      <code>__repr__</code>
 
130
      </p>
 
131
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 
132
      <code>__delattr__</code>,
 
133
      <code>__getattribute__</code>,
 
134
      <code>__hash__</code>,
 
135
      <code>__new__</code>,
 
136
      <code>__reduce__</code>,
 
137
      <code>__reduce_ex__</code>,
 
138
      <code>__setattr__</code>,
 
139
      <code>__str__</code>
 
140
      </p>
 
141
    </td>
 
142
  </tr>
 
143
</table>
 
144
<!-- ==================== CLASS METHODS ==================== -->
 
145
<a name="section-ClassMethods"></a>
 
146
<table class="summary" border="1" cellpadding="3"
 
147
       cellspacing="0" width="100%" bgcolor="white">
 
148
<tr bgcolor="#70b0f0" class="table-header">
 
149
  <td align="left" colspan="2" class="table-header">
 
150
    <span class="table-header">Class Methods</span></td>
 
151
</tr>
 
152
  <tr>
 
153
    <td colspan="2" class="summary">
 
154
    <p class="indent-wrapped-lines"><b>Inherited from <code>Directive</code></b>:
 
155
      <code>attach</code>
 
156
      </p>
 
157
    </td>
 
158
  </tr>
 
159
</table>
 
160
<!-- ==================== CLASS VARIABLES ==================== -->
 
161
<a name="section-ClassVariables"></a>
 
162
<table class="summary" border="1" cellpadding="3"
 
163
       cellspacing="0" width="100%" bgcolor="white">
 
164
<tr bgcolor="#70b0f0" class="table-header">
 
165
  <td align="left" colspan="2" class="table-header">
 
166
    <span class="table-header">Class Variables</span></td>
 
167
</tr>
 
168
<tr>
 
169
    <td width="15%" align="right" valign="top" class="summary">
 
170
      <span class="summary-type">&nbsp;</span>
 
171
    </td><td class="summary">
 
172
        <a name="ATTRIBUTE"></a><span class="summary-name">ATTRIBUTE</span> = <code title="'test'"><code class="variable-quote">'</code><code class="variable-string">test</code><code class="variable-quote">'</code></code>
 
173
    </td>
 
174
  </tr>
 
175
<tr>
 
176
    <td width="15%" align="right" valign="top" class="summary">
 
177
      <span class="summary-type">&nbsp;</span>
 
178
    </td><td class="summary">
 
179
        <a name="tagname"></a><span class="summary-name">tagname</span> = <code title="'if'"><code class="variable-quote">'</code><code class="variable-string">if</code><code class="variable-quote">'</code></code>
 
180
    </td>
 
181
  </tr>
 
182
</table>
 
183
<!-- ==================== PROPERTIES ==================== -->
 
184
<a name="section-Properties"></a>
 
185
<table class="summary" border="1" cellpadding="3"
 
186
       cellspacing="0" width="100%" bgcolor="white">
 
187
<tr bgcolor="#70b0f0" class="table-header">
 
188
  <td align="left" colspan="2" class="table-header">
 
189
    <span class="table-header">Properties</span></td>
 
190
</tr>
 
191
  <tr>
 
192
    <td colspan="2" class="summary">
 
193
    <p class="indent-wrapped-lines"><b>Inherited from <code>Directive</code></b>:
 
194
      <code>expr</code>
 
195
      </p>
 
196
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 
197
      <code>__class__</code>
 
198
      </p>
 
199
    </td>
 
200
  </tr>
 
201
</table>
 
202
<!-- ==================== METHOD DETAILS ==================== -->
 
203
<a name="section-MethodDetails"></a>
 
204
<table class="details" border="1" cellpadding="3"
 
205
       cellspacing="0" width="100%" bgcolor="white">
 
206
<tr bgcolor="#70b0f0" class="table-header">
 
207
  <td align="left" colspan="2" class="table-header">
 
208
    <span class="table-header">Method Details</span></td>
 
209
</tr>
 
210
</table>
 
211
<a name="__call__"></a>
 
212
<div>
 
213
<table class="details" border="1" cellpadding="3"
 
214
       cellspacing="0" width="100%" bgcolor="white">
 
215
<tr><td>
 
216
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
217
  <tr valign="top"><td>
 
218
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>,
 
219
        <span class="sig-arg">stream</span>,
 
220
        <span class="sig-arg">ctxt</span>,
 
221
        <span class="sig-arg">directives</span>)</span>
 
222
    <br /><em class="fname">(Call operator)</em>
 
223
  </h3>
 
224
  </td><td align="right" valign="top"
 
225
    >&nbsp;
 
226
    </td>
 
227
  </table>
 
228
  
 
229
  Apply the directive to the given stream.
 
230
  <dl class="fields">
 
231
    <dt>Overrides:
 
232
      Directive.__call__
 
233
        <dd><em class="note">(inherited documentation)</em></dd>
 
234
    </dt>
 
235
  </dl>
 
236
</td></tr></table>
 
237
</div>
 
238
<br />
 
239
<!-- ==================== NAVIGATION BAR ==================== -->
 
240
<table class="navbar" border="0" width="100%" cellpadding="0"
 
241
       bgcolor="#a0c0ff" cellspacing="0">
 
242
  <tr valign="middle">
 
243
  <!-- Home link -->
 
244
      <th>&nbsp;&nbsp;&nbsp;<a
 
245
        href="genshi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
246
 
 
247
  <!-- Tree link -->
 
248
      <th>&nbsp;&nbsp;&nbsp;<a
 
249
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
250
 
 
251
  <!-- Index link -->
 
252
      <th>&nbsp;&nbsp;&nbsp;<a
 
253
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
254
 
 
255
  <!-- Help link -->
 
256
      <th>&nbsp;&nbsp;&nbsp;<a
 
257
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
258
 
 
259
  <!-- Project homepage -->
 
260
      <th class="navbar" align="right" width="100%">
 
261
        <table border="0" cellpadding="0" cellspacing="0">
 
262
          <tr><th class="navbar" align="center"
 
263
            ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
 
264
          </tr></table></th>
 
265
  </tr>
 
266
</table>
 
267
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
268
  <tr>
 
269
    <td align="left" class="footer">
 
270
    Generated by Epydoc 3.0beta1 on Mon Apr 16 16:02:14 2007
 
271
    </td>
 
272
    <td align="right" class="footer">
 
273
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
 
274
    </td>
 
275
  </tr>
 
276
</table>
 
277
 
 
278
<script type="text/javascript">
 
279
  <!--
 
280
  // Private objects are initially displayed (because if
 
281
  // javascript is turned off then we want them to be
 
282
  // visible); but by default, we want to hide them.  So hide
 
283
  // them unless we have a cookie that says to show them.
 
284
  checkCookie()
 
285
  // -->
 
286
</script>
 
287
  
 
288
</body>
 
289
</html>