rubytext 0.1.22 → 0.1.23
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/lib/.yardoc/checksums +11 -0
- data/lib/.yardoc/complete +0 -0
- data/lib/.yardoc/object_types +0 -0
- data/lib/.yardoc/objects/root.dat +0 -0
- data/lib/.yardoc/proxy_types +0 -0
- data/lib/color.rb +22 -0
- data/lib/doc/RubyText.html +1410 -0
- data/lib/doc/RubyText/Color.html +366 -0
- data/lib/doc/RubyText/Effects.html +658 -0
- data/lib/doc/RubyText/Keys.html +300 -0
- data/lib/doc/RubyText/Settings.html +593 -0
- data/lib/doc/RubyText/Window.html +5074 -0
- data/lib/doc/RubyText/Window/GetString.html +812 -0
- data/lib/doc/WindowIO.html +541 -0
- data/lib/doc/_index.html +195 -0
- data/lib/doc/class_list.html +51 -0
- data/lib/doc/css/common.css +1 -0
- data/lib/doc/css/full_list.css +58 -0
- data/lib/doc/css/style.css +496 -0
- data/lib/doc/file_list.html +51 -0
- data/lib/doc/frames.html +17 -0
- data/lib/doc/index.html +195 -0
- data/lib/doc/js/app.js +314 -0
- data/lib/doc/js/full_list.js +216 -0
- data/lib/doc/js/jquery.js +4 -0
- data/lib/doc/method_list.html +987 -0
- data/lib/doc/top-level-namespace.html +483 -0
- data/lib/effects.rb +15 -1
- data/lib/keys.rb +3 -0
- data/lib/menu.rb +77 -3
- data/lib/navigation.rb +35 -0
- data/lib/output.rb +18 -4
- data/lib/rubytext_version.rb +1 -1
- data/lib/settings.rb +1 -0
- data/lib/window.rb +1 -0
- metadata +28 -2
@@ -0,0 +1,300 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Module: RubyText::Keys
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.24
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
16
|
+
|
17
|
+
<script type="text/javascript">
|
18
|
+
pathId = "RubyText::Keys";
|
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 (K)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../RubyText.html" title="RubyText (module)">RubyText</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Keys</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="../class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<div id="content"><h1>Module: RubyText::Keys
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
<dl>
|
78
|
+
<dt>Included in:</dt>
|
79
|
+
<dd><span class='object_link'><a href="Window.html" title="RubyText::Window (class)">Window</a></span></dd>
|
80
|
+
</dl>
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
<dl>
|
85
|
+
<dt>Defined in:</dt>
|
86
|
+
<dd>keys.rb<span class="defines">,<br />
|
87
|
+
rubytext.rb</span>
|
88
|
+
</dd>
|
89
|
+
</dl>
|
90
|
+
|
91
|
+
</div>
|
92
|
+
|
93
|
+
<h2>Overview</h2><div class="docstring">
|
94
|
+
<div class="discussion">
|
95
|
+
|
96
|
+
<p>Ruby constants for curses key definitions</p>
|
97
|
+
|
98
|
+
|
99
|
+
</div>
|
100
|
+
</div>
|
101
|
+
<div class="tags">
|
102
|
+
|
103
|
+
|
104
|
+
</div>
|
105
|
+
|
106
|
+
<h2>
|
107
|
+
Constant Summary
|
108
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
109
|
+
</h2>
|
110
|
+
|
111
|
+
<dl class="constants">
|
112
|
+
|
113
|
+
<dt id="Down-constant" class="">Down =
|
114
|
+
|
115
|
+
</dt>
|
116
|
+
<dd><pre class="code"><span class='int'>258</span></pre></dd>
|
117
|
+
|
118
|
+
<dt id="Up-constant" class="">Up =
|
119
|
+
|
120
|
+
</dt>
|
121
|
+
<dd><pre class="code"><span class='int'>259</span></pre></dd>
|
122
|
+
|
123
|
+
<dt id="Left-constant" class="">Left =
|
124
|
+
|
125
|
+
</dt>
|
126
|
+
<dd><pre class="code"><span class='int'>260</span></pre></dd>
|
127
|
+
|
128
|
+
<dt id="Right-constant" class="">Right =
|
129
|
+
|
130
|
+
</dt>
|
131
|
+
<dd><pre class="code"><span class='int'>261</span></pre></dd>
|
132
|
+
|
133
|
+
<dt id="Enter-constant" class="">Enter =
|
134
|
+
|
135
|
+
</dt>
|
136
|
+
<dd><pre class="code"><span class='int'>10</span></pre></dd>
|
137
|
+
|
138
|
+
<dt id="NL-constant" class="">NL =
|
139
|
+
|
140
|
+
</dt>
|
141
|
+
<dd><pre class="code"><span class='int'>10</span></pre></dd>
|
142
|
+
|
143
|
+
<dt id="LF-constant" class="">LF =
|
144
|
+
|
145
|
+
</dt>
|
146
|
+
<dd><pre class="code"><span class='int'>10</span></pre></dd>
|
147
|
+
|
148
|
+
<dt id="EOF-constant" class="">EOF =
|
149
|
+
|
150
|
+
</dt>
|
151
|
+
<dd><pre class="code"><span class='int'>4</span></pre></dd>
|
152
|
+
|
153
|
+
<dt id="CtlD-constant" class="">CtlD =
|
154
|
+
|
155
|
+
</dt>
|
156
|
+
<dd><pre class="code"><span class='int'>4</span></pre></dd>
|
157
|
+
|
158
|
+
<dt id="Back-constant" class="">Back =
|
159
|
+
<div class="docstring">
|
160
|
+
<div class="discussion">
|
161
|
+
|
162
|
+
<p>backspace</p>
|
163
|
+
|
164
|
+
|
165
|
+
</div>
|
166
|
+
</div>
|
167
|
+
<div class="tags">
|
168
|
+
|
169
|
+
|
170
|
+
</div>
|
171
|
+
</dt>
|
172
|
+
<dd><pre class="code"><span class='int'>8</span></pre></dd>
|
173
|
+
|
174
|
+
<dt id="BS-constant" class="">BS =
|
175
|
+
|
176
|
+
</dt>
|
177
|
+
<dd><pre class="code"><span class='int'>8</span></pre></dd>
|
178
|
+
|
179
|
+
<dt id="Tab-constant" class="">Tab =
|
180
|
+
|
181
|
+
</dt>
|
182
|
+
<dd><pre class="code"><span class='int'>9</span></pre></dd>
|
183
|
+
|
184
|
+
<dt id="TAB-constant" class="">TAB =
|
185
|
+
|
186
|
+
</dt>
|
187
|
+
<dd><pre class="code"><span class='int'>9</span></pre></dd>
|
188
|
+
|
189
|
+
<dt id="Escape-constant" class="">Escape =
|
190
|
+
|
191
|
+
</dt>
|
192
|
+
<dd><pre class="code"><span class='int'>27</span></pre></dd>
|
193
|
+
|
194
|
+
<dt id="ESC-constant" class="">ESC =
|
195
|
+
|
196
|
+
</dt>
|
197
|
+
<dd><pre class="code"><span class='int'>27</span></pre></dd>
|
198
|
+
|
199
|
+
<dt id="Esc-constant" class="">Esc =
|
200
|
+
|
201
|
+
</dt>
|
202
|
+
<dd><pre class="code"><span class='int'>27</span></pre></dd>
|
203
|
+
|
204
|
+
<dt id="Delete-constant" class="">Delete =
|
205
|
+
|
206
|
+
</dt>
|
207
|
+
<dd><pre class="code"><span class='int'>127</span></pre></dd>
|
208
|
+
|
209
|
+
<dt id="DEL-constant" class="">DEL =
|
210
|
+
|
211
|
+
</dt>
|
212
|
+
<dd><pre class="code"><span class='int'>127</span></pre></dd>
|
213
|
+
|
214
|
+
<dt id="Del-constant" class="">Del =
|
215
|
+
|
216
|
+
</dt>
|
217
|
+
<dd><pre class="code"><span class='int'>127</span></pre></dd>
|
218
|
+
|
219
|
+
<dt id="F1-constant" class="">F1 =
|
220
|
+
|
221
|
+
</dt>
|
222
|
+
<dd><pre class="code"><span class='int'>265</span></pre></dd>
|
223
|
+
|
224
|
+
<dt id="F2-constant" class="">F2 =
|
225
|
+
|
226
|
+
</dt>
|
227
|
+
<dd><pre class="code"><span class='int'>266</span></pre></dd>
|
228
|
+
|
229
|
+
<dt id="F3-constant" class="">F3 =
|
230
|
+
|
231
|
+
</dt>
|
232
|
+
<dd><pre class="code"><span class='int'>267</span></pre></dd>
|
233
|
+
|
234
|
+
<dt id="F4-constant" class="">F4 =
|
235
|
+
|
236
|
+
</dt>
|
237
|
+
<dd><pre class="code"><span class='int'>268</span></pre></dd>
|
238
|
+
|
239
|
+
<dt id="F5-constant" class="">F5 =
|
240
|
+
|
241
|
+
</dt>
|
242
|
+
<dd><pre class="code"><span class='int'>269</span></pre></dd>
|
243
|
+
|
244
|
+
<dt id="F6-constant" class="">F6 =
|
245
|
+
|
246
|
+
</dt>
|
247
|
+
<dd><pre class="code"><span class='int'>270</span></pre></dd>
|
248
|
+
|
249
|
+
<dt id="F7-constant" class="">F7 =
|
250
|
+
|
251
|
+
</dt>
|
252
|
+
<dd><pre class="code"><span class='int'>271</span></pre></dd>
|
253
|
+
|
254
|
+
<dt id="F8-constant" class="">F8 =
|
255
|
+
|
256
|
+
</dt>
|
257
|
+
<dd><pre class="code"><span class='int'>272</span></pre></dd>
|
258
|
+
|
259
|
+
<dt id="F9-constant" class="">F9 =
|
260
|
+
|
261
|
+
</dt>
|
262
|
+
<dd><pre class="code"><span class='int'>273</span></pre></dd>
|
263
|
+
|
264
|
+
<dt id="F10-constant" class="">F10 =
|
265
|
+
|
266
|
+
</dt>
|
267
|
+
<dd><pre class="code"><span class='int'>274</span></pre></dd>
|
268
|
+
|
269
|
+
<dt id="F11-constant" class="">F11 =
|
270
|
+
|
271
|
+
</dt>
|
272
|
+
<dd><pre class="code"><span class='int'>275</span></pre></dd>
|
273
|
+
|
274
|
+
<dt id="F12-constant" class="">F12 =
|
275
|
+
|
276
|
+
</dt>
|
277
|
+
<dd><pre class="code"><span class='int'>276</span></pre></dd>
|
278
|
+
|
279
|
+
</dl>
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
</div>
|
291
|
+
|
292
|
+
<div id="footer">
|
293
|
+
Generated on Sat Feb 8 04:23:59 2020 by
|
294
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
295
|
+
0.9.24 (ruby-2.4.2).
|
296
|
+
</div>
|
297
|
+
|
298
|
+
</div>
|
299
|
+
</body>
|
300
|
+
</html>
|
@@ -0,0 +1,593 @@
|
|
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: RubyText::Settings
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.24
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
16
|
+
|
17
|
+
<script type="text/javascript">
|
18
|
+
pathId = "RubyText::Settings";
|
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 (S)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../RubyText.html" title="RubyText (module)">RubyText</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Settings</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: RubyText::Settings
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
<dl>
|
70
|
+
<dt>Inherits:</dt>
|
71
|
+
<dd>
|
72
|
+
<span class="inheritName">Object</span>
|
73
|
+
|
74
|
+
<ul class="fullTree">
|
75
|
+
<li>Object</li>
|
76
|
+
|
77
|
+
<li class="next">RubyText::Settings</li>
|
78
|
+
|
79
|
+
</ul>
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
81
|
+
|
82
|
+
</dd>
|
83
|
+
</dl>
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
<dl>
|
96
|
+
<dt>Defined in:</dt>
|
97
|
+
<dd>settings.rb</dd>
|
98
|
+
</dl>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
103
|
+
<div class="discussion">
|
104
|
+
|
105
|
+
<p>Hmm, all these are module-level…?</p>
|
106
|
+
|
107
|
+
|
108
|
+
</div>
|
109
|
+
</div>
|
110
|
+
<div class="tags">
|
111
|
+
|
112
|
+
|
113
|
+
</div>
|
114
|
+
|
115
|
+
<h2>
|
116
|
+
Constant Summary
|
117
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
118
|
+
</h2>
|
119
|
+
|
120
|
+
<dl class="constants">
|
121
|
+
|
122
|
+
<dt id="ValidArgs-constant" class="">ValidArgs =
|
123
|
+
|
124
|
+
</dt>
|
125
|
+
<dd><pre class="code"><span class='lbracket'>[</span><span class='symbol'>:raw</span><span class='comma'>,</span> <span class='symbol'>:_raw</span><span class='comma'>,</span> <span class='symbol'>:echo</span><span class='comma'>,</span> <span class='symbol'>:_echo</span><span class='comma'>,</span> <span class='symbol'>:cbreak</span><span class='comma'>,</span> <span class='symbol'>:_cbreak</span><span class='comma'>,</span>
|
126
|
+
<span class='symbol'>:keypad</span><span class='comma'>,</span> <span class='symbol'>:_keypad</span><span class='comma'>,</span> <span class='symbol'>:cursor</span><span class='comma'>,</span> <span class='symbol'>:_cursor</span><span class='rbracket'>]</span></pre></dd>
|
127
|
+
|
128
|
+
</dl>
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
<h2>
|
139
|
+
Instance Method Summary
|
140
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
141
|
+
</h2>
|
142
|
+
|
143
|
+
<ul class="summary">
|
144
|
+
|
145
|
+
<li class="public ">
|
146
|
+
<span class="summary_signature">
|
147
|
+
|
148
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ Settings </a>
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
</span>
|
153
|
+
|
154
|
+
|
155
|
+
<span class="note title constructor">constructor</span>
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
<span class="summary_desc"><div class='inline'>
|
165
|
+
<p>A new instance of Settings.</p>
|
166
|
+
</div></span>
|
167
|
+
|
168
|
+
</li>
|
169
|
+
|
170
|
+
|
171
|
+
<li class="public ">
|
172
|
+
<span class="summary_signature">
|
173
|
+
|
174
|
+
<a href="#reset-instance_method" title="#reset (instance method)">#<strong>reset</strong> ⇒ Object </a>
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
</span>
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
189
|
+
|
190
|
+
</li>
|
191
|
+
|
192
|
+
|
193
|
+
<li class="public ">
|
194
|
+
<span class="summary_signature">
|
195
|
+
|
196
|
+
<a href="#reset_boolean-instance_method" title="#reset_boolean (instance method)">#<strong>reset_boolean</strong> ⇒ Object </a>
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
</span>
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
211
|
+
|
212
|
+
</li>
|
213
|
+
|
214
|
+
|
215
|
+
<li class="public ">
|
216
|
+
<span class="summary_signature">
|
217
|
+
|
218
|
+
<a href="#set-instance_method" title="#set (instance method)">#<strong>set</strong>(*syms) ⇒ Object </a>
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
</span>
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
233
|
+
|
234
|
+
</li>
|
235
|
+
|
236
|
+
|
237
|
+
<li class="public ">
|
238
|
+
<span class="summary_signature">
|
239
|
+
|
240
|
+
<a href="#set_boolean-instance_method" title="#set_boolean (instance method)">#<strong>set_boolean</strong>(raw: nil, echo: nil, cbreak: nil, keypad: nil, cursor: nil) ⇒ Object </a>
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
</span>
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
255
|
+
|
256
|
+
</li>
|
257
|
+
|
258
|
+
|
259
|
+
<li class="public ">
|
260
|
+
<span class="summary_signature">
|
261
|
+
|
262
|
+
<a href="#set_curses-instance_method" title="#set_curses (instance method)">#<strong>set_curses</strong>(**hash) ⇒ Object </a>
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
</span>
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
277
|
+
|
278
|
+
</li>
|
279
|
+
|
280
|
+
|
281
|
+
</ul>
|
282
|
+
|
283
|
+
|
284
|
+
<div id="constructor_details" class="method_details_list">
|
285
|
+
<h2>Constructor Details</h2>
|
286
|
+
|
287
|
+
<div class="method_details first">
|
288
|
+
<h3 class="signature first" id="initialize-instance_method">
|
289
|
+
|
290
|
+
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="RubyText::Settings (class)">Settings</a></span></tt>
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
</h3><div class="docstring">
|
297
|
+
<div class="discussion">
|
298
|
+
|
299
|
+
<p>Returns a new instance of Settings.</p>
|
300
|
+
|
301
|
+
|
302
|
+
</div>
|
303
|
+
</div>
|
304
|
+
<div class="tags">
|
305
|
+
|
306
|
+
|
307
|
+
</div><table class="source_code">
|
308
|
+
<tr>
|
309
|
+
<td>
|
310
|
+
<pre class="lines">
|
311
|
+
|
312
|
+
|
313
|
+
7
|
314
|
+
8
|
315
|
+
9
|
316
|
+
10
|
317
|
+
11
|
318
|
+
12
|
319
|
+
13
|
320
|
+
14</pre>
|
321
|
+
</td>
|
322
|
+
<td>
|
323
|
+
<pre class="code"><span class="info file"># File 'settings.rb', line 7</span>
|
324
|
+
|
325
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
326
|
+
<span class='ivar'>@defaults</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>raw:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>echo:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>cbreak:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>keypad:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>cursor:</span> <span class='kw'>true</span><span class='rbrace'>}</span>
|
327
|
+
<span class='ivar'>@current</span> <span class='op'>=</span> <span class='ivar'>@defaults</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
|
328
|
+
<span class='ivar'>@stack</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
329
|
+
<span class='ivar'>@stack</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='ivar'>@current</span> <span class='comment'># Note: Never let stack be empty
|
330
|
+
</span> <span class='id identifier rubyid_set_curses'>set_curses</span><span class='lparen'>(</span><span class='ivar'>@current</span><span class='rparen'>)</span> <span class='comment'># Set them for real
|
331
|
+
</span> <span class='comment'># FIXME To be continued...
|
332
|
+
</span><span class='kw'>end</span></pre>
|
333
|
+
</td>
|
334
|
+
</tr>
|
335
|
+
</table>
|
336
|
+
</div>
|
337
|
+
|
338
|
+
</div>
|
339
|
+
|
340
|
+
|
341
|
+
<div id="instance_method_details" class="method_details_list">
|
342
|
+
<h2>Instance Method Details</h2>
|
343
|
+
|
344
|
+
|
345
|
+
<div class="method_details first">
|
346
|
+
<h3 class="signature first" id="reset-instance_method">
|
347
|
+
|
348
|
+
#<strong>reset</strong> ⇒ <tt>Object</tt>
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
|
353
|
+
|
354
|
+
</h3><table class="source_code">
|
355
|
+
<tr>
|
356
|
+
<td>
|
357
|
+
<pre class="lines">
|
358
|
+
|
359
|
+
|
360
|
+
64
|
361
|
+
65
|
362
|
+
66</pre>
|
363
|
+
</td>
|
364
|
+
<td>
|
365
|
+
<pre class="code"><span class="info file"># File 'settings.rb', line 64</span>
|
366
|
+
|
367
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_reset'>reset</span>
|
368
|
+
<span class='comment'># FIXME - call reset_boolean
|
369
|
+
</span><span class='kw'>end</span></pre>
|
370
|
+
</td>
|
371
|
+
</tr>
|
372
|
+
</table>
|
373
|
+
</div>
|
374
|
+
|
375
|
+
<div class="method_details ">
|
376
|
+
<h3 class="signature " id="reset_boolean-instance_method">
|
377
|
+
|
378
|
+
#<strong>reset_boolean</strong> ⇒ <tt>Object</tt>
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
|
383
|
+
|
384
|
+
</h3><table class="source_code">
|
385
|
+
<tr>
|
386
|
+
<td>
|
387
|
+
<pre class="lines">
|
388
|
+
|
389
|
+
|
390
|
+
45
|
391
|
+
46
|
392
|
+
47
|
393
|
+
48</pre>
|
394
|
+
</td>
|
395
|
+
<td>
|
396
|
+
<pre class="code"><span class="info file"># File 'settings.rb', line 45</span>
|
397
|
+
|
398
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_reset_boolean'>reset_boolean</span>
|
399
|
+
<span class='ivar'>@current</span> <span class='op'>=</span> <span class='ivar'>@stack</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span> <span class='kw'>rescue</span> <span class='ivar'>@stack</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
|
400
|
+
<span class='id identifier rubyid_set_curses'>set_curses</span><span class='lparen'>(</span><span class='ivar'>@current</span><span class='rparen'>)</span>
|
401
|
+
<span class='kw'>end</span></pre>
|
402
|
+
</td>
|
403
|
+
</tr>
|
404
|
+
</table>
|
405
|
+
</div>
|
406
|
+
|
407
|
+
<div class="method_details ">
|
408
|
+
<h3 class="signature " id="set-instance_method">
|
409
|
+
|
410
|
+
#<strong>set</strong>(*syms) ⇒ <tt>Object</tt>
|
411
|
+
|
412
|
+
|
413
|
+
|
414
|
+
|
415
|
+
|
416
|
+
</h3><div class="docstring">
|
417
|
+
<div class="discussion">
|
418
|
+
|
419
|
+
|
420
|
+
</div>
|
421
|
+
</div>
|
422
|
+
<div class="tags">
|
423
|
+
|
424
|
+
<p class="tag_title">Raises:</p>
|
425
|
+
<ul class="raise">
|
426
|
+
|
427
|
+
<li>
|
428
|
+
|
429
|
+
|
430
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
431
|
+
|
432
|
+
|
433
|
+
|
434
|
+
</li>
|
435
|
+
|
436
|
+
</ul>
|
437
|
+
|
438
|
+
</div><table class="source_code">
|
439
|
+
<tr>
|
440
|
+
<td>
|
441
|
+
<pre class="lines">
|
442
|
+
|
443
|
+
|
444
|
+
50
|
445
|
+
51
|
446
|
+
52
|
447
|
+
53
|
448
|
+
54
|
449
|
+
55
|
450
|
+
56
|
451
|
+
57
|
452
|
+
58
|
453
|
+
59
|
454
|
+
60
|
455
|
+
61
|
456
|
+
62</pre>
|
457
|
+
</td>
|
458
|
+
<td>
|
459
|
+
<pre class="code"><span class="info file"># File 'settings.rb', line 50</span>
|
460
|
+
|
461
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_syms'>syms</span><span class='rparen'>)</span>
|
462
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span> <span class='kw'>unless</span> <span class='id identifier rubyid_syms'>syms</span> <span class='op'>-</span> <span class='const'><span class='object_link'><a href="#ValidArgs-constant" title="RubyText::Settings::ValidArgs (constant)">ValidArgs</a></span></span> <span class='op'>==</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
463
|
+
<span class='comment'># FIXME - call set_boolean
|
464
|
+
</span> <span class='id identifier rubyid_list'>list</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
465
|
+
<span class='id identifier rubyid_syms'>syms</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_sym'>sym</span><span class='op'>|</span>
|
466
|
+
<span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='id identifier rubyid_sym'>sym</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
467
|
+
<span class='id identifier rubyid_val'>val</span> <span class='op'>=</span> <span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>_</span><span class='tstring_end'>"</span></span>
|
468
|
+
<span class='id identifier rubyid_sym0'>sym0</span> <span class='op'>=</span> <span class='id identifier rubyid_val'>val</span> <span class='op'>?</span> <span class='id identifier rubyid_sym'>sym</span> <span class='op'>:</span> <span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
|
469
|
+
<span class='id identifier rubyid_list'>list</span><span class='lbracket'>[</span><span class='id identifier rubyid_sym0'>sym0</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_val'>val</span>
|
470
|
+
<span class='kw'>end</span>
|
471
|
+
<span class='id identifier rubyid_set_boolean'>set_boolean</span><span class='lparen'>(</span><span class='id identifier rubyid_list'>list</span><span class='rparen'>)</span>
|
472
|
+
<span class='comment'># allow a block here?
|
473
|
+
</span><span class='kw'>end</span></pre>
|
474
|
+
</td>
|
475
|
+
</tr>
|
476
|
+
</table>
|
477
|
+
</div>
|
478
|
+
|
479
|
+
<div class="method_details ">
|
480
|
+
<h3 class="signature " id="set_boolean-instance_method">
|
481
|
+
|
482
|
+
#<strong>set_boolean</strong>(raw: nil, echo: nil, cbreak: nil, keypad: nil, cursor: nil) ⇒ <tt>Object</tt>
|
483
|
+
|
484
|
+
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
</h3><table class="source_code">
|
489
|
+
<tr>
|
490
|
+
<td>
|
491
|
+
<pre class="lines">
|
492
|
+
|
493
|
+
|
494
|
+
34
|
495
|
+
35
|
496
|
+
36
|
497
|
+
37
|
498
|
+
38
|
499
|
+
39
|
500
|
+
40
|
501
|
+
41
|
502
|
+
42
|
503
|
+
43</pre>
|
504
|
+
</td>
|
505
|
+
<td>
|
506
|
+
<pre class="code"><span class="info file"># File 'settings.rb', line 34</span>
|
507
|
+
|
508
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_set_boolean'>set_boolean</span><span class='lparen'>(</span><span class='label'>raw:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>echo:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>cbreak:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>keypad:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>cursor:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
509
|
+
<span class='id identifier rubyid_raw'>raw</span> <span class='op'>||=</span> <span class='ivar'>@current</span><span class='lbracket'>[</span><span class='symbol'>:raw</span><span class='rbracket'>]</span>
|
510
|
+
<span class='id identifier rubyid_echo'>echo</span> <span class='op'>||=</span> <span class='ivar'>@current</span><span class='lbracket'>[</span><span class='symbol'>:echo</span><span class='rbracket'>]</span>
|
511
|
+
<span class='id identifier rubyid_cbreak'>cbreak</span> <span class='op'>||=</span> <span class='ivar'>@current</span><span class='lbracket'>[</span><span class='symbol'>:cbreak</span><span class='rbracket'>]</span>
|
512
|
+
<span class='id identifier rubyid_keypad'>keypad</span> <span class='op'>||=</span> <span class='ivar'>@current</span><span class='lbracket'>[</span><span class='symbol'>:keypad</span><span class='rbracket'>]</span>
|
513
|
+
<span class='id identifier rubyid_cursor'>cursor</span> <span class='op'>||=</span> <span class='ivar'>@current</span><span class='lbracket'>[</span><span class='symbol'>:cursor</span><span class='rbracket'>]</span>
|
514
|
+
<span class='ivar'>@stack</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='ivar'>@current</span>
|
515
|
+
<span class='ivar'>@current</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>raw:</span> <span class='id identifier rubyid_raw'>raw</span><span class='comma'>,</span> <span class='label'>echo:</span> <span class='id identifier rubyid_echo'>echo</span><span class='comma'>,</span> <span class='label'>cbreak:</span> <span class='id identifier rubyid_cbreak'>cbreak</span><span class='comma'>,</span> <span class='label'>keypad:</span> <span class='id identifier rubyid_keypad'>keypad</span><span class='comma'>,</span> <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span><span class='rbrace'>}</span>
|
516
|
+
<span class='id identifier rubyid_set_curses'>set_curses</span><span class='lparen'>(</span><span class='ivar'>@current</span><span class='rparen'>)</span>
|
517
|
+
<span class='kw'>end</span></pre>
|
518
|
+
</td>
|
519
|
+
</tr>
|
520
|
+
</table>
|
521
|
+
</div>
|
522
|
+
|
523
|
+
<div class="method_details ">
|
524
|
+
<h3 class="signature " id="set_curses-instance_method">
|
525
|
+
|
526
|
+
#<strong>set_curses</strong>(**hash) ⇒ <tt>Object</tt>
|
527
|
+
|
528
|
+
|
529
|
+
|
530
|
+
|
531
|
+
|
532
|
+
</h3><table class="source_code">
|
533
|
+
<tr>
|
534
|
+
<td>
|
535
|
+
<pre class="lines">
|
536
|
+
|
537
|
+
|
538
|
+
16
|
539
|
+
17
|
540
|
+
18
|
541
|
+
19
|
542
|
+
20
|
543
|
+
21
|
544
|
+
22
|
545
|
+
23
|
546
|
+
24
|
547
|
+
25
|
548
|
+
26
|
549
|
+
27
|
550
|
+
28
|
551
|
+
29
|
552
|
+
30
|
553
|
+
31
|
554
|
+
32</pre>
|
555
|
+
</td>
|
556
|
+
<td>
|
557
|
+
<pre class="code"><span class="info file"># File 'settings.rb', line 16</span>
|
558
|
+
|
559
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_set_curses'>set_curses</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
|
560
|
+
<span class='comment'># Later: check for bad keys
|
561
|
+
</span> <span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_sym'>sym</span><span class='comma'>,</span> <span class='id identifier rubyid_val'>val</span><span class='op'>|</span>
|
562
|
+
<span class='kw'>case</span> <span class='lbracket'>[</span><span class='id identifier rubyid_sym'>sym</span><span class='comma'>,</span> <span class='id identifier rubyid_val'>val</span><span class='rbracket'>]</span>
|
563
|
+
<span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:cbreak</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_cbreak'>cbreak</span>
|
564
|
+
<span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:cbreak</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_nocbreak'>nocbreak</span>
|
565
|
+
<span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:raw</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_raw'>raw</span>
|
566
|
+
<span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:raw</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_noraw'>noraw</span>
|
567
|
+
<span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:echo</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_echo'>echo</span>
|
568
|
+
<span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:echo</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_noecho'>noecho</span>
|
569
|
+
<span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:keypad</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_stdscr'>stdscr</span><span class='period'>.</span><span class='id identifier rubyid_keypad'>keypad</span><span class='lparen'>(</span><span class='kw'>true</span><span class='rparen'>)</span>
|
570
|
+
<span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:keypad</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_stdscr'>stdscr</span><span class='period'>.</span><span class='id identifier rubyid_keypad'>keypad</span><span class='lparen'>(</span><span class='kw'>false</span><span class='rparen'>)</span>
|
571
|
+
<span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:cursor</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_curs_set'>curs_set</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span>
|
572
|
+
<span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:cursor</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_curs_set'>curs_set</span><span class='lparen'>(</span><span class='int'>0</span><span class='rparen'>)</span>
|
573
|
+
<span class='kw'>end</span>
|
574
|
+
<span class='kw'>end</span>
|
575
|
+
<span class='kw'>end</span></pre>
|
576
|
+
</td>
|
577
|
+
</tr>
|
578
|
+
</table>
|
579
|
+
</div>
|
580
|
+
|
581
|
+
</div>
|
582
|
+
|
583
|
+
</div>
|
584
|
+
|
585
|
+
<div id="footer">
|
586
|
+
Generated on Sat Feb 8 04:24:00 2020 by
|
587
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
588
|
+
0.9.24 (ruby-2.4.2).
|
589
|
+
</div>
|
590
|
+
|
591
|
+
</div>
|
592
|
+
</body>
|
593
|
+
</html>
|