wxruby3 1.7.0 → 1.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (522) hide show
  1. checksums.yaml +4 -4
  2. data/INSTALL.md +27 -2
  3. data/README.md +15 -15
  4. data/ext/wxruby3/include/wxRubyApp.h +145 -46
  5. data/ext/wxruby3/include/wxruby-ComboPopup.h +25 -8
  6. data/ext/wxruby3/include/wxruby-GCTracking.h +262 -0
  7. data/ext/wxruby3/include/wxruby-MBConv.h +190 -0
  8. data/ext/wxruby3/include/wxruby-SharedEventHandler.h +183 -0
  9. data/ext/wxruby3/include/wxruby-SharedPtr.h +104 -0
  10. data/ext/wxruby3/include/wxruby-runtime.h +29 -0
  11. data/ext/wxruby3/swig/custom/rubytracking.swg +8 -22
  12. data/ext/wxruby3/swig/custom/wx_ruby_shared_ptr.i +434 -0
  13. data/ext/wxruby3/swig/custom/wx_shared_ptr.i +431 -0
  14. data/ext/wxruby3/swig/mark_free_impl.i +7 -132
  15. data/ext/wxruby3/swig/memory_management.i +8 -44
  16. data/ext/wxruby3/swig/wx.i +46 -73
  17. data/lib/wx/core/const.rb +0 -1
  18. data/lib/wx/core/context_help.rb +17 -0
  19. data/lib/wx/core/cursor.rb +1 -0
  20. data/lib/wx/core/helpcontrollerhelpprovider.rb +10 -2
  21. data/lib/wx/core/mbconv.rb +11 -0
  22. data/lib/wx/core/media_ctrl.rb +31 -0
  23. data/lib/wx/core/top_level_window.rb +7 -0
  24. data/lib/wx/core.rb +6 -0
  25. data/lib/wx/doc/art_provider.rb +17 -0
  26. data/lib/wx/doc/context_help.rb +42 -0
  27. data/lib/wx/doc/core.rb +0 -5
  28. data/lib/wx/doc/functions.rb +10 -0
  29. data/lib/wx/doc/html/html_help_controller.rb +23 -1
  30. data/lib/wx/doc/mbconv.rb +108 -0
  31. data/lib/wx/doc/rt/shared_event_handler.rb +49 -0
  32. data/lib/wx/doc/rt/thread_event.rb +28 -0
  33. data/lib/wx/doc/stream.rb +7 -3
  34. data/lib/wx/doc/webview.rb +40 -0
  35. data/lib/wx/helpers.rb +1 -1
  36. data/lib/wx/html/htmlhelpcontroller.rb +10 -0
  37. data/lib/wx/keyword_defs.rb +11 -0
  38. data/lib/wx/rt/require.rb +8 -0
  39. data/lib/wx/rt/thread_event.rb +14 -0
  40. data/lib/wx/rt.rb +16 -0
  41. data/lib/wx/version.rb +1 -1
  42. data/lib/wx/web/require.rb +8 -0
  43. data/lib/wx/web/webview.rb +106 -0
  44. data/lib/wx/web.rb +17 -0
  45. data/lib/wx/wxruby/cmd/setup.rb +15 -0
  46. data/lib/wx/wxruby/cmd/test.rb +8 -2
  47. data/lib/wx.rb +2 -0
  48. data/rakelib/configure.rb +24 -0
  49. data/rakelib/gem.rb +3 -2
  50. data/rakelib/install.rb +54 -27
  51. data/rakelib/lib/config/macosx.rb +7 -5
  52. data/rakelib/lib/config/mingw.rb +66 -5
  53. data/rakelib/lib/config/pkgman/linux.rb +4 -2
  54. data/rakelib/lib/config/pkgman/mingw.rb +1 -1
  55. data/rakelib/lib/config/unixish.rb +4 -2
  56. data/rakelib/lib/config.rb +37 -3
  57. data/rakelib/lib/core/include/client_data.inc +38 -17
  58. data/rakelib/lib/core/include/funcall.inc +1 -1
  59. data/rakelib/lib/core/include/swigdirector.inc +3 -3
  60. data/rakelib/lib/core/include/swigrubyrun.inc +14 -26
  61. data/rakelib/lib/core/package.rb +0 -2
  62. data/rakelib/lib/director/app.rb +1 -8
  63. data/rakelib/lib/director/art_provider.rb +7 -3
  64. data/rakelib/lib/director/comboctrl.rb +0 -7
  65. data/rakelib/lib/director/context_help_button.rb +35 -2
  66. data/rakelib/lib/director/derived_dc.rb +41 -32
  67. data/rakelib/lib/director/editable_listbox.rb +10 -8
  68. data/rakelib/lib/director/event_handler.rb +32 -28
  69. data/rakelib/lib/director/fs_file.rb +38 -10
  70. data/rakelib/lib/director/functions.rb +8 -0
  71. data/rakelib/lib/director/grid_cell_attr.rb +1 -3
  72. data/rakelib/lib/director/grid_cell_editor.rb +14 -12
  73. data/rakelib/lib/director/grid_cell_renderer.rb +11 -8
  74. data/rakelib/lib/director/grid_ctrl.rb +140 -121
  75. data/rakelib/lib/director/help_controller.rb +70 -2
  76. data/rakelib/lib/director/mb_conv.rb +30 -0
  77. data/rakelib/lib/director/menu.rb +92 -42
  78. data/rakelib/lib/director/menu_bar.rb +84 -45
  79. data/rakelib/lib/director/menu_item.rb +2 -2
  80. data/rakelib/lib/director/persistence_manager.rb +3 -2
  81. data/rakelib/lib/director/preview_frame.rb +2 -2
  82. data/rakelib/lib/director/ribbon_page.rb +11 -0
  83. data/rakelib/lib/director/richtext_buffer.rb +5 -2
  84. data/rakelib/lib/director/shared_evt_handler.rb +30 -0
  85. data/rakelib/lib/director/sizer.rb +8 -17
  86. data/rakelib/lib/director/sizer_item.rb +3 -4
  87. data/rakelib/lib/director/task_bar_icon.rb +7 -7
  88. data/rakelib/lib/director/thread_event.rb +33 -0
  89. data/rakelib/lib/director/top_level_window.rb +12 -4
  90. data/rakelib/lib/director/validator.rb +3 -1
  91. data/rakelib/lib/director/variant.rb +16 -12
  92. data/rakelib/lib/director/webview.rb +166 -0
  93. data/rakelib/lib/director/webview_event.rb +37 -0
  94. data/rakelib/lib/director/webview_handler.rb +63 -0
  95. data/rakelib/lib/generate/doc/thread_event.yaml +20 -0
  96. data/rakelib/lib/generate/doc/web_view.yaml +135 -0
  97. data/rakelib/lib/generate/doc/web_view_event.yaml +38 -0
  98. data/rakelib/lib/generate/doc/web_view_handler.yaml +58 -0
  99. data/rakelib/lib/specs/interfaces.rb +14 -2
  100. data/rakelib/lib/typemap/common.rb +34 -1
  101. data/rakelib/lib/typemap/mb_conv.rb +58 -0
  102. data/rakelib/prepost.rake +23 -31
  103. data/rakelib/prepost.rb +20 -0
  104. data/samples/event/threaded.rb +295 -42
  105. data/samples/event/tn_threaded.png +0 -0
  106. data/samples/help/doc/back.gif +0 -0
  107. data/samples/help/doc/contents.gif +0 -0
  108. data/samples/help/doc/cshelp.txt +9 -0
  109. data/samples/help/doc/doc.chm +0 -0
  110. data/samples/help/doc/doc.cnt +8 -0
  111. data/samples/help/doc/doc.h +7 -0
  112. data/samples/help/doc/doc.hhc +40 -0
  113. data/samples/help/doc/doc.hhk +31 -0
  114. data/samples/help/doc/doc.hhp +33 -0
  115. data/samples/help/doc/doc.hpj +21 -0
  116. data/samples/help/doc/doc.htm +27 -0
  117. data/samples/help/doc/doc1.htm +24 -0
  118. data/samples/help/doc/doc2.htm +12 -0
  119. data/samples/help/doc/doc3.htm +12 -0
  120. data/samples/help/doc/doc4.htm +12 -0
  121. data/samples/help/doc/doc5.htm +14 -0
  122. data/samples/help/doc/forward.gif +0 -0
  123. data/samples/help/doc/up.gif +0 -0
  124. data/samples/help/doc.chm +0 -0
  125. data/samples/help/doc.chw +0 -0
  126. data/samples/help/doc.zip +0 -0
  127. data/samples/help/help.rb +352 -0
  128. data/samples/help/tn_help.png +0 -0
  129. data/samples/webview/handler_advanced.html +55 -0
  130. data/samples/webview/tn_webview.png +0 -0
  131. data/samples/webview/webview.rb +1264 -0
  132. data/tests/assets/handler_advanced.html +55 -0
  133. data/tests/assets/test.zip +0 -0
  134. data/tests/lib/text_entry_tests.rb +2 -2
  135. data/tests/lib/wxapp_runner.rb +40 -0
  136. data/tests/lib/wxframe_runner.rb +17 -2
  137. data/tests/test_art.rb +8 -8
  138. data/tests/test_clipboard.rb +4 -4
  139. data/tests/test_config.rb +6 -6
  140. data/tests/test_exceptions.rb +8 -6
  141. data/tests/test_ext_controls.rb +3 -3
  142. data/tests/test_file_dialog.rb +5 -5
  143. data/tests/test_font.rb +7 -7
  144. data/tests/test_grid_ctrl.rb +133 -0
  145. data/tests/test_help.rb +88 -0
  146. data/tests/test_intl.rb +1 -1
  147. data/tests/test_media_ctrl.rb +14 -6
  148. data/tests/test_menu.rb +94 -86
  149. data/tests/test_persistence.rb +1 -1
  150. data/tests/test_proof_check.rb +5 -5
  151. data/tests/test_propgrid.rb +1 -1
  152. data/tests/test_shared_event_handler.rb +141 -0
  153. data/tests/test_std_controls.rb +5 -5
  154. data/tests/test_webview.rb +492 -0
  155. data/tests/test_window.rb +3 -3
  156. metadata +66 -368
  157. data/assets/repo-social-preview.odg +0 -0
  158. data/assets/repo-social-preview.xcf +0 -0
  159. data/lib/wx/aui/events/evt_list.rb +0 -148
  160. data/lib/wx/core/events/evt_list.rb +0 -1458
  161. data/lib/wx/core/font/encoding.rb +0 -113
  162. data/lib/wx/doc/gen/about_dialog_info.rb +0 -330
  163. data/lib/wx/doc/gen/accelerator.rb +0 -178
  164. data/lib/wx/doc/gen/activity_indicator.rb +0 -83
  165. data/lib/wx/doc/gen/affine_matrix2d.rb +0 -284
  166. data/lib/wx/doc/gen/animation.rb +0 -275
  167. data/lib/wx/doc/gen/animation_ctrl.rb +0 -300
  168. data/lib/wx/doc/gen/any_button.rb +0 -191
  169. data/lib/wx/doc/gen/app.rb +0 -463
  170. data/lib/wx/doc/gen/app_traits.rb +0 -396
  171. data/lib/wx/doc/gen/art_provider.rb +0 -605
  172. data/lib/wx/doc/gen/aui/aui_dock_art.rb +0 -455
  173. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +0 -54
  174. data/lib/wx/doc/gen/aui/aui_manager.rb +0 -847
  175. data/lib/wx/doc/gen/aui/aui_manager_event.rb +0 -131
  176. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +0 -180
  177. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +0 -59
  178. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +0 -130
  179. data/lib/wx/doc/gen/aui/aui_notebook.rb +0 -631
  180. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +0 -233
  181. data/lib/wx/doc/gen/aui/aui_pane_info.rb +0 -769
  182. data/lib/wx/doc/gen/aui/aui_tab_art.rb +0 -352
  183. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +0 -14
  184. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +0 -510
  185. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +0 -340
  186. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +0 -244
  187. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +0 -257
  188. data/lib/wx/doc/gen/aui/event_list.rb +0 -179
  189. data/lib/wx/doc/gen/banner_window.rb +0 -124
  190. data/lib/wx/doc/gen/bitmap.rb +0 -731
  191. data/lib/wx/doc/gen/bitmap_button.rb +0 -123
  192. data/lib/wx/doc/gen/bitmap_combo_box.rb +0 -221
  193. data/lib/wx/doc/gen/book_ctrl_base.rb +0 -273
  194. data/lib/wx/doc/gen/book_ctrl_event.rb +0 -66
  195. data/lib/wx/doc/gen/box_sizer.rb +0 -85
  196. data/lib/wx/doc/gen/brush.rb +0 -251
  197. data/lib/wx/doc/gen/busy_info.rb +0 -157
  198. data/lib/wx/doc/gen/button.rb +0 -182
  199. data/lib/wx/doc/gen/calculate_layout_event.rb +0 -62
  200. data/lib/wx/doc/gen/calendar_ctrl.rb +0 -505
  201. data/lib/wx/doc/gen/calendar_date_attr.rb +0 -138
  202. data/lib/wx/doc/gen/calendar_event.rb +0 -147
  203. data/lib/wx/doc/gen/caret.rb +0 -97
  204. data/lib/wx/doc/gen/check_box.rb +0 -175
  205. data/lib/wx/doc/gen/check_list_box.rb +0 -121
  206. data/lib/wx/doc/gen/choice.rb +0 -175
  207. data/lib/wx/doc/gen/choicebook.rb +0 -116
  208. data/lib/wx/doc/gen/client_dc.rb +0 -43
  209. data/lib/wx/doc/gen/clipboard.rb +0 -144
  210. data/lib/wx/doc/gen/collapsible_pane.rb +0 -138
  211. data/lib/wx/doc/gen/collapsible_pane_event.rb +0 -46
  212. data/lib/wx/doc/gen/colour.rb +0 -333
  213. data/lib/wx/doc/gen/colour_dialog.rb +0 -190
  214. data/lib/wx/doc/gen/colour_picker_ctrl.rb +0 -110
  215. data/lib/wx/doc/gen/colour_picker_event.rb +0 -77
  216. data/lib/wx/doc/gen/combo_box.rb +0 -292
  217. data/lib/wx/doc/gen/combo_ctrl.rb +0 -662
  218. data/lib/wx/doc/gen/command_link_button.rb +0 -134
  219. data/lib/wx/doc/gen/config_base.rb +0 -10
  220. data/lib/wx/doc/gen/context_help_button.rb +0 -109
  221. data/lib/wx/doc/gen/control.rb +0 -277
  222. data/lib/wx/doc/gen/control_with_items.rb +0 -253
  223. data/lib/wx/doc/gen/core.rb +0 -45
  224. data/lib/wx/doc/gen/credential_entry_dialog.rb +0 -137
  225. data/lib/wx/doc/gen/cursor.rb +0 -193
  226. data/lib/wx/doc/gen/data_format.rb +0 -85
  227. data/lib/wx/doc/gen/data_object.rb +0 -436
  228. data/lib/wx/doc/gen/data_object_simple_base.rb +0 -10
  229. data/lib/wx/doc/gen/date_event.rb +0 -49
  230. data/lib/wx/doc/gen/date_picker_ctrl.rb +0 -161
  231. data/lib/wx/doc/gen/dc.rb +0 -1631
  232. data/lib/wx/doc/gen/dc_overlay.rb +0 -102
  233. data/lib/wx/doc/gen/defs.rb +0 -2802
  234. data/lib/wx/doc/gen/dial_up_event.rb +0 -45
  235. data/lib/wx/doc/gen/dial_up_manager.rb +0 -149
  236. data/lib/wx/doc/gen/dialog.rb +0 -541
  237. data/lib/wx/doc/gen/dir_dialog.rb +0 -164
  238. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +0 -90
  239. data/lib/wx/doc/gen/dir_picker_ctrl.rb +0 -125
  240. data/lib/wx/doc/gen/display.rb +0 -238
  241. data/lib/wx/doc/gen/drag_drop.rb +0 -299
  242. data/lib/wx/doc/gen/drag_image.rb +0 -116
  243. data/lib/wx/doc/gen/editable_list_box.rb +0 -109
  244. data/lib/wx/doc/gen/event.rb +0 -990
  245. data/lib/wx/doc/gen/event_blocker.rb +0 -50
  246. data/lib/wx/doc/gen/event_filter.rb +0 -92
  247. data/lib/wx/doc/gen/event_list.rb +0 -1644
  248. data/lib/wx/doc/gen/events.rb +0 -2809
  249. data/lib/wx/doc/gen/evt_handler.rb +0 -229
  250. data/lib/wx/doc/gen/ext_help_controller.rb +0 -109
  251. data/lib/wx/doc/gen/file_ctrl.rb +0 -231
  252. data/lib/wx/doc/gen/file_ctrl_event.rb +0 -83
  253. data/lib/wx/doc/gen/file_dialog.rb +0 -353
  254. data/lib/wx/doc/gen/file_dialog_custom_control.rb +0 -165
  255. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +0 -158
  256. data/lib/wx/doc/gen/file_dir_picker_event.rb +0 -100
  257. data/lib/wx/doc/gen/file_picker_ctrl.rb +0 -132
  258. data/lib/wx/doc/gen/file_system.rb +0 -232
  259. data/lib/wx/doc/gen/find_dialog_event.rb +0 -126
  260. data/lib/wx/doc/gen/find_replace_data.rb +0 -60
  261. data/lib/wx/doc/gen/find_replace_dialog.rb +0 -58
  262. data/lib/wx/doc/gen/flex_grid_sizer.rb +0 -199
  263. data/lib/wx/doc/gen/font.rb +0 -1379
  264. data/lib/wx/doc/gen/font_data.rb +0 -151
  265. data/lib/wx/doc/gen/font_dialog.rb +0 -88
  266. data/lib/wx/doc/gen/font_picker_ctrl.rb +0 -143
  267. data/lib/wx/doc/gen/font_picker_event.rb +0 -65
  268. data/lib/wx/doc/gen/frame.rb +0 -352
  269. data/lib/wx/doc/gen/fs_file.rb +0 -337
  270. data/lib/wx/doc/gen/functions.rb +0 -10
  271. data/lib/wx/doc/gen/gauge.rb +0 -157
  272. data/lib/wx/doc/gen/gb_sizer_item.rb +0 -68
  273. data/lib/wx/doc/gen/gcdc.rb +0 -46
  274. data/lib/wx/doc/gen/gdi_common.rb +0 -1271
  275. data/lib/wx/doc/gen/gdi_object.rb +0 -31
  276. data/lib/wx/doc/gen/generic_about_dialog.rb +0 -140
  277. data/lib/wx/doc/gen/generic_dir_ctrl.rb +0 -223
  278. data/lib/wx/doc/gen/geometry.rb +0 -661
  279. data/lib/wx/doc/gen/graphics_context.rb +0 -1184
  280. data/lib/wx/doc/gen/graphics_object.rb +0 -750
  281. data/lib/wx/doc/gen/grid/event_list.rb +0 -191
  282. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +0 -40
  283. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +0 -280
  284. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +0 -35
  285. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +0 -37
  286. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +0 -49
  287. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +0 -35
  288. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +0 -46
  289. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +0 -38
  290. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +0 -45
  291. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +0 -40
  292. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +0 -197
  293. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +0 -39
  294. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +0 -44
  295. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +0 -45
  296. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +0 -79
  297. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +0 -46
  298. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +0 -35
  299. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +0 -108
  300. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +0 -35
  301. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +0 -49
  302. data/lib/wx/doc/gen/grid/grid_ctrl.rb +0 -3002
  303. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +0 -95
  304. data/lib/wx/doc/gen/grid/grid_event.rb +0 -129
  305. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +0 -104
  306. data/lib/wx/doc/gen/grid/grid_size_event.rb +0 -85
  307. data/lib/wx/doc/gen/grid/grid_string_table.rb +0 -142
  308. data/lib/wx/doc/gen/grid/grid_table_base.rb +0 -317
  309. data/lib/wx/doc/gen/grid/grid_table_message.rb +0 -81
  310. data/lib/wx/doc/gen/grid_bag_sizer.rb +0 -323
  311. data/lib/wx/doc/gen/grid_sizer.rb +0 -195
  312. data/lib/wx/doc/gen/gui_event_loop.rb +0 -159
  313. data/lib/wx/doc/gen/h_scrolled_window.rb +0 -562
  314. data/lib/wx/doc/gen/header_ctrl.rb +0 -880
  315. data/lib/wx/doc/gen/header_ctrl_event.rb +0 -133
  316. data/lib/wx/doc/gen/help_controller.rb +0 -195
  317. data/lib/wx/doc/gen/help_provider.rb +0 -98
  318. data/lib/wx/doc/gen/html/event_list.rb +0 -38
  319. data/lib/wx/doc/gen/html/html_cell.rb +0 -536
  320. data/lib/wx/doc/gen/html/html_cell_event.rb +0 -69
  321. data/lib/wx/doc/gen/html/html_data_object.rb +0 -42
  322. data/lib/wx/doc/gen/html/html_easy_printing.rb +0 -203
  323. data/lib/wx/doc/gen/html/html_help_controller.rb +0 -340
  324. data/lib/wx/doc/gen/html/html_help_data.rb +0 -159
  325. data/lib/wx/doc/gen/html/html_help_window.rb +0 -258
  326. data/lib/wx/doc/gen/html/html_link_event.rb +0 -41
  327. data/lib/wx/doc/gen/html/html_list_box.rb +0 -346
  328. data/lib/wx/doc/gen/html/html_printout.rb +0 -109
  329. data/lib/wx/doc/gen/html/html_window.rb +0 -461
  330. data/lib/wx/doc/gen/hyperlink_ctrl.rb +0 -311
  331. data/lib/wx/doc/gen/hyperlink_event.rb +0 -44
  332. data/lib/wx/doc/gen/icon.rb +0 -267
  333. data/lib/wx/doc/gen/icon_location.rb +0 -40
  334. data/lib/wx/doc/gen/image.rb +0 -1371
  335. data/lib/wx/doc/gen/image_list.rb +0 -168
  336. data/lib/wx/doc/gen/info_bar.rb +0 -195
  337. data/lib/wx/doc/gen/keyboard_state.rb +0 -140
  338. data/lib/wx/doc/gen/list_box.rb +0 -304
  339. data/lib/wx/doc/gen/list_ctrl.rb +0 -1774
  340. data/lib/wx/doc/gen/list_event.rb +0 -208
  341. data/lib/wx/doc/gen/listbook.rb +0 -116
  342. data/lib/wx/doc/gen/locale.rb +0 -4293
  343. data/lib/wx/doc/gen/log.rb +0 -603
  344. data/lib/wx/doc/gen/mdi_client_window.rb +0 -47
  345. data/lib/wx/doc/gen/mdi_frame.rb +0 -324
  346. data/lib/wx/doc/gen/media_ctrl.rb +0 -269
  347. data/lib/wx/doc/gen/media_event.rb +0 -117
  348. data/lib/wx/doc/gen/memory_dc.rb +0 -174
  349. data/lib/wx/doc/gen/menu.rb +0 -509
  350. data/lib/wx/doc/gen/menu_bar.rb +0 -287
  351. data/lib/wx/doc/gen/menu_item.rb +0 -362
  352. data/lib/wx/doc/gen/message_dialog.rb +0 -238
  353. data/lib/wx/doc/gen/mini_frame.rb +0 -108
  354. data/lib/wx/doc/gen/mirror_dc.rb +0 -22
  355. data/lib/wx/doc/gen/mouse_state.rb +0 -150
  356. data/lib/wx/doc/gen/multi_choice_dialog.rb +0 -80
  357. data/lib/wx/doc/gen/non_owned_window.rb +0 -49
  358. data/lib/wx/doc/gen/notebook.rb +0 -278
  359. data/lib/wx/doc/gen/num_validator.rb +0 -37
  360. data/lib/wx/doc/gen/number_entry_dialog.rb +0 -93
  361. data/lib/wx/doc/gen/object.rb +0 -59
  362. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +0 -395
  363. data/lib/wx/doc/gen/paint_dc.rb +0 -27
  364. data/lib/wx/doc/gen/palette.rb +0 -92
  365. data/lib/wx/doc/gen/panel.rb +0 -127
  366. data/lib/wx/doc/gen/pen.rb +0 -511
  367. data/lib/wx/doc/gen/persistence_manager.rb +0 -135
  368. data/lib/wx/doc/gen/persistent_object.rb +0 -52
  369. data/lib/wx/doc/gen/persistent_window.rb +0 -241
  370. data/lib/wx/doc/gen/pg/event_list.rb +0 -106
  371. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +0 -54
  372. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +0 -292
  373. data/lib/wx/doc/gen/pg/pg_cell.rb +0 -177
  374. data/lib/wx/doc/gen/pg/pg_editor.rb +0 -721
  375. data/lib/wx/doc/gen/pg/pg_multi_button.rb +0 -152
  376. data/lib/wx/doc/gen/pg/pg_properties.rb +0 -2829
  377. data/lib/wx/doc/gen/pg/pg_property.rb +0 -2078
  378. data/lib/wx/doc/gen/pg/pg_validation_info.rb +0 -344
  379. data/lib/wx/doc/gen/pg/property_grid.rb +0 -740
  380. data/lib/wx/doc/gen/pg/property_grid_event.rb +0 -184
  381. data/lib/wx/doc/gen/pg/property_grid_interface.rb +0 -1098
  382. data/lib/wx/doc/gen/pg/property_grid_manager.rb +0 -415
  383. data/lib/wx/doc/gen/pg/property_grid_page.rb +0 -354
  384. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +0 -165
  385. data/lib/wx/doc/gen/picker_base.rb +0 -152
  386. data/lib/wx/doc/gen/platform_info.rb +0 -622
  387. data/lib/wx/doc/gen/popup_window.rb +0 -107
  388. data/lib/wx/doc/gen/progress_dialog.rb +0 -100
  389. data/lib/wx/doc/gen/property_sheet_dialog.rb +0 -216
  390. data/lib/wx/doc/gen/prt/event_list.rb +0 -17
  391. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +0 -44
  392. data/lib/wx/doc/gen/prt/post_script_dc.rb +0 -30
  393. data/lib/wx/doc/gen/prt/preview_frame.rb +0 -78
  394. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +0 -151
  395. data/lib/wx/doc/gen/prt/print_data.rb +0 -804
  396. data/lib/wx/doc/gen/prt/print_dialog.rb +0 -55
  397. data/lib/wx/doc/gen/prt/printer.rb +0 -518
  398. data/lib/wx/doc/gen/prt/printer_dc.rb +0 -37
  399. data/lib/wx/doc/gen/query_layout_info_event.rb +0 -106
  400. data/lib/wx/doc/gen/radio_box.rb +0 -306
  401. data/lib/wx/doc/gen/radio_button.rb +0 -159
  402. data/lib/wx/doc/gen/rbn/event_list.rb +0 -136
  403. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +0 -1132
  404. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +0 -308
  405. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +0 -45
  406. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +0 -458
  407. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +0 -63
  408. data/lib/wx/doc/gen/rbn/ribbon_control.rb +0 -143
  409. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +0 -229
  410. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +0 -55
  411. data/lib/wx/doc/gen/rbn/ribbon_page.rb +0 -174
  412. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +0 -270
  413. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +0 -45
  414. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +0 -360
  415. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +0 -42
  416. data/lib/wx/doc/gen/rearrange_ctrl.rb +0 -78
  417. data/lib/wx/doc/gen/rearrange_list.rb +0 -123
  418. data/lib/wx/doc/gen/region.rb +0 -380
  419. data/lib/wx/doc/gen/region_iterator.rb +0 -76
  420. data/lib/wx/doc/gen/rich_tool_tip.rb +0 -154
  421. data/lib/wx/doc/gen/rtc/event_list.rb +0 -125
  422. data/lib/wx/doc/gen/rtc/rich_text_box.rb +0 -445
  423. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +0 -1188
  424. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +0 -41
  425. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +0 -538
  426. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +0 -2103
  427. data/lib/wx/doc/gen/rtc/rich_text_event.rb +0 -173
  428. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +0 -181
  429. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +0 -319
  430. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +0 -193
  431. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +0 -102
  432. data/lib/wx/doc/gen/rtc/rich_text_image.rb +0 -337
  433. data/lib/wx/doc/gen/rtc/rich_text_object.rb +0 -2922
  434. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +0 -1240
  435. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +0 -258
  436. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +0 -344
  437. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +0 -227
  438. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +0 -59
  439. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +0 -169
  440. data/lib/wx/doc/gen/sash_event.rb +0 -147
  441. data/lib/wx/doc/gen/sash_layout_window.rb +0 -232
  442. data/lib/wx/doc/gen/sash_window.rb +0 -171
  443. data/lib/wx/doc/gen/scaled_dc.rb +0 -10
  444. data/lib/wx/doc/gen/screen_dc.rb +0 -30
  445. data/lib/wx/doc/gen/scroll_bar.rb +0 -204
  446. data/lib/wx/doc/gen/scrolled_canvas.rb +0 -410
  447. data/lib/wx/doc/gen/scrolled_control.rb +0 -410
  448. data/lib/wx/doc/gen/scrolled_window.rb +0 -430
  449. data/lib/wx/doc/gen/search_ctrl.rb +0 -159
  450. data/lib/wx/doc/gen/secret_store.rb +0 -116
  451. data/lib/wx/doc/gen/simplebook.rb +0 -110
  452. data/lib/wx/doc/gen/single_choice_dialog.rb +0 -89
  453. data/lib/wx/doc/gen/sizer.rb +0 -945
  454. data/lib/wx/doc/gen/sizer_item.rb +0 -244
  455. data/lib/wx/doc/gen/slider.rb +0 -342
  456. data/lib/wx/doc/gen/spin_button.rb +0 -157
  457. data/lib/wx/doc/gen/spin_ctrl.rb +0 -231
  458. data/lib/wx/doc/gen/spin_ctrl_double.rb +0 -192
  459. data/lib/wx/doc/gen/spin_double_event.rb +0 -55
  460. data/lib/wx/doc/gen/spin_event.rb +0 -51
  461. data/lib/wx/doc/gen/splash_screen.rb +0 -113
  462. data/lib/wx/doc/gen/splitter_event.rb +0 -99
  463. data/lib/wx/doc/gen/splitter_window.rb +0 -498
  464. data/lib/wx/doc/gen/static_bitmap.rb +0 -256
  465. data/lib/wx/doc/gen/static_box.rb +0 -180
  466. data/lib/wx/doc/gen/static_box_sizer.rb +0 -85
  467. data/lib/wx/doc/gen/static_line.rb +0 -83
  468. data/lib/wx/doc/gen/static_text.rb +0 -127
  469. data/lib/wx/doc/gen/status_bar.rb +0 -290
  470. data/lib/wx/doc/gen/stc/event_list.rb +0 -221
  471. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +0 -4474
  472. data/lib/wx/doc/gen/stc/styled_text_event.rb +0 -8762
  473. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +0 -129
  474. data/lib/wx/doc/gen/svg_file_dc.rb +0 -164
  475. data/lib/wx/doc/gen/system_options.rb +0 -129
  476. data/lib/wx/doc/gen/system_settings.rb +0 -507
  477. data/lib/wx/doc/gen/task_bar_icon.rb +0 -127
  478. data/lib/wx/doc/gen/task_bar_icon_event.rb +0 -88
  479. data/lib/wx/doc/gen/text_attr.rb +0 -756
  480. data/lib/wx/doc/gen/text_ctrl.rb +0 -1033
  481. data/lib/wx/doc/gen/text_entry.rb +0 -441
  482. data/lib/wx/doc/gen/text_entry_dialog.rb +0 -220
  483. data/lib/wx/doc/gen/text_validator.rb +0 -245
  484. data/lib/wx/doc/gen/time_picker_ctrl.rb +0 -128
  485. data/lib/wx/doc/gen/timer.rb +0 -119
  486. data/lib/wx/doc/gen/timer_event.rb +0 -68
  487. data/lib/wx/doc/gen/tip_provider.rb +0 -63
  488. data/lib/wx/doc/gen/tip_window.rb +0 -51
  489. data/lib/wx/doc/gen/toggle_button.rb +0 -182
  490. data/lib/wx/doc/gen/tool_bar.rb +0 -890
  491. data/lib/wx/doc/gen/tool_tip.rb +0 -86
  492. data/lib/wx/doc/gen/toolbook.rb +0 -118
  493. data/lib/wx/doc/gen/top_level_window.rb +0 -497
  494. data/lib/wx/doc/gen/tree_ctrl.rb +0 -1052
  495. data/lib/wx/doc/gen/tree_event.rb +0 -127
  496. data/lib/wx/doc/gen/treebook.rb +0 -180
  497. data/lib/wx/doc/gen/ui_action_simulator.rb +0 -109
  498. data/lib/wx/doc/gen/utils.rb +0 -273
  499. data/lib/wx/doc/gen/v_list_box.rb +0 -272
  500. data/lib/wx/doc/gen/v_scrolled_canvas.rb +0 -195
  501. data/lib/wx/doc/gen/v_scrolled_window.rb +0 -191
  502. data/lib/wx/doc/gen/validator.rb +0 -68
  503. data/lib/wx/doc/gen/variant.rb +0 -294
  504. data/lib/wx/doc/gen/window.rb +0 -2917
  505. data/lib/wx/doc/gen/window_dc.rb +0 -38
  506. data/lib/wx/doc/gen/window_disabler.rb +0 -30
  507. data/lib/wx/doc/gen/with_images.rb +0 -84
  508. data/lib/wx/doc/gen/wizard.rb +0 -257
  509. data/lib/wx/doc/gen/wizard_event.rb +0 -113
  510. data/lib/wx/doc/gen/wizard_page.rb +0 -65
  511. data/lib/wx/doc/gen/wizard_page_simple.rb +0 -88
  512. data/lib/wx/doc/gen/wrap_sizer.rb +0 -79
  513. data/lib/wx/doc/gen/xml_node.rb +0 -316
  514. data/lib/wx/doc/gen/xml_resource.rb +0 -320
  515. data/lib/wx/grid/events/evt_list.rb +0 -166
  516. data/lib/wx/html/events/evt_list.rb +0 -27
  517. data/lib/wx/pg/events/evt_list.rb +0 -73
  518. data/lib/wx/rbn/events/evt_list.rb +0 -102
  519. data/lib/wx/rtc/events/evt_list.rb +0 -98
  520. data/lib/wx/rtc/ext/rich_text_ctrl.rb +0 -24
  521. data/lib/wx/stc/events/evt_list.rb +0 -178
  522. data/samples/art/wxruby-512x512.png +0 -0
