Class: Glimmer::Tk::WidgetProxy

Inherits:
Object
  • Object
show all
Defined in:
lib/glimmer/tk/widget_proxy.rb,
lib/glimmer/tk/drag_and_drop_extension.rb

Overview

Proxy for Tk Widget objects

Follows the Proxy Design Pattern

Defined Under Namespace

Classes: DragAndDropEvent

Constant Summary collapse

FONTS_PREDEFINED = 
%w[default text fixed menu heading caption small_caption icon tooltip]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(underscored_widget_name, parent_proxy, args, &block) ⇒ WidgetProxy

Initializes a new Tk Widget

Styles is a comma separate list of symbols representing Tk styles in lower case



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 80

def initialize(underscored_widget_name, parent_proxy, args, &block)
  @parent_proxy = parent_proxy
  @args = args
  @keyword = underscored_widget_name
  @block = block
  build_widget
  # a common widget initializer
  @parent_proxy&.post_initialize_child(self)
  initialize_defaults
  post_add_content if @block.nil?
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object 



512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 512

def method_missing(method, *args, &block)
  method = method.to_s
  if args.empty? && block.nil? && ((widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][method]) || has_state?(method) || has_attributes_attribute?(method))
    get_attribute(method)
  elsif method.end_with?('=') && block.nil? && ((widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][method.sub(/=$/, '')]) || has_state?(method) || has_attributes_attribute?(method))
    set_attribute(method.sub(/=$/, ''), *args)
  else
    tk.send(method, *args, &block)
  end
rescue => e
  Glimmer::Config.logger.debug {"Neither WidgetProxy nor #{tk.class.name} can handle the method ##{method}"}
  super(method.to_sym, *args, &block)
end

Instance Attribute Details

#args ⇒ Object (readonly)

Returns the value of attribute args.



74
75
76
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 74

def args
  @args
end

#bind_ids ⇒ Object (readonly)

Returns the value of attribute bind_ids.



74
75
76
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 74

def bind_ids
  @bind_ids
end

#children ⇒ Object (readonly)

Returns the value of attribute children.



74
75
76
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 74

def children
  @children
end

#destroyed ⇒ Object (readonly) Also known as: destroyed?

Returns the value of attribute destroyed.



74
75
76
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 74

def destroyed
  @destroyed
end

#keyword ⇒ Object (readonly)

Returns the value of attribute keyword.



74
75
76
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 74

def keyword
  @keyword
end

#on_drag_motion_block ⇒ Object

Returns the value of attribute on_drag_motion_block.



27
28
29
 
# File 'lib/glimmer/tk/drag_and_drop_extension.rb', line 27

def on_drag_motion_block
  @on_drag_motion_block
end

#parent_proxy ⇒ Object (readonly)

Returns the value of attribute parent_proxy.



74
75
76
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 74

def parent_proxy
  @parent_proxy
end

#tk ⇒ Object (readonly)

Returns the value of attribute tk.



74
75
76
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 74

def tk
  @tk
end

Class Method Details

.create(keyword, parent, args, &block) ⇒ Object 



32
33
34
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 32

def create(keyword, parent, args, &block)
  widget_proxy_class(keyword).new(keyword, parent, args, &block)
end

.tk_widget_class_for(underscored_widget_name) ⇒ Object

This supports widgets in and out of basic Tk



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 48

def tk_widget_class_for(underscored_widget_name)
  tk_widget_class_basename = underscored_widget_name.camelcase(:upper)
  # TODO consider exposing this via Glimmer::Config
  potential_tk_widget_class_names = [
    "::Tk::Tile::#{tk_widget_class_basename}",
    "::Tk#{tk_widget_class_basename}",
    "::Tk::#{tk_widget_class_basename}",
    "::Tk::BWidget::#{tk_widget_class_basename}",
    "::Tk::Iwidgets::#{tk_widget_class_basename}",
    "::Glimmer::Tk::#{tk_widget_class_basename}Proxy",
  ]
  tk_widget_class = nil
  potential_tk_widget_class_names.each do |tk_widget_name|
    begin
      tk_widget_class = eval(tk_widget_name)
      break
    rescue RuntimeError, SyntaxError, NameError => e
      Glimmer::Config.logger.debug {e.full_message}
    end
  end
  tk_widget_class if tk_widget_class.respond_to?(:new)
