class Canis::StatusLine

A vim-like application status bar that can display time and various other statuses

at the bottom, typically above the dock (3rd line from last), or else the last line.

Example

require 'canis/core/widgets/statusline'
@status_line = Canis::StatusLine.new @form, :row => Ncurses.LINES-2
@status_line.command {
   "F1 Help | F2 Menu | F3 View | F4 Shell | F5 Sh | %20s" % [message_label.text]
}

Changes

Earlier, the color of teh status line was REVERSED while printing which can be confusing 
and surprising. We should use normal, or use whatever attribute the user gives.
Also, using the row as -3 is assuming that a dock is used, which may not be the case,
so -1 should be used.

Public Class Methods

new(form, config={}) click to toggle source

attr_accessor :row_relative # lets only advertise this when we've tested it out

Calls superclass method Canis::Widget::new
# File lib/canis/core/widgets/statusline.rb, line 27
def initialize form, config={}, &block
  @row_relative = @@negative_offset
  if form.window.height == 0
    @row = Ncurses.LINES + @@negative_offset
  else
    @row = form.window.height + @@negative_offset
  end
   # in root windows FIXME
  @col = 0
  @name = "sl"
  super
  # if negativ row passed we store as relative to bottom, so we can maintain that.
  if @row < 0
    @row_relative = @row
    @row = Ncurses.LINES - @row
  else
    @row_relative = (Ncurses.LINES - @row) * -1
  end
  @focusable = false
  @editable  = false
  @command = nil
  @repaint_required = true
  bind(:PROPERTY_CHANGE) {  |e| @color_pair = nil ; }
end

Public Instance Methods

command(*args, &blk) click to toggle source

command that returns a string that populates the status line (left aligned) @see :right @see dbdemo.rb

Example

@l.command { "%-20s [DB: %-s | %-s ]" % [ Time.now, $current_db || "None", $current_table || "----"] }
# File lib/canis/core/widgets/statusline.rb, line 59
def command *args, &blk
  @command = blk
  @args = args
end
Also aliased as: left
handle_keys(ch) click to toggle source

not used since not focusable

# File lib/canis/core/widgets/statusline.rb, line 127
def handle_keys ch 
  return :UNHANDLED
end
left(*args, &blk)
Alias for: command
repaint() click to toggle source

NOTE: I have not put a check of repaint_required, so this will print on each key-stroke OR

rather whenever form.repaint is called.
# File lib/canis/core/widgets/statusline.rb, line 74
def repaint
  @color_pair ||= get_color($datacolor, @color, @bgcolor) 
  # earlier attrib defaulted to REVERSE which was surprising.
  _attr = @attr || Ncurses::A_NORMAL
  len = @form.window.getmaxx # width does not change upon resizing so useless, fix or do something
  len = Ncurses.COLS if len == 0 || len > Ncurses.COLS
  # this should only happen if there's a change in window
  if @row_relative
    @row = Ncurses.LINES+@row_relative
  end

  # first print dashes through
  @form.window.printstring @row, @col, "%s" % "-" * len, @color_pair, _attr

  # now call the block to get current values
  if @command
    ftext = @command.call(self, @args) 
  else
    status = $status_message ? $status_message.value : ""
    #ftext = " %-20s | %s" % [Time.now, status] # should we print a default value just in case user doesn't
    ftext = status # should we print a default value just in case user doesn't
  end
  # 2013-03-25 - 11:52 replaced $datacolor with @color_pair - how could this have been ?
  # what if user wants to change attrib ?
  if ftext =~ /#\[/
    # hopefully color_pair does not clash with formatting
    @form.window.printstring_formatted @row, @col, ftext, @color_pair, _attr
  else
    @form.window.printstring @row, @col, ftext, @color_pair, _attr
  end

  if @right_text
    ftext = @right_text.call(self, @right_args) 
    if ftext =~ /#\[/
      # hopefully color_pair does not clash with formatting
      @form.window.printstring_formatted_right @row, nil, ftext, @color_pair, _attr
    else
      c = len - ftext.length
      @form.window.printstring @row, c, ftext, @color_pair, _attr
    end
  else
    t = Time.now
    tt = t.strftime "%F %H:%M:%S"
    #r = Ncurses.LINES
    # somehow the bg defined here affects the bg in left text, if left does not define
    # a bg. The bgcolor defined of statusline is ignored in left or overriden by this
    #ftext = "#[fg=white,bg=blue] %-20s#[/end]" % [tt] # print a default
    @form.window.printstring_formatted_right @row, nil, tt, @color_pair, _attr
  end

  @repaint_required = false
end
right(*args, &blk) click to toggle source

Procedure for text to be right aligned in statusline

# File lib/canis/core/widgets/statusline.rb, line 67
def right *args, &blk
  @right_text = blk
  @right_args = args
end