Class: RubyCurses::TextView
- Includes:
- ListScrollable
- Defined in:
- lib/rbcurse/rtextview.rb
Overview
A viewable read only box. Can scroll. Intention is to be able to change content dynamically - the entire list. Use set_content to set content, or just update the list attrib TODO -
- goto line - DONE
Direct Known Subclasses
Constant Summary
Constants included from Io
Io::ERROR_COLOR_PAIR, Io::FOOTER_COLOR_PAIR, Io::LINEONE, Io::MAIN_WINDOW_COLOR_PAIR
Instance Attribute Summary collapse
-
#toprow ⇒ Object
readonly
the toprow in the view (offsets are 0).
-
#winrow ⇒ Object
readonly
attr_reader :prow # the row on which cursor/focus is.
Attributes included from ListScrollable
#find_offset, #find_offset1, #search_found_ix, #show_caret
Attributes inherited from Widget
#col_offset, #cols_panned, #config, #curpos, #ext_col_offset, #ext_row_offset, #form, #id, #parent_component, #row_offset, #rows_panned, #should_create_buffer, #state
Instance Method Summary collapse
-
#addcol(num) ⇒ Object
2010-01-23 22:41.
- #addrowcol(row, col) ⇒ Object
-
#check_curpos ⇒ Object
newly added to check curpos when moving up or down.
- #cursor_backward ⇒ Object
- #cursor_forward ⇒ Object
-
#disp_menu ⇒ Object
this is just a test of the simple “most” menu.
- #do_relative_row(num) {|| ... } ⇒ Object
-
#find_first_match(regex) ⇒ Object
returns row of first match of given regex (or nil if not found).
-
#get_content ⇒ Object
FOR scrollable ###.
- #get_window ⇒ Object
-
#getstr(prompt, maxlen = 10) ⇒ Object
this is just a test of prompting user for a string + as an alternative to the dialog.
- #getvalue ⇒ Object
-
#handle_key(ch) ⇒ Object
textview.
- #init_vars ⇒ Object
-
#initialize(form = nil, config = {}, &block) ⇒ TextView
constructor
A new instance of TextView.
-
#load_module(requirename, includename) ⇒ Object
dynamically load a module and execute init method.
-
#next_line ⇒ Object
gives offset of next line, does not move.
-
#paint ⇒ Object
NOTE: earlier print_border was called only once in constructor, but when + a window is resized, and destroyed, then this was never called again, so the + border would not be seen in splitpane unless the width coincided exactly with + what is calculated in divider_location.
-
#print_borders ⇒ Object
print a border Note that print_border clears the area too, so should be used sparingly.
- #print_foot ⇒ Object
- #print_title ⇒ Object
-
#repaint ⇒ Object
FOR scrollable ###.
- #row_count ⇒ Object
-
#rowcol ⇒ Object
returns the position where cursor was to be positioned by default It may no longer work like that.
-
#scrollatrow ⇒ Object
—- for listscrollable —- ##.
-
#set_content(list, wrap = :WRAP_NONE) ⇒ Object
send in a list e.g.
-
#set_form_col(col1 = @curpos) ⇒ Object
set cursor on correct column tview.
-
#top_row(*val) ⇒ Object
display this row on top.
- #wrap_text(txt, col = @maxlen) ⇒ Object
Methods included from ListScrollable
#OLDscrollable_handle_key, #OLDset_focus_on, #_find_next, #_find_prev, #ask_search, #bounds_check, #find_more, #find_next, #find_prev, #focussed_index, #forward_char, #forward_word, #goto_bottom, #goto_last_position, #goto_top, #install_keys, #next_match, #next_row, #previous_row, #scroll_backward, #scroll_forward, #scroll_left, #scroll_right, #selected_item, #set_focus_on, #set_form_row, #set_selection_for_char, #show_caret_func
Methods inherited from Widget
#OLDbind_key, #buffer_to_screen, #buffer_to_window, #create_buffer, #destroy, #destroy_buffer, #focus, #get_buffer, #get_color, #get_preferred_size, #getvalue_for_paint, #height, #height=, #hide, #is_double_buffered?, #modified?, #move, #on_enter, #on_leave, #override_graphic, #printstring, #process_key, #remove, #repaint_all, #repaint_required, #safe_create_buffer, #set_buffer_modified, #set_buffering, #set_form, #set_form_row, #set_modified, #setformrowcol, #setrowcol, #show, #text_variable, #unbind_key, #width, #width=
Methods included from Io
#askchoice, #askyesno, #askyesnocancel, #clear_error, #clear_this, #get_string, #newaskyesno, #old_print_header, #old_print_top_right, #print_action, #print_error, #print_footer_help, #print_header, #print_headers, #print_help, #print_help_page, #print_in_middle, #print_key_labels, #print_key_labels_row, #print_screen_labels, #print_status, #print_this, #print_top_right, #rbgetstr
Methods included from Utils
#_process_key, #bind_key, #clean_string!, #get_color, #keycode_tos, #repeatm
Methods included from ConfigSetup
#cget, #config_setup, #configure, #variable_set
Methods included from EventHandler
#bind, #fire_handler, #fire_property_change
Methods included from DSL
Constructor Details
#initialize(form = nil, config = {}, &block) ⇒ TextView
Returns a new instance of TextView.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/rbcurse/rtextview.rb', line 50 def initialize form = nil, config={}, &block @focusable = true @editable = false @row = 0 @col = 0 @show_focus = false # don't highlight row under focus @list = [] super # ideally this should have been 2 to take care of borders, but that would break # too much stuff ! @row_offset = @col_offset = 1 #@scrollatrow = @height-2 @content_rows = @list.length @win = @graphic install_keys init_vars end |
Instance Attribute Details
#toprow ⇒ Object (readonly)
the toprow in the view (offsets are 0)
43 44 45 |
# File 'lib/rbcurse/rtextview.rb', line 43 def toprow @toprow end |
#winrow ⇒ Object (readonly)
attr_reader :prow # the row on which cursor/focus is
45 46 47 |
# File 'lib/rbcurse/rtextview.rb', line 45 def winrow @winrow end |
Instance Method Details
#addcol(num) ⇒ Object
2010-01-23 22:41
347 348 349 350 351 352 353 354 355 |
# File 'lib/rbcurse/rtextview.rb', line 347 def addcol num #@repaint_required = true @repaint_footer_required = true # 2010-01-23 22:41 if @form @form.addcol num else @parent_component.form.addcol num end end |
#addrowcol(row, col) ⇒ Object
356 357 358 359 360 361 362 363 364 |
# File 'lib/rbcurse/rtextview.rb', line 356 def addrowcol row,col #@repaint_required = true @repaint_footer_required = true # 2010-01-23 22:41 if @form @form.addrowcol row, col else @parent_component.form.addrowcol num end end |
#check_curpos ⇒ Object
newly added to check curpos when moving up or down
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/rbcurse/rtextview.rb', line 292 def check_curpos @buffer = @list[@current_index] # if the cursor is ahead of data in this row then move it back if @pcol+@curpos > @buffer.length addcol((@pcol+@buffer.length-@curpos)+1) @curpos = @buffer.length maxlen = (@maxlen || @width-2) # even this row is gt maxlen, i.e., scrolled right if @curpos > maxlen @pcol = @curpos - maxlen @curpos = maxlen-1 else # this row is within maxlen, make scroll 0 @pcol=0 end set_form_col end end |
#cursor_backward ⇒ Object
365 366 367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/rbcurse/rtextview.rb', line 365 def cursor_backward repeatm { if @curpos > 0 @curpos -= 1 set_form_col #addcol -1 elsif @pcol > 0 @pcol -= 1 end } #@repaint_required = true @repaint_footer_required = true # 2010-01-23 22:41 end |
#cursor_forward ⇒ Object
333 334 335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/rbcurse/rtextview.rb', line 333 def cursor_forward maxlen = @maxlen || @width-2 repeatm { if @curpos < @width and @curpos < maxlen-1 # else it will do out of box @curpos += 1 addcol 1 else @pcol += 1 if @pcol <= @buffer.length end } set_form_col #@repaint_required = true @repaint_footer_required = true # 2010-01-23 22:41 end |
#disp_menu ⇒ Object
this is just a test of the simple “most” menu
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 |
# File 'lib/rbcurse/rtextview.rb', line 468 def = PromptMenu.new self .add( .create_mitem( 's', "Goto start ", "Going to start", Proc.new { goto_start} )) .add(.create_mitem( 'r', "scroll right", "I have scrolled ", :scroll_right )) .add(.create_mitem( 'l', "scroll left", "I have scrolled ", :scroll_left )) item = .create_mitem( 'm', "submenu", "submenu options" ) = PromptMenu.new( self, "Submenu Options") .add(.create_mitem( 's', "CASE sensitive", "Ignoring Case in search" )) .add(.create_mitem( 't', "goto last position", "moved to previous position", Proc.new { goto_last_position} )) item.action = .add(item) # how do i know what's available. the application or window should know where to place #menu.display @form.window, 23, 1, $datacolor #, menu .display @form.window, $error_message_row, $error_message_col, $datacolor #, menu end |
#do_relative_row(num) {|| ... } ⇒ Object
382 383 384 |
# File 'lib/rbcurse/rtextview.rb', line 382 def do_relative_row num yield @list[@current_index+num] end |
#find_first_match(regex) ⇒ Object
returns row of first match of given regex (or nil if not found)
135 136 137 138 139 140 |
# File 'lib/rbcurse/rtextview.rb', line 135 def find_first_match regex @list.each_with_index do |row, ix| return ix if !row.match(regex).nil? end return nil end |
#get_content ⇒ Object
FOR scrollable ###
172 173 174 |
# File 'lib/rbcurse/rtextview.rb', line 172 def get_content @list end |
#get_window ⇒ Object
175 176 177 |
# File 'lib/rbcurse/rtextview.rb', line 175 def get_window @graphic end |
#getstr(prompt, maxlen = 10) ⇒ Object
this is just a test of prompting user for a string + as an alternative to the dialog.
457 458 459 460 461 462 463 464 465 466 |
# File 'lib/rbcurse/rtextview.rb', line 457 def getstr prompt, maxlen=10 tabc = Proc.new {|str| Dir.glob(str +"*") } config={}; config[:tab_completion] = tabc config[:default] = "defaulT" $log.debug " inside getstr before call " ret, str = rbgetstr(@form.window, @row+@height-1, @col+1, prompt, maxlen, config) $log.debug " rbgetstr returned #{ret} , #{str} " return "" if ret != 0 return str end |
#getvalue ⇒ Object
192 193 194 |
# File 'lib/rbcurse/rtextview.rb', line 192 def getvalue @list end |
#handle_key(ch) ⇒ Object
textview
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 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/rbcurse/rtextview.rb', line 196 def handle_key ch @buffer = @list[@current_index] if @buffer.nil? and row_count == 0 @list << "\r" @buffer = @list[@current_index] end return if @buffer.nil? #$log.debug " before: curpos #{@curpos} blen: #{@buffer.length}" if @curpos > @buffer.length addcol((@buffer.length-@curpos)+1) @curpos = @buffer.length set_form_col end # We can improve later case ch when ?\C-n.getbyte(0), 32 scroll_forward when ?\C-p.getbyte(0) scroll_backward when ?\C-[.getbyte(0), ?t.getbyte(0) goto_start #start of buffer # cursor_start when ?\C-].getbyte(0), ?G.getbyte(0) goto_end # end / bottom cursor_end when KEY_UP, ?k.getbyte(0) #select_prev_row ret = up check_curpos when KEY_DOWN, ?j.getbyte(0) ret = down check_curpos when KEY_LEFT, ?h.getbyte(0) cursor_backward when KEY_RIGHT, ?l.getbyte(0) cursor_forward when KEY_BACKSPACE, 127, 330 cursor_backward when ?\C-a.getbyte(0) #, ?0.getbyte(0) # take care of data that exceeds maxlen by scrolling and placing cursor at start @repaint_required = true if @pcol > 0 # tried other things but did not work set_form_col 0 @pcol = 0 when ?\C-e.getbyte(0), ?$.getbyte(0) # take care of data that exceeds maxlen by scrolling and placing cursor at end # This use to actually pan the screen to actual end of line, but now somewhere # it only goes to end of visible screen, set_form probably does a sanity check blen = @buffer.rstrip.length set_form_col blen # search related when @KEY_ASK_FIND ask_search when @KEY_FIND_MORE find_more when ?0.getbyte(0)..?9.getbyte(0) # FIXME the assumption here was that if numbers are being entered then a 0 is a number # not a beg-of-line command. # However, after introducing universal_argument, we can enters numbers using C-u and then press another # C-u to stop. In that case a 0 should act as a command, even though multiplier has been set if ch == ?0.getbyte(0) and $multiplier == 0 # copy of C-a - start of line @repaint_required = true if @pcol > 0 # tried other things but did not work set_form_col 0 @pcol = 0 return 0 end # storing digits entered so we can multiply motion actions $multiplier *= 10 ; $multiplier += (ch-48) return 0 #when ?\C-u.getbyte(0) ## multiplier. Series is 4 16 64 #@multiplier = (@multiplier == 0 ? 4 : @multiplier *= 4) #return 0 when ?\M-l.getbyte(0) # just added 2010-03-05 not perfect scroll_right # scroll data horizontally when ?\M-h.getbyte(0) scroll_left when ?\C-c.getbyte(0) $multiplier = 0 return 0 else # check for bindings, these cannot override above keys since placed at end begin ret = process_key ch, self rescue => err $error_message = err @form.window. $log.error " TEXTVIEW ERROR #{err} " $log.debug(err.backtrace.join("\n")) end return :UNHANDLED if ret == :UNHANDLED end $multiplier = 0 # you must reset if you've handled a key. if unhandled, don't reset since parent could use set_form_row return 0 # added 2010-01-12 22:17 else down arrow was going into next field end |
#init_vars ⇒ Object
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/rbcurse/rtextview.rb', line 68 def init_vars @curpos = @pcol = @toprow = @current_index = 0 @repaint_all=true ## 2010-02-10 20:20 RFED16 taking care if no border requested @suppress_borders ||= false @row_offset = @col_offset = 0 if @suppress_borders == true # added 2010-02-11 15:11 RFED16 so we don't need a form. @win_left = 0 @win_top = 0 $error_message_row ||= 23 $error_message_col ||= 1 # currently i scroll right only if current line is longer than display width, i should use # longest line on screen. @longest_line = 0 # the longest line printed on this page, used to determine if scrolling shd work bind_key([?g,?g]){ goto_start } # mapping double keys like vim bind_key([?',?']){ goto_last_position } # vim , goto last row position (not column) bind_key(?/, :ask_search) bind_key(?n, :find_more) bind_key([?\C-x, ?>], :scroll_right) bind_key([?\C-x, ?<], :scroll_left) bind_key(?r) { getstr("Enter a word") } bind_key(?m, :disp_menu) end |
#load_module(requirename, includename) ⇒ Object
dynamically load a module and execute init method. Hopefully, we can get behavior like this such as vieditable or multibuffers
486 487 488 489 490 |
# File 'lib/rbcurse/rtextview.rb', line 486 def load_module requirename, includename require "rbcurse/#{requirename}" extend Object.const_get("#{includename}") send("#{requirename}_init") #if respond_to? "#{includename}_init" end |
#next_line ⇒ Object
gives offset of next line, does not move
379 380 381 |
# File 'lib/rbcurse/rtextview.rb', line 379 def next_line @list[@current_index+1] end |
#paint ⇒ Object
NOTE: earlier print_border was called only once in constructor, but when + a window is resized, and destroyed, then this was never called again, so the + border would not be seen in splitpane unless the width coincided exactly with + what is calculated in divider_location.
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 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 |
# File 'lib/rbcurse/rtextview.rb', line 390 def paint # not sure where to put this, once for all or repeat 2010-02-11 15:06 RFED16 my_win = nil if @form my_win = @form.window else my_win = @target_window end @graphic = my_win unless @graphic #$log.warn "neither form not target window given!!! TV paint 368" unless my_win #raise " #{@name} neither form, nor target window given TV paint " unless my_win #raise " #{@name} NO GRAPHIC set as yet TV paint " unless @graphic @win_left = my_win.left @win_top = my_win.top print_borders if (@suppress_borders == false && @repaint_all) # do this once only, unless everything changes rc = row_count maxlen = @maxlen || @width-2 $log.debug " #{@name} textview repaint width is #{@width}, height is #{@height} , maxlen #{maxlen}/ #{@maxlen}, #{@graphic.name} roff #{@row_offset} coff #{@col_offset}" tm = get_content tr = @toprow acolor = get_color $datacolor h = scrollatrow() r,c = rowcol @longest_line = @width #maxlen 0.upto(h) do |hh| crow = tr+hh if crow < rc #focussed = @current_index == crow ? true : false #selected = is_row_selected crow content = tm[crow].chomp content.gsub!(/\t/, ' ') # don't display tab content.gsub!(/[^[:print:]]/, '') # don't display non print characters if !content.nil? if content.length > maxlen # only show maxlen @longest_line = content.length if content.length > @longest_line content = content[@pcol..@pcol+maxlen-1] else content = content[@pcol..-1] end end @graphic.printstring r+hh, c, "%-*s" % [@width-2,content], acolor, @attr if @search_found_ix == tr+hh if !@find_offset.nil? # handle exceed bounds, and if scrolling if @find_offset1 < maxlen+@pcol and @find_offset > @pcol @graphic.mvchgat(y=r+hh, x=c+@find_offset-@pcol, @find_offset1-@find_offset, Ncurses::A_NORMAL, $reversecolor, nil) end end end else # clear rows @graphic.printstring r+hh, c, " " * (@width-2), acolor,@attr end end show_caret_func @table_changed = false @repaint_required = false @repaint_footer_required = true # 2010-01-23 22:41 @buffer_modified = true # required by form to call buffer_to_screen @repaint_all = false # added 2010-01-08 18:56 for redrawing everything # 2010-02-10 22:08 RFED16 end |
#print_borders ⇒ Object
print a border Note that print_border clears the area too, so should be used sparingly.
154 155 156 157 158 159 |
# File 'lib/rbcurse/rtextview.rb', line 154 def print_borders $log.debug " #{@name} print_borders, #{@graphic.name} " color = $datacolor @graphic.print_border @row, @col, @height-1, @width, color #, Ncurses::A_REVERSE print_title end |
#print_foot ⇒ Object
164 165 166 167 168 169 170 |
# File 'lib/rbcurse/rtextview.rb', line 164 def print_foot @footer_attrib ||= Ncurses::A_REVERSE = "R: #{@current_index+1}, C: #{@curpos+@pcol}, #{@list.length} lines " $log.debug " print_foot calling printstring with #{@row} + #{@height} -1, #{@col}+2" @graphic.printstring( @row + @height -1 , @col+2, , $datacolor, @footer_attrib) @repaint_footer_required = false # 2010-01-23 22:55 end |
#print_title ⇒ Object
160 161 162 163 |
# File 'lib/rbcurse/rtextview.rb', line 160 def print_title $log.debug " print_title #{@row}, #{@col}, #{@width} " @graphic.printstring( @row, @col+(@width-@title.length)/2, @title, $datacolor, @title_attrib) unless @title.nil? end |
#repaint ⇒ Object
FOR scrollable ###
179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/rbcurse/rtextview.rb', line 179 def repaint # textview if @screen_buffer.nil? safe_create_buffer @screen_buffer.name = "Pad::TV_PAD_#{@name}" unless @screen_buffer.nil? $log.debug " textview creates pad #{@screen_buffer} #{@name}" end #return unless @repaint_required # 2010-02-12 19:08 TRYING - won't let footer print for col move paint if @repaint_required # raise "TV 175 graphic nil " unless @graphic print_foot if @print_footer && @repaint_footer_required buffer_to_window end |
#row_count ⇒ Object
130 131 132 |
# File 'lib/rbcurse/rtextview.rb', line 130 def row_count @list.length end |
#rowcol ⇒ Object
returns the position where cursor was to be positioned by default It may no longer work like that.
143 144 145 |
# File 'lib/rbcurse/rtextview.rb', line 143 def rowcol return @row+@row_offset, @col+@col_offset end |
#scrollatrow ⇒ Object
—- for listscrollable —- ##
127 128 129 |
# File 'lib/rbcurse/rtextview.rb', line 127 def scrollatrow @height - 3 # trying out 2009-10-31 15:22 XXX since we seem to be printing one more line end |
#set_content(list, wrap = :WRAP_NONE) ⇒ Object
send in a list e.g. set_content File.open(“README.txt”,“r”).readlines set wrap at time of passing :WRAP_NONE :WRAP_WORD
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/rbcurse/rtextview.rb', line 96 def set_content list, wrap = :WRAP_NONE @wrap_policy = wrap if list.is_a? String if @wrap_policy == :WRAP_WORD data = wrap_text list @list = data.split("\n") else @list = list.split("\n") end elsif list.is_a? Array if @wrap_policy == :WRAP_WORD data = wrap_text list.join(" ") @list = data.split("\n") else @list = list end else raise "set_content expects Array not #{list.class}" end end |
#set_form_col(col1 = @curpos) ⇒ Object
set cursor on correct column tview
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
# File 'lib/rbcurse/rtextview.rb', line 312 def set_form_col col1=@curpos @cols_panned ||= 0 @pad_offset ||= 0 # added 2010-02-11 21:54 since padded widgets get an offset. @curpos = col1 maxlen = @maxlen || @width-2 #@curpos = maxlen if @curpos > maxlen if @curpos > maxlen @pcol = @curpos - maxlen @curpos = maxlen - 1 @repaint_required = true # this is required so C-e can pan screen else @pcol = 0 end # the rest only determines cursor placement win_col = 0 # 2010-02-07 23:19 new cursor stuff col2 = win_col + @col + @col_offset + @curpos + @cols_panned + @pad_offset $log.debug "TV SFC #{@name} setting c to #{col2} #{win_col} #{@col} #{@col_offset} #{@curpos} " #@form.setrowcol @form.row, col setrowcol nil, col2 @repaint_footer_required = true end |
#top_row(*val) ⇒ Object
display this row on top
117 118 119 120 121 122 123 124 125 |
# File 'lib/rbcurse/rtextview.rb', line 117 def top_row(*val) if val.empty? @toprow else @toprow = val[0] || 0 #@prow = val[0] || 0 end @repaint_required = true end |
#wrap_text(txt, col = @maxlen) ⇒ Object
146 147 148 149 150 151 |
# File 'lib/rbcurse/rtextview.rb', line 146 def wrap_text(txt, col = @maxlen) col ||= @width-2 $log.debug "inside wrap text for :#{txt}" txt.gsub(/(.{1,#{col}})( +|$\n?)|(.{1,#{col}})/, "\\1\\3\n") end |