end

.widget_exists?(underscored_widget_name) ⇒ Boolean

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 127

def self.widget_exists?(underscored_widget_name)
  !!tk_widget_class_for(underscored_widget_name) || (Glimmer::Tk.constants.include?("#{underscored_widget_name.camelcase(:upper)}Proxy".to_sym) && Glimmer::Tk.const_get("#{underscored_widget_name.camelcase(:upper)}Proxy".to_sym).respond_to?(:new))
end

.widget_proxy_class(keyword) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 36

def widget_proxy_class(keyword)
  begin
    class_name = "#{keyword.camelcase(:upper)}Proxy".to_sym
    Glimmer::Tk.const_get(class_name)
  rescue => e
    Glimmer::Config.logger.debug {"Unable to instantiate custom class name for #{keyword} ... defaulting to Glimmer::Tk::WidgetProxy"}
    Glimmer::Config.logger.debug {e.full_message}
    Glimmer::Tk::WidgetProxy
  end
end

Instance Method Details

#add_observer(observer, attribute) ⇒ Object 



454
455
456
457
458
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 454

def add_observer(observer, attribute)
  attribute_listener_installers = @tk.class.ancestors.map {|ancestor| widget_attribute_listener_installers[ancestor]}.compact
  widget_listener_installers = attribute_listener_installers.map{|installer| installer[attribute.to_s]}.compact if !attribute_listener_installers.empty?
  widget_listener_installers.to_a.first&.call(observer)
end

#ancestor_proxies ⇒ Object

returns list of ancestors ordered from direct parent to root parent



103
104
105
106
107
108
109
110
111
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 103

def ancestor_proxies
  ancestors = []
  current = self
  while current.parent_proxy
    ancestors << current.parent_proxy
    current = current.parent_proxy
  end
  ancestors
end

#apply_style(options) ⇒ Object 



299
300
301
302
303
304
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 299

def apply_style(options)
  @@style_number = 0 unless defined?(@@style_number)
  style = "style#{@@style_number += 1}.#{@tk.class.name.split('::').last}"
  ::Tk::Tile::Style.configure(style, options)
  @tk.style = style
end

#attribute_setter(attribute) ⇒ Object 



246
247
248
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 246

def attribute_setter(attribute)
  "#{attribute}="
end

#content(&block) ⇒ Object 



508
509
510
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 508

def content(&block)
  Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Tk::WidgetExpression.new, keyword, *args, &block)
end

#destroy ⇒ Object 



292
293
294
295
296
297
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 292

def destroy
  unbind_all
  @tk.destroy
  @on_destroy_procs&.each {|p| p.call(@tk)}
  @destroyed = true
end

#drag_source=(value) ⇒ Object 



29
30
31
32
33
34
35
36
 
# File 'lib/glimmer/tk/drag_and_drop_extension.rb', line 29

def drag_source=(value)
  @drag_source = value
  if @drag_source
    make_draggable
  else
    make_non_draggable
  end
end

#font=(value) ⇒ Object 



280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 280

def font=(value)
  if (value.is_a?(Symbol) || value.is_a?(String)) && FONTS_PREDEFINED.include?(value.to_s.downcase)
    @tk.font = "tk_#{value}_font".camelcase(:upper)
  else
    @tk.font = value.is_a?(TkFont) ? value : TkFont.new(value)
  end
rescue => e
  Glimmer::Config.logger.debug {"Failed to set attribute #{attribute} with args #{args.inspect}. Attempting to set through style instead..."}
  Glimmer::Config.logger.debug {e.full_message}
  apply_style({"font" => value})
end

#get_attribute(attribute) ⇒ Object 



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 227

