class Canis::Widget

Basic widget class superclass. Anything embedded in a form should extend this, if it wants to be repainted or wants focus. Otherwise. form will be unaware of it.

Attributes

_object_created[RW]
col_offset[R]
config[R]
curpos[RW]
focussed[RW]

sometimes inside a container there's no way of knowing if an individual comp is in focus other than to explicitly set it and inquire . 2010-09-02 14:47 @since 1.1.5 NOTE state takes care of this and is set by form. boolean

form[RW]
handler[R]
id[RW]
key_label[R]

descriptions for each key set in _key_map

parent_component[RW]
row_offset[R]
state[RW]

Public Class Methods

new(aform, aconfig={}) { |self| ... } click to toggle source
# File lib/canis/core/widgets/rwidget.rb, line 1128
def initialize aform, aconfig={}, &block
  # I am trying to avoid passing the nil when you don't want to give a form.
  # I hope this does not create new issues 2011-11-20
  if aform.is_a? Hash
    # presumable there's nothing coming in in hash, or else we will have to merge
    aconfig = aform
    @form = nil
  else
    #raise "got a #{aform.class} "
    @form = aform
  end
  @row_offset ||= 0
  @col_offset ||= 0
  #@ext_row_offset = @ext_col_offset = 0 # 2010-02-07 20:18  # removed on 2011-09-29
  @state = :NORMAL

  @handler = nil # we can avoid firing if nil
  #@event_args = {} # 2014-04-22 - 18:47 declared in bind_key
  # These are standard events for most widgets which will be fired by
  # Form. In the case of CHANGED, form fires if it's editable property is set, so
  # it does not apply to all widgets.
  register_events( [:ENTER, :LEAVE, :CHANGED, :PROPERTY_CHANGE])

  config_setup aconfig # @config.each_pair { |k,v| variable_set(k,v) }
  #instance_eval &block if block_given?
  if block_given?
    if block.arity > 0
      yield self
    else
      self.instance_eval(&block)
    end
  end
  # 2010-09-20 13:12 moved down, so it does not create problems with other who want to set their
  # own default
  #@bgcolor ||=  "black" # 0
  #@color ||= "white" # $datacolor
  set_form(@form) if @form
end

Public Instance Methods

action_manager() click to toggle source

return an object of actionmanager class, creating if required Widgets and apps may add_action and show_menu using the same

# File lib/canis/core/widgets/rwidget.rb, line 1508
def action_manager
  require 'canis/core/include/actionmanager'
  @action_manager ||= ActionManager.new
end
bgcolor( *val ) click to toggle source

returns widgets bgcolor, or form's color. This ensures that all widgets use form's color

unless user has overriden the color.

This is to be used whenever a widget is rendering to check the color at this moment.

# File lib/canis/core/widgets/rwidget.rb, line 1211
def bgcolor( *val )
  if val.empty?
    return @bgcolor if @bgcolor
    return @form.bgcolor if @form
    return $def_bg_color
  else
    @color_pair = nil
    return property_set :bgcolor, val
  end
end
color( *val ) click to toggle source

returns widgets color, or if not set then app default Ideally would have returned form's color, but it seems that form does not have color any longer.

# File lib/canis/core/widgets/rwidget.rb, line 1198
def color( *val )
  if val.empty?
    return @color if @color
    return @form.color if @form
    return $def_fg_color
  else
    @color_pair = nil
    return property_set :color, val
  end
end
color_pair(*val) click to toggle source

2011-11-12 trying to make color setting a bit sane You may set as a color_pair using get_color which gives a fixnum or you may give 2 color symbols so i can update color, bgcolor and colorpair in one shot if one of them is nil, i just use the existing value

# File lib/canis/core/widgets/rwidget.rb, line 1472
def color_pair(*val)
  if val.empty?
    #return @color_pair
    return @color_pair || get_color($datacolor, color(), bgcolor())
  end

  oldvalue = @color_pair
  case val.size
  when 1
    raise ArgumentError, "Expecting fixnum for color_pair." unless val[0].is_a? Integer
    @color_pair = val[0]
    @color, @bgcolor = ColorMap.get_colors_for_pair @color_pair
  when 2
    @color = val.first if val.first
    @bgcolor = val.last if val.last
    @color_pair = get_color $datacolor, @color, @bgcolor
  end
  if oldvalue != @color_pair
    fire_property_change(:color_pair, oldvalue, @color_pair)
    @property_changed = true
    repaint_all true
  end
  self
