Class: Glimmer::Tk::WidgetProxy

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

Overview

Proxy for Tk Widget objects

Follows the Proxy Design Pattern

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



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 69

def initialize(underscored_widget_name, parent_proxy, args, &block)
  @parent_proxy = parent_proxy
  @args = args
  @keyword = underscored_widget_name
  @block = block
  tk_widget_class = self.class.tk_widget_class_for(underscored_widget_name)
  @tk = tk_widget_class.new(@parent_proxy.tk, *args)
  # 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 



424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 424

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.



64
65
66
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 64

def args
  @args
end

#children ⇒ Object (readonly)

Returns the value of attribute children.



64
65
66
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 64

def children
  @children
end

#keyword ⇒ Object (readonly)

Returns the value of attribute keyword.



64
65
66
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 64

def keyword
  @keyword
end

#parent_proxy ⇒ Object (readonly)

Returns the value of attribute parent_proxy.



64
65
66
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 64

def parent_proxy
  @parent_proxy
end

#tk ⇒ Object (readonly)

Returns the value of attribute tk.



64
65
66
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 64

def tk
  @tk
end

Class Method Details

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



29
30
31
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 29

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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 43

def tk_widget_class_for(underscored_widget_name)
  tk_widget_class_basename = underscored_widget_name.camelcase(:upper)
  potential_tk_widget_class_names = [
    "::Tk::Tile::#{tk_widget_class_basename}",
    "::Tk::#{tk_widget_class_basename}",
    "::Tk#{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) 


96
97
98
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 96

def self.widget_exists?(underscored_widget_name)
  !!tk_widget_class_for(underscored_widget_name)
end

.widget_proxy_class(keyword) ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 33

def widget_proxy_class(keyword)
  begin
    class_name = "#{keyword.camelcase(:upper)}Proxy".to_sym
    Glimmer::Tk.const_get(class_name)
  rescue
    Glimmer::Tk::WidgetProxy
  end
end

Instance Method Details

#add_observer(observer, attribute) ⇒ Object 



402
403
404
405
406
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 402

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

#apply_style(options) ⇒ Object 



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

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

#attribute_setter(attribute) ⇒ Object 



210
211
212
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 210

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

#content(&block) ⇒ Object 



420
421
422
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 420

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

#font=(value) ⇒ Object 



240
241
242
243
244
245
246
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 240

def font=(value)
  @tk.font = value.is_a?(TkFont) ? value : TkFont.new(value)
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 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 191

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 



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 220

def grid(options = {})
  options = options.stringify_keys
  index_in_parent = @parent_proxy.children.index(self)
  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')
  TkGrid.rowconfigure(@parent_proxy.tk, index_in_parent, 'weight'=> options.delete('rowweight')) if options.keys.include?('rowweight')
  TkGrid.rowconfigure(@parent_proxy.tk, index_in_parent, 'minsize'=> options.delete('rowminsize')) if options.keys.include?('rowminsize')
  TkGrid.columnconfigure(@parent_proxy.tk, index_in_parent, 'weight'=> options.delete('columnweight')) if options.keys.include?('columnweight')
  TkGrid.columnconfigure(@parent_proxy.tk, index_in_parent, 'minsize'=> options.delete('columnminsize')) if options.keys.include?('columnminsize')
  @tk.grid(options)
end

#handle_listener(listener_name, &listener) ⇒ Object 



408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 408

def handle_listener(listener_name, &listener)
  listener_name = listener_name.to_s
  begin
    @tk.bind(listener_name, &listener)
  rescue => e
    Glimmer::Config.logger.debug {e.full_message}
    listener_name = "<#{listener_name}" if !listener_name.start_with?('<')
    listener_name = "#{listener_name}>" if !listener_name.end_with?('>')
    @tk.bind(listener_name, &listener)
  end
end

#has_attribute?(attribute, *args) ⇒ Boolean

Returns:

  • (Boolean) 


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

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) 


136
137
138
139
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 136

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) 


122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 122

def has_state?(attribute)
  attribute = attribute.sub(/\?$/, '').sub(/=$/, '')
  if @tk.respond_to?(:tile_state)
    begin
      @tk.tile_instate(attribute)
      true
    rescue
      false
    end
  else
    false
  end
end

#image_argument(args) ⇒ Object 



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 386

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

#post_add_content ⇒ Object

Subclasses may override to perform post add_content work



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

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



87
88
89
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 87

def post_initialize_child(child)
  children << child
end

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

Returns:

  • (Boolean) 


438
439
440
441
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 438

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

#set_attribute(attribute, *args) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 152

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.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(attribute => args.first)
  end
end

#style=(styles) ⇒ Object 



214
215
216
217
218
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 214

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

#tk_widget_has_attribute_getter_setter?(attribute) ⇒ Boolean

Returns:

  • (Boolean) 


112
113
114
115
116
117
118
119
120
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 112

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
    false
  end
end

#tk_widget_has_attribute_setter?(attribute) ⇒ Boolean

Returns:

  • (Boolean) 


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

def tk_widget_has_attribute_setter?(attribute)
  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
    result = false
  end
  result
end

#widget_attribute_listener_installers ⇒ Object 



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

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'
          @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 => {
      'text' => lambda do |observer|
        handle_listener('modified') do
          observer.call(text)
        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 



255
256
257
258
259
260
261
262
263
264
265
266
267
268
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/glimmer/tk/widget_proxy.rb', line 255

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