summaryrefslogtreecommitdiff
path: root/ext/tk/lib/tk/menuspec.rb
blob: dfc1871ba9d9310ff63b733d8db291cca40b18eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
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
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
141
142
143
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
#
# tk/menuspec.rb
#                              Hidethoshi NAGAI (nagai@ai.kyutech.ac.jp)
#
# based on tkmenubar.rb :
#   Copyright (C) 1998 maeda shugo. All rights reserved. 
#   This file can be distributed under the terms of the Ruby.
#
# The format of the menu_spec is:
#   [ menu_info, menu_info, ... ]
#
# And the format of the menu_info is:
#   [
#     [text, underline, configs], # menu button/entry (*1)
#     [label, command, underline, accelerator, configs],    # command entry
#     [label, TkVar_obj, underline, accelerator, configs],  # checkbutton entry
#     [label, [TkVar_obj, value], 
#                        underline, accelerator, configs],  # radiobutton entry
#     [label, [[...menu_info...], [...menu_info...], ...], 
#                        underline, accelerator, configs],  # cascade entry
#     '---', # separator
#     ...
#   ]
#
# underline, accelerator, and configs are optional pearameters. 
# Hashes are OK instead of Arrays. Then the entry type ('command', 
# 'checkbutton', 'radiobutton' or 'cascade') is given by 'type' key
# (e.g. :type=>'cascade'). When type is 'cascade', an array of menu_info
# is acceptable for 'menu' key (then, create sub-menu).
#
# NOTE: (*1)
#   If you want to make special menus (*.help for UNIX, *.system for Win, 
#   and *.apple for Mac), append 'menu_name'=>name (name is 'help' for UNIX, 
#   'system' for Win, and 'apple' for Mac) option to the configs hash of 
#   menu button/entry information.

