From 058faf2581970fa18c314ad07f5658adeca32c69 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Sun, 27 Nov 2011 22:08:55 +0900 Subject: update to README --- doc/Axlsx/App.html | 591 ++++++++++++++++++++++------------------------------- 1 file changed, 244 insertions(+), 347 deletions(-) (limited to 'doc/Axlsx/App.html') diff --git a/doc/Axlsx/App.html b/doc/Axlsx/App.html index d8ee7c52..47c9c28a 100644 --- a/doc/Axlsx/App.html +++ b/doc/Axlsx/App.html @@ -97,22 +97,19 @@
Note: -

-Support is not implemented for the following complex types: -

-

-HeadingPairs (VectorVariant), TitlesOfParts (VectorLpstr), HLinks -(VectorVariant), DigSig (DigSigBlob) -

+
+

Support is not implemented for the following complex types:

+ +

HeadingPairs (VectorVariant), TitlesOfParts (VectorLpstr), HLinks +(VectorVariant), DigSig (DigSigBlob)

-

-App represents the app.xml document. The attributes for this object are + +

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. -

+object.

@@ -151,9 +148,8 @@ object. -

-The name of the application. -

+
+

The name of the application.

 @@ -178,9 +174,8 @@ The name of the application. -

-The version of the application. -

+
+

The version of the application.

 @@ -205,9 +200,8 @@ The version of the application. -

-The number of characters in the document. -

+
+

The number of characters in the document.

 @@ -232,9 +226,8 @@ The number of characters in the document. -

-The number of characters in the document including spaces. -

+
+

The number of characters in the document including spaces.

 @@ -259,9 +252,8 @@ The number of characters in the document including spaces. -

-The name of the company generating the document. -

+
+

The name of the company generating the document.

 @@ -286,9 +278,8 @@ The name of the company generating the document. -

-Document security. -

+
+

Document security.

 @@ -313,9 +304,8 @@ Document security. -

-The number of hidden slides. -

+
+

The number of hidden slides.

 @@ -340,9 +330,8 @@ The number of hidden slides. -

-The base for hyper links in the document. -

+
+

The base for hyper links in the document.

 @@ -367,9 +356,8 @@ The base for hyper links in the document. -

-Indicates that the hyper links in the document have been changed. -

+
+

Indicates that the hyper links in the document have been changed.

 @@ -394,9 +382,8 @@ Indicates that the hyper links in the document have been changed. -

-The number of lines in the document. -

+
+

The number of lines in the document.

 @@ -421,9 +408,8 @@ The number of lines in the document. -

-The links in the document are up to date. -

+
+

The links in the document are up to date.

 @@ -448,9 +434,8 @@ The links in the document are up to date. -

-The name of the manager for the document. -

+
+

The name of the manager for the document.

 @@ -475,9 +460,8 @@ The name of the manager for the document. -

-The total number multimedia clips. -

+
+

The total number multimedia clips.

 @@ -502,9 +486,8 @@ The total number multimedia clips. -

-The number of slides that have notes. -

+
+

The number of slides that have notes.

 @@ -529,9 +512,8 @@ The number of slides that have notes. -

-The number of pages in the document. -

+
+

The number of pages in the document.

 @@ -556,9 +538,8 @@ The number of pages in the document. -

-The number of paragraphs in the document. -

+
+

The number of paragraphs in the document.

 @@ -583,9 +564,8 @@ The number of paragraphs in the document. -

-The intended format of the presentation. -

+
+

The intended format of the presentation.

 @@ -610,9 +590,8 @@ The intended format of the presentation. -

-The display mode for the document thumbnail. -

+
+

The display mode for the document thumbnail.

 @@ -637,9 +616,8 @@ The display mode for the document thumbnail. -

-Indicates if the document is shared. -

+
+

Indicates if the document is shared.

 @@ -664,9 +642,8 @@ Indicates if the document is shared. -

-The number of slides in the document. -

+
+

The number of slides in the document.

 @@ -691,9 +668,8 @@ The number of slides in the document. -

-The name of the document template. -

+
+

The name of the document template.

 @@ -718,9 +694,8 @@ The name of the document template. -

-The total amount of time spent editing. -

+
+

The total amount of time spent editing.

 @@ -745,9 +720,8 @@ The total amount of time spent editing. -

-The number of words in the document. -

+
+

The number of words in the document.

 @@ -782,9 +756,8 @@ The number of words in the document. -

-Creates an App object. -

+
+

Creates an App object.

 @@ -806,9 +779,8 @@ Creates an App object. -

-Generate an app.xml document. -

+
+

