Class: RNDK::Viewer

Inherits:
Widget show all
Defined in:
lib/rndk/viewer.rb

Overview

Shows a list of lines with lots of fancy things. Generally used to view files, has Buttons, Label and Entry.

Example

viewer = RNDK::Viewer.new(screen, {
                            :x => RNDK::CENTER,
                            :y => RNDK::CENTER,
                            :title => "</77>Awesome Viewer",
                            :buttons => buttons,
                            :shadow => true
                          })

# To set the lines of Viewer we must use Viewer#set.
# No way to do it on the constructor :(
viewer.set :items => lines

Keybindings

Left Arrow:: Shifts the viewport one column left. Right Arrow:: Shifts the viewport one column left Up Arrow:: Scrolls the viewport one line up. Down Arrow:: Scrolls the viewport one line down. Prev Page:: Scroll one page backward. Ctrl-B:: Scroll one page backward. B:: Scroll one page backward. b:: Scroll one page backward. Next Page:: Scroll one page forward. Ctrl-F:: Scroll one page forward. Space:: Scroll one page forward. F:: Scroll one page forward. f:: Scroll one page forward. Home:: Shift the whole list to the far left. |:: Shift the whole list to the far left. End:: Shift the whole list to the far right. $:: Shift the whole list to the far right. 1:: Moves to the first line in the viewer. <:: Moves to the first line in the viewer. g:: Moves to the first line in the viewer.

:: Moves to the last line in the viewer. G:: Moves to the last line in the viewer. L:: Moves half the distance to the end of the viewer. l:: Moves half the distance to the top of the viewer. ?:: Searches up for a pattern. /:: Searches down for a pattern. n:: Repeats last search. N:: Repeats last search, reversed direction. ::: Jumps to a given line. i:: Displays file statistics. s:: Displays file statistics. Tab:: Switches buttons. Return:: Exit the widget and return the index of the selected button. Set exit_type to :NORMAL. Escape:: Exit the widget and return -1. Set exit_type to :ESCAPE_HIT. Ctrl-L:: Refreshes the screen.

TODO There's something wrong with this widget why wont it work with Traverse?

Constant Summary collapse

DOWN = 
0
UP = 
1

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 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?, #move, #refresh_data, #run_key_binding, #run_signal_binding, #save_data, #setBXattr, #setHZchar, #setLLchar, #setLRchar, #setULchar, #setURchar, #setVTchar, #set_box, #set_exit_type, #unbind_key, #valid?, #valid_type?

Constructor Details

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

TODO:

complete documentation

Note:

To set the data inside Viewer, you must call Viewer#set! No stuffin' things on the constructor.

Creates a new Viewer Widget.

Settings

  • x is the x position - can be an integer or RNDK::LEFT, RNDK::RIGHT, RNDK::CENTER.
  • y is the y position - can be an integer or RNDK::TOP, RNDK::BOTTOM, RNDK::CENTER.
  • width/height are integers - if either are 0, Widget will be created with full width/height of the screen. If it's a negative value, will create with full width/height minus the value.
  • title can be more than one line - just split them with \ns.
  • buttons is an Array of Strings with all buttons.


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
150
151
152
153
154
155
156
157
158
159
160
161
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
190
191
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
 
