wxruby3 0.9.0.pre.rc.2-x64-mingw-ucrt → 0.9.0.pre.rc.3-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (341) hide show
  1. checksums.yaml +4 -4
  2. data/INSTALL.md +30 -8
  3. data/README.md +3 -3
  4. data/ext/wxbase32u_gcc_custom.dll +0 -0
  5. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  6. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  7. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  19. data/lib/wx/core/event_loop.rb +7 -0
  20. data/lib/wx/core/image.rb +33 -0
  21. data/lib/wx/core/listctrl.rb +17 -13
  22. data/lib/wx/core/log.rb +90 -0
  23. data/lib/wx/doc/bitmap.rb +11 -15
  24. data/lib/wx/doc/event_loop.rb +7 -0
  25. data/lib/wx/doc/extra/00_starting.md +6 -6
  26. data/lib/wx/doc/extra/02_lifecycles.md +9 -8
  27. data/lib/wx/doc/extra/09_exceptions.md +1 -1
  28. data/lib/wx/doc/extra/11_drawing_and_dc.md +4 -4
  29. data/lib/wx/doc/font.rb +1 -1
  30. data/lib/wx/doc/functions.rb +51 -23
  31. data/lib/wx/doc/gc_dc.rb +1 -1
  32. data/lib/wx/doc/gen/about_dialog_info.rb +1 -1
  33. data/lib/wx/doc/gen/accelerator.rb +6 -6
  34. data/lib/wx/doc/gen/accessible.rb +6 -2
  35. data/lib/wx/doc/gen/activity_indicator.rb +5 -5
  36. data/lib/wx/doc/gen/animation.rb +7 -7
  37. data/lib/wx/doc/gen/animation_ctrl.rb +7 -6
  38. data/lib/wx/doc/gen/any_button.rb +1 -1
  39. data/lib/wx/doc/gen/app.rb +17 -11
  40. data/lib/wx/doc/gen/art_provider.rb +61 -1
  41. data/lib/wx/doc/gen/aui/aui_dock_art.rb +12 -12
  42. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +6 -6
  43. data/lib/wx/doc/gen/aui/aui_manager.rb +45 -27
  44. data/lib/wx/doc/gen/aui/aui_manager_event.rb +12 -6
  45. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +6 -6
  46. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +6 -6
  47. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +10 -10
  48. data/lib/wx/doc/gen/aui/aui_notebook.rb +34 -7
  49. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +17 -2
  50. data/lib/wx/doc/gen/aui/aui_pane_info.rb +51 -51
  51. data/lib/wx/doc/gen/aui/aui_tab_art.rb +6 -6
  52. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +33 -18
  53. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +16 -16
  54. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +4 -4
  55. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +4 -4
  56. data/lib/wx/doc/gen/bitmap.rb +32 -26
  57. data/lib/wx/doc/gen/bitmap_button.rb +10 -6
  58. data/lib/wx/doc/gen/bitmap_combo_box.rb +12 -7
  59. data/lib/wx/doc/gen/book_ctrl_base.rb +7 -3
  60. data/lib/wx/doc/gen/book_ctrl_event.rb +2 -2
  61. data/lib/wx/doc/gen/box_sizer.rb +1 -1
  62. data/lib/wx/doc/gen/brush.rb +16 -4
  63. data/lib/wx/doc/gen/busy_info.rb +1 -1
  64. data/lib/wx/doc/gen/button.rb +19 -7
  65. data/lib/wx/doc/gen/calculate_layout_event.rb +2 -1
  66. data/lib/wx/doc/gen/calendar_ctrl.rb +28 -16
  67. data/lib/wx/doc/gen/calendar_date_attr.rb +2 -2
  68. data/lib/wx/doc/gen/calendar_event.rb +3 -3
  69. data/lib/wx/doc/gen/caret.rb +2 -2
  70. data/lib/wx/doc/gen/check_box.rb +10 -6
  71. data/lib/wx/doc/gen/check_list_box.rb +8 -7
  72. data/lib/wx/doc/gen/choice.rb +7 -6
  73. data/lib/wx/doc/gen/choicebook.rb +12 -6
  74. data/lib/wx/doc/gen/client_dc.rb +1 -1
  75. data/lib/wx/doc/gen/clipboard.rb +1 -1
  76. data/lib/wx/doc/gen/collapsible_pane.rb +9 -6
  77. data/lib/wx/doc/gen/collapsible_pane_event.rb +2 -1
  78. data/lib/wx/doc/gen/colour.rb +16 -6
  79. data/lib/wx/doc/gen/colour_dialog.rb +6 -6
  80. data/lib/wx/doc/gen/colour_picker_ctrl.rb +15 -9
  81. data/lib/wx/doc/gen/colour_picker_event.rb +7 -4
  82. data/lib/wx/doc/gen/combo_box.rb +22 -13
  83. data/lib/wx/doc/gen/context_help_button.rb +4 -3
  84. data/lib/wx/doc/gen/control.rb +9 -6
  85. data/lib/wx/doc/gen/core.rb +5 -2
  86. data/lib/wx/doc/gen/cursor.rb +16 -11
  87. data/lib/wx/doc/gen/data_format.rb +2 -2
  88. data/lib/wx/doc/gen/data_object.rb +23 -16
  89. data/lib/wx/doc/gen/date_event.rb +3 -3
  90. data/lib/wx/doc/gen/date_picker_ctrl.rb +11 -6
  91. data/lib/wx/doc/gen/dc.rb +37 -12
  92. data/lib/wx/doc/gen/defs.rb +16 -16
  93. data/lib/wx/doc/gen/dialog.rb +19 -5
  94. data/lib/wx/doc/gen/dir_dialog.rb +6 -2
  95. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +2 -2
  96. data/lib/wx/doc/gen/dir_picker_ctrl.rb +14 -9
  97. data/lib/wx/doc/gen/drag_drop.rb +15 -15
  98. data/lib/wx/doc/gen/drag_image.rb +6 -6
  99. data/lib/wx/doc/gen/editable_list_box.rb +7 -3
  100. data/lib/wx/doc/gen/event.rb +44 -13
  101. data/lib/wx/doc/gen/event_blocker.rb +1 -1
  102. data/lib/wx/doc/gen/event_filter.rb +5 -2
  103. data/lib/wx/doc/gen/event_list.rb +15 -15
  104. data/lib/wx/doc/gen/events.rb +215 -79
  105. data/lib/wx/doc/gen/evt_handler.rb +1 -1
  106. data/lib/wx/doc/gen/ext_help_controller.rb +1 -1
  107. data/lib/wx/doc/gen/file_dialog.rb +16 -7
  108. data/lib/wx/doc/gen/file_dir_picker_event.rb +5 -3
  109. data/lib/wx/doc/gen/file_picker_ctrl.rb +16 -8
  110. data/lib/wx/doc/gen/find_dialog_event.rb +7 -2
  111. data/lib/wx/doc/gen/find_replace_data.rb +1 -1
  112. data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
  113. data/lib/wx/doc/gen/flex_grid_sizer.rb +12 -6
  114. data/lib/wx/doc/gen/font.rb +30 -29
  115. data/lib/wx/doc/gen/font_data.rb +9 -5
  116. data/lib/wx/doc/gen/font_dialog.rb +3 -3
  117. data/lib/wx/doc/gen/font_picker_ctrl.rb +10 -6
  118. data/lib/wx/doc/gen/font_picker_event.rb +2 -1
  119. data/lib/wx/doc/gen/frame.rb +34 -11
  120. data/lib/wx/doc/gen/fs_file.rb +4 -17
  121. data/lib/wx/doc/gen/gauge.rb +11 -7
  122. data/lib/wx/doc/gen/gcdc.rb +5 -1
  123. data/lib/wx/doc/gen/gdi_common.rb +35 -33
  124. data/lib/wx/doc/gen/gdi_object.rb +1 -1
  125. data/lib/wx/doc/gen/generic_dir_ctrl.rb +13 -7
  126. data/lib/wx/doc/gen/graphics_context.rb +29 -28
  127. data/lib/wx/doc/gen/graphics_object.rb +1 -1
  128. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +2 -2
  129. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +10 -10
  130. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -1
  131. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +1 -1
  132. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +1 -1
  133. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -1
  134. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +2 -2
  135. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +1 -1
  136. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +1 -1
  137. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +1 -1
  138. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +13 -10
  139. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +1 -1
  140. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +1 -1
  141. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -1
  142. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +1 -1
  143. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +1 -1
  144. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -1
  145. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +12 -12
  146. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -1
  147. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -1
  148. data/lib/wx/doc/gen/grid/grid_ctrl.rb +32 -18
  149. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +5 -3
  150. data/lib/wx/doc/gen/grid/grid_event.rb +20 -3
  151. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +7 -3
  152. data/lib/wx/doc/gen/grid/grid_size_event.rb +9 -3
  153. data/lib/wx/doc/gen/grid/grid_string_table.rb +2 -2
  154. data/lib/wx/doc/gen/grid/grid_table_base.rb +7 -7
  155. data/lib/wx/doc/gen/grid/grid_table_message.rb +5 -5
  156. data/lib/wx/doc/gen/grid_bag_sizer.rb +5 -5
  157. data/lib/wx/doc/gen/grid_sizer.rb +4 -4
  158. data/lib/wx/doc/gen/gui_event_loop.rb +132 -0
  159. data/lib/wx/doc/gen/help_controller.rb +18 -12
  160. data/lib/wx/doc/gen/html/html_cell.rb +36 -18
  161. data/lib/wx/doc/gen/html/html_cell_event.rb +5 -3
  162. data/lib/wx/doc/gen/html/html_easy_printing.rb +9 -4
  163. data/lib/wx/doc/gen/html/html_help_controller.rb +34 -8
  164. data/lib/wx/doc/gen/html/html_help_data.rb +3 -3
  165. data/lib/wx/doc/gen/html/html_help_frame.rb +6 -6
  166. data/lib/wx/doc/gen/html/html_help_window.rb +12 -8
  167. data/lib/wx/doc/gen/html/html_link_event.rb +4 -3
  168. data/lib/wx/doc/gen/html/html_list_box.rb +15 -7
  169. data/lib/wx/doc/gen/html/html_printout.rb +15 -5
  170. data/lib/wx/doc/gen/html/html_window.rb +19 -8
  171. data/lib/wx/doc/gen/hyperlink_ctrl.rb +12 -7
  172. data/lib/wx/doc/gen/hyperlink_event.rb +2 -1
  173. data/lib/wx/doc/gen/icon.rb +14 -14
  174. data/lib/wx/doc/gen/image.rb +119 -64
  175. data/lib/wx/doc/gen/image_list.rb +10 -6
  176. data/lib/wx/doc/gen/keyboard_state.rb +7 -7
  177. data/lib/wx/doc/gen/list_box.rb +30 -21
  178. data/lib/wx/doc/gen/list_ctrl.rb +169 -78
  179. data/lib/wx/doc/gen/list_event.rb +24 -2
  180. data/lib/wx/doc/gen/listbook.rb +12 -6
  181. data/lib/wx/doc/gen/locale.rb +11 -36
  182. data/lib/wx/doc/gen/log.rb +122 -45
  183. data/lib/wx/doc/gen/mdi_client_window.rb +2 -2
  184. data/lib/wx/doc/gen/mdi_frame.rb +15 -9
  185. data/lib/wx/doc/gen/media_ctrl.rb +7 -4
  186. data/lib/wx/doc/gen/media_event.rb +8 -2
  187. data/lib/wx/doc/gen/memory_dc.rb +23 -27
  188. data/lib/wx/doc/gen/menu.rb +9 -9
  189. data/lib/wx/doc/gen/menu_bar.rb +4 -4
  190. data/lib/wx/doc/gen/menu_item.rb +115 -34
  191. data/lib/wx/doc/gen/message_dialog.rb +48 -30
  192. data/lib/wx/doc/gen/mini_frame.rb +12 -3
  193. data/lib/wx/doc/gen/mouse_state.rb +1 -1
  194. data/lib/wx/doc/gen/multi_choice_dialog.rb +4 -2
  195. data/lib/wx/doc/gen/non_owned_window.rb +6 -7
  196. data/lib/wx/doc/gen/notebook.rb +20 -15
  197. data/lib/wx/doc/gen/number_entry_dialog.rb +2 -2
  198. data/lib/wx/doc/gen/object.rb +2 -2
  199. data/lib/wx/doc/gen/palette.rb +3 -3
  200. data/lib/wx/doc/gen/panel.rb +4 -3
  201. data/lib/wx/doc/gen/pen.rb +25 -12
  202. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +1 -1
  203. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +3 -3
  204. data/lib/wx/doc/gen/pg/pg_cell.rb +12 -12
  205. data/lib/wx/doc/gen/pg/pg_editor.rb +76 -74
  206. data/lib/wx/doc/gen/pg/pg_multi_button.rb +3 -3
  207. data/lib/wx/doc/gen/pg/pg_properties.rb +221 -138
  208. data/lib/wx/doc/gen/pg/pg_property.rb +103 -54
  209. data/lib/wx/doc/gen/pg/pg_validation_info.rb +1 -1
  210. data/lib/wx/doc/gen/pg/property_grid.rb +19 -19
  211. data/lib/wx/doc/gen/pg/property_grid_event.rb +18 -5
  212. data/lib/wx/doc/gen/pg/property_grid_interface.rb +36 -24
  213. data/lib/wx/doc/gen/pg/property_grid_manager.rb +12 -12
  214. data/lib/wx/doc/gen/pg/property_grid_page.rb +12 -11
  215. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +8 -8
  216. data/lib/wx/doc/gen/picker_base.rb +12 -11
  217. data/lib/wx/doc/gen/platform_info.rb +7 -7
  218. data/lib/wx/doc/gen/popup_window.rb +6 -6
  219. data/lib/wx/doc/gen/progress_dialog.rb +1 -1
  220. data/lib/wx/doc/gen/property_sheet_dialog.rb +19 -17
  221. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +2 -2
  222. data/lib/wx/doc/gen/prt/preview_frame.rb +4 -1
  223. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +1 -1
  224. data/lib/wx/doc/gen/prt/print_data.rb +24 -18
  225. data/lib/wx/doc/gen/prt/print_dialog.rb +4 -4
  226. data/lib/wx/doc/gen/prt/printer.rb +22 -22
  227. data/lib/wx/doc/gen/query_layout_info_event.rb +2 -1
  228. data/lib/wx/doc/gen/radio_box.rb +12 -10
  229. data/lib/wx/doc/gen/radio_button.rb +8 -6
  230. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +39 -39
  231. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +25 -7
  232. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +5 -5
  233. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +9 -2
  234. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +5 -5
  235. data/lib/wx/doc/gen/rbn/ribbon_control.rb +4 -4
  236. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +6 -2
  237. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +5 -5
  238. data/lib/wx/doc/gen/rbn/ribbon_page.rb +5 -5
  239. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +12 -6
  240. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +5 -5
  241. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +4 -2
  242. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +5 -5
  243. data/lib/wx/doc/gen/region.rb +9 -8
  244. data/lib/wx/doc/gen/region_iterator.rb +2 -2
  245. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +92 -92
  246. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +56 -34
  247. data/lib/wx/doc/gen/rtc/rich_text_event.rb +23 -4
  248. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +6 -6
  249. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +9 -5
  250. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +6 -2
  251. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +12 -12
  252. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +1 -1
  253. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +2 -2
  254. data/lib/wx/doc/gen/sash_event.rb +3 -1
  255. data/lib/wx/doc/gen/sash_layout_window.rb +5 -3
  256. data/lib/wx/doc/gen/sash_window.rb +8 -3
  257. data/lib/wx/doc/gen/scroll_bar.rb +29 -8
  258. data/lib/wx/doc/gen/scrolled_canvas.rb +41 -23
  259. data/lib/wx/doc/gen/scrolled_control.rb +41 -23
  260. data/lib/wx/doc/gen/scrolled_window.rb +41 -23
  261. data/lib/wx/doc/gen/search_ctrl.rb +15 -8
  262. data/lib/wx/doc/gen/simplebook.rb +2 -2
  263. data/lib/wx/doc/gen/single_choice_dialog.rb +4 -2
  264. data/lib/wx/doc/gen/sizer.rb +29 -28
  265. data/lib/wx/doc/gen/slider.rb +49 -16
  266. data/lib/wx/doc/gen/spin_button.rb +15 -9
  267. data/lib/wx/doc/gen/spin_ctrl.rb +12 -6
  268. data/lib/wx/doc/gen/spin_event.rb +5 -2
  269. data/lib/wx/doc/gen/splash_screen.rb +16 -12
  270. data/lib/wx/doc/gen/splitter_event.rb +6 -2
  271. data/lib/wx/doc/gen/splitter_window.rb +20 -4
  272. data/lib/wx/doc/gen/static_bitmap.rb +5 -5
  273. data/lib/wx/doc/gen/static_box.rb +36 -32
  274. data/lib/wx/doc/gen/static_box_sizer.rb +13 -10
  275. data/lib/wx/doc/gen/static_line.rb +5 -4
  276. data/lib/wx/doc/gen/static_text.rb +12 -6
  277. data/lib/wx/doc/gen/status_bar.rb +14 -5
  278. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +55 -7
  279. data/lib/wx/doc/gen/stc/styled_text_event.rb +224 -49
  280. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +11 -2
  281. data/lib/wx/doc/gen/svg_file_dc.rb +3 -3
  282. data/lib/wx/doc/gen/system_options.rb +11 -1
  283. data/lib/wx/doc/gen/system_settings.rb +3 -3
  284. data/lib/wx/doc/gen/task_bar_icon.rb +10 -2
  285. data/lib/wx/doc/gen/task_bar_icon_event.rb +3 -3
  286. data/lib/wx/doc/gen/text_attr.rb +11 -7
  287. data/lib/wx/doc/gen/text_ctrl.rb +61 -92
  288. data/lib/wx/doc/gen/text_entry.rb +28 -40
  289. data/lib/wx/doc/gen/text_entry_dialog.rb +19 -19
  290. data/lib/wx/doc/gen/text_validator.rb +0 -11
  291. data/lib/wx/doc/gen/time_picker_ctrl.rb +6 -5
  292. data/lib/wx/doc/gen/timer.rb +8 -4
  293. data/lib/wx/doc/gen/timer_event.rb +19 -26
  294. data/lib/wx/doc/gen/tip_provider.rb +1 -1
  295. data/lib/wx/doc/gen/toggle_button.rb +6 -5
  296. data/lib/wx/doc/gen/tool_bar.rb +41 -24
  297. data/lib/wx/doc/gen/tool_tip.rb +2 -2
  298. data/lib/wx/doc/gen/toolbook.rb +6 -3
  299. data/lib/wx/doc/gen/top_level_window.rb +35 -25
  300. data/lib/wx/doc/gen/tree_ctrl.rb +63 -13
  301. data/lib/wx/doc/gen/tree_event.rb +23 -2
  302. data/lib/wx/doc/gen/treebook.rb +6 -2
  303. data/lib/wx/doc/gen/ui_action_simulator.rb +1 -1
  304. data/lib/wx/doc/gen/utils.rb +9 -3
  305. data/lib/wx/doc/gen/v_list_box.rb +2 -2
  306. data/lib/wx/doc/gen/v_scrolled_window.rb +2 -2
  307. data/lib/wx/doc/gen/validator.rb +7 -5
  308. data/lib/wx/doc/gen/variant.rb +34 -97
  309. data/lib/wx/doc/gen/window.rb +157 -102
  310. data/lib/wx/doc/gen/window_dc.rb +1 -1
  311. data/lib/wx/doc/gen/with_images.rb +1 -1
  312. data/lib/wx/doc/gen/wizard.rb +17 -4
  313. data/lib/wx/doc/gen/wizard_event.rb +9 -2
  314. data/lib/wx/doc/gen/wizard_page.rb +1 -1
  315. data/lib/wx/doc/gen/wizard_page_simple.rb +7 -7
  316. data/lib/wx/doc/gen/xml_node.rb +3 -3
  317. data/lib/wx/doc/gen/xml_resource.rb +12 -9
  318. data/lib/wx/doc/image.rb +42 -12
  319. data/lib/wx/doc/list_ctrl.rb +32 -0
  320. data/lib/wx/doc/log.rb +28 -0
  321. data/lib/wx/doc/prt/printer_dc.rb +2 -2
  322. data/lib/wx/doc/scaled_dc.rb +1 -1
  323. data/lib/wx/doc/text_validator.rb +12 -0
  324. data/lib/wx/version.rb +1 -1
  325. data/lib/wxruby_aui.so +0 -0
  326. data/lib/wxruby_core.so +0 -0
  327. data/lib/wxruby_grid.so +0 -0
  328. data/lib/wxruby_html.so +0 -0
  329. data/lib/wxruby_pg.so +0 -0
  330. data/lib/wxruby_prt.so +0 -0
  331. data/lib/wxruby_rbn.so +0 -0
  332. data/lib/wxruby_rtc.so +0 -0
  333. data/lib/wxruby_stc.so +0 -0
  334. data/tests/test_art.rb +9 -0
  335. data/tests/test_box_sizer.rb +161 -0
  336. data/tests/test_grid_sizer.rb +148 -0
  337. data/tests/test_list_ctrl.rb +53 -0
  338. data/tests/test_log.rb +163 -0
  339. data/tests/test_std_controls.rb +58 -0
  340. data/tests/test_timer.rb +95 -0
  341. metadata +13 -2
