simpler-tiles 0.0.4 → 0.0.5

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,576 +0,0 @@
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: SimplerTiles::Layer
8
-
9
- &mdash; Documentation by YARD 0.7.5
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 (L)</a> &raquo;
37
- <span class='title'><span class='object_link'><a href="../SimplerTiles.html" title="SimplerTiles (module)">SimplerTiles</a></span></span>
38
- &raquo;
39
- <span class="title">Layer</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: SimplerTiles::Layer
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">SimplerTiles::Layer</li>
75
-
76
- </ul>
77
- <a href="#" class="inheritanceTree">show all</a>
78
-
79
- </dd>
80
-
81
-
82
-
83
-
84
-
85
-
86
- <dt class="r2">Includes:</dt>
87
- <dd class="r2"><span class='object_link'><a href="PP.html" title="SimplerTiles::PP (module)">PP</a></span></dd>
88
-
89
-
90
-
91
-
92
-
93
- <dt class="r1 last">Defined in:</dt>
94
- <dd class="r1 last">lib/simpler_tiles/layer.rb<span class="defines">,<br />
95
- ext/simpler_tiles/layer.c</span>
96
- </dd>
97
-
98
- </dl>
99
- <div class="clear"></div>
100
-
101
- <h2>Overview</h2><div class="docstring">
102
- <div class="discussion">
103
-
104
- <p>The Layer object contains connection info for a particular datasource and
105
- tracks a list of <span class='object_link'><a href="Query.html" title="SimplerTiles::Query (class)">Query</a></span>s.</p>
106
-
107
-
108
- </div>
109
- </div>
110
- <div class="tags">
111
-
112
-
113
- </div>
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
- <h2>
122
- Instance Method Summary
123
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
124
- </h2>
125
-
126
- <ul class="summary">
127
-
128
- <li class="public ">
129
- <span class="summary_signature">
130
-
131
- <a href="#add_query-instance_method" title="#add_query (instance method)">- (Query) <strong>add_query</strong> </a>
132
-
133
-
134
-
135
- </span>
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
- <span class="summary_desc"><div class='inline'>
145
- <p>Add a query object to this Layer's list of queries.</p>
146
- </div></span>
147
-
148
- </li>
149
-
150
-
151
- <li class="public ">
152
- <span class="summary_signature">
153
-
154
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (Layer) <strong>initialize</strong>(source) {|_self| ... }</a>
155
-
156
-
157
-
158
- </span>
159
-
160
- <span class="note title constructor">constructor</span>
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
- <span class="summary_desc"><div class='inline'>
170
- <p>Initialize a Layer.</p>
171
- </div></span>
172
-
173
- </li>
174
-
175
-
176
- <li class="public ">
177
- <span class="summary_signature">
178
-
179
- <a href="#query-instance_method" title="#query (instance method)">- (Object) <strong>query</strong>(sql, &amp;blk) </a>
180
-
181
-
182
-
183
- </span>
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
- <span class="summary_desc"><div class='inline'>
193
- <p>Add a query to this Layer's c list.</p>
194
- </div></span>
195
-
196
- </li>
197
-
198
-
199
- <li class="public ">
200
- <span class="summary_signature">
201
-
202
- <a href="#source-instance_method" title="#source (instance method)">- (String) <strong>source</strong> </a>
203
-
204
-
205
-
206
- </span>
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
- <span class="summary_desc"><div class='inline'>
216
- <p>Get a copy of the Layer's source.</p>
217
- </div></span>
218
-
219
- </li>
220
-
221
-
222
- <li class="public ">
223
- <span class="summary_signature">
224
-
225
- <a href="#source%3D-instance_method" title="#source= (instance method)">- (String) <strong>source=</strong> </a>
226
-
227
-
228
-
229
- </span>
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
- <span class="summary_desc"><div class='inline'>
239
- <p>Set the source attribute for the Layer.</p>
240
- </div></span>
241
-
242
- </li>
243
-
244
-
245
- </ul>
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
- <h3 class="inherited">Methods included from <span class='object_link'><a href="PP.html" title="SimplerTiles::PP (module)">PP</a></span></h3>
257
- <p class="inherited"><span class='object_link'><a href="PP.html#inspect-instance_method" title="SimplerTiles::PP#inspect (method)">#inspect</a></span></p>
258
- <div id="constructor_details" class="method_details_list">
259
- <h2>Constructor Details</h2>
260
-
261
- <div class="method_details first">
262
- <p class="signature first" id="initialize-instance_method">
263
-
264
- - (<tt><span class='object_link'><a href="" title="SimplerTiles::Layer (class)">Layer</a></span></tt>) <strong>initialize</strong>(source) {|_self| ... }
265
-
266
-
267
-
268
- </p><div class="docstring">
269
- <div class="discussion">
270
-
271
- <p>Initialize a Layer</p>
272
-
273
-
274
- </div>
275
- </div>
276
- <div class="tags">
277
-
278
- <h3>Yields:</h3>
279
- <ul class="yield">
280
-
281
- <li>
282
-
283
-
284
- <span class='type'>(<tt>_self</tt>)</span>
285
-
286
-
287
-
288
- </li>
289
-
290
- </ul>
291
- <h3>Yield Parameters:</h3>
292
- <ul class="yieldparam">
293
-
294
- <li>
295
-
296
- <span class='name'>_self</span>
297
-
298
-
299
- <span class='type'>(<tt><span class='object_link'><a href="" title="SimplerTiles::Layer (class)">SimplerTiles::Layer</a></span></tt>)</span>
300
-
301
-
302
-
303
- &mdash;
304
- <div class='inline'>
305
- <p>the object that the method was called on</p>
306
- </div>
307
-
308
- </li>
309
-
310
- </ul>
311
-
312
- </div><table class="source_code">
313
- <tr>
314
- <td>
315
- <pre class="lines">
316
-
317
-
318
- 8
319
- 9
320
- 10
321
- 11</pre>
322
- </td>
323
- <td>
324
- <pre class="code"><span class="info file"># File 'lib/simpler_tiles/layer.rb', line 8</span>
325
-
326
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='rparen'>)</span>
327
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_source'>source</span> <span class='op'>=</span> <span class='id identifier rubyid_source'>source</span>
328
- <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
329
- <span class='kw'>end</span></pre>
330
- </td>
331
- </tr>
332
- </table>
333
- </div>
334
-
335
- </div>
336
-
337
-
338
- <div id="instance_method_details" class="method_details_list">
339
- <h2>Instance Method Details</h2>
340
-
341
-
342
- <div class="method_details first">
343
- <p class="signature first" id="add_query-instance_method">
344
-
345
- - (<tt><span class='object_link'><a href="Query.html" title="SimplerTiles::Query (class)">Query</a></span></tt>) <strong>add_query</strong>
346
-
347
-
348
-
349
- </p><div class="docstring">
350
- <div class="discussion">
351
-
352
- <p>Add a query object to this Layer's list of queries.</p>
353
-
354
-
355
- </div>
356
- </div>
357
- <div class="tags">
358
- <h3>Parameters:</h3>
359
- <ul class="param">
360
-
361
- <li>
362
-
363
- <span class='name'></span>
364
-
365
-
366
- <span class='type'>(<tt>String</tt>)</span>
367
-
368
-
369
-
370
- </li>
371
-
372
- </ul>
373
-
374
- <h3>Returns:</h3>
375
- <ul class="return">
376
-
377
- <li>
378
-
379
-
380
- <span class='type'>(<tt><span class='object_link'><a href="Query.html" title="SimplerTiles::Query (class)">Query</a></span></tt>)</span>
381
-
382
-
383
-
384
- </li>
385
-
386
- </ul>
387
-
388
- </div><table class="source_code">
389
- <tr>
390
- <td>
391
- <pre class="lines">
392
-
393
-
394
- </pre>
395
- </td>
396
- <td>
397
- <pre class="code"><span class="info file"># File 'ext/simpler_tiles/layer.c'</span>
398
-
399
- static VALUE
400
- add_query(VALUE self, VALUE query){</pre>
401
- </td>
402
- </tr>
403
- </table>
404
- </div>
405
-
406
- <div class="method_details ">
407
- <p class="signature " id="query-instance_method">
408
-
409
- - (<tt>Object</tt>) <strong>query</strong>(sql, &amp;blk)
410
-
411
-
412
-
413
- </p><div class="docstring">
414
- <div class="discussion">
415
-
416
- <p>Add a query to this Layer's c list.</p>
417
-
418
-
419
- </div>
420
- </div>
421
- <div class="tags">
422
-
423
-
424
- </div><table class="source_code">
425
- <tr>
426
- <td>
427
- <pre class="lines">
428
-
429
-
430
- 14
431
- 15
432
- 16
433
- 17</pre>
434
- </td>
435
- <td>
436
- <pre class="code"><span class="info file"># File 'lib/simpler_tiles/layer.rb', line 14</span>
437
-
438
- <span class='kw'>def</span> <span class='id identifier rubyid_query'>query</span><span class='lparen'>(</span><span class='id identifier rubyid_sql'>sql</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_blk'>blk</span><span class='rparen'>)</span>
439
- <span class='id identifier rubyid_layer'>layer</span> <span class='op'>=</span> <span class='const'>SimplerTiles</span><span class='op'>::</span><span class='const'>Query</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_sql'>sql</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_blk'>blk</span><span class='rparen'>)</span>
440
- <span class='id identifier rubyid_add_query'>add_query</span> <span class='id identifier rubyid_layer'>layer</span>
441
- <span class='kw'>end</span></pre>
442
- </td>
443
- </tr>
444
- </table>
445
- </div>
446
-
447
- <div class="method_details ">
448
- <p class="signature " id="source-instance_method">
449
-
450
- - (<tt>String</tt>) <strong>source</strong>
451
-
452
-
453
-
454
- </p><div class="docstring">
455
- <div class="discussion">
456
-
457
- <p>Get a copy of the Layer's source.</p>
458
-
459
-
460
- </div>
461
- </div>
462
- <div class="tags">
463
-
464
- <h3>Returns:</h3>
465
- <ul class="return">
466
-
467
- <li>
468
-
469
-
470
- <span class='type'>(<tt>String</tt>)</span>
471
-
472
-
473
-
474
- </li>
475
-
476
- </ul>
477
-
478
- </div><table class="source_code">
479
- <tr>
480
- <td>
481
- <pre class="lines">
482
-
483
-
484
- </pre>
485
- </td>
486
- <td>
487
- <pre class="code"><span class="info file"># File 'ext/simpler_tiles/layer.c'</span>
488
-
489
- <span class='id identifier rubyid_static'>static</span> <span class='const'>VALUE</span>
490
- <span class='id identifier rubyid_get_source'>get_source</span><span class='lparen'>(</span><span class='const'>VALUE</span> <span class='kw'>self</span><span class='rparen'>)</span> <span class='lbrace'>{</span>
491
- <span class='id identifier rubyid_simplet_layer_t'>simplet_layer_t</span> <span class='op'>*</span><span class='id identifier rubyid_layer'>layer</span> <span class='op'>=</span> <span class='id identifier rubyid_get_layer'>get_layer</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span><span class='semicolon'>;</span>
492
- <span class='id identifier rubyid_char'>char</span> <span class='op'>*</span><span class='id identifier rubyid_source'>source</span><span class='semicolon'>;</span>
493
- <span class='id identifier rubyid_simplet_layer_get_source'>simplet_layer_get_source</span><span class='lparen'>(</span><span class='id identifier rubyid_layer'>layer</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_source'>source</span><span class='rparen'>)</span><span class='semicolon'>;</span>
494
- <span class='kw'>return</span> <span class='id identifier rubyid_rb_str_new2'>rb_str_new2</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='rparen'>)</span><span class='semicolon'>;</span>
495
- <span class='rbrace'>}</span></pre>
496
- </td>
497
- </tr>
498
- </table>
499
- </div>
500
-
501
- <div class="method_details ">
502
- <p class="signature " id="source=-instance_method">
503
-
504
- - (<tt>String</tt>) <strong>source=</strong>
505
-
506
-
507
-
508
- </p><div class="docstring">
509
- <div class="discussion">
510
-
511
- <p>Set the source attribute for the Layer.</p>
512
-
513
-
514
- </div>
515
- </div>
516
- <div class="tags">
517
- <h3>Parameters:</h3>
518
- <ul class="param">
519
-
520
- <li>
521
-
522
- <span class='name'></span>
523
-
524
-
525
- <span class='type'>(<tt>String</tt>)</span>
526
-
527
-
528
-
529
- </li>
530
-
531
- </ul>
532
-
533
- <h3>Returns:</h3>
534
- <ul class="return">
535
-
536
- <li>
537
-
538
-
539
- <span class='type'>(<tt>String</tt>)</span>
540
-
541
-
542
-
543
- </li>
544
-
545
- </ul>
546
-
547
- </div><table class="source_code">
548
- <tr>
549
- <td>
550
- <pre class="lines">
551
-
552
-
553
- </pre>
554
- </td>
555
- <td>
556
- <pre class="code"><span class="info file"># File 'ext/simpler_tiles/layer.c'</span>
557
-
558
- static VALUE
559
- set_source(VALUE self, VALUE source){</pre>
560
- </td>
561
- </tr>
562
- </table>
563
- </div>
564
-
565
- </div>
566
-
567
- </div>
568
-
569
- <div id="footer">
570
- Generated on Sat Dec 8 18:04:34 2012 by
571
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
572
- 0.7.5 (ruby-1.9.3).
573
- </div>
574
-
575
- </body>
576
- </html>