Class: RubyCurses::Scrollbar

Inherits:
Widget show all
Defined in:
lib/rbcurse/core/widgets/scrollbar.rb

Overview

Since:

  • 1.2.0 UNTESTED

Instance Attribute Summary

Attributes inherited from Widget

#_object_created, #col_offset, #cols_panned, #config, #curpos, #focussed, #form, #id, #key_label, #parent_component, #row_offset, #rows_panned, #state

Instance Method Summary collapse

Methods inherited from Widget

#action_manager, #changed, #click, #color_pair, #command, #destroy, #enter, #event_list, #focus, #get_preferred_size, #getvalue, #getvalue_for_paint, #handle_key, #height, #height=, #hide, #init_vars, #leave, #modified?, #move, #on_enter, #on_leave, #override_graphic, #process_key, #remove, #repaint_all, #repaint_required, #rowcol, #set_buffer_modified, #set_buffering, #set_form, #set_form_col, #set_form_row, #set_modified, #setformrowcol, #setrowcol, #show, #text_variable, #unbind_key, #width, #width=

Methods included from Io

#__create_footer_window, #clear_this, #get_file, #print_this, #rb_getchar, #rb_gets, #rbgetstr, #warn

Methods included from Utils

#OLDdefine_key, #_process_key, #bind_key, #bind_keys, #clean_string!, #define_key, #define_prefix_command, #display_app_help, #get_attrib, #get_color, #keycode_tos, #last_line, #one_line_window, #parse_formatted_text, #print_key_bindings, #repeatm, #run_command, #shell_out, #shell_output, #suspend, #view, #wrap_text

Methods included from ConfigSetup

#cget, #config_setup, #configure, #variable_set

Methods included from EventHandler

#bind, #fire_handler, #fire_property_change

Constructor Details

#initialize(form, config = {}, &block) ⇒ Scrollbar

TODO: if parent passed, we shold bind to ON_ENTER and get current_index, so no extra work is required.

Since:

  • 1.2.0 UNTESTED



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
 
# File 'lib/rbcurse/core/widgets/scrollbar.rb', line 38

def initialize form, config={}, &block

  # setting default first or else Widget will place its BW default
  #@color, @bgcolor = ColorMap.get_colors_for_pair $bottomcolor
  super
  @color_pair = get_color $datacolor, @color, @bgcolor
  @scroll_pair = get_color $bottomcolor, :green, :white
  #$log.debug "SCROLLBAR COLOR cp #{@color_pair} sp #{@scroll_pair} " if $log.debug? 
  @window = form.window
  @editable = false
  @focusable = false
  @repaint_required = true
  @orientation = :V
  if @parent
    @parent.bind :ENTER_ROW do |p|
      # parent must implement row_count, and have a @current_index
      raise StandardError, "Parent must implement row_count" unless p.respond_to? :row_count
      self.current_index = p.current_index
      @repaint_required = true  #requred otherwise at end when same value sent, prop handler
      # will not be fired (due to optimization).
    end
    # in some cases, on leaving a listbox or other component redraws itself to reduce
    # selected or highlighted object, so the scrollbar gets overwritten. We need to repaint it.
    @parent.bind :LEAVE do |p|
      @repaint_required = true  
    end
  end
end

Instance Method Details

#repaint ⇒ Object

repaint the scrollbar Taking the data from parent as late as possible in case parent resized, or moved around by a container.

Raises:

  • (ArgumentError)

Since:

  • 1.2.0 UNTESTED



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
 
# File 'lib/rbcurse/core/widgets/scrollbar.rb', line 71

def repaint
  if @parent
    @row = @parent.row+1
    @col = @parent.col + @parent.width - 1
    @length = @parent.height - 2
    @list_length = @parent.row_count 
    @current_index ||= @parent.current_index
    @border_attrib ||= @parent.border_attrib
  end
  raise ArgumentError, "current_index must be provided" unless @current_index
  raise ArgumentError, "list_length must be provided" unless @list_length
  my_win = @form ? @form.window : @target_window
  @graphic = my_win unless @graphic
  return unless @repaint_required

  # first print a right side vertical line
  #bc = $bottomcolor  # dark blue
  bc = $datacolor
  bordercolor = @border_color || bc
  borderatt = @border_attrib || Ncurses::A_REVERSE
  #$log.debug "SCROLL bordercolor #{bordercolor} , #{borderatt} " if $log.debug? 


  @graphic.attron(Ncurses.COLOR_PAIR(bordercolor) | borderatt)
  #$log.debug " XXX SCROLL #{@row} #{@col} #{@length} "
  @graphic.mvvline(@row+0, @col, 1, @length-0)
  @graphic.attroff(Ncurses.COLOR_PAIR(bordercolor) | borderatt)

  # now calculate and paint the scrollbar
  pht = @length
  listlen = @list_length * 1.0
  @current_index = 0 if @current_index < 0
  @current_index = listlen-1 if @current_index >= listlen
  sclen = (pht/listlen)* @length
  sclen = 1 if sclen < 1 # sometimes 0.7 for large lists 100 items 2011-10-1 
  scloc = (@current_index/listlen)* @length
  scloc = (@length - sclen) if scloc > @length - sclen # don't exceed end
  if @current_index == @list_length - 1
    scloc = @length - sclen + 0 # earlier 1, but removed since sclen min 1 2011-10-1 
  end
  @graphic.attron(Ncurses.COLOR_PAIR(@scroll_pair) | borderatt)
  r = @row + scloc
  c = @col + 0
  #$log.debug " XXX SCROLLBAR #{r} #{c} #{sclen} "
  @graphic.mvvline(r, c, 1, sclen)
  @graphic.attroff(Ncurses.COLOR_PAIR(@scroll_pair) | borderatt)
  @repaint_required = false
end