Module: TkGrid

Extended by:
Tk
Includes:
Tk
Defined in:
lib/tk/grid.rb

Constant Summary collapse

TkCommandNames = 
['grid'.freeze].freeze

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::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

Class 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_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, #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

Class Method Details

.add(widget, *args) ⇒ Object 



189
190
191
 
# File 'lib/tk/grid.rb', line 189

def add(widget, *args)
  configure(widget, *args)
end

.anchor(master, anchor = None) ⇒ Object 



13
14
15
16
17
 
# File 'lib/tk/grid.rb', line 13

def anchor(master, anchor=None)
  # master = master.epath if master.kind_of?(TkObject)
  master = _epath(master)
  tk_call_without_enc('grid', 'anchor', master, anchor)
end

.bbox(master, *args) ⇒ Object 



19
20
21
22
23
24
 
# File 'lib/tk/grid.rb', line 19

def bbox(master, *args)
  # master = master.epath if master.kind_of?(TkObject)
  master = _epath(master)
  args.unshift(master)
  list(tk_call_without_enc('grid', 'bbox', *args))
end

.column(master, index, keys = nil) ⇒ Object 



173
174
175
176
177
178
179
 
# File 'lib/tk/grid.rb', line 173

def column(master, index, keys=nil)
  if keys.kind_of?(Hash)
    columnconfigure(master, index, keys)
  else
    columnconfiginfo(master, index, keys)
  end
end

.columnconfiginfo(master, index, slot = nil) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/tk/grid.rb', line 115

def columnconfiginfo(master, index, slot=nil)
  # master = master.epath if master.kind_of?(TkObject)
  master = _epath(master)
  if slot
    case slot
    when 'uniform', :uniform
      tk_call_without_enc('grid', 'columnconfigure',
                          master, index, "-#{slot}")
    else
      num_or_str(tk_call_without_enc('grid', 'columnconfigure',
                                     master, index, "-#{slot}"))
    end
  else
    #ilist = list(tk_call_without_enc('grid','columnconfigure',master,index))
    ilist = simplelist(tk_call_without_enc('grid', 'columnconfigure',
                                           master, index))
    info = {}
    while key = ilist.shift
      case key
      when 'uniform'
        info[key[1..-1]] = ilist.shift
      else
        info[key[1..-1]] = tk_tcl2ruby(ilist.shift)
      end
    end
    info
  end
end

.columnconfigure(master, index, args) ⇒ Object 



102
103
104
105
106
107
 
# File 'lib/tk/grid.rb', line 102

def columnconfigure(master, index, args)
  # master = master.epath if master.kind_of?(TkObject)
  master = _epath(master)
  tk_call_without_enc("grid", 'columnconfigure',
                      master, index, *hash_kv(args))
end

.configure(*args) ⇒ Object

def configure(win, *args)

  if args[-1].kind_of?(Hash)
    opts = args.pop
  else
    opts = {}
  end
  params = []
  params.push(_epath(win))
  args.each{|win|
    case win
    when '-', 'x', '^'  # RELATIVE PLACEMENT
      params.push(win)
    else
      params.push(_epath(win))
    end
  }
  opts.each{|k, v|
    params.push("-#{k}")
    params.push((v.kind_of?(TkObject))? v.epath: v)
  }
  if Tk::TCL_MAJOR_VERSION < 8 ||
      (Tk::TCL_MAJOR_VERSION == 8 && Tk::TCL_MINOR_VERSION <= 3)
    if params[0] == '-' || params[0] == 'x' || params[0] == '^'
      tk_call_without_enc('grid', *params)
    else
      tk_call_without_enc('grid', 'configure', *params)
    end
  else
    tk_call_without_enc('grid', 'configure', *params)
  end
end



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