# File 'lib/rndk/viewer.rb', line 93

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

  # This is UGLY AS HELL
  # But I don't have time to clean this up right now
  # (lots of widgets, you know)  :(
  x                = 0
  y                = 0
  width            = 0
  height           = 0
  title            = "viewer"
  buttons          = []
  button_highlight = RNDK::Color[:reverse]
  box              = true
  shadow           = false

  config.each do |key, val|
    x                = val if key == :x
    y                = val if key == :y
    width            = val if key == :width
    height           = val if key == :height
    title            = val if key == :title
    buttons          = val if key == :buttons
    button_highlight = val if key == :button_highlight
    box              = val if key == :box
    shadow           = val if key == :shadow
  end

  parent_width  = Ncurses.getmaxx screen.window
  parent_height = Ncurses.getmaxy screen.window

  box_width  = width
  box_height = height

  button_width = 0
  button_adj = 0
  button_pos = 1

  self.set_box box

  box_width  = RNDK.set_widget_dimension(parent_width, width, 0)
  box_height = RNDK.set_widget_dimension(parent_height, height, 0)

  # 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 viewer window.
  @win= Ncurses.newwin(box_height, box_width, ypos, xpos)
  if @win.nil?
    self.destroy
    return nil
  end

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

  # Create the buttons.
  @button_count = buttons.size
  @button = []
  @button_len = []
  @button_pos = []

  if @button_count > 0
    (0...@button_count).each do |x|
      button_len = []
      @button << RNDK.char2Chtype(buttons[x], button_len, [])
      @button_len << button_len[0]
      button_width += @button_len[x] + 1
    end
    button_adj = (box_width - button_width) / (@button_count + 1)
    button_pos = 1 + button_adj
    (0...@button_count).each do |x|
      @button_pos << button_pos
      button_pos += button_adj + @button_len[x]
    end
  end

  # Set the rest of the variables.
  @screen = screen
  @parent = screen.window
  @shadow_win = nil
  @button_highlight = button_highlight
  @box_height = box_height
  @box_width = box_width - 2
  @view_size = height - 2
  @input_window = @win
  @shadow = shadow
  @current_button = 0
  @current_top = 0
  @length = 0
  @left_char = 0
  @max_left_char = 0
  @max_top_line = 0
  @characters = 0
  @items_size = -1
  @show_line_items = 1
  @exit_type = :EARLY_EXIT

  @search_pattern = []

  self.set_title title

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

  # Setup the key bindings.
  self.bind_key('b') { self.scroll_page_up   }
  self.bind_key('B') { self.scroll_page_up   }
  self.bind_key(' ') { self.scroll_page_down }
  self.bind_key('f') { self.scroll_page_down }
  self.bind_key('F') { self.scroll_page_down }
  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 function actually controls the viewer...



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
 
# File 'lib/rndk/viewer.rb', line 461

def activate(actions=[])
  self.draw

  if actions.nil? || actions.size == 0
    loop do
      input = self.getch

      # Inject the character into the widget.
      ret = self.inject input

      return ret if @exit_type != :EARLY_EXIT
    end
  else
    # Inject each character one at a time.
    actions.each do |action|
      ret = self.inject action

      return ret if @exit_type != :EARLY_EXIT
    end
  end

  # Set the exit type for the widget and return
  self.set_exit_type(0)
  return nil
end

#clean ⇒ Object

This removes all the lines inside the scrolling window.



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/rndk/viewer.rb', line 436

def clean
  # Clean up the memory used...
  (0...@items_size).each do |x|
    self.free_line(x)
  end

  # Reset some variables.
  @items_size = 0
  @max_left_char = 0
  @widest_line = 0
  @current_top = 0
  @max_top_line = 0

  # Redraw the window.
  self.draw
end

#create_items(items_size) ⇒ Object

The items_size may be negative, to assign no definite limit.



924
925
926
927
928
929
930
931
932
933
934
935
936
937
 
# File 'lib/rndk/viewer.rb', line 924

def create_items(items_size)
  status = false

  self.destroy_items

  if items_size >= 0
    status = true

    @items = []
    @items_pos = []
    @items_len = []
  end
  return status
end

#destroy ⇒ Object

This function destroys the viewer widget.



818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/rndk/viewer.rb', line 818

def destroy
  self.destroy_items
  self.clean_title

  # Clean up the windows.
  RNDK.window_delete @shadow_win
  RNDK.window_delete @win

  # Clean the key bindings.
  self.clean_bindings

  # Unregister this widget.
  @screen.unregister self
end

#destroy_items ⇒ Object 



811
812
813
814
815
 
# File 'lib/rndk/viewer.rb', line 811

def destroy_items
  @items = []
  @items_pos = []
  @items_len = []
end

#draw ⇒ Object

This function draws the viewer widget.



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'lib/rndk/viewer.rb', line 758

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

  # Box it if it was asked for.
  if @box
    Draw.drawObjBox(@win, self)
    Ncurses.wrefresh @win
  end

  # Draw the items in the viewer.
  self.draw_items
