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,821 @@
|
|
|
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::BorderFormatting
|
|
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::BorderFormatting";
|
|
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 (B)</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">BorderFormatting</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::BorderFormatting
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
<dl>
|
|
78
|
+
<dt>Included in:</dt>
|
|
79
|
+
<dd><span class='object_link'><a href="BorderStyle.html" title="RRTF::BorderStyle (class)">BorderStyle</a></span></dd>
|
|
80
|
+
</dl>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<dl>
|
|
85
|
+
<dt>Defined in:</dt>
|
|
86
|
+
<dd>lib/rrtf/formatting.rb</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
|
|
91
|
+
<h2>Overview</h2><div class="docstring">
|
|
92
|
+
<div class="discussion">
|
|
93
|
+
|
|
94
|
+
<p>Paragraph, table, and image border formatting attributes and methods.</p>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
</div>
|
|
98
|
+
</div>
|
|
99
|
+
<div class="tags">
|
|
100
|
+
|
|
101
|
+
<p class="tag_title">Author:</p>
|
|
102
|
+
<ul class="author">
|
|
103
|
+
|
|
104
|
+
<li>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<div class='inline'>
|
|
111
|
+
<p>Wesley Hileman</p>
|
|
112
|
+
</div>
|
|
113
|
+
|
|
114
|
+
</li>
|
|
115
|
+
|
|
116
|
+
</ul>
|
|
117
|
+
<p class="tag_title">Since:</p>
|
|
118
|
+
<ul class="since">
|
|
119
|
+
|
|
120
|
+
<li>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
<div class='inline'>
|
|
127
|
+
<p>1.0.0</p>
|
|
128
|
+
</div>
|
|
129
|
+
|
|
130
|
+
</li>
|
|
131
|
+
|
|
132
|
+
</ul>
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
<h2>Constant Summary</h2>
|
|
136
|
+
<dl class="constants">
|
|
137
|
+
|
|
138
|
+
<dt id="BORDER_ATTRIBUTES-constant" class="">BORDER_ATTRIBUTES =
|
|
139
|
+
<div class="docstring">
|
|
140
|
+
<div class="discussion">
|
|
141
|
+
|
|
142
|
+
<div class="note notetag">
|
|
143
|
+
<strong>Note:</strong>
|
|
144
|
+
<div class='inline'>
|
|
145
|
+
<p>The “sides” attribute must appear at the top of this hash so that
|
|
146
|
+
<span class='object_link'><a href="#border_formatting_to_rtf-instance_method" title="RRTF::BorderFormatting#border_formatting_to_rtf (method)">#border_formatting_to_rtf</a></span> generates correct RTF (borders are initiated by
|
|
147
|
+
the “sides” attribute in the RTF spec).</p>
|
|
148
|
+
</div>
|
|
149
|
+
</div>
|
|
150
|
+
|
|
151
|
+
<div class="note notetag">
|
|
152
|
+
<strong>Note:</strong>
|
|
153
|
+
<div class='inline'>
|
|
154
|
+
<p>The “line_type” attribute must appear second in this hash so that
|
|
155
|
+
<span class='object_link'><a href="#border_formatting_to_rtf-instance_method" title="RRTF::BorderFormatting#border_formatting_to_rtf (method)">#border_formatting_to_rtf</a></span> generates correct RTF.</p>
|
|
156
|
+
</div>
|
|
157
|
+
</div>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
<p>Formatting attributes that can be applied to borders of paragraphs, tables,
|
|
161
|
+
& images.</p>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
</div>
|
|
165
|
+
</div>
|
|
166
|
+
<div class="tags">
|
|
167
|
+
|
|
168
|
+
<p class="tag_title">Since:</p>
|
|
169
|
+
<ul class="since">
|
|
170
|
+
|
|
171
|
+
<li>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
<div class='inline'>
|
|
178
|
+
<p>1.0.0</p>
|
|
179
|
+
</div>
|
|
180
|
+
|
|
181
|
+
</li>
|
|
182
|
+
|
|
183
|
+
</ul>
|
|
184
|
+
|
|
185
|
+
</div>
|
|
186
|
+
</dt>
|
|
187
|
+
<dd><pre class="code"><span class='lbrace'>{</span>
|
|
188
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sides</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
189
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>box</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
190
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dictionary</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
191
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ALL</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>box</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
192
|
+
<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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brdrl</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
193
|
+
<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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brdrr</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
194
|
+
<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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brdrt</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
195
|
+
<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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brdrb</span><span class='tstring_end'>"</span></span>
|
|
196
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
197
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span>
|
|
198
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
199
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>line_type</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
200
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brdrs</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
201
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dictionary</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
202
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>SINGLE</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brdrs</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
203
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>THICK</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brdrth</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
204
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>DOUBLE</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brdrdb</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
205
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>DOT</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brdrdot</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
206
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>DASH</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brdrdash</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
207
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>HAIRLINE</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brdrhair</span><span class='tstring_end'>"</span></span>
|
|
208
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
209
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span>
|
|
210
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
211
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>width</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
212
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
213
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>from_user</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</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_value'>value</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='comma'>,</span>
|
|
214
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\brdrw</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span>
|
|
215
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
216
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>spacing</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
217
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
218
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>from_user</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</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_value'>value</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='comma'>,</span>
|
|
219
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\brsp</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span>
|
|
220
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
221
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>color</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
222
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
223
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>from_user</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</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="Colour.html" title="RRTF::Colour (class)">Colour</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_value'>value</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="Colour.html" title="RRTF::Colour (class)">Colour</a></span></span><span class='period'>.</span><span class='id identifier rubyid_from_string'><span class='object_link'><a href="Colour.html#from_string-class_method" title="RRTF::Colour.from_string (method)">from_string</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='comma'>,</span>
|
|
224
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\brdrcf</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_document'>document</span><span class='period'>.</span><span class='id identifier rubyid_colours'>colours</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span>
|
|
225
|
+
<span class='rbrace'>}</span>
|
|
226
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
227
|
+
|
|
228
|
+
</dl>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<h2>
|
|
238
|
+
Class Method Summary
|
|
239
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
240
|
+
</h2>
|
|
241
|
+
|
|
242
|
+
<ul class="summary">
|
|
243
|
+
|
|
244
|
+
<li class="public ">
|
|
245
|
+
<span class="summary_signature">
|
|
246
|
+
|
|
247
|
+
<a href="#included-class_method" title="included (class method)">.<strong>included</strong>(base) ⇒ Object </a>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
</span>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<span class="summary_desc"><div class='inline'>
|
|
262
|
+
<p>Generates attribute accessors for all paragraph attributes when the module
|
|
263
|
+
is included in another module or class.</p>
|
|
264
|
+
</div></span>
|
|
265
|
+
|
|
266
|
+
</li>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
</ul>
|
|
270
|
+
|
|
271
|
+
<h2>
|
|
272
|
+
Instance Method Summary
|
|
273
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
274
|
+
</h2>
|
|
275
|
+
|
|
276
|
+
<ul class="summary">
|
|
277
|
+
|
|
278
|
+
<li class="public ">
|
|
279
|
+
<span class="summary_signature">
|
|
280
|
+
|
|
281
|
+
<a href="#border_formatting_to_rtf-instance_method" title="#border_formatting_to_rtf (instance method)">#<strong>border_formatting_to_rtf</strong>(document) ⇒ Object </a>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
</span>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
<span class="summary_desc"><div class='inline'>
|
|
296
|
+
<p>Generates an RTF string representing all applied border formatting.</p>
|
|
297
|
+
</div></span>
|
|
298
|
+
|
|
299
|
+
</li>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
<li class="public ">
|
|
303
|
+
<span class="summary_signature">
|
|
304
|
+
|
|
305
|
+
<a href="#initialize_border_formatting-instance_method" title="#initialize_border_formatting (instance method)">#<strong>initialize_border_formatting</strong>(options = {}) ⇒ Object </a>
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
</span>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
<span class="summary_desc"><div class='inline'>
|
|
320
|
+
<p>Initializes border formatting attributes.</p>
|
|
321
|
+
</div></span>
|
|
322
|
+
|
|
323
|
+
</li>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<li class="public ">
|
|
327
|
+
<span class="summary_signature">
|
|
328
|
+
|
|
329
|
+
<a href="#set_border_formatting_from_hashmap-instance_method" title="#set_border_formatting_from_hashmap (instance method)">#<strong>set_border_formatting_from_hashmap</strong>(hash) ⇒ Object </a>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
</span>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
<span class="summary_desc"><div class='inline'>
|
|
344
|
+
<p>Sets paragraph formatting attributes according to the supplied hashmap.</p>
|
|
345
|
+
</div></span>
|
|
346
|
+
|
|
347
|
+
</li>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
</ul>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
<div id="class_method_details" class="method_details_list">
|
|
356
|
+
<h2>Class Method Details</h2>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
<div class="method_details first">
|
|
360
|
+
<h3 class="signature first" id="included-class_method">
|
|
361
|
+
|
|
362
|
+
.<strong>included</strong>(base) ⇒ <tt>Object</tt>
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
</h3><div class="docstring">
|
|
369
|
+
<div class="discussion">
|
|
370
|
+
|
|
371
|
+
<p>Generates attribute accessors for all paragraph attributes when the module
|
|
372
|
+
is included in another module or class.</p>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
</div>
|
|
376
|
+
</div>
|
|
377
|
+
<div class="tags">
|
|
378
|
+
|
|
379
|
+
<p class="tag_title">Since:</p>
|
|
380
|
+
<ul class="since">
|
|
381
|
+
|
|
382
|
+
<li>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
<div class='inline'>
|
|
389
|
+
<p>1.0.0</p>
|
|
390
|
+
</div>
|
|
391
|
+
|
|
392
|
+
</li>
|
|
393
|
+
|
|
394
|
+
</ul>
|
|
395
|
+
|
|
396
|
+
</div><table class="source_code">
|
|
397
|
+
<tr>
|
|
398
|
+
<td>
|
|
399
|
+
<pre class="lines">
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
465
|
|
403
|
+
466
|
|
404
|
+
467
|
|
405
|
+
468
|
|
406
|
+
469
|
|
407
|
+
470
|
|
408
|
+
471
|
|
409
|
+
472</pre>
|
|
410
|
+
</td>
|
|
411
|
+
<td>
|
|
412
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 465</span>
|
|
413
|
+
|
|
414
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
|
|
415
|
+
<span class='comment'># define accessors in base for paragraph attributes
|
|
416
|
+
</span> <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_class_eval'>class_eval</span> <span class='kw'>do</span>
|
|
417
|
+
<span class='const'><span class='object_link'><a href="#BORDER_ATTRIBUTES-constant" title="RRTF::BorderFormatting::BORDER_ATTRIBUTES (constant)">BORDER_ATTRIBUTES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>|</span>
|
|
418
|
+
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
419
|
+
<span class='kw'>end</span> <span class='comment'># each
|
|
420
|
+
</span> <span class='kw'>end</span> <span class='comment'># class_eval
|
|
421
|
+
</span><span class='kw'>end</span></pre>
|
|
422
|
+
</td>
|
|
423
|
+
</tr>
|
|
424
|
+
</table>
|
|
425
|
+
</div>
|
|
426
|
+
|
|
427
|
+
</div>
|
|
428
|
+
|
|
429
|
+
<div id="instance_method_details" class="method_details_list">
|
|
430
|
+
<h2>Instance Method Details</h2>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
<div class="method_details first">
|
|
434
|
+
<h3 class="signature first" id="border_formatting_to_rtf-instance_method">
|
|
435
|
+
|
|
436
|
+
#<strong>border_formatting_to_rtf</strong>(document) ⇒ <tt>Object</tt>
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
</h3><div class="docstring">
|
|
443
|
+
<div class="discussion">
|
|
444
|
+
|
|
445
|
+
<div class="note notetag">
|
|
446
|
+
<strong>Note:</strong>
|
|
447
|
+
<div class='inline'>
|
|
448
|
+
<p>To generate correct RTF control words for colours and fonts, a document
|
|
449
|
+
object must be provided to this method so that colour and font indicies may
|
|
450
|
+
be found in the document's colour and font tables, respectively.</p>
|
|
451
|
+
</div>
|
|
452
|
+
</div>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
<p>Generates an RTF string representing all applied border formatting.</p>
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
</div>
|
|
459
|
+
</div>
|
|
460
|
+
<div class="tags">
|
|
461
|
+
<p class="tag_title">Parameters:</p>
|
|
462
|
+
<ul class="param">
|
|
463
|
+
|
|
464
|
+
<li>
|
|
465
|
+
|
|
466
|
+
<span class='name'>document</span>
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
<span class='type'>(<tt><span class='object_link'><a href="Document.html" title="RRTF::Document (class)">Document</a></span></tt>)</span>
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
—
|
|
474
|
+
<div class='inline'>
|
|
475
|
+
<p>the document for which the RTF is to be generated.</p>
|
|
476
|
+
</div>
|
|
477
|
+
|
|
478
|
+
</li>
|
|
479
|
+
|
|
480
|
+
</ul>
|
|
481
|
+
|
|
482
|
+
<p class="tag_title">Since:</p>
|
|
483
|
+
<ul class="since">
|
|
484
|
+
|
|
485
|
+
<li>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
<div class='inline'>
|
|
492
|
+
<p>1.0.0</p>
|
|
493
|
+
</div>
|
|
494
|
+
|
|
495
|
+
</li>
|
|
496
|
+
|
|
497
|
+
</ul>
|
|
498
|
+
|
|
499
|
+
</div><table class="source_code">
|
|
500
|
+
<tr>
|
|
501
|
+
<td>
|
|
502
|
+
<pre class="lines">
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
514
|
|
506
|
+
515
|
|
507
|
+
516
|
|
508
|
+
517
|
|
509
|
+
518
|
|
510
|
+
519
|
|
511
|
+
520
|
|
512
|
+
521
|
|
513
|
+
522
|
|
514
|
+
523
|
|
515
|
+
524
|
|
516
|
+
525
|
|
517
|
+
526</pre>
|
|
518
|
+
</td>
|
|
519
|
+
<td>
|
|
520
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 514</span>
|
|
521
|
+
|
|
522
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_border_formatting_to_rtf'>border_formatting_to_rtf</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
|
|
523
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='const'>StringIO</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
524
|
+
|
|
525
|
+
<span class='comment'># accumulate RTF representations of paragraph attributes
|
|
526
|
+
</span> <span class='const'><span class='object_link'><a href="#BORDER_ATTRIBUTES-constant" title="RRTF::BorderFormatting::BORDER_ATTRIBUTES (constant)">BORDER_ATTRIBUTES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>|</span>
|
|
527
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
528
|
+
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
|
|
529
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='id identifier rubyid_rtf'>rtf</span> <span class='kw'>unless</span> <span class='id identifier rubyid_rtf'>rtf</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
530
|
+
<span class='kw'>end</span> <span class='comment'># if
|
|
531
|
+
</span> <span class='kw'>end</span> <span class='comment'># each
|
|
532
|
+
</span>
|
|
533
|
+
<span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span>
|
|
534
|
+
<span class='kw'>end</span></pre>
|
|
535
|
+
</td>
|
|
536
|
+
</tr>
|
|
537
|
+
</table>
|
|
538
|
+
</div>
|
|
539
|
+
|
|
540
|
+
<div class="method_details ">
|
|
541
|
+
<h3 class="signature " id="initialize_border_formatting-instance_method">
|
|
542
|
+
|
|
543
|
+
#<strong>initialize_border_formatting</strong>(options = {}) ⇒ <tt>Object</tt>
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
</h3><div class="docstring">
|
|
550
|
+
<div class="discussion">
|
|
551
|
+
|
|
552
|
+
<p>Initializes border formatting attributes.</p>
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
</div>
|
|
556
|
+
</div>
|
|
557
|
+
<div class="tags">
|
|
558
|
+
<p class="tag_title">Parameters:</p>
|
|
559
|
+
<ul class="param">
|
|
560
|
+
|
|
561
|
+
<li>
|
|
562
|
+
|
|
563
|
+
<span class='name'>options</span>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
—
|
|
573
|
+
<div class='inline'>
|
|
574
|
+
<p>the border formatting options.</p>
|
|
575
|
+
</div>
|
|
576
|
+
|
|
577
|
+
</li>
|
|
578
|
+
|
|
579
|
+
</ul>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
|
585
|
+
<ul class="option">
|
|
586
|
+
|
|
587
|
+
<li>
|
|
588
|
+
<span class="name">"sides"</span>
|
|
589
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
590
|
+
<span class="default">
|
|
591
|
+
|
|
592
|
+
— default:
|
|
593
|
+
<tt>'ALL'</tt>
|
|
594
|
+
|
|
595
|
+
</span>
|
|
596
|
+
|
|
597
|
+
— <div class='inline'>
|
|
598
|
+
<p>the sides to which the border applied (“ALL”, “LEFT”, “RIGHT”, “TOP”, or
|
|
599
|
+
“BOTTOM”).</p>
|
|
600
|
+
</div>
|
|
601
|
+
|
|
602
|
+
</li>
|
|
603
|
+
|
|
604
|
+
<li>
|
|
605
|
+
<span class="name">"line_type"</span>
|
|
606
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
607
|
+
<span class="default">
|
|
608
|
+
|
|
609
|
+
— default:
|
|
610
|
+
<tt>'SINGLE'</tt>
|
|
611
|
+
|
|
612
|
+
</span>
|
|
613
|
+
|
|
614
|
+
— <div class='inline'>
|
|
615
|
+
<p>the border line type (“SINGLE”, “THICK”, “DOUBLE”, “DOT”, “DASH”, or
|
|
616
|
+
“HAIRLINE”).</p>
|
|
617
|
+
</div>
|
|
618
|
+
|
|
619
|
+
</li>
|
|
620
|
+
|
|
621
|
+
<li>
|
|
622
|
+
<span class="name">"width"</span>
|
|
623
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
624
|
+
<span class="default">
|
|
625
|
+
|
|
626
|
+
— default:
|
|
627
|
+
<tt>nil</tt>
|
|
628
|
+
|
|
629
|
+
</span>
|
|
630
|
+
|
|
631
|
+
— <div class='inline'>
|
|
632
|
+
<p>the width of the the border line in twips (can be a string, see
|
|
633
|
+
<span class='object_link'><a href="Utilities.html#value2twips-class_method" title="RRTF::Utilities.value2twips (method)">Utilities.value2twips</a></span>).</p>
|
|
634
|
+
</div>
|
|
635
|
+
|
|
636
|
+
</li>
|
|
637
|
+
|
|
638
|
+
<li>
|
|
639
|
+
<span class="name">"spacing"</span>
|
|
640
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
641
|
+
<span class="default">
|
|
642
|
+
|
|
643
|
+
— default:
|
|
644
|
+
<tt>nil</tt>
|
|
645
|
+
|
|
646
|
+
</span>
|
|
647
|
+
|
|
648
|
+
— <div class='inline'>
|
|
649
|
+
<p>the spacing between the border and paragraph content in twips (can be a
|
|
650
|
+
string, see <span class='object_link'><a href="Utilities.html#value2twips-class_method" title="RRTF::Utilities.value2twips (method)">Utilities.value2twips</a></span>).</p>
|
|
651
|
+
</div>
|
|
652
|
+
|
|
653
|
+
</li>
|
|
654
|
+
|
|
655
|
+
<li>
|
|
656
|
+
<span class="name">"color"</span>
|
|
657
|
+
<span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></tt>)</span>
|
|
658
|
+
<span class="default">
|
|
659
|
+
|
|
660
|
+
— default:
|
|
661
|
+
<tt>nil</tt>
|
|
662
|
+
|
|
663
|
+
</span>
|
|
664
|
+
|
|
665
|
+
— <div class='inline'>
|
|
666
|
+
<p>the color of the the border line (can be a string, see
|
|
667
|
+
<span class='object_link'><a href="Colour.html#from_string-class_method" title="RRTF::Colour.from_string (method)">Colour.from_string</a></span>).</p>
|
|
668
|
+
</div>
|
|
669
|
+
|
|
670
|
+
</li>
|
|
671
|
+
|
|
672
|
+
</ul>
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
<p class="tag_title">Since:</p>
|
|
676
|
+
<ul class="since">
|
|
677
|
+
|
|
678
|
+
<li>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
<div class='inline'>
|
|
685
|
+
<p>1.0.0</p>
|
|
686
|
+
</div>
|
|
687
|
+
|
|
688
|
+
</li>
|
|
689
|
+
|
|
690
|
+
</ul>
|
|
691
|
+
|
|
692
|
+
</div><table class="source_code">
|
|
693
|
+
<tr>
|
|
694
|
+
<td>
|
|
695
|
+
<pre class="lines">
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
482
|
|
699
|
+
483
|
|
700
|
+
484
|
|
701
|
+
485
|
|
702
|
+
486
|
|
703
|
+
487
|
|
704
|
+
488
|
|
705
|
+
489</pre>
|
|
706
|
+
</td>
|
|
707
|
+
<td>
|
|
708
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 482</span>
|
|
709
|
+
|
|
710
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize_border_formatting'>initialize_border_formatting</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
711
|
+
<span class='comment'># load default attribute values
|
|
712
|
+
</span> <span class='const'><span class='object_link'><a href="#BORDER_ATTRIBUTES-constant" title="RRTF::BorderFormatting::BORDER_ATTRIBUTES (constant)">BORDER_ATTRIBUTES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>|</span>
|
|
713
|
+
<span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
714
|
+
<span class='kw'>end</span> <span class='comment'># each
|
|
715
|
+
</span> <span class='comment'># overwrite default attribute values with given values
|
|
716
|
+
</span> <span class='id identifier rubyid_set_border_formatting_from_hashmap'>set_border_formatting_from_hashmap</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
717
|
+
<span class='kw'>end</span></pre>
|
|
718
|
+
</td>
|
|
719
|
+
</tr>
|
|
720
|
+
</table>
|
|
721
|
+
</div>
|
|
722
|
+
|
|
723
|
+
<div class="method_details ">
|
|
724
|
+
<h3 class="signature " id="set_border_formatting_from_hashmap-instance_method">
|
|
725
|
+
|
|
726
|
+
#<strong>set_border_formatting_from_hashmap</strong>(hash) ⇒ <tt>Object</tt>
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
</h3><div class="docstring">
|
|
733
|
+
<div class="discussion">
|
|
734
|
+
|
|
735
|
+
<p>Sets paragraph formatting attributes according to the supplied hashmap.</p>
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
</div>
|
|
739
|
+
</div>
|
|
740
|
+
<div class="tags">
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
<p class="tag_title">See Also:</p>
|
|
744
|
+
<ul class="see">
|
|
745
|
+
|
|
746
|
+
<li><span class='object_link'><a href="#initialize_border_formatting-instance_method" title="RRTF::BorderFormatting#initialize_border_formatting (method)">#initialize_border_formatting</a></span></li>
|
|
747
|
+
|
|
748
|
+
</ul>
|
|
749
|
+
<p class="tag_title">Since:</p>
|
|
750
|
+
<ul class="since">
|
|
751
|
+
|
|
752
|
+
<li>
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
<div class='inline'>
|
|
759
|
+
<p>1.0.0</p>
|
|
760
|
+
</div>
|
|
761
|
+
|
|
762
|
+
</li>
|
|
763
|
+
|
|
764
|
+
</ul>
|
|
765
|
+
|
|
766
|
+
</div><table class="source_code">
|
|
767
|
+
<tr>
|
|
768
|
+
<td>
|
|
769
|
+
<pre class="lines">
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
493
|
|
773
|
+
494
|
|
774
|
+
495
|
|
775
|
+
496
|
|
776
|
+
497
|
|
777
|
+
498
|
|
778
|
+
499
|
|
779
|
+
500
|
|
780
|
+
501
|
|
781
|
+
502
|
|
782
|
+
503
|
|
783
|
+
504
|
|
784
|
+
505
|
|
785
|
+
506</pre>
|
|
786
|
+
</td>
|
|
787
|
+
<td>
|
|
788
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 493</span>
|
|
789
|
+
|
|
790
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_set_border_formatting_from_hashmap'>set_border_formatting_from_hashmap</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
|
|
791
|
+
<span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
|
|
792
|
+
<span class='comment'># skip unreconized attributes
|
|
793
|
+
</span> <span class='kw'>next</span> <span class='kw'>unless</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#BORDER_ATTRIBUTES-constant" title="RRTF::BorderFormatting::BORDER_ATTRIBUTES (constant)">BORDER_ATTRIBUTES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
794
|
+
<span class='comment'># preprocess value if nessesary
|
|
795
|
+
</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="#BORDER_ATTRIBUTES-constant" title="RRTF::BorderFormatting::BORDER_ATTRIBUTES (constant)">BORDER_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>from_user</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
796
|
+
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#BORDER_ATTRIBUTES-constant" title="RRTF::BorderFormatting::BORDER_ATTRIBUTES (constant)">BORDER_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>from_user</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
797
|
+
<span class='kw'>elsif</span> <span class='const'><span class='object_link'><a href="#BORDER_ATTRIBUTES-constant" title="RRTF::BorderFormatting::BORDER_ATTRIBUTES (constant)">BORDER_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dictionary</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
|
|
798
|
+
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#BORDER_ATTRIBUTES-constant" title="RRTF::BorderFormatting::BORDER_ATTRIBUTES (constant)">BORDER_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dictionary</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_value'>value</span><span class='rbracket'>]</span>
|
|
799
|
+
<span class='kw'>end</span> <span class='comment'># if
|
|
800
|
+
</span> <span class='comment'># set attribute value
|
|
801
|
+
</span> <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attribute'>attribute</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
802
|
+
<span class='kw'>end</span> <span class='comment'># each
|
|
803
|
+
</span><span class='kw'>end</span></pre>
|
|
804
|
+
</td>
|
|
805
|
+
</tr>
|
|
806
|
+
</table>
|
|
807
|
+
</div>
|
|
808
|
+
|
|
809
|
+
</div>
|
|
810
|
+
|
|
811
|
+
</div>
|
|
812
|
+
|
|
813
|
+
<div id="footer">
|
|
814
|
+
Generated on Mon Jul 31 21:48:57 2017 by
|
|
815
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
816
|
+
0.9.9 (ruby-2.3.3).
|
|
817
|
+
</div>
|
|
818
|
+
|
|
819
|
+
</div>
|
|
820
|
+
</body>
|
|
821
|
+
</html>
|