Generate an app.xml document.

 @@ -833,9 +805,8 @@ Generate an app.xml document.

-

-The name of the application -

+ +

The name of the application

@@ -853,9 +824,8 @@ The name of the application — -

-The name of the application -

+
+

The name of the application

@@ -875,10 +845,9 @@ The name of the application 
# File 'lib/axlsx/doc_props/app.rb', line 74
 
-def Application
-  @Application
-end
-
+def Application + @Application +end @@ -896,9 +865,8 @@ The name of the application

-

-The version of the application. -

+ +

The version of the application.

@@ -916,9 +884,8 @@ The version of the application. — -

-The version of the application. -

+
+

The version of the application.

@@ -938,10 +905,9 @@ The version of the application. 
# File 'lib/axlsx/doc_props/app.rb', line 77
 
-def AppVersion
-  @AppVersion
-end
-
+def AppVersion + @AppVersion +end @@ -959,9 +925,8 @@ The version of the application.

-

-The number of characters in the document. -

+ +

The number of characters in the document.

@@ -979,9 +944,8 @@ The number of characters in the document. — -

-The number of characters in the document. -

+
+

The number of characters in the document.

@@ -1001,10 +965,9 @@ The number of characters in the document. 
# File 'lib/axlsx/doc_props/app.rb', line 29
 
-def Characters
-  @Characters
-end
-
+def Characters + @Characters +end @@ -1022,9 +985,8 @@ The number of characters in the document.

-

-The number of characters in the document including spaces. -

+ +

The number of characters in the document including spaces.

@@ -1042,9 +1004,8 @@ The number of characters in the document including spaces. — -

-The number of characters in the document including spaces. -

+
+

The number of characters in the document including spaces.

@@ -1064,10 +1025,9 @@ The number of characters in the document including spaces. 
# File 'lib/axlsx/doc_props/app.rb', line 62
 
-def CharactersWithSpaces
-  @CharactersWithSpaces
-end
-
+def CharactersWithSpaces + @CharactersWithSpaces +end @@ -1085,9 +1045,8 @@ The number of characters in the document including spaces.

-

-The name of the company generating the document. -

+ +

The name of the company generating the document.

@@ -1105,9 +1064,8 @@ The name of the company generating the document. — -

-The name of the company generating the document. -

+
+

The name of the company generating the document.

@@ -1127,10 +1085,9 @@ The name of the company generating the document. 
# File 'lib/axlsx/doc_props/app.rb', line 20
 
-def Company
-  @Company
-end
-
+def Company + @Company +end @@ -1148,9 +1105,8 @@ The name of the company generating the document.

-

-Document security -

+ +

Document security

@@ -1168,9 +1124,8 @@ Document security — -

-Document security -

+
+

Document security

@@ -1190,10 +1145,9 @@ Document security 
# File 'lib/axlsx/doc_props/app.rb', line 80
 
-def DocSecurity
-  @DocSecurity
-end
-
+def DocSecurity + @DocSecurity +end @@ -1211,9 +1165,8 @@ Document security

-

-The number of hidden slides. -

+ +

The number of hidden slides.

@@ -1231,9 +1184,8 @@ The number of hidden slides. — -

-The number of hidden slides. -

+
+

The number of hidden slides.

@@ -1253,10 +1205,9 @@ The number of hidden slides. 
# File 'lib/axlsx/doc_props/app.rb', line 50
 
-def HiddenSlides
-  @HiddenSlides
-end
-
+def HiddenSlides + @HiddenSlides +end @@ -1274,9 +1225,8 @@ The number of hidden slides.

-

-The base for hyper links in the document. -

+ +

The base for hyper links in the document.

@@ -1294,9 +1244,8 @@ The base for hyper links in the document. — -

-The base for hyper links in the document. -

+
+

The base for hyper links in the document.

@@ -1316,10 +1265,9 @@ The base for hyper links in the document. 
# File 'lib/axlsx/doc_props/app.rb', line 68
 
-def HyperLinkBase
-  @HyperLinkBase
-end
-
+def HyperLinkBase + @HyperLinkBase +end @@ -1337,9 +1285,8 @@ The base for hyper links in the document.

-

-Indicates that the hyper links in the document have been changed. -

+ +

Indicates that the hyper links in the document have been changed.

@@ -1357,9 +1304,8 @@ Indicates that the hyper links in the document have been changed. — -

-Indicates that the hyper links in the document have been changed. -

+
+

Indicates that the hyper links in the document have been changed.

@@ -1379,10 +1325,9 @@ Indicates that the hyper links in the document have been changed. 
# File 'lib/axlsx/doc_props/app.rb', line 71
 
