rrtf 0.1.1 → 0.1.2
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/README.md +31 -7
- data/documentation/RRTF/CharacterFormatting.html +1002 -0
- data/documentation/RRTF/CharacterStyle.html +1058 -0
- data/documentation/RRTF/Colour.html +813 -0
- data/documentation/RRTF/ColourTable.html +770 -0
- data/documentation/RRTF/CommandNode.html +2372 -0
- data/documentation/RRTF/ContainerNode.html +826 -0
- data/documentation/RRTF/Converters/HTML/Helpers.html +272 -0
- data/documentation/RRTF/Converters/HTML/Node.html +364 -0
- data/documentation/RRTF/Converters/HTML/NodeSet.html +265 -0
- data/documentation/RRTF/Converters/HTML.html +337 -0
- data/documentation/RRTF/Converters.html +117 -0
- data/documentation/RRTF/Document.html +2405 -0
- data/documentation/RRTF/DocumentStyle.html +1367 -0
- data/documentation/RRTF/Font.html +790 -0
- data/documentation/RRTF/FontTable.html +763 -0
- data/documentation/RRTF/FooterNode.html +515 -0
- data/documentation/RRTF/HeaderNode.html +515 -0
- data/documentation/RRTF/ImageNode.html +1374 -0
- data/documentation/RRTF/Information.html +809 -0
- data/documentation/RRTF/LinkNode.html +264 -0
- data/documentation/RRTF/ListLevel.html +799 -0
- data/documentation/RRTF/ListLevelNode.html +612 -0
- data/documentation/RRTF/ListMarker.html +595 -0
- data/documentation/RRTF/ListNode.html +368 -0
- data/documentation/RRTF/ListTable.html +343 -0
- data/documentation/RRTF/ListTemplate.html +433 -0
- data/documentation/RRTF/ListTextNode.html +285 -0
- data/documentation/RRTF/Node.html +616 -0
- data/documentation/RRTF/Paper.html +624 -0
- data/documentation/RRTF/ParagraphFormatting.html +749 -0
- data/documentation/RRTF/ParagraphNode.html +275 -0
- data/documentation/RRTF/ParagraphStyle.html +1319 -0
- data/documentation/RRTF/RTFError.html +295 -0
- data/documentation/RRTF/Style.html +1767 -0
- data/documentation/RRTF/Stylesheet.html +1768 -0
- data/documentation/RRTF/TableCellNode.html +1704 -0
- data/documentation/RRTF/TableNode.html +1025 -0
- data/documentation/RRTF/TableRowNode.html +675 -0
- data/documentation/RRTF/TextNode.html +600 -0
- data/documentation/RRTF/Utilities.html +201 -0
- data/documentation/RRTF.html +129 -0
- data/documentation/_index.html +478 -0
- data/documentation/class_list.html +51 -0
- data/documentation/css/common.css +1 -0
- data/documentation/css/full_list.css +58 -0
- data/documentation/css/style.css +492 -0
- data/documentation/file.README.html +223 -0
- data/documentation/file_list.html +56 -0
- data/documentation/frames.html +17 -0
- data/documentation/index.html +223 -0
- data/documentation/js/app.js +248 -0
- data/documentation/js/full_list.js +216 -0
- data/documentation/js/jquery.js +4 -0
- data/documentation/method_list.html +2203 -0
- data/documentation/top-level-namespace.html +110 -0
- data/examples/01.rtf +14 -17
- data/examples/01_mac_word15_36.png +0 -0
- data/examples/01_styles_and_paragraphs.rb +3 -4
- data/examples/resources/json/redshirt_styles.json +4 -2
- data/lib/rrtf/node.rb +86 -167
- data/lib/rrtf/style/character_style.rb +4 -3
- data/lib/rrtf/style/formatting.rb +55 -11
- data/lib/rrtf/style/paragraph_style.rb +19 -4
- data/lib/rrtf/style/style.rb +15 -15
- data/lib/rrtf/stylesheet.rb +57 -16
- data/lib/rrtf/version.rb +1 -1
- data/rrtf.gemspec +1 -0
- metadata +70 -1
|
@@ -0,0 +1,813 @@
|
|
|
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::Colour
|
|
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::Colour";
|
|
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 (C)</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">Colour</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::Colour
|
|
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::Colour</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/colour.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>This class represents a colour within a RTF document.</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
118
|
+
<ul class="summary">
|
|
119
|
+
|
|
120
|
+
<li class="public ">
|
|
121
|
+
<span class="summary_signature">
|
|
122
|
+
|
|
123
|
+
<a href="#blue-instance_method" title="#blue (instance method)">#<strong>blue</strong> ⇒ Object </a>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
</span>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
<span class="note title readonly">readonly</span>
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<span class="summary_desc"><div class='inline'>
|
|
143
|
+
<p>Attribute accessor.</p>
|
|
144
|
+
</div></span>
|
|
145
|
+
|
|
146
|
+
</li>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<li class="public ">
|
|
150
|
+
<span class="summary_signature">
|
|
151
|
+
|
|
152
|
+
<a href="#green-instance_method" title="#green (instance method)">#<strong>green</strong> ⇒ Object </a>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
</span>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<span class="note title readonly">readonly</span>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<span class="summary_desc"><div class='inline'>
|
|
172
|
+
<p>Attribute accessor.</p>
|
|
173
|
+
</div></span>
|
|
174
|
+
|
|
175
|
+
</li>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
<li class="public ">
|
|
179
|
+
<span class="summary_signature">
|
|
180
|
+
|
|
181
|
+
<a href="#red-instance_method" title="#red (instance method)">#<strong>red</strong> ⇒ Object </a>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</span>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<span class="note title readonly">readonly</span>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<span class="summary_desc"><div class='inline'>
|
|
201
|
+
<p>Attribute accessor.</p>
|
|
202
|
+
</div></span>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
</ul>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
<h2>
|
|
214
|
+
Class Method Summary
|
|
215
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
216
|
+
</h2>
|
|
217
|
+
|
|
218
|
+
<ul class="summary">
|
|
219
|
+
|
|
220
|
+
<li class="public ">
|
|
221
|
+
<span class="summary_signature">
|
|
222
|
+
|
|
223
|
+
<a href="#from_string-class_method" title="from_string (class method)">.<strong>from_string</strong>(str) ⇒ Object </a>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
</span>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<span class="summary_desc"><div class='inline'>
|
|
238
|
+
<p>Format: HEX RGB with '#' prefix.</p>
|
|
239
|
+
</div></span>
|
|
240
|
+
|
|
241
|
+
</li>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
</ul>
|
|
245
|
+
|
|
246
|
+
<h2>
|
|
247
|
+
Instance Method Summary
|
|
248
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
249
|
+
</h2>
|
|
250
|
+
|
|
251
|
+
<ul class="summary">
|
|
252
|
+
|
|
253
|
+
<li class="public ">
|
|
254
|
+
<span class="summary_signature">
|
|
255
|
+
|
|
256
|
+
<a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(object) ⇒ Object </a>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
</span>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
<span class="summary_desc"><div class='inline'>
|
|
271
|
+
<p>This method overloads the comparison operator for the Colour class.</p>
|
|
272
|
+
</div></span>
|
|
273
|
+
|
|
274
|
+
</li>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<li class="public ">
|
|
278
|
+
<span class="summary_signature">
|
|
279
|
+
|
|
280
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(red, green, blue) ⇒ Colour </a>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
<span class="note title constructor">constructor</span>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<span class="summary_desc"><div class='inline'>
|
|
297
|
+
<p>This is the constructor for the Colour class.</p>
|
|
298
|
+
</div></span>
|
|
299
|
+
|
|
300
|
+
</li>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<li class="public ">
|
|
304
|
+
<span class="summary_signature">
|
|
305
|
+
|
|
306
|
+
<a href="#to_rtf-instance_method" title="#to_rtf (instance method)">#<strong>to_rtf</strong>(indent = 0) ⇒ Object </a>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</span>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<span class="summary_desc"><div class='inline'>
|
|
321
|
+
<p>This method generates the RTF text for a Colour object.</p>
|
|
322
|
+
</div></span>
|
|
323
|
+
|
|
324
|
+
</li>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<li class="public ">
|
|
328
|
+
<span class="summary_signature">
|
|
329
|
+
|
|
330
|
+
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong>(indent = 0) ⇒ Object </a>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
</span>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<span class="summary_desc"><div class='inline'>
|
|
345
|
+
<p>This method returns a textual description for a Colour object.</p>
|
|
346
|
+
</div></span>
|
|
347
|
+
|
|
348
|
+
</li>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
</ul>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
<div id="constructor_details" class="method_details_list">
|
|
355
|
+
<h2>Constructor Details</h2>
|
|
356
|
+
|
|
357
|
+
<div class="method_details first">
|
|
358
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
359
|
+
|
|
360
|
+
#<strong>initialize</strong>(red, green, blue) ⇒ <tt><span class='object_link'><a href="" title="RRTF::Colour (class)">Colour</a></span></tt>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
</h3><div class="docstring">
|
|
367
|
+
<div class="discussion">
|
|
368
|
+
|
|
369
|
+
<p>This is the constructor for the Colour class.</p>
|
|
370
|
+
|
|
371
|
+
<h4 id="label-Parameters">Parameters</h4>
|
|
372
|
+
<dl class="rdoc-list note-list"><dt>red
|
|
373
|
+
<dd>
|
|
374
|
+
<p>The intensity setting for red in the colour. Must be an integer between 0
|
|
375
|
+
and 255.</p>
|
|
376
|
+
</dd><dt>green
|
|
377
|
+
<dd>
|
|
378
|
+
<p>The intensity setting for green in the colour. Must be an integer between 0
|
|
379
|
+
and 255.</p>
|
|
380
|
+
</dd><dt>blue
|
|
381
|
+
<dd>
|
|
382
|
+
<p>The intensity setting for blue in the colour. Must be an integer between 0
|
|
383
|
+
and 255.</p>
|
|
384
|
+
</dd></dl>
|
|
385
|
+
|
|
386
|
+
<h4 id="label-Exceptions">Exceptions</h4>
|
|
387
|
+
<dl class="rdoc-list note-list"><dt>RTFError
|
|
388
|
+
<dd>
|
|
389
|
+
<p>Generated whenever an invalid intensity setting is specified for the red,
|
|
390
|
+
green or blue values.</p>
|
|
391
|
+
</dd></dl>
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
</div>
|
|
395
|
+
</div>
|
|
396
|
+
<div class="tags">
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
</div><table class="source_code">
|
|
400
|
+
<tr>
|
|
401
|
+
<td>
|
|
402
|
+
<pre class="lines">
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
34
|
|
406
|
+
35
|
|
407
|
+
36
|
|
408
|
+
37
|
|
409
|
+
38
|
|
410
|
+
39
|
|
411
|
+
40
|
|
412
|
+
41
|
|
413
|
+
42
|
|
414
|
+
43
|
|
415
|
+
44
|
|
416
|
+
45
|
|
417
|
+
46
|
|
418
|
+
47
|
|
419
|
+
48
|
|
420
|
+
49
|
|
421
|
+
50
|
|
422
|
+
51</pre>
|
|
423
|
+
</td>
|
|
424
|
+
<td>
|
|
425
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 34</span>
|
|
426
|
+
|
|
427
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_red'>red</span><span class='comma'>,</span> <span class='id identifier rubyid_green'>green</span><span class='comma'>,</span> <span class='id identifier rubyid_blue'>blue</span><span class='rparen'>)</span>
|
|
428
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_red'>red</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_red'>red</span> <span class='op'><</span> <span class='int'>0</span> <span class='op'>||</span> <span class='id identifier rubyid_red'>red</span> <span class='op'>></span> <span class='int'>255</span>
|
|
429
|
+
<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 red intensity setting ('</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_red'>red</span><span class='embexpr_end'>}</span><span class='tstring_content'>') specified </span><span class='tstring_end'>"</span></span>\
|
|
430
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>for a Colour object.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
431
|
+
<span class='kw'>end</span>
|
|
432
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_green'>green</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_green'>green</span> <span class='op'><</span> <span class='int'>0</span> <span class='op'>||</span> <span class='id identifier rubyid_green'>green</span> <span class='op'>></span> <span class='int'>255</span>
|
|
433
|
+
<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 green intensity setting ('</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_green'>green</span><span class='embexpr_end'>}</span><span class='tstring_content'>') </span><span class='tstring_end'>"</span></span>\
|
|
434
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>specified for a Colour object.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
435
|
+
<span class='kw'>end</span>
|
|
436
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_blue'>blue</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_blue'>blue</span> <span class='op'><</span> <span class='int'>0</span> <span class='op'>||</span> <span class='id identifier rubyid_blue'>blue</span> <span class='op'>></span> <span class='int'>255</span>
|
|
437
|
+
<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 blue intensity setting ('</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_blue'>blue</span><span class='embexpr_end'>}</span><span class='tstring_content'>') </span><span class='tstring_end'>"</span></span>\
|
|
438
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>specified for a Colour object.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
439
|
+
<span class='kw'>end</span>
|
|
440
|
+
|
|
441
|
+
<span class='ivar'>@red</span> <span class='op'>=</span> <span class='id identifier rubyid_red'>red</span>
|
|
442
|
+
<span class='ivar'>@green</span> <span class='op'>=</span> <span class='id identifier rubyid_green'>green</span>
|
|
443
|
+
<span class='ivar'>@blue</span> <span class='op'>=</span> <span class='id identifier rubyid_blue'>blue</span>
|
|
444
|
+
<span class='kw'>end</span></pre>
|
|
445
|
+
</td>
|
|
446
|
+
</tr>
|
|
447
|
+
</table>
|
|
448
|
+
</div>
|
|
449
|
+
|
|
450
|
+
</div>
|
|
451
|
+
|
|
452
|
+
<div id="instance_attr_details" class="attr_details">
|
|
453
|
+
<h2>Instance Attribute Details</h2>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
<span id=""></span>
|
|
457
|
+
<div class="method_details first">
|
|
458
|
+
<h3 class="signature first" id="blue-instance_method">
|
|
459
|
+
|
|
460
|
+
#<strong>blue</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
</h3><div class="docstring">
|
|
467
|
+
<div class="discussion">
|
|
468
|
+
|
|
469
|
+
<p>Attribute accessor.</p>
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
</div>
|
|
473
|
+
</div>
|
|
474
|
+
<div class="tags">
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
</div><table class="source_code">
|
|
478
|
+
<tr>
|
|
479
|
+
<td>
|
|
480
|
+
<pre class="lines">
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
7
|
|
484
|
+
8
|
|
485
|
+
9</pre>
|
|
486
|
+
</td>
|
|
487
|
+
<td>
|
|
488
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 7</span>
|
|
489
|
+
|
|
490
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_blue'>blue</span>
|
|
491
|
+
<span class='ivar'>@blue</span>
|
|
492
|
+
<span class='kw'>end</span></pre>
|
|
493
|
+
</td>
|
|
494
|
+
</tr>
|
|
495
|
+
</table>
|
|
496
|
+
</div>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
<span id=""></span>
|
|
500
|
+
<div class="method_details ">
|
|
501
|
+
<h3 class="signature " id="green-instance_method">
|
|
502
|
+
|
|
503
|
+
#<strong>green</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
</h3><div class="docstring">
|
|
510
|
+
<div class="discussion">
|
|
511
|
+
|
|
512
|
+
<p>Attribute accessor.</p>
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
</div>
|
|
516
|
+
</div>
|
|
517
|
+
<div class="tags">
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
</div><table class="source_code">
|
|
521
|
+
<tr>
|
|
522
|
+
<td>
|
|
523
|
+
<pre class="lines">
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
7
|
|
527
|
+
8
|
|
528
|
+
9</pre>
|
|
529
|
+
</td>
|
|
530
|
+
<td>
|
|
531
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 7</span>
|
|
532
|
+
|
|
533
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_green'>green</span>
|
|
534
|
+
<span class='ivar'>@green</span>
|
|
535
|
+
<span class='kw'>end</span></pre>
|
|
536
|
+
</td>
|
|
537
|
+
</tr>
|
|
538
|
+
</table>
|
|
539
|
+
</div>
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
<span id=""></span>
|
|
543
|
+
<div class="method_details ">
|
|
544
|
+
<h3 class="signature " id="red-instance_method">
|
|
545
|
+
|
|
546
|
+
#<strong>red</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
</h3><div class="docstring">
|
|
553
|
+
<div class="discussion">
|
|
554
|
+
|
|
555
|
+
<p>Attribute accessor.</p>
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
</div>
|
|
559
|
+
</div>
|
|
560
|
+
<div class="tags">
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
</div><table class="source_code">
|
|
564
|
+
<tr>
|
|
565
|
+
<td>
|
|
566
|
+
<pre class="lines">
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
7
|
|
570
|
+
8
|
|
571
|
+
9</pre>
|
|
572
|
+
</td>
|
|
573
|
+
<td>
|
|
574
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 7</span>
|
|
575
|
+
|
|
576
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_red'>red</span>
|
|
577
|
+
<span class='ivar'>@red</span>
|
|
578
|
+
<span class='kw'>end</span></pre>
|
|
579
|
+
</td>
|
|
580
|
+
</tr>
|
|
581
|
+
</table>
|
|
582
|
+
</div>
|
|
583
|
+
|
|
584
|
+
</div>
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
<div id="class_method_details" class="method_details_list">
|
|
588
|
+
<h2>Class Method Details</h2>
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
<div class="method_details first">
|
|
592
|
+
<h3 class="signature first" id="from_string-class_method">
|
|
593
|
+
|
|
594
|
+
.<strong>from_string</strong>(str) ⇒ <tt>Object</tt>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</h3><div class="docstring">
|
|
601
|
+
<div class="discussion">
|
|
602
|
+
|
|
603
|
+
<p>Format: HEX RGB with '#' prefix</p>
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
</div>
|
|
607
|
+
</div>
|
|
608
|
+
<div class="tags">
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
</div><table class="source_code">
|
|
612
|
+
<tr>
|
|
613
|
+
<td>
|
|
614
|
+
<pre class="lines">
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
11
|
|
618
|
+
12
|
|
619
|
+
13
|
|
620
|
+
14
|
|
621
|
+
15
|
|
622
|
+
16
|
|
623
|
+
17
|
|
624
|
+
18</pre>
|
|
625
|
+
</td>
|
|
626
|
+
<td>
|
|
627
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 11</span>
|
|
628
|
+
|
|
629
|
+
<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_str'>str</span><span class='rparen'>)</span>
|
|
630
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\#[0-9a-f]{6}</span><span class='regexp_end'>/i</span></span>
|
|
631
|
+
<span class='id identifier rubyid_m'>m</span> <span class='op'>=</span> <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})</span><span class='regexp_end'>/i</span></span>
|
|
632
|
+
<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_m'>m</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_hex'>hex</span><span class='comma'>,</span> <span class='id identifier rubyid_m'>m</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_hex'>hex</span><span class='comma'>,</span> <span class='id identifier rubyid_m'>m</span><span class='lbracket'>[</span><span class='int'>3</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_hex'>hex</span><span class='rparen'>)</span>
|
|
633
|
+
<span class='kw'>else</span>
|
|
634
|
+
<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'>Unreconized string colour format '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_str'>str</span><span class='embexpr_end'>}</span><span class='tstring_content'>'.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
635
|
+
<span class='kw'>end</span>
|
|
636
|
+
<span class='kw'>end</span></pre>
|
|
637
|
+
</td>
|
|
638
|
+
</tr>
|
|
639
|
+
</table>
|
|
640
|
+
</div>
|
|
641
|
+
|
|
642
|
+
</div>
|
|
643
|
+
|
|
644
|
+
<div id="instance_method_details" class="method_details_list">
|
|
645
|
+
<h2>Instance Method Details</h2>
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
<div class="method_details first">
|
|
649
|
+
<h3 class="signature first" id="==-instance_method">
|
|
650
|
+
|
|
651
|
+
#<strong>==</strong>(object) ⇒ <tt>Object</tt>
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
</h3><div class="docstring">
|
|
658
|
+
<div class="discussion">
|
|
659
|
+
|
|
660
|
+
<p>This method overloads the comparison operator for the Colour class.</p>
|
|
661
|
+
|
|
662
|
+
<h4 id="label-Parameters">Parameters</h4>
|
|
663
|
+
<dl class="rdoc-list note-list"><dt>object
|
|
664
|
+
<dd>
|
|
665
|
+
<p>A reference to the object to be compared with.</p>
|
|
666
|
+
</dd></dl>
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
</div>
|
|
670
|
+
</div>
|
|
671
|
+
<div class="tags">
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
</div><table class="source_code">
|
|
675
|
+
<tr>
|
|
676
|
+
<td>
|
|
677
|
+
<pre class="lines">
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
57
|
|
681
|
+
58
|
|
682
|
+
59
|
|
683
|
+
60
|
|
684
|
+
61
|
|
685
|
+
62</pre>
|
|
686
|
+
</td>
|
|
687
|
+
<td>
|
|
688
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 57</span>
|
|
689
|
+
|
|
690
|
+
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
|
|
691
|
+
<span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_instance_of?'>instance_of?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="" title="RRTF::Colour (class)">Colour</a></span></span><span class='rparen'>)</span> <span class='kw'>and</span>
|
|
692
|
+
<span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_red'>red</span> <span class='op'>==</span> <span class='ivar'>@red</span> <span class='kw'>and</span>
|
|
693
|
+
<span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_green'>green</span> <span class='op'>==</span> <span class='ivar'>@green</span> <span class='kw'>and</span>
|
|
694
|
+
<span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_blue'>blue</span> <span class='op'>==</span> <span class='ivar'>@blue</span>
|
|
695
|
+
<span class='kw'>end</span></pre>
|
|
696
|
+
</td>
|
|
697
|
+
</tr>
|
|
698
|
+
</table>
|
|
699
|
+
</div>
|
|
700
|
+
|
|
701
|
+
<div class="method_details ">
|
|
702
|
+
<h3 class="signature " id="to_rtf-instance_method">
|
|
703
|
+
|
|
704
|
+
#<strong>to_rtf</strong>(indent = 0) ⇒ <tt>Object</tt>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
</h3><div class="docstring">
|
|
711
|
+
<div class="discussion">
|
|
712
|
+
|
|
713
|
+
<p>This method generates the RTF text for a Colour object.</p>
|
|
714
|
+
|
|
715
|
+
<h4 id="label-Parameters">Parameters</h4>
|
|
716
|
+
<dl class="rdoc-list note-list"><dt>indent
|
|
717
|
+
<dd>
|
|
718
|
+
<p>The number of spaces to prefix to the lines created by the method. Defaults
|
|
719
|
+
to zero.</p>
|
|
720
|
+
</dd></dl>
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
</div>
|
|
724
|
+
</div>
|
|
725
|
+
<div class="tags">
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
</div><table class="source_code">
|
|
729
|
+
<tr>
|
|
730
|
+
<td>
|
|
731
|
+
<pre class="lines">
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
79
|
|
735
|
+
80
|
|
736
|
+
81
|
|
737
|
+
82</pre>
|
|
738
|
+
</td>
|
|
739
|
+
<td>
|
|
740
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 79</span>
|
|
741
|
+
|
|
742
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='lparen'>(</span><span class='id identifier rubyid_indent'>indent</span><span class='op'>=</span><span class='int'>0</span><span class='rparen'>)</span>
|
|
743
|
+
<span class='id identifier rubyid_prefix'>prefix</span> <span class='op'>=</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>></span> <span class='int'>0</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span> <span class='op'>*</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
|
|
744
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>\\red</span><span class='embexpr_beg'>#{</span><span class='ivar'>@red</span><span class='embexpr_end'>}</span><span class='tstring_content'>\\green</span><span class='embexpr_beg'>#{</span><span class='ivar'>@green</span><span class='embexpr_end'>}</span><span class='tstring_content'>\\blue</span><span class='embexpr_beg'>#{</span><span class='ivar'>@blue</span><span class='embexpr_end'>}</span><span class='tstring_content'>;</span><span class='tstring_end'>"</span></span>
|
|
745
|
+
<span class='kw'>end</span></pre>
|
|
746
|
+
</td>
|
|
747
|
+
</tr>
|
|
748
|
+
</table>
|
|
749
|
+
</div>
|
|
750
|
+
|
|
751
|
+
<div class="method_details ">
|
|
752
|
+
<h3 class="signature " id="to_s-instance_method">
|
|
753
|
+
|
|
754
|
+
#<strong>to_s</strong>(indent = 0) ⇒ <tt>Object</tt>
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
</h3><div class="docstring">
|
|
761
|
+
<div class="discussion">
|
|
762
|
+
|
|
763
|
+
<p>This method returns a textual description for a Colour object.</p>
|
|
764
|
+
|
|
765
|
+
<h4 id="label-Parameters">Parameters</h4>
|
|
766
|
+
<dl class="rdoc-list note-list"><dt>indent
|
|
767
|
+
<dd>
|
|
768
|
+
<p>The number of spaces to prefix to the lines created by the method. Defaults
|
|
769
|
+
to zero.</p>
|
|
770
|
+
</dd></dl>
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
</div>
|
|
774
|
+
</div>
|
|
775
|
+
<div class="tags">
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
</div><table class="source_code">
|
|
779
|
+
<tr>
|
|
780
|
+
<td>
|
|
781
|
+
<pre class="lines">
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
69
|
|
785
|
+
70
|
|
786
|
+
71
|
|
787
|
+
72</pre>
|
|
788
|
+
</td>
|
|
789
|
+
<td>
|
|
790
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 69</span>
|
|
791
|
+
|
|
792
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span><span class='lparen'>(</span><span class='id identifier rubyid_indent'>indent</span><span class='op'>=</span><span class='int'>0</span><span class='rparen'>)</span>
|
|
793
|
+
<span class='id identifier rubyid_prefix'>prefix</span> <span class='op'>=</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>></span> <span class='int'>0</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span> <span class='op'>*</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
|
|
794
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>Colour (</span><span class='embexpr_beg'>#{</span><span class='ivar'>@red</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@green</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@blue</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>"</span></span>
|
|
795
|
+
<span class='kw'>end</span></pre>
|
|
796
|
+
</td>
|
|
797
|
+
</tr>
|
|
798
|
+
</table>
|
|
799
|
+
</div>
|
|
800
|
+
|
|
801
|
+
</div>
|
|
802
|
+
|
|
803
|
+
</div>
|
|
804
|
+
|
|
805
|
+
<div id="footer">
|
|
806
|
+
Generated on Mon Jul 24 15:49:01 2017 by
|
|
807
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
808
|
+
0.9.9 (ruby-2.3.3).
|
|
809
|
+
</div>
|
|
810
|
+
|
|
811
|
+
</div>
|
|
812
|
+
</body>
|
|
813
|
+
</html>
|