diff options
| author | Randy Morgan <[email protected]> | 2011-12-01 14:11:42 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-12-01 14:11:42 +0900 |
| commit | 8cf0296bbc16e8eb535e9af932eed2557d5e66d2 (patch) | |
| tree | 9c5a214c0ac49b56d08be769fbe0634ac1e5b0a4 /doc/Axlsx/Package.html | |
| parent | 076be316935180341d7ee7a9335281a4b18d1fa9 (diff) | |
| download | caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.tar.gz caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.zip | |
removing generated yard docs from repository
Diffstat (limited to 'doc/Axlsx/Package.html')
| -rw-r--r-- | doc/Axlsx/Package.html | 885 |
1 files changed, 0 insertions, 885 deletions
diff --git a/doc/Axlsx/Package.html b/doc/Axlsx/Package.html deleted file mode 100644 index 29c1b79f..00000000 --- a/doc/Axlsx/Package.html +++ /dev/null @@ -1,885 +0,0 @@ -<!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::Package - - — AXLSX - -</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 (P)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Package</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::Package - - - -</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::Package</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/package.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>Package is responsible for managing all the bits and peices that Open -Office XML requires to make a valid xlsx document including valdation and -serialization.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - <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="#initialize-instance_method" title="#initialize (instance method)">- (Package) <strong>initialize</strong>(options = {}) {|_self| ... }</a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Initializes your package.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#ruport_table-instance_method" title="#ruport_table (instance method)">- (Object) <strong>ruport_table</strong>(table) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Accepts a ruport table for serialization to xlsx.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#serialize-instance_method" title="#serialize (instance method)">- (Boolean) <strong>serialize</strong>(output, confirm_valid = false) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serialize your workbook to disk as an xlsx document.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#validate-instance_method" title="#validate (instance method)">- (Array) <strong>validate</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Validate all parts of the package against xsd schema.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> {|@workbook| ... }</a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The workbook this package will serialize or validate.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#workbook%3D-instance_method" title="#workbook= (instance method)">- (Object) <strong>workbook=</strong>(workbook) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'></div></span> - -</li> - - - </ul> - - -<div id="constructor_details" class="method_details_list"> - <h2>Constructor Details</h2> - - <div class="method_details first"> - <p class="signature first" id="initialize-instance_method"> - - - (<tt><span class='object_link'><a href="" title="Axlsx::Package (class)">Package</a></span></tt>) <strong>initialize</strong>(options = {}) {|_self| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Initializes your package</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <h3>Examples:</h3> - - <h4><div class='inline'> -<p>Package.new :author => ‘you!’, :workbook => Workbook.new</p> -</div></h4> - <pre class="example code"> -</pre> - - </div> -<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 hash that you can use to specify the author and workbook for this -package.</p> -</div> - - </li> - -</ul> - - - - - <h3>Options Hash (<tt>options</tt>):</h3> - <ul class="option"> - - <li> - <span class="name">:author</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The author of the document</p> -</div> - </li> - - </ul> - - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>_self</tt>)</span> - - - - </li> - -</ul> -<h3>Yield Parameters:</h3> -<ul class="yieldparam"> - - <li> - - <span class='name'>_self</span> - - - <span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Package (class)">Axlsx::Package</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>the object that the method was called on</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -12 -13 -14 -15 -16 -17</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 12</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</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='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> - <span class='@core ivar id'>@core</span><span class='comma token'>,</span> <span class='@app ivar id'>@app</span> <span class='assign token'>=</span> <span class='Core constant id'>Core</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='comma token'>,</span> <span class='App constant id'>App</span><span class='dot token'>.</span><span class='new identifier id'>new</span> - <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:author</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> - <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</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="ruport_table-instance_method"> - - - (<tt>Object</tt>) <strong>ruport_table</strong>(table) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Accepts a ruport table for serialization to xlsx</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>table</span> - - - <span class='type'>(<tt>Table</tt>)</span> - - - - — - <div class='inline'> -<p>a ruport Table object</p> -</div> - - </li> - -</ul> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -21 -22 -23</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 21</span> - -<span class='def def kw'>def</span> <span class='ruport_table identifier id'>ruport_table</span><span class='lparen token'>(</span><span class='table identifier id'>table</span><span class='rparen token'>)</span> - <span class='puts identifier id'>puts</span> <span class='table identifier id'>table</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="serialize-instance_method"> - - - (<tt>Boolean</tt>) <strong>serialize</strong>(output, confirm_valid = false) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>A tremendous amount of effort has gone into ensuring that you cannot create -invalid xlsx documents. confirm_valid should be used in the rare case that -you cannot open the serialized file.</p> -</div> - </div> - - -<p>Serialize your workbook to disk as an xlsx document.</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <h3>Examples:</h3> - - <h4><div class='inline'></div></h4> - <pre class="example code"><span class='comment val'># This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.</span> -<span class='comment val'># Take a look at the README for an example of how to do it!</span> -<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'test.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span> -<span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span> - -<span class='comment val'># You will find a file called test.xlsx</span> -</pre> - - </div> -<h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>output</span> - - - <span class='type'>(<tt>File</tt>)</span> - - - - — - <div class='inline'> -<p>The file you want to serialize your package to</p> -</div> - - </li> - - <li> - - <span class='name'>confirm_valid</span> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - <em class="default">(defaults to: <tt>false</tt>)</em> - - - — - <div class='inline'> -<p>Validate the package prior to serialization.</p> -</div> - - </li> - -</ul> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - — - <div class='inline'> -<p>False if confirm_valid and validation errors exist. True if the package was -serialized</p> -</div> - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#validate-instance_method" title="Axlsx::Package#validate (method)">#validate</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 61</span> - -<span class='def def kw'>def</span> <span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='comma token'>,</span> <span class='confirm_valid identifier id'>confirm_valid</span><span class='assign token'>=</span><span class='false false kw'>false</span><span class='rparen token'>)</span> - <span class='return return kw'>return</span> <span class='false false kw'>false</span> <span class='unless unless_mod kw'>unless</span> <span class='notop op'>!</span><span class='confirm_valid identifier id'>confirm_valid</span> <span class='orop op'>||</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span> - <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='parts identifier id'>parts</span> - <span class='Zip constant id'>Zip</span><span class='colon2 op'>::</span><span class='ZipOutputStream constant id'>ZipOutputStream</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='zip identifier id'>zip</span><span class='bitor op'>|</span> - <span class='p identifier id'>p</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='part identifier id'>part</span><span class='bitor op'>|</span> - <span class='unless unless kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> - <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='put_next_entry identifier id'>put_next_entry</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:entry</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='semicolon token'>;</span> - <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='puts identifier id'>puts</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - <span class='unless unless kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> - <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='put_next_entry identifier id'>put_next_entry</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:entry</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='semicolon token'>;</span> - <span class='comment val'># binread for 1.9.3</span> - <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='write identifier id'>write</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:binread</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='binread identifier id'>binread</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='read identifier id'>read</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - <span class='end end kw'>end</span> - <span class='end end kw'>end</span> - <span class='true true kw'>true</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="validate-instance_method"> - - - (<tt>Array</tt>) <strong>validate</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip -and OpenPackagingConventions-XMLSchema.zip as per ECMA-376, Third edition. -opc schema require an internet connection to import remote schema from -dublin core for dc, dcterms and xml namespaces. Those remote schema are -included in this gem, and the original files have been altered to refer to -the local versions.</p> - -<p>If by chance you are able to creat a package that does not validate it -indicates that the internal validation is not robust enough and needs to be -improved. Please report your errors to the gem author.</p> -</div> - </div> - - -<p>Validate all parts of the package against xsd schema.</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <h3>Examples:</h3> - - <h4><div class='inline'></div></h4> - <pre class="example code"><span class='comment val'># The following will output any error messages found in serialization.</span> -<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> -<span class='comment val'># ... code to create sheets, charts, styles etc.</span> -<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='error identifier id'>error</span><span class='bitor op'>|</span> <span class='puts identifier id'>puts</span> <span class='error identifier id'>error</span><span class='dot token'>.</span><span class='message identifier id'>message</span> <span class='rbrace token'>}</span> -</pre> - - </div> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Array</tt>)</span> - - - - — - <div class='inline'> -<p>An array of all validation errors found.</p> -</div> - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><a href="http://www.ecma-international.org/publications/standards/Ecma-376.htm" target="_parent" title="http://www.ecma-international.org/publications/standards/Ecma-376.htm">http://www.ecma-international.org/publications/standards/Ecma-376.htm</a></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -95 -96 -97 -98 -99</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 95</span> - -<span class='def def kw'>def</span> <span class='validate identifier id'>validate</span> - <span class='errors identifier id'>errors</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> - <span class='parts identifier id'>parts</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='part identifier id'>part</span><span class='bitor op'>|</span> <span class='errors identifier id'>errors</span><span class='dot token'>.</span><span class='concat identifier id'>concat</span> <span class='validate_single_doc identifier id'>validate_single_doc</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:schema</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:schema</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> <span class='rbrace token'>}</span> - <span class='errors identifier id'>errors</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="workbook-instance_method"> - - - (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong> {|@workbook| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>As there are multiple ways to instantiate a workbook for the package, here -are a few examples:</p> - -<pre class="ruby"><span class="ruby-comment"># assign directly during package instanciation</span> -<span class="ruby-identifier">wb</span> = <span class="ruby-constant">Package</span>.<span class="ruby-identifier">new</span>(:<span class="ruby-identifier">workbook</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span>).<span class="ruby-identifier">workbook</span> - -<span class="ruby-comment"># get a fresh workbook automatically from the package</span> -<span class="ruby-identifier">wb</span> = <span class="ruby-constant">Pacakge</span>.<span class="ruby-identifier">new</span>().<span class="ruby-identifier">workbook</span> -<span class="ruby-comment"># # set the workbook after creating the package</span> -<span class="ruby-identifier">wb</span> = <span class="ruby-constant">Package</span>.<span class="ruby-identifier">new</span>().<span class="ruby-identifier">workbook</span> = <span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span> -</pre> -</div> - </div> - - -<p>The workbook this package will serialize or validate.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>@workbook</tt>)</span> - - - - </li> - -</ul> -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>If no workbook instance has been assigned with this package a new Workbook -instance is returned.</p> -</div> - - </li> - -</ul> -<h3>Raises:</h3> -<ul class="raise"> - - <li> - - - <span class='type'></span> - - - - - <div class='inline'> -<p>ArgumentError if workbook parameter is not a Workbook instance.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -37 -38 -39 -40 -41</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 37</span> - -<span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span> - <span class='@workbook ivar id'>@workbook</span> <span class='orop op'>||</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span> - <span class='yield yield kw'>yield</span> <span class='@workbook ivar id'>@workbook</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> - <span class='@workbook ivar id'>@workbook</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="workbook=-instance_method"> - - - (<tt>Object</tt>) <strong>workbook=</strong>(workbook) - - - -</p><div class="docstring"> - <div class="discussion"> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>workbook</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -44</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 44</span> - -<span class='def def kw'>def</span> <span class='workbook= identifier id'>workbook=</span><span class='lparen token'>(</span><span class='workbook identifier id'>workbook</span><span class='rparen token'>)</span> <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>"Package.workbook"</span><span class='comma token'>,</span> <span class='Workbook constant id'>Workbook</span><span class='comma token'>,</span> <span class='workbook identifier id'>workbook</span><span class='semicolon token'>;</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='workbook identifier id'>workbook</span> <span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Wed Nov 30 08:46:36 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 |