Location: PHPKode > projects > Aukyla Platform > aukyla/doc/html/a00132.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
  <head>
    <title>Aukyla PHP Framework</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <link rel="StyleSheet" href="auton.css" type="text/css" media="screen">
  </head>

  <body>
    <div id="mainmenu">
      <a href="http://www.auton.nl/" class="home">Home</a>
    </div>
    <div id="submenu">
      <a class="logo" href="http://www.auton.nl/"></a>

      <div class="head">Ads</div>
      <a href="http://sourceforge.net/"><img src="http://sourceforge.net/sflogo.php?group_id=116358&amp;type=1" alt="SourceForge.net Logo" style="padding: 2px 4px; width: 88px; height: 31px; border: 0px"></a>
      <a href="http://getfirefox.com/" title="Get Firefox - The Browser, Reloaded."><img src="http://www.mozilla.org/products/firefox/buttons/getfirefox_small.png" alt="Get Firefox" style="width: 110px; height: 32px; border: 0px"></a>
    </div>
    <div id="main">
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>OpenDocument Class Reference</h1><a href="a00057.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Class with utility functions for working with OpenDocument files. 
<p>

<p>
Definition at line <a class="el" href="a00227.html#l00030">30</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a0">__destruct</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a1">load</a> ($openDocument)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a2">unload</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a3">title</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a4">setTitle</a> ($title)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a5">subject</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a6">setSubject</a> ($subject)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a7">keywords</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a8">setKeywords</a> ($keywords)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a9">comments</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a10">setComments</a> ($comments)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a11">author</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a12">setAuthor</a> ($author)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a13">convertToXHTML</a> ($xhtmlDocument)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a14">scaleImages</a> ($maxWidth, $maxHeight)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a15">temporaryDirectory</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html#a16">setChanged</a> ()</td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a0" doxytag="OpenDocument::__destruct"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::__destruct           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Destructor.<p>
Performs cleanup operations.
<p>
Definition at line <a class="el" href="a00227.html#l00037">37</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a11" doxytag="OpenDocument::author"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::author           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the name of the author of the currently opened OpenDocument file.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The name of the document's author.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html#a12">setAuthor()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00292">292</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a9" doxytag="OpenDocument::comments"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::comments           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns comments about the currently opened OpenDocument file.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The comments about the document as given by the document's author.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html#a10">setComments()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00254">254</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a13" doxytag="OpenDocument::convertToXHTML"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::convertToXHTML           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>xhtmlDocument</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Converts the currently opened OpenDocument file to <a class="el" href="a00169.html">XHTML</a>.<p>
This function does not modify the original document.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>xhtmlDocument</em>&nbsp;</td><td><a class="el" href="a00163.html">URI</a> to the resulting <a class="el" href="a00169.html">XHTML</a> document.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if the document was successfully converted, <code>false</code> otherwise.</dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00333">333</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.
<p>
References <a class="el" href="a00237.html#l01038">URI::fileExists()</a>, <a class="el" href="a00237.html#l00754">URI::mkdir()</a>, and <a class="el" href="a00237.html#l00647">URI::permissions()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a7" doxytag="OpenDocument::keywords"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::keywords           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns some keywords about the currently opened OpenDocument file.<p>
<dl compact><dt><b>Returns:</b></dt><dd>Some keywords about the document as given by the document's author.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html#a8">setKeywords()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00216">216</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a1" doxytag="OpenDocument::load"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::load           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>openDocument</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Loads the specified OpenDocument for use by the other utility functions in this class.<p>
If the document has already been loaded, you will receive a cached reference to it. This reference contains all changes made to the already loaded document, and any changes you make on this reference will reflect on the original and vice versa.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>openDocument</em>&nbsp;</td><td><a class="el" href="a00163.html">URI</a> to the OpenDocument file to load.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if the document was successfully loaded, <code>false</code> otherwise.</dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00059">59</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.
<p>
References <a class="el" href="a00237.html#l00647">URI::permissions()</a>, and <a class="el" href="a00235.html#l00134">String::simplifyPath()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a14" doxytag="OpenDocument::scaleImages"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::scaleImages           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>maxWidth</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>maxHeight</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Scales all images in the currently opened OpenDocument file to a maximum resolution.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>maxWidth</em>&nbsp;</td><td>The maximum width of the images. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>maxHeight</em>&nbsp;</td><td>The maximum height of the images.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> on success, <code>false</code> on error.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This function requires ImageMagick to be installed to be able to work.</dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00419">419</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.
<p>
References <a class="el" href="a00237.html#l00647">URI::permissions()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a12" doxytag="OpenDocument::setAuthor"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::setAuthor           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>author</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets the name of the author of the currently opened OpenDocument file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>author</em>&nbsp;</td><td>The new name to use as the document's author.</td></tr>
  </table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html#a11">author()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00310">310</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a16" doxytag="OpenDocument::setChanged"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::setChanged           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Marks the document as changed so it will be saved when you unload it. Call this function if you have changed the document directly.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html#a2">unload()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00574">574</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.
<p>
References <a class="el" href="a00235.html#l00134">String::simplifyPath()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a10" doxytag="OpenDocument::setComments"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::setComments           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>comments</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets comments about the currently opened OpenDocument file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>comments</em>&nbsp;</td><td>The new comments to set for the document.</td></tr>
  </table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html#a9">comments()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00272">272</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a8" doxytag="OpenDocument::setKeywords"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::setKeywords           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>keywords</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets keywords about the currently opened OpenDocument file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>keywords</em>&nbsp;</td><td>The new keywords to set for the document.</td></tr>
  </table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html#a7">keywords()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00234">234</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a6" doxytag="OpenDocument::setSubject"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::setSubject           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>subject</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets the subject of the currently opened OpenDocument file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>subject</em>&nbsp;</td><td>The new subject to set for the document.</td></tr>
  </table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html#a5">subject()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00196">196</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a4" doxytag="OpenDocument::setTitle"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::setTitle           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>title</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets the title of the currently opened OpenDocument file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>title</em>&nbsp;</td><td>The new title to use for the document.</td></tr>
  </table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html#a3">title()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00158">158</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a5" doxytag="OpenDocument::subject"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::subject           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the subject of the currently opened OpenDocument file.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The subject of the document as given by the document's author.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html#a6">setSubject()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00178">178</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a15" doxytag="OpenDocument::temporaryDirectory"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::temporaryDirectory           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the temporary directory in which you can find the unzipped version of a loaded OpenDocument file.<p>
If you change the contents of the temporary directory, be sure to call <a class="el" href="a00132.html#a16">setChanged()</a> so your changes will be saved.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The path to the temporary directory where the OpenDocument file has been unzipped to, or an empty string if no file was loaded.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html#a16">setChanged()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00478">478</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a3" doxytag="OpenDocument::title"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::title           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the title of the currently opened OpenDocument file.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The title of the document as given by the document's author.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00132.html#a4">setTitle()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00227.html#l00140">140</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a2" doxytag="OpenDocument::unload"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">OpenDocument::unload           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Unloads the loaded OpenDocument file. If the file has been changed, it will be saved automatically. Any cached references to it will become useless and using them after this call will result in undefined behavior.
<p>
Definition at line <a class="el" href="a00227.html#l00120">120</a> of file <a class="el" href="a00227.html">OpenDocument.php</a>.
<p>
References <a class="el" href="a00235.html#l00134">String::simplifyPath()</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00227.html">OpenDocument.php</a></ul>
    </div>
  </body>
</html>
Return current item: Aukyla Platform