twisted.web.woven.interfaces.IModel.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.web.woven.interfaces.IModel</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.web.html">Package web</a> ::
<a href="twisted.web.woven.html">Package woven</a> ::
<a href="twisted.web.woven.interfaces.html">Module interfaces</a> ::
Class IModel
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.web.woven.interfaces.IModel.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IModel</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IModel</b>
</pre><br />
<hr/>
A MVC Model.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IModel.html#addView" class="summary-sig-name"><code>addView</code></a>(<span class=summary-sig-arg>view</span>)</span></code>
<br />
Add a view for the model to keep track of.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IModel.html#getData" class="summary-sig-name"><code>getData</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the raw data contained by this Model object, if it is a
wrapper.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IModel.html#getSubmodel" class="summary-sig-name"><code>getSubmodel</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>submodelName</span>)</span></code>
<br />
Return an IModel implementor for the submodel named
"submodelName".</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IModel.html#lookupSubmodel" class="summary-sig-name"><code>lookupSubmodel</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>submodelPath</span>)</span></code>
<br />
Return an IModel implementor for the given submodel path string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IModel.html#notify" class="summary-sig-name"><code>notify</code></a>(<span class=summary-sig-arg>changed</span>)</span></code>
<br />
Notify all views that something was changed on me.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IModel.html#removeView" class="summary-sig-name"><code>removeView</code></a>(<span class=summary-sig-arg>view</span>)</span></code>
<br />
Remove a view that the model no longer should keep track of.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IModel.html#setData" class="summary-sig-name"><code>setData</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Set the raw data referenced by this Model object, if it is a
wrapper.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IModel.html#setSubmodel" class="summary-sig-name"><code>setSubmodel</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>submodelName</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Set the given data as a submodel of this model.</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="addView"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addView</span>(<span class=sig-arg>view</span>)</span>
</h3>
Add a view for the model to keep track of.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getData"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getData</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the raw data contained by this Model object, if it is a
wrapper. If not, return self.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getSubmodel"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getSubmodel</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>request</span>,
<span class=sig-arg>submodelName</span>)</span>
</h3>
Return an IModel implementor for the submodel named
"submodelName". If this object contains simple data types,
they can be adapted to IModel using model.adaptToIModel(m, parent,
name) before returning.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="lookupSubmodel"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">lookupSubmodel</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>request</span>,
<span class=sig-arg>submodelPath</span>)</span>
</h3>
Return an IModel implementor for the given submodel path string.
This path may be any number of elements separated by /. The default
implementation splits on "/" and calls getSubmodel until the
path is exhausted. You will not normally need to override this
behavior.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="notify"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">notify</span>(<span class=sig-arg>changed</span>=<span class=sig-default>None</span>)</span>
</h3>
Notify all views that something was changed on me. Passing a
dictionary of {'attribute': 'new value'} in changed will pass this
dictionary to the view for increased performance. If you don't want to
do this, don't, and just use the traditional MVC paradigm of querying
the model for things you're interested in.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="removeView"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">removeView</span>(<span class=sig-arg>view</span>)</span>
</h3>
Remove a view that the model no longer should keep track of.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setData"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setData</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>request</span>,
<span class=sig-arg>data</span>)</span>
</h3>
Set the raw data referenced by this Model object, if it is a
wrapper. This is done by telling our Parent model to setSubmodel the
new data. If this object is not a wrapper, keep the data around and
return it for subsequent getData calls.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setSubmodel"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setSubmodel</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>request</span>,
<span class=sig-arg>submodelName</span>,
<span class=sig-arg>data</span>)</span>
</h3>
Set the given data as a submodel of this model. The data need not
implement IModel, since getSubmodel should adapt the data to IModel
before returning it.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:34 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>