@@ -15,6 +15,7 @@ module Wx
15
15
  #
16
16
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::IdleEvent} events.
17
17
  # Event handler methods:
18
+ #
18
19
  # - {Wx::EvtHandler#evt_idle}(meth = nil, &block): Process a {Wx::EVT_IDLE} event.
19
20
  #
20
21
  # ===
@@ -34,7 +35,7 @@ module Wx
34
35
  class IdleEvent < Event
35
36
 
36
37
  # Constructor.
37
- # @return [IdleEvent]
38
+ # @return [Wx::IdleEvent]
38
39
  def initialize; end
39
40
 
40
41
  # Returns true if the OnIdle function processing this event requested more processing time.
@@ -75,9 +76,9 @@ module Wx
75
76
  class NotifyEvent < CommandEvent
76
77
 
77
78
  # Constructor (used internally by wxWidgets only).
78
- # @param eventType [Integer]
79
+ # @param eventType [Wx::AUI::AuiMDIChildFrame::EventType]
79
80
  # @param id [Integer]
80
- # @return [NotifyEvent]
81
+ # @return [Wx::NotifyEvent]
81
82
  def initialize(eventType=Wx::EVT_NULL, id=0) end
82
83
 
83
84
  # This is the opposite of {Wx::NotifyEvent#veto}: it explicitly allows the event to be processed.
