Class: Glimmer::Tk::WidgetProxy

Inherits:
Object
  • Object
show all
Includes:
DraggableAndDroppable
Defined in:
lib/glimmer/tk/widget_proxy.rb

Overview

Proxy for Tk Widget objects

Follows the Proxy Design Pattern

Constant Summary collapse

FONTS_PREDEFINED = 
%w[default text fixed menu heading caption small_caption icon tooltip]
HEXADECIMAL_CHARACTERS = 
%w[0 1 2 3 4 5 6 7 8 9 a b c d e f]

Instance Attribute Summary collapse

Attributes included from DraggableAndDroppable

#on_drag_motion_block

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DraggableAndDroppable

#drag_source=, #drop_target=, #make_draggable, #make_droppable, #make_non_draggable, #make_non_droppable, #on_drag_start_block=, #on_drop_block=, #textvariable_defined?

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



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 85

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 



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 649

def method_missing(method, *args, &block)
  method = method.to_s
  attribute_name = method.sub(/=$/, '')
  args = normalize_attribute_arguments(attribute_name, args)
  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(attribute_name, *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.



79
80
81
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 79

def args
  @args
end

#bind_ids ⇒ Object (readonly)

Returns the value of attribute bind_ids.



79
80
81
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 79

def bind_ids
  @bind_ids
end

#children ⇒ Object (readonly)

Returns the value of attribute children.



79
80
81
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 79

def children
  @children
end

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

Returns the value of attribute destroyed.



79
80
81
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 79

def destroyed
  @destroyed
end

#keyword ⇒ Object (readonly)

Returns the value of attribute keyword.



79
80
81
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 79

def keyword
  @keyword
end

#parent_proxy ⇒ Object (readonly)

Returns the value of attribute parent_proxy.



79
80
81
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 79

def parent_proxy
  @parent_proxy
end

#tk ⇒ Object (readonly)

Returns the value of attribute tk.



79
80
81
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 79

def tk
  @tk
end

Class Method Details

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



34
35
36
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 34

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



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

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) 


133
134
135
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 133

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 



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

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 



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

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



109
110
111
112
113
114
115
116
117
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 109

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 



318
319
320
321
322
323
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 318

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_argument_normalizers ⇒ Object 



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 329

def attribute_argument_normalizers
  color_normalizer = lambda do |args|
    if args.size > 1 || args.first.is_a?(Numeric)
      rgb = args
      rgb = rgb.map(&:to_s).map(&:to_i)
      rgb = 3.times.map { |n| rgb[n] || 0}
      hex = rgb.map { |color| color.to_s(16).ljust(2, '0') }.join
      ["##{hex}"]
    elsif args.size == 1 &&
          args.first.is_a?(String) &&
          !args.first.start_with?('#') &&
          (args.first.size == 3 || args.first.size == 6)  &&
          (args.first.chars.all? {|char| HEXADECIMAL_CHARACTERS.include?(char.downcase)})
      ["##{args.first}"]
    else
      args
    end
  end
  @attribute_argument_normalizers ||= {
    'background' => color_normalizer,
    'foreground' => color_normalizer,
  }
end

#attribute_setter(attribute) ⇒ Object 



255
256
257
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 255

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

#clear_children ⇒ Object 



591
592
593
594
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 591

def clear_children
  children.each(&:destroy)
  @children = []
end

#content(&block) ⇒ Object 



596
597
598
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 596

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

#destroy ⇒ Object 



310
311
312
313
314
315
316
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 310

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

#disabled ⇒ Object Also known as: disabled? 



640
641
642
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 640

def disabled
  !enabled
end

#disabled=(value) ⇒ Object 



645
646
647
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 645

def disabled=(value)
  self.enabled = !value
end

#enabled ⇒ Object Also known as: enabled? 



631
632
633
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 631

def enabled
  tk.state == 'normal'
end

#enabled=(value) ⇒ Object 



636
637
638
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 636

def enabled=(value)
  tk.state = !!value ? 'normal' : 'disabled'
end

#event_generate(event_name, data = nil) ⇒ Object 



575
576
577
578
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 575

def event_generate(event_name, data = nil)
  data = YAML.dump(data) if data && !data.is_a?(String)
  tk.event_generate("<#{event_name}>", data: data)
end

#font=(value) ⇒ Object 



298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 298

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 



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 236

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 



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 269