end

#draw_buttons ⇒ Object

This redraws the viewer buttons.



775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
 
# File 'lib/rndk/viewer.rb', line 775

def draw_buttons
  # No buttons, no drawing
  return if @button_count == 0

  # Redraw the buttons.
  (0...@button_count).each do |x|
    Draw.writeChtype(@win,
                     @button_pos[x],
                     @box_height - 2,
                     @button[x],
                     RNDK::HORIZONTAL,
                     0,
                     @button_len[x])
  end

  # Highlight the current button.
  (0...@button_len[@current_button]).each do |x|
    # Strip the character of any extra attributes.
    character = RNDK.char_of @button[@current_button][x]

    # Add the character into the window.
    Ncurses.mvwaddch(@win,
                     @box_height - 2,
                     @button_pos[@current_button] + x,
                     character.ord | @button_highlight)
  end

  # Refresh the window.
  Ncurses.wrefresh @win
end

#draw_items ⇒ Object

This draws the viewer items lines.



842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
 
# File 'lib/rndk/viewer.rb', line 842

def draw_items
  temp = ''
  line_adjust = false

  # Clear the window.
  Ncurses.werase(@win)

  self.draw_title @win

  # Draw in the current line at the top.
  if @show_line_items == true
    # Set up the items line and draw it.
    if @in_progress
      temp = 'processing...'
    elsif @items_size != 0
      temp = '%d/%d %2.0f%%' % [@current_top + 1, @items_size,
          ((1.0 * @current_top + 1) / (@items_size)) * 100]
    else
      temp = '%d/%d %2.0f%%' % [0, 0, 0.0]
    end

    # The items_adjust variable tells us if we have to shift down one line
    # because the person asked for the line X of Y line at the top of the
    # screen. We only want to set this to true if they asked for the items
    # line and there is no title or if the two items overlap.
    if @title_lines == '' || @title_pos[0] < temp.size + 2
      items_adjust = true
    end
    Draw.writeChar(@win,
                   1,
                   if items_adjust then @title_lines else 0 end + 1,
                   temp,
                   RNDK::HORIZONTAL,
                   0,
                   temp.size)
  end

  # Determine the last line to draw.
  last_line = [@items_size, @view_size].min
  last_line -= if items_adjust then 1 else 0 end

  # Redraw the items.
  (0...last_line).each do |x|
    if @current_top + x < @items_size
      screen_pos = @items_pos[@current_top + x] + 1 - @left_char

      Draw.writeChtype(@win,
                       if screen_pos >= 0 then screen_pos else 1 end,
                       x + @title_lines + if items_adjust then 1 else 0 end + 1,
                       @items[x + @current_top],
                       RNDK::HORIZONTAL,
                       if screen_pos >= 0
                       then 0
                       else @left_char - @items_pos[@current_top + x]
                       end,
                       @items_len[x + @current_top])
    end
  end

  # Box it if we have to.
  if @box
    Draw.drawObjBox(@win, self)
    Ncurses.wrefresh @win
  end

  # Draw the separation line.
  if @button_count > 0
    boxattr = @BXAttr

    (1..@box_width).each do |x|
      Ncurses.mvwaddch(@win, @box_height - 3, x, @HZChar | boxattr)
    end

    Ncurses.mvwaddch(@win, @box_height - 3, 0, Ncurses::ACS_LTEE | boxattr)
    Ncurses.mvwaddch(@win, @box_height - 3, Ncurses.getmaxx(@win) - 1, Ncurses::ACS_RTEE | boxattr)
  end

  # Draw the buttons. This will call refresh on the viewer win.
  self.draw_buttons
end

#erase ⇒ Object

This function erases the viewer widget from the screen.



834
835
836
837
838
839
 
# File 'lib/rndk/viewer.rb', line 834

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

#focus ⇒ Object 



1016
1017
1018
 
# File 'lib/rndk/viewer.rb', line 1016

def focus
  self.draw
end

#free_line(x) ⇒ Object 



307
308
309
 
# File 'lib/rndk/viewer.rb', line 307

