Class: RNDK::Radio

Inherits:
Scroller show all
Defined in:
lib/rndk/radio.rb

Instance Attribute Summary

Attributes inherited from Widget

#BXAttr, #HZChar, #LLChar, #LRChar, #ULChar, #URChar, #VTChar, #accepts_focus, #binding_list, #border_size, #box, #exit_type, #has_focus, #is_visible, #screen, #screen_index, #supported_signals, #widget_type

Instance Method Summary collapse

Methods inherited from Scroller

#get_current_item, #max_view_size, #scroll_begin, #scroll_down, #scroll_end, #scroll_left, #scroll_page_down, #scroll_page_up, #scroll_right, #scroll_up, #set_position, #set_view_size

Methods inherited from Widget

#Screen_XPOS, #Screen_YPOS, #after_processing, #before_processing, #bind_key, #bind_signal, #bindable_widget, #clean_bindings, #clean_title, #draw_title, #get_box, #getch, #is_bound?, #position, #refresh_data, #run_key_binding, #run_signal_binding, #save_data, #setBXattr, #setHZchar, #setLLchar, #setLRchar, #setULchar, #setURchar, #setVTchar, #set_box, #set_exit_type, #set_title, #unbind_key, #valid?, #valid_type?

Constructor Details

#initialize(screen, config = {}) ⇒ Radio

Returns a new instance of Radio.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/rndk/radio.rb', line 7

def initialize(screen, config={})
  super()
  @widget_type = :radio
  @supported_signals += [:before_input, :after_input]

  x           = 0
  y           = 0
  splace      = RNDK::RIGHT
  width       = 0
  height      = 0
  title       = "radio"
  items        = []
  choice_char = '#'.ord | RNDK::Color[:reverse]
  default    = 0
  highlight   = RNDK::Color[:reverse]
  box         = true
  shadow      = false

  config.each do |key, val|
    x           = val if key == :x
    y           = val if key == :y
    splace      = val if key == :splace
    width       = val if key == :width
    height      = val if key == :height
    title       = val if key == :title
    items       = val if key == :items
    choice_char = val if key == :choice_char
    default     = val if key == :default
    highlight   = val if key == :highlight
    box         = val if key == :box
    shadow      = val if key == :shadow
  end

  items_size = items.size
  parent_width = Ncurses.getmaxx(screen.window)
  parent_height = Ncurses.getmaxy(screen.window)
  box_width = width
  box_height = height
  widest_item = 0

  self.set_box box

  # If the height is a negative value, height will be ROWS-height,
  # otherwise the height will be the given height.
  box_height = RNDK.set_widget_dimension(parent_height, height, 0)

  # If the width is a negative value, the width will be COLS-width,
  # otherwise the width will be the given width.
  box_width = RNDK.set_widget_dimension(parent_width, width, 5)

  box_width = self.set_title(title, box_width)

  # Set the box height.
  if @title_lines > box_height
    box_height = @title_lines + [items_size, 8].min + 2 * @border_size
  end

  # Adjust the box width if there is a scroll bar.
  if splace == RNDK::LEFT || splace == RNDK::RIGHT
    box_width += 1
    @scrollbar = true
  else
    scrollbar = false
  end

  # Make sure we didn't extend beyond the dimensions of the window
  @box_width = [box_width, parent_width].min
  @box_height = [box_height, parent_height].min

  self.set_view_size(items_size)

  # Each item in the needs to be converted to chtype array
  widest_item = self.create_items(items, @box_width)
  if widest_item > 0
    self.updateViewWidth(widest_item)
  elsif items_size > 0
    self.destroy
    return nil
  end

  # Rejustify the x and y positions if we need to.
  xtmp = [x]
  ytmp = [y]
  RNDK.alignxy(screen.window, xtmp, ytmp, @box_width, @box_height)
  xpos = xtmp[0]
  ypos = ytmp[0]

  # Make the radio window
  @win = Ncurses.newwin(@box_height, @box_width, ypos, xpos)

  # Is the window nil?
  if @win.nil?
    self.destroy
    return nil
  end

  # Turn on the keypad.
  Ncurses.keypad(@win, true)

  # Create the scrollbar window.
  if splace == RNDK::RIGHT
    @scrollbar_win = Ncurses.subwin(@win, self.max_view_size, 1,
        self.Screen_YPOS(ypos), xpos + @box_width - @border_size - 1)
  elsif splace == RNDK::LEFT
    @scrollbar_win = Ncurses.subwin(@win, self.max_view_size, 1,
        self.Screen_YPOS(ypos), self.Screen_XPOS(xpos))
  else
    @scrollbar_win = nil
  end

  # Set the rest of the variables
  @screen = screen
  @parent = screen.window
  @scrollbar_placement = splace
  @widest_item = widest_item
  @left_char = 0
  @selected_item = 0
  @highlight = highlight
  @choice_char = choice_char.ord
  @left_box_char = '['.ord
  @right_box_char = ']'.ord
  @default = default
  @input_window = @win
  @accepts_focus = true
  @shadow = shadow

  self.set_current_item(0)

  # Do we need to create the shadow?
  if shadow
    @shadow_win = Ncurses.newwin(box_height, box_width + 1,
        ypos + 1, xpos + 1)
  end

  # Setup the key bindings
  self.bind_key('g') { self.scroll_begin }
  self.bind_key('1') { self.scroll_begin }
  self.bind_key('G') { self.scroll_end   }
  self.bind_key('<') { self.scroll_begin }
  self.bind_key('>') { self.scroll_end   }

  screen.register(@widget_type, self)