def grid(options = {})
  @_visible = true
  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')
  options['rowuniform'] = options.delete('row_uniform') || options.delete('rowuniform')
  options['columnuniform'] = options.delete('column_uniform') || options.delete('columnuniform')
  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.rowconfigure(griddable_parent_proxy.tk, index_in_parent, 'uniform'=> options.delete('rowuniform')) if options.keys.include?('rowuniform')
    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')
    TkGrid.columnconfigure(griddable_parent_proxy.tk, index_in_parent, 'uniform'=> options.delete('columnuniform')) if options.keys.include?('columnuniform')
  end
  griddable_proxy&.tk&.grid(options)
end

#handle_listener(listener_name, &listener) ⇒ Object 



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 537

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) 


185
186
187
188
189
190
191
192
193
194
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 185

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) 


179
180
181
182
183
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 179

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

#has_state?(attribute) ⇒ Boolean

Returns:

  • (Boolean) 


163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 163

def has_state?(attribute)
  attribute = attribute.to_s
  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

#hidden ⇒ Object Also known as: hidden? 



622
623
624
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 622

def hidden
  !visible
end

#hidden=(value) ⇒ Object 



627
628
629
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 627

def hidden=(value)
  self.visible = !value
end

#image_argument(args) ⇒ Object 



515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 515

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



671
672
673
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 671

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

#normalize_attribute_arguments(attribute, args) ⇒ Object 



325
326
327
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 325

def normalize_attribute_arguments(attribute, args)
  attribute_argument_normalizers[attribute]&.call(args) || args
end

#on(listener_name, &listener) ⇒ Object 



571
572
573
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 571

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

#post_add_content ⇒ Object

Subclasses may override to perform post add_content work



129
130
131
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 129

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



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

def post_initialize_child(child)
  children << child
end

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

Returns:

  • (Boolean) 


665
666
667
668
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 665

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 



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

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

#set_attribute(attribute, *args) ⇒ Object 



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
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 196

def set_attribute(attribute, *args)
  begin
    args = normalize_attribute_arguments(attribute, args)
    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=(style_or_styles) ⇒ Object 



259
260
261
262
263
264
265
266
267
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 259

def style=(style_or_styles)
  if style_or_styles.is_a? String
    @tk.style(style_or_styles)
  else
    style_or_styles.each do |attribute, value|
      apply_style(attribute => value)
    end
  end
end

#tk_widget_has_attribute_getter_setter?(attribute) ⇒ Boolean

Returns:

  • (Boolean) 


152
153
154
155
156
157
158
159
160
161
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 152

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) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 137

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 Also known as: closest_window 



103
104
105
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 103

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

#unbind_all ⇒ Object 



580
581
582
583
584
585
586
587
588
589
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 580

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

#visible ⇒ Object Also known as: visible? 



604
605
606
607
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 604

def visible
  @visible = true if @visible.nil?
  @visible
end

#visible=(value) ⇒ Object 



610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 610

def visible=(value)
  value = !!value
  return if visible == value

  if value
    grid
  else
    tk.grid_remove
  end
  @visible = value
end

#widget_attribute_listener_installers ⇒ Object 



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
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
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 433

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'
          if model.respond_to?(options_model_property)
            options_observer = Glimmer::DataBinding::Observer.proc do
              @tk.values = model.send(options_model_property)
            end
            options_observer.observe(model, options_model_property)
            options_observer.call
          end
        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::Tile::TScale => {
      'variable' => lambda do |observer|
        @tk.command {
          observer.call(@tk.variable&.value)
        }
      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 is called only when the radiobutton is clicked/selected
        # it isn't called when other radiobutton in the group is clicked/selected == this radiobutton is deselected
        # so, we need to call the observers of the deselected radiobuttons in order for their variables to be reset to false
        @tk.command {
          if @tk.variable.value == @tk.value
            sibling_radio_buttons.each do |sibling_radio_button|
              sibling_radio_button.tk.command.call
            end
          end
          observer.call(@tk.variable.value == @tk.value)
        }
      end,
    },
  }
end

#widget_custom_attribute_mapping ⇒ Object 



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
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
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 353

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::Tile::TScale => {
      'variable' => {
        getter: {name: 'variable', invoker: lambda { |widget, args| @tk.variable&.value }},
        setter: {name: 'variable=', invoker: lambda { |widget, args| @tk.variable&.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 }},
      },
      'icon_photo' => {
        getter: {name: 'icon_photo', invoker: lambda { |widget, args| @tk.iconphoto }},
        setter: {name: 'icon_photo=', invoker: lambda { |widget, args| @tk.iconphoto = image_argument(args) }},
      },
    },
  }
end

#window? ⇒ Boolean

Returns:

  • (Boolean) 


600
601
602
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 600

def window?
  false
end