-def HyperlinksChanged
-  @HyperlinksChanged
-end
-
+def HyperlinksChanged + @HyperlinksChanged +end @@ -1400,9 +1345,8 @@ Indicates that the hyper links in the document have been changed.

-

-The number of lines in the document. -

+ +

The number of lines in the document.

@@ -1420,9 +1364,8 @@ The number of lines in the document. — -

-The number of lines in the document. -

+
+

The number of lines in the document.

@@ -1442,10 +1385,9 @@ The number of lines in the document. 
# File 'lib/axlsx/doc_props/app.rb', line 35
 
-def Lines
-  @Lines
-end
-
+def Lines + @Lines +end @@ -1463,9 +1405,8 @@ The number of lines in the document.

-

-The links in the document are up to date. -

+ +

The links in the document are up to date.

@@ -1483,9 +1424,8 @@ The links in the document are up to date. — -

-The links in the document are up to date. -

+
+

The links in the document are up to date.

@@ -1505,10 +1445,9 @@ The links in the document are up to date. 
# File 'lib/axlsx/doc_props/app.rb', line 59
 
-def LinksUpToDate
-  @LinksUpToDate
-end
-
+def LinksUpToDate + @LinksUpToDate +end @@ -1526,9 +1465,8 @@ The links in the document are up to date.

-

-The name of the manager for the document. -

+ +

The name of the manager for the document.

@@ -1546,9 +1484,8 @@ The name of the manager for the document. — -

-The name of the manager for the document. -

+
+

The name of the manager for the document.

@@ -1568,10 +1505,9 @@ The name of the manager for the document. 
# File 'lib/axlsx/doc_props/app.rb', line 17
 
-def Manager
-  @Manager
-end
-
+def Manager + @Manager +end @@ -1589,9 +1525,8 @@ The name of the manager for the document.

-

-The total number multimedia clips -

+ +

The total number multimedia clips

@@ -1609,9 +1544,8 @@ The total number multimedia clips — -

-The total number multimedia clips -

+
+

The total number multimedia clips

@@ -1631,10 +1565,9 @@ The total number multimedia clips 
# File 'lib/axlsx/doc_props/app.rb', line 53
 
-def MMClips
-  @MMClips
-end
-
+def MMClips + @MMClips +end @@ -1652,9 +1585,8 @@ The total number multimedia clips

-

-The number of slides that have notes. -

+ +

The number of slides that have notes.

@@ -1672,9 +1604,8 @@ The number of slides that have notes. — -

-The number of slides that have notes. -

+
+

The number of slides that have notes.

@@ -1694,10 +1625,9 @@ The number of slides that have notes. 
# File 'lib/axlsx/doc_props/app.rb', line 44
 
-def Notes
-  @Notes
-end
-
+def Notes + @Notes +end @@ -1715,9 +1645,8 @@ The number of slides that have notes.

-

-The number of pages in the document. -

+ +

The number of pages in the document.

@@ -1735,9 +1664,8 @@ The number of pages in the document. — -

-The number of pages in the document. -

+
+

The number of pages in the document.

@@ -1757,10 +1685,9 @@ The number of pages in the document. 
# File 'lib/axlsx/doc_props/app.rb', line 23
 
-def Pages
-  @Pages
-end
-
+def Pages + @Pages +end @@ -1778,9 +1705,8 @@ The number of pages in the document.

-

-The number of paragraphs in the document -

+ +

The number of paragraphs in the document

@@ -1798,9 +1724,8 @@ The number of paragraphs in the document — -

-The number of paragraphs in the document -

+
+

The number of paragraphs in the document

@@ -1820,10 +1745,9 @@ The number of paragraphs in the document 
# File 'lib/axlsx/doc_props/app.rb', line 38
 
-def Paragraphs
-  @Paragraphs
-end
-
+def Paragraphs + @Paragraphs +end @@ -1841,9 +1765,8 @@ The number of paragraphs in the document

-

-The intended format of the presentation. -

+ +

The intended format of the presentation.

@@ -1861,9 +1784,8 @@ The intended format of the presentation. — -

-The intended format of the presentation. -

+
+

The intended format of the presentation.

@@ -1883,10 +1805,9 @@ The intended format of the presentation. 
# File 'lib/axlsx/doc_props/app.rb', line 32
 
-def PresentationFormat
-  @PresentationFormat
-end
-
+def PresentationFormat + @PresentationFormat +end @@ -1904,9 +1825,8 @@ The intended format of the presentation.

-

-The display mode for the document thumbnail. -

+ +

The display mode for the document thumbnail.

@@ -1924,9 +1844,8 @@ The display mode for the document thumbnail. — -

