/usr/share/doc/python-djvu-doc/html/files.html is in python-djvu-doc 0.7-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Document files — python-djvulibre 0.7 documentation</title>
<link rel="stylesheet" href="_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="python-djvulibre 0.7 documentation" href="index.html" />
<link rel="next" title="Document outline" href="outline.html" />
<link rel="prev" title="Geometry and colors" href="geometry.html" />
</head>
<body role="document">
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
<span>python-djvulibre 0.7 documentation</span></a></h1>
<h2 class="heading"><span>Document files</span></h2>
</div>
<div class="topnav" role="navigation" aria-label="top navigation">
<p>
«  <a href="geometry.html">Geometry and colors</a>
  ::  
<a class="uplink" href="index.html">Contents</a>
  ::  
<a href="outline.html">Document outline</a>  »
</p>
</div>
<div class="content">
<div class="section" id="document-files">
<h1>Document files<a class="headerlink" href="#document-files" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="djvu.decode.DocumentFiles">
<em class="property">class </em><code class="descclassname">djvu.decode.</code><code class="descname">DocumentFiles</code><a class="headerlink" href="#djvu.decode.DocumentFiles" title="Permalink to this definition">¶</a></dt>
<dd><p>Component files of a document.</p>
<p>Use <a class="reference internal" href="documents.html#djvu.decode.Document.files" title="djvu.decode.Document.files"><code class="xref py py-attr docutils literal"><span class="pre">Document.files</span></code></a> to obtain instances of this class.</p>
<p>File indexing is zero-based, i.e. <a class="reference internal" href="documents.html#djvu.decode.Document.files" title="djvu.decode.Document.files"><code class="xref py py-attr docutils literal"><span class="pre">files</span></code></a><code class="docutils literal"><span class="pre">[0]</span></code> stands for the very first file.</p>
<p><code class="docutils literal"><span class="pre">len(files)</span></code> might raise <a class="reference internal" href="exceptions.html#djvu.decode.NotAvailable" title="djvu.decode.NotAvailable"><code class="xref py py-exc docutils literal"><span class="pre">NotAvailable</span></code></a> when called before receiving
a <a class="reference internal" href="messages.html#djvu.decode.DocInfoMessage" title="djvu.decode.DocInfoMessage"><code class="xref py py-class docutils literal"><span class="pre">DocInfoMessage</span></code></a>.</p>
</dd></dl>
<dl class="class">
<dt id="djvu.decode.File">
<em class="property">class </em><code class="descclassname">djvu.decode.</code><code class="descname">File</code><a class="headerlink" href="#djvu.decode.File" title="Permalink to this definition">¶</a></dt>
<dd><p>Component file of a document.</p>
<p>Use <a class="reference internal" href="documents.html#djvu.decode.Document.files" title="djvu.decode.Document.files"><code class="xref py py-attr docutils literal"><span class="pre">Document.files</span></code></a><code class="docutils literal"><span class="pre">[N]</span></code> to obtain instances of this class.</p>
<dl class="attribute">
<dt id="djvu.decode.File.document">
<code class="descname">document</code><a class="headerlink" href="#djvu.decode.File.document" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="documents.html#djvu.decode.Document" title="djvu.decode.Document"><code class="xref py py-class docutils literal"><span class="pre">Document</span></code></a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="djvu.decode.File.n">
<code class="descname">n</code><a class="headerlink" href="#djvu.decode.File.n" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the component file number.</td>
</tr>
</tbody>
</table>
<p>File indexing is zero-based, i.e. 0 stands for the very first file.</p>
</dd></dl>
<dl class="method">
<dt id="djvu.decode.File.get_info">
<code class="descname">get_info</code><span class="sig-paren">(</span><span class="optional">[</span><em>wait=1</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#djvu.decode.File.get_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Attempt to obtain information about the component file.</p>
<p>If <cite>wait</cite> is true, wait until the information is available.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>NotAvailable</strong> – if the information is not available.</li>
<li><strong>JobFailed</strong> – on failure.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="djvu.decode.File.type">
<code class="descname">type</code><a class="headerlink" href="#djvu.decode.File.type" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the type of the compound file.</td>
</tr>
</tbody>
</table>
<p>The following types are possible:</p>
<blockquote>
<div><dl class="data">
<dt id="djvu.decode.File.FILE_TYPE_PAGE">
<code class="descname">FILE_TYPE_PAGE</code><a class="headerlink" href="#djvu.decode.File.FILE_TYPE_PAGE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="djvu.decode.File.FILE_TYPE_THUMBNAILS">
<code class="descname">FILE_TYPE_THUMBNAILS</code><a class="headerlink" href="#djvu.decode.File.FILE_TYPE_THUMBNAILS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="djvu.decode.File.FILE_TYPE_INCLUDE">
<code class="descname">FILE_TYPE_INCLUDE</code><a class="headerlink" href="#djvu.decode.File.FILE_TYPE_INCLUDE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>NotAvailable</strong> – see <a class="reference internal" href="#djvu.decode.File.get_info" title="djvu.decode.File.get_info"><code class="xref py py-meth docutils literal"><span class="pre">get_info()</span></code></a>.</li>
<li><strong>JobFailed</strong> – on failure.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="djvu.decode.File.n_page">
<code class="descname">n_page</code><a class="headerlink" href="#djvu.decode.File.n_page" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the page number, or <code class="docutils literal"><span class="pre">None</span></code> when not applicable.</td>
</tr>
</tbody>
</table>
<p>Page indexing is zero-based, i.e. 0 stands for the very first page.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>NotAvailable</strong> – see <a class="reference internal" href="#djvu.decode.File.get_info" title="djvu.decode.File.get_info"><code class="xref py py-meth docutils literal"><span class="pre">get_info()</span></code></a>.</li>
<li><strong>JobFailed</strong> – on failure.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="djvu.decode.File.page">
<code class="descname">page</code><a class="headerlink" href="#djvu.decode.File.page" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the page, or <code class="docutils literal"><span class="pre">None</span></code> when not applicable.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>NotAvailable</strong> – see <a class="reference internal" href="#djvu.decode.File.get_info" title="djvu.decode.File.get_info"><code class="xref py py-meth docutils literal"><span class="pre">get_info()</span></code></a>.</li>
<li><strong>JobFailed</strong> – on failure.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="djvu.decode.File.size">
<code class="descname">size</code><a class="headerlink" href="#djvu.decode.File.size" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the compound file size, or <code class="docutils literal"><span class="pre">None</span></code> when unknown.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>NotAvailable</strong> – see <a class="reference internal" href="#djvu.decode.File.get_info" title="djvu.decode.File.get_info"><code class="xref py py-meth docutils literal"><span class="pre">get_info()</span></code></a>.</li>
<li><strong>JobFailed</strong> – on failure.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="djvu.decode.File.id">
<code class="descname">id</code><a class="headerlink" href="#djvu.decode.File.id" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the compound file identifier, or <code class="docutils literal"><span class="pre">None</span></code>.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>NotAvailable</strong> – see <a class="reference internal" href="#djvu.decode.File.get_info" title="djvu.decode.File.get_info"><code class="xref py py-meth docutils literal"><span class="pre">get_info()</span></code></a>.</li>
<li><strong>JobFailed</strong> – on failure.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="djvu.decode.File.name">
<code class="descname">name</code><a class="headerlink" href="#djvu.decode.File.name" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the compound file name, or <code class="docutils literal"><span class="pre">None</span></code>.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>NotAvailable</strong> – see <a class="reference internal" href="#djvu.decode.File.get_info" title="djvu.decode.File.get_info"><code class="xref py py-meth docutils literal"><span class="pre">get_info()</span></code></a>.</li>
<li><strong>JobFailed</strong> – on failure.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="djvu.decode.File.title">
<code class="descname">title</code><a class="headerlink" href="#djvu.decode.File.title" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the compound file title, or <code class="docutils literal"><span class="pre">None</span></code>.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>NotAvailable</strong> – see <a class="reference internal" href="#djvu.decode.File.get_info" title="djvu.decode.File.get_info"><code class="xref py py-meth docutils literal"><span class="pre">get_info()</span></code></a>.</li>
<li><strong>JobFailed</strong> – on failure.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="djvu.decode.File.dump">
<code class="descname">dump</code><a class="headerlink" href="#djvu.decode.File.dump" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a text describing the contents of the file using the same format as
the <code class="docutils literal"><span class="pre">djvudump</span></code> command.</td>
</tr>
</tbody>
</table>
<p>If the information is not available, raise <a class="reference internal" href="exceptions.html#djvu.decode.NotAvailable" title="djvu.decode.NotAvailable"><code class="xref py py-exc docutils literal"><span class="pre">NotAvailable</span></code></a> exception.
Then, <a class="reference internal" href="messages.html#djvu.decode.PageInfoMessage" title="djvu.decode.PageInfoMessage"><code class="xref py py-exc docutils literal"><span class="pre">PageInfoMessage</span></code></a> messages with empty
<a class="reference internal" href="messages.html#djvu.decode.Message.page_job" title="djvu.decode.Message.page_job"><code class="xref py py-attr docutils literal"><span class="pre">page_job</span></code></a> may be emitted.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>NotAvailable</strong> – see above.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
<p>
«  <a href="geometry.html">Geometry and colors</a>
  ::  
<a class="uplink" href="index.html">Contents</a>
  ::  
<a href="outline.html">Document outline</a>  »
</p>
</div>
<div class="footer" role="contentinfo">
© Copyright 2007-2015 Jakub Wilk <jwilk@jwilk.net>.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.4.
</div>
</body>
</html>
|