def free_line(x)
  @items[x] = '' if x < @items_size
end

#get_and_store_pattern(screen) ⇒ Object

This searches the document looking for the given word.



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/rndk/viewer.rb', line 637

def get_and_store_pattern(screen)
  temp = ''

  # Check the direction.
  if @search_direction == Viewer::UP
    temp = '</5>Search Up  : <!5>'
  else
    temp = '</5>Search Down: <!5>'
  end

  # Pop up the entry field.
  get_pattern = RNDK::Entry.new(screen, {
                                  :x => RNDK::CENTER,
                                  :y => RNDK::CENTER,
                                  :title => '',
                                  :label => temp,
                                  :field_color => RNDK::Color[:white_blue] | RNDK::Color[:bold],
                                  :filler => '.'.ord | RNDK::Color[:white_blue] | RNDK::Color[:bold],
                                  :field_width => 10
                                })

  # Is there an old search pattern?
  if @search_pattern.size != 0
    get_pattern.set(@search_pattern, get_pattern.min, get_pattern.max,
        get_pattern.box)
  end

  # Activate this baby.
  items = get_pattern.activate([])

  # Save teh items.
  if items.size != 0
    @search_pattern = items
  end

  # Clean up.
  get_pattern.destroy
end

#get_highlight ⇒ Object 



421
422
423
 
# File 'lib/rndk/viewer.rb', line 421

def get_highlight
  @button_highlight
end

#get_items(size) ⇒ Object 



411
412
413
414
 
# File 'lib/rndk/viewer.rb', line 411

def get_items(size)
  size << @items_size
  @items
end

#get_items_line ⇒ Object 



431
432
433
 
# File 'lib/rndk/viewer.rb', line 431

def get_items_line
  @show_line_items
end

#get_title ⇒ Object 



268
269
270
 
# File 'lib/rndk/viewer.rb', line 268

def get_title
  @title
end

#inject(input) ⇒ 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
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/rndk/viewer.rb', line 487

def inject input

  refresh = false
  # Create the itemsrmation about the file stats.
  file_items = [
      '</5>      </U>File Statistics<!U>     <!5>',
      '</5>                          <!5>',
      '</5/R>Character Count:<!R> %-4d     <!5>' % @characters,
      '</5/R>Line Count     :<!R> %-4d     <!5>' % @items_size,
      '</5>                          <!5>',
      '<C></5>Press Any Key To Continue.<!5>'
  ]

  temp_items = ['<C></5>Press Any Key To Continue.<!5>']

  # Calls a pre-process block if exists.
  # They can interrup input.
  continue = run_signal_binding(:before_input, input)

  if continue

    # Reset the refresh flag.
    refresh = false

    if self.is_bound? input
      self.run_key_binding input
      #complete = true

    else
      case input
      when RNDK::KEY_TAB
        if @button_count > 1
          if @current_button == @button_count - 1
            @current_button = 0
          else
            @current_button += 1
          end

          # Redraw the buttons.
          self.draw_buttons
        end
      when RNDK::PREV
        if @button_count > 1
          if @current_button == 0
            @current_button = @button_count - 1
          else
            @current_button -= 1
          end

          # Redraw the buttons.
          self.draw_buttons
        end
      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 'g'.ord, '1'.ord, '<'.ord
        @current_top = 0
        refresh = true

      when 'G'.ord, '>'.ord
        @current_top = @max_top_line
        refresh = true

      when 'L'.ord
        x = (@items_size + @current_top) / 2
        if x < @max_top_line
          @current_top = x
          refresh = true
        else
          RNDK.beep
        end

      when 'l'.ord
        x = @current_top / 2
        if x >= 0
          @current_top = x
          refresh = true
        else
          RNDK.beep
        end

      when '?'.ord
        @search_direction = Viewer::UP
        self.get_and_store_pattern(@screen)
        if !self.search_for_word(@search_pattern, @search_direction)
          self.PatternNotFound(@search_pattern)
        end
        refresh = true

      when '/'.ord
        @search_direction = Viewer::DOWN
        self.get_and_store_pattern(@screen)
        if !self.search_for_word(@search_pattern, @search_direction)
          self.PatternNotFound(@search_pattern)
        end
        refresh = true

      when 'N'.ord, 'n'.ord
        if @search_pattern == ''
          temp_items[0] = '</5>There is no pattern in the buffer.<!5>'
          @screen.popup_label temp_items

        elsif !self.search_for_word(@search_pattern,
            if input == 'n'.ord
            then @search_direction
            else 1 - @search_direction
            end)
          self.PatternNotFound(@search_pattern)
        end
        refresh = true

      when ':'.ord
        @current_top = self.jump_to_line
        refresh = true
      when 'i'.ord, 's'.ord, 'S'.ord
        @screen.popup_label file_items
        refresh = true
      when RNDK::KEY_ESC
        self.set_exit_type(input)
        return -1
      when Ncurses::ERR
        self.set_exit_type(input)
        return -1
      when Ncurses::KEY_ENTER, RNDK::KEY_RETURN
        self.set_exit_type(input)
        return @current_button
      when RNDK::REFRESH
        self.draw
      else
        RNDK.beep
      end

      run_signal_binding(:after_input, input)
    end

    # Do we need to redraw the screen?
    self.draw_items if refresh
  end
  self.draw