end
command(*args, &block) click to toggle source

a general method for all widgets to override with their favorite or most meaninful event Ideally this is where the block in the constructor should land up. @since 1.5.0 2011-11-21

# File lib/canis/core/widgets/rwidget.rb, line 1499
def command *args, &block
  if event? :PRESS
    bind :PRESS, *args, &block
  else
    bind :CHANGED, *args, &block
  end
end
destroy() click to toggle source
# File lib/canis/core/widgets/rwidget.rb, line 1289
def destroy
  $log.debug "DESTROY : widget #{@name} "
  panel = @window.panel
  Ncurses::Panel.del_panel(panel.pointer) if !panel.nil?   
  @window.delwin if !@window.nil?
end
focus() click to toggle source

moves focus to this field we must look into running on_leave of previous field

# File lib/canis/core/widgets/rwidget.rb, line 1352
def focus
  return if !@focusable
  if @form.validate_field != -1
    @form.select_field @id
  end
end
focusable(*val) click to toggle source

set or unset focusable (boolean). Whether a widget can get keyboard focus.

# File lib/canis/core/widgets/rwidget.rb, line 1359
def focusable(*val)
  return @focusable if val.empty?
  oldv = @focusable
  @focusable = val[0]

  return self if oldv.nil? || @_object_created.nil?
  # once the form has been painted then any changes will trigger update of focusables.
  @form.update_focusables if @form
  # actually i should only set the forms focusable_modified flag rather than call this. FIXME
  self
end
focusable?() click to toggle source

is this widget accessible from keyboard or not.

# File lib/canis/core/widgets/rwidget.rb, line 1372
def focusable?
  @focusable
end
getvalue() click to toggle source

return the value of the widget. In cases where selection is possible, should return selected value/s

# File lib/canis/core/widgets/rwidget.rb, line 1262
def getvalue
  #@text_variable && @text_variable.value || @text
  @text
end
getvalue_for_paint() click to toggle source

Am making a separate method since often value for print differs from actual value

# File lib/canis/core/widgets/rwidget.rb, line 1268
def getvalue_for_paint
  getvalue
end
handle_key(ch) click to toggle source

to be added at end of handle_key of widgets so instlalled actions can be checked

# File lib/canis/core/widgets/rwidget.rb, line 1391
def handle_key(ch)
  ret = process_key ch, self
  return :UNHANDLED if ret == :UNHANDLED
  0
end
hide() click to toggle source
# File lib/canis/core/widgets/rwidget.rb, line 1335
def hide
  @visible = false
end
init_vars() click to toggle source
# File lib/canis/core/widgets/rwidget.rb, line 1166
def init_vars
  # just in case anyone does a super. Not putting anything here
  # since i don't want anyone accidentally overriding
end
modified(tf=true)
Alias for: set_modified
modified?() click to toggle source

modified

typically read will be overridden to check if value changed from what it was on enter. getter and setter for modified (added 2009-01-18 12:31 )

# File lib/canis/core/widgets/rwidget.rb, line 1227
def modified?
  @modified
end
move(row, col) click to toggle source

is this required can we remove

# File lib/canis/core/widgets/rwidget.rb, line 1345
def move row, col
  @row = row
  @col = col
end
on_enter() click to toggle source

got left out by mistake 2008-11-26 20:20

# File lib/canis/core/widgets/rwidget.rb, line 1237
def on_enter
  @state = :HIGHLIGHTED    # duplicating since often these are inside containers
  @focussed = true
  if @handler && @handler.has_key?(:ENTER)
    fire_handler :ENTER, self
  end
end
on_leave() click to toggle source

Called when user exits a widget

# File lib/canis/core/widgets/rwidget.rb, line 1245
def on_leave
  @state = :NORMAL    # duplicating since often these are inside containers
  @focussed = false
  if @handler && @handler.has_key?(:LEAVE)
    fire_handler :LEAVE, self
  end
end
override_graphic(gr) click to toggle source
When an enclosing component creates a pad (buffer) and the child component

+ should write onto the same pad, then the enclosing component should override + the default graphic of child. This applies mainly to editor components in + listboxes and tables.

