Module: TkComposite

Extended by:
Tk
Includes:
Tk
Included in:
Tk::RbWidget::AutoScrollListbox, Tk::RbWidget::Combobox, Tk::RbWidget::ScrollFrame, Tk::ScrollbarComposite, TkMenubar, TkMultiColumnList, TkMultiListFrame, TkMultiListbox, TkScrollbox, TkScrolledCanvas
Defined in:
lib/tk/composite.rb

Constant Summary

Constants included from Tk

Tk::AUTO_PATH, Tk::Fontchooser, Tk::INTERP, Tk::JAPANIZED_TK, Tk::LIBRARY_PATH, Tk::MAINLOOP, Tk::PACKAGE_PATH, Tk::RELEASE_DATE, Tk::TCL_LIBRARY_PATH, Tk::TCL_MAJOR_VERSION, Tk::TCL_MINOR_VERSION, Tk::TCL_PACKAGE_PATH, Tk::TCL_PATCHLEVEL, Tk::TCL_PRECISION, Tk::TCL_VERSION, Tk::TK_MAJOR_VERSION, Tk::TK_MINOR_VERSION, Tk::TK_PATCHLEVEL, Tk::TK_VERSION, Tk::Tkextlib_RELEASE_DATE, Tk::TreeCtrl_Widget, Tk::X_Scrollable, Tk::Y_Scrollable

Constants included from Tk::Encoding

Tk::Encoding::BINARY, Tk::Encoding::BINARY_NAME, Tk::Encoding::DEFAULT_EXTERNAL_NAME, Tk::Encoding::DEFAULT_INTERNAL_NAME, Tk::Encoding::ENCODING_TABLE, Tk::Encoding::RubyEncoding, Tk::Encoding::TkCommandNames, Tk::Encoding::UNKNOWN, Tk::Encoding::UTF8_NAME

Constants included from TkCore

TkCore::EventFlag, TkCore::INTERP, TkCore::INTERP_MUTEX, TkCore::INTERP_ROOT_CHECK, TkCore::INTERP_THREAD, TkCore::INTERP_THREAD_STATUS, TkCore::RUN_EVENTLOOP_ON_MAIN_THREAD, TkCore::WIDGET_DESTROY_HOOK, TkCore::WITH_ENCODING, TkCore::WITH_RUBY_VM

Constants included from TkComm

TkComm::GET_CONFIGINFO_AS_ARRAY, TkComm::GET_CONFIGINFOwoRES_AS_ARRAY, TkComm::TkExtlibAutoloadModule, TkComm::Tk_CMDTBL, TkComm::Tk_IDs, TkComm::Tk_WINDOWS, TkComm::USE_TCLs_LIST_FUNCTIONS, TkComm::WidgetClassNames

Constants included from TkUtil

TkUtil::None, TkUtil::RELEASE_DATE

Instance Method Summary collapse

Methods included from Tk

BinaryString, EncodedString, Grid, Pack, Place, UTF8_String, __create_widget_set__, __disable_toplevel_control__, __import_toplevel_aliases__, __regist_toplevel_aliases__, __remove_toplevel_aliases__, __reset_toplevel_owner__, __set_loaded_toplevel_aliases__, __set_toplevel_aliases__, __toplevel_alias_setup_proc__, _replace_toplevel_aliases, add_kinsoku, backup_current_topdef, bell, bell_on_display, const_missing, current_grabs, cursor_display, default_widget_set, default_widget_set=, define_topalias, define_topobj, delete_kinsoku, destroy, encoding, encoding=, errorCode, errorInfo, exit, focus, focus_lastfor, focus_next, focus_prev, focus_to, fromUTF8, grid, grid_forget, has_mainwindow?, load_tcllibrary, load_tclscript, load_tclscript_rsrc, load_tclscript_rsrcid, lower_window, pack, pack_forget, pkgconfig_get, pkgconfig_list, place, place_forget, raise_window, regist_sym_for_loaded_file, replace_topalias, replace_topobj, root, set_topalias, show_kinsoku, sleep, strictMotif, subst_tk_backslash, subst_utf_backslash, tcl_pkgconfig_get, tcl_pkgconfig_list, thread_update, thread_update_idletasks, tk_pkgconfig_get, tk_pkgconfig_list, toUTF8, to_backslash_sequence, topalias_defined?, toplevel_aliases_on_widget_set, topobj_defined?, ungrid, unload_tcllibrary, unpack, unplace, update, update, update_idletasks, utf_to_backslash, utf_to_backslash_sequence, wakeup, widget_set_symbols