def get_attribute(attribute)
  widget_custom_attribute = widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][attribute.to_s]
  if respond_to?(attribute, super_only: true)
    send(attribute)
  elsif widget_custom_attribute
    widget_custom_attribute[:getter][:invoker].call(@tk, args)
  elsif tk_widget_has_attribute_getter_setter?(attribute)
    @tk.send(attribute)
  elsif has_state?(attribute)
    @tk.tile_instate(attribute.sub(/\?$/, ''))
  elsif has_attributes_attribute?(attribute)
    result = @tk.attributes[attribute.sub(/\?$/, '')]
    result = result == 1 if result.is_a?(Integer)
    result
  else
    send(attribute)
  end
end

#grid(options = {}) ⇒ Object 



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 256

def grid(options = {})
  options = options.stringify_keys
  options['rowspan'] = options.delete('row_span') if options.keys.include?('row_span')
  options['columnspan'] = options.delete('column_span') if options.keys.include?('column_span')
  options['rowweight'] = options.delete('row_weight') if options.keys.include?('row_weight')
  options['columnweight'] = options.delete('column_weight') if options.keys.include?('column_weight')
  options['columnweight'] = options['rowweight'] = options.delete('weight')  if options.keys.include?('weight')
  options['rowminsize'] = options.delete('row_minsize') if options.keys.include?('row_minsize')
  options['rowminsize'] = options.delete('minheight') if options.keys.include?('minheight')
  options['rowminsize'] = options.delete('min_height') if options.keys.include?('min_height')
  options['columnminsize'] = options.delete('column_minsize') if options.keys.include?('column_minsize')
  options['columnminsize'] = options.delete('minwidth') if options.keys.include?('minwidth')
  options['columnminsize'] = options.delete('min_width') if options.keys.include?('min_width')
  options['columnminsize'] = options['rowminsize'] = options.delete('minsize')  if options.keys.include?('minsize')
  index_in_parent = griddable_parent_proxy&.children&.index(griddable_proxy)
  if index_in_parent
    TkGrid.rowconfigure(griddable_parent_proxy.tk, index_in_parent, 'weight'=> options.delete('rowweight')) if options.keys.include?('rowweight')
    TkGrid.rowconfigure(griddable_parent_proxy.tk, index_in_parent, 'minsize'=> options.delete('rowminsize')) if options.keys.include?('rowminsize')
    TkGrid.columnconfigure(griddable_parent_proxy.tk, index_in_parent, 'weight'=> options.delete('columnweight')) if options.keys.include?('columnweight')
    TkGrid.columnconfigure(griddable_parent_proxy.tk, index_in_parent, 'minsize'=> options.delete('columnminsize')) if options.keys.include?('columnminsize')
  end
  griddable_proxy&.tk&.grid(options)
end

#handle_listener(listener_name, &listener) ⇒ Object 



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 460

def handle_listener(listener_name, &listener)
  listener_name = listener_name.to_s
  # TODO return a listener registration object that has a deregister method
  if listener_name == 'destroy'
    # 'destroy' is a more reliable alternative listener binding to '<Destroy>'
    @on_destroy_procs ||= []
    listener.singleton_class.include(Glimmer::DataBinding::Tk::OneTimeObserver) unless listener.is_a?(Glimmer::DataBinding::Tk::OneTimeObserver)
    @on_destroy_procs << listener
    @tk.bind('<Destroy>', listener)
    parent_proxy.handle_listener(listener_name, &listener) if parent_proxy
  else
    @listeners ||= {}
    begin
      @listeners[listener_name] ||= []
      if @tk.respond_to?(listener_name)
        @tk.send(listener_name) { |*args| @listeners[listener_name].each {|l| l.call(*args)} } if @listeners[listener_name].empty?
      else
        @tk.bind(listener_name) { |*args| @listeners[listener_name].each {|l| l.call(*args)} } if @listeners[listener_name].empty?
      end
      @listeners[listener_name] << listener
    rescue => e
      @listeners.delete(listener_name)
      Glimmer::Config.logger.debug {"Unable to bind to #{listener_name} .. attempting to surround with <> ..."}
      Glimmer::Config.logger.debug {e.full_message}
      new_listener_name = listener_name
      new_listener_name = "<#{new_listener_name}" if !new_listener_name.start_with?('<')
      new_listener_name = "#{new_listener_name}>" if !new_listener_name.end_with?('>')
      @listeners[new_listener_name] ||= []
      @tk.bind(new_listener_name) { |*args| @listeners[new_listener_name].each {|l| l.call(*args)} } if @listeners[new_listener_name].empty?
      @listeners[new_listener_name] << listener
    end
  end