@@ -111,25 +112,45 @@ module Wx
111
112
  #
112
113
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollEvent} events.
113
114
  # Event handler methods: except for this, the macros behave exactly the same.
115
+ #
114
116
  # - {Wx::EvtHandler#evt_scroll}(meth = nil, &block): Process all scroll events.
117
+ #
115
118
  # - {Wx::EvtHandler#evt_scroll_top}(meth = nil, &block): Process {Wx::EVT_SCROLL_TOP} scroll-to-top events (minimum position).
119
+ #
116
120
  # - {Wx::EvtHandler#evt_scroll_bottom}(meth = nil, &block): Process {Wx::EVT_SCROLL_BOTTOM} scroll-to-bottom events (maximum position).
121
+ #
117
122
  # - {Wx::EvtHandler#evt_scroll_lineup}(meth = nil, &block): Process {Wx::EVT_SCROLL_LINEUP} line up events.
123
+ #
118
124
  # - {Wx::EvtHandler#evt_scroll_linedown}(meth = nil, &block): Process {Wx::EVT_SCROLL_LINEDOWN} line down events.
125
+ #
119
126
  # - {Wx::EvtHandler#evt_scroll_pageup}(meth = nil, &block): Process {Wx::EVT_SCROLL_PAGEUP} page up events.
127
+ #
120
128
  # - {Wx::EvtHandler#evt_scroll_pagedown}(meth = nil, &block): Process {Wx::EVT_SCROLL_PAGEDOWN} page down events.
129
+ #
121
130
  # - {Wx::EvtHandler#evt_scroll_thumbtrack}(meth = nil, &block): Process {Wx::EVT_SCROLL_THUMBTRACK} thumbtrack events (frequent events sent as the user drags the thumbtrack).
131
+ #
122
132
  # - {Wx::EvtHandler#evt_scroll_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLL_THUMBRELEASE} thumb release events.
133
+ #
123
134
  # - {Wx::EvtHandler#evt_scroll_changed}(meth = nil, &block): Process {Wx::EVT_SCROLL_CHANGED} end of scrolling events (MSW only).
135
+ #
124
136
  # - {Wx::EvtHandler#evt_command_scroll}(id, meth = nil, &block): Process all scroll events.
137
+ #
125
138
  # - {Wx::EvtHandler#evt_command_scroll_top}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_TOP} scroll-to-top events (minimum position).
139
+ #
126
140
  # - {Wx::EvtHandler#evt_command_scroll_bottom}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_BOTTOM} scroll-to-bottom events (maximum position).
141
+ #
127
142
  # - {Wx::EvtHandler#evt_command_scroll_lineup}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_LINEUP} line up events.
143
+ #
128
144
  # - {Wx::EvtHandler#evt_command_scroll_linedown}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_LINEDOWN} line down events.
145
+ #
129
146
  # - {Wx::EvtHandler#evt_command_scroll_pageup}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_PAGEUP} page up events.
147
+ #
130
148
  # - {Wx::EvtHandler#evt_command_scroll_pagedown}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_PAGEDOWN} page down events.
149
+ #
131
150
  # - {Wx::EvtHandler#evt_command_scroll_thumbtrack}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_THUMBTRACK} thumbtrack events (frequent events sent as the user drags the thumbtrack).
151
+ #
132
152
  # - {Wx::EvtHandler#evt_command_scroll_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLL_THUMBRELEASE} thumb release events.
153
+ #
133
154
  # - {Wx::EvtHandler#evt_command_scroll_changed}(meth = nil, &block): Process {Wx::EVT_SCROLL_CHANGED} end of scrolling events (MSW only).
134
155
  #
135
156
  # ===
@@ -145,11 +166,11 @@ module Wx
145
166
  class ScrollEvent < CommandEvent
146
167
 
147
168
  # Constructor.
148
- # @param commandType [Integer]
169
+ # @param commandType [Wx::AUI::AuiMDIChildFrame::EventType]
149
170
  # @param id [Integer]
150
171
  # @param pos [Integer]
151
172
  # @param orientation [Integer]
152
- # @return [ScrollEvent]
173
+ # @return [Wx::ScrollEvent]
153
174
  def initialize(commandType=Wx::EVT_NULL, id=0, pos=0, orientation=0) end
154
175
 
155
176
  # Returns {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}, depending on the orientation of the scrollbar.
@@ -180,14 +201,23 @@ module Wx
180
201
  #
181
202
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollWinEvent} events.
182
203
  # Event handler methods:
204
+ #
183
205
  # - {Wx::EvtHandler#evt_scrollwin}(meth = nil, &block): Process all scroll events.
206
+ #
184
207
  # - {Wx::EvtHandler#evt_scrollwin_top}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_TOP} scroll-to-top events.
208
+ #
185
209
  # - {Wx::EvtHandler#evt_scrollwin_bottom}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_BOTTOM} scroll-to-bottom events.
210
+ #
186
211
  # - {Wx::EvtHandler#evt_scrollwin_lineup}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_LINEUP} line up events.
212
+ #
187
213
  # - {Wx::EvtHandler#evt_scrollwin_linedown}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_LINEDOWN} line down events.
214
+ #
188
215
  # - {Wx::EvtHandler#evt_scrollwin_pageup}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_PAGEUP} page up events.
216
+ #
189
217
  # - {Wx::EvtHandler#evt_scrollwin_pagedown}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_PAGEDOWN} page down events.
218
+ #
190
219
  # - {Wx::EvtHandler#evt_scrollwin_thumbtrack}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBTRACK} thumbtrack events (frequent events sent as the user drags the thumbtrack).
220
+ #
191
221
  # - {Wx::EvtHandler#evt_scrollwin_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBRELEASE} thumb release events.
192
222
  #
193
223
  # ===
@@ -200,10 +230,10 @@ module Wx
200
230
  class ScrollWinEvent < Event
201
231
 
202
232
  # Constructor.
203
- # @param commandType [Integer]
233
+ # @param commandType [Wx::AUI::AuiMDIChildFrame::EventType]
204
234
  # @param pos [Integer]
205
235
  # @param orientation [Integer]
206
- # @return [ScrollWinEvent]
236
+ # @return [Wx::ScrollWinEvent]
207
237
  def initialize(commandType=Wx::EVT_NULL, pos=0, orientation=0) end
208
238
 
209
239
  # Returns {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}, depending on the orientation of the scrollbar.
@@ -240,26 +270,47 @@ module Wx
240
270
  #
241
271
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MouseEvent} events.
242
272
  # Event handler methods:
273
+ #
243
274
  # - {Wx::EvtHandler#evt_left_down}(meth = nil, &block): Process a {Wx::EVT_LEFT_DOWN} event. The handler of this event should normally call event.Skip() to allow the default processing to take place as otherwise the window under mouse wouldn't get the focus.
275
+ #
244
276
  # - {Wx::EvtHandler#evt_left_up}(meth = nil, &block): Process a {Wx::EVT_LEFT_UP} event.
277
+ #
245
278
  # - {Wx::EvtHandler#evt_left_dclick}(meth = nil, &block): Process a {Wx::EVT_LEFT_DCLICK} event.
279
+ #
246
280
  # - {Wx::EvtHandler#evt_middle_down}(meth = nil, &block): Process a {Wx::EVT_MIDDLE_DOWN} event.
281
+ #
247
282
  # - {Wx::EvtHandler#evt_middle_up}(meth = nil, &block): Process a {Wx::EVT_MIDDLE_UP} event.
283
+ #
248
284
  # - {Wx::EvtHandler#evt_middle_dclick}(meth = nil, &block): Process a {Wx::EVT_MIDDLE_DCLICK} event.
285
+ #
249
286
  # - {Wx::EvtHandler#evt_right_down}(meth = nil, &block): Process a {Wx::EVT_RIGHT_DOWN} event.
287
+ #
250
288
  # - {Wx::EvtHandler#evt_right_up}(meth = nil, &block): Process a {Wx::EVT_RIGHT_UP} event.
289
+ #
251
290
  # - {Wx::EvtHandler#evt_right_dclick}(meth = nil, &block): Process a {Wx::EVT_RIGHT_DCLICK} event.
291
+ #
252
292
  # - EVT_MOUSE_AUX1_DOWN(func): Process a {Wx::EVT_AUX1_DOWN} event.
293
+ #
253
294
  # - EVT_MOUSE_AUX1_UP(func): Process a {Wx::EVT_AUX1_UP} event.
295
+ #
254
296
  # - EVT_MOUSE_AUX1_DCLICK(func): Process a {Wx::EVT_AUX1_DCLICK} event.
297
+ #
255
298
  # - EVT_MOUSE_AUX2_DOWN(func): Process a {Wx::EVT_AUX2_DOWN} event.
299
+ #
256
300
  # - EVT_MOUSE_AUX2_UP(func): Process a {Wx::EVT_AUX2_UP} event.
301
+ #
257
302
  # - EVT_MOUSE_AUX2_DCLICK(func): Process a {Wx::EVT_AUX2_DCLICK} event.
303
+ #
258
304
  # - {Wx::EvtHandler#evt_motion}(meth = nil, &block): Process a {Wx::EVT_MOTION} event.
305
+ #
259
306
  # - {Wx::EvtHandler#evt_enter_window}(meth = nil, &block): Process a {Wx::EVT_ENTER_WINDOW} event.
307
+ #
260
308
  # - {Wx::EvtHandler#evt_leave_window}(meth = nil, &block): Process a {Wx::EVT_LEAVE_WINDOW} event.
309
+ #
261
310
  # - {Wx::EvtHandler#evt_mousewheel}(meth = nil, &block): Process a {Wx::EVT_MOUSEWHEEL} event.
311
+ #
262
312
  # - {Wx::EvtHandler#evt_mouse_events}(meth = nil, &block): Process all mouse events.
313
+ #
263
314
  # - {Wx::EvtHandler#evt_magnify}(meth = nil, &block): Process a {Wx::EVT_MAGNIFY} event (new since wxWidgets 3.1.0).
264
315
  #
265
316
  # ===
@@ -274,27 +325,46 @@ module Wx
274
325
  # Valid event types are:
275
326
  #
276
327
  # - {Wx::EVT_ENTER_WINDOW}
328
+ #
277
329
  # - {Wx::EVT_LEAVE_WINDOW}
330
+ #
278
331
  # - {Wx::EVT_LEFT_DOWN}
332
+ #
279
333
  # - {Wx::EVT_LEFT_UP}
334
+ #
280
335
  # - {Wx::EVT_LEFT_DCLICK}
336
+ #
281
337
  # - {Wx::EVT_MIDDLE_DOWN}
338
+ #
282
339
  # - {Wx::EVT_MIDDLE_UP}
340
+ #
283
341
  # - {Wx::EVT_MIDDLE_DCLICK}
