Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F100455554
Pyblio.Cite.WP.IWordProcessor-class.html
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Thu, Jan 30, 23:10
Size
14 KB
Mime Type
text/xml
Expires
Sat, Feb 1, 23:10 (1 d, 23 h)
Engine
blob
Format
Raw Data
Handle
23966178
Attached To
R3596 pybliographer
Pyblio.Cite.WP.IWordProcessor-class.html
View Options
<?xml version="1.0" encoding="ascii"?>
<!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" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Pyblio-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>pyblio-core 1.3.4</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Pyblio-module.html">Package Pyblio</a> ::
<a href="Pyblio.Cite-module.html">Package Cite</a> ::
<a href="Pyblio.Cite.WP-module.html">Package WP</a> ::
Class IWordProcessor
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Pyblio.Cite.WP.IWordProcessor-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class IWordProcessor</h1><span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor">source code</a></span><br /><br />
Interface a WordProcessor object should provide<br /><br />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Pyblio.Cite.WP.IWordProcessor-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>)</span><br />
Establish a connection to the word processor.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor.connect">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="disconnect"></a><span class="summary-sig-name">disconnect</span>(<span class="summary-sig-arg">self</span>)</span><br />
Disconnect from the word processor.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor.disconnect">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="is_connected"></a><span class="summary-sig-name">is_connected</span>(<span class="summary-sig-arg">self</span>)</span><br />
Check if the connection is still up.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor.is_connected">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Pyblio.Cite.WP.IWordProcessor-class.html#cite" class="summary-sig-name">cite</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">keys</span>)</span><br />
Insert a list of references at the current position of the
document.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor.cite">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Pyblio.Cite.WP.IWordProcessor-class.html#fetch" class="summary-sig-name">fetch</a>(<span class="summary-sig-arg">self</span>)</span><br />
Retrieve the list of (uid, key) tuples previously inserted in the
current document with self.cite().</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor.fetch">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Pyblio.Cite.WP.IWordProcessor-class.html#update_keys" class="summary-sig-name">update_keys</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">keymap</span>)</span><br />
Update the keys shown to the user.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor.update_keys">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Pyblio.Cite.WP.IWordProcessor-class.html#update_biblio" class="summary-sig-name">update_biblio</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return a generate object ready to accept instructions to rebuild
the current bibliography list.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor.update_biblio">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="connect"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor.connect">source code</a></span>
</td>
</table>
<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 class="fields">
</dl>
</td></tr></table>
</div>
<a name="cite"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">cite</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">keys</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor.cite">source code</a></span>
</td>
</table>
<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 class="fields">
</dl>
</td></tr></table>
</div>
<a name="fetch"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">fetch</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor.fetch">source code</a></span>
</td>
</table>
<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 class="fields">
</dl>
</td></tr></table>
</div>
<a name="update_keys"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">update_keys</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">keymap</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor.update_keys">source code</a></span>
</td>
</table>
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 class="fields">
</dl>
</td></tr></table>
</div>
<a name="update_biblio"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">update_biblio</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Pyblio.Cite.WP-pysrc.html#IWordProcessor.update_biblio">source code</a></span>
</td>
</table>
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">Pyblio.Format.OpenOffice.Generator</a>.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Pyblio-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>pyblio-core 1.3.4</th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Thu Sep 13 21:54:19 2007
</td>
<td align="right" class="footer">
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie()
// -->
</script>
</body>
</html>
Event Timeline
Log In to Comment