diff options
Diffstat (limited to 'translate-toolkit-1.3.0/translate/doc/api/translate.storage.properties.propunit-class.html')
-rw-r--r-- | translate-toolkit-1.3.0/translate/doc/api/translate.storage.properties.propunit-class.html | 778 |
1 files changed, 778 insertions, 0 deletions
diff --git a/translate-toolkit-1.3.0/translate/doc/api/translate.storage.properties.propunit-class.html b/translate-toolkit-1.3.0/translate/doc/api/translate.storage.properties.propunit-class.html new file mode 100644 index 0000000..6d2131a --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/api/translate.storage.properties.propunit-class.html @@ -0,0 +1,778 @@ +<?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>translate.storage.properties.propunit</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"> + + <!-- 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" + ><a class="navbar" target="_top" href="http://translate.sourceforge.net">Translate Toolkit</a></th> + </tr></table></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <span class="breadcrumbs"> + Package translate :: + <a href="translate.storage-module.html">Package storage</a> :: + <a href="translate.storage.properties-module.html">Module properties</a> :: + Class propunit + </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="translate.storage.properties.propunit-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class propunit</h1><p class="nomargin-top"><span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit">source code</a></span></p> +<pre class="base-tree"> + object --+ + | +<a href="translate.storage.base.TranslationUnit-class.html">base.TranslationUnit</a> --+ + | + <strong class="uidshort">propunit</strong> +</pre> + +<hr /> +<p>an element of a properties file i.e. a name and value, and any + comments associated</p> + +<!-- ==================== 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="translate.storage.properties.propunit-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">source</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br /> + construct a blank propunit</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.__init__">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="translate.storage.properties.propunit-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br /> + convert to a string.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.__str__">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="getoutput"></a><span class="summary-sig-name">getoutput</span>(<span class="summary-sig-arg">self</span>)</span><br /> + convert the element back into formatted lines for a .properties file</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.getoutput">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="translate.storage.properties.propunit-class.html#isblank" class="summary-sig-name">isblank</a>(<span class="summary-sig-arg">self</span>)</span><br /> + returns whether this is a blank element, containing only comments...</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.isblank">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code><a href="translate.storage.base.TranslationUnit-class.html">base.TranslationUnit</a></code></b>: + <code><a href="translate.storage.base.TranslationUnit-class.html#__eq__">__eq__</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#getcontext">getcontext</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#getid">getid</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#getunits">getunits</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#hasplural">hasplural</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#isfuzzy">isfuzzy</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#isheader">isheader</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#isreview">isreview</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#istranslatable">istranslatable</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#istranslated">istranslated</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#markfuzzy">markfuzzy</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#markreviewneeded">markreviewneeded</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#merge">merge</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#unit_iter">unit_iter</a></code> + </p> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__delattr__</code>, + <code>__getattribute__</code>, + <code>__hash__</code>, + <code>__new__</code>, + <code>__reduce__</code>, + <code>__reduce_ex__</code>, + <code>__repr__</code>, + <code>__setattr__</code> + </p> + </td> + </tr> +<tr bgcolor="#e8f0f8" > + <th colspan="2" class="group-header" + > Source</th></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="setsource"></a><span class="summary-sig-name">setsource</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">source</span>)</span><br /> + Sets the source AND the target to be equal</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.setsource">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="getsource"></a><span class="summary-sig-name">getsource</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.getsource">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code><a href="translate.storage.base.TranslationUnit-class.html">base.TranslationUnit</a></code></b>: + <code><a href="translate.storage.base.TranslationUnit-class.html#getsourcelanguage">getsourcelanguage</a></code> + </p> + </td> + </tr> +<tr bgcolor="#e8f0f8" > + <th colspan="2" class="group-header" + > Target</th></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="translate.storage.properties.propunit-class.html#settarget" class="summary-sig-name">settarget</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">target</span>)</span><br /> + Note: this also sets the .source attribute!</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.settarget">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="gettarget"></a><span class="summary-sig-name">gettarget</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.gettarget">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code><a href="translate.storage.base.TranslationUnit-class.html">base.TranslationUnit</a></code></b>: + <code><a href="translate.storage.base.TranslationUnit-class.html#gettargetlanguage">gettargetlanguage</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#gettargetlen">gettargetlen</a></code> + </p> + </td> + </tr> +<tr bgcolor="#e8f0f8" > + <th colspan="2" class="group-header" + > Notes</th></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="translate.storage.properties.propunit-class.html#addnote" class="summary-sig-name">addnote</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">note</span>, + <span class="summary-sig-arg">origin</span>=<span class="summary-sig-default">None</span>)</span><br /> + Adds a note (comment).</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.addnote">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="translate.storage.properties.propunit-class.html#getnotes" class="summary-sig-name">getnotes</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">origin</span>=<span class="summary-sig-default">None</span>)</span><br /> + Returns all notes about this unit.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.getnotes">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="translate.storage.properties.propunit-class.html#removenotes" class="summary-sig-name">removenotes</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Remove all the translator's notes.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.removenotes">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr bgcolor="#e8f0f8" > + <th colspan="2" class="group-header" + > Locations</th></tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">List</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="translate.storage.properties.propunit-class.html#getlocations" class="summary-sig-name">getlocations</a>(<span class="summary-sig-arg">self</span>)</span><br /> + A list of source code locations.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.getlocations">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code><a href="translate.storage.base.TranslationUnit-class.html">base.TranslationUnit</a></code></b>: + <code><a href="translate.storage.base.TranslationUnit-class.html#addlocation">addlocation</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#addlocations">addlocations</a></code> + </p> + </td> + </tr> +<tr bgcolor="#e8f0f8" > + <th colspan="2" class="group-header" + > Errors</th></tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code><a href="translate.storage.base.TranslationUnit-class.html">base.TranslationUnit</a></code></b>: + <code><a href="translate.storage.base.TranslationUnit-class.html#adderror">adderror</a></code>, + <code><a href="translate.storage.base.TranslationUnit-class.html#geterrors">geterrors</a></code> + </p> + </td> + </tr> +</table> +<!-- ==================== CLASS METHODS ==================== --> +<a name="section-ClassMethods"></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">Class Methods</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-ClassMethods" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code><a href="translate.storage.base.TranslationUnit-class.html">base.TranslationUnit</a></code></b>: + <code><a href="translate.storage.base.TranslationUnit-class.html#buildfromunit">buildfromunit</a></code> + </p> + </td> + </tr> +</table> +<!-- ==================== PROPERTIES ==================== --> +<a name="section-Properties"></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">Properties</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Properties" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__class__</code> + </p> + </td> + </tr> +<tr bgcolor="#e8f0f8" > + <th colspan="2" class="group-header" + > Source</th></tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <a href="translate.storage.properties.propunit-class.html#source" class="summary-name">source</a> + </td> + </tr> +<tr bgcolor="#e8f0f8" > + <th colspan="2" class="group-header" + > Target</th></tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <a href="translate.storage.properties.propunit-class.html#target" class="summary-name">target</a> + </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="__init__"></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">__init__</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">source</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.__init__">source code</a></span> + </td> + </tr></table> + + <p>construct a blank propunit</p> + <dl class="fields"> + <dt>Overrides: + object.__init__ + </dt> + </dl> +</td></tr></table> +</div> +<a name="settarget"></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">settarget</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">target</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.settarget">source code</a></span> + </td> + </tr></table> + + <p>Note: this also sets the .source attribute!</p> + <dl class="fields"> + <dt>Overrides: + <a href="translate.storage.base.TranslationUnit-class.html#settarget">base.TranslationUnit.settarget</a> + </dt> + </dl> +</td></tr></table> +</div> +<a name="__str__"></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">__str__</span>(<span class="sig-arg">self</span>)</span> + <br /><em class="fname">(Informal representation operator)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.__str__">source code</a></span> + </td> + </tr></table> + + <p>convert to a string. double check that unicode is handled somehow + here</p> + <dl class="fields"> + <dt>Overrides: + object.__str__ + </dt> + </dl> +</td></tr></table> +</div> +<a name="getlocations"></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">getlocations</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.getlocations">source code</a></span> + </td> + </tr></table> + + <p>A list of source code locations.</p> + <dl class="fields"> + <dt>Returns: List</dt> + <dt>Overrides: + <a href="translate.storage.base.TranslationUnit-class.html#getlocations">base.TranslationUnit.getlocations</a> + <dd><em class="note">(inherited documentation)</em></dd> + </dt> + </dl> +</td></tr></table> +</div> +<a name="addnote"></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">addnote</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">note</span>, + <span class="sig-arg">origin</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.addnote">source code</a></span> + </td> + </tr></table> + + <p>Adds a note (comment).</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>text</code></strong> - Usually just a sentence or two.</li> + <li><strong class="pname"><code>origin</code></strong> - Specifies who/where the comment comes from. Origin can be one of + the following text strings: + <ul> + <li> + 'translator' + </li> + <li> + 'developer', 'programmer', 'source code' (synonyms) + </li> + </ul></li> + </ul></dd> + <dt>Overrides: + <a href="translate.storage.base.TranslationUnit-class.html#addnote">base.TranslationUnit.addnote</a> + <dd><em class="note">(inherited documentation)</em></dd> + </dt> + </dl> +</td></tr></table> +</div> +<a name="getnotes"></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">getnotes</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">origin</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.getnotes">source code</a></span> + </td> + </tr></table> + + <p>Returns all notes about this unit.</p> + <p>It will probably be freeform text or something reasonable that can be + synthesised by the format. It should not include location comments (see + <a href="translate.storage.base.TranslationUnit-class.html#getlocations" + class="link">getlocations()</a>).</p> + <dl class="fields"> + <dt>Overrides: + <a href="translate.storage.base.TranslationUnit-class.html#getnotes">base.TranslationUnit.getnotes</a> + <dd><em class="note">(inherited documentation)</em></dd> + </dt> + </dl> +</td></tr></table> +</div> +<a name="removenotes"></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">removenotes</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.removenotes">source code</a></span> + </td> + </tr></table> + + <p>Remove all the translator's notes.</p> + <dl class="fields"> + <dt>Overrides: + <a href="translate.storage.base.TranslationUnit-class.html#removenotes">base.TranslationUnit.removenotes</a> + <dd><em class="note">(inherited documentation)</em></dd> + </dt> + </dl> +</td></tr></table> +</div> +<a name="isblank"></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">isblank</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.properties-pysrc.html#propunit.isblank">source code</a></span> + </td> + </tr></table> + + <p>returns whether this is a blank element, containing only + comments...</p> + <dl class="fields"> + <dt>Overrides: + <a href="translate.storage.base.TranslationUnit-class.html#isblank">base.TranslationUnit.isblank</a> + </dt> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== PROPERTY DETAILS ==================== --> +<a name="section-PropertyDetails"></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">Property Details</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-PropertyDetails" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +</table> +<a name="source"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <h3 class="epydoc">source</h3> + + <dl class="fields"> + <dt>Get Method:</dt> + <dd class="value"><span class="summary-sig"><a href="translate.storage.properties.propunit-class.html#getsource" class="summary-sig-name">getsource</a>(<span class="summary-sig-arg">self</span>)</span> + </dd> + <dt>Set Method:</dt> + <dd class="value"><span class="summary-sig"><a href="translate.storage.properties.propunit-class.html#setsource" class="summary-sig-name">setsource</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">source</span>)</span> + - Sets the source AND the target to be equal + </dd> + </dl> +</td></tr></table> +</div> +<a name="target"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <h3 class="epydoc">target</h3> + + <dl class="fields"> + <dt>Get Method:</dt> + <dd class="value"><span class="summary-sig"><a href="translate.storage.properties.propunit-class.html#gettarget" class="summary-sig-name">gettarget</a>(<span class="summary-sig-arg">self</span>)</span> + </dd> + <dt>Set Method:</dt> + <dd class="value"><span class="summary-sig"><a href="translate.storage.properties.propunit-class.html#settarget" class="summary-sig-name">settarget</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">target</span>)</span> + - Note: this also sets the .source attribute! + </dd> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + + <!-- 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" + ><a class="navbar" target="_top" href="http://translate.sourceforge.net">Translate Toolkit</a></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.0.1 on Tue Sep 23 13:50:56 2008 + </td> + <td align="right" class="footer"> + <a target="mainFrame" 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> |