def configure(*args)
  if args[-1].kind_of?(Hash)
    opts = args.pop
  else
    opts = {}
  end
  fail ArgumentError, 'no widget is given' if args.empty?
  params = []
  args.flatten(1).each{|win|
    case win
    when '-', ?-              # RELATIVE PLACEMENT (increase columnspan)
      params.push('-')
    when /^-+$/             # RELATIVE PLACEMENT (increase columnspan)
      params.concat(win.to_s.split(//))
    when '^', ?^              # RELATIVE PLACEMENT (increase rowspan)
      params.push('^')
    when /^\^+$/             # RELATIVE PLACEMENT (increase rowspan)
      params.concat(win.to_s.split(//))
    when 'x', :x, ?x, nil, '' # RELATIVE PLACEMENT (empty column)
      params.push('x')
    when /^x+$/             # RELATIVE PLACEMENT (empty column)
      params.concat(win.to_s.split(//))
    else
      params.push(_epath(win))
    end
  }
  opts.each{|k, v|
    params.push("-#{k}")
    params.push(_epath(v))  # have to use 'epath' (hash_kv() is unavailable)
  }
  if Tk::TCL_MAJOR_VERSION < 8 ||
      (Tk::TCL_MAJOR_VERSION == 8 && Tk::TCL_MINOR_VERSION <= 3)
    if params[0] == '-' || params[0] == 'x' || params[0] == '^'
      tk_call_without_enc('grid', *params)
    else
      tk_call_without_enc('grid', 'configure', *params)
    end
  else
    tk_call_without_enc('grid', 'configure', *params)
  end
end

.forget(*args) ⇒ Object 



193
194
195
196
197
198
199
200
 
# File 'lib/tk/grid.rb', line 193

def forget(*args)
  return '' if args.size == 0
  wins = args.collect{|win|
    # (win.kind_of?(TkObject))? win.epath: win
    _epath(win)
  }
  tk_call_without_enc('grid', 'forget', *wins)
end

.grid ⇒ Object

def configure(win, *args)

  if args[-1].kind_of?(Hash)
    opts = args.pop
  else
    opts = {}
  end
  params = []
  params.push(_epath(win))
  args.each{|win|
    case win
    when '-', 'x', '^'  # RELATIVE PLACEMENT
      params.push(win)
    else
      params.push(_epath(win))
    end
  }
  opts.each{|k, v|
    params.push("-#{k}")
    params.push((v.kind_of?(TkObject))? v.epath: v)
  }
  if Tk::TCL_MAJOR_VERSION < 8 ||
      (Tk::TCL_MAJOR_VERSION == 8 && Tk::TCL_MINOR_VERSION <= 3)
    if params[0] == '-' || params[0] == 'x' || params[0] == '^'
      tk_call_without_enc('grid', *params)
    else
      tk_call_without_enc('grid', 'configure', *params)
    end
  else
    tk_call_without_enc('grid', 'configure', *params)
  end
end



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
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/tk/grid.rb', line 100

def configure(*args)
  if args[-1].kind_of?(Hash)
    opts = args.pop
  else
    opts = {}
  end
  fail ArgumentError, 'no widget is given' if args.empty?
  params = []
  args.flatten(1).each{|win|
    case win
    when '-', ?-              # RELATIVE PLACEMENT (increase columnspan)
      params.push('-')
    when /^-+$/             # RELATIVE PLACEMENT (increase columnspan)
      params.concat(win.to_s.split(//))
    when '^', ?^              # RELATIVE PLACEMENT (increase rowspan)
      params.push('^')
    when /^\^+$/             # RELATIVE PLACEMENT (increase rowspan)
      params.concat(win.to_s.split(//))
    when 'x', :x, ?x, nil, '' # RELATIVE PLACEMENT (empty column)
      params.push('x')
    when /^x+$/             # RELATIVE PLACEMENT (empty column)
      params.concat(win.to_s.split(//))
    else
      params.push(_epath(win))
    end
  }
  opts.each{|k, v|
    params.push("-#{k}")
    params.push(_epath(v))  # have to use 'epath' (hash_kv() is unavailable)
  }
  if Tk::TCL_MAJOR_VERSION < 8 ||
      (Tk::TCL_MAJOR_VERSION == 8 && Tk::TCL_MINOR_VERSION <= 3)
    if params[0] == '-' || params[0] == 'x' || params[0] == '^'
      tk_call_without_enc('grid', *params)
    else
      tk_call_without_enc('grid', 'configure', *params)
    end
  else
    tk_call_without_enc('grid', 'configure', *params)
  end
end

.info(slave) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/tk/grid.rb', line 202

def info(slave)
  # slave = slave.epath if slave.kind_of?(TkObject)
  slave = _epath(slave)
  #ilist = list(tk_call_without_enc('grid', 'info', slave))
  ilist = simplelist(tk_call_without_enc('grid', 'info', slave))
  info = {}
  while key = ilist.shift
    #info[key[1..-1]] = ilist.shift
    info[key[1..-1]] = tk_tcl2ruby(ilist.shift)
  end
  return info
end

.location(master, x, y) ⇒ Object 



215
216
217
218
219
 
# File 'lib/tk/grid.rb', line 215

def location(master, x, y)
  # master = master.epath if master.kind_of?(TkObject)
  master = _epath(master)
  list(tk_call_without_enc('grid', 'location', master, x, y))
end

.propagate(master, mode = None) ⇒ Object 



221
222
223
224
225
226
227
228
229
 
# File 'lib/tk/grid.rb', line 221

def propagate(master, mode=None)
  # master = master.epath if master.kind_of?(TkObject)
  master = _epath(master)
  if mode == None
    bool(tk_call_without_enc('grid', 'propagate', master))
  else
    tk_call_without_enc('grid', 'propagate', master, mode)
  end
end

.remove(*args) ⇒ Object 



231
232
233
234
235
236
237
238
 
# File 'lib/tk/grid.rb', line 231

def remove(*args)
  return '' if args.size == 0
  wins = args.collect{|win|
    # (win.kind_of?(TkObject))? win.epath: win
    _epath(win)
  }
  tk_call_without_enc('grid', 'remove', *wins)
end

.row(master, index, keys = nil) ⇒ Object 



181
182
183
184
185
186
187
 
# File 'lib/tk/grid.rb', line 181

def row(master, index, keys=nil)
  if keys.kind_of?(Hash)
    rowconfigure(master, index, keys)
  else
    rowconfiginfo(master, index, keys)
  end
end

.rowconfiginfo(master, index, slot = nil) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/tk/grid.rb', line 144

def rowconfiginfo(master, index, slot=nil)
  # master = master.epath if master.kind_of?(TkObject)
  master = _epath(master)
  if slot
    case slot
    when 'uniform', :uniform
      tk_call_without_enc('grid', 'rowconfigure',
                          master, index, "-#{slot}")
    else
      num_or_str(tk_call_without_enc('grid', 'rowconfigure',
                                     master, index, "-#{slot}"))
    end
  else
    #ilist = list(tk_call_without_enc('grid', 'rowconfigure', master, index))
    ilist = simplelist(tk_call_without_enc('grid', 'rowconfigure',
                                           master, index))
    info = {}
    while key = ilist.shift
      case key
      when 'uniform'
        info[key[1..-1]] = ilist.shift
      else
        info[key[1..-1]] = tk_tcl2ruby(ilist.shift)
      end
    end
    info
  end
end

.rowconfigure(master, index, args) ⇒ Object 



109
110
111
112
113
 
# File 'lib/tk/grid.rb', line 109

def rowconfigure(master, index, args)
  # master = master.epath if master.kind_of?(TkObject)
  master = _epath(master)
  tk_call_without_enc("grid", 'rowconfigure', master, index, *hash_kv(args))
end

.size(master) ⇒ Object 



240
241
242
243
244
 
# File 'lib/tk/grid.rb', line 240

def size(master)
  # master = master.epath if master.kind_of?(TkObject)
  master = _epath(master)
  list(tk_call_without_enc('grid', 'size', master))
end

.slaves(master, keys = nil) ⇒ Object 



246
247
248
249
250
 
# File 'lib/tk/grid.rb', line 246

def slaves(master, keys=nil)
  # master = master.epath if master.kind_of?(TkObject)
  master = _epath(master)
  list(tk_call_without_enc('grid', 'slaves', master, *hash_kv(args)))
end