From 2d0ac967e94c5944ccccf9adad8da5a9d082df29 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Sun, 20 Nov 2011 23:44:58 +0900 Subject: pushing docs --- doc/Axlsx/Relationships.html | 343 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 343 insertions(+) create mode 100644 doc/Axlsx/Relationships.html (limited to 'doc/Axlsx/Relationships.html') diff --git a/doc/Axlsx/Relationships.html b/doc/Axlsx/Relationships.html new file mode 100644 index 00000000..d5e76faf --- /dev/null +++ b/doc/Axlsx/Relationships.html @@ -0,0 +1,343 @@ + + + + + + Class: Axlsx::Relationships + + — Documentation by YARD 0.7.3 + + + + + + + + + + + + + + + + + + + + + + +

Class: Axlsx::Relationships + + + +

+ +
+ +
Inherits:
+
+ SimpleTypedList + + + show all + +
+ + + + + + + + + +
Defined in:
+
lib/axlsx/rels/relationships.rb
+ +
+
+ +

Overview

+
+ +
+ Note: +

+The package automatically manages releationships. +

+
+
+ +

+Relationships are a collection of Relations that define how package parts +are related. +

+ + +
+
+
+ + +
+ + + + + + + + + + +

Instance Attribute Summary

+ +

Attributes inherited from SimpleTypedList

+

allowed_types, locked_at, serialize_as

+ + + +

+ Instance Method Summary + (collapse) +

+ + + + + + + + + + + + +

Methods inherited from SimpleTypedList

+

#<<, #[]=, #delete, #delete_at, #lock, #method_missing, #protected?, #push, #unlock

+
+

Constructor Details

+ +
+

+ + - (Relationships) initialize + + + +

+
+

+Creates a new Relationships collection based on SimpleTypedList +

+ + +
+
+
+ + +
+ + + + +
+ 
+
+
+9
+10
+11
+ 		+ 
# File 'lib/axlsx/rels/relationships.rb', line 9
+
+def initialize
+  super Relationship
+end
+
+
+
+ +
+
+

Dynamic Method Handling

+

+ This class handles dynamic methods through the method_missing method + + in the class Axlsx::SimpleTypedList + +

+ +
+ + +
+

Instance Method Details

+ + +
+

+ + - (String) to_xml + + + +

+
+

+Serializes the relationships document. +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+15
+16
+17
+18
+19
+20
+21
+22
+ 		+ 
# File 'lib/axlsx/rels/relationships.rb', line 15
+
+def to_xml()
+  builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
+    xml.Relationships(:xmlns => Axlsx::RELS_R) {
+      each_with_index { |rel, index| rel.to_xml(xml, "rId#{index+1}") }
+    }
+  end
+  builder.to_xml
+end
+
+
+
+ +
+ +
+ + + + + \ No newline at end of file -- cgit v1.2.3