end

#jump_to_line ⇒ Object

This allows us to 'jump' to a given line in the file.



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/rndk/viewer.rb', line 733

def jump_to_line
  newline = RNDK::Scale.new(@screen, {
                              :x => RNDK::CENTER,
                              :y => RNDK::CENTER,
                              :title => '<C>Jump To Line',
                              :label => '</5>Line :',
                              :field_color => RNDK::Color[:bold],
                              :field_width => @items_size.size + 1,
                              :start => @current_top + 1,
                              :high => @max_top_line + 1,
                              :fast_increment => 10,
                              :shador => true
                            })

  line = newline.activate
  newline.destroy
  line - 1
end

#PatternNotFound(pattern) ⇒ Object 



453
454
455
456
457
458
 
# File 'lib/rndk/viewer.rb', line 453

def PatternNotFound(pattern)
  temp_items = [
      "</U/5>Pattern '%s' not found.<!U!5>" % pattern,
  ]
  @screen.popup_label temp_items
end

#position ⇒ Object 



939
940
941
 
# File 'lib/rndk/viewer.rb', line 939

def position
  super(@win)
end

#scroll_begin ⇒ Object 



1006
1007
1008
1009
 
# File 'lib/rndk/viewer.rb', line 1006

def scroll_begin
  @left_char = 0
  refresh = true
end

#scroll_down ⇒ Object 



952
953
954
955
956
957
958
959
 
# File 'lib/rndk/viewer.rb', line 952

def scroll_down
  if @current_top < @max_top_line
    @current_top += 1
    refresh = true
  else
    RNDK.beep
  end
end

#scroll_end ⇒ Object 



1011
1012
1013
1014
 
# File 'lib/rndk/viewer.rb', line 1011

def scroll_end
  @left_char = @max_left_char
  refresh = true
end

#scroll_left ⇒ Object 



970
971
972
973
974
975
976
977
 
# File 'lib/rndk/viewer.rb', line 970

def scroll_left
  if @left_char > 0
    @left_char -= 1
    refresh = true
  else
    RNDK.beep
  end
end

#scroll_page_down ⇒ Object 



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/rndk/viewer.rb', line 993

def scroll_page_down
  if @current_top < @max_top_line
    if @current_top + @view_size < @max_top_line
      @current_top = @current_top + (@view_size - 1)
    else
      @current_top = @max_top_line
    end
    refresh = true
  else
    RNDK.beep
  end
end

#scroll_page_up ⇒ Object 



979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'lib/rndk/viewer.rb', line 979

def scroll_page_up
  if @current_top > 0
    if @current_top - (@view_size - 1) > 0
      @current_top = @current_top - (@view_size - 1)
    else
      @current_top = 0
    end
    refresh = true
  else
    RNDK.beep
  end

end

#scroll_right ⇒ Object 



961
962
963
964
965
966
967
968
 