342
+ #
284
343
  # - {Wx::EVT_RIGHT_DOWN}
344
+ #
285
345
  # - {Wx::EVT_RIGHT_UP}
346
+ #
286
347
  # - {Wx::EVT_RIGHT_DCLICK}
348
+ #
287
349
  # - {Wx::EVT_AUX1_DOWN}
350
+ #
288
351
  # - {Wx::EVT_AUX1_UP}
352
+ #
289
353
  # - {Wx::EVT_AUX1_DCLICK}
354
+ #
290
355
  # - {Wx::EVT_AUX2_DOWN}
356
+ #
291
357
  # - {Wx::EVT_AUX2_UP}
358
+ #
292
359
  # - {Wx::EVT_AUX2_DCLICK}
360
+ #
293
361
  # - {Wx::EVT_MOTION}
362
+ #
294
363
  # - {Wx::EVT_MOUSEWHEEL}
364
+ #
295
365
  # - {Wx::EVT_MAGNIFY}
296
- # @param mouseEventType [Integer]
297
- # @return [MouseEvent]
366
+ # @param mouseEventType [Wx::AUI::AuiMDIChildFrame::EventType]
367
+ # @return [Wx::MouseEvent]
298
368
  def initialize(mouseEventType=Wx::EVT_NULL) end
299
369
 
300
370
  # Returns true if the event was a first extra button double click.
@@ -667,6 +737,7 @@ module Wx
667
737
  #
668
738
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SetCursorEvent} events.
669
739
  # Event handler methods:
740
+ #
670
741
  # - {Wx::EvtHandler#evt_set_cursor}(meth = nil, &block): Process a {Wx::EVT_SET_CURSOR} event.
671
742
  #
672
743
  # ===
@@ -681,7 +752,7 @@ module Wx
681
752
  # Constructor, used by the library itself internally to initialize the event object.
682
753
  # @param x [Integer]
683
754
  # @param y [Integer]
684
- # @return [SetCursorEvent]
755
+ # @return [Wx::SetCursorEvent]
685
756
  def initialize(x=0, y=0) end
686
757
 
687
758
  # Returns a reference to the cursor specified by this event.
@@ -728,8 +799,8 @@ module Wx
728
799
 
729
800
  # Constructor.
730
801
  # @param winid [Integer]
731
- # @param type [Integer]
732
- # @return [GestureEvent]
802
+ # @param type [Wx::AUI::AuiMDIChildFrame::EventType]
803
+ # @return [Wx::GestureEvent]
733
804
  def initialize(winid=0, type=Wx::EVT_NULL) end
734
805
 
735
806
  # Returns the position where the event took effect, in client coordinates: position of Pan event, center of zoom for Zoom event, center of rotation for Rotate event, center of box formed by 2 fingers for Two Finger Tap event and position of the pressed finger for Press and Tap Event.
@@ -768,12 +839,13 @@ module Wx
768
839
  end # GestureEvent
769
840
 
770
841
  # This event is generated when the user moves a finger on the surface.
771
- # {Wx::GTK} also generates this event during mouse dragging (mouse motion while a left mouse button is depressed).
842
+ # wxGTK also generates this event during mouse dragging (mouse motion while a left mouse button is depressed).
772
843
  # Note that OSX requires the primary mouse button to be pressed while performing the finger movement.
773
844
  # === Events using this class
774
845
  #
775
846
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::PanGestureEvent} events.
776
847
  # Event handler methods:
848
+ #
777
849
  # - {Wx::EvtHandler#evt_gesture_pan}(id, meth = nil, &block): Process a {Wx::EVT_GESTURE_PAN}.
778
850
  #
779
851
  # ===
@@ -784,7 +856,7 @@ module Wx
784
856
 
785
857
  # Constructor.
786
858
  # @param winid [Integer]
787
- # @return [PanGestureEvent]
859
+ # @return [Wx::PanGestureEvent]
788
860
  def initialize(winid=0) end
789
861
 
790
862
  # Returns the distance covered since the previous panning event.
@@ -805,6 +877,7 @@ module Wx
805
877
  #
806
878
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ZoomGestureEvent} events.
807
879
  # Event handler methods:
880
+ #
808
881
  # - {Wx::EvtHandler#evt_gesture_zoom}(id, meth = nil, &block): Process a {Wx::EVT_GESTURE_ZOOM}.
809
882
  #
810
883
  # ===
@@ -815,7 +888,7 @@ module Wx
815
888
 
816
889
  # Constructor.
817
890
  # @param windid [Integer]
818
- # @return [ZoomGestureEvent]
891
+ # @return [Wx::ZoomGestureEvent]
819
892
  def initialize(windid=0) end
820
893
 
821
894
  # Returns the zoom Factor since the gesture started.
@@ -837,6 +910,7 @@ module Wx
837
910
  #
838
911
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::RotateGestureEvent} events.
839
912
  # Event handler methods:
913
+ #
840
914
  # - {Wx::EvtHandler#evt_gesture_rotate}(id, meth = nil, &block): Process a {Wx::EVT_GESTURE_ROTATE}.
841
915
  #
842
916
  # ===
@@ -847,7 +921,7 @@ module Wx
847
921
 
848
922
  # Constructor.
849
923
  # @param windid [Integer]
850
- # @return [RotateGestureEvent]
924
+ # @return [Wx::RotateGestureEvent]
851
925
  def initialize(windid=0) end
852
926
 
853
927
  # Returns the total angle of rotation in radians in clockwise direction since the gesture was first started i.e.
@@ -870,6 +944,7 @@ module Wx
870
944
  #
871
945
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::TwoFingerTapEvent} events.
872
946
  # Event handler methods:
947
+ #
873
948
  # - {Wx::EvtHandler#evt_two_finger_tap}(id, meth = nil, &block): Process a {Wx::EVT_TWO_FINGER_TAP}.
874
949
  #
875
950
  # ===
@@ -880,18 +955,19 @@ module Wx
880
955
 
881
956
  # Constructor.
882
957
  # @param windid [Integer]
883
- # @return [TwoFingerTapEvent]
958
+ # @return [Wx::TwoFingerTapEvent]
884
959
  def initialize(windid=0) end
885
960
 
886
961
  end # TwoFingerTapEvent
887
962
 
888
963
  # This event is generated when one finger touches the surface and remains stationary.
889
- # Note that currently it is only generated under {Wx::GTK} and {Wx::OSX}.
890
- # {Wx::GTK} also generates this event when left mouse button is being pressed for some minimum duration of time.
964
+ # Note that currently it is only generated under wxGTK and wxOSX.
965
+ # wxGTK also generates this event when left mouse button is being pressed for some minimum duration of time.
891
966
  # === Events using this class
892
967
  #
893
968
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::LongPressEvent} events.
894
969
  # Event handler methods:
970
+ #
895
971
  # - {Wx::EvtHandler#evt_long_press}(id, meth = nil, &block): Process a {Wx::EVT_LONG_PRESS}.
896
972
  #
897
973
  # ===
@@ -902,7 +978,7 @@ module Wx
902
978
 
903
979
  # Constructor.
904
980
  # @param windid [Integer]
905
- # @return [LongPressEvent]
981
+ # @return [Wx::LongPressEvent]
906
982
  def initialize(windid=0) end
907
983
 
908
984
  end # LongPressEvent
@@ -913,6 +989,7 @@ module Wx
913
989
  #
914
990
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::PressAndTapEvent} events.
915
991
  # Event handler methods:
992
+ #
916
993
  # - {Wx::EvtHandler#evt_press_and_tap}(id, meth = nil, &block): Process a {Wx::EVT_PRESS_AND_TAP}.
917
994
  #
918
995
  # ===
@@ -923,7 +1000,7 @@ module Wx
923
1000
 
924
1001
  # Constructor.
925
1002
  # @param windid [Integer]
926
- # @return [PressAndTapEvent]
1003
+ # @return [Wx::PressAndTapEvent]
927
1004
  def initialize(windid=0) end
928
1005
 
929
1006
  end # PressAndTapEvent
@@ -932,7 +1009,10 @@ module Wx
932
1009
  # The main information carried by this event is the key being pressed or released. It can be accessed using one of {Wx::KeyEvent#get_unicode_key}, {Wx::KeyEvent#get_key_code} or {Wx::KeyEvent#get_raw_key_code} functions. For the printable characters, {Wx::KeyEvent#get_unicode_key} should be used as it works for any keys, including non-Latin-1 characters that can be entered when using national keyboard layouts. {Wx::KeyEvent#get_key_code} should be used to handle special characters (such as cursor arrows keys or HOME or INS and so on) which correspond to {Wx::KeyCode} enum elements above the {Wx::K_START} constant. While {Wx::KeyEvent#get_key_code} also returns the character code for Latin-1 keys for compatibility, it doesn't work for Unicode characters in general and will return {Wx::K_NONE} for any non-Latin-1 ones. If both {Wx::KeyEvent#get_unicode_key} and {Wx::KeyEvent#get_key_code} return {Wx::K_NONE} then the key has no WXK_xxx mapping and {Wx::KeyEvent#get_raw_key_code} can be used to distinguish between keys, but raw key codes are platform specific. For these reasons, it is recommended to always use {Wx::KeyEvent#get_unicode_key} and only fall back to {Wx::KeyEvent#get_key_code} if {Wx::KeyEvent#get_unicode_key} returned {Wx::K_NONE}, meaning that the event corresponds to a non-printable special keys, then optionally check {Wx::KeyEvent#get_raw_key_code} if {Wx::KeyEvent#get_key_code} also returned {Wx::K_NONE} or simply ignore that key.
933
1010
  # While these three functions can be used with the events of {Wx::EVT_KEY_DOWN}, {Wx::EVT_KEY_UP} and {Wx::EVT_CHAR} types, the values returned by them are different for the first two events and the last one. For the latter, the key returned corresponds to the character that would appear in e.g. a text zone if the user pressed the key in it. As such, its value depends on the current state of the Shift key and, for the letters, on the state of Caps Lock modifier. For example, if A key is pressed without Shift being held down, {Wx::KeyEvent} of type {Wx::EVT_CHAR} generated for this key press will return (from either {Wx::KeyEvent#get_key_code} or {Wx::KeyEvent#get_unicode_key} as their meanings coincide for ASCII characters) key code of 97 corresponding the ASCII value of a. And if the same key is pressed but with Shift being held (or Caps Lock being active), then the key could would be 65, i.e. ASCII value of capital A.
934
1011
  # However for the key down and up events the returned key code will instead be A independently of the state of the modifier keys i.e. it depends only on physical key being pressed and is not translated to its logical representation using the current keyboard state. Such untranslated key codes are defined as follows:
935
- # - For the letters they correspond to the upper case value of the letter.- For the other alphanumeric keys (e.g. 7 or <code>+</code>), the untranslated key code corresponds to the character produced by the key when it is pressed without Shift. E.g. in standard US keyboard layout the untranslated key code for the key <code>=/+</code> in the upper right corner of the keyboard is 61 which is the ASCII value of <code>=</code>.- For the rest of the keys (i.e. special non-printable keys) it is the same as the normal key code as no translation is used anyhow.
1012
+ #
1013
+ # - For the letters they correspond to the upper case value of the letter.
1014
+ # - For the other alphanumeric keys (e.g. 7 or <code>+</code>), the untranslated key code corresponds to the character produced by the key when it is pressed without Shift. E.g. in standard US keyboard layout the untranslated key code for the key <code>=/+</code> in the upper right corner of the keyboard is 61 which is the ASCII value of <code>=</code>.
1015
+ # - For the rest of the keys (i.e. special non-printable keys) it is the same as the normal key code as no translation is used anyhow.
936
1016
  #
