Class: Canis::ItemEvent

Inherits:
Object show all
Defined in:
lib/canis/core/widgets/rwidget.rb

Overview

an event fired when an item that can be selected is toggled/selected

Since:

  • 1.2.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(item, item_selectable) ⇒ ItemEvent

i think only one is needed per object, so create once only

Since:

  • 1.2.0



3345
3346
3347
3348
# File 'lib/canis/core/widgets/rwidget.rb', line 3345

def initialize item, item_selectable
  @item, @item_selectable =
    item, item_selectable
end

Instance Attribute Details

#itemObject (readonly)

the item pressed such as toggle button

Since:

  • 1.2.0



3332
3333
3334
# File 'lib/canis/core/widgets/rwidget.rb', line 3332

def item
  @item
end

#item_firstObject (readonly)

if from a list

Since:

  • 1.2.0



3334
3335
3336
# File 'lib/canis/core/widgets/rwidget.rb', line 3334

def item_first
  @item_first
end

#item_lastObject (readonly)

Since:

  • 1.2.0



3335
3336
3337
# File 'lib/canis/core/widgets/rwidget.rb', line 3335

def item_last
  @item_last
end

#item_selectableObject (readonly)

item originating event such as list or collection

Since:

  • 1.2.0



3333
3334
3335
# File 'lib/canis/core/widgets/rwidget.rb', line 3333

def item_selectable
  @item_selectable
end

#param_stringObject (readonly)

for debugging etc

Since:

  • 1.2.0



3336
3337
3338
# File 'lib/canis/core/widgets/rwidget.rb', line 3336

def param_string
  @param_string
end

#stateObject (readonly)

Since:

  • 1.2.0



3331
3332
3333
# File 'lib/canis/core/widgets/rwidget.rb', line 3331

def state
  @state
end

Instance Method Details

#set(state, item_first = -1,, item_last = -1,, param_string = nil) ⇒ Object

Since:

  • 1.2.0



3349
3350
3351
3352
3353
# File 'lib/canis/core/widgets/rwidget.rb', line 3349

def set state, item_first=-1, item_last=-1, param_string=nil
  @state, @item_first, @item_last, @param_string =
    state, item_first, item_last, param_string 
  @param_string = "Item event fired: #{item}, #{state}" if param_string.nil?
end