rrtf 0.1.2 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.byebug_history +6 -3
- data/CHANGELOG.md +24 -0
- data/README.md +194 -84
- data/documentation/RRTF.html +5 -5
- data/documentation/RRTF/AnonymousStyle.html +792 -0
- data/documentation/RRTF/BorderFormatting.html +821 -0
- data/documentation/RRTF/BorderStyle.html +493 -0
- data/documentation/RRTF/CharacterFormatting.html +293 -162
- data/documentation/RRTF/CharacterStyle.html +53 -109
- data/documentation/RRTF/Colour.html +61 -1
- data/documentation/RRTF/ColourTable.html +52 -52
- data/documentation/RRTF/CommandNode.html +367 -971
- data/documentation/RRTF/ContainerNode.html +44 -44
- data/documentation/RRTF/Converters.html +1 -1
- data/documentation/RRTF/Converters/HTML.html +1 -1
- data/documentation/RRTF/Converters/HTML/Helpers.html +1 -1
- data/documentation/RRTF/Converters/HTML/Node.html +1 -1
- data/documentation/RRTF/Converters/HTML/NodeSet.html +1 -1
- data/documentation/RRTF/Document.html +267 -255
- data/documentation/RRTF/DocumentFormatting.html +833 -0
- data/documentation/RRTF/DocumentProperties.html +444 -0
- data/documentation/RRTF/Font.html +1 -1
- data/documentation/RRTF/FontTable.html +1 -1
- data/documentation/RRTF/FooterNode.html +16 -16
- data/documentation/RRTF/GeometryNode.html +774 -0
- data/documentation/RRTF/GeometryProperties.html +1014 -0
- data/documentation/RRTF/HeaderNode.html +16 -16
- data/documentation/RRTF/ImageNode.html +705 -492
- data/documentation/RRTF/Information.html +1 -1
- data/documentation/RRTF/LinkNode.html +10 -10
- data/documentation/RRTF/ListLevel.html +1 -1
- data/documentation/RRTF/ListLevelNode.html +37 -37
- data/documentation/RRTF/ListMarker.html +1 -1
- data/documentation/RRTF/ListNode.html +19 -19
- data/documentation/RRTF/ListTable.html +1 -1
- data/documentation/RRTF/ListTemplate.html +1 -1
- data/documentation/RRTF/ListTextNode.html +14 -14
- data/documentation/RRTF/Node.html +26 -26
- data/documentation/RRTF/Page.html +129 -0
- data/documentation/RRTF/Page/Margin.html +1158 -0
- data/documentation/RRTF/Page/Size.html +946 -0
- data/documentation/RRTF/PageFormatting.html +954 -0
- data/documentation/RRTF/ParagraphFormatting.html +338 -56
- data/documentation/RRTF/ParagraphNode.html +10 -10
- data/documentation/RRTF/ParagraphStyle.html +72 -111
- data/documentation/RRTF/PositionFormatting.html +780 -0
- data/documentation/RRTF/PositionStyle.html +424 -0
- data/documentation/RRTF/Properties.html +243 -0
- data/documentation/RRTF/RTFError.html +21 -10
- data/documentation/RRTF/ShadingFormatting.html +712 -0
- data/documentation/RRTF/ShadingStyle.html +424 -0
- data/documentation/RRTF/Style.html +284 -697
- data/documentation/RRTF/Stylesheet.html +36 -3
- data/documentation/RRTF/TableCellNode.html +131 -131
- data/documentation/RRTF/TableNode.html +82 -82
- data/documentation/RRTF/TableRowNode.html +53 -53
- data/documentation/RRTF/TextNode.html +46 -46
- data/documentation/RRTF/Utilities.html +837 -17
- data/documentation/_index.html +139 -6
- data/documentation/class_list.html +1 -1
- data/documentation/file.README.html +218 -87
- data/documentation/index.html +218 -87
- data/documentation/method_list.html +631 -391
- data/documentation/top-level-namespace.html +1 -1
- data/examples/01.rtf +947 -20
- data/examples/01_everything.rb +176 -0
- data/examples/02.rtf +13 -0
- data/examples/02_basic_paragraph.rb +10 -0
- data/examples/03.rtf +20 -0
- data/examples/03_paragraph_inline_style.rb +14 -0
- data/examples/04.rtf +21 -0
- data/examples/04_paragraph_with_character_style.rb +18 -0
- data/examples/05.rtf +21 -0
- data/examples/05_hyperlinks.rb +21 -0
- data/examples/06.rtf +21 -0
- data/examples/06_basic_list.rb +21 -0
- data/examples/07.rtf +28 -0
- data/examples/07_nested_list.rb +27 -0
- data/examples/08.rtf +807 -0
- data/examples/08_images.rb +17 -0
- data/examples/09.rtf +84 -0
- data/examples/09_shapes.rb +56 -0
- data/examples/10.rtf +34 -0
- data/examples/10_stylesheet.rb +18 -0
- data/examples/resources/images/redshirt.png +0 -0
- data/examples/resources/images/redshirts.jpg +0 -0
- data/examples/resources/json/redshirt_styles.json +72 -8
- data/examples/~$01.rtf +0 -0
- data/lib/rrtf.rb +4 -16
- data/lib/rrtf/colour.rb +8 -0
- data/lib/rrtf/formatting.rb +988 -0
- data/lib/rrtf/node.rb +17 -1851
- data/lib/rrtf/node/command_node.rb +242 -0
- data/lib/rrtf/node/container_node.rb +75 -0
- data/lib/rrtf/node/document.rb +339 -0
- data/lib/rrtf/node/footer_node.rb +47 -0
- data/lib/rrtf/node/geometry_node.rb +65 -0
- data/lib/rrtf/node/header_node.rb +47 -0
- data/lib/rrtf/node/image_node.rb +175 -0
- data/lib/rrtf/node/link_node.rb +10 -0
- data/lib/rrtf/node/list_level_node.rb +44 -0
- data/lib/rrtf/node/list_node.rb +30 -0
- data/lib/rrtf/node/list_text_node.rb +22 -0
- data/lib/rrtf/node/node.rb +53 -0
- data/lib/rrtf/node/paragraph_node.rb +11 -0
- data/lib/rrtf/node/table_cell_node.rb +233 -0
- data/lib/rrtf/node/table_node.rb +136 -0
- data/lib/rrtf/node/table_row_node.rb +92 -0
- data/lib/rrtf/node/text_node.rb +76 -0
- data/lib/rrtf/page.rb +7 -0
- data/lib/rrtf/page/margin.rb +98 -0
- data/lib/rrtf/page/size.rb +98 -0
- data/lib/rrtf/properties.rb +3 -0
- data/lib/rrtf/properties/document_properties.rb +34 -0
- data/lib/rrtf/properties/geometry_properties.rb +380 -0
- data/lib/rrtf/properties/properties.rb +13 -0
- data/lib/rrtf/style.rb +4 -5
- data/lib/rrtf/style/anonymous_style.rb +73 -0
- data/lib/rrtf/style/border_style.rb +27 -0
- data/lib/rrtf/style/character_style.rb +1 -7
- data/lib/rrtf/style/paragraph_style.rb +0 -6
- data/lib/rrtf/style/position_style.rb +26 -0
- data/lib/rrtf/style/shading_style.rb +26 -0
- data/lib/rrtf/style/style.rb +60 -101
- data/lib/rrtf/utilities.rb +138 -0
- data/lib/rrtf/version.rb +1 -1
- data/rrtf.gemspec +1 -0
- metadata +85 -10
- data/examples/01_mac_libreoffice5_2_3_3.png +0 -0
- data/examples/01_mac_pages6_2.png +0 -0
- data/examples/01_mac_textedit1_12.png +0 -0
- data/examples/01_mac_word15_36.png +0 -0
- data/examples/01_styles_and_paragraphs.rb +0 -32
- data/lib/rrtf/paper.rb +0 -53
- data/lib/rrtf/style/document_style.rb +0 -116
- data/lib/rrtf/style/formatting.rb +0 -320
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Module: RRTF::Page
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.9
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "RRTF::Page";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (P)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Page</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Module: RRTF::Page
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<dl>
|
|
80
|
+
<dt>Defined in:</dt>
|
|
81
|
+
<dd>lib/rrtf/page.rb<span class="defines">,<br />
|
|
82
|
+
lib/rrtf/page/size.rb,<br /> lib/rrtf/page/margin.rb</span>
|
|
83
|
+
</dd>
|
|
84
|
+
</dl>
|
|
85
|
+
|
|
86
|
+
</div>
|
|
87
|
+
|
|
88
|
+
<h2>Overview</h2><div class="docstring">
|
|
89
|
+
<div class="discussion">
|
|
90
|
+
|
|
91
|
+
<p>Encapsulates classes that represent various aspects of a page in an RTF
|
|
92
|
+
document.</p>
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
</div>
|
|
96
|
+
</div>
|
|
97
|
+
<div class="tags">
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
</div><h2>Defined Under Namespace</h2>
|
|
101
|
+
<p class="children">
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Page/Margin.html" title="RRTF::Page::Margin (class)">Margin</a></span>, <span class='object_link'><a href="Page/Size.html" title="RRTF::Page::Size (class)">Size</a></span>
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</p>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
</div>
|
|
120
|
+
|
|
121
|
+
<div id="footer">
|
|
122
|
+
Generated on Mon Jul 31 21:48:57 2017 by
|
|
123
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
124
|
+
0.9.9 (ruby-2.3.3).
|
|
125
|
+
</div>
|
|
126
|
+
|
|
127
|
+
</div>
|
|
128
|
+
</body>
|
|
129
|
+
</html>
|
|
@@ -0,0 +1,1158 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: RRTF::Page::Margin
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.9
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "RRTF::Page::Margin";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (M)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../RRTF.html" title="RRTF (module)">RRTF</a></span></span> » <span class='title'><span class='object_link'><a href="../Page.html" title="RRTF::Page (module)">Page</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Margin</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: RRTF::Page::Margin
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">RRTF::Page::Margin</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/rrtf/page/margin.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Represents the left, right, top, and bottom margin in a document page.</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
<p class="tag_title">Author:</p>
|
|
113
|
+
<ul class="author">
|
|
114
|
+
|
|
115
|
+
<li>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<div class='inline'>
|
|
122
|
+
<p>Wesley Hileman</p>
|
|
123
|
+
</div>
|
|
124
|
+
|
|
125
|
+
</li>
|
|
126
|
+
|
|
127
|
+
</ul>
|
|
128
|
+
<p class="tag_title">Since:</p>
|
|
129
|
+
<ul class="since">
|
|
130
|
+
|
|
131
|
+
<li>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
<div class='inline'>
|
|
138
|
+
<p>1.0.0</p>
|
|
139
|
+
</div>
|
|
140
|
+
|
|
141
|
+
</li>
|
|
142
|
+
|
|
143
|
+
</ul>
|
|
144
|
+
|
|
145
|
+
</div>
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
150
|
+
<ul class="summary">
|
|
151
|
+
|
|
152
|
+
<li class="public ">
|
|
153
|
+
<span class="summary_signature">
|
|
154
|
+
|
|
155
|
+
<a href="#bottom-instance_method" title="#bottom (instance method)">#<strong>bottom</strong> ⇒ Object </a>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</span>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
173
|
+
|
|
174
|
+
</li>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
<li class="public ">
|
|
178
|
+
<span class="summary_signature">
|
|
179
|
+
|
|
180
|
+
<a href="#left-instance_method" title="#left (instance method)">#<strong>left</strong> ⇒ Object </a>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
</span>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
198
|
+
|
|
199
|
+
</li>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
<li class="public ">
|
|
203
|
+
<span class="summary_signature">
|
|
204
|
+
|
|
205
|
+
<a href="#right-instance_method" title="#right (instance method)">#<strong>right</strong> ⇒ Object </a>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
</span>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
223
|
+
|
|
224
|
+
</li>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<li class="public ">
|
|
228
|
+
<span class="summary_signature">
|
|
229
|
+
|
|
230
|
+
<a href="#top-instance_method" title="#top (instance method)">#<strong>top</strong> ⇒ Object </a>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
</span>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
248
|
+
|
|
249
|
+
</li>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
</ul>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
<h2>
|
|
259
|
+
Class Method Summary
|
|
260
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
261
|
+
</h2>
|
|
262
|
+
|
|
263
|
+
<ul class="summary">
|
|
264
|
+
|
|
265
|
+
<li class="public ">
|
|
266
|
+
<span class="summary_signature">
|
|
267
|
+
|
|
268
|
+
<a href="#from_string-class_method" title="from_string (class method)">.<strong>from_string</strong>(string) ⇒ Margin </a>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
</span>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<span class="summary_desc"><div class='inline'>
|
|
283
|
+
<p>Extracts a margin object from a string.</p>
|
|
284
|
+
</div></span>
|
|
285
|
+
|
|
286
|
+
</li>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
<li class="public ">
|
|
290
|
+
<span class="summary_signature">
|
|
291
|
+
|
|
292
|
+
<a href="#parse_string-class_method" title="parse_string (class method)">.<strong>parse_string</strong>(string) ⇒ Hash<String, Integer> </a>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
</span>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
<span class="summary_desc"><div class='inline'>
|
|
307
|
+
<p>Extracts a margin hash from a string.</p>
|
|
308
|
+
</div></span>
|
|
309
|
+
|
|
310
|
+
</li>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
</ul>
|
|
314
|
+
|
|
315
|
+
<h2>
|
|
316
|
+
Instance Method Summary
|
|
317
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
318
|
+
</h2>
|
|
319
|
+
|
|
320
|
+
<ul class="summary">
|
|
321
|
+
|
|
322
|
+
<li class="public ">
|
|
323
|
+
<span class="summary_signature">
|
|
324
|
+
|
|
325
|
+
<a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(obj) ⇒ Object </a>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
(also: #eql?)
|
|
330
|
+
|
|
331
|
+
</span>
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
<span class="summary_desc"><div class='inline'>
|
|
342
|
+
<p>initialize.</p>
|
|
343
|
+
</div></span>
|
|
344
|
+
|
|
345
|
+
</li>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
<li class="public ">
|
|
349
|
+
<span class="summary_signature">
|
|
350
|
+
|
|
351
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(value = nil) ⇒ Margin </a>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
</span>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
<span class="note title constructor">constructor</span>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
<span class="summary_desc"><div class='inline'>
|
|
368
|
+
<p>Builds a new margin object from a string or hash.</p>
|
|
369
|
+
</div></span>
|
|
370
|
+
|
|
371
|
+
</li>
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
</ul>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<div id="constructor_details" class="method_details_list">
|
|
378
|
+
<h2>Constructor Details</h2>
|
|
379
|
+
|
|
380
|
+
<div class="method_details first">
|
|
381
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
382
|
+
|
|
383
|
+
#<strong>initialize</strong>(value = nil) ⇒ <tt><span class='object_link'><a href="" title="RRTF::Page::Margin (class)">Margin</a></span></tt>
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
</h3><div class="docstring">
|
|
390
|
+
<div class="discussion">
|
|
391
|
+
|
|
392
|
+
<div class="note notetag">
|
|
393
|
+
<strong>Note:</strong>
|
|
394
|
+
<div class='inline'>
|
|
395
|
+
<p>Margins are stored internally in twentieth points (twips).</p>
|
|
396
|
+
</div>
|
|
397
|
+
</div>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
<p>Builds a new margin object from a string or hash.</p>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
</div>
|
|
404
|
+
</div>
|
|
405
|
+
<div class="tags">
|
|
406
|
+
<p class="tag_title">Parameters:</p>
|
|
407
|
+
<ul class="param">
|
|
408
|
+
|
|
409
|
+
<li>
|
|
410
|
+
|
|
411
|
+
<span class='name'>value</span>
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
<span class='type'>(<tt>String</tt>, <tt>Hash</tt>)</span>
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
—
|
|
421
|
+
<div class='inline'>
|
|
422
|
+
<p>the value from which to parse the margin.</p>
|
|
423
|
+
</div>
|
|
424
|
+
|
|
425
|
+
</li>
|
|
426
|
+
|
|
427
|
+
</ul>
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
<p class="tag_title">Options Hash (<tt>value</tt>):</p>
|
|
433
|
+
<ul class="option">
|
|
434
|
+
|
|
435
|
+
<li>
|
|
436
|
+
<span class="name">"left"</span>
|
|
437
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
438
|
+
<span class="default">
|
|
439
|
+
|
|
440
|
+
</span>
|
|
441
|
+
|
|
442
|
+
— <div class='inline'>
|
|
443
|
+
<p>the left margin in twips.</p>
|
|
444
|
+
</div>
|
|
445
|
+
|
|
446
|
+
</li>
|
|
447
|
+
|
|
448
|
+
<li>
|
|
449
|
+
<span class="name">"right"</span>
|
|
450
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
451
|
+
<span class="default">
|
|
452
|
+
|
|
453
|
+
</span>
|
|
454
|
+
|
|
455
|
+
— <div class='inline'>
|
|
456
|
+
<p>the right margin in twips.</p>
|
|
457
|
+
</div>
|
|
458
|
+
|
|
459
|
+
</li>
|
|
460
|
+
|
|
461
|
+
<li>
|
|
462
|
+
<span class="name">"top"</span>
|
|
463
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
464
|
+
<span class="default">
|
|
465
|
+
|
|
466
|
+
</span>
|
|
467
|
+
|
|
468
|
+
— <div class='inline'>
|
|
469
|
+
<p>the top margin in twips.</p>
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
</li>
|
|
473
|
+
|
|
474
|
+
<li>
|
|
475
|
+
<span class="name">"bottom"</span>
|
|
476
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
477
|
+
<span class="default">
|
|
478
|
+
|
|
479
|
+
</span>
|
|
480
|
+
|
|
481
|
+
— <div class='inline'>
|
|
482
|
+
<p>the bottom margin in twips.</p>
|
|
483
|
+
</div>
|
|
484
|
+
|
|
485
|
+
</li>
|
|
486
|
+
|
|
487
|
+
</ul>
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
<p class="tag_title">See Also:</p>
|
|
492
|
+
<ul class="see">
|
|
493
|
+
|
|
494
|
+
<li><span class='object_link'><a href="#from_string-class_method" title="RRTF::Page::Margin.from_string (method)">from_string</a></span></li>
|
|
495
|
+
|
|
496
|
+
<li><span class='object_link'><a href="#parse_string-class_method" title="RRTF::Page::Margin.parse_string (method)">parse_string</a></span></li>
|
|
497
|
+
|
|
498
|
+
<li><span class='object_link'><a href="../Utilities.html#value2twips-class_method" title="RRTF::Utilities.value2twips (method)">Utilities.value2twips</a></span></li>
|
|
499
|
+
|
|
500
|
+
</ul>
|
|
501
|
+
<p class="tag_title">Since:</p>
|
|
502
|
+
<ul class="since">
|
|
503
|
+
|
|
504
|
+
<li>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
<div class='inline'>
|
|
511
|
+
<p>1.0.0</p>
|
|
512
|
+
</div>
|
|
513
|
+
|
|
514
|
+
</li>
|
|
515
|
+
|
|
516
|
+
</ul>
|
|
517
|
+
|
|
518
|
+
</div><table class="source_code">
|
|
519
|
+
<tr>
|
|
520
|
+
<td>
|
|
521
|
+
<pre class="lines">
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
62
|
|
525
|
+
63
|
|
526
|
+
64
|
|
527
|
+
65
|
|
528
|
+
66
|
|
529
|
+
67
|
|
530
|
+
68
|
|
531
|
+
69
|
|
532
|
+
70
|
|
533
|
+
71
|
|
534
|
+
72
|
|
535
|
+
73
|
|
536
|
+
74
|
|
537
|
+
75
|
|
538
|
+
76
|
|
539
|
+
77
|
|
540
|
+
78
|
|
541
|
+
79
|
|
542
|
+
80
|
|
543
|
+
81
|
|
544
|
+
82
|
|
545
|
+
83
|
|
546
|
+
84
|
|
547
|
+
85</pre>
|
|
548
|
+
</td>
|
|
549
|
+
<td>
|
|
550
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/page/margin.rb', line 62</span>
|
|
551
|
+
|
|
552
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
553
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
554
|
+
<span class='comment'># default 1 inch margins
|
|
555
|
+
</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>left</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1440</span><span class='comma'>,</span>
|
|
556
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>right</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1440</span><span class='comma'>,</span>
|
|
557
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>top</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1440</span><span class='comma'>,</span>
|
|
558
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bottom</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1440</span>
|
|
559
|
+
<span class='rbrace'>}</span>
|
|
560
|
+
|
|
561
|
+
<span class='kw'>case</span> <span class='id identifier rubyid_value'>value</span>
|
|
562
|
+
<span class='kw'>when</span> <span class='const'>String</span>
|
|
563
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_parse_string'>parse_string</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
564
|
+
<span class='kw'>when</span> <span class='const'>Hash</span>
|
|
565
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
566
|
+
<span class='kw'>when</span> <span class='kw'>nil</span>
|
|
567
|
+
<span class='kw'>else</span>
|
|
568
|
+
<span class='const'><span class='object_link'><a href="../../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'><span class='object_link'><a href="../RTFError.html#fire-class_method" title="RRTF::RTFError.fire (method)">fire</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Cannot create margin from '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_content'>'.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
569
|
+
<span class='kw'>end</span> <span class='comment'># case
|
|
570
|
+
</span>
|
|
571
|
+
<span class='ivar'>@left</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>left</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
572
|
+
<span class='ivar'>@right</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>right</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
573
|
+
<span class='ivar'>@top</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>top</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
574
|
+
<span class='ivar'>@bottom</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bottom</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
575
|
+
<span class='kw'>end</span></pre>
|
|
576
|
+
</td>
|
|
577
|
+
</tr>
|
|
578
|
+
</table>
|
|
579
|
+
</div>
|
|
580
|
+
|
|
581
|
+
</div>
|
|
582
|
+
|
|
583
|
+
<div id="instance_attr_details" class="attr_details">
|
|
584
|
+
<h2>Instance Attribute Details</h2>
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
<span id="bottom=-instance_method"></span>
|
|
588
|
+
<div class="method_details first">
|
|
589
|
+
<h3 class="signature first" id="bottom-instance_method">
|
|
590
|
+
|
|
591
|
+
#<strong>bottom</strong> ⇒ <tt>Object</tt>
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
</h3><div class="docstring">
|
|
598
|
+
<div class="discussion">
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
</div>
|
|
602
|
+
</div>
|
|
603
|
+
<div class="tags">
|
|
604
|
+
|
|
605
|
+
<p class="tag_title">Since:</p>
|
|
606
|
+
<ul class="since">
|
|
607
|
+
|
|
608
|
+
<li>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
<div class='inline'>
|
|
615
|
+
<p>1.0.0</p>
|
|
616
|
+
</div>
|
|
617
|
+
|
|
618
|
+
</li>
|
|
619
|
+
|
|
620
|
+
</ul>
|
|
621
|
+
|
|
622
|
+
</div><table class="source_code">
|
|
623
|
+
<tr>
|
|
624
|
+
<td>
|
|
625
|
+
<pre class="lines">
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
6
|
|
629
|
+
7
|
|
630
|
+
8</pre>
|
|
631
|
+
</td>
|
|
632
|
+
<td>
|
|
633
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/page/margin.rb', line 6</span>
|
|
634
|
+
|
|
635
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_bottom'>bottom</span>
|
|
636
|
+
<span class='ivar'>@bottom</span>
|
|
637
|
+
<span class='kw'>end</span></pre>
|
|
638
|
+
</td>
|
|
639
|
+
</tr>
|
|
640
|
+
</table>
|
|
641
|
+
</div>
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
<span id="left=-instance_method"></span>
|
|
645
|
+
<div class="method_details ">
|
|
646
|
+
<h3 class="signature " id="left-instance_method">
|
|
647
|
+
|
|
648
|
+
#<strong>left</strong> ⇒ <tt>Object</tt>
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
</h3><div class="docstring">
|
|
655
|
+
<div class="discussion">
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
</div>
|
|
659
|
+
</div>
|
|
660
|
+
<div class="tags">
|
|
661
|
+
|
|
662
|
+
<p class="tag_title">Since:</p>
|
|
663
|
+
<ul class="since">
|
|
664
|
+
|
|
665
|
+
<li>
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
<div class='inline'>
|
|
672
|
+
<p>1.0.0</p>
|
|
673
|
+
</div>
|
|
674
|
+
|
|
675
|
+
</li>
|
|
676
|
+
|
|
677
|
+
</ul>
|
|
678
|
+
|
|
679
|
+
</div><table class="source_code">
|
|
680
|
+
<tr>
|
|
681
|
+
<td>
|
|
682
|
+
<pre class="lines">
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
6
|
|
686
|
+
7
|
|
687
|
+
8</pre>
|
|
688
|
+
</td>
|
|
689
|
+
<td>
|
|
690
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/page/margin.rb', line 6</span>
|
|
691
|
+
|
|
692
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_left'>left</span>
|
|
693
|
+
<span class='ivar'>@left</span>
|
|
694
|
+
<span class='kw'>end</span></pre>
|
|
695
|
+
</td>
|
|
696
|
+
</tr>
|
|
697
|
+
</table>
|
|
698
|
+
</div>
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
<span id="right=-instance_method"></span>
|
|
702
|
+
<div class="method_details ">
|
|
703
|
+
<h3 class="signature " id="right-instance_method">
|
|
704
|
+
|
|
705
|
+
#<strong>right</strong> ⇒ <tt>Object</tt>
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
</h3><div class="docstring">
|
|
712
|
+
<div class="discussion">
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
</div>
|
|
716
|
+
</div>
|
|
717
|
+
<div class="tags">
|
|
718
|
+
|
|
719
|
+
<p class="tag_title">Since:</p>
|
|
720
|
+
<ul class="since">
|
|
721
|
+
|
|
722
|
+
<li>
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
<div class='inline'>
|
|
729
|
+
<p>1.0.0</p>
|
|
730
|
+
</div>
|
|
731
|
+
|
|
732
|
+
</li>
|
|
733
|
+
|
|
734
|
+
</ul>
|
|
735
|
+
|
|
736
|
+
</div><table class="source_code">
|
|
737
|
+
<tr>
|
|
738
|
+
<td>
|
|
739
|
+
<pre class="lines">
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
6
|
|
743
|
+
7
|
|
744
|
+
8</pre>
|
|
745
|
+
</td>
|
|
746
|
+
<td>
|
|
747
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/page/margin.rb', line 6</span>
|
|
748
|
+
|
|
749
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_right'>right</span>
|
|
750
|
+
<span class='ivar'>@right</span>
|
|
751
|
+
<span class='kw'>end</span></pre>
|
|
752
|
+
</td>
|
|
753
|
+
</tr>
|
|
754
|
+
</table>
|
|
755
|
+
</div>
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
<span id="top=-instance_method"></span>
|
|
759
|
+
<div class="method_details ">
|
|
760
|
+
<h3 class="signature " id="top-instance_method">
|
|
761
|
+
|
|
762
|
+
#<strong>top</strong> ⇒ <tt>Object</tt>
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
</h3><div class="docstring">
|
|
769
|
+
<div class="discussion">
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
</div>
|
|
773
|
+
</div>
|
|
774
|
+
<div class="tags">
|
|
775
|
+
|
|
776
|
+
<p class="tag_title">Since:</p>
|
|
777
|
+
<ul class="since">
|
|
778
|
+
|
|
779
|
+
<li>
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
<div class='inline'>
|
|
786
|
+
<p>1.0.0</p>
|
|
787
|
+
</div>
|
|
788
|
+
|
|
789
|
+
</li>
|
|
790
|
+
|
|
791
|
+
</ul>
|
|
792
|
+
|
|
793
|
+
</div><table class="source_code">
|
|
794
|
+
<tr>
|
|
795
|
+
<td>
|
|
796
|
+
<pre class="lines">
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
6
|
|
800
|
+
7
|
|
801
|
+
8</pre>
|
|
802
|
+
</td>
|
|
803
|
+
<td>
|
|
804
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/page/margin.rb', line 6</span>
|
|
805
|
+
|
|
806
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_top'>top</span>
|
|
807
|
+
<span class='ivar'>@top</span>
|
|
808
|
+
<span class='kw'>end</span></pre>
|
|
809
|
+
</td>
|
|
810
|
+
</tr>
|
|
811
|
+
</table>
|
|
812
|
+
</div>
|
|
813
|
+
|
|
814
|
+
</div>
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
<div id="class_method_details" class="method_details_list">
|
|
818
|
+
<h2>Class Method Details</h2>
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
<div class="method_details first">
|
|
822
|
+
<h3 class="signature first" id="from_string-class_method">
|
|
823
|
+
|
|
824
|
+
.<strong>from_string</strong>(string) ⇒ <tt><span class='object_link'><a href="" title="RRTF::Page::Margin (class)">Margin</a></span></tt>
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
</h3><div class="docstring">
|
|
831
|
+
<div class="discussion">
|
|
832
|
+
|
|
833
|
+
<p>Extracts a margin object from a string.</p>
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
</div>
|
|
837
|
+
</div>
|
|
838
|
+
<div class="tags">
|
|
839
|
+
|
|
840
|
+
<div class="examples">
|
|
841
|
+
<p class="tag_title">Examples:</p>
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
<p class="example_title"><div class='inline'>
|
|
845
|
+
<p>Parse margin from a String</p>
|
|
846
|
+
</div></p>
|
|
847
|
+
|
|
848
|
+
<pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="RRTF::Page::Margin (class)">Margin</a></span></span><span class='period'>.</span><span class='id identifier rubyid_from_string'>from_string</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>12.1pt, 2.2in, 5cm, 4in</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
849
|
+
<span class='comment'># => #<RRTF::Margin:0x007fa1b3094500 @left=242, @right=3168, @top=2834, @bottom=5760></span></code></pre>
|
|
850
|
+
|
|
851
|
+
</div>
|
|
852
|
+
|
|
853
|
+
<p class="tag_title">Returns:</p>
|
|
854
|
+
<ul class="return">
|
|
855
|
+
|
|
856
|
+
<li>
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="RRTF::Page::Margin (class)">Margin</a></span></tt>)</span>
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
—
|
|
864
|
+
<div class='inline'>
|
|
865
|
+
<p>the margin object created from the string.</p>
|
|
866
|
+
</div>
|
|
867
|
+
|
|
868
|
+
</li>
|
|
869
|
+
|
|
870
|
+
</ul>
|
|
871
|
+
|
|
872
|
+
<p class="tag_title">See Also:</p>
|
|
873
|
+
<ul class="see">
|
|
874
|
+
|
|
875
|
+
<li><span class='object_link'><a href="#parse_string-class_method" title="RRTF::Page::Margin.parse_string (method)">parse_string</a></span></li>
|
|
876
|
+
|
|
877
|
+
</ul>
|
|
878
|
+
<p class="tag_title">Since:</p>
|
|
879
|
+
<ul class="since">
|
|
880
|
+
|
|
881
|
+
<li>
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
<div class='inline'>
|
|
888
|
+
<p>1.0.0</p>
|
|
889
|
+
</div>
|
|
890
|
+
|
|
891
|
+
</li>
|
|
892
|
+
|
|
893
|
+
</ul>
|
|
894
|
+
|
|
895
|
+
</div><table class="source_code">
|
|
896
|
+
<tr>
|
|
897
|
+
<td>
|
|
898
|
+
<pre class="lines">
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
16
|
|
902
|
+
17
|
|
903
|
+
18</pre>
|
|
904
|
+
</td>
|
|
905
|
+
<td>
|
|
906
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/page/margin.rb', line 16</span>
|
|
907
|
+
|
|
908
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_string'>from_string</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span>
|
|
909
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_parse_string'>parse_string</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
910
|
+
<span class='kw'>end</span></pre>
|
|
911
|
+
</td>
|
|
912
|
+
</tr>
|
|
913
|
+
</table>
|
|
914
|
+
</div>
|
|
915
|
+
|
|
916
|
+
<div class="method_details ">
|
|
917
|
+
<h3 class="signature " id="parse_string-class_method">
|
|
918
|
+
|
|
919
|
+
.<strong>parse_string</strong>(string) ⇒ <tt>Hash<String, Integer></tt>
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
</h3><div class="docstring">
|
|
926
|
+
<div class="discussion">
|
|
927
|
+
|
|
928
|
+
<p>Extracts a margin hash from a string.</p>
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
</div>
|
|
932
|
+
</div>
|
|
933
|
+
<div class="tags">
|
|
934
|
+
|
|
935
|
+
<div class="examples">
|
|
936
|
+
<p class="tag_title">Examples:</p>
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
<p class="example_title"><div class='inline'>
|
|
940
|
+
<p>Parse margin from a String</p>
|
|
941
|
+
</div></p>
|
|
942
|
+
|
|
943
|
+
<pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="RRTF::Page::Margin (class)">Margin</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_string'>parse_string</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>12.1pt, 2.2in, 5cm, 4in</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
944
|
+
<span class='comment'># => {"top"=>2834, "bottom"=>5760, "left"=>242, "right"=>3168} (twips)</span></code></pre>
|
|
945
|
+
|
|
946
|
+
</div>
|
|
947
|
+
<p class="tag_title">Parameters:</p>
|
|
948
|
+
<ul class="param">
|
|
949
|
+
|
|
950
|
+
<li>
|
|
951
|
+
|
|
952
|
+
<span class='name'>string</span>
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
—
|
|
960
|
+
<div class='inline'>
|
|
961
|
+
<p>the string from which to parse the margin, taking one of the following
|
|
962
|
+
formats: “<marg:all>”, “<marg:lr>,<marg:tb>”, or
|
|
963
|
+
“<marg:l>,<marg:r>,<marg:t>,<marg:b>” where each
|
|
964
|
+
number may be suffixed by an optional unit (see <span class='object_link'><a href="../Utilities.html#value2twips-class_method" title="RRTF::Utilities.value2twips (method)">Utilities.value2twips</a></span>).</p>
|
|
965
|
+
</div>
|
|
966
|
+
|
|
967
|
+
</li>
|
|
968
|
+
|
|
969
|
+
</ul>
|
|
970
|
+
|
|
971
|
+
<p class="tag_title">Returns:</p>
|
|
972
|
+
<ul class="return">
|
|
973
|
+
|
|
974
|
+
<li>
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
<span class='type'>(<tt>Hash<String, Integer></tt>)</span>
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
—
|
|
982
|
+
<div class='inline'>
|
|
983
|
+
<p>the margin hash created from the string.</p>
|
|
984
|
+
</div>
|
|
985
|
+
|
|
986
|
+
</li>
|
|
987
|
+
|
|
988
|
+
</ul>
|
|
989
|
+
<p class="tag_title">Raises:</p>
|
|
990
|
+
<ul class="raise">
|
|
991
|
+
|
|
992
|
+
<li>
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
<span class='type'>(<tt><span class='object_link'><a href="../RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></tt>)</span>
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
—
|
|
1000
|
+
<div class='inline'>
|
|
1001
|
+
<p>if the string cannot be converted into a margin hash.</p>
|
|
1002
|
+
</div>
|
|
1003
|
+
|
|
1004
|
+
</li>
|
|
1005
|
+
|
|
1006
|
+
</ul>
|
|
1007
|
+
<p class="tag_title">Since:</p>
|
|
1008
|
+
<ul class="since">
|
|
1009
|
+
|
|
1010
|
+
<li>
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
<div class='inline'>
|
|
1017
|
+
<p>1.0.0</p>
|
|
1018
|
+
</div>
|
|
1019
|
+
|
|
1020
|
+
</li>
|
|
1021
|
+
|
|
1022
|
+
</ul>
|
|
1023
|
+
|
|
1024
|
+
</div><table class="source_code">
|
|
1025
|
+
<tr>
|
|
1026
|
+
<td>
|
|
1027
|
+
<pre class="lines">
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
30
|
|
1031
|
+
31
|
|
1032
|
+
32
|
|
1033
|
+
33
|
|
1034
|
+
34
|
|
1035
|
+
35
|
|
1036
|
+
36
|
|
1037
|
+
37
|
|
1038
|
+
38
|
|
1039
|
+
39
|
|
1040
|
+
40
|
|
1041
|
+
41
|
|
1042
|
+
42
|
|
1043
|
+
43
|
|
1044
|
+
44
|
|
1045
|
+
45
|
|
1046
|
+
46
|
|
1047
|
+
47
|
|
1048
|
+
48
|
|
1049
|
+
49</pre>
|
|
1050
|
+
</td>
|
|
1051
|
+
<td>
|
|
1052
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/page/margin.rb', line 30</span>
|
|
1053
|
+
|
|
1054
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse_string'>parse_string</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span>
|
|
1055
|
+
<span class='id identifier rubyid_values'>values</span> <span class='op'>=</span> <span class='id identifier rubyid_string'>string</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:strip</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_str'>str</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Utilities.html" title="RRTF::Utilities (class)">Utilities</a></span></span><span class='period'>.</span><span class='id identifier rubyid_value2twips'><span class='object_link'><a href="../Utilities.html#value2twips-class_method" title="RRTF::Utilities.value2twips (method)">value2twips</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
1056
|
+
<span class='kw'>case</span> <span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span>
|
|
1057
|
+
<span class='kw'>when</span> <span class='int'>1</span>
|
|
1058
|
+
<span class='id identifier rubyid_tblr'>tblr</span> <span class='op'>=</span> <span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
|
1059
|
+
<span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>top</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_tblr'>tblr</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bottom</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_tblr'>tblr</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>left</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_tblr'>tblr</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>right</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_tblr'>tblr</span><span class='rbrace'>}</span>
|
|
1060
|
+
<span class='kw'>when</span> <span class='int'>2</span>
|
|
1061
|
+
<span class='id identifier rubyid_tb'>tb</span> <span class='op'>=</span> <span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
|
|
1062
|
+
<span class='id identifier rubyid_lr'>lr</span> <span class='op'>=</span> <span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
|
1063
|
+
<span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>top</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_tb'>tb</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bottom</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_tb'>tb</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>left</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lr'>lr</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>right</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lr'>lr</span><span class='rbrace'>}</span>
|
|
1064
|
+
<span class='kw'>when</span> <span class='int'>4</span>
|
|
1065
|
+
<span class='id identifier rubyid_l'>l</span> <span class='op'>=</span> <span class='id identifier rubyid_values'>values</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
|
|
1066
|
+
<span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='id identifier rubyid_values'>values</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
|
|
1067
|
+
<span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='id identifier rubyid_values'>values</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span>
|
|
1068
|
+
<span class='id identifier rubyid_b'>b</span> <span class='op'>=</span> <span class='id identifier rubyid_values'>values</span><span class='lbracket'>[</span><span class='int'>3</span><span class='rbracket'>]</span>
|
|
1069
|
+
<span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>top</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_t'>t</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bottom</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_b'>b</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>left</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_l'>l</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>right</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_r'>r</span><span class='rbrace'>}</span>
|
|
1070
|
+
<span class='kw'>else</span>
|
|
1071
|
+
<span class='const'><span class='object_link'><a href="../../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'><span class='object_link'><a href="../RTFError.html#fire-class_method" title="RRTF::RTFError.fire (method)">fire</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid margin '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_string'>string</span><span class='embexpr_end'>}</span><span class='tstring_content'>'.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1072
|
+
<span class='kw'>end</span> <span class='comment'># case
|
|
1073
|
+
</span><span class='kw'>end</span></pre>
|
|
1074
|
+
</td>
|
|
1075
|
+
</tr>
|
|
1076
|
+
</table>
|
|
1077
|
+
</div>
|
|
1078
|
+
|
|
1079
|
+
</div>
|
|
1080
|
+
|
|
1081
|
+
<div id="instance_method_details" class="method_details_list">
|
|
1082
|
+
<h2>Instance Method Details</h2>
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
<div class="method_details first">
|
|
1086
|
+
<h3 class="signature first" id="==-instance_method">
|
|
1087
|
+
|
|
1088
|
+
#<strong>==</strong>(obj) ⇒ <tt>Object</tt>
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
<span class="aliases">Also known as:
|
|
1093
|
+
<span class="names"><span id='eql?-instance_method'>eql?</span></span>
|
|
1094
|
+
</span>
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
</h3><div class="docstring">
|
|
1099
|
+
<div class="discussion">
|
|
1100
|
+
|
|
1101
|
+
<p>initialize</p>
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
</div>
|
|
1105
|
+
</div>
|
|
1106
|
+
<div class="tags">
|
|
1107
|
+
|
|
1108
|
+
<p class="tag_title">Since:</p>
|
|
1109
|
+
<ul class="since">
|
|
1110
|
+
|
|
1111
|
+
<li>
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
<div class='inline'>
|
|
1118
|
+
<p>1.0.0</p>
|
|
1119
|
+
</div>
|
|
1120
|
+
|
|
1121
|
+
</li>
|
|
1122
|
+
|
|
1123
|
+
</ul>
|
|
1124
|
+
|
|
1125
|
+
</div><table class="source_code">
|
|
1126
|
+
<tr>
|
|
1127
|
+
<td>
|
|
1128
|
+
<pre class="lines">
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
87
|
|
1132
|
+
88
|
|
1133
|
+
89</pre>
|
|
1134
|
+
</td>
|
|
1135
|
+
<td>
|
|
1136
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/page/margin.rb', line 87</span>
|
|
1137
|
+
|
|
1138
|
+
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
|
|
1139
|
+
<span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>==</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>&&</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_state'>state</span> <span class='op'>==</span> <span class='id identifier rubyid_state'>state</span>
|
|
1140
|
+
<span class='kw'>end</span></pre>
|
|
1141
|
+
</td>
|
|
1142
|
+
</tr>
|
|
1143
|
+
</table>
|
|
1144
|
+
</div>
|
|
1145
|
+
|
|
1146
|
+
</div>
|
|
1147
|
+
|
|
1148
|
+
</div>
|
|
1149
|
+
|
|
1150
|
+
<div id="footer">
|
|
1151
|
+
Generated on Mon Jul 31 21:48:59 2017 by
|
|
1152
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1153
|
+
0.9.9 (ruby-2.3.3).
|
|
1154
|
+
</div>
|
|
1155
|
+
|
|
1156
|
+
</div>
|
|
1157
|
+
</body>
|
|
1158
|
+
</html>
|