end

#has_attribute?(attribute, *args) ⇒ Boolean

Returns:

  • (Boolean) 


177
178
179
180
181
182
183
184
185
186
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 177

def has_attribute?(attribute, *args)
  (widget_custom_attribute_mapping[tk.class] and widget_custom_attribute_mapping[tk.class][attribute.to_s]) or
    tk_widget_has_attribute_setter?(attribute) or
    tk_widget_has_attribute_getter_setter?(attribute) or
    has_state?(attribute) or
    has_attributes_attribute?(attribute) or
    respond_to?(attribute_setter(attribute), args) or
    respond_to?(attribute_setter(attribute), *args, super_only: true) or
    respond_to?(attribute, *args, super_only: true)
end

#has_attributes_attribute?(attribute) ⇒ Boolean

Returns:

  • (Boolean) 


172
173
174
175
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 172

def has_attributes_attribute?(attribute)
  attribute = attribute.sub(/\?$/, '').sub(/=$/, '')
  @tk.respond_to?(:attributes) && @tk.attributes.keys.include?(attribute.to_s)
end

#has_state?(attribute) ⇒ Boolean

Returns:

  • (Boolean) 


157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 157

def has_state?(attribute)
  attribute = attribute.sub(/\?$/, '').sub(/=$/, '')
  if @tk.respond_to?(:tile_state)
    begin
      @tk.tile_instate(attribute)
      true
    rescue => e
      Glimmer::Config.logger.debug { "No tk state for #{attribute}" }
      false
    end
  else
    false
  end
end

#image_argument(args) ⇒ Object 



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 438

def image_argument(args)
  if args.first.is_a?(::TkPhotoImage)
    args.first
  else
    image_args = {}
    image_args.merge!(file: args.first.to_s) if args.first.is_a?(String)
    the_image = ::TkPhotoImage.new(image_args)
    if args.last.is_a?(Hash)
      processed_image = ::TkPhotoImage.new
      processed_image.copy(the_image, args.last)
      the_image = processed_image
    end
    the_image
  end
end

#inspect ⇒ Object

inspect is overridden to prevent printing very long stack traces



532
533
534
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 532

def inspect
  "#{super[0, 150]}... >"
end

#make_draggable ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
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
 
# File 'lib/glimmer/tk/drag_and_drop_extension.rb', line 59

def make_draggable
  drag_event = nil
  bind("<DropAcceptedEvent>", proc { |event| drag_event.drop_accepted = true })
  bind("B1-Motion", proc { |tk_event|
    if drag_event.nil?
      tooltip = WidgetProxy.new('toplevel', root_parent_proxy, [])
      tooltip.overrideredirect(1) #create tooltip window to display dragged data
      tooltip.geometry("+#{tk_event.x_root + 10}+#{tk_event.y_root - 2}")
      drag_event = DragAndDropEvent.new(self, nil, tooltip, tk_event.x_root, tk_event.y_root, nil, false)
      if @drag_source
        tk_event.widget.configure(:cursor => "hand2")
        # Default data to drag is text
        drag_event.data = if textvariable_defined? then tk.textvariable.value elsif has_attribute?(:text) then tk.text end
        tooltip_label = WidgetProxy.new('label', tooltip, [])
        tooltip_label.text = drag_event.data
        tooltip_label.pack # TODO look into using grid instead to be consistent with the modern Tk way
      elsif !@on_drag_start_block.nil?
        @on_drag_start_block.call(drag_event)
        if tooltip.winfo_children().length == 0
          tooltip_label = WidgetProxy.new('label', tooltip, [])
          tooltip_label.text = drag_event.data
          tooltip_label.pack # TODO look into using grid instead to be consistent with the modern Tk way
        end
      end
    else
      drag_event.x_root, drag_event.y_root = tk_event.x_root, tk_event.y_root
      drag_event.drop_accepted = false
      move_over_widget = tk_event.widget.winfo_containing(tk_event.x_root, tk_event.y_root)
      drag_event.target = move_over_widget.proxy
      move_over_widget.event_generate("<DropCheckEvent>", :data => drag_event.to_json)
      if @on_drag_motion_block.nil?
        # Default motion behavior:
        # 1.Change cursor to show whether text can be dropped.
        # 2.Move tooltip with dragged data.
        if drag_event.drop_accepted
          tk_event.widget.configure(:cursor => "hand1")
        else
          tk_event.widget.configure(:cursor => "hand2")
        end
        drag_event.tooltip.geometry("+#{tk_event.x_root + 10}+#{tk_event.y_root - 2}")
      else
        @on_drag_motion_block.call(drag_event)
      end
    end
  })
  bind("ButtonRelease-1", proc { |tk_event|
    if drag_event
      drag_event.target = tk_event.widget.winfo_containing(tk_event.x_root, tk_event.y_root).proxy
      drag_event.source.configure(:cursor => "")
      drag_event.target.event_generate("<DropEvent>", :data => drag_event.to_json)
      drag_event.tooltip.destroy
      drag_event = nil
    end
  })