937
1017
  # Notice that the first rule applies to all Unicode letters, not just the usual Latin-1 ones. However for non-Latin-1 letters only {Wx::KeyEvent#get_unicode_key} can be used to retrieve the key code as {Wx::KeyEvent#get_key_code} just returns {Wx::K_NONE} in this case.
938
1018
  # Also, note that {Wx::EVT_CHAR} events are not generated for keys which do not have a wxWidgets mapping, so {Wx::KeyEvent#get_raw_key_code} should never be required for this event.
@@ -953,9 +1033,13 @@ module Wx
953
1033
  #
954
1034
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::KeyEvent} events.
955
1035
  # Event handler methods:
1036
+ #
956
1037
  # - {Wx::EvtHandler#evt_key_down}(meth = nil, &block): Process a {Wx::EVT_KEY_DOWN} event (any key has been pressed). If this event is handled and not skipped, {Wx::EVT_CHAR} will not be generated at all for this key press (but {Wx::EVT_KEY_UP} will be).
1038
+ #
957
1039
  # - {Wx::EvtHandler#evt_key_up}(meth = nil, &block): Process a {Wx::EVT_KEY_UP} event (any key has been released).
1040
+ #
958
1041
  # - {Wx::EvtHandler#evt_char}(meth = nil, &block): Process a {Wx::EVT_CHAR} event.
1042
+ #
959
1043
  # - {Wx::EvtHandler#evt_char_hook}(meth = nil, &block): Process a {Wx::EVT_CHAR_HOOK} event. Unlike all the other key events, this event is propagated upwards the window hierarchy which allows intercepting it in the parent window of the focused window to which it is sent initially (if there is no focused window, this event is sent to the {Wx::App} global object). It is also generated before any other key events and so gives the parent window an opportunity to modify the keyboard handling of its children, e.g. it is used internally by wxWidgets in some ports to intercept pressing Esc key in any child of a dialog to close the dialog itself when it's pressed. By default, if this event is handled, i.e. the handler doesn't call {Wx::Event#skip}, neither {Wx::EVT_KEY_DOWN} nor {Wx::EVT_CHAR} events will be generated (although {Wx::EVT_KEY_UP} still will be), i.e. it replaces the normal key events. However by calling the special {Wx::KeyEvent#do_allow_next_event} method you can handle {Wx::EVT_CHAR_HOOK} and still allow normal events generation. This is something that is rarely useful but can be required if you need to prevent a parent {Wx::EVT_CHAR_HOOK} handler from running without suppressing the normal key events. Finally notice that this event is not generated when the mouse is captured as it is considered that the window which has the capture should receive all the keyboard events too without allowing its parent {Wx::TopLevelWindow} to interfere with their processing.
960
1044
  #
961
1045
  # ===
@@ -975,8 +1059,8 @@ module Wx
975
1059
 
976
1060
  # Constructor.
977
1061
  # Currently, the only valid event types are {Wx::EVT_CHAR} and {Wx::EVT_CHAR_HOOK}.
978
- # @param keyEventType [Integer]
979
- # @return [KeyEvent]
1062
+ # @param keyEventType [Wx::AUI::AuiMDIChildFrame::EventType]
1063
+ # @return [Wx::KeyEvent]
980
1064
  def initialize(keyEventType=Wx::EVT_NULL) end
981
1065
 
982
1066
  # Returns the key code of the key that generated this event.
@@ -1183,6 +1267,7 @@ module Wx
1183
1267
  #
1184
1268
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SizeEvent} events.
1185
1269
  # Event handler methods:
1270
+ #
1186
1271
  # - {Wx::EvtHandler#evt_size}(meth = nil, &block): Process a {Wx::EVT_SIZE} event.
1187
1272
  #
1188
1273
  # ===
@@ -1197,7 +1282,7 @@ module Wx
1197
1282
  # Constructor.
1198
1283
  # @param sz [Array(Integer, Integer), Wx::Size]
1199
1284
  # @param id [Integer]
1200
- # @return [SizeEvent]
1285
+ # @return [Wx::SizeEvent]
1201
1286
  def initialize(sz, id=0) end
1202
1287
 
1203
1288
  # Returns the entire size of the window generating the size change event.
@@ -1223,15 +1308,19 @@ module Wx
1223
1308
  end # SizeEvent
1224
1309
 
1225
1310
  # A move event holds information about window position change.
1226
- # These events are currently generated for top level (see {Wx::TopLevelWindow}) windows in all ports, but are not generated for the child windows in {Wx::GTK}.
1311
+ # These events are currently generated for top level (see {Wx::TopLevelWindow}) windows in all ports, but are not generated for the child windows in wxGTK.
1227
1312
  # === Events using this class
1228
1313
  #
1229
1314
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MoveEvent} events.
1230
1315
  # Event handler methods:
1316
+ #
1231
1317
  # - {Wx::EvtHandler#evt_move}(meth = nil, &block): Process a {Wx::EVT_MOVE} event, which is generated when a window is moved.
1232
- # - {Wx::EvtHandler#evt_move_start}(meth = nil, &block): Process a {Wx::EVT_MOVE_START} event, which is generated when the user starts to move or size a window. {Wx::MSW} only.
1233
- # - {Wx::EvtHandler#evt_moving}(meth = nil, &block): Process a {Wx::EVT_MOVING} event, which is generated while the user is moving the window. {Wx::MSW} only.
1234
- # - {Wx::EvtHandler#evt_move_end}(meth = nil, &block): Process a {Wx::EVT_MOVE_END} event, which is generated when the user stops moving or sizing a window. {Wx::MSW} only.
1318
+ #
1319
+ # - {Wx::EvtHandler#evt_move_start}(meth = nil, &block): Process a {Wx::EVT_MOVE_START} event, which is generated when the user starts to move or size a window. wxMSW only.
1320
+ #
1321
+ # - {Wx::EvtHandler#evt_moving}(meth = nil, &block): Process a {Wx::EVT_MOVING} event, which is generated while the user is moving the window. wxMSW only.
1322
+ #
1323
+ # - {Wx::EvtHandler#evt_move_end}(meth = nil, &block): Process a {Wx::EVT_MOVE_END} event, which is generated when the user stops moving or sizing a window. wxMSW only.
1235
1324
  #
1236
1325
  # ===
1237
1326
  #
@@ -1245,7 +1334,7 @@ module Wx
1245
1334
  # Constructor.
1246
1335
  # @param pt [Array(Integer, Integer), Wx::Point]
1247
1336
  # @param id [Integer]
1248
- # @return [MoveEvent]
1337
+ # @return [Wx::MoveEvent]
1249
1338
  def initialize(pt, id=0) end
1250
1339
 
1251
1340
  # Returns the position of the window generating the move change event.
@@ -1310,6 +1399,7 @@ module Wx
1310
1399
  #
1311
1400
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::PaintEvent} events.
1312
1401
  # Event handler methods:
1402
+ #
1313
1403
  # - {Wx::EvtHandler#evt_paint}(meth = nil, &block): Process a {Wx::EVT_PAINT} event.
1314
1404
  #
1315
1405
  # ===
@@ -1323,7 +1413,7 @@ module Wx
1323
1413
  # Constructor for exclusive use of wxWidgets itself.
1324
1414
  # Note that the objects of this class can not be created from application code, they're only created by the library itself. If you need a window to be repainted, use {Wx::Window#refresh} instead of trying to manually create an event of this class.
1325
1415
  # @param window [Wx::Window]
1326
- # @return [PaintEvent]
1416
+ # @return [Wx::PaintEvent]
1327
1417
  def initialize(window) end
1328
1418
 
1329
1419
  end # PaintEvent
@@ -1336,6 +1426,7 @@ module Wx
1336
1426
  #
1337
1427
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::EraseEvent} events.
1338
1428
  # Event handler methods:
1429
+ #
1339
1430
  # - {Wx::EvtHandler#evt_erase_background}(meth = nil, &block): Process a {Wx::EVT_ERASE_BACKGROUND} event.
1340
1431
  #
1341
1432
  # ===
@@ -1349,7 +1440,7 @@ module Wx
1349
1440
  # Constructor.
1350
1441
  # @param id [Integer]
1351
1442
  # @param dc [Wx::DC]
1352
- # @return [EraseEvent]
1443
+ # @return [Wx::EraseEvent]
1353
1444
  def initialize(id=0, dc=nil) end
1354
1445
 
1355
1446
  # Returns the device context associated with the erase event to draw on.
@@ -1368,7 +1459,9 @@ module Wx
1368
1459
  #
1369
1460
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FocusEvent} events.
1370
1461
  # Event handler methods:
1462
+ #
1371
1463
  # - {Wx::EvtHandler#evt_set_focus}(meth = nil, &block): Process a {Wx::EVT_SET_FOCUS} event.
1464
+ #
1372
1465
  # - {Wx::EvtHandler#evt_kill_focus}(meth = nil, &block): Process a {Wx::EVT_KILL_FOCUS} event.
1373
1466
  #
1374
1467
  # ===
@@ -1380,9 +1473,9 @@ module Wx
1380
1473
  class FocusEvent < Event
1381
1474
 
1382
1475
  # Constructor.
1383
- # @param eventType [Integer]
1476
+ # @param eventType [Wx::AUI::AuiMDIChildFrame::EventType]
1384
1477
  # @param id [Integer]
1385
- # @return [FocusEvent]
1478
+ # @return [Wx::FocusEvent]
1386
1479
  def initialize(eventType=Wx::EVT_NULL, id=0) end
1387
1480
 
1388
1481
  # Returns the window associated with this event, that is the window which had the focus before for the {Wx::EVT_SET_FOCUS} event and the window which is going to receive focus for the {Wx::EVT_KILL_FOCUS} one.
@@ -1403,11 +1496,14 @@ module Wx
1403
1496
  #
1404
1497
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ActivateEvent} events.
1405
1498
  # Event handler methods:
1499
+ #
1406
1500
  # - {Wx::EvtHandler#evt_activate}(meth = nil, &block): Process a {Wx::EVT_ACTIVATE} event.
1501
+ #
1407
1502
  # - {Wx::EvtHandler#evt_activate_app}(meth = nil, &block): Process a {Wx::EVT_ACTIVATE_APP} event. This event is received by the {Wx::App}-derived instance only.
1503
+ #
1408
1504
  # - {Wx::EvtHandler#evt_hibernate}(meth = nil, &block): Process a hibernate event, supplying the member function. This event applies to {Wx::App} only, and only on Windows SmartPhone and PocketPC. It is generated when the system is low on memory; the application should free up as much memory as possible, and restore full working state when it receives a {Wx::EVT_ACTIVATE} or {Wx::EVT_ACTIVATE_APP} event.
1409
1505
  #
