diff options
Diffstat (limited to 'doc/Axlsx/App.html')
| -rw-r--r-- | doc/Axlsx/App.html | 2640 |
1 files changed, 2640 insertions, 0 deletions
diff --git a/doc/Axlsx/App.html b/doc/Axlsx/App.html new file mode 100644 index 00000000..c4f9169c --- /dev/null +++ b/doc/Axlsx/App.html @@ -0,0 +1,2640 @@ +<!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" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Class: Axlsx::App + + — Documentation by YARD 0.7.3 + +</title> + + <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + relpath = '..'; + if (relpath != '') relpath += '/'; +</script> + + <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> + + + </head> + <body> + <script type="text/javascript" charset="utf-8"> + if (window.top.frames.main) document.body.className = 'frames'; + </script> + + <div id="header"> + <div id="menu"> + + <a href="../_index.html">Index (A)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">App</span> + + + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> + + <div id="search"> + + <a id="class_list_link" href="#">Class List</a> + + <a id="method_list_link" href="#">Method List</a> + + <a id="file_list_link" href="#">File List</a> + +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Class: Axlsx::App + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Axlsx::App</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/doc_props/app.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +Support is not implemented for the following complex types: +</p> +<p> +HeadingPairs (VectorVariant), TitlesOfParts (VectorLpstr), HLinks +(VectorVariant), DigSig (DigSigBlob) +</p> +</div> + </div> + +<p> +App represents the app.xml document. The attributes for this object are +primarily managed by the application the end user uses to edit the +document. None of the attributes are required to serialize a valid xlsx +object. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li>shared-documentPropertiesExtendedshared-documentPropertiesExtended.xsd</li> + + </ul> + +</div> + + <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#Application-instance_method" title="#Application (instance method)">- (String) <strong>Application</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The name of the application. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#AppVersion-instance_method" title="#AppVersion (instance method)">- (String) <strong>AppVersion</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The version of the application. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Characters-instance_method" title="#Characters (instance method)">- (Integer) <strong>Characters</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of characters in the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#CharactersWithSpaces-instance_method" title="#CharactersWithSpaces (instance method)">- (Integer) <strong>CharactersWithSpaces</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of characters in the document including spaces. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Company-instance_method" title="#Company (instance method)">- (String) <strong>Company</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The name of the company generating the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#DocSecurity-instance_method" title="#DocSecurity (instance method)">- (Integer) <strong>DocSecurity</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Document security. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#HiddenSlides-instance_method" title="#HiddenSlides (instance method)">- (Integer) <strong>HiddenSlides</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of hidden slides. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#HyperLinkBase-instance_method" title="#HyperLinkBase (instance method)">- (String) <strong>HyperLinkBase</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The base for hyper links in the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#HyperlinksChanged-instance_method" title="#HyperlinksChanged (instance method)">- (Boolean) <strong>HyperlinksChanged</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates that the hyper links in the document have been changed. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Lines-instance_method" title="#Lines (instance method)">- (Integer) <strong>Lines</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of lines in the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#LinksUpToDate-instance_method" title="#LinksUpToDate (instance method)">- (Boolean) <strong>LinksUpToDate</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The links in the document are up to date. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Manager-instance_method" title="#Manager (instance method)">- (String) <strong>Manager</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The name of the manager for the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#MMClips-instance_method" title="#MMClips (instance method)">- (Integer) <strong>MMClips</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The total number multimedia clips. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Notes-instance_method" title="#Notes (instance method)">- (Integer) <strong>Notes</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of slides that have notes. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Pages-instance_method" title="#Pages (instance method)">- (Integer) <strong>Pages</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of pages in the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Paragraphs-instance_method" title="#Paragraphs (instance method)">- (Integer) <strong>Paragraphs</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of paragraphs in the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#PresentationFormat-instance_method" title="#PresentationFormat (instance method)">- (String) <strong>PresentationFormat</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The intended format of the presentation. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#ScaleCrop-instance_method" title="#ScaleCrop (instance method)">- (Boolean) <strong>ScaleCrop</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The display mode for the document thumbnail. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#ShareDoc-instance_method" title="#ShareDoc (instance method)">- (Boolean) <strong>ShareDoc</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates if the document is shared. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Slides-instance_method" title="#Slides (instance method)">- (Intger) <strong>Slides</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of slides in the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Template-instance_method" title="#Template (instance method)">- (String) <strong>Template</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The name of the document template. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#TotalTime-instance_method" title="#TotalTime (instance method)">- (Integer) <strong>TotalTime</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The total amount of time spent editing. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Words-instance_method" title="#Words (instance method)">- (Integer) <strong>Words</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of words in the document. +</p> +</div></span> + +</li> + + + </ul> + + + + + + <h2> + Instance Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#initalize-instance_method" title="#initalize (instance method)">- (Object) <strong>initalize</strong>(options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates an App object. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Generate an app.xml document. +</p> +</div></span> + +</li> + + + </ul> + + + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="Application=-instance_method"></span> + <span id="Application-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="Application-instance_method"> + + - (<tt>String</tt>) <strong>Application</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The name of the application +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The name of the application +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +74 +75 +76</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 74</span> + +<span class='def def kw'>def</span> <span class='Application constant id'>Application</span> + <span class='@Application ivar id'>@Application</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="AppVersion=-instance_method"></span> + <span id="AppVersion-instance_method"></span> + <div class="method_details "> + <p class="signature " id="AppVersion-instance_method"> + + - (<tt>String</tt>) <strong>AppVersion</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The version of the application. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The version of the application. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +77 +78 +79</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 77</span> + +<span class='def def kw'>def</span> <span class='AppVersion constant id'>AppVersion</span> + <span class='@AppVersion ivar id'>@AppVersion</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Characters=-instance_method"></span> + <span id="Characters-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Characters-instance_method"> + + - (<tt>Integer</tt>) <strong>Characters</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of characters in the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of characters in the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +29 +30 +31</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 29</span> + +<span class='def def kw'>def</span> <span class='Characters constant id'>Characters</span> + <span class='@Characters ivar id'>@Characters</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="CharactersWithSpaces=-instance_method"></span> + <span id="CharactersWithSpaces-instance_method"></span> + <div class="method_details "> + <p class="signature " id="CharactersWithSpaces-instance_method"> + + - (<tt>Integer</tt>) <strong>CharactersWithSpaces</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of characters in the document including spaces. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of characters in the document including spaces. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +62 +63 +64</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 62</span> + +<span class='def def kw'>def</span> <span class='CharactersWithSpaces constant id'>CharactersWithSpaces</span> + <span class='@CharactersWithSpaces ivar id'>@CharactersWithSpaces</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Company=-instance_method"></span> + <span id="Company-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Company-instance_method"> + + - (<tt>String</tt>) <strong>Company</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The name of the company generating the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The name of the company generating the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +20 +21 +22</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 20</span> + +<span class='def def kw'>def</span> <span class='Company constant id'>Company</span> + <span class='@Company ivar id'>@Company</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="DocSecurity=-instance_method"></span> + <span id="DocSecurity-instance_method"></span> + <div class="method_details "> + <p class="signature " id="DocSecurity-instance_method"> + + - (<tt>Integer</tt>) <strong>DocSecurity</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Document security +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +Document security +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +80 +81 +82</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 80</span> + +<span class='def def kw'>def</span> <span class='DocSecurity constant id'>DocSecurity</span> + <span class='@DocSecurity ivar id'>@DocSecurity</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="HiddenSlides=-instance_method"></span> + <span id="HiddenSlides-instance_method"></span> + <div class="method_details "> + <p class="signature " id="HiddenSlides-instance_method"> + + - (<tt>Integer</tt>) <strong>HiddenSlides</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of hidden slides. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of hidden slides. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +50 +51 +52</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 50</span> + +<span class='def def kw'>def</span> <span class='HiddenSlides constant id'>HiddenSlides</span> + <span class='@HiddenSlides ivar id'>@HiddenSlides</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="HyperLinkBase=-instance_method"></span> + <span id="HyperLinkBase-instance_method"></span> + <div class="method_details "> + <p class="signature " id="HyperLinkBase-instance_method"> + + - (<tt>String</tt>) <strong>HyperLinkBase</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The base for hyper links in the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The base for hyper links in the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +68 +69 +70</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 68</span> + +<span class='def def kw'>def</span> <span class='HyperLinkBase constant id'>HyperLinkBase</span> + <span class='@HyperLinkBase ivar id'>@HyperLinkBase</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="HyperlinksChanged=-instance_method"></span> + <span id="HyperlinksChanged-instance_method"></span> + <div class="method_details "> + <p class="signature " id="HyperlinksChanged-instance_method"> + + - (<tt>Boolean</tt>) <strong>HyperlinksChanged</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates that the hyper links in the document have been changed. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +Indicates that the hyper links in the document have been changed. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +71 +72 +73</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 71</span> + +<span class='def def kw'>def</span> <span class='HyperlinksChanged constant id'>HyperlinksChanged</span> + <span class='@HyperlinksChanged ivar id'>@HyperlinksChanged</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Lines=-instance_method"></span> + <span id="Lines-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Lines-instance_method"> + + - (<tt>Integer</tt>) <strong>Lines</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of lines in the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of lines in the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +35 +36 +37</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 35</span> + +<span class='def def kw'>def</span> <span class='Lines constant id'>Lines</span> + <span class='@Lines ivar id'>@Lines</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="LinksUpToDate=-instance_method"></span> + <span id="LinksUpToDate-instance_method"></span> + <div class="method_details "> + <p class="signature " id="LinksUpToDate-instance_method"> + + - (<tt>Boolean</tt>) <strong>LinksUpToDate</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The links in the document are up to date. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +The links in the document are up to date. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +59 +60 +61</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 59</span> + +<span class='def def kw'>def</span> <span class='LinksUpToDate constant id'>LinksUpToDate</span> + <span class='@LinksUpToDate ivar id'>@LinksUpToDate</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Manager=-instance_method"></span> + <span id="Manager-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Manager-instance_method"> + + - (<tt>String</tt>) <strong>Manager</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The name of the manager for the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The name of the manager for the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +17 +18 +19</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 17</span> + +<span class='def def kw'>def</span> <span class='Manager constant id'>Manager</span> + <span class='@Manager ivar id'>@Manager</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="MMClips=-instance_method"></span> + <span id="MMClips-instance_method"></span> + <div class="method_details "> + <p class="signature " id="MMClips-instance_method"> + + - (<tt>Integer</tt>) <strong>MMClips</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The total number multimedia clips +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The total number multimedia clips +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +53 +54 +55</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 53</span> + +<span class='def def kw'>def</span> <span class='MMClips constant id'>MMClips</span> + <span class='@MMClips ivar id'>@MMClips</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Notes=-instance_method"></span> + <span id="Notes-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Notes-instance_method"> + + - (<tt>Integer</tt>) <strong>Notes</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of slides that have notes. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of slides that have notes. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +44 +45 +46</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 44</span> + +<span class='def def kw'>def</span> <span class='Notes constant id'>Notes</span> + <span class='@Notes ivar id'>@Notes</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Pages=-instance_method"></span> + <span id="Pages-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Pages-instance_method"> + + - (<tt>Integer</tt>) <strong>Pages</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of pages in the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of pages in the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +23 +24 +25</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 23</span> + +<span class='def def kw'>def</span> <span class='Pages constant id'>Pages</span> + <span class='@Pages ivar id'>@Pages</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Paragraphs=-instance_method"></span> + <span id="Paragraphs-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Paragraphs-instance_method"> + + - (<tt>Integer</tt>) <strong>Paragraphs</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of paragraphs in the document +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of paragraphs in the document +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +38 +39 +40</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 38</span> + +<span class='def def kw'>def</span> <span class='Paragraphs constant id'>Paragraphs</span> + <span class='@Paragraphs ivar id'>@Paragraphs</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="PresentationFormat=-instance_method"></span> + <span id="PresentationFormat-instance_method"></span> + <div class="method_details "> + <p class="signature " id="PresentationFormat-instance_method"> + + - (<tt>String</tt>) <strong>PresentationFormat</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The intended format of the presentation. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The intended format of the presentation. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +32 +33 +34</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 32</span> + +<span class='def def kw'>def</span> <span class='PresentationFormat constant id'>PresentationFormat</span> + <span class='@PresentationFormat ivar id'>@PresentationFormat</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="ScaleCrop=-instance_method"></span> + <span id="ScaleCrop-instance_method"></span> + <div class="method_details "> + <p class="signature " id="ScaleCrop-instance_method"> + + - (<tt>Boolean</tt>) <strong>ScaleCrop</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The display mode for the document thumbnail. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +The display mode for the document thumbnail. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +56 +57 +58</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 56</span> + +<span class='def def kw'>def</span> <span class='ScaleCrop constant id'>ScaleCrop</span> + <span class='@ScaleCrop ivar id'>@ScaleCrop</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="ShareDoc=-instance_method"></span> + <span id="ShareDoc-instance_method"></span> + <div class="method_details "> + <p class="signature " id="ShareDoc-instance_method"> + + - (<tt>Boolean</tt>) <strong>ShareDoc</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates if the document is shared. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +Indicates if the document is shared. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +65 +66 +67</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 65</span> + +<span class='def def kw'>def</span> <span class='ShareDoc constant id'>ShareDoc</span> + <span class='@ShareDoc ivar id'>@ShareDoc</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Slides=-instance_method"></span> + <span id="Slides-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Slides-instance_method"> + + - (<tt>Intger</tt>) <strong>Slides</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of slides in the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Intger</tt>)</span> + + + + — + <div class='inline'><p> +The number of slides in the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +41 +42 +43</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 41</span> + +<span class='def def kw'>def</span> <span class='Slides constant id'>Slides</span> + <span class='@Slides ivar id'>@Slides</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Template=-instance_method"></span> + <span id="Template-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Template-instance_method"> + + - (<tt>String</tt>) <strong>Template</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The name of the document template. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The name of the document template. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +14 +15 +16</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 14</span> + +<span class='def def kw'>def</span> <span class='Template constant id'>Template</span> + <span class='@Template ivar id'>@Template</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="TotalTime=-instance_method"></span> + <span id="TotalTime-instance_method"></span> + <div class="method_details "> + <p class="signature " id="TotalTime-instance_method"> + + - (<tt>Integer</tt>) <strong>TotalTime</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The total amount of time spent editing. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The total amount of time spent editing. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +47 +48 +49</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 47</span> + +<span class='def def kw'>def</span> <span class='TotalTime constant id'>TotalTime</span> + <span class='@TotalTime ivar id'>@TotalTime</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Words=-instance_method"></span> + <span id="Words-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Words-instance_method"> + + - (<tt>Integer</tt>) <strong>Words</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of words in the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of words in the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +26 +27 +28</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 26</span> + +<span class='def def kw'>def</span> <span class='Words constant id'>Words</span> + <span class='@Words ivar id'>@Words</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + + + <div id="instance_method_details" class="method_details_list"> + <h2>Instance Method Details</h2> + + + <div class="method_details first"> + <p class="signature first" id="initalize-instance_method"> + + - (<tt>Object</tt>) <strong>initalize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates an App object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>options</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + <em class="default">(defaults to: <tt>{}</tt>)</em> + + + — + <div class='inline'><p> +a customizable set of options +</p> +</div> + + </li> + +</ul> + + + + + <h3>Options Hash (<tt>options</tt>):</h3> + <ul class="option"> + + <li> + <span class="name">Template</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Manager</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Pages</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Words</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Characters</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">PresentationFormat</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Lines</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Paragraphs</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Slides</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Notes</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">TotalTime</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">HiddenSlides</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">MMClips</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">ScaleCrop</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">LinksUpToDate</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">CharactersWithSpaces</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">ShareDoc</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">HyperLinkBase</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">HyperlinksChanged</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Application</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">AppVersion</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">DocSecurity</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +105 +106 +107 +108 +109</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 105</span> + +<span class='def def kw'>def</span> <span class='initalize identifier id'>initalize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="to_xml-instance_method"> + + - (<tt>String</tt>) <strong>to_xml</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Generate an app.xml document +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The document as a string +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +137 +138 +139 +140 +141 +142 +143 +144 +145 +146</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 137</span> + +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='symbol val'>:Properties</span><span class='comma token'>,</span> <span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='APP_NS constant id'>APP_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:vt'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='APP_NS_VT constant id'>APP_NS_VT</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"ap:#{name}"</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:55 2011 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.7.3 (ruby-1.8.7). +</div> + + </body> +</html>
\ No newline at end of file |