module TkMenuSpec
  def _create_menu(parent, menu_info, menu_name = nil, 
		   tearoff = false, default_opts = nil)
    if tearoff.kind_of?(Hash)
      default_opts = tearoff
      tearoff = false
    end

    if menu_name.kind_of?(Hash)
      default_opts = menu_name
      menu_name = nil
      tearoff = false
    end

    if default_opts.kind_of?(Hash)
      orig_opts = _symbolkey2str(default_opts)
    else
      orig_opts = {}
    end

    tearoff = orig_opts.delete('tearoff') if orig_opts.key?('tearoff')

    if menu_name
      menu = TkMenu.new(parent, :widgetname=>menu_name, :tearoff=>tearoff)
    else
      menu = TkMenu.new(parent, :tearoff=>tearoff)
    end

    for item_info in menu_info
      if item_info.kind_of?(Hash)
	options = orig_opts.dup
	options.update(_symbolkey2str(item_info))
	item_type = (options.delete('type') || 'command').to_s
	menu_name = options.delete('menu_name')
	menu_opts = orig_opts.dup
	menu_opts.update(_symbolkey2str(options.delete('menu_config') || {}))
	if item_type == 'cascade' && options['menu'].kind_of?(Array)
	  # create cascade menu
	  submenu = _create_menu(menu, options['menu'], menu_name, 
				 tearoff, menu_opts)
	  options['menu'] = submenu
	end
	menu.add(item_type, options)

      elsif item_info.kind_of?(Array)
	options = orig_opts.dup

	options['label'] = item_info[0] if item_info[0]

	case item_info[1]
	when TkVariable
	  # checkbutton
	  item_type = 'checkbutton'
	  options['variable'] = item_info[1]
	  options['onvalue']  = true
	  options['offvalue'] = false

	when Array
	  # radiobutton or cascade
	  if item_info[1][0].kind_of?(TkVariable)
	    # radiobutton
	    item_type = 'radiobutton'
	    options['variable'] = item_info[1][0]
	    options['value'] = item_info[1][1] if item_info[1][1]

	  else
	    # cascade
	    item_type = 'cascade'
	    menu_opts = orig_opts.dup
	    if item_info[4] && item_info[4].kind_of?(Hash)
	      opts = _symbolkey2str(item_info[4])
	      menu_name = opts.delete('menu_name')
	      menu_config = opts.delete('menu_config') || {}
	      menu_opts.update(_symbolkey2str(menu_config))
	    end
	    submenu = _create_menu(menu, item_info[1], menu_name, 
				   tearoff, menu_opts)
	    options['menu'] = submenu
	  end

	else
	  # command
	  item_type = 'command'
	  options['command'] = item_info[1] if item_info[1]
	end

	options['underline'] = item_info[2] if item_info[2]
	options['accelerator'] = item_info[3] if item_info[3]
	if item_info[4] && item_info[4].kind_of?(Hash)
	  opts = _symbolkey2str(item_info[4])
	  if item_type == 'cascade'
	    opts.delete('menu_name')
	    opts.delete('menu_config')
	  end
	  options.update(opts)
	end
	menu.add(item_type, options)

      elsif /^-+$/ =~ item_info
	menu.add('separator')

      else
	menu.add('command', 'label' => item_info)
      end
    end

    menu
  end
  private :_create_menu

  def _use_menubar?(parent)
    use_menubar = false
    if parent.kind_of?(TkRoot) || parent.kind_of?(TkToplevel)
      return true 
    else
      begin
	parent.cget('menu')
	return true 
      rescue
      end
    end
    false
  end
  private :_use_menubar?

  def _create_menu_for_menubar(parent)
    unless (mbar = parent.menu).kind_of?(TkMenu)
      mbar = TkMenu.new(parent, :tearoff=>false)
      parent.menu(mbar)
    end
    mbar
  end
  private :_create_menu_for_menubar

  def _create_menubutton(parent, menu_info, tearoff=false, default_opts = nil)
    btn_info = menu_info[0]

    if tearoff.kind_of?(Hash)
      default_opts = tearoff
      tearoff = false
    end

    if default_opts.kind_of?(Hash)
      keys = _symbolkey2str(default_opts)
    else
      keys = {}
    end

    tearoff = keys.delete('tearoff') if keys.key?('tearoff')

    if _use_menubar?(parent)
      # menubar by menu entries

      mbar = _create_menu_for_menubar(parent)

      menu_name = nil

      if btn_info.kind_of?(Hash)
	keys.update(_symbolkey2str(btn_info))
	menu_name = keys.delete('menu_name')
	keys['label'] = keys.delete('text') if keys.key?('text')
      elsif btn_info.kind_of?(Array)
	keys['label'] = btn_info[0] if btn_info[0]
	keys['underline'] = btn_info[1] if btn_info[1]
	if btn_info[2]&&btn_info[2].kind_of?(Hash)
	  keys.update(_symbolkey2str(btn_info[2]))
	  menu_name = keys.delete('menu_name')
	end
      else
	keys = {:label=>btn_info}
      end

      menu = _create_menu(mbar, menu_info[1..-1], menu_name, 
			  tearoff, default_opts)
      menu.tearoff(tearoff)

      keys['menu'] = menu
      mbar.add('cascade', keys)

      [mbar, menu]

    else
      # menubar by menubuttons
      mbtn = TkMenubutton.new(parent)

      menu_name = nil

      if btn_info.kind_of?(Hash)
	keys.update(_symbolkey2str(btn_info))
	menu_name = keys.delete('menu_name')
	keys['text'] = keys.delete('label') if keys.key?('label')
	mbtn.configure(keys)
      elsif btn_info.kind_of?(Array)
	mbtn.configure('text', btn_info[0]) if btn_info[0]
	mbtn.configure('underline', btn_info[1]) if btn_info[1]
	# mbtn.configure('accelerator', btn_info[2]) if btn_info[2]
	if btn_info[2]&&btn_info[2].kind_of?(Hash)
	  keys.update(_symbolkey2str(btn_info[2]))
	  menu_name = keys.delete('menu_name')
	  mbtn.configure(keys)
	end
      else
	mbtn.configure('text', btn_info)
      end

      mbtn.pack('side' => 'left')

      menu = _create_menu(mbtn, menu_info[1..-1], menu_name, 
			  tearoff, default_opts)
    
      mbtn.menu(menu)

      [mbtn, menu]
    end
  end
  private :_create_menubutton

  def _get_cascade_menus(menu)
    menus = []
    (0..(menu.index('last'))).each{|idx|
      if menu.menutype(idx) == 'cascade'
	submenu = menu.entrycget(idx, 'menu')
	menus << [submenu, _get_cascade_menus(submenu)]
      end
    }
    menus
  end
  private :_get_cascade_menus
end