# File 'lib/rndk/viewer.rb', line 961

def scroll_right
  if @left_char < @max_left_char
    @left_char += 1
    refresh = true
  else
    RNDK.beep
  end
end

#scroll_up ⇒ Object 



943
944
945
946
947
948
949
950
 
# File 'lib/rndk/viewer.rb', line 943

def scroll_up
  if @current_top > 0
    @current_top -= 1
    refresh = true
  else
    RNDK.beep
  end
end

#search_for_word(pattern, direction) ⇒ Object

This searches for a line containing the word and realigns the value on the screen.



678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/rndk/viewer.rb', line 678

def search_for_word(pattern, direction)
  found = false

  # If the pattern is empty then return.
  if pattern.size != 0
    if direction == Viewer::DOWN
      # Start looking from 'here' down.
      x = @current_top + 1
      while !found && x < @items_size
        pos = 0
        y = 0
        while y < @items[x].size
          plain_char = RNDK.char_of(@items[x][y])

          pos += 1
          if RNDK.char_of(pattern[pos-1]) != plain_char
            y -= (pos - 1)
            pos = 0
          elsif pos == pattern.size
            @current_top = [x, @max_top_line].min
            @left_char = if y < @box_width then 0 else @max_left_char end
            found = true
            break
          end
          y += 1
        end
        x += 1
      end
    else
      # Start looking from 'here' up.
      x = @current_top - 1
      while ! found && x >= 0
        y = 0
        pos = 0
        while y < @items[x].size
          plain_char = RNDK.char_of(@items[x][y])

          pos += 1
          if RNDK.char_of(pattern[pos-1]) != plain_char
            y -= (pos - 1)
            pos = 0
          elsif pos == pattern.size
            @current_top = x
            @left_char = if y < @box_width then 0 else @max_left_char end
            found = true
            break
          end
        end
      end
    end
  end
  found
end

#set(config) ⇒ Object

This function sets various attributes of the widget.



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
 
# File 'lib/rndk/viewer.rb', line 226

def set(config)
  items            = @items
  hide_control_chars = @hide_control_chars
  show_line_items   = @show_line_items
  title            = @title
  buttons          = @buttons
  button_highlight = @button_highlight
  box              = @box
  shadow           = @shadow

  config.each do |key, val|
    x                  = val if key == :x
    y                  = val if key == :y
    width              = val if key == :width
    height             = val if key == :height
    title              = val if key == :title
    items              = val if key == :items
    hide_control_chars = val if key == :hide_control_chars
    show_line_items    = val if key == :show_line_items
    buttons            = val if key == :buttons
    button_highlight   = val if key == :button_highlight
    box                = val if key == :box
    shadow             = val if key == :shadow
  end

  self.set_title(title)                  if title != @title
  self.set_highlight(button_highlight)   if button_highlight != @button_highlight
  self.set_items_line(show_line_items)   if show_line_items != @show_line_items
  self.set_box(box)                      if box != @box
  self.set_items(items, hide_control_chars) if items != @items
end

#set_bg_color(attrib) ⇒ Object

This sets the background attribute of the widget.



807
808
809
 
# File 'lib/rndk/viewer.rb', line 807

def set_bg_color(attrib)
  Ncurses.wbkgd(@win, attrib)
end

#set_highlight(button_highlight) ⇒ Object

This function sets the highlight type of the buttons.



417
418
419
 
# File 'lib/rndk/viewer.rb', line 417

def set_highlight(button_highlight)
  @button_highlight = button_highlight
end

#set_items(items, interpret) ⇒ Object

This function sets the contents of the viewer.



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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/rndk/viewer.rb', line 312