Methods included from Tk::Encoding

#default_encoding=, #encoding=, #encoding_convertfrom, #encoding_convertto, #encoding_dirs, #encoding_dirs=, #encoding_name, #encoding_names, #encoding_obj, #encoding_objs, #encoding_system=, #encoding_system_name, #encoding_system_obj, #force_default_encoding, #force_default_encoding=, #force_default_encoding?, #tk_encoding_names

Methods included from TkCore

#_tk_call_to_list_core, #after, #after_cancel, #after_idle, #appname, #appsend, #appsend_deny, #appsend_displayof, callback, #callback_break, #callback_continue, #callback_return, #chooseColor, #chooseDirectory, #do_one_event, #event_generate, #getMultipleOpenFile, #getMultipleSaveFile, #getOpenFile, #getSaveFile, #get_eventloop_tick, #get_eventloop_weight, #get_no_event_wait, #inactive, #inactive_displayof, #info, #ip_eval, #ip_eval_with_enc, #ip_eval_without_enc, #ip_invoke, #ip_invoke_with_enc, #ip_invoke_without_enc, #is_mainloop?, #load_cmd_on_ip, #mainloop, #mainloop_exist?, #mainloop_thread?, #mainloop_watchdog, #messageBox, #rb_appsend, #rb_appsend_displayof, #reset_inactive, #reset_inactive_displayof, #restart, #scaling, #scaling_displayof, #set_eventloop_tick, #set_eventloop_weight, #set_no_event_wait, #tk_call, #tk_call_to_list, #tk_call_to_list_with_enc, #tk_call_to_list_without_enc, #tk_call_to_simplelist, #tk_call_to_simplelist_with_enc, #tk_call_to_simplelist_without_enc, #tk_call_with_enc, #tk_call_without_enc, #windowingsystem

Methods included from TkComm

_at, _callback_entry?, _callback_entry_class?, _curr_cmd_id, _fromUTF8, _genobj_for_tkwidget, _next_cmd_id, _toUTF8, array2tk_list, #bind, #bind_all, #bind_append, #bind_append_all, #bind_remove, #bind_remove_all, #bindinfo, #bindinfo_all, bool, image_obj, #install_cmd, install_cmd, list, num_or_nil, num_or_str, number, procedure, simplelist, slice_ary, string, #subst, tk_tcl2ruby, uninstall_cmd, #uninstall_cmd, window

Methods included from TkEvent

#install_bind, #install_bind_for_event_class

Methods included from TkUtil

#_conv_args, _conv_args, #_fromUTF8, #_get_eval_enc_str, _get_eval_enc_str, #_get_eval_string, _get_eval_string, _symbolkey2str, #_symbolkey2str, #_toUTF8, #bool, bool, callback, eval_cmd, #hash_kv, hash_kv, install_cmd, #num_or_nil, num_or_nil, num_or_str, #num_or_str, number, #number, string, #string, uninstall_cmd, untrust

Instance Method Details

#cget(slot) ⇒ Object 



245
246
247
248
249
250
251
 
# File 'lib/tk/composite.rb', line 245

def cget(slot)
  if (ret = __cget_delegates(slot)) == None
    super(slot)
  else
    ret
  end
end

#cget_strict(slot) ⇒ Object 



253
254
255
256
257
258
259
 
# File 'lib/tk/composite.rb', line 253

def cget_strict(slot)
  if (ret = __cget_delegates(slot)) == None
    super(slot)
  else
    ret
  end
end

#cget_tkstring(slot) ⇒ Object 



237
238
239
240
241
242
243
 
# File 'lib/tk/composite.rb', line 237

def cget_tkstring(slot)
  if (ret = __cget_delegates(slot)) == None
    super(slot)
  else
    _get_eval_string(ret)
  end
end

#configinfo(slot = nil) ⇒ Object 



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
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
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
 
# File 'lib/tk/composite.rb', line 332