@param graphic graphic object to use for writing contents
@see prepare_editor in rlistbox.
added 2010-01-05 15:25
# File lib/canis/core/widgets/rwidget.rb, line 1417
def override_graphic gr
  @graphic = gr
end
process_key(keycode, object) click to toggle source

e.g. process_key ch, self returns UNHANDLED if no block for it after form handles basic keys, it gives unhandled key to current field, if current field returns unhandled, then it checks this map.

# File lib/canis/core/widgets/rwidget.rb, line 1386
def process_key keycode, object
  return _process_key keycode, object, @graphic
end
property_set(sym, val) click to toggle source

this is supposed to be a duplicate of what dsl_property generates for cases when

we need to customise the get portion but not copy the set part. just call this.
# File lib/canis/core/widgets/rwidget.rb, line 1172
def property_set sym, val
  oldvalue = instance_variable_get "@#{sym}"
  tmp = val.size == 1 ? val[0] : val
  newvalue = tmp
  if oldvalue.nil? || @_object_created.nil?
    #@#{sym} = tmp
    instance_variable_set "@#{sym}", tmp
  end
  return(self) if oldvalue.nil? || @_object_created.nil?

  if oldvalue != newvalue
    # trying to reduce calls to fire, when object is being created
    begin
      @property_changed = true
      fire_property_change("#{sym}", oldvalue, newvalue) if !oldvalue.nil?
      #@#{sym} = tmp
      instance_variable_set "@#{sym}", tmp
      #@config["#{sym}"]=@#{sym}
    rescue PropertyVetoException
      $log.warn "PropertyVetoException for #{sym}:" + oldvalue.to_s + "->  "+ newvalue.to_s
    end
  end # if old
  self
end
remove() click to toggle source
# File lib/canis/core/widgets/rwidget.rb, line 1341
def remove
  @form.remove_widget(self)
end
repaint() click to toggle source

default repaint method. Called by form for all widgets.

widget does not have display_length.
# File lib/canis/core/widgets/rwidget.rb, line 1274
def repaint
    r,c = rowcol
    #@bgcolor ||= $def_bg_color # moved down 2011-11-5
    #@color   ||= $def_fg_color
    _bgcolor = bgcolor()
    _color = color()
    $log.debug("widget repaint : r:#{r} c:#{c} col:#{_color}" )
    value = getvalue_for_paint
    len = @width || value.length
    acolor = @color_pair || get_color($datacolor, _color, _bgcolor)
    @graphic.printstring r, c, "%-*s" % [len, value], acolor, attr()
    # next line should be in same color but only have @att so we can change att is nec
    #@form.window.mvchgat(y=r, x=c, max=len, Ncurses::A_NORMAL, @bgcolor, nil)
end
repaint_all(tf=true) click to toggle source
# File lib/canis/core/widgets/rwidget.rb, line 1404
def repaint_all(tf=true)
  @repaint_all = tf
  @repaint_required = tf
end
repaint_required(tf=true) click to toggle source

to give simple access to other components, (eg, parent) to tell a comp to either paint its data, or to paint all - borders, headers, footers due to a big change (ht/width)

# File lib/canis/core/widgets/rwidget.rb, line 1401
def repaint_required(tf=true)
  @repaint_required = tf
end
rowcol() click to toggle source

@return row and col of a widget where painting data actually starts row and col is where a widget starts. offsets usually take into account borders. the offsets typically are where the cursor should be positioned inside, upon on_enter.

# File lib/canis/core/widgets/rwidget.rb, line 1256
def rowcol
# $log.debug "widgte rowcol : #{@row+@row_offset}, #{@col+@col_offset}"
  return @row+@row_offset, @col+@col_offset
end
set_form(form) click to toggle source

in those cases where we create widget without a form, and later give it to some other program which sets the form. Dirty, we should perhaps create widgets without forms, and add explicitly.