end

Instance Method Details

#activate(actions = []) ⇒ Object

This actually manages the radio widget.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/rndk/radio.rb', line 162

def activate(actions=[])
  # Draw the radio items.
  self.draw

  if actions.nil? || actions.size == 0
    while true
      self.fixCursorPosition
      input = self.getch

      # Inject the character into the widget.
      ret = self.inject(input)
      if @exit_type != :EARLY_EXIT
        return ret
      end
    end
  else
    actions.each do |action|
      ret = self.inject(action)
      if @exit_type != :EARLY_EXIT
        return ret
      end
    end
  end

  # Set the exit type and return
  self.set_exit_type(0)
  return -1
end

#AvailableWidth ⇒ Object

Determine how many characters we can shift to the right before all the items have been scrolled off the screen.



526
527
528
 
# File 'lib/rndk/radio.rb', line 526

def AvailableWidth
  @box_width - 2 * @border_size - 3
end

#create_items(items, box_width) ⇒ Object 



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/rndk/radio.rb', line 487

def create_items(items, box_width)
  status = false
  widest_item = 0

  if items.size >= 0
    new_items = []
    new_len = []
    new_pos = []

    # Each item in the needs to be converted to chtype array
    status = true
    box_width -= 2 + @border_size
    (0...items.size).each do |j|
      lentmp = []
      postmp = []
      new_items << RNDK.char2Chtype(items[j], lentmp, postmp)
      new_len << lentmp[0]
      new_pos << postmp[0]
      if new_items[j].nil? || new_items[j].size == 0
        status = false
        break
      end
      new_pos[j] = RNDK.justifyString(box_width, new_len[j], new_pos[j]) + 3
      widest_item = [widest_item, new_len[j]].max
    end
    if status
      self.destroyInfo
      @item = new_items
      @item_len = new_len
      @item_pos = new_pos
    end
  end
  @items_size = items.size

  return (if status then widest_item else 0 end)
end

#destroy ⇒ Object

This function destroys the radio widget.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/rndk/radio.rb', line 364

def destroy
  self.clean_title
  self.destroyInfo

  # Clean up the windows.
  RNDK.window_delete(@scrollbar_win)
  RNDK.window_delete(@shadow_win)
  RNDK.window_delete(@win)

  # Clean up the key bindings.
  self.clean_bindings

  # Unregister this widget.
  @screen.unregister self
end

#destroyInfo ⇒ Object 



359
360
361
 
# File 'lib/rndk/radio.rb', line 359

def destroyInfo
  @item = ''
end

#draw ⇒ Object

This function draws the radio widget.



269
270
271
272
273
274
275
276
277
 
# File 'lib/rndk/radio.rb', line 269

def draw
  # Do we need to draw in the shadow?
  Draw.drawShadow(@shadow_win) unless @shadow_win.nil?

  self.draw_title @win

  # Draw in the radio items.
  self.draw_items @box
end

#draw_items(box) ⇒ Object

This redraws the radio items.



280
281
282
283
284
285
286
287
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
 
# File 'lib/rndk/radio.rb', line 280

