axlsx 1.0.5 → 1.0.6

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.
Files changed (71) hide show
  1. data/README.md +10 -9
  2. data/doc/Axlsx.html +2443 -0
  3. data/doc/Axlsx/App.html +2640 -0
  4. data/doc/Axlsx/Axis.html +1047 -0
  5. data/doc/Axlsx/Bar3DChart.html +1153 -0
  6. data/doc/Axlsx/BarSeries.html +764 -0
  7. data/doc/Axlsx/Border.html +775 -0
  8. data/doc/Axlsx/BorderPr.html +709 -0
  9. data/doc/Axlsx/CatAxis.html +766 -0
  10. data/doc/Axlsx/Cell.html +1623 -0
  11. data/doc/Axlsx/CellAlignment.html +1247 -0
  12. data/doc/Axlsx/CellProtection.html +565 -0
  13. data/doc/Axlsx/CellStyle.html +949 -0
  14. data/doc/Axlsx/Chart.html +1459 -0
  15. data/doc/Axlsx/Color.html +665 -0
  16. data/doc/Axlsx/ContentType.html +340 -0
  17. data/doc/Axlsx/Core.html +465 -0
  18. data/doc/Axlsx/DataTypeValidator.html +324 -0
  19. data/doc/Axlsx/Default.html +575 -0
  20. data/doc/Axlsx/Drawing.html +1154 -0
  21. data/doc/Axlsx/Fill.html +460 -0
  22. data/doc/Axlsx/Font.html +1554 -0
  23. data/doc/Axlsx/GradientFill.html +1026 -0
  24. data/doc/Axlsx/GradientStop.html +526 -0
  25. data/doc/Axlsx/GraphicFrame.html +646 -0
  26. data/doc/Axlsx/Line3DChart.html +921 -0
  27. data/doc/Axlsx/LineSeries.html +656 -0
  28. data/doc/Axlsx/Marker.html +857 -0
  29. data/doc/Axlsx/NumFmt.html +562 -0
  30. data/doc/Axlsx/Override.html +568 -0
  31. data/doc/Axlsx/Package.html +1293 -0
  32. data/doc/Axlsx/PatternFill.html +681 -0
  33. data/doc/Axlsx/Pie3DChart.html +439 -0
  34. data/doc/Axlsx/PieSeries.html +762 -0
  35. data/doc/Axlsx/RegexValidator.html +268 -0
  36. data/doc/Axlsx/Relationship.html +554 -0
  37. data/doc/Axlsx/Relationships.html +343 -0
  38. data/doc/Axlsx/RestrictionValidator.html +300 -0
  39. data/doc/Axlsx/Row.html +771 -0
  40. data/doc/Axlsx/Scaling.html +740 -0
  41. data/doc/Axlsx/SerAxis.html +624 -0
  42. data/doc/Axlsx/Series.html +746 -0
  43. data/doc/Axlsx/SeriesTitle.html +289 -0
  44. data/doc/Axlsx/SimpleTypedList.html +1617 -0
  45. data/doc/Axlsx/Styles.html +1754 -0
  46. data/doc/Axlsx/TableStyle.html +710 -0
  47. data/doc/Axlsx/TableStyleElement.html +677 -0
  48. data/doc/Axlsx/TableStyles.html +599 -0
  49. data/doc/Axlsx/Title.html +625 -0
  50. data/doc/Axlsx/TwoCellAnchor.html +1115 -0
  51. data/doc/Axlsx/ValAxis.html +539 -0
  52. data/doc/Axlsx/View3D.html +971 -0
  53. data/doc/Axlsx/Workbook.html +1347 -0
  54. data/doc/Axlsx/Worksheet.html +1864 -0
  55. data/doc/Axlsx/Xf.html +1681 -0
  56. data/doc/_index.html +611 -0
  57. data/doc/class_list.html +47 -0
  58. data/doc/css/common.css +1 -0
  59. data/doc/css/full_list.css +55 -0
  60. data/doc/css/style.css +322 -0
  61. data/doc/file.README.html +262 -0
  62. data/doc/file_list.html +49 -0
  63. data/doc/frames.html +13 -0
  64. data/doc/index.html +262 -0
  65. data/doc/js/app.js +205 -0
  66. data/doc/js/full_list.js +167 -0
  67. data/doc/js/jquery.js +16 -0
  68. data/doc/method_list.html +3038 -0
  69. data/doc/top-level-namespace.html +103 -0
  70. data/lib/axlsx/util/constants.rb +1 -1
  71. metadata +71 -3