@@ -1,287 +0,0 @@
1
- # :stopdoc:
2
- # This file is automatically generated by the WXRuby3 documentation
3
- # generator. Do not alter this file.
4
- # :startdoc:
5
-
6
-
7
- module Wx
8
-
9
- # A menu bar is a series of menus accessible from the top of a frame.
10
- #
11
- # <div class="wxrb-remark">
12
- # <b>Remark:</b>
13
- # <p>To respond to a menu selection, provide a handler for EVT_MENU, in the frame that contains the menu bar.
14
- # </p>
15
- # </div>
16
- #
17
- # If you have a toolbar which uses the same identifiers as your EVT_MENU entries, events from the toolbar will also be processed by your EVT_MENU event handlers.
18
- # Tip: under Windows, if you discover that menu shortcuts (for example, Alt-F to show the file menu) are not working, check any EVT_CHAR events you are handling in child windows. If you are not calling event.Skip() for events that you don't process in these event handlers, menu shortcuts may cease to work.
19
- #
20
- # Category: {Wx::Menus}
21
- # @see Wx::Menu
22
- # @see Events and Event Handling
23
- #
24
- #
25
- # @wxrb_require USE_MENUBAR
26
- class MenuBar < Window
27
-
28
- # @overload initialize(style=0)
29
- # Construct an empty menu bar.
30
- # @param style [Integer] If {Wx::MB_DOCKABLE} the menu bar can be detached (WXGTK only).
31
- # @return [Wx::MenuBar]
32
- # @overload initialize(style=0, &block)
33
- # Construct an empty menu bar.
34
- # @param style [Integer] If {Wx::MB_DOCKABLE} the menu bar can be detached (WXGTK only).
35
- # @yieldparam [Wx::MenuBar] win new instance
36
- # @return [Wx::MenuBar]
37
- def initialize(*args) end
38
-
39
- # Adds the item to the end of the menu bar.
40
- #
41
- # true on success, false if an error occurred.
42
- # @see Wx::MenuBar#insert
43
- # @param menu [Wx::Menu] The menu to add. Do not deallocate this menu after calling {Wx::MenuBar#append}.
44
- # @param title [String] The title of the menu, must be non-empty.
45
- # @return [Boolean]
46
- def append(menu, title) end
47
-
48
- # Checks or unchecks a menu item.
49
- #
50
- # <div class="wxrb-remark">
51
- # <b>Remark:</b>
52
- # <p>Only use this when the menu bar has been associated with a frame; otherwise, use the {Wx::Menu} equivalent call.
53
- # </p>
54
- # </div>
55
- # @param id [Integer] The menu item identifier.
56
- # @param check [Boolean] If true, checks the menu item, otherwise the item is unchecked.
57
- # @return [void]
58
- def check(id, check) end
59
-
60
- # Enables or disables (greys out) a menu item.
61
- #
62
- # <div class="wxrb-remark">
63
- # <b>Remark:</b>
64
- # <p>Only use this when the menu bar has been associated with a frame; otherwise, use the {Wx::Menu} equivalent call.
65
- # </p>
66
- # </div>
67
- # @param id [Integer] The menu item identifier.
68
- # @param enable [Boolean] true to enable the item, false to disable it.
69
- # @return [void]
70
- def enable(id, enable) end
71
-
72
- # Returns true if the menu with the given index is enabled.
73
- # @param pos [Integer] The menu position (0-based)
74
- # @return [Boolean]
75
- def is_enabled_top(pos) end
76
- alias_method :enabled_top?, :is_enabled_top
77
-
78
- # Enables or disables a whole menu.
79
- #
80
- # <div class="wxrb-remark">
81
- # <b>Remark:</b>
82
- # <p>Only use this when the menu bar has been associated with a frame.
83
- # </p>
84
- # </div>
85
- # @param pos [Integer] The position of the menu, starting from zero.
86
- # @param enable [Boolean] true to enable the menu, false to disable it.
87
- # @return [void]
88
- def enable_top(pos, enable) end
89
-
90
- # Finds the menu item object associated with the given menu item identifier.
91
- #
92
- # The found menu item object, or nil if one was not found.
93
- # @param id [Integer] Menu item identifier.
94
- # @return [Array(Wx::MenuItem,Wx::Menu)]
95
- def find_item(id) end
96
-
97
- # Returns the index of the menu with the given title or {Wx::NOT_FOUND} if no such menu exists in this menubar.
98
- #
99
- # The title parameter may specify either the menu title (with accelerator characters, i.e. <code>"&File"</code>) or just the menu label (<code>"File"</code>) indifferently.
100
- # @param title [String]
101
- # @return [Integer]
102
- def find_menu(title) end
103
-
104
- # Finds the menu item id for a menu name/menu item string pair.
105
- #
106
- # The menu item identifier, or {Wx::NOT_FOUND} if none was found.
107
- #
108
- # <div class="wxrb-remark">
109
- # <b>Remark:</b>
110
- # <p>Any special menu codes are stripped out of source and target strings before matching.
111
- # </p>
112
- # </div>
113
- # @param menuString [String] Menu title to find.
114
- # @param itemString [String] Item to find.
115
- # @return [Integer]
116
- def find_menu_item(menuString, itemString) end
117
-
118
- # Gets the help string associated with the menu item identifier.
119
- #
120
- # The help string, or the empty string if there was no help string or the menu item was not found.
121
- # @see Wx::MenuBar#set_help_string
122
- # @param id [Integer] The menu item identifier.
123
- # @return [String]
124
- def get_help_string(id) end
125
- alias_method :help_string, :get_help_string
126
-
127
- # Gets the label associated with a menu item.
128
- #
129
- # The menu item label, or the empty string if the item was not found.
130
- #
131
- # <div class="wxrb-remark">
132
- # <b>Remark:</b>
133
- # <p>Use only after the menubar has been associated with a frame.
134
- # </p>
135
- # </div>
136
- # @param id [Integer] The menu item identifier.
137
- # @return [String]
138
- def get_label(id) end
139
- alias_method :label, :get_label
140
-
141
- # Returns the menu at menuIndex (zero-based).
142
- # @param menuIndex [Integer]
143
- # @return [Wx::Menu]
144
- def get_menu(menuIndex) end
145
- alias_method :menu, :get_menu
146
-
147
- # Returns the number of menus in this menubar.
148
- # @return [Integer]
149
- def get_menu_count; end
150
- alias_method :menu_count, :get_menu_count
151
-
152
- # Returns the label of a top-level menu.
153
- #
154
- # Note that the returned string includes the accelerator characters that have been specified in the menu title string during its construction.
155
- #
156
- # The menu label, or the empty string if the menu was not found.
157
- #
158
- # <div class="wxrb-remark">
159
- # <b>Remark:</b>
160
- # <p>Use only after the menubar has been associated with a frame.
161
- # </p>
162
- # </div>
163
- # @see Wx::MenuBar#get_menu_label_text
164
- # @see Wx::MenuBar#set_menu_label
165
- # @param pos [Integer] Position of the menu on the menu bar, starting from zero.
166
- # @return [String]
167
- def get_menu_label(pos) end
168
- alias_method :menu_label, :get_menu_label
169
-
170
- # Returns the label of a top-level menu.
171
- #
172
- # Note that the returned string does not include any accelerator characters that may have been specified in the menu title string during its construction.
173
- #
174
- # The menu label, or the empty string if the menu was not found.
175
- #
176
- # <div class="wxrb-remark">
177
- # <b>Remark:</b>
178
- # <p>Use only after the menubar has been associated with a frame.
179
- # </p>
180
- # </div>
181
- # @see Wx::MenuBar#get_menu_label
182
- # @see Wx::MenuBar#set_menu_label
183
- # @param pos [Integer] Position of the menu on the menu bar, starting from zero.
184
- # @return [String]
185
- def get_menu_label_text(pos) end
186
- alias_method :menu_label_text, :get_menu_label_text
187
-
188
- # Inserts the menu at the given position into the menu bar.
189
- #
190
- # Inserting menu at position 0 will insert it in the very beginning of it, inserting at position {Wx::MenuBar#get_menu_count} is the same as calling {Wx::MenuBar#append}.
191
- #
192
- # true on success, false if an error occurred.
193
- # @see Wx::MenuBar#append
194
- # @param pos [Integer] The position of the new menu in the menu bar
195
- # @param menu [Wx::Menu] The menu to add. {Wx::MenuBar} owns the menu and will free it.
196
- # @param title [String] The title of the menu.
197
- # @return [Boolean]
198
- def insert(pos, menu, title) end
199
-
200
- # Determines whether an item is checked.
201
- #
202
- # true if the item was found and is checked, false otherwise.
203
- # @param id [Integer] The menu item identifier.
204
- # @return [Boolean]
205
- def is_checked(id) end
206
- alias_method :checked?, :is_checked
207
-
208
- # Determines whether an item is enabled.
209
- #
210
- # true if the item was found and is enabled, false otherwise.
211
- # @param id [Integer] The menu item identifier.
212
- # @return [Boolean]
213
- def is_enabled(id) end
214
- alias_method :enabled?, :is_enabled
215
-
216
- # Removes the menu from the menu bar and returns the menu object - the caller is responsible for deleting it.
217
- #
218
- # This function may be used together with {Wx::MenuBar#insert} to change the menubar dynamically.
219
- # @see Wx::MenuBar#replace
220
- # @param pos [Integer]
221
- # @return [Wx::Menu]
222
- def remove(pos) end
223
-
224
- # Replaces the menu at the given position with another one.
225
- #
226
- # The menu which was previously at position pos. The caller is responsible for deleting it.
227
- # @see Wx::MenuBar#insert
228
- # @see Wx::MenuBar#remove
229
- # @param pos [Integer] The position of the new menu in the menu bar
230
- # @param menu [Wx::Menu] The menu to add.
231
- # @param title [String] The title of the menu.
232
- # @return [Wx::Menu]
233
- def replace(pos, menu, title) end
234
-
235
- # Sets the help string associated with a menu item.
236
- #
237
- #
238
- # @see Wx::MenuBar#get_help_string
239
- # @param id [Integer] Menu item identifier.
240
- # @param helpString [String] Help string to associate with the menu item.
241
- # @return [void]
242
- def set_help_string(id, helpString) end
243
-
244
- # Sets the label of a menu item.
245
- #
246
- # <div class="wxrb-remark">
247
- # <b>Remark:</b>
248
- # <p>Use only after the menubar has been associated with a frame.
249
- # </p>
250
- # </div>
251
- # @see Wx::MenuBar#get_label
252
- # @param id [Integer] Menu item identifier.
253
- # @param label [String] Menu item label.
254
- # @return [void]
255
- def set_label(id, label) end
256
-
257
- # Sets the label of a top-level menu.
258
- #
259
- # <div class="wxrb-remark">
260
- # <b>Remark:</b>
261
- # <p>Use only after the menubar has been associated with a frame.
262
- # </p>
263
- # </div>
264
- # @param pos [Integer] The position of a menu on the menu bar, starting from zero.
265
- # @param label [String] The menu label.
266
- # @return [void]
267
- def set_menu_label(pos, label) end
268
-
269
- # @return [Wx::Frame]
270
- def get_frame; end
271
- alias_method :frame, :get_frame
272
-
273
- # @return [Boolean]
274
- def is_attached; end
275
- alias_method :attached?, :is_attached
276
-
277
- # @param frame [Wx::Frame]
278
- # @return [void]
279
- def attach(frame) end
280
-
281
- # @return [void]
282
- def detach; end
283
-
284
- end # MenuBar
285
-
286
-
287
- end
@@ -1,362 +0,0 @@
1
- # :stopdoc:
2
- # This file is automatically generated by the WXRuby3 documentation
3
- # generator. Do not alter this file.
4
- # :startdoc:
5
-
6
-
7
- module Wx
8
-
9
- # A menu item represents an item in a menu.
10
- #
11
- # Note that you usually don't have to deal with it directly as {Wx::Menu} methods usually construct an object of this class for you.
12
- # ### Events emitted by this class
13
- #
14
- # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MenuEvent} events.
15
- # Event handler methods for events emitted by this class:
16
- #
17
- # - {Wx::EvtHandler#evt_menu}(id, meth = nil, &block): Process a {Wx::EVT_MENU} command, which is generated by a menu item. This type of event is sent as {Wx::CommandEvent}.
18
- #
19
- # - {Wx::EvtHandler#evt_menu_range}(id1, id2, meth = nil, &block): Process a {Wx::EVT_MENU} command, which is generated by a range of menu items. This type of event is sent as {Wx::CommandEvent}.
20
- #
21
- # - {Wx::EvtHandler#evt_menu_open}(meth = nil, &block): A menu is about to be opened. On Windows, this is only sent once for each navigation of the menubar (up until all menus have closed). This type of event is sent as {Wx::MenuEvent}.
22
- #
23
- # - {Wx::EvtHandler#evt_menu_close}(meth = nil, &block): A menu has been just closed. This type of event is sent as {Wx::MenuEvent}.
24
- #
25
- # - {Wx::EvtHandler#evt_menu_highlight}(id, meth = nil, &block): The menu item with the specified id has been highlighted. If the id is {Wx::StandardID::ID_NONE}, highlighting has been removed from the previously highlighted menu item and there is no highlighted item any more. This is used by {Wx::Frame} to show help prompts in the status bar. This type of event is sent as {Wx::MenuEvent}.
26
- #
27
- # - {Wx::EvtHandler#evt_menu_highlight_all}(meth = nil, &block): A menu item has been highlighted, i.e. the currently selected menu item has changed. This type of event is sent as {Wx::MenuEvent}.
28
- #
29
- # ## Customizing Menu Items Appearance
30
- # This class provides several functions for customizing the menu items appearance that are available only in WXMSW port. These functions should not be used in portable programs and, moreover, have some known limitations even in WXMSW: using them switches the menu item in an "owner drawn" mode, where it is painted by wxWidgets itself and not the system, which may result in a slightly different appearance for it. Owner drawn items are also incompatible with dark mode support and using them makes the entire menu containing them to use standard light mode colours even in dark mode.
31
- #
32
- # Category: {Wx::Menus}
33
- # @see Wx::MenuBar
34
- # @see Wx::Menu
35
- #
36
- #
37
- # @wxrb_require USE_MENUS
38
- class MenuItem < Object
39
-
40
- # Returns the item bitmap.
41
- #
42
- # This method exists only for compatibility, please use {Wx::MenuItem#get_bitmap_bundle} in the new code.
43
- # @return [Wx::Bitmap]
44
- def get_bitmap; end
45
- alias_method :bitmap, :get_bitmap
46
-
47
- # Returns the bitmap bundle containing the bitmap used for this item.
48
- #
49
- # The returned bundle is invalid, i.e. empty, if no bitmap is associated with the item.
50
- # @see Wx::MenuItem#set_bitmap
51
- # @return [Wx::BitmapBundle]
52
- def get_bitmap_bundle; end
53
- alias_method :bitmap_bundle, :get_bitmap_bundle
54
-
55
- # Returns the help string associated with the menu item.
56
- # @return [Wx::String]
57
- def get_help; end
58
- alias_method :help, :get_help
59
-
60
- # Returns the menu item identifier.
61
- # @return [Integer]
62
- def get_id; end
63
- alias_method :id, :get_id
64
-
65
- # Returns the text associated with the menu item including any accelerator characters that were passed to the constructor or {Wx::MenuItem#set_item_label}.
66
- #
67
- #
68
- # @see Wx::MenuItem#get_item_label_text
69
- # @see Wx::MenuItem.get_label_text
70
- # @return [String]
71
- def get_item_label; end
72
- alias_method :item_label, :get_item_label
73
-
74
- # Returns the text associated with the menu item, without any accelerator characters.
75
- #
76
- #
77
- # @see Wx::MenuItem#get_item_label
78
- # @see Wx::MenuItem.get_label_text
79
- # @return [String]
80
- def get_item_label_text; end
81
- alias_method :item_label_text, :get_item_label_text
82
-
83
- # Returns the item kind, one of {Wx::ItemKind::ITEM_SEPARATOR}, {Wx::ItemKind::ITEM_NORMAL}, {Wx::ItemKind::ITEM_CHECK} or {Wx::ItemKind::ITEM_RADIO}.
84
- # @return [Wx::ItemKind]
85
- def get_kind; end
86
- alias_method :kind, :get_kind
87
-
88
- # Returns the menu this menu item is in, or nil if this menu item is not attached.
89
- # @return [Wx::Menu]
90
- def get_menu; end
91
- alias_method :menu, :get_menu
92
-
93
- # Returns the submenu associated with the menu item, or nil if there isn't one.
94
- # @return [Wx::Menu]
95
- def get_sub_menu; end
96
- alias_method :sub_menu, :get_sub_menu
97
-
98
- # Get our accelerator or nil (caller must delete the pointer).
99
- # @return [Wx::AcceleratorEntry]
100
- # @wxrb_require USE_ACCEL
101
- def get_accel; end
102
- alias_method :accel, :get_accel
103
-
104
- # Returns true if the item is a check item.
105
- #
106
- # Unlike {Wx::MenuItem#is_checkable} this doesn't return true for the radio buttons.
107
- # @return [Boolean]
108
- def is_check; end
109
- alias_method :check?, :is_check
110
-
111
- # Returns true if the item is checkable.
112
- #
113
- # Notice that the radio buttons are considered to be checkable as well, so this method returns true for them too. Use {Wx::MenuItem#is_check} if you want to test for the check items only.
114
- # @return [Boolean]
115
- def is_checkable; end
116
- alias_method :checkable?, :is_checkable
117
-
118
- # Returns true if the item is checked.
119
- # @return [Boolean]
120
- def is_checked; end
121
- alias_method :checked?, :is_checked
122
-
123
- # Returns true if the item is enabled.
124
- # @return [Boolean]
125
- def is_enabled; end
126
- alias_method :enabled?, :is_enabled
127
-
128
- # Returns true if the item is a radio button.
129
- # @return [Boolean]
130
- def is_radio; end
131
- alias_method :radio?, :is_radio
132
-
133
- # Returns true if the item is a separator.
134
- # @return [Boolean]
135
- def is_separator; end
136
- alias_method :separator?, :is_separator
137
-
138
- # Returns true if the item is a submenu.
139
- # @return [Boolean]
140
- def is_sub_menu; end
141
- alias_method :sub_menu?, :is_sub_menu
142
-
143
- # Sets the bitmap for the menu item.
144
- #
145
- # Notice that GTK+ uses a global setting called <code>gtk-menu-images</code> to determine if the images should be shown in the menus at all. If it is off (which is the case in e.g. Gnome 2.28 by default), no images will be shown, consistently with the native behaviour.
146
- # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
147
- # @return [void]
148
- def set_bitmap(bmp) end
149
- alias_method :bitmap=, :set_bitmap
150
-
151
- # Sets the help string.
152
- # @param helpString [String]
153
- # @return [void]
154
- def set_help(helpString) end
155
- alias_method :help=, :set_help
156
-
157
- # Sets the label associated with the menu item.
158
- #
159
- # Note that if the ID of this menu item corresponds to a stock ID, then it is not necessary to specify a label: wxWidgets will automatically use the stock item label associated with that ID. See the {Wx::constructor} for more info.
160
- # The label string for the normal menu items (not separators) may include the accelerator which can be used to activate the menu item from keyboard. An accelerator key can be specified using the ampersand <code>&</code> character. In order to embed an ampersand character in the menu item text, the ampersand must be doubled.
161
- # Optionally you can specify also an accelerator string appending a tab character <code>\t</code> followed by a valid key combination (e.g. <code>CTRL+V</code>). Its general syntax is any combination of <code>"CTRL"</code>, <code>"RAWCTRL"</code>, <code>"ALT"</code> and <code>"SHIFT"</code> strings (case doesn't matter) separated by either <code>'-'</code> or <code>'+'</code> characters and followed by the accelerator itself. Note that the displayed accelerator can differ from the string specified here though, e.g. <code>Ctrl+X</code> could be actually shown on the screen when <code>Ctrl-X</code> is used. Notice that CTRL corresponds to the "Ctrl" key on most platforms but not under macOS where it is mapped to "Cmd" key on Mac keyboard. Usually this is exactly what you want in portable code but if you really need to use the (rarely used for this purpose) "Ctrl" key even under Mac, you may use RAWCTRL to prevent this mapping. Under the other platforms RAWCTRL is the same as plain CTRL.
162
- # The accelerator may be any alphanumeric character, any function key (from F1 to F12), any numpad digit key using KP_ prefix (i.e. from KP_0 to KP_9) or one of the special strings listed below (again, case doesn't matter) corresponding to the specified key code:
163
- #
164
- # - Del or Delete: {Wx::KeyCode::K_DELETE}
165
- # - Back: {Wx::KeyCode::K_BACK}
166
- # - Ins or Insert: {Wx::KeyCode::K_INSERT}
167
- # - Enter or Return: {Wx::KeyCode::K_RETURN}
168
- # - PgUp or PageUp: {Wx::KeyCode::K_PAGEUP}
169
- # - PgDn or PageDown: {Wx::KeyCode::K_PAGEDOWN}
170
- # - Left: {Wx::KeyCode::K_LEFT}
171
- # - Right: {Wx::KeyCode::K_RIGHT}
172
- # - Up: {Wx::KeyCode::K_UP}
173
- # - Down: {Wx::KeyCode::K_DOWN}
174
- # - Home: {Wx::KeyCode::K_HOME}
175
- # - End: {Wx::KeyCode::K_END}
176
- # - Space: {Wx::KeyCode::K_SPACE}
177
- # - Tab: {Wx::KeyCode::K_TAB}
178
- # - Esc or Escape: {Wx::KeyCode::K_ESCAPE}
179
- # - Cancel: {Wx::KeyCode::K_CANCEL}
180
- # - Clear: {Wx::KeyCode::K_CLEAR}
181
- # - Menu: {Wx::KeyCode::K_MENU}
182
- # - Pause: {Wx::KeyCode::K_PAUSE}
183
- # - Capital: {Wx::KeyCode::K_CAPITAL}
184
- # - Select: {Wx::KeyCode::K_SELECT}
185
- # - Print: {Wx::KeyCode::K_PRINT}
186
- # - Execute: {Wx::KeyCode::K_EXECUTE}
187
- # - Snapshot: {Wx::KeyCode::K_SNAPSHOT}
188
- # - Help: {Wx::KeyCode::K_HELP}
189
- # - Add: {Wx::KeyCode::K_ADD}
190
- # - Separator: {Wx::KeyCode::K_SEPARATOR}
191
- # - Subtract: {Wx::KeyCode::K_SUBTRACT}
192
- # - Decimal: {Wx::KeyCode::K_DECIMAL}
193
- # - Divide: {Wx::KeyCode::K_DIVIDE}
194
- # - Num_lock: {Wx::KeyCode::K_NUMLOCK}
195
- # - Scroll_lock: {Wx::KeyCode::K_SCROLL}
196
- # - KP_Space: {Wx::KeyCode::K_NUMPAD}_SPACE
197
- # - KP_Tab: {Wx::KeyCode::K_NUMPAD}_TAB
198
- # - KP_Enter: {Wx::KeyCode::K_NUMPAD}_ENTER
199
- # - KP_Home: {Wx::KeyCode::K_NUMPAD}_HOME
200
- # - KP_Left: {Wx::KeyCode::K_NUMPAD}_LEFT
201
- # - KP_Up: {Wx::KeyCode::K_NUMPAD}_UP
202
- # - KP_Right: {Wx::KeyCode::K_NUMPAD}_RIGHT
203
- # - KP_Down: {Wx::KeyCode::K_NUMPAD}_DOWN
204
- # - KP_PageUp: {Wx::KeyCode::K_NUMPAD}_PAGEUP
205
- # - KP_PageDown: {Wx::KeyCode::K_NUMPAD}_PAGEDOWN
206
- # - KP_Prior: {Wx::KeyCode::K_NUMPAD}_PAGEUP
207
- # - KP_Next: {Wx::KeyCode::K_NUMPAD}_PAGEDOWN
208
- # - KP_End: {Wx::KeyCode::K_NUMPAD}_END
209
- # - KP_Begin: {Wx::KeyCode::K_NUMPAD}_BEGIN
210
- # - KP_Insert: {Wx::KeyCode::K_NUMPAD}_INSERT
211
- # - KP_Delete: {Wx::KeyCode::K_NUMPAD}_DELETE
212
- # - KP_Equal: {Wx::KeyCode::K_NUMPAD}_EQUAL
213
- # - KP_Multiply: {Wx::KeyCode::K_NUMPAD}_MULTIPLY
214
- # - KP_Add: {Wx::KeyCode::K_NUMPAD}_ADD
215
- # - KP_Separator: {Wx::KeyCode::K_NUMPAD}_SEPARATOR
216
- # - KP_Subtract: {Wx::KeyCode::K_NUMPAD}_SUBTRACT
217
- # - KP_Decimal: {Wx::KeyCode::K_NUMPAD}_DECIMAL
218
- # - KP_Divide: {Wx::KeyCode::K_NUMPAD}_DIVIDE
219
- # - Windows_Left: {Wx::KeyCode::K_WINDOWS}_LEFT
220
- # - Windows_Right: {Wx::KeyCode::K_WINDOWS}_RIGHT
221
- # - Windows_Menu: {Wx::KeyCode::K_WINDOWS}_MENU
222
- # - Command: {Wx::KeyCode::K_COMMAND}
223
- #
224
- # Examples:
225
- #
226
- # ```ruby
227
- # @my_menu_item.set_item_label("My &item\tCTRL+I")
228
- # @my_menu_item2.set_item_label("Clean && build\tF7")
229
- # @my_menu_item3.set_item_label("Simple item")
230
- # @my_menu_item4.set_item_label("Item with &accelerator")
231
- # ```
232
- #
233
- # <div class="wxrb-note">
234
- # <b>Note:</b>
235
- # <p>In WXGTK using <code>"SHIFT"</code> with non-alphabetic characters currently doesn't work, even in combination with other modifiers, due to GTK+ limitation. E.g. <code>Shift+Ctrl+A</code> works but <code>Shift+Ctrl+1</code> or <code>Shift+/</code> do not, so avoid using accelerators of this form in portable code.
236
- # </p>
237
- # </div>
238
- #
239
- # <div class="wxrb-note">
240
- # <b>Note:</b>
241
- # <p>In {Wx::GTk}, the left/right/up/down arrow keys do not work as accelerator keys for a menu item unless a modifier key is used. Additionally, the following keycodes are not supported as menu accelerator keys:
242
- #
243
- # - {Wx::KeyCode::K_COMMAND}/{Wx::KeyCode::K_CONTROL}
244
- # - {Wx::KeyCode::K_SHIFT}
245
- # - {Wx::KeyCode::K_ALT}
246
- # - {Wx::KeyCode::K_SCROLL}
247
- # - {Wx::KeyCode::K_CAPITAL}
248
- # - {Wx::KeyCode::K_NUMLOCK}
249
- # - {Wx::KeyCode::K_NUMPAD}_TAB
250
- # - {Wx::KeyCode::K_TAB}
251
- # - {Wx::KeyCode::K_WINDOWS}_LEFT
252
- # - {Wx::KeyCode::K_WINDOWS}_RIGHT
253
- # - {Wx::KeyCode::K_ADD}
254
- # - {Wx::KeyCode::K_SEPARATOR}
255
- # - {Wx::KeyCode::K_SUBTRACT}
256
- # - {Wx::KeyCode::K_DECIMAL}
257
- # - {Wx::KeyCode::K_DIVIDE}
258
- # - {Wx::KeyCode::K_SNAPSHOT}
259
- #
260
- # </p>
261
- # </div>
262
- # @see Wx::MenuItem#get_item_label
263
- # @see Wx::MenuItem#get_item_label_text
264
- # @param label [String]
265
- # @return [void]
266
- def set_item_label(label) end
267
- alias_method :item_label=, :set_item_label
268
-
269
- # Sets the parent menu which will contain this menu item.
270
- # @param menu [Wx::Menu]
271
- # @return [void]
272
- def set_menu(menu) end
273
- alias_method :menu=, :set_menu
274
-
275
- # Sets the submenu of this menu item.
276
- # @param menu [Wx::Menu]
277
- # @return [void]
278
- def set_sub_menu(menu) end
279
-
280
- # Set the accel for this item - this may also be done indirectly with {Wx::MenuItem#set_text}.
281
- # @param accel [Wx::AcceleratorEntry]
282
- # @return [void]
283
- def set_accel(accel) end
284
- alias_method :accel=, :set_accel
285
-
286
- # Add an extra accelerator for this menu item.
287
- #
288
- # Additional accelerators are not shown in the item's label, but still will trigger the menu command when pressed.
289
- # They can be useful to let multiple keys be used as accelerators for the same command, e.g. {Wx::KeyCode::K_ADD} and {Wx::KeyCode::K_NUMPAD}_ADD.
290
- # Availability: only available for the WXMSW, WXGTK ports.
291
- # @param accel [Wx::AcceleratorEntry]
292
- # @return [void]
293
- # @wxrb_require WXMSW|WXGTK
294
- def add_extra_accel(accel) end
295
-
296
- # Clear the extra accelerators list.
297
- #
298
- # This doesn't affect the main item accelerator (if any).
299
- # @return [void]
300
- def clear_extra_accels; end
301
-
302
- # Constructs a {Wx::MenuItem} object.
303
- #
304
- # Menu items can be standard, or "stock menu items", or custom. For the standard menu items (such as commands to open a file, exit the program and so on, see Stock Items for the full list) it is enough to specify just the stock ID and leave text and helpString empty. Some platforms (currently WXGTK only, and see the remark in {Wx::MenuItem#set_bitmap} documentation) will also show standard bitmaps for stock menu items.
305
- # Leaving at least text empty for the stock menu items is actually strongly recommended as they will have appearance and keyboard interface (including standard accelerators) familiar to the user.
306
- # For the custom (non-stock) menu items, text must be specified and while helpString may be left empty, it's recommended to pass the item description (which is automatically shown by the library in the status bar when the menu item is selected) in this parameter.
307
- # Finally note that you can e.g. use a stock menu label without using its stock help string:
308
- #
309
- # ```ruby
310
- # # use all stock properties:
311
- # helpMenu.append(wxID_ABOUT)
312
- #
313
- # # use the stock label and the stock accelerator but not the stock help string:
314
- # helpMenu.append(Wx::ID_ABOUT, "", "My custom help string")
315
- #
316
- # # use all stock properties except for the bitmap:
317
- # mymenu = Wx::MenuItem.new(helpMenu, Wx::ID_ABOUT)
318
- # mymenu.set_bitmap(Wx::ArtProvider.get_bitmap(Wx::ART_WARNING))
319
- # helpMenu.append(mymenu)
320
- # ```
321
- #
322
- # that is, stock properties are set independently one from the other.
323
- # @param parentMenu [Wx::Menu] Menu that the menu item belongs to. Can be nil if the item is going to be added to the menu later.
324
- # @param id [Integer] Identifier for this menu item. May be {Wx::StandardID::ID_SEPARATOR}, in which case the given kind is ignored and taken to be {Wx::ItemKind::ITEM_SEPARATOR} instead.
325
- # @param text [String] Text for the menu item, as shown on the menu. See {Wx::MenuItem#set_item_label} for more info.
326
- # @param helpString [String] Optional help string that will be shown on the status bar.
327
- # @param kind [Wx::ItemKind] May be {Wx::ItemKind::ITEM_SEPARATOR}, {Wx::ItemKind::ITEM_NORMAL}, {Wx::ItemKind::ITEM_CHECK} or {Wx::ItemKind::ITEM_RADIO}.
328
- # @param subMenu [Wx::Menu] If non-null, indicates that the menu item is a submenu.
329
- # @return [Wx::MenuItem]
330
- def initialize(parentMenu=nil, id=Wx::StandardID::ID_SEPARATOR, text=(''), helpString=(''), kind=Wx::ItemKind::ITEM_NORMAL, subMenu=nil) end
331
-
332
- # Checks or unchecks the menu item.
333
- #
334
- # Note that this only works when the item is already appended to a menu.
335
- # @param check [Boolean]
336
- # @return [void]
337
- def check(check=true) end
338
-
339
- # Enables or disables the menu item.
340
- # @param enable [Boolean]
341
- # @return [void]
342
- def enable(enable=true) end
343
-
344
- # Strips all accelerator characters and mnemonics from the given text.
345
- #
346
- # For example:
347
- #
348
- # ```ruby
349
- # Wx::MenuItem.get_label_text("&Hello\tCtrl-h")
350
- # ```
351
- #
352
- # will return just <code>"Hello"</code>.
353
- # @see Wx::MenuItem#get_item_label_text
354
- # @see Wx::MenuItem#get_item_label
355
- # @param text [String]
356
- # @return [String]
357
- def self.get_label_text(text) end
358
-
359
- end # MenuItem
360
-
361
-
362
- end