def set_items(items, interpret)
  current_line = 0
  viewer_size = items.size

  if items.size < 0
    items.size = items.size
  end

  # Compute the size of the resulting display
  viewer_size = items.size
  if items.size > 0 && interpret
    (0...items.size).each do |x|
      filename = ''
      if RNDK.checkForLink(items[x], filename) == 1
        file_contents = []
        file_len = RNDK.read_file(filename, file_contents)

        if file_len >= 0
          viewer_size += (file_len - 1)
        end
      end
    end
  end

  # Clean out the old viewer items. (if there is any)
  @in_progress = true
  self.clean
  self.create_items(viewer_size)

  # Keep some semi-permanent items
  @interpret = interpret

  # Copy the itemsrmation given.
  current_line = 0
  x = 0
  while x < items.size && current_line < viewer_size
    if items[x].size == 0
      @items[current_line] = ''
      @items_len[current_line] = 0
      @items_pos[current_line] = 0
      current_line += 1
    else
      # Check if we have a file link in this line.
      filename = []
      if RNDK.checkForLink(items[x], filename) == 1
        # We have a link, open the file.
        file_contents = []
        file_len = 0

        # Open the file and put it into the viewer
        file_len = RNDK.read_file(filename, file_contents)
        if file_len == -1
          fopen_fmt = if Ncurses.has_colors?
                      then '<C></16>Link Failed: Could not open the file %s'
                      else '<C></K>Link Failed: Could not open the file %s'
                      end
          temp = fopen_fmt % filename
          self.setup_line(true, temp, current_line)
          current_line += 1
        else
          # For each line read, copy it into the viewer.
          file_len = [file_len, viewer_size - current_line].min
          (0...file_len).each do |file_line|
            if current_line >= viewer_size
              break
            end
            self.setup_line(false, file_contents[file_line], current_line)
            @characters += @items_len[current_line]
            current_line += 1
          end
        end
      elsif current_line < viewer_size
        self.setup_line(@interpret, items[x], current_line)
        @characters += @items_len[current_line]
        current_line += 1
      end
    end
    x+= 1
  end

  # Determine how many characters we can shift to the right before
  # all the items have been viewer off the screen.
  if @widest_line > @box_width
    @max_left_char = (@widest_line - @box_width) + 1
  else
    @max_left_char = 0
  end

  # Set up the needed vars for the viewer items.
  @in_progress = false
  @items_size = viewer_size
  if @items_size <= @view_size
    @max_top_line = 0
  else
    @max_top_line = @items_size - 1
  end
  return @items_size
end

#set_items_line(show_line_items) ⇒ Object

This sets whether or not you wnat to set the viewer items line.



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

def set_items_line(show_line_items)
  @show_line_items = show_line_items
end

#set_title(title) ⇒ Object

This sets the title of the viewer. (A nil title is allowed. It just means that the viewer will not have a title when drawn.)



260
261
262
263
264
265
266
 
# File 'lib/rndk/viewer.rb', line 260

def set_title title
  super(title, -(@box_width + 1))
  @title_adj = @title_lines

  # Need to set @view_size
  @view_size = @box_height - (@title_lines + 1) - 2
end

#setup_line(interpret, items, x) ⇒ Object 



272
273
274
275
276
277
278
279
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
 
# File 'lib/rndk/viewer.rb', line 272

def setup_line(interpret, items, x)
  # Did they ask for attribute interpretation?
  if interpret
    items_len = []
    items_pos = []
    @items[x] = RNDK.char2Chtype(items, items_len, items_pos)
    @items_len[x] = items_len[0]
    @items_pos[x] = RNDK.justifyString(@box_width, @items_len[x], items_pos[0])
  else
    # We must convert tabs and other nonprinting characters. The curses
    # library normally does this, but we are bypassing it by writing
    # chtypes directly.
    t = ''
    len = 0
    (0...items.size).each do |y|
      if items[y] == "\t".ord
        begin
          t  << ' '
          len += 1
        end while (len & 7) != 0
      elsif RNDK.char_of(items[y].ord).match(/^[[:print:]]$/)
        t << RNDK.char_of(items[y].ord)
        len += 1
      else
        t << Ncurses.unctrl(items[y].ord)
        len += 1
      end
    end
    @items[x] = t
    @items_len[x] = t.size
    @items_pos[x] = 0
  end
  @widest_line = [@widest_line, @items_len[x]].max
end

#unfocus ⇒ Object 



1020
1021
1022
 
# File 'lib/rndk/viewer.rb', line 1020

def unfocus
  self.draw
end