data/doc/Axlsx/Relationships.html ADDED
@@ -0,0 +1,343 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Axlsx::Relationships
8
+
9
+ &mdash; Documentation by YARD 0.7.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (R)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
38
+ &raquo;
39
+ <span class="title">Relationships</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Class: Axlsx::Relationships
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+ <dt class="r1">Inherits:</dt>
68
+ <dd class="r1">
69
+ <span class="inheritName"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li>
75
+
76
+ <li class="next">Axlsx::Relationships</li>
77
+
78
+ </ul>
79
+ <a href="#" class="inheritanceTree">show all</a>
80
+
81
+ </dd>
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+ <dt class="r2 last">Defined in:</dt>
92
+ <dd class="r2 last">lib/axlsx/rels/relationships.rb</dd>
93
+
94
+ </dl>
95
+ <div class="clear"></div>
96
+
97
+ <h2>Overview</h2><div class="docstring">
98
+ <div class="discussion">
99
+
100
+ <div class="note notetag">
101
+ <strong>Note:</strong>
102
+ <div class='inline'><p>
103
+ The package automatically manages releationships.
104
+ </p>
105
+ </div>
106
+ </div>
107
+
108
+ <p>
109
+ Relationships are a collection of Relations that define how package parts
110
+ are related.
111
+ </p>
112
+
113
+
114
+ </div>
115
+ </div>
116
+ <div class="tags">
117
+
118
+
119
+ </div>
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+ <h2>Instance Attribute Summary</h2>
131
+
132
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3>
133
+ <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</a></span></p>
134
+
135
+
136
+
137
+ <h2>
138
+ Instance Method Summary
139
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
140
+ </h2>
141
+
142
+ <ul class="summary">
143
+
144
+ <li class="public ">
145
+ <span class="summary_signature">
146
+
147
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Relationships) <strong>initialize</strong> </a>
148
+
149
+
150
+
151
+ </span>
152
+
153
+ <span class="note title constructor">constructor</span>
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+ <span class="summary_desc"><div class='inline'><p>
163
+ Creates a new Relationships collection based on SimpleTypedList.
164
+ </p>
165
+ </div></span>
166
+
167
+ </li>
168
+
169
+
170
+ <li class="public ">
171
+ <span class="summary_signature">
172
+
173
+ <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a>
174
+
175
+
176
+
177
+ </span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+ <span class="summary_desc"><div class='inline'><p>
187
+ Serializes the relationships document.
188
+ </p>
189
+ </div></span>
190
+
191
+ </li>
192
+
193
+
194
+ </ul>
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3>
206
+ <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#&lt;&lt; (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p>
207
+ <div id="constructor_details" class="method_details_list">
208
+ <h2>Constructor Details</h2>
209
+
210
+ <div class="method_details first">
211
+ <p class="signature first" id="initialize-instance_method">
212
+
213
+ - (<tt><span class='object_link'><a href="" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>initialize</strong>
214
+
215
+
216
+
217
+ </p><div class="docstring">
218
+ <div class="discussion">
219
+ <p>
220
+ Creates a new Relationships collection based on SimpleTypedList
221
+ </p>
222
+
223
+
224
+ </div>
225
+ </div>
226
+ <div class="tags">
227
+
228
+
229
+ </div><table class="source_code">
230
+ <tr>
231
+ <td>
232
+ <pre class="lines">
233
+
234
+
235
+ 9
236
+ 10
237
+ 11</pre>
238
+ </td>
239
+ <td>
240
+ <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationships.rb', line 9</span>
241
+
242
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span>
243
+ <span class='super super kw'>super</span> <span class='Relationship constant id'>Relationship</span>
244
+ <span class='end end kw'>end</span>
245
+ </pre>
246
+ </td>
247
+ </tr>
248
+ </table>
249
+ </div>
250
+
251
+ </div>
252
+ <div id="method_missing_details" class="method_details_list">
253
+ <h2>Dynamic Method Handling</h2>
254
+ <p class="notice super">
255
+ This class handles dynamic methods through the <tt>method_missing</tt> method
256
+
257
+ in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span>
258
+
259
+ </p>
260
+
261
+ </div>
262
+
263
+
264
+ <div id="instance_method_details" class="method_details_list">
265
+ <h2>Instance Method Details</h2>
266
+
267
+
268
+ <div class="method_details first">
269
+ <p class="signature first" id="to_xml-instance_method">
270
+
271
+ - (<tt>String</tt>) <strong>to_xml</strong>
272
+
273
+
274
+
275
+ </p><div class="docstring">
276
+ <div class="discussion">
277
+ <p>
278
+ Serializes the relationships document.
279
+ </p>
280
+
281
+
282
+ </div>
283
+ </div>
284
+ <div class="tags">
285
+
286
+ <h3>Returns:</h3>
287
+ <ul class="return">
288
+
289
+ <li>
290
+
291
+
292
+ <span class='type'>(<tt>String</tt>)</span>
293
+
294
+
295
+
296
+ </li>
297
+
298
+ </ul>
299
+
300
+ </div><table class="source_code">
301
+ <tr>
302
+ <td>
303
+ <pre class="lines">
304
+
305
+
306
+ 15
307
+ 16
308
+ 17
309
+ 18
310
+ 19
311
+ 20
312
+ 21
313
+ 22</pre>
314
+ </td>
315
+ <td>
316
+ <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationships.rb', line 15</span>
317
+
318
+ <span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span>
319
+ <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span>
320
+ <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Relationships constant id'>Relationships</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='RELS_R constant id'>RELS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
321
+ <span class='each_with_index identifier id'>each_with_index</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rel identifier id'>rel</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> <span class='rel identifier id'>rel</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='comma token'>,</span> <span class='dstring node'>&quot;rId#{index+1}&quot;</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
322
+ <span class='rbrace token'>}</span>
323
+ <span class='end end kw'>end</span>
324
+ <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span>
325
+ <span class='end end kw'>end</span>
326
+ </pre>
327
+ </td>
328
+ </tr>
329
+ </table>
330
+ </div>
331
+
332
+ </div>
333
+
334
+ </div>
335
+
336
+ <div id="footer">
337
+ Generated on Tue Nov 22 00:27:46 2011 by
338
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
339
+ 0.7.3 (ruby-1.8.7).
340
+ </div>
341
+
342
+ </body>
343
+ </html>
data/doc/Axlsx/RestrictionValidator.html ADDED
@@ -0,0 +1,300 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Axlsx::RestrictionValidator
8
+
9
+ &mdash; Documentation by YARD 0.7.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (R)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
38
+ &raquo;
39
+ <span class="title">RestrictionValidator</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Class: Axlsx::RestrictionValidator
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+ <dt class="r1">Inherits:</dt>
68
+ <dd class="r1">
69
+ <span class="inheritName">Object</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">Axlsx::RestrictionValidator</li>
75
+
76
+ </ul>
77
+ <a href="#" class="inheritanceTree">show all</a>
78
+
79
+ </dd>
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+ <dt class="r2 last">Defined in:</dt>
90
+ <dd class="r2 last">lib/axlsx/util/validators.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+ <h2>Overview</h2><div class="docstring">
96
+ <div class="discussion">
97
+ <p>
98
+ Validate a value against a specific list of allowed values.
99
+ </p>
100
+
101
+
102
+ </div>
103
+ </div>
104
+ <div class="tags">
105
+
106
+
107
+ </div>
108
+
109
+
110
+
111
+
112
+
113
+ <h2>
114
+ Class Method Summary
115
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
116
+ </h2>
117
+
118
+ <ul class="summary">
119
+
120
+ <li class="public ">
121
+ <span class="summary_signature">
122
+
123
+ <a href="#validate-class_method" title="validate (class method)">+ (Boolean) <strong>validate</strong>(name, choices, v) </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ <span class="summary_desc"><div class='inline'><p>
137
+ Perform validation.
138
+ </p>
139
+ </div></span>
140
+
141
+ </li>
142
+
143
+
144
+ </ul>
145
+
146
+
147
+
148
+
149
+ <div id="class_method_details" class="method_details_list">
150
+ <h2>Class Method Details</h2>
151
+
152
+
153
+ <div class="method_details first">
154
+ <p class="signature first" id="validate-class_method">
155
+
156
+ + (<tt>Boolean</tt>) <strong>validate</strong>(name, choices, v)
157
+
158
+
159
+
160
+ </p><div class="docstring">
161
+ <div class="discussion">
162
+ <p>
163
+ Perform validation
164
+ </p>
165
+
166
+
167
+ </div>
168
+ </div>
169
+ <div class="tags">
170
+ <h3>Parameters:</h3>
171
+ <ul class="param">
172
+
173
+ <li>
174
+
175
+ <span class='name'>name</span>
176
+
177
+
178
+ <span class='type'>(<tt>String</tt>)</span>
179
+
180
+
181
+
182
+ &mdash;
183
+ <div class='inline'><p>
184
+ The name of what is being validatied. This is included in the error message
185
+ </p>
186
+ </div>
187
+
188
+ </li>
189
+
190
+ <li>
191
+
192
+ <span class='name'>choices</span>
193
+
194
+
195
+ <span class='type'>(<tt>Array</tt>)</span>
196
+
197
+
198
+
199
+ &mdash;
200
+ <div class='inline'><p>
201
+ The list of choices to validate against
202
+ </p>
203
+ </div>
204
+
205
+ </li>
206
+
207
+ <li>
208
+
209
+ <span class='name'>v</span>
210
+
211
+
212
+ <span class='type'>(<tt>Any</tt>)</span>
213
+
214
+
215
+
216
+ &mdash;
217
+ <div class='inline'><p>
218
+ The value to be validated
219
+ </p>
220
+ </div>
221
+
222
+ </li>
223
+
224
+ </ul>
225
+
226
+ <h3>Returns:</h3>
227
+ <ul class="return">
228
+
229
+ <li>
230
+
231
+
232
+ <span class='type'>(<tt>Boolean</tt>)</span>
233
+
234
+
235
+
236
+ &mdash;
237
+ <div class='inline'><p>
238
+ true if validation succeeds.
239
+ </p>
240
+ </div>
241
+
242
+ </li>
243
+
244
+ </ul>
245
+ <h3>Raises:</h3>
246
+ <ul class="raise">
247
+
248
+ <li>
249
+
250
+
251
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
252
+
253
+
254
+
255
+ &mdash;
256
+ <div class='inline'><p>
257
+ Raised if the value provided is not in the list of choices.
258
+ </p>
259
+ </div>
260
+
261
+ </li>
262
+
263
+ </ul>
264
+
265
+ </div><table class="source_code">
266
+ <tr>
267
+ <td>
268
+ <pre class="lines">
269
+
270
+
271
+ 10
272
+ 11
273
+ 12
274
+ 13</pre>
275
+ </td>
276
+ <td>
277
+ <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 10</span>
278
+
279
+ <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span>
280
+ <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_RESTRICTION constant id'>ERR_RESTRICTION</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span>
281
+ <span class='true true kw'>true</span>
282
+ <span class='end end kw'>end</span>
283
+ </pre>
284
+ </td>
285
+ </tr>
286
+ </table>
287
+ </div>
288
+
289
+ </div>
290
+
291
+ </div>
292
+
293
+ <div id="footer">
294
+ Generated on Tue Nov 22 00:27:44 2011 by
295
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
296
+ 0.7.3 (ruby-1.8.7).
297
+ </div>
298
+
299
+ </body>
300
+ </html>