1410
- # Until wxWidgets 3.1.0 activation events could be sent by {Wx::MSW} when the window was minimized. This reflected the native MSW behaviour but was often surprising and unexpected, so starting from 3.1.0 such events are not sent any more when the window is in the minimized state.
1506
+ # Until wxWidgets 3.1.0 activation events could be sent by wxMSW when the window was minimized. This reflected the native MSW behaviour but was often surprising and unexpected, so starting from 3.1.0 such events are not sent any more when the window is in the minimized state.
1411
1507
  #
1412
1508
  # ===
1413
1509
  #
@@ -1435,11 +1531,11 @@ module Wx
1435
1531
  end # Reason
1436
1532
 
1437
1533
  # Constructor.
1438
- # @param eventType [Integer]
1534
+ # @param eventType [Wx::AUI::AuiMDIChildFrame::EventType]
1439
1535
  # @param active [true,false]
1440
1536
  # @param id [Integer]
1441
1537
  # @param activationReason [Reason]
1442
- # @return [ActivateEvent]
1538
+ # @return [Wx::ActivateEvent]
1443
1539
  def initialize(eventType=Wx::EVT_NULL, active=true, id=0, activationReason=Wx::ActivateEvent::Reason::Reason_Unknown) end
1444
1540
 
1445
1541
  # Returns true if the application or window is being activated, false otherwise.
@@ -1448,7 +1544,7 @@ module Wx
1448
1544
  alias_method :active, :get_active
1449
1545
 
1450
1546
  # Allows checking if the window was activated by clicking it with the mouse or in some other way.
1451
- # This method is currently only implemented in {Wx::MSW} and returns Reason_Mouse there if the window was activated by a mouse click and Reason_Unknown if it was activated in any other way (e.g. from keyboard or programmatically).
1547
+ # This method is currently only implemented in wxMSW and returns Reason_Mouse there if the window was activated by a mouse click and Reason_Unknown if it was activated in any other way (e.g. from keyboard or programmatically).
1452
1548
  # Under all the other platforms, Reason_Unknown is always returned.
1453
1549
  # @return [Reason]
1454
1550
  def get_activation_reason; end
@@ -1463,6 +1559,7 @@ module Wx
1463
1559
  #
1464
1560
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::InitDialogEvent} events.
1465
1561
  # Event handler methods:
1562
+ #
1466
1563
  # - {Wx::EvtHandler#evt_init_dialog}(meth = nil, &block): Process a {Wx::EVT_INIT_DIALOG} event.
1467
1564
  #
1468
1565
  # ===
@@ -1475,7 +1572,7 @@ module Wx
1475
1572
 
1476
1573
  # Constructor.
1477
1574
  # @param id [Integer]
1478
- # @return [InitDialogEvent]
1575
+ # @return [Wx::InitDialogEvent]
1479
1576
  def initialize(id=0) end
1480
1577
 
1481
1578
  end # InitDialogEvent
@@ -1483,7 +1580,11 @@ module Wx
1483
1580
  # This class is used for a variety of menu-related events.
1484
1581
  # Note that these do not include menu command events, which are handled using {Wx::CommandEvent} objects.
1485
1582
  # Events of this class are generated by both menus that are part of a {Wx::MenuBar}, attached to {Wx::Frame}, and popup menus shown by {Wx::Window#popup_menu}. They are sent to the following objects until one of them handles the event:
1486
- # - The menu object itself, as returned by {Wx::MenuEvent#get_menu}, if any.- The {Wx::MenuBar} to which this menu is attached, if any.- The window associated with the menu, e.g. the one calling PopupMenu() for the popup menus.- The top level parent of that window if it's different from the window itself.
1583
+ #
1584
+ # - The menu object itself, as returned by {Wx::MenuEvent#get_menu}, if any.
1585
+ # - The {Wx::MenuBar} to which this menu is attached, if any.
1586
+ # - The window associated with the menu, e.g. the one calling PopupMenu() for the popup menus.
1587
+ # - The top level parent of that window if it's different from the window itself.
1487
1588
  #
1488
1589
  # This is similar to command events generated by the menu items, but, unlike them, {Wx::MenuEvent} are only sent to the window itself and its top level parent but not any intermediate windows in the hierarchy.
1489
1590
  # The default handler for {Wx::EVT_MENU_HIGHLIGHT} in {Wx::Frame} displays help text in the status bar, see {Wx::Frame#set_status_bar_pane}.
@@ -1491,9 +1592,13 @@ module Wx
1491
1592
  #
1492
1593
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MenuEvent} events.
1493
1594
  # Event handler methods:
1595
+ #
1494
1596
  # - {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).
1597
+ #
1495
1598
  # - {Wx::EvtHandler#evt_menu_close}(meth = nil, &block): A menu has been just closed. Notice that this event is currently being sent before the menu selection ({Wx::EVT_MENU}) event, if any.
1599
+ #
1496
1600
  # - {Wx::EvtHandler#evt_menu_highlight}(id, meth = nil, &block): The menu item with the specified id has been highlighted: used to show help prompts in the status bar by {Wx::Frame}
1601
+ #
1497
1602
  # - {Wx::EvtHandler#evt_menu_highlight_all}(meth = nil, &block): A menu item has been highlighted, i.e. the currently selected menu item has changed.
1498
1603
  #
1499
1604
  # ===
@@ -1506,14 +1611,14 @@ module Wx
1506
1611
  class MenuEvent < Event
1507
1612
 
1508
1613
  # Constructor.
1509
- # @param type [Integer]
1614
+ # @param type [Wx::AUI::AuiMDIChildFrame::EventType]
1510
1615
  # @param id [Integer]
1511
1616
  # @param menu [Wx::Menu]
1512
- # @return [MenuEvent]
1617
+ # @return [Wx::MenuEvent]
1513
1618
  def initialize(type=Wx::EVT_NULL, id=0, menu=nil) end
1514
1619
 
1515
1620
  # Returns the menu which is being opened or closed, or the menu containing the highlighted item.
1516
- # Note that the returned value can be NULL if the menu being opened doesn't have a corresponding {Wx::Menu}, e.g. this happens when opening the system menu in {Wx::MSW} port.
1621
+ # Note that the returned value can be NULL if the menu being opened doesn't have a corresponding {Wx::Menu}, e.g. this happens when opening the system menu in wxMSW port.
1517
1622
  # Since 3.1.3 this function can be used with OPEN, CLOSE and HIGHLIGHT events. Before 3.1.3, this method can only be used with the OPEN and CLOSE events.
1518
1623
  # @return [Wx::Menu]
1519
1624
  def get_menu; end
@@ -1562,8 +1667,11 @@ module Wx
1562
1667
  #
1563
1668
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CloseEvent} events.
1564
1669
  # Event handler methods:
1670
+ #
1565
1671
  # - {Wx::EvtHandler#evt_close}(meth = nil, &block): Process a {Wx::EVT_CLOSE_WINDOW} command event, supplying the member function. This event applies to {Wx::Frame} and {Wx::Dialog} classes.
1672
+ #
1566
1673
  # - {Wx::EvtHandler#evt_query_end_session}(meth = nil, &block): Process a {Wx::EVT_QUERY_END_SESSION} session event, supplying the member function. This event can be handled in {Wx::App}-derived class only.
1674
+ #
1567
1675
  # - {Wx::EvtHandler#evt_end_session}(meth = nil, &block): Process a {Wx::EVT_END_SESSION} session event, supplying the member function. This event can be handled in {Wx::App}-derived class only.
1568
1676
  #
1569
1677
  # ===
@@ -1576,9 +1684,9 @@ module Wx
1576
1684
  class CloseEvent < Event
1577
1685
 
1578
1686
  # Constructor.
1579
- # @param commandEventType [Integer]
1687
+ # @param commandEventType [Wx::AUI::AuiMDIChildFrame::EventType]
1580
1688
  # @param id [Integer]
1581
- # @return [CloseEvent]
1689
+ # @return [Wx::CloseEvent]
1582
1690
  def initialize(commandEventType=Wx::EVT_NULL, id=0) end
1583
1691
 
1584
1692
  # Returns true if you can veto a system shutdown or a window close event.
@@ -1618,11 +1726,12 @@ module Wx
1618
1726
  end # CloseEvent
1619
1727
 
1620
1728
  # An event being sent when the window is shown or hidden.
1621
- # The event is triggered by calls to {Wx::Window#show}, and any user action showing a previously hidden window or vice versa (if allowed by the current platform and/or window manager). Notice that the event is not triggered when the application is iconized (minimized) or restored under {Wx::MSW}.
1729
+ # The event is triggered by calls to {Wx::Window#show}, and any user action showing a previously hidden window or vice versa (if allowed by the current platform and/or window manager). Notice that the event is not triggered when the application is iconized (minimized) or restored under wxMSW.
1622
1730
  # === Events using this class
1623
1731
  #
1624
1732
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ShowEvent} events.
1625
1733
  # Event handler methods:
1734
+ #
1626
1735
  # - {Wx::EvtHandler#evt_show}(meth = nil, &block): Process a {Wx::EVT_SHOW} event.
1627
1736
  #
1628
1737
  # ===
@@ -1638,7 +1747,7 @@ module Wx
1638
1747
  # Constructor.
1639
1748
  # @param winid [Integer]
1640
1749
  # @param show [true,false]
1641
- # @return [ShowEvent]
1750
+ # @return [Wx::ShowEvent]
1642
1751
  def initialize(winid=0, show=false) end
1643
1752
 
1644
1753
  # Set whether the windows was shown or hidden.
@@ -1659,6 +1768,7 @@ module Wx
1659
1768
  #
1660
1769
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::IconizeEvent} events.
1661
1770
  # Event handler methods:
1771
+ #
1662
1772
  # - {Wx::EvtHandler#evt_iconize}(meth = nil, &block): Process a {Wx::EVT_ICONIZE} event.
1663
1773
  #
1664
1774
  # ===
@@ -1674,7 +1784,7 @@ module Wx
1674
1784
  # Constructor.
1675
1785
  # @param id [Integer]
1676
1786
  # @param iconized [true,false]
1677
- # @return [IconizeEvent]
1787
+ # @return [Wx::IconizeEvent]
1678
1788
  def initialize(id=0, iconized=true) end
1679
1789
 
1680
1790
  # Returns true if the frame has been iconized, false if it has been restored.
@@ -1686,11 +1796,12 @@ module Wx
1686
1796
 
1687
1797
  # An event being sent when a top level window is maximized.
1688
1798
  # Notice that it is not sent when the window is restored to its original size after it had been maximized, only a normal {Wx::SizeEvent} is generated in this case.
1689
- # Currently this event is only generated in {Wx::MSW}, {Wx::GTK} and {Wx::OSX}/Cocoa ports so portable programs should only rely on receiving {Wx::EVT_SIZE} and not necessarily this event when the window is maximized.
1799
+ # Currently this event is only generated in wxMSW, wxGTK and wxOSX/Cocoa ports so portable programs should only rely on receiving {Wx::EVT_SIZE} and not necessarily this event when the window is maximized.
1690
1800
  # === Events using this class
1691
1801
  #
1692
1802
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MaximizeEvent} events.
1693
1803
  # Event handler methods:
1804
+ #
1694
1805
  # - {Wx::EvtHandler#evt_maximize}(meth = nil, &block): Process a {Wx::EVT_MAXIMIZE} event.
1695
1806
  #