end

#make_non_draggable ⇒ Object 



115
116
117
118
119
 
# File 'lib/glimmer/tk/drag_and_drop_extension.rb', line 115

def make_non_draggable
  @tk.bind_remove("B1-Motion")
  @tk.bind_remove("ButtonRelease-1")
  @tk.bind_remove("<DropAcceptedEvent>")
end

#on(listener_name, &listener) ⇒ Object 



494
495
496
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 494

def on(listener_name, &listener)
  handle_listener(listener_name, &listener)
end

#on_drag_start_block=(block) ⇒ Object 



38
39
40
41
 
# File 'lib/glimmer/tk/drag_and_drop_extension.rb', line 38

def on_drag_start_block=(block)
  @on_drag_start_block = block
  make_draggable
end

#on_drop_block=(value) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/glimmer/tk/drag_and_drop_extension.rb', line 43

def on_drop_block=(value)
  @on_drop_block = value
  self.tk.bind("<DropEvent>", proc { |tk_event|
    drop_event = DragAndDropEvent.json_create(JSON.parse("{" + tk_event.detail + "}"))
    @on_drop_block.call(drop_event) if self == drop_event.target
  })
  self.tk.bind("<DropCheckEvent>", proc { |tk_event|
    drop_check_event = DragAndDropEvent.json_create(JSON.parse("{" + tk_event.detail + "}"))
    drop_check_event.source.event_generate("<DropAcceptedEvent>")
  })
end

#post_add_content ⇒ Object

Subclasses may override to perform post add_content work



123
124
125
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 123

def post_add_content
  # No Op by default
end

#post_initialize_child(child) ⇒ Object

Subclasses may override to perform post initialization work on an added child



118
119
120
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 118

def post_initialize_child(child)
  children << child
end

#respond_to?(method, *args, super_only: false, &block) ⇒ Boolean

Returns:

  • (Boolean) 


526
527
528
529
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 526

def respond_to?(method, *args, super_only: false, &block)
  super(method, true) ||
    !super_only && tk.respond_to?(method, *args, &block)
end

#root_parent_proxy ⇒ Object 



92
93
94
95
96
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 92

def root_parent_proxy
  current = self
  current = current.parent_proxy while current.parent_proxy
  current
end

#set_attribute(attribute, *args) ⇒ Object 



188
189
190
191
192
193
194
195
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
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 188