-The display mode for the document thumbnail. -

+
+

The display mode for the document thumbnail.

@@ -1946,10 +1865,9 @@ The display mode for the document thumbnail. 
# File 'lib/axlsx/doc_props/app.rb', line 56
 
-def ScaleCrop
-  @ScaleCrop
-end
-
+def ScaleCrop + @ScaleCrop +end @@ -1967,9 +1885,8 @@ The display mode for the document thumbnail.

-

-Indicates if the document is shared. -

+ +

Indicates if the document is shared.

@@ -1987,9 +1904,8 @@ Indicates if the document is shared. — -

-Indicates if the document is shared. -

+
+

Indicates if the document is shared.

@@ -2009,10 +1925,9 @@ Indicates if the document is shared. 
# File 'lib/axlsx/doc_props/app.rb', line 65
 
-def ShareDoc
-  @ShareDoc
-end
-
+def ShareDoc + @ShareDoc +end @@ -2030,9 +1945,8 @@ Indicates if the document is shared.

-

-The number of slides in the document. -

+ +

The number of slides in the document.

@@ -2050,9 +1964,8 @@ The number of slides in the document. — -

-The number of slides in the document. -

+
+

The number of slides in the document.

@@ -2072,10 +1985,9 @@ The number of slides in the document. 
# File 'lib/axlsx/doc_props/app.rb', line 41
 
-def Slides
-  @Slides
-end
-
+def Slides + @Slides +end @@ -2093,9 +2005,8 @@ The number of slides in the document.

-

-The name of the document template. -

+ +

The name of the document template.

@@ -2113,9 +2024,8 @@ The name of the document template. — -

-The name of the document template. -

+
+

The name of the document template.

@@ -2135,10 +2045,9 @@ The name of the document template. 
# File 'lib/axlsx/doc_props/app.rb', line 14
 
-def Template
-  @Template
-end
-
+def Template + @Template +end @@ -2156,9 +2065,8 @@ The name of the document template.

-

-The total amount of time spent editing. -

+ +

The total amount of time spent editing.

@@ -2176,9 +2084,8 @@ The total amount of time spent editing. — -

-The total amount of time spent editing. -

+
+

The total amount of time spent editing.

@@ -2198,10 +2105,9 @@ The total amount of time spent editing. 
# File 'lib/axlsx/doc_props/app.rb', line 47
 
-def TotalTime
-  @TotalTime
-end
-
+def TotalTime + @TotalTime +end @@ -2219,9 +2125,8 @@ The total amount of time spent editing.

-

-The number of words in the document. -

+ +

The number of words in the document.

@@ -2239,9 +2144,8 @@ The number of words in the document. — -

-The number of words in the document. -

+
+

The number of words in the document.

@@ -2261,10 +2165,9 @@ The number of words in the document. 
# File 'lib/axlsx/doc_props/app.rb', line 26
 
-def Words
-  @Words
-end
-
+def Words + @Words +end @@ -2286,9 +2189,8 @@ The number of words in the document.

-

-Creates an App object -

+ +

Creates an App object

@@ -2309,9 +2211,8 @@ Creates an App object — -

-a customizable set of options -

+
+

a customizable set of options

@@ -2541,12 +2442,11 @@ a customizable set of options 
# File 'lib/axlsx/doc_props/app.rb', line 105
 
-def initalize(options={})
-  options.each do |o|
-    self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-  end
-end
-
+def initalize(options={}) + options.each do |o| + self.send("#{o[0]}=", o[1]) if self.respond_to? o[0] + end +end @@ -2561,9 +2461,8 @@ a customizable set of options

-

-Generate an app.xml document -

+ +

Generate an app.xml document

@@ -2581,9 +2480,8 @@ Generate an app.xml document — -

-The document as a string -

+
+

The document as a string

@@ -2610,17 +2508,16 @@ The document as a string 
# File 'lib/axlsx/doc_props/app.rb', line 167
 
-def to_xml()
-  builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
-    xml.send(:Properties, :xmlns => APP_NS, :'xmlns:vt' => APP_NS_VT) {
-      self.instance_values.each do |name, value|
-        xml.send("ap:#{name}", value)
-      end
-    }
-  end      
-  builder.to_xml
-end
-
+def to_xml() + builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml| + xml.send(:Properties, :xmlns => APP_NS, :xmlns:vt' => APP_NS_VT) { + self.instance_values.each do |name, value| + xml.send("ap:#{name}", value) + end + } + end + builder.to_xml +end @@ -2631,9 +2528,9 @@ The document as a string
-- cgit v1.2.3