Module: RubyCurses::WidgetShortcuts
- Included in:
- App
- Defined in:
- lib/rbcurse/core/util/widgetshortcuts.rb
Defined Under Namespace
Classes: Ws, WsFlow, WsStack
Class Method Summary
collapse
Instance Method Summary
collapse
-
#_configure(s) ⇒ Object
This configures a stack or flow not the objects inside.
-
#_position(w) ⇒ Object
-
#app_header(title, config = {}, &block) ⇒ Object
-
#blank ⇒ Object
-
#box(config = {}, &block) ⇒ Object
flow and stack could have a border option NOTE: box takes one row below too, so :expand overwrites that line.
-
#dock(labels, config = {}, &block) ⇒ Object
prints pine-like key labels.
-
#flow(config = {}, &block) ⇒ Object
item_width - width to use per item but the item width may apply to stacks inside not to items.
-
#line(config = {}) ⇒ Object
-
#link(config = {}, &block) ⇒ Object
-
#listbox(config = {}, &block) ⇒ Object
-
#menubar(&block) ⇒ Object
-
#menulink(config = {}, &block) ⇒ Object
-
#radio(config = {}, &block) ⇒ Object
horizontal line TODO row = config || @app_row width = config || 20 _position config col = config || 1 @window.attron(Ncurses.COLOR_PAIR(@color_pair) | @attrib) @window.mvwhline( row, col, FFI::NCurses::ACS_HLINE, width) @window.attron(Ncurses.COLOR_PAIR(@color_pair) | @attrib).
-
#stack(config = {}, &block) ⇒ Object
make it as simple as possible, don’t try to be intelligent or clever, put as much on the user.
-
#tabular_widget(config = {}, &block) ⇒ Object
(also: #table)
creates a simple readonly table, that allows users to click on rows and also on the header.
-
#textarea(config = {}, &block) ⇒ Object
-
#textview(config = {}, &block) ⇒ Object
-
#tree(config = {}, &block) ⇒ Object
-
#vimsplit(config = {}, &block) ⇒ Object
-
#widget_shortcuts_init ⇒ Object
Class Method Details
create a shortcut for a class path is path of file to use in require starting with rbcurse klass is name of class to instantiate
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 91
def self.def_widget(path, klass, short=nil)
p=""
if path
p="require \"#{path}\""
end
short ||= klass.to_s.downcase
eval %{
def #{short}(config={}, &block)
if config.is_a? String
_s = config
config = {}
config[:text] = _s
end
#{p}
w = #{klass}.new nil, config
_position w
w.command &block if block_given?
return w
end
}
end
|
Instance Method Details
This configures a stack or flow not the objects inside
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 460
def _configure s
s[:row] ||= 0
s[:col] ||= 0
s[:row] += (s[:margin_top] || 0)
s[:col] += (s[:margin_left] || 0)
s[:width] = FFI::NCurses.COLS-s[:col] if s[:width] == :expand
s[:height] = FFI::NCurses.LINES-s[:row] if s[:height] == :expand last = @_ws_active.last
if last
if s[:width_pc]
if last.is_a? WsStack
s[:width] = (last[:width] * (s[:width_pc].to_i * 0.01)).floor
else
last[:item_width] = (last[:width] * (s[:width_pc].to_i* 0.01)).floor
end
end
if s[:height_pc]
if last.is_a? WsFlow
s[:height] = ( (last[:height] * s[:height_pc].to_i)/100).floor
else
s[:item_height] = ( (last[:height] * s[:height_pc].to_i)/100).floor
end
end
if last.is_a? WsStack
s[:row] += (last[:row] || 0)
s[:col] += (last[:col] || 0)
else
s[:row] += (last[:row] || 0)
s[:col] += (last[:col] || 0) s[:width] ||= last[:item_width] end
else
s[:width] ||= :expand
s[:height] ||= :expand
s[:width] = FFI::NCurses.COLS-s[:col] if s[:width] == :expand
s[:height] = FFI::NCurses.LINES-s[:row] if s[:height] == :expand end
s[:components] = []
end
|
#_position(w) ⇒ Object
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 288
def _position w
if @_ws_active.nil? || @_ws_active.empty?
w.row ||= 0
w.col ||= 0
w.set_form @form if @form if w.width == :expand w.width = FFI::NCurses.COLS-w.col end
if w.height == :expand
w.height = FFI::NCurses.LINES-w.row end
return
end
cur = @_ws_active.last
unless cur
raise "This should have been handled previously.Somethings wrong, check/untested"
end
r = cur[:row] || 0
c = cur[:col] || 0
w.row = r
w.col = c
if w.height_pc
w.height = ( (cur[:height] * w.height_pc.to_i)/100).floor
end
if w.height == :expand
if cur.is_a? WsFlow
w.height = cur[:height] || 8 else
w.height = cur[:item_height] || 8 end
end
if w.width == :expand
if cur.is_a? WsFlow
if cur[:item_width]
w.width = cur[:item_width] elsif w.width_pc
w.width = (cur[:width] * (w.width_pc.to_i * 0.01)).floor
else
w.width = cur[:width]
end
raise "width could not be calculated. i need flow width and item width_pc" if w.width == :expand
else
w.width = cur[:width] or raise "Width not known for stack #{cur.class}, #{cur[:width]} "
end
end
if cur.is_a? WsStack
r += w.height || 1 cur[:row] = r
else
wid = cur[:item_width] || w.width || 10
c += wid + 1
cur[:col] = c
end
if cur.is_a? WsFlow
unless w.height
w.height = cur[:height] end
end
w.color ||= cur[:color]
w.bgcolor ||= cur[:bgcolor]
w.set_form @form if @form @_ws_components << w
cur[:components] << w
end
|
123
124
125
126
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 123
def title, config={}, &block
require 'rbcurse/core/widgets/applicationheader'
= ApplicationHeader.new @form, title, config, &block
end
|
55
56
57
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 55
def blank
label :text => ""
end
|
#box(config = {}, &block) ⇒ Object
flow and stack could have a border option NOTE: box takes one row below too, so :expand overwrites that line
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 418
def box config={}, &block
require 'rbcurse/core/widgets/box'
@_ws_active ||= []
last = @_ws_active.last
if last
r = last[:row]
c = last[:col]
config[:row] = r
config[:col] = c
last[:row] += config[:margin_top] || 1
last[:col] += config[:margin_left] || 1
_box = Box.new @form, config yield_or_eval &block if block_given?
h = config[:height] || last[:height] || (last[:row] - r)
h = 2 if h < 2
w = config[:width] || last[:width] || 15 case last
when WsFlow
w = last[:col]
when WsStack
end
config[:row] = r
config[:col] = c
config[:height] = h
config[:width] = w
_box.row r
_box.col c
_box.height h
_box.width w
last[:row] += 1
last[:col] += 1 end
end
|
#dock(labels, config = {}, &block) ⇒ Object
prints pine-like key labels
189
190
191
192
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 189
def dock labels, config={}, &block
require 'rbcurse/core/widgets/keylabelprinter'
klp = RubyCurses::KeyLabelPrinter.new @form, labels, config, &block
end
|
#flow(config = {}, &block) ⇒ Object
item_width - width to use per item
but the item width may apply to stacks inside not to items
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 394
def flow config={}, &block
s = WsFlow.new config
@_ws_active ||= []
_configure s
@_ws_active << s
yield_or_eval &block if block_given?
@_ws_active.pop
last = @_ws_active.last
if last
case last
when WsStack
if s[:height]
last[:row] += s[:height]
else
last[:row] += 1
end
when WsFlow
last[:col] += last[:item_width] || 0
end
end
end
|
#line(config = {}) ⇒ Object
58
59
60
61
62
63
64
65
66
67
68
69
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 58
def line config={}
end
|
#link(config = {}, &block) ⇒ Object
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 194
def link config={}, &block
if config.is_a? String
_s = config
config = {}
config[:text] = _s
end
require 'rbcurse/core/widgets/rlink'
events = [ :PRESS, :LEAVE, :ENTER ]
block_event = :PRESS
config[:highlight_foreground] = "yellow"
config[:highlight_background] = "red"
toggle = Link.new nil, config
_position(toggle)
if block
toggle.bind(block_event, toggle, &block)
end
return toggle
end
|
#listbox(config = {}, &block) ⇒ Object
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 169
def listbox config={}, &block
events = [ :PRESS, :ENTER_ROW, :LEAVE, :ENTER ]
block_event = events[0]
useform = nil
w = List.new useform, config
w.width = :expand unless w.width
w.height ||= :expand _position(w)
if block
w.bind(block_event, &block)
end
return w
end
|
119
120
121
122
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 119
def &block
require 'rbcurse/core/widgets/rmenu'
RubyCurses::MenuBar.new &block
end
|
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 212
def config={}, &block
if config.is_a? String
_s = config
config = {}
config[:text] = _s
end
require 'rbcurse/core/widgets/rmenulink'
events = [ :PRESS, :LEAVE, :ENTER ]
block_event = :PRESS
config[:highlight_foreground] = "yellow"
config[:highlight_background] = "red"
w = MenuLink.new nil, config
_position(w)
if block
w.bind(block_event, w, &block)
end
return w
end
|
#radio(config = {}, &block) ⇒ Object
horizontal line TODO row = config || @app_row width = config || 20 _position config col = config || 1 @window.attron(Ncurses.COLOR_PAIR(@color_pair) | @attrib) @window.mvwhline( row, col, FFI::NCurses::ACS_HLINE, width) @window.attron(Ncurses.COLOR_PAIR(@color_pair) | @attrib)
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 70
def radio config={}, &block
a = config[:group]
if @variables.has_key? a
v = @variables[a]
else
v = Variable.new
@variables[a] = v
end
config[:variable] = v
config.delete(:group)
w = RadioButton.new nil, config _position w
if block
w.bind(:PRESS, &block)
end
return w
end
|
#stack(config = {}, &block) ⇒ Object
make it as simple as possible, don’t try to be intelligent or clever, put as much on the user
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 367
def stack config={}, &block
s = WsStack.new config
@_ws_active ||= []
_configure s
@_ws_active << s
yield_or_eval &block if block_given?
@_ws_active.pop
last = @_ws_active.last
if last
case last
when WsStack
when WsFlow
last[:col] += last[:item_width] || 0
last[:height] = s[:row] if s[:row] > (last[:height]||0)
$log.debug "XXX: STACK setting col to #{s[:col]} "
end
end
end
|
creates a simple readonly table, that allows users to click on rows and also on the header. Header clicking is for column-sorting.
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 247
def tabular_widget config={}, &block
require 'rbcurse/core/widgets/tabularwidget'
events = [:PROPERTY_CHANGE, :LEAVE, :ENTER, :CHANGE, :ENTER_ROW, :PRESS ]
block_event = nil
useform = nil
w = TabularWidget.new useform, config w.width ||= :expand
w.height ||= :expand _position(w)
if block_given?
yield_or_eval &block
end
return w
end
|
#textarea(config = {}, &block) ⇒ Object
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 128
def textarea config={}, &block
require 'rbcurse/core/widgets/rtextarea'
events = [ :CHANGE, :LEAVE, :ENTER ]
block_event = events[0]
useform = nil
w = TextArea.new useform, config
w.width = :expand unless w.width
w.height ||= :expand _position(w)
w.height ||= 8 if block
w.bind(block_event, &block)
end
return w
end
|
#textview(config = {}, &block) ⇒ Object
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 150
def textview config={}, &block
events = [ :LEAVE, :ENTER ]
block_event = events[0]
useform = nil
w = TextView.new useform, config
w.width = :expand unless w.width
w.height ||= :expand _position(w)
if block
w.bind(block_event, &block)
end
return w
end
|
#tree(config = {}, &block) ⇒ Object
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 231
def tree config={}, &block
require 'rbcurse/core/widgets/rtree'
events = [:TREE_WILL_EXPAND_EVENT, :TREE_EXPANDED_EVENT, :TREE_SELECTION_EVENT, :PROPERTY_CHANGE, :LEAVE, :ENTER ]
block_event = nil
useform = nil
w = Tree.new useform, config, &block
w.width ||= :expand
w.height ||= :expand _position w
return w
end
|
#vimsplit(config = {}, &block) ⇒ Object
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 268
def vimsplit config={}, &block
require 'rbcurse/extras/widgets/rvimsplit'
events = [:PROPERTY_CHANGE, :LEAVE, :ENTER ]
block_event = nil
config[:height] ||= 10
useform = nil
w = VimSplit.new useform, config _position(w)
if block_given?
yield w
end
return w
end
|
48
49
50
51
52
53
54
|
# File 'lib/rbcurse/core/util/widgetshortcuts.rb', line 48
def widget_shortcuts_init
@_ws_app_row = @_ws_app_col = 0
@_ws_active = nil @_ws_components = []
@variables = {}
end
|