def set_attribute(attribute, *args)
  begin
    widget_custom_attribute = widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][attribute.to_s]
    if respond_to?(attribute_setter(attribute), super_only: true)
      send(attribute_setter(attribute), *args)
    elsif respond_to?(attribute, super_only: true) && self.class.instance_method(attribute).parameters.size > 0
      send(attribute, *args)
    elsif widget_custom_attribute
      widget_custom_attribute[:setter][:invoker].call(@tk, args)
    elsif tk_widget_has_attribute_setter?(attribute)
      unless args.size == 1 && @tk.send(attribute) == args.first
        if args.size == 1
          @tk.send(attribute_setter(attribute), *args)
        else
          @tk.send(attribute_setter(attribute), args)
        end
      end
    elsif tk_widget_has_attribute_getter_setter?(attribute)
      @tk.send(attribute, *args)
    elsif has_state?(attribute)
      attribute = attribute.sub(/=$/, '')
      if !!args.first
        @tk.tile_state(attribute)
      else
        @tk.tile_state("!#{attribute}")
      end
    elsif has_attributes_attribute?(attribute)
      attribute = attribute.sub(/=$/, '')
      @tk.attributes(attribute, args.first)
    else
      raise "#{self} cannot handle attribute #{attribute} with args #{args.inspect}"
    end
  rescue => e
    Glimmer::Config.logger.error {"Failed to set attribute #{attribute} with args #{args.inspect}. Attempting to set through style instead..."}
    Glimmer::Config.logger.error {e.full_message}
    apply_style(attribute => args.first)
  end
end

#style=(styles) ⇒ Object 



250
251
252
253
254
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 250

def style=(styles)
  styles.each do |attribute, value|
    apply_style(attribute => value)
  end
end

#textvariable_defined? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/glimmer/tk/drag_and_drop_extension.rb', line 55

def textvariable_defined?
  tk_widget_has_attribute_setter?(:textvariable) && !tk.textvariable.nil?
end

#tk_widget_has_attribute_getter_setter?(attribute) ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
149
150
151
152
153
154
155
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 146

def tk_widget_has_attribute_getter_setter?(attribute)
  begin
    # TK Widget currently doesn't support respond_to? properly, so I have to resort to this trick for now
    @tk.send(attribute)
    true
  rescue => e
    Glimmer::Config.logger.debug { "No tk attribute getter setter for #{attribute}" }
    false
  end
end

#tk_widget_has_attribute_setter?(attribute) ⇒ Boolean

Returns:

  • (Boolean) 


131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 131

def tk_widget_has_attribute_setter?(attribute)
  return true if @tk.respond_to?(attribute) && attribute != 'focus' # TODO configure exceptions via constant if needed
  result = nil
  begin
    # TK Widget currently doesn't support respond_to? properly, so I have to resort to this trick for now
    @tk.send(attribute_setter(attribute), @tk.send(attribute))
    result = true
  rescue => e
    Glimmer::Config.logger.debug { "No tk attribute setter for #{attribute}" }
    Glimmer::Config.logger.debug { e.full_message }
    result = false
  end
  result
end

#toplevel_parent_proxy ⇒ Object 



98
99
100
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 98

def toplevel_parent_proxy
  ancestor_proxies.find {|widget_proxy| widget_proxy.is_a?(ToplevelProxy)}
end

#unbind_all ⇒ Object 



498
499
500
501
502
503
504
505
506
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 498

def unbind_all
  @listeners&.keys&.each do |key|
    if key.to_s.downcase.include?('command')
      @tk.send(key, '')
    else
      @tk.bind(key, '')
    end
  end
end

#widget_attribute_listener_installers ⇒ Object 



376
377
378
379
380
381
382
383
384
385
386
387
388
389
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
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 376

def widget_attribute_listener_installers
  # TODO consider extracting to modules/subclasses
  @tk_widget_attribute_listener_installers ||= {
    ::Tk::Tile::TCheckbutton => {
      'variable' => lambda do |observer|
        @tk.command {
          observer.call(@tk.variable.value.to_s == @tk.onvalue.to_s)
        }
      end,
    },
    ::Tk::Tile::TCombobox => {
      'text' => lambda do |observer|
        if observer.is_a?(Glimmer::DataBinding::ModelBinding)
          model = observer.model
          options_model_property = observer.property_name + '_options'
          # TODO perform data-binding to values too
          @tk.values = model.send(options_model_property) if model.respond_to?(options_model_property)
        end
        @tk.bind('<ComboboxSelected>') {
          observer.call(@tk.textvariable.value)
        }
      end,
    },
    ::Tk::Tile::TEntry => {
      'text' => lambda do |observer|
        @tk.textvariable.trace('write') {
          observer.call(@tk.textvariable.value)
        }
      end,
    },
    ::Tk::Tile::TSpinbox => {
      'text' => lambda do |observer|
        @tk.command {
          observer.call(@tk.textvariable&.value)
        }
        @tk.validate('key')
        @tk.validatecommand { |validate_args|
          observer.call(validate_args.value)
          new_icursor = validate_args.index
          new_icursor += validate_args.string.size if validate_args.action == 1
          @tk.icursor = new_icursor
          true
        }
      end,
    },
    ::Tk::Text => {
      'value' => lambda do |observer|
        handle_listener('modified') do
          observer.call(value)
        end
      end,
    },
    ::Tk::Tile::TRadiobutton => {
      'variable' => lambda do |observer|
        @tk.command {
          observer.call(@tk.variable.value == @tk.value)
        }
      end,
    },
  }