def draw_items(box)
  scrollbar_adj = if @scrollbar_placement == RNDK::LEFT then 1 else 0 end
  screen_pos = 0

  # Draw the items
  (0...@view_size).each do |j|
    k = j + @current_top
    if k < @items_size
      xpos = self.Screen_XPOS(0)
      ypos = self.Screen_YPOS(j)

      screen_pos = self.ScreenPOS(k, scrollbar_adj)

      # Draw the empty string.
      Draw.writeBlanks(@win, xpos, ypos, RNDK::HORIZONTAL, 0,
          @box_width - @border_size)

      # Draw the line.
      Draw.writeChtype(@win,
          if screen_pos >= 0 then screen_pos else 1 end,
          ypos, @item[k], RNDK::HORIZONTAL,
          if screen_pos >= 0 then 0 else 1 - screen_pos end,
          @item_len[k])

      # Draw the selected choice
      xpos += scrollbar_adj
      Ncurses.mvwaddch(@win, ypos, xpos, @left_box_char)
      Ncurses.mvwaddch(@win, ypos, xpos + 1,
          if k == @selected_item then @choice_char else ' '.ord end)
      Ncurses.mvwaddch(@win, ypos, xpos + 2, @right_box_char)
    end
  end

  # Highlight the current item
  if @has_focus
    k = @current_item
    if k < @items_size
      screen_pos = self.ScreenPOS(k, scrollbar_adj)
      ypos = self.Screen_YPOS(@current_high)

      Draw.writeChtypeAttrib(@win,
          if screen_pos >= 0 then screen_pos else 1 + scrollbar_adj end,
          ypos, @item[k], @highlight, RNDK::HORIZONTAL,
          if screen_pos >= 0 then 0 else 1 - screen_pos end,
          @item_len[k])
    end
  end

  if @scrollbar
    @toggle_pos = (@current_item * @step).floor
    @toggle_pos = [@toggle_pos, Ncurses.getmaxy(@scrollbar_win) - 1].min

    Ncurses.mvwvline(@scrollbar_win,
                     0,
                     0,
                     Ncurses::ACS_CKBOARD,
                     Ncurses.getmaxy(@scrollbar_win))

    Ncurses.mvwvline(@scrollbar_win,
                     @toggle_pos,
                     0,
                     ' '.ord | RNDK::Color[:reverse],
                     @toggle_size)
  end

  # Box it if needed.
  if box
    Draw.drawObjBox(@win, self)
  end

  self.fixCursorPosition
end

#erase ⇒ Object

This function erases the radio widget



381
382
383
384
385
386
 
# File 'lib/rndk/radio.rb', line 381

def erase
  if self.valid?
    RNDK.window_erase(@win)
    RNDK.window_erase(@shadow_win)
  end
end

#fixCursorPosition ⇒ Object

Put the cursor on the currently-selected item.



152
153
154
155
156
157
158
159
 
# File 'lib/rndk/radio.rb', line 152

def fixCursorPosition
  scrollbar_adj = if @scrollbar_placement == RNDK::LEFT then 1 else 0 end
  ypos = self.Screen_YPOS(@current_item - @current_top)
  xpos = self.Screen_XPOS(0) + scrollbar_adj

  Ncurses.wmove(@input_window, ypos, xpos)
  Ncurses.wrefresh @input_window
end

#focus ⇒ Object 



479
480
481
 
# File 'lib/rndk/radio.rb', line 479

def focus
  self.draw_items(@box)
end

#getChoiceCharacter ⇒ Object 



436
437
438
 
# File 'lib/rndk/radio.rb', line 436

def getChoiceCharacter
  return @choice_char
end

#getCurrentItem ⇒ Object 



466
467
468
 
# File 'lib/rndk/radio.rb', line 466

def getCurrentItem
  return @current_item
end

#getHighlight ⇒ Object 



427
428
429
 
# File 'lib/rndk/radio.rb', line 427

def getHighlight
  return @highlight
end

#getItems(items) ⇒ Object 



415
416
417
418
419
420
 
# File 'lib/rndk/radio.rb', line 415

def getItems(items)
  (0...@items_size).each do |j|
    items << RNDK.chtype2Char(@item[j])
  end
  return @items_size
end

#getLeftBrace ⇒ Object 



446
447
448
 
# File 'lib/rndk/radio.rb', line 446

def getLeftBrace
  return @left_box_char
end

#getRightBrace ⇒ Object 



456
457
458
 
# File 'lib/rndk/radio.rb', line 456

def getRightBrace
  return @right_box_char
end

#getSelectedItem ⇒ Object 



475
476
477
 
# File 'lib/rndk/radio.rb', line 475

def getSelectedItem
  return @selected_item
end

#inject(input) ⇒ Object

This injects a single character into the widget.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/rndk/radio.rb', line 192

def inject input
  pp_return = true
  ret = false
  complete = false

  # Set the exit type
  self.set_exit_type(0)

  # Draw the widget items
  self.draw_items(@box)

  # Check if there is a pre-process function to be called.
  keep_going = self.run_signal_binding(:before_input, input)

  if keep_going

    # Check for a predefined key binding.
    if self.is_bound? input
      self.run_key_binding input
      #complete = true
    else
      case input
      when Ncurses::KEY_UP    then self.scroll_up
      when Ncurses::KEY_DOWN  then self.scroll_down
      when Ncurses::KEY_RIGHT then self.scroll_right
      when Ncurses::KEY_LEFT  then self.scroll_left
      when Ncurses::KEY_HOME  then self.scroll_begin
      when Ncurses::KEY_END   then self.scroll_end
      when Ncurses::KEY_PPAGE, RNDK::BACKCHAR
        self.scroll_page_up
      when Ncurses::KEY_NPAGE, RNDK::FORCHAR
        self.scroll_page_down
      when '$'.ord
        @left_char = @max_left_char
      when '|'.ord
        @left_char = 0
      when ' '.ord
        @selected_item = @current_item
      when RNDK::KEY_ESC
        self.set_exit_type(input)
        ret = false
        complete = true
      when Ncurses::ERR
        self.set_exit_type(input)
        complete = true
      when RNDK::KEY_TAB, RNDK::KEY_RETURN, Ncurses::KEY_ENTER
        self.set_exit_type(input)
        ret = @selected_item
        complete = true
      when RNDK::REFRESH
        @screen.erase
        @screen.refresh
      end
    end

    # Should we call a post-process?
    self.run_signal_binding(:after_input) if not complete
  end

  if not complete
    self.draw_items(@box)
    self.set_exit_type(0)
  end

  self.fixCursorPosition
  @return_data = ret
  return ret