def configinfo(slot = nil)
  if TkComm::GET_CONFIGINFO_AS_ARRAY
    if slot
      slot = slot.to_s
      if @option_methods.include?(slot)
        if @option_methods[slot][:info]
          return self.__send__(@option_methods[slot][:info])
        else
          return [slot, '', '', '', self.cget(slot)]
        end
      end

      tbl = @delegates[slot]
      tbl = @delegates['DEFAULT'] unless tbl

      begin
        if tbl
          if tbl.length == 1
            opt, wins = tbl[0]
            if slot == opt || opt == 'DEFAULT'
              return wins[-1].configinfo(slot)
            else
              info = wins[-1].configinfo(opt)
              info[0] = slot
              return info
            end
          else
            opt, wins = tbl[-1]
            return [slot, '', '', '', wins[-1].cget(opt)]
          end
        end
      rescue
      end

      super(slot)

    else # slot == nil
      info_list = super(slot)

      tbl = @delegates['DEFAULT']
      if tbl
        wins = tbl[0][1]
        if wins && wins[-1]
          wins[-1].configinfo.each{|info|
            slot = info[0]
            info_list.delete_if{|i| i[0] == slot} << info
          }
        end
      end

      @delegates.each{|slot, tbl|
        next if slot == 'DEFAULT'
        if tbl.length == 1
          opt, wins = tbl[0]
          next unless wins && wins[-1]
          if slot == opt
            info_list.delete_if{|i| i[0] == slot} <<
              wins[-1].configinfo(slot)
          else
            info = wins[-1].configinfo(opt)
            info[0] = slot
            info_list.delete_if{|i| i[0] == slot} << info
          end
        else
          opt, wins = tbl[-1]
          info_list.delete_if{|i| i[0] == slot} <<
            [slot, '', '', '', wins[-1].cget(opt)]
        end
      }

      @option_methods.each{|slot, m|
        if m[:info]
          info = self.__send__(m[:info])
        else
          info = [slot, '', '', '', self.cget(slot)]
        end
        info_list.delete_if{|i| i[0] == slot} << info
      }

      info_list
    end

  else # ! TkComm::GET_CONFIGINFO_AS_ARRAY
    if slot
      slot = slot.to_s
      if @option_methods.include?(slot)
        if @option_methods[slot][:info]
          return self.__send__(@option_methods[slot][:info])
        else
          return {slot => ['', '', '', self.cget(slot)]}
        end
      end

      tbl = @delegates[slot]
      tbl = @delegates['DEFAULT'] unless tbl

      begin
        if tbl
          if tbl.length == 1
            opt, wins = tbl[0]
            if slot == opt || opt == 'DEFAULT'
              return wins[-1].configinfo(slot)
            else
              return {slot => wins[-1].configinfo(opt)[opt]}
            end
          else
            opt, wins = tbl[-1]
            return {slot => ['', '', '', wins[-1].cget(opt)]}
          end
        end
      rescue
      end

      super(slot)

    else # slot == nil
      info_list = super(slot)

      tbl = @delegates['DEFAULT']
      if tbl
        wins = tbl[0][1]
        info_list.update(wins[-1].configinfo) if wins && wins[-1]
      end

      @delegates.each{|slot, tbl|
        next if slot == 'DEFAULT'
        if tbl.length == 1
          opt, wins = tbl[0]
          next unless wins && wins[-1]
          if slot == opt
            info_list.update(wins[-1].configinfo(slot))
          else
            info_list.update({slot => wins[-1].configinfo(opt)[opt]})
          end
        else
          opt, wins = tbl[-1]
          info_list.update({slot => ['', '', '', wins[-1].cget(opt)]})
        end
      }

      @option_methods.each{|slot, m|
        if m[:info]
          info = self.__send__(m[:info])
        else
          info = {slot => ['', '', '', self.cget(slot)]}
        end
        info_list.update(info)
      }

      info_list
    end
  end
end

#configure(slot, value = None) ⇒ Object

def cget(slot)

  slot = slot.to_s

  if @option_methods.include?(slot)
    if @option_methods[slot][:cget]
      return self.__send__(@option_methods[slot][:cget])
    else
      if @option_setting[slot]
        return @option_setting[slot]
      else
        return ''
      end
    end
  end

  tbl = @delegates[slot]
  tbl = @delegates['DEFAULT'] unless tbl

  begin
    if tbl
      opt, wins = tbl[-1]
      opt = slot if opt == 'DEFAULT'
      if wins && wins[-1]
        return wins[-1].cget(opt)
      end
    end
  rescue
  end

  super(slot)