end

#widget_custom_attribute_mapping ⇒ Object 



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 306

def widget_custom_attribute_mapping
  # TODO consider extracting to modules/subclasses
  @widget_custom_attribute_mapping ||= {
    ::Tk::Tile::TButton => {
      'image' => {
        getter: {name: 'image', invoker: lambda { |widget, args| @tk.image }},
        setter: {name: 'image=', invoker: lambda { |widget, args| @tk.image = image_argument(args) }},
      },
    },
    ::Tk::Tile::TCheckbutton => {
      'image' => {
        getter: {name: 'image', invoker: lambda { |widget, args| @tk.image }},
        setter: {name: 'image=', invoker: lambda { |widget, args| @tk.image = image_argument(args) }},
      },
      'variable' => {
        getter: {name: 'variable', invoker: lambda { |widget, args| @tk.variable&.value.to_s == @tk.onvalue.to_s }},
        setter: {name: 'variable=', invoker: lambda { |widget, args| @tk.variable&.value = args.first.is_a?(Integer) ? args.first : (args.first ? 1 : 0) }},
      },
    },
    ::Tk::Tile::TRadiobutton => {
      'image' => {
        getter: {name: 'image', invoker: lambda { |widget, args| @tk.image }},
        setter: {name: 'image=', invoker: lambda { |widget, args| @tk.image = image_argument(args) }},
      },
      'text' => {
        getter: {name: 'text', invoker: lambda { |widget, args| @tk.text }},
        setter: {name: 'text=', invoker: lambda { |widget, args| @tk.value = @tk.text = args.first }},
      },
      'variable' => {
        getter: {name: 'variable', invoker: lambda { |widget, args| @tk.variable&.value == @tk.value }},
        setter: {name: 'variable=', invoker: lambda { |widget, args| @tk.variable&.value = args.first ? @tk.value : @tk.variable&.value }},
      },
    },
    ::Tk::Tile::TCombobox => {
      'text' => {
        getter: {name: 'text', invoker: lambda { |widget, args| @tk.textvariable&.value }},
        setter: {name: 'text=', invoker: lambda { |widget, args| @tk.textvariable&.value = args.first }},
      },
    },
    ::Tk::Tile::TLabel => {
      'text' => {
        getter: {name: 'text', invoker: lambda { |widget, args| @tk.textvariable&.value }},
        setter: {name: 'text=', invoker: lambda { |widget, args| @tk.textvariable&.value = args.first }},
      },
      'image' => {
        getter: {name: 'image', invoker: lambda { |widget, args| @tk.image }},
        setter: {name: 'image=', invoker: lambda { |widget, args| @tk.image = image_argument(args) }},
      },
    },
    ::Tk::Tile::TEntry => {
      'text' => {
        getter: {name: 'text', invoker: lambda { |widget, args| @tk.textvariable&.value }},
        setter: {name: 'text=', invoker: lambda { |widget, args| @tk.textvariable&.value = args.first }},
      },
    },
    ::Tk::Tile::TSpinbox => {
      'text' => {
        getter: {name: 'text', invoker: lambda { |widget, args| @tk.textvariable&.value }},
        setter: {name: 'text=', invoker: lambda { |widget, args| @tk.textvariable&.value = args.first }},
      },
    },
    ::Tk::Root => {
      'text' => {
        getter: {name: 'text', invoker: lambda { |widget, args| @tk.title }},
        setter: {name: 'text=', invoker: lambda { |widget, args| @tk.title = args.first }},
      },
    },
  }
end