# File lib/canis/core/widgets/rwidget.rb, line 1298
def set_form form
  raise "Form is nil in set_form" if form.nil?
  @form = form
  @id = form.add_widget(self) if !form.nil? and form.respond_to? :add_widget
  # 2009-10-29 15:04 use form.window, unless buffer created
  # should not use form.window so explicitly everywhere.
  # added 2009-12-27 20:05 BUFFERED in case child object needs a form.
  # We don;t wish to overwrite the graphic object
  if @graphic.nil?
    #$log.debug " setting graphic to form window for #{self.class}, #{form} "
    @graphic = form.window unless form.nil? # use screen for writing, not buffer
  end
  # execute those actions delayed due to absence of form -- used internally
  # mostly by buttons and labels to bind hotkey to form
  fire_handler(:FORM_ATTACHED, self) if event? :FORM_ATTACHED
end
set_form_col(col1=@curpos) click to toggle source

set cursor on correct column, widget Ideally, this should be overriden, as it is not likely to be correct. NOTE: this is okay for some widgets but NOT for containers that will call their own components SFR and SFC

# File lib/canis/core/widgets/rwidget.rb, line 1328
def set_form_col col1=@curpos
  @curpos = col1 || 0 # 2010-01-14 21:02
  #@form.col = @col + @col_offset + @curpos
  c = @col + @col_offset + @curpos
  #$log.warn " #{@name} empty set_form_col #{c}, curpos #{@curpos}  , #{@col} + #{@col_offset} #{@form} "
  setrowcol nil, c
end
set_form_row() click to toggle source

puts cursor on correct row.

# File lib/canis/core/widgets/rwidget.rb, line 1316
def set_form_row
#  @form.row = @row + 1 + @winrow
  #@form.row = @row + 1
  r, c = rowcol
  #$log.warn " empty set_form_row in widget #{self} r = #{r} , c = #{c}  "
  #raise "trying to set 0, maybe called repaint before container has set value" if row <= 0
  setrowcol row, nil
end
set_modified(tf=true) click to toggle source
# File lib/canis/core/widgets/rwidget.rb, line 1230
def set_modified tf=true
  @modified = tf
  @form.modified = true if tf
end
Also aliased as: modified
setformrowcol(r, c) click to toggle source
passing a cursor up and adding col and row offsets
Added 2010-01-13 13:27 I am checking this out.
I would rather pass the value down and store it than do this recursive call

+ for each cursor display @see Form#setrowcol

# File lib/canis/core/widgets/rwidget.rb, line 1426
def setformrowcol r, c
      @form.row = r unless r.nil?
      @form.col = c unless c.nil?
      # this is stupid, going through this route i was losing windows top and left
      # And this could get repeated if there are mult objects.
   if !@parent_component.nil? and @parent_component != self
      r+= @parent_component.form.window.top unless  r.nil?
      c+= @parent_component.form.window.left unless c.nil?
      $log.debug " (#{@name}) calling parents setformrowcol #{r}, #{c} pa: #{@parent_component.name} self: #{name}, #{self.class}, poff #{@parent_component.row_offset}, #{@parent_component.col_offset}, top:#{@form.window.left} left:#{@form.window.left} "
      @parent_component.setformrowcol r, c
   else
      # no more parents, now set form
      $log.debug " name NO MORE parents setting #{r}, #{c}    in #{@form} "
      @form.setrowcol r, c
   end
end
setrowcol(r, c) click to toggle source
widget: i am putting one extra level of indirection so i can switch here

between form#setrowcol and setformrowcol, since i am not convinced either are giving the accurate result. i am not sure what the issue is.

# File lib/canis/core/widgets/rwidget.rb, line 1445
def setrowcol r, c
    # 2010-02-07 21:32 is this where i should add ext_offsets
   #$log.debug " #{@name}  w.setrowcol #{r} + #{@ext_row_offset}, #{c} + #{@ext_col_offset}  "
   # commented off 2010-02-15 18:22
   #r += @ext_row_offset unless r.nil?
   #c += @ext_col_offset unless c.nil?
   if @form
     @form.setrowcol r, c
   #elsif @parent_component
   else
     raise "Parent component not defined for #{self}, #{self.class} " unless @parent_component
     @parent_component.setrowcol r, c
   end
   #setformrowcol r,c
end
show() click to toggle source
# File lib/canis/core/widgets/rwidget.rb, line 1338
def show
  @visible = true
end
unbind_key(keycode) click to toggle source

remove a binding that you don't want

# File lib/canis/core/widgets/rwidget.rb, line 1377
def unbind_key keycode
  @_key_args.delete keycode unless @_key_args.nil?
  @_key_map.delete keycode unless @_key_map.nil?
end