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,1374 @@
|
|
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::ImageNode
|
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::ImageNode";
|
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 (I)</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">ImageNode</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::ImageNode
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
<dl>
|
70
|
+
<dt>Inherits:</dt>
|
71
|
+
<dd>
|
72
|
+
<span class="inheritName"><span class='object_link'><a href="Node.html" title="RRTF::Node (class)">Node</a></span></span>
|
73
|
+
|
74
|
+
<ul class="fullTree">
|
75
|
+
<li>Object</li>
|
76
|
+
|
77
|
+
<li class="next"><span class='object_link'><a href="Node.html" title="RRTF::Node (class)">Node</a></span></li>
|
78
|
+
|
79
|
+
<li class="next">RRTF::ImageNode</li>
|
80
|
+
|
81
|
+
</ul>
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
83
|
+
|
84
|
+
</dd>
|
85
|
+
</dl>
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
<dl>
|
98
|
+
<dt>Defined in:</dt>
|
99
|
+
<dd>lib/rrtf/node.rb</dd>
|
100
|
+
</dl>
|
101
|
+
|
102
|
+
</div>
|
103
|
+
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
105
|
+
<div class="discussion">
|
106
|
+
|
107
|
+
<p>This class represents an image within a RTF document. Currently only the
|
108
|
+
PNG, JPEG and Windows Bitmap formats are supported. Efforts are made to
|
109
|
+
identify the file type but these are not guaranteed to work.</p>
|
110
|
+
|
111
|
+
|
112
|
+
</div>
|
113
|
+
</div>
|
114
|
+
<div class="tags">
|
115
|
+
|
116
|
+
|
117
|
+
</div>
|
118
|
+
<h2>Constant Summary</h2>
|
119
|
+
<dl class="constants">
|
120
|
+
|
121
|
+
<dt id="PNG-constant" class="">PNG =
|
122
|
+
<div class="docstring">
|
123
|
+
<div class="discussion">
|
124
|
+
|
125
|
+
<p>A definition for an image type constant.</p>
|
126
|
+
|
127
|
+
|
128
|
+
</div>
|
129
|
+
</div>
|
130
|
+
<div class="tags">
|
131
|
+
|
132
|
+
|
133
|
+
</div>
|
134
|
+
</dt>
|
135
|
+
<dd><pre class="code"><span class='symbol'>:pngblip</span></pre></dd>
|
136
|
+
|
137
|
+
<dt id="JPEG-constant" class="">JPEG =
|
138
|
+
<div class="docstring">
|
139
|
+
<div class="discussion">
|
140
|
+
|
141
|
+
<p>A definition for an image type constant.</p>
|
142
|
+
|
143
|
+
|
144
|
+
</div>
|
145
|
+
</div>
|
146
|
+
<div class="tags">
|
147
|
+
|
148
|
+
|
149
|
+
</div>
|
150
|
+
</dt>
|
151
|
+
<dd><pre class="code"><span class='symbol'>:jpegblip</span></pre></dd>
|
152
|
+
|
153
|
+
<dt id="BITMAP-constant" class="">BITMAP =
|
154
|
+
<div class="docstring">
|
155
|
+
<div class="discussion">
|
156
|
+
|
157
|
+
<p>A definition for an image type constant.</p>
|
158
|
+
|
159
|
+
|
160
|
+
</div>
|
161
|
+
</div>
|
162
|
+
<div class="tags">
|
163
|
+
|
164
|
+
|
165
|
+
</div>
|
166
|
+
</dt>
|
167
|
+
<dd><pre class="code"><span class='symbol'>:dibitmap0</span></pre></dd>
|
168
|
+
|
169
|
+
<dt id="LITTLE_ENDIAN-constant" class="">LITTLE_ENDIAN =
|
170
|
+
<div class="docstring">
|
171
|
+
<div class="discussion">
|
172
|
+
|
173
|
+
<p>A definition for an architecture endian constant.</p>
|
174
|
+
|
175
|
+
|
176
|
+
</div>
|
177
|
+
</div>
|
178
|
+
<div class="tags">
|
179
|
+
|
180
|
+
|
181
|
+
</div>
|
182
|
+
</dt>
|
183
|
+
<dd><pre class="code"><span class='symbol'>:little</span></pre></dd>
|
184
|
+
|
185
|
+
<dt id="BIG_ENDIAN-constant" class="">BIG_ENDIAN =
|
186
|
+
<div class="docstring">
|
187
|
+
<div class="discussion">
|
188
|
+
|
189
|
+
<p>A definition for an architecture endian constant.</p>
|
190
|
+
|
191
|
+
|
192
|
+
</div>
|
193
|
+
</div>
|
194
|
+
<div class="tags">
|
195
|
+
|
196
|
+
|
197
|
+
</div>
|
198
|
+
</dt>
|
199
|
+
<dd><pre class="code"><span class='symbol'>:big</span></pre></dd>
|
200
|
+
|
201
|
+
<dt id="DIMENSIONS_OFFSET-constant" class="">DIMENSIONS_OFFSET =
|
202
|
+
<div class="docstring">
|
203
|
+
<div class="discussion">
|
204
|
+
|
205
|
+
<p>Offsets for reading dimension data by filetype</p>
|
206
|
+
|
207
|
+
|
208
|
+
</div>
|
209
|
+
</div>
|
210
|
+
<div class="tags">
|
211
|
+
|
212
|
+
|
213
|
+
</div>
|
214
|
+
</dt>
|
215
|
+
<dd><pre class="code"><span class='lbrace'>{</span>
|
216
|
+
<span class='const'><span class='object_link'><a href="#JPEG-constant" title="RRTF::ImageNode::JPEG (constant)">JPEG</a></span></span> <span class='op'>=></span> <span class='int'>2</span><span class='comma'>,</span>
|
217
|
+
<span class='const'><span class='object_link'><a href="#PNG-constant" title="RRTF::ImageNode::PNG (constant)">PNG</a></span></span> <span class='op'>=></span> <span class='int'>8</span><span class='comma'>,</span>
|
218
|
+
<span class='const'><span class='object_link'><a href="#BITMAP-constant" title="RRTF::ImageNode::BITMAP (constant)">BITMAP</a></span></span> <span class='op'>=></span> <span class='int'>8</span><span class='comma'>,</span>
|
219
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
220
|
+
|
221
|
+
</dl>
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
227
|
+
<ul class="summary">
|
228
|
+
|
229
|
+
<li class="public ">
|
230
|
+
<span class="summary_signature">
|
231
|
+
|
232
|
+
<a href="#bottom_crop-instance_method" title="#bottom_crop (instance method)">#<strong>bottom_crop</strong> ⇒ Object </a>
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
</span>
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
<span class="summary_desc"><div class='inline'>
|
250
|
+
<p>Attribute accessor.</p>
|
251
|
+
</div></span>
|
252
|
+
|
253
|
+
</li>
|
254
|
+
|
255
|
+
|
256
|
+
<li class="public ">
|
257
|
+
<span class="summary_signature">
|
258
|
+
|
259
|
+
<a href="#displayed_height-instance_method" title="#displayed_height (instance method)">#<strong>displayed_height</strong> ⇒ Object </a>
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
</span>
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
<span class="summary_desc"><div class='inline'>
|
277
|
+
<p>Attribute accessor.</p>
|
278
|
+
</div></span>
|
279
|
+
|
280
|
+
</li>
|
281
|
+
|
282
|
+
|
283
|
+
<li class="public ">
|
284
|
+
<span class="summary_signature">
|
285
|
+
|
286
|
+
<a href="#displayed_width-instance_method" title="#displayed_width (instance method)">#<strong>displayed_width</strong> ⇒ Object </a>
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
</span>
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
|
297
|
+
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
<span class="summary_desc"><div class='inline'>
|
304
|
+
<p>Attribute accessor.</p>
|
305
|
+
</div></span>
|
306
|
+
|
307
|
+
</li>
|
308
|
+
|
309
|
+
|
310
|
+
<li class="public ">
|
311
|
+
<span class="summary_signature">
|
312
|
+
|
313
|
+
<a href="#height-instance_method" title="#height (instance method)">#<strong>height</strong> ⇒ Object </a>
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
</span>
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
<span class="note title readonly">readonly</span>
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
<span class="summary_desc"><div class='inline'>
|
333
|
+
<p>Attribute accessor.</p>
|
334
|
+
</div></span>
|
335
|
+
|
336
|
+
</li>
|
337
|
+
|
338
|
+
|
339
|
+
<li class="public ">
|
340
|
+
<span class="summary_signature">
|
341
|
+
|
342
|
+
<a href="#left_crop-instance_method" title="#left_crop (instance method)">#<strong>left_crop</strong> ⇒ Object </a>
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
</span>
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
|
353
|
+
|
354
|
+
|
355
|
+
|
356
|
+
|
357
|
+
|
358
|
+
|
359
|
+
<span class="summary_desc"><div class='inline'>
|
360
|
+
<p>Attribute accessor.</p>
|
361
|
+
</div></span>
|
362
|
+
|
363
|
+
</li>
|
364
|
+
|
365
|
+
|
366
|
+
<li class="public ">
|
367
|
+
<span class="summary_signature">
|
368
|
+
|
369
|
+
<a href="#right_crop-instance_method" title="#right_crop (instance method)">#<strong>right_crop</strong> ⇒ Object </a>
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
</span>
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
<span class="summary_desc"><div class='inline'>
|
387
|
+
<p>Attribute accessor.</p>
|
388
|
+
</div></span>
|
389
|
+
|
390
|
+
</li>
|
391
|
+
|
392
|
+
|
393
|
+
<li class="public ">
|
394
|
+
<span class="summary_signature">
|
395
|
+
|
396
|
+
<a href="#top_crop-instance_method" title="#top_crop (instance method)">#<strong>top_crop</strong> ⇒ Object </a>
|
397
|
+
|
398
|
+
|
399
|
+
|
400
|
+
</span>
|
401
|
+
|
402
|
+
|
403
|
+
|
404
|
+
|
405
|
+
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
<span class="summary_desc"><div class='inline'>
|
414
|
+
<p>Attribute accessor.</p>
|
415
|
+
</div></span>
|
416
|
+
|
417
|
+
</li>
|
418
|
+
|
419
|
+
|
420
|
+
<li class="public ">
|
421
|
+
<span class="summary_signature">
|
422
|
+
|
423
|
+
<a href="#width-instance_method" title="#width (instance method)">#<strong>width</strong> ⇒ Object </a>
|
424
|
+
|
425
|
+
|
426
|
+
|
427
|
+
</span>
|
428
|
+
|
429
|
+
|
430
|
+
|
431
|
+
|
432
|
+
<span class="note title readonly">readonly</span>
|
433
|
+
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
<span class="summary_desc"><div class='inline'>
|
443
|
+
<p>Attribute accessor.</p>
|
444
|
+
</div></span>
|
445
|
+
|
446
|
+
</li>
|
447
|
+
|
448
|
+
|
449
|
+
<li class="public ">
|
450
|
+
<span class="summary_signature">
|
451
|
+
|
452
|
+
<a href="#x_scaling-instance_method" title="#x_scaling (instance method)">#<strong>x_scaling</strong> ⇒ Object </a>
|
453
|
+
|
454
|
+
|
455
|
+
|
456
|
+
</span>
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
|
465
|
+
|
466
|
+
|
467
|
+
|
468
|
+
|
469
|
+
<span class="summary_desc"><div class='inline'>
|
470
|
+
<p>Attribute accessor.</p>
|
471
|
+
</div></span>
|
472
|
+
|
473
|
+
</li>
|
474
|
+
|
475
|
+
|
476
|
+
<li class="public ">
|
477
|
+
<span class="summary_signature">
|
478
|
+
|
479
|
+
<a href="#y_scaling-instance_method" title="#y_scaling (instance method)">#<strong>y_scaling</strong> ⇒ Object </a>
|
480
|
+
|
481
|
+
|
482
|
+
|
483
|
+
</span>
|
484
|
+
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
|
489
|
+
|
490
|
+
|
491
|
+
|
492
|
+
|
493
|
+
|
494
|
+
|
495
|
+
|
496
|
+
<span class="summary_desc"><div class='inline'>
|
497
|
+
<p>Attribute accessor.</p>
|
498
|
+
</div></span>
|
499
|
+
|
500
|
+
</li>
|
501
|
+
|
502
|
+
|
503
|
+
</ul>
|
504
|
+
|
505
|
+
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="RRTF::Node (class)">Node</a></span></h3>
|
510
|
+
<p class="inherited"><span class='object_link'><a href="Node.html#parent-instance_method" title="RRTF::Node#parent (method)">#parent</a></span></p>
|
511
|
+
|
512
|
+
|
513
|
+
|
514
|
+
<h2>
|
515
|
+
Instance Method Summary
|
516
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
517
|
+
</h2>
|
518
|
+
|
519
|
+
<ul class="summary">
|
520
|
+
|
521
|
+
<li class="public ">
|
522
|
+
<span class="summary_signature">
|
523
|
+
|
524
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(parent, source, id) ⇒ ImageNode </a>
|
525
|
+
|
526
|
+
|
527
|
+
|
528
|
+
</span>
|
529
|
+
|
530
|
+
|
531
|
+
<span class="note title constructor">constructor</span>
|
532
|
+
|
533
|
+
|
534
|
+
|
535
|
+
|
536
|
+
|
537
|
+
|
538
|
+
|
539
|
+
|
540
|
+
<span class="summary_desc"><div class='inline'>
|
541
|
+
<p>This is the constructor for the ImageNode class.</p>
|
542
|
+
</div></span>
|
543
|
+
|
544
|
+
</li>
|
545
|
+
|
546
|
+
|
547
|
+
<li class="public ">
|
548
|
+
<span class="summary_signature">
|
549
|
+
|
550
|
+
<a href="#read_source-instance_method" title="#read_source (instance method)">#<strong>read_source</strong>(file, read, size = nil) ⇒ Object </a>
|
551
|
+
|
552
|
+
|
553
|
+
|
554
|
+
</span>
|
555
|
+
|
556
|
+
|
557
|
+
|
558
|
+
|
559
|
+
|
560
|
+
|
561
|
+
|
562
|
+
|
563
|
+
|
564
|
+
<span class="summary_desc"><div class='inline'>
|
565
|
+
<p>This method loads the data for an image from its source.</p>
|
566
|
+
</div></span>
|
567
|
+
|
568
|
+
</li>
|
569
|
+
|
570
|
+
|
571
|
+
<li class="public ">
|
572
|
+
<span class="summary_signature">
|
573
|
+
|
574
|
+
<a href="#to_rtf-instance_method" title="#to_rtf (instance method)">#<strong>to_rtf</strong> ⇒ Object </a>
|
575
|
+
|
576
|
+
|
577
|
+
|
578
|
+
</span>
|
579
|
+
|
580
|
+
|
581
|
+
|
582
|
+
|
583
|
+
|
584
|
+
|
585
|
+
|
586
|
+
|
587
|
+
|
588
|
+
<span class="summary_desc"><div class='inline'>
|
589
|
+
<p>This method generates the RTF for an ImageNode object.</p>
|
590
|
+
</div></span>
|
591
|
+
|
592
|
+
</li>
|
593
|
+
|
594
|
+
|
595
|
+
</ul>
|
596
|
+
|
597
|
+
|
598
|
+
|
599
|
+
|
600
|
+
|
601
|
+
|
602
|
+
|
603
|
+
|
604
|
+
|
605
|
+
|
606
|
+
|
607
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="RRTF::Node (class)">Node</a></span></h3>
|
608
|
+
<p class="inherited"><span class='object_link'><a href="Node.html#is_root%3F-instance_method" title="RRTF::Node#is_root? (method)">#is_root?</a></span>, <span class='object_link'><a href="Node.html#next_node-instance_method" title="RRTF::Node#next_node (method)">#next_node</a></span>, <span class='object_link'><a href="Node.html#previous_node-instance_method" title="RRTF::Node#previous_node (method)">#previous_node</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="RRTF::Node#root (method)">#root</a></span></p>
|
609
|
+
<div id="constructor_details" class="method_details_list">
|
610
|
+
<h2>Constructor Details</h2>
|
611
|
+
|
612
|
+
<div class="method_details first">
|
613
|
+
<h3 class="signature first" id="initialize-instance_method">
|
614
|
+
|
615
|
+
#<strong>initialize</strong>(parent, source, id) ⇒ <tt><span class='object_link'><a href="" title="RRTF::ImageNode (class)">ImageNode</a></span></tt>
|
616
|
+
|
617
|
+
|
618
|
+
|
619
|
+
|
620
|
+
|
621
|
+
</h3><div class="docstring">
|
622
|
+
<div class="discussion">
|
623
|
+
|
624
|
+
<p>This is the constructor for the ImageNode class.</p>
|
625
|
+
|
626
|
+
<h4 id="label-Parameters">Parameters</h4>
|
627
|
+
<dl class="rdoc-list note-list"><dt>parent
|
628
|
+
<dd>
|
629
|
+
<p>A reference to the node that owns the new image node.</p>
|
630
|
+
</dd><dt>source
|
631
|
+
<dd>
|
632
|
+
<p>A reference to the image source. This must be a String or a File.</p>
|
633
|
+
</dd><dt>id
|
634
|
+
<dd>
|
635
|
+
<p>The unique identifier for the image node.</p>
|
636
|
+
</dd></dl>
|
637
|
+
|
638
|
+
<h4 id="label-Exceptions">Exceptions</h4>
|
639
|
+
<dl class="rdoc-list note-list"><dt>RTFError
|
640
|
+
<dd>
|
641
|
+
<p>Generated whenever the image specified is not recognised as a supported
|
642
|
+
image type, something other than a String or File or IO is passed as the
|
643
|
+
source parameter or if the specified source does not exist or cannot be
|
644
|
+
accessed.</p>
|
645
|
+
</dd></dl>
|
646
|
+
|
647
|
+
|
648
|
+
</div>
|
649
|
+
</div>
|
650
|
+
<div class="tags">
|
651
|
+
|
652
|
+
|
653
|
+
</div><table class="source_code">
|
654
|
+
<tr>
|
655
|
+
<td>
|
656
|
+
<pre class="lines">
|
657
|
+
|
658
|
+
|
659
|
+
1301
|
660
|
+
1302
|
661
|
+
1303
|
662
|
+
1304
|
663
|
+
1305
|
664
|
+
1306
|
665
|
+
1307
|
666
|
+
1308
|
667
|
+
1309
|
668
|
+
1310
|
669
|
+
1311
|
670
|
+
1312
|
671
|
+
1313
|
672
|
+
1314
|
673
|
+
1315
|
674
|
+
1316
|
675
|
+
1317
|
676
|
+
1318
|
677
|
+
1319
|
678
|
+
1320
|
679
|
+
1321
|
680
|
+
1322
|
681
|
+
1323
|
682
|
+
1324
|
683
|
+
1325
|
684
|
+
1326
|
685
|
+
1327
|
686
|
+
1328
|
687
|
+
1329
|
688
|
+
1330</pre>
|
689
|
+
</td>
|
690
|
+
<td>
|
691
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1301</span>
|
692
|
+
|
693
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_source'>source</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
694
|
+
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span>
|
695
|
+
<span class='ivar'>@source</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
696
|
+
<span class='ivar'>@id</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span>
|
697
|
+
<span class='ivar'>@type</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
698
|
+
<span class='ivar'>@x_scaling</span> <span class='op'>=</span> <span class='ivar'>@y_scaling</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
699
|
+
<span class='ivar'>@top_crop</span> <span class='op'>=</span> <span class='ivar'>@right_crop</span> <span class='op'>=</span> <span class='ivar'>@bottom_crop</span> <span class='op'>=</span> <span class='ivar'>@left_crop</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
700
|
+
<span class='ivar'>@width</span> <span class='op'>=</span> <span class='ivar'>@height</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
701
|
+
<span class='ivar'>@displayed_width</span> <span class='op'>=</span> <span class='ivar'>@displayed_height</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
702
|
+
|
703
|
+
<span class='comment'># store path to image
|
704
|
+
</span> <span class='ivar'>@source</span> <span class='op'>=</span> <span class='id identifier rubyid_source'>source</span> <span class='kw'>if</span> <span class='id identifier rubyid_source'>source</span><span class='period'>.</span><span class='id identifier rubyid_instance_of?'>instance_of?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_source'>source</span><span class='period'>.</span><span class='id identifier rubyid_instance_of?'>instance_of?</span><span class='lparen'>(</span><span class='const'>Tempfile</span><span class='rparen'>)</span>
|
705
|
+
<span class='ivar'>@source</span> <span class='op'>=</span> <span class='id identifier rubyid_source'>source</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span> <span class='kw'>if</span> <span class='id identifier rubyid_source'>source</span><span class='period'>.</span><span class='id identifier rubyid_instance_of?'>instance_of?</span><span class='lparen'>(</span><span class='const'>File</span><span class='rparen'>)</span>
|
706
|
+
|
707
|
+
<span class='comment'># Check the file's existence and accessibility.
|
708
|
+
</span> <span class='kw'>if</span> <span class='op'>!</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span><span class='lparen'>(</span><span class='ivar'>@source</span><span class='rparen'>)</span>
|
709
|
+
<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'>Unable to find the </span><span class='embexpr_beg'>#{</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_basename'>basename</span><span class='lparen'>(</span><span class='ivar'>@source</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'> file.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
710
|
+
<span class='kw'>end</span>
|
711
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_readable?'>readable?</span><span class='lparen'>(</span><span class='ivar'>@source</span><span class='rparen'>)</span>
|
712
|
+
<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'>Access to the </span><span class='embexpr_beg'>#{</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_basename'>basename</span><span class='lparen'>(</span><span class='ivar'>@source</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'> file denied.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
713
|
+
<span class='kw'>end</span>
|
714
|
+
|
715
|
+
<span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_get_file_type'>get_file_type</span>
|
716
|
+
<span class='kw'>if</span> <span class='ivar'>@type</span> <span class='op'>==</span> <span class='kw'>nil</span>
|
717
|
+
<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'>The </span><span class='embexpr_beg'>#{</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_basename'>basename</span><span class='lparen'>(</span><span class='ivar'>@source</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'> file contains an </span><span class='tstring_end'>"</span></span>\
|
718
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>unknown or unsupported image type.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
719
|
+
<span class='kw'>end</span>
|
720
|
+
|
721
|
+
<span class='ivar'>@width</span><span class='comma'>,</span> <span class='ivar'>@height</span> <span class='op'>=</span> <span class='id identifier rubyid_get_dimensions'>get_dimensions</span>
|
722
|
+
<span class='kw'>end</span></pre>
|
723
|
+
</td>
|
724
|
+
</tr>
|
725
|
+
</table>
|
726
|
+
</div>
|
727
|
+
|
728
|
+
</div>
|
729
|
+
|
730
|
+
<div id="instance_attr_details" class="attr_details">
|
731
|
+
<h2>Instance Attribute Details</h2>
|
732
|
+
|
733
|
+
|
734
|
+
<span id="bottom_crop=-instance_method"></span>
|
735
|
+
<div class="method_details first">
|
736
|
+
<h3 class="signature first" id="bottom_crop-instance_method">
|
737
|
+
|
738
|
+
#<strong>bottom_crop</strong> ⇒ <tt>Object</tt>
|
739
|
+
|
740
|
+
|
741
|
+
|
742
|
+
|
743
|
+
|
744
|
+
</h3><div class="docstring">
|
745
|
+
<div class="discussion">
|
746
|
+
|
747
|
+
<p>Attribute accessor.</p>
|
748
|
+
|
749
|
+
|
750
|
+
</div>
|
751
|
+
</div>
|
752
|
+
<div class="tags">
|
753
|
+
|
754
|
+
|
755
|
+
</div><table class="source_code">
|
756
|
+
<tr>
|
757
|
+
<td>
|
758
|
+
<pre class="lines">
|
759
|
+
|
760
|
+
|
761
|
+
1280
|
762
|
+
1281
|
763
|
+
1282</pre>
|
764
|
+
</td>
|
765
|
+
<td>
|
766
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1280</span>
|
767
|
+
|
768
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_bottom_crop'>bottom_crop</span>
|
769
|
+
<span class='ivar'>@bottom_crop</span>
|
770
|
+
<span class='kw'>end</span></pre>
|
771
|
+
</td>
|
772
|
+
</tr>
|
773
|
+
</table>
|
774
|
+
</div>
|
775
|
+
|
776
|
+
|
777
|
+
<span id="displayed_height=-instance_method"></span>
|
778
|
+
<div class="method_details ">
|
779
|
+
<h3 class="signature " id="displayed_height-instance_method">
|
780
|
+
|
781
|
+
#<strong>displayed_height</strong> ⇒ <tt>Object</tt>
|
782
|
+
|
783
|
+
|
784
|
+
|
785
|
+
|
786
|
+
|
787
|
+
</h3><div class="docstring">
|
788
|
+
<div class="discussion">
|
789
|
+
|
790
|
+
<p>Attribute accessor.</p>
|
791
|
+
|
792
|
+
|
793
|
+
</div>
|
794
|
+
</div>
|
795
|
+
<div class="tags">
|
796
|
+
|
797
|
+
|
798
|
+
</div><table class="source_code">
|
799
|
+
<tr>
|
800
|
+
<td>
|
801
|
+
<pre class="lines">
|
802
|
+
|
803
|
+
|
804
|
+
1280
|
805
|
+
1281
|
806
|
+
1282</pre>
|
807
|
+
</td>
|
808
|
+
<td>
|
809
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1280</span>
|
810
|
+
|
811
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_displayed_height'>displayed_height</span>
|
812
|
+
<span class='ivar'>@displayed_height</span>
|
813
|
+
<span class='kw'>end</span></pre>
|
814
|
+
</td>
|
815
|
+
</tr>
|
816
|
+
</table>
|
817
|
+
</div>
|
818
|
+
|
819
|
+
|
820
|
+
<span id="displayed_width=-instance_method"></span>
|
821
|
+
<div class="method_details ">
|
822
|
+
<h3 class="signature " id="displayed_width-instance_method">
|
823
|
+
|
824
|
+
#<strong>displayed_width</strong> ⇒ <tt>Object</tt>
|
825
|
+
|
826
|
+
|
827
|
+
|
828
|
+
|
829
|
+
|
830
|
+
</h3><div class="docstring">
|
831
|
+
<div class="discussion">
|
832
|
+
|
833
|
+
<p>Attribute accessor.</p>
|
834
|
+
|
835
|
+
|
836
|
+
</div>
|
837
|
+
</div>
|
838
|
+
<div class="tags">
|
839
|
+
|
840
|
+
|
841
|
+
</div><table class="source_code">
|
842
|
+
<tr>
|
843
|
+
<td>
|
844
|
+
<pre class="lines">
|
845
|
+
|
846
|
+
|
847
|
+
1280
|
848
|
+
1281
|
849
|
+
1282</pre>
|
850
|
+
</td>
|
851
|
+
<td>
|
852
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1280</span>
|
853
|
+
|
854
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_displayed_width'>displayed_width</span>
|
855
|
+
<span class='ivar'>@displayed_width</span>
|
856
|
+
<span class='kw'>end</span></pre>
|
857
|
+
</td>
|
858
|
+
</tr>
|
859
|
+
</table>
|
860
|
+
</div>
|
861
|
+
|
862
|
+
|
863
|
+
<span id=""></span>
|
864
|
+
<div class="method_details ">
|
865
|
+
<h3 class="signature " id="height-instance_method">
|
866
|
+
|
867
|
+
#<strong>height</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
868
|
+
|
869
|
+
|
870
|
+
|
871
|
+
|
872
|
+
|
873
|
+
</h3><div class="docstring">
|
874
|
+
<div class="discussion">
|
875
|
+
|
876
|
+
<p>Attribute accessor.</p>
|
877
|
+
|
878
|
+
|
879
|
+
</div>
|
880
|
+
</div>
|
881
|
+
<div class="tags">
|
882
|
+
|
883
|
+
|
884
|
+
</div><table class="source_code">
|
885
|
+
<tr>
|
886
|
+
<td>
|
887
|
+
<pre class="lines">
|
888
|
+
|
889
|
+
|
890
|
+
1280
|
891
|
+
1281
|
892
|
+
1282</pre>
|
893
|
+
</td>
|
894
|
+
<td>
|
895
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1280</span>
|
896
|
+
|
897
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_height'>height</span>
|
898
|
+
<span class='ivar'>@height</span>
|
899
|
+
<span class='kw'>end</span></pre>
|
900
|
+
</td>
|
901
|
+
</tr>
|
902
|
+
</table>
|
903
|
+
</div>
|
904
|
+
|
905
|
+
|
906
|
+
<span id="left_crop=-instance_method"></span>
|
907
|
+
<div class="method_details ">
|
908
|
+
<h3 class="signature " id="left_crop-instance_method">
|
909
|
+
|
910
|
+
#<strong>left_crop</strong> ⇒ <tt>Object</tt>
|
911
|
+
|
912
|
+
|
913
|
+
|
914
|
+
|
915
|
+
|
916
|
+
</h3><div class="docstring">
|
917
|
+
<div class="discussion">
|
918
|
+
|
919
|
+
<p>Attribute accessor.</p>
|
920
|
+
|
921
|
+
|
922
|
+
</div>
|
923
|
+
</div>
|
924
|
+
<div class="tags">
|
925
|
+
|
926
|
+
|
927
|
+
</div><table class="source_code">
|
928
|
+
<tr>
|
929
|
+
<td>
|
930
|
+
<pre class="lines">
|
931
|
+
|
932
|
+
|
933
|
+
1280
|
934
|
+
1281
|
935
|
+
1282</pre>
|
936
|
+
</td>
|
937
|
+
<td>
|
938
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1280</span>
|
939
|
+
|
940
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_left_crop'>left_crop</span>
|
941
|
+
<span class='ivar'>@left_crop</span>
|
942
|
+
<span class='kw'>end</span></pre>
|
943
|
+
</td>
|
944
|
+
</tr>
|
945
|
+
</table>
|
946
|
+
</div>
|
947
|
+
|
948
|
+
|
949
|
+
<span id="right_crop=-instance_method"></span>
|
950
|
+
<div class="method_details ">
|
951
|
+
<h3 class="signature " id="right_crop-instance_method">
|
952
|
+
|
953
|
+
#<strong>right_crop</strong> ⇒ <tt>Object</tt>
|
954
|
+
|
955
|
+
|
956
|
+
|
957
|
+
|
958
|
+
|
959
|
+
</h3><div class="docstring">
|
960
|
+
<div class="discussion">
|
961
|
+
|
962
|
+
<p>Attribute accessor.</p>
|
963
|
+
|
964
|
+
|
965
|
+
</div>
|
966
|
+
</div>
|
967
|
+
<div class="tags">
|
968
|
+
|
969
|
+
|
970
|
+
</div><table class="source_code">
|
971
|
+
<tr>
|
972
|
+
<td>
|
973
|
+
<pre class="lines">
|
974
|
+
|
975
|
+
|
976
|
+
1280
|
977
|
+
1281
|
978
|
+
1282</pre>
|
979
|
+
</td>
|
980
|
+
<td>
|
981
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1280</span>
|
982
|
+
|
983
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_right_crop'>right_crop</span>
|
984
|
+
<span class='ivar'>@right_crop</span>
|
985
|
+
<span class='kw'>end</span></pre>
|
986
|
+
</td>
|
987
|
+
</tr>
|
988
|
+
</table>
|
989
|
+
</div>
|
990
|
+
|
991
|
+
|
992
|
+
<span id="top_crop=-instance_method"></span>
|
993
|
+
<div class="method_details ">
|
994
|
+
<h3 class="signature " id="top_crop-instance_method">
|
995
|
+
|
996
|
+
#<strong>top_crop</strong> ⇒ <tt>Object</tt>
|
997
|
+
|
998
|
+
|
999
|
+
|
1000
|
+
|
1001
|
+
|
1002
|
+
</h3><div class="docstring">
|
1003
|
+
<div class="discussion">
|
1004
|
+
|
1005
|
+
<p>Attribute accessor.</p>
|
1006
|
+
|
1007
|
+
|
1008
|
+
</div>
|
1009
|
+
</div>
|
1010
|
+
<div class="tags">
|
1011
|
+
|
1012
|
+
|
1013
|
+
</div><table class="source_code">
|
1014
|
+
<tr>
|
1015
|
+
<td>
|
1016
|
+
<pre class="lines">
|
1017
|
+
|
1018
|
+
|
1019
|
+
1280
|
1020
|
+
1281
|
1021
|
+
1282</pre>
|
1022
|
+
</td>
|
1023
|
+
<td>
|
1024
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1280</span>
|
1025
|
+
|
1026
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_top_crop'>top_crop</span>
|
1027
|
+
<span class='ivar'>@top_crop</span>
|
1028
|
+
<span class='kw'>end</span></pre>
|
1029
|
+
</td>
|
1030
|
+
</tr>
|
1031
|
+
</table>
|
1032
|
+
</div>
|
1033
|
+
|
1034
|
+
|
1035
|
+
<span id=""></span>
|
1036
|
+
<div class="method_details ">
|
1037
|
+
<h3 class="signature " id="width-instance_method">
|
1038
|
+
|
1039
|
+
#<strong>width</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
1040
|
+
|
1041
|
+
|
1042
|
+
|
1043
|
+
|
1044
|
+
|
1045
|
+
</h3><div class="docstring">
|
1046
|
+
<div class="discussion">
|
1047
|
+
|
1048
|
+
<p>Attribute accessor.</p>
|
1049
|
+
|
1050
|
+
|
1051
|
+
</div>
|
1052
|
+
</div>
|
1053
|
+
<div class="tags">
|
1054
|
+
|
1055
|
+
|
1056
|
+
</div><table class="source_code">
|
1057
|
+
<tr>
|
1058
|
+
<td>
|
1059
|
+
<pre class="lines">
|
1060
|
+
|
1061
|
+
|
1062
|
+
1280
|
1063
|
+
1281
|
1064
|
+
1282</pre>
|
1065
|
+
</td>
|
1066
|
+
<td>
|
1067
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1280</span>
|
1068
|
+
|
1069
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_width'>width</span>
|
1070
|
+
<span class='ivar'>@width</span>
|
1071
|
+
<span class='kw'>end</span></pre>
|
1072
|
+
</td>
|
1073
|
+
</tr>
|
1074
|
+
</table>
|
1075
|
+
</div>
|
1076
|
+
|
1077
|
+
|
1078
|
+
<span id="x_scaling=-instance_method"></span>
|
1079
|
+
<div class="method_details ">
|
1080
|
+
<h3 class="signature " id="x_scaling-instance_method">
|
1081
|
+
|
1082
|
+
#<strong>x_scaling</strong> ⇒ <tt>Object</tt>
|
1083
|
+
|
1084
|
+
|
1085
|
+
|
1086
|
+
|
1087
|
+
|
1088
|
+
</h3><div class="docstring">
|
1089
|
+
<div class="discussion">
|
1090
|
+
|
1091
|
+
<p>Attribute accessor.</p>
|
1092
|
+
|
1093
|
+
|
1094
|
+
</div>
|
1095
|
+
</div>
|
1096
|
+
<div class="tags">
|
1097
|
+
|
1098
|
+
|
1099
|
+
</div><table class="source_code">
|
1100
|
+
<tr>
|
1101
|
+
<td>
|
1102
|
+
<pre class="lines">
|
1103
|
+
|
1104
|
+
|
1105
|
+
1280
|
1106
|
+
1281
|
1107
|
+
1282</pre>
|
1108
|
+
</td>
|
1109
|
+
<td>
|
1110
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1280</span>
|
1111
|
+
|
1112
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_x_scaling'>x_scaling</span>
|
1113
|
+
<span class='ivar'>@x_scaling</span>
|
1114
|
+
<span class='kw'>end</span></pre>
|
1115
|
+
</td>
|
1116
|
+
</tr>
|
1117
|
+
</table>
|
1118
|
+
</div>
|
1119
|
+
|
1120
|
+
|
1121
|
+
<span id="y_scaling=-instance_method"></span>
|
1122
|
+
<div class="method_details ">
|
1123
|
+
<h3 class="signature " id="y_scaling-instance_method">
|
1124
|
+
|
1125
|
+
#<strong>y_scaling</strong> ⇒ <tt>Object</tt>
|
1126
|
+
|
1127
|
+
|
1128
|
+
|
1129
|
+
|
1130
|
+
|
1131
|
+
</h3><div class="docstring">
|
1132
|
+
<div class="discussion">
|
1133
|
+
|
1134
|
+
<p>Attribute accessor.</p>
|
1135
|
+
|
1136
|
+
|
1137
|
+
</div>
|
1138
|
+
</div>
|
1139
|
+
<div class="tags">
|
1140
|
+
|
1141
|
+
|
1142
|
+
</div><table class="source_code">
|
1143
|
+
<tr>
|
1144
|
+
<td>
|
1145
|
+
<pre class="lines">
|
1146
|
+
|
1147
|
+
|
1148
|
+
1280
|
1149
|
+
1281
|
1150
|
+
1282</pre>
|
1151
|
+
</td>
|
1152
|
+
<td>
|
1153
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1280</span>
|
1154
|
+
|
1155
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_y_scaling'>y_scaling</span>
|
1156
|
+
<span class='ivar'>@y_scaling</span>
|
1157
|
+
<span class='kw'>end</span></pre>
|
1158
|
+
</td>
|
1159
|
+
</tr>
|
1160
|
+
</table>
|
1161
|
+
</div>
|
1162
|
+
|
1163
|
+
</div>
|
1164
|
+
|
1165
|
+
|
1166
|
+
<div id="instance_method_details" class="method_details_list">
|
1167
|
+
<h2>Instance Method Details</h2>
|
1168
|
+
|
1169
|
+
|
1170
|
+
<div class="method_details first">
|
1171
|
+
<h3 class="signature first" id="read_source-instance_method">
|
1172
|
+
|
1173
|
+
#<strong>read_source</strong>(file, read, size = nil) ⇒ <tt>Object</tt>
|
1174
|
+
|
1175
|
+
|
1176
|
+
|
1177
|
+
|
1178
|
+
|
1179
|
+
</h3><div class="docstring">
|
1180
|
+
<div class="discussion">
|
1181
|
+
|
1182
|
+
<p>This method loads the data for an image from its source. The method accepts
|
1183
|
+
two call approaches. If called without a block then the method considers
|
1184
|
+
the size parameter it is passed. If called with a block the method executes
|
1185
|
+
until the block returns true.</p>
|
1186
|
+
|
1187
|
+
<h4 id="label-Parameters">Parameters</h4>
|
1188
|
+
<dl class="rdoc-list note-list"><dt>size
|
1189
|
+
<dd>
|
1190
|
+
<p>The maximum number of bytes to be read from the file. Defaults to nil to
|
1191
|
+
indicate that the remainder of the file should be read in.</p>
|
1192
|
+
</dd></dl>
|
1193
|
+
|
1194
|
+
|
1195
|
+
</div>
|
1196
|
+
</div>
|
1197
|
+
<div class="tags">
|
1198
|
+
|
1199
|
+
|
1200
|
+
</div><table class="source_code">
|
1201
|
+
<tr>
|
1202
|
+
<td>
|
1203
|
+
<pre class="lines">
|
1204
|
+
|
1205
|
+
|
1206
|
+
1445
|
1207
|
+
1446
|
1208
|
+
1447
|
1209
|
+
1448
|
1210
|
+
1449
|
1211
|
+
1450
|
1212
|
+
1451
|
1213
|
+
1452
|
1214
|
+
1453
|
1215
|
+
1454
|
1216
|
+
1455
|
1217
|
+
1456
|
1218
|
+
1457
|
1219
|
+
1458
|
1220
|
+
1459
|
1221
|
+
1460
|
1222
|
+
1461
|
1223
|
+
1462
|
1224
|
+
1463
|
1225
|
+
1464
|
1226
|
+
1465
|
1227
|
+
1466</pre>
|
1228
|
+
</td>
|
1229
|
+
<td>
|
1230
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1445</span>
|
1231
|
+
|
1232
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_read_source'>read_source</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='id identifier rubyid_read'>read</span><span class='comma'>,</span> <span class='id identifier rubyid_size'>size</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
1233
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
|
1234
|
+
<span class='id identifier rubyid_done'>done</span> <span class='op'>=</span> <span class='kw'>false</span>
|
1235
|
+
|
1236
|
+
<span class='kw'>while</span> <span class='op'>!</span><span class='id identifier rubyid_done'>done</span> <span class='kw'>and</span> <span class='op'>!</span><span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_eof?'>eof?</span>
|
1237
|
+
<span class='id identifier rubyid_read'>read</span> <span class='op'><<</span> <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_getbyte'>getbyte</span>
|
1238
|
+
<span class='id identifier rubyid_done'>done</span> <span class='op'>=</span> <span class='kw'>yield</span> <span class='id identifier rubyid_read'>read</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span>
|
1239
|
+
<span class='kw'>end</span>
|
1240
|
+
<span class='kw'>else</span>
|
1241
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_size'>size</span> <span class='op'>!=</span> <span class='kw'>nil</span>
|
1242
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_size'>size</span> <span class='op'>></span> <span class='int'>0</span>
|
1243
|
+
<span class='id identifier rubyid_total'>total</span> <span class='op'>=</span> <span class='int'>0</span>
|
1244
|
+
<span class='kw'>while</span> <span class='op'>!</span><span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_eof?'>eof?</span> <span class='kw'>and</span> <span class='id identifier rubyid_total'>total</span> <span class='op'><</span> <span class='id identifier rubyid_size'>size</span>
|
1245
|
+
<span class='id identifier rubyid_read'>read</span> <span class='op'><<</span> <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_getbyte'>getbyte</span>
|
1246
|
+
<span class='id identifier rubyid_total'>total</span> <span class='op'>+=</span> <span class='int'>1</span>
|
1247
|
+
<span class='kw'>end</span>
|
1248
|
+
<span class='kw'>end</span>
|
1249
|
+
<span class='kw'>else</span>
|
1250
|
+
<span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_each_byte'>each_byte</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_byte'>byte</span><span class='op'>|</span> <span class='id identifier rubyid_read'>read</span> <span class='op'><<</span> <span class='id identifier rubyid_byte'>byte</span><span class='rbrace'>}</span>
|
1251
|
+
<span class='kw'>end</span>
|
1252
|
+
<span class='kw'>end</span>
|
1253
|
+
<span class='kw'>end</span></pre>
|
1254
|
+
</td>
|
1255
|
+
</tr>
|
1256
|
+
</table>
|
1257
|
+
</div>
|
1258
|
+
|
1259
|
+
<div class="method_details ">
|
1260
|
+
<h3 class="signature " id="to_rtf-instance_method">
|
1261
|
+
|
1262
|
+
#<strong>to_rtf</strong> ⇒ <tt>Object</tt>
|
1263
|
+
|
1264
|
+
|
1265
|
+
|
1266
|
+
|
1267
|
+
|
1268
|
+
</h3><div class="docstring">
|
1269
|
+
<div class="discussion">
|
1270
|
+
|
1271
|
+
<p>This method generates the RTF for an ImageNode object.</p>
|
1272
|
+
|
1273
|
+
|
1274
|
+
</div>
|
1275
|
+
</div>
|
1276
|
+
<div class="tags">
|
1277
|
+
|
1278
|
+
|
1279
|
+
</div><table class="source_code">
|
1280
|
+
<tr>
|
1281
|
+
<td>
|
1282
|
+
<pre class="lines">
|
1283
|
+
|
1284
|
+
|
1285
|
+
1371
|
1286
|
+
1372
|
1287
|
+
1373
|
1288
|
+
1374
|
1289
|
+
1375
|
1290
|
+
1376
|
1291
|
+
1377
|
1292
|
+
1378
|
1293
|
+
1379
|
1294
|
+
1380
|
1295
|
+
1381
|
1296
|
+
1382
|
1297
|
+
1383
|
1298
|
+
1384
|
1299
|
+
1385
|
1300
|
+
1386
|
1301
|
+
1387
|
1302
|
+
1388
|
1303
|
+
1389
|
1304
|
+
1390
|
1305
|
+
1391
|
1306
|
+
1392
|
1307
|
+
1393
|
1308
|
+
1394
|
1309
|
+
1395
|
1310
|
+
1396
|
1311
|
+
1397
|
1312
|
+
1398
|
1313
|
+
1399
|
1314
|
+
1400
|
1315
|
+
1401
|
1316
|
+
1402
|
1317
|
+
1403
|
1318
|
+
1404</pre>
|
1319
|
+
</td>
|
1320
|
+
<td>
|
1321
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 1371</span>
|
1322
|
+
|
1323
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_rtf'>to_rtf</span>
|
1324
|
+
<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>
|
1325
|
+
<span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='int'>0</span>
|
1326
|
+
|
1327
|
+
<span class='comment'>#text << '{\pard{\*\shppict{\pict'
|
1328
|
+
</span> <span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>{\*\shppict{\pict</span><span class='tstring_end'>'</span></span>
|
1329
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\picscalex</span><span class='embexpr_beg'>#{</span><span class='ivar'>@x_scaling</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@x_scaling</span> <span class='op'>!=</span> <span class='kw'>nil</span>
|
1330
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\picscaley</span><span class='embexpr_beg'>#{</span><span class='ivar'>@y_scaling</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@y_scaling</span> <span class='op'>!=</span> <span class='kw'>nil</span>
|
1331
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\piccropl</span><span class='embexpr_beg'>#{</span><span class='ivar'>@left_crop</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@left_crop</span> <span class='op'>!=</span> <span class='kw'>nil</span>
|
1332
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\piccropr</span><span class='embexpr_beg'>#{</span><span class='ivar'>@right_crop</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@right_crop</span> <span class='op'>!=</span> <span class='kw'>nil</span>
|
1333
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\piccropt</span><span class='embexpr_beg'>#{</span><span class='ivar'>@top_crop</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@top_crop</span> <span class='op'>!=</span> <span class='kw'>nil</span>
|
1334
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\piccropb</span><span class='embexpr_beg'>#{</span><span class='ivar'>@bottom_crop</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@bottom_crop</span> <span class='op'>!=</span> <span class='kw'>nil</span>
|
1335
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\picwgoal</span><span class='embexpr_beg'>#{</span><span class='ivar'>@displayed_width</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@displayed_width</span> <span class='op'>!=</span> <span class='kw'>nil</span>
|
1336
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\pichgoal</span><span class='embexpr_beg'>#{</span><span class='ivar'>@displayed_height</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@displayed_height</span> <span class='op'>!=</span> <span class='kw'>nil</span>
|
1337
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\picw</span><span class='embexpr_beg'>#{</span><span class='ivar'>@width</span><span class='embexpr_end'>}</span><span class='tstring_content'>\\pich</span><span class='embexpr_beg'>#{</span><span class='ivar'>@height</span><span class='embexpr_end'>}</span><span class='tstring_content'>\\bliptag</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1338
|
+
<span class='id identifier rubyid_text'>text</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='ivar'>@type</span><span class='period'>.</span><span class='id identifier rubyid_id2name'>id2name</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span>
|
1339
|
+
|
1340
|
+
<span class='id identifier rubyid_open_file'>open_file</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_file'>file</span><span class='op'>|</span>
|
1341
|
+
<span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_each_byte'>each_byte</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_byte'>byte</span><span class='op'>|</span>
|
1342
|
+
<span class='id identifier rubyid_hex_str'>hex_str</span> <span class='op'>=</span> <span class='id identifier rubyid_byte'>byte</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='lparen'>(</span><span class='int'>16</span><span class='rparen'>)</span>
|
1343
|
+
<span class='id identifier rubyid_hex_str'>hex_str</span><span class='period'>.</span><span class='id identifier rubyid_insert'>insert</span><span class='lparen'>(</span><span class='int'>0</span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_hex_str'>hex_str</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>==</span> <span class='int'>1</span>
|
1344
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='id identifier rubyid_hex_str'>hex_str</span>
|
1345
|
+
<span class='id identifier rubyid_count'>count</span> <span class='op'>+=</span> <span class='int'>1</span>
|
1346
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>==</span> <span class='int'>40</span>
|
1347
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span>
|
1348
|
+
<span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='int'>0</span>
|
1349
|
+
<span class='kw'>end</span>
|
1350
|
+
<span class='kw'>end</span>
|
1351
|
+
<span class='kw'>end</span>
|
1352
|
+
<span class='comment'>#text << "\n}}\\par}"
|
1353
|
+
</span> <span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n}}</span><span class='tstring_end'>"</span></span>
|
1354
|
+
|
1355
|
+
<span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span>
|
1356
|
+
<span class='kw'>end</span></pre>
|
1357
|
+
</td>
|
1358
|
+
</tr>
|
1359
|
+
</table>
|
1360
|
+
</div>
|
1361
|
+
|
1362
|
+
</div>
|
1363
|
+
|
1364
|
+
</div>
|
1365
|
+
|
1366
|
+
<div id="footer">
|
1367
|
+
Generated on Mon Jul 24 15:49:01 2017 by
|
1368
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1369
|
+
0.9.9 (ruby-2.3.3).
|
1370
|
+
</div>
|
1371
|
+
|
1372
|
+
</div>
|
1373
|
+
</body>
|
1374
|
+
</html>
|