1696
1807
  # ===
@@ -1706,17 +1817,18 @@ module Wx
1706
1817
  # Constructor.
1707
1818
  # Only used by wxWidgets internally.
1708
1819
  # @param id [Integer]
1709
- # @return [MaximizeEvent]
1820
+ # @return [Wx::MaximizeEvent]
1710
1821
  def initialize(id=0) end
1711
1822
 
1712
1823
  end # MaximizeEvent
1713
1824
 
1714
1825
  # An event being sent when the user enters or exits full screen mode.
1715
- # Currently this event is only generated in the {Wx::OSX}/Cocoa port when {Wx::TopLevelWindow#enable_full_screen_view} is enabled and the user the user enters or exits full screen. Note that this event is not generated when {Wx::TopLevelWindow#show_full_screen}.
1826
+ # Currently this event is only generated in the wxOSX/Cocoa port when {Wx::TopLevelWindow#enable_full_screen_view} is enabled and the user the user enters or exits full screen. Note that this event is not generated when {Wx::TopLevelWindow#show_full_screen}.
1716
1827
  # === Events using this class
1717
1828
  #
1718
1829
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FullScreenEvent} events.
1719
1830
  # Event handler methods:
1831
+ #
1720
1832
  # - {Wx::EvtHandler#evt_fullscreen}(meth = nil, &block): Process a {Wx::EVT_FULLSCREEN} event.
1721
1833
  #
1722
1834
  # ===
@@ -1732,7 +1844,7 @@ module Wx
1732
1844
  # Constructor.
1733
1845
  # @param id [Integer]
1734
1846
  # @param fullscreen [true,false]
1735
- # @return [FullScreenEvent]
1847
+ # @return [Wx::FullScreenEvent]
1736
1848
  def initialize(id=0, fullscreen=true) end
1737
1849
 
1738
1850
  # Returns true if the frame entered full screen, false if exited full screen.
@@ -1747,10 +1859,15 @@ module Wx
1747
1859
  #
1748
1860
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::JoystickEvent} events.
1749
1861
  # Event handler methods:
1862
+ #
1750
1863
  # - {Wx::EvtHandler#evt_joy_button_down}(meth = nil, &block): Process a {Wx::EVT_JOY_BUTTON_DOWN} event.
1864
+ #
1751
1865
  # - {Wx::EvtHandler#evt_joy_button_up}(meth = nil, &block): Process a {Wx::EVT_JOY_BUTTON_UP} event.
1866
+ #
1752
1867
  # - {Wx::EvtHandler#evt_joy_move}(meth = nil, &block): Process a {Wx::EVT_JOY_MOVE} event.
1868
+ #
1753
1869
  # - {Wx::EvtHandler#evt_joy_zmove}(meth = nil, &block): Process a {Wx::EVT_JOY_ZMOVE} event.
1870
+ #
1754
1871
  # - {Wx::EvtHandler#evt_joystick_events}(meth = nil, &block): Processes all joystick events.
1755
1872
  #
1756
1873
  # ===
@@ -1762,11 +1879,11 @@ module Wx
1762
1879
  class JoystickEvent < Event
1763
1880
 
1764
1881
  # Constructor.
1765
- # @param eventType [Integer]
1882
+ # @param eventType [Wx::AUI::AuiMDIChildFrame::EventType]
1766
1883
  # @param state [Integer]
1767
1884
  # @param joystick [Integer]
1768
1885
  # @param change [Integer]
1769
- # @return [JoystickEvent]
1886
+ # @return [Wx::JoystickEvent]
1770
1887
  def initialize(eventType=Wx::EVT_NULL, state=0, joystick=wxJOYSTICK1, change=0) end
1771
1888
 
1772
1889
  # Returns true if the event was a down event from the specified button (or any button).
@@ -1849,6 +1966,7 @@ module Wx
1849
1966
  #
1850
1967
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DropFilesEvent} events.
1851
1968
  # Event handler methods:
1969
+ #
1852
1970
  # - {Wx::EvtHandler#evt_drop_files}(meth = nil, &block): Process a {Wx::EVT_DROP_FILES} event.
1853
1971
  #
1854
1972
  # Windows only until version 2.8.9, available on all platforms since 2.8.10.
@@ -1863,10 +1981,10 @@ module Wx
1863
1981
  class DropFilesEvent < Event
1864
1982
 
1865
1983
  # Constructor.
1866
- # @param id [Integer]
1984
+ # @param id [Wx::AUI::AuiMDIChildFrame::EventType]
1867
1985
  # @param noFiles [Integer]
1868
1986
  # @param files [String]
1869
- # @return [DropFilesEvent]
1987
+ # @return [Wx::DropFilesEvent]
1870
1988
  def initialize(id=0, noFiles=0, files=nil) end
1871
1989
 
1872
1990
  # Returns an array of filenames.
@@ -1893,7 +2011,9 @@ module Wx
1893
2011
  # In addition to being a clearer and more declarative method, it also means you don't have to worry whether you're updating a toolbar or menubar identifier. The same handler can update a menu item and toolbar button, if the identifier is the same. Instead of directly manipulating the menu or button, you call functions in the event object, such as {Wx::UpdateUIEvent#check}. wxWidgets will determine whether such a call has been made, and which UI element to update.
1894
2012
  # These events will work for popup menus as well as menubars. Just before a menu is popped up, {Wx::Menu::UpdateUI} is called to process any UI events for the window that owns the menu.
1895
2013
  # If you find that the overhead of UI update processing is affecting your application, you can do one or both of the following:
2014
+ #
1896
2015
  # - Call {Wx::UpdateUIEvent.set_mode} with a value of {Wx::UpdateUIMode::UPDATE_UI_PROCESS_SPECIFIED}, and set the extra style {Wx::WS_EX_PROCESS_UI_UPDATES} for every window that should receive update events. No other windows will receive update events.
2016
+ #
1897
2017
  # - Call {Wx::UpdateUIEvent.set_update_interval} with a millisecond value to set the delay between updates. You may need to call {Wx::Window#update_window_ui} at critical points, for example when a dialog is about to be shown, in case the user sees a slight delay before windows are updated.
1898
2018
  #
1899
2019
  # Note that although events are sent in idle time, defining a {Wx::IdleEvent} handler for a window does not affect this because the events are sent from {Wx::Window#on_internal_idle} which is always called in idle time.
@@ -1902,7 +2022,9 @@ module Wx
1902
2022
  #
1903
2023
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::UpdateUIEvent} events.
1904
2024
  # Event handler methods:
2025
+ #
1905
2026
  # - {Wx::EvtHandler#evt_update_ui}(id, meth = nil, &block): Process a {Wx::EVT_UPDATE_UI} event for the command with the given id.
2027
+ #
1906
2028
  # - {Wx::EvtHandler#evt_update_ui_range}(id1, id2, meth = nil, &block): Process a {Wx::EVT_UPDATE_UI} event for any command with id included in the given range.
1907
2029
  #
1908
2030
  # ===
@@ -1915,7 +2037,7 @@ module Wx
1915
2037
 
1916
2038
  # Constructor.
1917
2039
  # @param commandId [Integer]
1918
- # @return [UpdateUIEvent]
2040
+ # @return [Wx::UpdateUIEvent]
1919
2041
  def initialize(commandId=0) end
1920
2042
 
1921
2043
  # Check or uncheck the UI element.
@@ -2046,6 +2168,7 @@ module Wx
2046
2168
  #
2047
2169
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SysColourChangedEvent} events.
2048
2170
  # Event handler methods:
2171
+ #
2049
2172
  # - {Wx::EvtHandler#evt_sys_colour_changed}(meth = nil, &block): Process a {Wx::EVT_SYS_COLOUR_CHANGED} event.
2050
2173
  #
2051
2174
  # ===
@@ -2057,18 +2180,19 @@ module Wx
2057
2180
  class SysColourChangedEvent < Event
2058
2181
 
2059
2182
  # Constructor.
2060
- # @return [SysColourChangedEvent]
2183
+ # @return [Wx::SysColourChangedEvent]
2061
2184
  def initialize; end
2062
2185
 
2063
2186
  end # SysColourChangedEvent
2064
2187
 
2065
2188
  # A mouse capture changed event is sent to a window that loses its mouse capture.
2066
2189
  # This is called even if {Wx::Window#release_mouse} was called by the application code. Handling this event allows an application to cater for unexpected capture releases which might otherwise confuse mouse handling code.
2067
- # Availability: only available for the {Wx::MSW} port. {Wx::msw}
2190
+ # Availability: only available for the wxMSW port. {Wx::msw}
2068
2191
  # === Events using this class
2069
2192
  #
2070
2193
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MouseCaptureChangedEvent} events.
2071
2194
  # Event handler methods:
2195
+ #
2072
2196
  # - {Wx::EvtHandler#evt_mouse_capture_changed}(meth = nil, &block): Process a {Wx::EVT_MOUSE_CAPTURE_CHANGED} event.
2073
2197
  #
2074
2198
  # ===
@@ -2086,7 +2210,7 @@ module Wx
2086
2210
  # Constructor.
2087
2211
  # @param windowId [Integer]
2088
2212
  # @param gainedCapture [Wx::Window]
2089
- # @return [MouseCaptureChangedEvent]
2213
+ # @return [Wx::MouseCaptureChangedEvent]
2090
2214
  def initialize(windowId=0, gainedCapture=nil) end
2091
2215
 
2092
2216
  # Returns the window that gained the capture, or NULL if it was a non-wxWidgets window.
@@ -2103,9 +2227,10 @@ module Wx
2103
2227
  #
2104
2228
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MouseCaptureLostEvent} events.
2105
2229
  # Event handler methods:
2230
+ #
2106
2231
  # - {Wx::EvtHandler#evt_mouse_capture_lost}(meth = nil, &block): Process a {Wx::EVT_MOUSE_CAPTURE_LOST} event.
2107
2232
  #
2108
- # Availability: only available for the {Wx::MSW} port. {Wx::msw}
2233
+ # Availability: only available for the wxMSW port. {Wx::msw}
2109
2234
  # ===
2110
2235
  #
2111
2236
  # Category: {Wx::Events}
@@ -2120,7 +2245,7 @@ module Wx
2120
2245
 
2121
2246
  # Constructor.
2122
2247
  # @param windowId [Integer]
2123
- # @return [MouseCaptureLostEvent]
2248
+ # @return [Wx::MouseCaptureLostEvent]
2124
2249
  def initialize(windowId=0) end
2125
2250
 
2126
2251
  end # MouseCaptureLostEvent
@@ -2131,9 +2256,10 @@ module Wx
2131
2256
  #
2132
2257
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DisplayChangedEvent} events.
2133
2258
  # Event handler methods:
2259
+ #
2134
2260
  # - {Wx::EvtHandler#evt_display_changed}(meth = nil, &block): Process a {Wx::EVT_DISPLAY_CHANGED} event.
2135
2261
  #
2136
- # Availability: only available for the {Wx::MSW} port. {Wx::msw}
2262
+ # Availability: only available for the wxMSW port. {Wx::msw}
2137
2263
  # ===
2138
2264
  #
2139
2265
  # Category: {Wx::Events}
@@ -2142,7 +2268,7 @@ module Wx
2142
2268
  #
2143
2269
  class DisplayChangedEvent < Event
