Page MenuHomec4science
Files F123588730

Pyblio.Cite.WP.IWordProcessor-class.html
No OneTemporary
Actions

File Metadata

Created
Mon, Jul 28, 13:08

Pyblio.Cite.WP.IWordProcessor-class.html
View Options

<?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>Pyblio.Cite.WP.IWordProcessor</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="Pyblio-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
pybliographer&nbsp;1.3.3
</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="Pyblio-module.html">Package&nbsp;Pyblio</a> ::
<a href="Pyblio.Cite-module.html">Package&nbsp;Cite</a> ::
<a href="Pyblio.Cite.WP-module.html">Package&nbsp;WP</a> ::
Class&nbsp;IWordProcessor
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="../private/Pyblio.Cite.WP.IWordProcessor-class.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="Pyblio.Cite.WP.IWordProcessor-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IWordProcessor</h2>
<hr/>
Interface a WordProcessor object should provide
<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">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Cite.WP.IWordProcessor-class.html#cite" class="summary-sig-name"><code>cite</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>keys</span>)</span></code>
<br />
Insert a list of references at the current position of the
document.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Cite.WP.IWordProcessor-class.html#connect" class="summary-sig-name"><code>connect</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Establish a connection to the word processor.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Cite.WP.IWordProcessor-class.html#disconnect" class="summary-sig-name"><code>disconnect</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Disconnect from the word processor.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Cite.WP.IWordProcessor-class.html#fetch" class="summary-sig-name"><code>fetch</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Retrieve the list of (uid, key) tuples previously inserted in the
current document with self.cite().</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Cite.WP.IWordProcessor-class.html#is_connected" class="summary-sig-name"><code>is_connected</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Check if the connection is still up.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Cite.WP.IWordProcessor-class.html#update_biblio" class="summary-sig-name"><code>update_biblio</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a generate object ready to accept instructions to rebuild the
current bibliography list.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Cite.WP.IWordProcessor-class.html#update_keys" class="summary-sig-name"><code>update_keys</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>keymap</span>)</span></code>
<br />
Update the keys shown to the user.</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="cite"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">cite</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>keys</span>)</span>
</h3>
<p>Insert a list of references at the current position of the
document.</p>
keys is a list of tuples (uid, key) where uid is the identifier of
the record in the database, and key is the key to be shown to the
user.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="connect"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">connect</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Establish a connection to the word processor.</p>
This binds this object to a specific document in the word processor.
No other operation except is_connected can take place before
connection.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="disconnect"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">disconnect</span>(<span class=sig-arg>self</span>)</span>
</h3>
Disconnect from the word processor.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="fetch"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetch</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Retrieve the list of (uid, key) tuples previously inserted in the
current document with self.cite().</p>
<p>The tuples are ordered according to the position of the references
in the text.</p>
If the WP does not support this operation, returns None (not
[]).
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="is_connected"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">is_connected</span>(<span class=sig-arg>self</span>)</span>
</h3>
Check if the connection is still up.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="update_biblio"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">update_biblio</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return a generate object ready to accept instructions to rebuild the
current bibliography list. An example of such a generator is provided
by <a href="Pyblio.Format.OpenOffice.Generator-class.html"
class="link"><code>Pyblio.Format.OpenOffice.Generator</code></a>.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="update_keys"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">update_keys</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>keymap</span>)</span>
</h3>
Update the keys shown to the user. keymap is a dictionary that
provides, for each uid having changed, the new key to be displayed.
<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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="Pyblio-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
pybliographer&nbsp;1.3.3
</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.1 on Sun Sep 24 23:52:43 2006</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>

Event Timeline

c4science · Help