end



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
324
325
326
327
328
329
330
 
# File 'lib/tk/composite.rb', line 295

def configure(slot, value=None)
  if slot.kind_of? Hash
    slot.each{|slot,value| configure slot, value}
    return self
  end

  slot = slot.to_s

  if @option_methods.include?(slot)
    unless @option_methods[slot][:cget]
      if value.kind_of?(Symbol)
        @option_setting[slot] = value.to_s
      else
        @option_setting[slot] = value
      end
    end
    return self.__send__(@option_methods[slot][:set], value)
  end

  tbl = @delegates[slot]
  tbl = @delegates['DEFAULT'] unless tbl

  begin
    if tbl
      last = nil
      tbl.each{|opt, wins|
        opt = slot if opt == 'DEFAULT'
        wins.each{|w| last = w.configure(opt, value)}
      }
      return last
    end
  rescue
  end

  super(slot, value)
end

#database_class ⇒ Object 



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

def database_class
  @frame.database_class
end

#database_classname ⇒ Object 



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

def database_classname
  @frame.database_classname
end

#delegate(option, *wins) ⇒ Object 



199
200
201
 
# File 'lib/tk/composite.rb', line 199

def delegate(option, *wins)
  delegate_alias(option, option, *wins)
end

#delegate_alias(alias_opt, option, *wins) ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/tk/composite.rb', line 179

def delegate_alias(alias_opt, option, *wins)
  if wins.length == 0
    fail ArgumentError, "target widgets are not given"
  end
  if alias_opt != option && (alias_opt == 'DEFAULT' || option == 'DEFAULT')
    fail ArgumentError, "cannot alias 'DEFAULT' option"
  end
  alias_opt = alias_opt.to_s
  option = option.to_s
  if @delegates[alias_opt].kind_of?(Array)
    if (elem = @delegates[alias_opt].assoc(option))
      wins.each{|w| elem[1].push(w)}
    else
      @delegates[alias_opt] << [option, wins]
    end
  else
    @delegates[alias_opt] = [ [option, wins] ]
  end
end

#epath ⇒ Object 



137
138
139
 
# File 'lib/tk/composite.rb', line 137

def epath
  @epath
end

#initialize(*args) ⇒ Object

def initialize(parent=nil, *args)



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/tk/composite.rb', line 94

def initialize(*args)
  @delegates = {}
  @option_methods = {}
  @option_setting = {}

  if args[-1].kind_of?(Hash)
    keys = _symbolkey2str(args.pop)
  else
    keys = {}
  end
  parent = args.shift
  parent = keys.delete('parent') if keys.has_key?('parent')

  if keys.key?('classname')
    keys['class'] = keys.delete('classname')
  end
  if (base_class_name = (keys.delete('class')).to_s).empty?
    base_class_name = _choice_classname_of_baseframe
  end

  if base_class_name
    # @frame = Tk::Frame.new(parent, :class=>base_class_name)
    # --> use current TkFrame class
    @frame = TkFrame.new(parent, :class=>base_class_name)
  else
    # @frame = Tk::Frame.new(parent)
    # --> use current TkFrame class
    @frame = TkFrame.new(parent)
  end
  @path = @epath = @frame.path

  args.push(keys) unless keys.empty?
  initialize_composite(*args)
end

#inspect ⇒ Object 



144
145
146
147
 
# File 'lib/tk/composite.rb', line 144

def inspect
  str = super
  str.chop << ' @epath=' << @epath.inspect << '>'
end

#option_methods(*opts) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/tk/composite.rb', line 159

def option_methods(*opts)
  if opts.size == 1 && opts[0].kind_of?(Hash)
    # {name => [m_set, m_cget, m_info], name => method} style
    opts[0].each{|name, arg|
      m_set, m_cget, m_info = _get_opt_method_list(arg)
      @option_methods[name.to_s] = {
        :set => m_set, :cget => m_cget, :info => m_info
      }
    }
  else
    # [m_set, m_cget, m_info] or method style
    opts.each{|arg|
      m_set, m_cget, m_info = _get_opt_method_list(arg)
      @option_methods[m_set] = {
        :set => m_set, :cget => m_cget, :info => m_info
      }
    }
  end
end