end

#move(x, y, relative, refresh_flag) ⇒ Object

This moves the radio field to the given location.



262
263
264
265
266
 
# File 'lib/rndk/radio.rb', line 262

def move(x, y, relative, refresh_flag)
  windows = [@win, @scrollbar_win, @shadow_win]
  self.move_specific(x, y, relative, refresh_flag,
      windows, subwidgets)
end

#ScreenPOS(n, scrollbar_adj) ⇒ Object 



541
542
543
 
# File 'lib/rndk/radio.rb', line 541

def ScreenPOS(n, scrollbar_adj)
  @item_pos[n] - @left_char + scrollbar_adj + @border_size
end

#set(highlight, choice_char, box) ⇒ Object

This sets various attributes of the radio items.



389
390
391
392
393
 
# File 'lib/rndk/radio.rb', line 389

def set(highlight, choice_char, box)
  self.set_highlight(highlight)
  self.setChoiceCHaracter(choice_char)
  self.set_box(box)
end

#set_bg_color(attrib) ⇒ Object

This sets the background attribute of the widget.



354
355
356
357
 
# File 'lib/rndk/radio.rb', line 354

def set_bg_color(attrib)
  Ncurses.wbkgd(@win, attrib)
  Ncurses.wbkgd(@scrollbar_win, attrib) unless @scrollbar_win.nil?
end

#set_current_item(item) ⇒ Object

This sets the current highlighted item of the widget



461
462
463
464
 
# File 'lib/rndk/radio.rb', line 461

def set_current_item(item)
  self.set_position(item)
  @selected_item = item
end

#set_highlight(highlight) ⇒ Object

This sets the highlight bar of the radio items.



423
424
425
 
# File 'lib/rndk/radio.rb', line 423

def set_highlight(highlight)
  @highlight = highlight
end

#set_items(items) ⇒ Object

This sets the radio items items.



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/rndk/radio.rb', line 396

def set_items(items)
  widest_item = self.create_items(items, @box_width)
  return if widest_item <= 0

  # Clean up the display.
  (0...@view_size).each do |j|
    Draw.writeBlanks(@win, self.Screen_XPOS(0), self.Screen_YPOS(j),
        RNDK::HORIZONTAL, 0, @box_width - @border_size)
  end

  self.set_view_size(items_size)

  self.set_current_item(0)
  @left_char = 0
  @selected_item = 0

  self.updateViewWidth(widest_item)
end

#setChoiceCharacter(character) ⇒ Object

This sets the character to use when selecting na item in the items.



432
433
434
 
# File 'lib/rndk/radio.rb', line 432

def setChoiceCharacter(character)
  @choice_char = character
end

#setLeftBrace(character) ⇒ Object

This sets the character to use to drw the left side of the choice box on the items



442
443
444
 
# File 'lib/rndk/radio.rb', line 442

def setLeftBrace(character)
  @left_box_char = character
end

#setRightBrace(character) ⇒ Object

This sets the character to use to draw the right side of the choice box on the items



452
453
454
 
# File 'lib/rndk/radio.rb', line 452

def setRightBrace(character)
  @right_box_char = character
end

#setSelectedItem(item) ⇒ Object

This sets the selected item of the widget



471
472
473
 
# File 'lib/rndk/radio.rb', line 471

def setSelectedItem(item)
  @selected_item = item
end

#unfocus ⇒ Object 



483
484
485
 
# File 'lib/rndk/radio.rb', line 483

def unfocus
  self.draw_items(@box)
end

#updateViewWidth(widest) ⇒ Object 



530
531
532
533
534
535
 
# File 'lib/rndk/radio.rb', line 530

def updateViewWidth(widest)
  @max_left_char = if @box_width > widest
                   then 0
                   else widest - self.AvailableWidth
                   end
end

#WidestItem ⇒ Object 



537
538
539
 
# File 'lib/rndk/radio.rb', line 537

def WidestItem
  @max_left_char + self.AvailableWidth
end