2144
2270
 
2145
- # @return [DisplayChangedEvent]
2271
+ # @return [Wx::DisplayChangedEvent]
2146
2272
  def initialize; end
2147
2273
 
2148
2274
  end # DisplayChangedEvent
@@ -2150,11 +2276,12 @@ module Wx
2150
2276
  # Event sent when the display scale factor or pixel density (measured in dots-per-inch, or DPI) of the monitor a window is on changes.
2151
2277
  # The event is sent to each {Wx::TopLevelWindow} affected by the change, and all its children recursively (post-order traversal). For example, this event is sent to the window when it is moved, by the user, from a display using some DPI value to another display using a different DPI value. It also sent to all program windows on the given display if its DPI changes due to a change in the system settings.
2152
2278
  # If you define an event handler for this event, you should almost always call <code>event.Skip()</code> in it in order to allow the base class handler to execute, as many controls rely on processing this event in order to update their appearance when the DPI changes. However the default handler for the top level window itself only sets the new window size, by scaling the current size by the DPI ratio e.g. doubling it if the DPI has changed from normal to "high", i.e. 200%, one and also ensuring that the window is still bigger than its best size, as returned by {Wx::Window#get_best_size}. Note that in some cases this may cause the window size to grow unexpectedly and you may prefer to call {Wx::Window#set_size} in your handler of this event for the top level window and not call <code>event.Skip()</code> to prevent the default handler from resizing the window.
2153
- # Currently this event is generated by {Wx::MSW} port if only and only if the MSW application runs under Windows 10 Creators Update (v1703) or later and is marked as being "per-monitor DPI aware", i.e. contains a dpiAwareness tag with the value "PerMonitorV2" in its manifest (see Microsoft "Application Manifests" documentation for more details).
2279
+ # Currently this event is generated by wxMSW port if only and only if the MSW application runs under Windows 10 Creators Update (v1703) or later and is marked as being "per-monitor DPI aware", i.e. contains a dpiAwareness tag with the value "PerMonitorV2" in its manifest (see Microsoft "Application Manifests" documentation for more details).
2154
2280
  # === Events using this class
2155
2281
  #
2156
2282
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DPIChangedEvent} events.
2157
2283
  # Event handler methods:
2284
+ #
2158
2285
  # - {Wx::EvtHandler#evt_dpi_changed}(meth = nil, &block): Process a {Wx::EVT_DPI_CHANGED} event.
2159
2286
  #
2160
2287
  # ===
@@ -2202,7 +2329,7 @@ module Wx
2202
2329
  class PaletteChangedEvent < Event
2203
2330
 
2204
2331
  # @param winid [Integer]
2205
- # @return [PaletteChangedEvent]
2332
+ # @return [Wx::PaletteChangedEvent]
2206
2333
  def initialize(winid=0) end
2207
2334
 
2208
2335
  # @param win [Wx::Window]
@@ -2222,7 +2349,7 @@ module Wx
2222
2349
  class QueryNewPaletteEvent < Event
2223
2350
 
2224
2351
  # @param winid [Integer]
2225
- # @return [QueryNewPaletteEvent]
2352
+ # @return [Wx::QueryNewPaletteEvent]
2226
2353
  def initialize(winid=0) end
2227
2354
 
2228
2355
  # @param realized [true,false]
@@ -2242,6 +2369,7 @@ module Wx
2242
2369
  #
2243
2370
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::NavigationKeyEvent} events.
2244
2371
  # Event handler methods:
2372
+ #
2245
2373
  # - {Wx::EvtHandler#evt_navigation_key}(meth = nil, &block): Process a navigation key event.
2246
2374
  #
2247
2375
  # ===
@@ -2278,10 +2406,10 @@ module Wx
2278
2406
  end # NavigationKeyEventFlags
2279
2407
 
2280
2408
  # @overload initialize()
2281
- # @return [NavigationKeyEvent]
2409
+ # @return [Wx::NavigationKeyEvent]
2282
2410
  # @overload initialize(event)
2283
2411
  # @param event [Wx::NavigationKeyEvent]
2284
- # @return [NavigationKeyEvent]
2412
+ # @return [Wx::NavigationKeyEvent]
2285
2413
  def initialize(*args) end
2286
2414
 
2287
2415
  # Returns the child that has the focus, or NULL.
@@ -2344,6 +2472,7 @@ module Wx
2344
2472
  #
2345
2473
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::WindowCreateEvent} events.
2346
2474
  # Event handler methods:
2475
+ #
2347
2476
  # - {Wx::EvtHandler#evt_window_create}(meth = nil, &block): Process a {Wx::EVT_CREATE} event.
2348
2477
  #
2349
2478
  # ===
@@ -2357,7 +2486,7 @@ module Wx
2357
2486
 
2358
2487
  # Constructor.
2359
2488
  # @param win [Wx::Window]
2360
- # @return [WindowCreateEvent]
2489
+ # @return [Wx::WindowCreateEvent]
2361
2490
  def initialize(win=nil) end
2362
2491
 
2363
2492
  # Return the window being created.
@@ -2382,7 +2511,7 @@ module Wx
2382
2511
 
2383
2512
  # Constructor.
2384
2513
  # @param win [Wx::Window]
2385
- # @return [WindowDestroyEvent]
2514
+ # @return [Wx::WindowDestroyEvent]
2386
2515
  def initialize(win=nil) end
2387
2516
 
2388
2517
  # Return the window being destroyed.
@@ -2401,7 +2530,9 @@ module Wx
2401
2530
  #
2402
2531
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HelpEvent} events.
2403
2532
  # Event handler methods:
2533
+ #
2404
2534
  # - {Wx::EvtHandler#evt_help}(id, meth = nil, &block): Process a {Wx::EVT_HELP} event.
2535
+ #
2405
2536
  # - {Wx::EvtHandler#evt_help_range}(id1, id2, meth = nil, &block): Process a {Wx::EVT_HELP} event for a range of ids.
2406
2537
  #
2407
2538
  # ===
@@ -2435,11 +2566,11 @@ module Wx
2435
2566
  end # Origin
2436
2567
 
2437
2568
  # Constructor.
2438
- # @param type [Integer]
2569
+ # @param type [Wx::AUI::AuiMDIChildFrame::EventType]
2439
2570
  # @param winid [Integer]
2440
2571
  # @param pt [Array(Integer, Integer), Wx::Point]
2441
2572
  # @param origin [Wx::HelpEvent::Origin]
2442
- # @return [HelpEvent]
2573
+ # @return [Wx::HelpEvent]
2443
2574
  def initialize(type=Wx::EVT_NULL, winid=0, pt=Wx::DEFAULT_POSITION, origin=Wx::HelpEvent::Origin::Origin_Unknown) end
2444
2575
 
2445
2576
  # Returns the origin of the help event which is one of the {Wx::HelpEvent::Origin} values.
@@ -2475,14 +2606,17 @@ module Wx
2475
2606
  # There are three types of corresponding events {Wx::EVT_TEXT_COPY}, {Wx::EVT_TEXT_CUT} and {Wx::EVT_TEXT_PASTE}.
2476
2607
  # If any of these events is processed (without being skipped) by an event handler, the corresponding operation doesn't take place which allows preventing the text from being copied from or pasted to a control. It is also possible to examine the clipboard contents in the PASTE event handler and transform it in some way before inserting in a control for example, changing its case or removing invalid characters.
2477
2608
  # Finally notice that a CUT event is always preceded by the COPY event which makes it possible to only process the latter if it doesn't matter if the text was copied or cut.
2478
- # These events are currently only generated by {Wx::TextCtrl} in {Wx::GTK} and {Wx::OSX} but are also generated by {Wx::ComboBox} without {Wx::CB_READONLY} style in {Wx::MSW}.
2609
+ # These events are currently only generated by {Wx::TextCtrl} in wxGTK and wxOSX but are also generated by {Wx::ComboBox} without {Wx::CB_READONLY} style in wxMSW.
2479
2610
  #
2480
2611
  # === Events using this class
2481
2612
  #
2482
2613
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ClipboardTextEvent} events.
2483
2614
  # Event handler methods:
2615
+ #
2484
2616
  # - {Wx::EvtHandler#evt_text_copy}(id, meth = nil, &block): Some or all of the controls content was copied to the clipboard.
2617
+ #
2485
2618
  # - {Wx::EvtHandler#evt_text_cut}(id, meth = nil, &block): Some or all of the controls content was cut (i.e. copied and deleted).
2619
+ #
2486
2620
  # - {Wx::EvtHandler#evt_text_paste}(id, meth = nil, &block): Clipboard content was pasted into the control.
2487
2621
  #
2488
2622
  # ===
@@ -2494,9 +2628,9 @@ module Wx
2494
2628
  class ClipboardTextEvent < CommandEvent
2495
2629
 
2496
2630
  # Constructor.
2497
- # @param commandType [Integer]
2631
+ # @param commandType [Wx::AUI::AuiMDIChildFrame::EventType]
2498
2632
  # @param id [Integer]
2499
- # @return [ClipboardTextEvent]
2633
+ # @return [Wx::ClipboardTextEvent]
2500
2634
  def initialize(commandType=Wx::EVT_NULL, id=0) end
2501
2635
 
2502
2636
  end # ClipboardTextEvent
@@ -2508,6 +2642,7 @@ module Wx
2508
2642
  #
2509
2643
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ContextMenuEvent} events.
2510
2644
  # Event handler methods:
2645
+ #
2511
2646
  # - {Wx::EvtHandler#evt_context_menu}(meth = nil, &block): A right click (or other context menu command depending on platform) has been detected.
2512
2647
  #
2513
2648
  # ===
@@ -2520,10 +2655,10 @@ module Wx
2520
2655
  class ContextMenuEvent < CommandEvent
2521
2656
 
2522
2657
  # Constructor.
2523
- # @param type [Integer]
2658
+ # @param type [Wx::AUI::AuiMDIChildFrame::EventType]
2524
2659
  # @param id [Integer]
2525
2660
  # @param pos [Array(Integer, Integer), Wx::Point]
2526
- # @return [ContextMenuEvent]
2661
+ # @return [Wx::ContextMenuEvent]
2527
2662
  def initialize(type=Wx::EVT_NULL, id=0, pos=Wx::DEFAULT_POSITION) end
2528
2663
 
2529
2664
  # Returns the position in screen coordinates at which the menu should be shown.
@@ -2548,6 +2683,7 @@ module Wx
2548
2683
  #
2549
2684
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ChildFocusEvent} events.
2550
2685
  # Event handler methods:
2686
+ #
2551
2687
  # - {Wx::EvtHandler#evt_child_focus}(meth = nil, &block): Process a {Wx::EVT_CHILD_FOCUS} event.
2552
2688
  #
2553
2689
  # ===
@@ -2560,7 +2696,7 @@ module Wx
2560
2696
 
2561
2697
  # Constructor.
2562
2698
  # @param win [Wx::Window] The direct child which is (or which contains the window which is) receiving the focus.
2563
- # @return [ChildFocusEvent]
2699
+ # @return [Wx::ChildFocusEvent]
2564
2700
  def initialize(win=nil) end
2565
2701
 
2566
2702
  # Returns the direct child which receives the focus, or a (grand-)parent of the control receiving the focus.