wxruby3 0.9.0-x64-mingw-ucrt → 0.9.2-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (466) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -0
  3. data/ext/wxbase32u_gcc_custom.dll +0 -0
  4. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  5. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  6. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  7. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  18. data/lib/wx/aui/aui_tab_ctrl.rb +18 -0
  19. data/lib/wx/aui/auinotebook.rb +6 -2
  20. data/lib/wx/aui/require.rb +1 -0
  21. data/lib/wx/core/app.rb +2 -2
  22. data/lib/wx/core/collapsible_pane.rb +1 -1
  23. data/lib/wx/core/const.rb +83 -0
  24. data/lib/wx/core/controlwithitems.rb +8 -6
  25. data/lib/wx/core/events/evt_list.rb +24 -0
  26. data/lib/wx/core/menu.rb +10 -0
  27. data/lib/wx/core/notebook.rb +6 -2
  28. data/lib/wx/core/sizer.rb +11 -0
  29. data/lib/wx/core/task_bar_button.rb +19 -0
  30. data/lib/wx/core/textctrl.rb +11 -1
  31. data/lib/wx/core/{treectrl.rb → tree_ctrl.rb} +31 -12
  32. data/lib/wx/core/window.rb +10 -0
  33. data/lib/wx/doc/app.rb +48 -38
  34. data/lib/wx/doc/art_locator.rb +47 -43
  35. data/lib/wx/doc/aui/auimanager.rb +16 -8
  36. data/lib/wx/doc/aui/auinotebook.rb +20 -5
  37. data/lib/wx/doc/clipboard.rb +11 -7
  38. data/lib/wx/doc/colour_dialog.rb +14 -10
  39. data/lib/wx/doc/const.rb +66 -66
  40. data/lib/wx/doc/controlwithitems.rb +17 -7
  41. data/lib/wx/doc/data_object.rb +2 -2
  42. data/lib/wx/doc/event.rb +0 -6
  43. data/lib/wx/doc/evthandler.rb +113 -108
  44. data/lib/wx/doc/font.rb +1 -0
  45. data/lib/wx/doc/functions.rb +9 -9
  46. data/lib/wx/doc/gc_dc.rb +6 -1
  47. data/lib/wx/doc/gen/about_dialog_info.rb +1 -2
  48. data/lib/wx/doc/gen/accelerator.rb +14 -5
  49. data/lib/wx/doc/gen/accessible.rb +35 -47
  50. data/lib/wx/doc/gen/activity_indicator.rb +6 -7
  51. data/lib/wx/doc/gen/animation.rb +7 -3
  52. data/lib/wx/doc/gen/animation_ctrl.rb +8 -9
  53. data/lib/wx/doc/gen/any_button.rb +6 -1
  54. data/lib/wx/doc/gen/app.rb +7 -5
  55. data/lib/wx/doc/gen/app_traits.rb +27 -10
  56. data/lib/wx/doc/gen/art_provider.rb +20 -8
  57. data/lib/wx/doc/gen/aui/aui_dock_art.rb +6 -3
  58. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +1 -0
  59. data/lib/wx/doc/gen/aui/aui_manager.rb +11 -7
  60. data/lib/wx/doc/gen/aui/aui_manager_event.rb +3 -4
  61. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +3 -2
  62. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +1 -0
  63. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +8 -3
  64. data/lib/wx/doc/gen/aui/aui_notebook.rb +14 -8
  65. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +4 -4
  66. data/lib/wx/doc/gen/aui/aui_pane_info.rb +9 -2
  67. data/lib/wx/doc/gen/aui/aui_tab_art.rb +3 -3
  68. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +2 -2
  69. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +9 -6
  70. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +2 -2
  71. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +5 -8
  72. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +1 -1
  73. data/lib/wx/doc/gen/aui/event_list.rb +164 -160
  74. data/lib/wx/doc/gen/banner_window.rb +3 -3
  75. data/lib/wx/doc/gen/bitmap.rb +34 -17
  76. data/lib/wx/doc/gen/bitmap_button.rb +13 -10
  77. data/lib/wx/doc/gen/bitmap_combo_box.rb +16 -12
  78. data/lib/wx/doc/gen/book_ctrl_base.rb +16 -4
  79. data/lib/wx/doc/gen/book_ctrl_event.rb +7 -3
  80. data/lib/wx/doc/gen/box_sizer.rb +0 -1
  81. data/lib/wx/doc/gen/brush.rb +5 -2
  82. data/lib/wx/doc/gen/busy_info.rb +2 -2
  83. data/lib/wx/doc/gen/button.rb +25 -13
  84. data/lib/wx/doc/gen/calculate_layout_event.rb +1 -3
  85. data/lib/wx/doc/gen/calendar_ctrl.rb +18 -15
  86. data/lib/wx/doc/gen/calendar_date_attr.rb +1 -1
  87. data/lib/wx/doc/gen/calendar_event.rb +4 -3
  88. data/lib/wx/doc/gen/caret.rb +0 -1
  89. data/lib/wx/doc/gen/check_box.rb +9 -9
  90. data/lib/wx/doc/gen/check_list_box.rb +8 -9
  91. data/lib/wx/doc/gen/choice.rb +18 -11
  92. data/lib/wx/doc/gen/choicebook.rb +6 -7
  93. data/lib/wx/doc/gen/client_dc.rb +5 -2
  94. data/lib/wx/doc/gen/clipboard.rb +7 -3
  95. data/lib/wx/doc/gen/collapsible_pane.rb +8 -9
  96. data/lib/wx/doc/gen/collapsible_pane_event.rb +2 -3
  97. data/lib/wx/doc/gen/colour.rb +8 -4
  98. data/lib/wx/doc/gen/colour_dialog.rb +6 -8
  99. data/lib/wx/doc/gen/colour_picker_ctrl.rb +11 -12
  100. data/lib/wx/doc/gen/colour_picker_event.rb +4 -5
  101. data/lib/wx/doc/gen/combo_box.rb +20 -17
  102. data/lib/wx/doc/gen/combo_ctrl.rb +100 -37
  103. data/lib/wx/doc/gen/command_link_button.rb +6 -7
  104. data/lib/wx/doc/gen/context_help_button.rb +7 -3
  105. data/lib/wx/doc/gen/control.rb +12 -10
  106. data/lib/wx/doc/gen/control_with_items.rb +0 -1
  107. data/lib/wx/doc/gen/core.rb +4 -4
  108. data/lib/wx/doc/gen/cursor.rb +6 -8
  109. data/lib/wx/doc/gen/data_format.rb +6 -1
  110. data/lib/wx/doc/gen/data_object.rb +16 -14
  111. data/lib/wx/doc/gen/date_event.rb +2 -2
  112. data/lib/wx/doc/gen/date_picker_ctrl.rb +14 -10
  113. data/lib/wx/doc/gen/dc.rb +155 -37
  114. data/lib/wx/doc/gen/defs.rb +54 -54
  115. data/lib/wx/doc/gen/dial_up_event.rb +41 -0
  116. data/lib/wx/doc/gen/dial_up_manager.rb +137 -0
  117. data/lib/wx/doc/gen/dialog.rb +35 -15
  118. data/lib/wx/doc/gen/dir_dialog.rb +17 -5
  119. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -0
  120. data/lib/wx/doc/gen/dir_picker_ctrl.rb +11 -12
  121. data/lib/wx/doc/gen/drag_drop.rb +11 -10
  122. data/lib/wx/doc/gen/drag_image.rb +6 -2
  123. data/lib/wx/doc/gen/editable_list_box.rb +4 -4
  124. data/lib/wx/doc/gen/event.rb +42 -20
  125. data/lib/wx/doc/gen/event_blocker.rb +1 -3
  126. data/lib/wx/doc/gen/event_list.rb +1656 -1624
  127. data/lib/wx/doc/gen/events.rb +170 -181
  128. data/lib/wx/doc/gen/evt_handler.rb +11 -3
  129. data/lib/wx/doc/gen/ext_help_controller.rb +1 -1
  130. data/lib/wx/doc/gen/file_ctrl.rb +209 -0
  131. data/lib/wx/doc/gen/file_ctrl_event.rb +79 -0
  132. data/lib/wx/doc/gen/file_dialog.rb +32 -15
  133. data/lib/wx/doc/gen/file_dialog_custom_control.rb +7 -0
  134. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +2 -3
  135. data/lib/wx/doc/gen/file_dir_picker_event.rb +3 -4
  136. data/lib/wx/doc/gen/file_picker_ctrl.rb +10 -11
  137. data/lib/wx/doc/gen/file_system.rb +38 -15
  138. data/lib/wx/doc/gen/find_dialog_event.rb +5 -4
  139. data/lib/wx/doc/gen/find_replace_data.rb +1 -1
  140. data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
  141. data/lib/wx/doc/gen/flex_grid_sizer.rb +0 -1
  142. data/lib/wx/doc/gen/font.rb +31 -20
  143. data/lib/wx/doc/gen/font_data.rb +3 -4
  144. data/lib/wx/doc/gen/font_dialog.rb +1 -2
  145. data/lib/wx/doc/gen/font_picker_ctrl.rb +8 -9
  146. data/lib/wx/doc/gen/font_picker_event.rb +2 -3
  147. data/lib/wx/doc/gen/frame.rb +60 -19
  148. data/lib/wx/doc/gen/fs_file.rb +17 -10
  149. data/lib/wx/doc/gen/gauge.rb +13 -10
  150. data/lib/wx/doc/gen/gb_sizer_item.rb +0 -1
  151. data/lib/wx/doc/gen/gcdc.rb +1 -2
  152. data/lib/wx/doc/gen/gdi_common.rb +30 -11
  153. data/lib/wx/doc/gen/gdi_object.rb +0 -1
  154. data/lib/wx/doc/gen/generic_dir_ctrl.rb +8 -9
  155. data/lib/wx/doc/gen/graphics_context.rb +59 -12
  156. data/lib/wx/doc/gen/graphics_object.rb +11 -6
  157. data/lib/wx/doc/gen/grid/event_list.rb +168 -164
  158. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +1 -0
  159. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +2 -1
  160. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -2
  161. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +1 -1
  162. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +1 -2
  163. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -2
  164. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +1 -2
  165. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +1 -1
  166. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +1 -1
  167. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +2 -2
  168. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +1 -1
  169. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +1 -1
  170. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +1 -1
  171. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -2
  172. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +1 -2
  173. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +1 -2
  174. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -2
  175. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +1 -1
  176. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -2
  177. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -2
  178. data/lib/wx/doc/gen/grid/grid_ctrl.rb +29 -7
  179. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +3 -4
  180. data/lib/wx/doc/gen/grid/grid_event.rb +3 -4
  181. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +3 -4
  182. data/lib/wx/doc/gen/grid/grid_size_event.rb +3 -4
  183. data/lib/wx/doc/gen/grid/grid_string_table.rb +1 -0
  184. data/lib/wx/doc/gen/grid/grid_table_base.rb +1 -2
  185. data/lib/wx/doc/gen/grid/grid_table_message.rb +1 -0
  186. data/lib/wx/doc/gen/grid_bag_sizer.rb +0 -6
  187. data/lib/wx/doc/gen/grid_sizer.rb +0 -1
  188. data/lib/wx/doc/gen/gui_event_loop.rb +2 -4
  189. data/lib/wx/doc/gen/header_ctrl.rb +7 -14
  190. data/lib/wx/doc/gen/header_ctrl_event.rb +1 -3
  191. data/lib/wx/doc/gen/help_controller.rb +42 -3
  192. data/lib/wx/doc/gen/help_provider.rb +12 -3
  193. data/lib/wx/doc/gen/html/event_list.rb +41 -37
  194. data/lib/wx/doc/gen/html/html_cell.rb +23 -6
  195. data/lib/wx/doc/gen/html/html_cell_event.rb +3 -4
  196. data/lib/wx/doc/gen/html/html_easy_printing.rb +8 -3
  197. data/lib/wx/doc/gen/html/html_help_controller.rb +47 -2
  198. data/lib/wx/doc/gen/html/html_help_data.rb +3 -1
  199. data/lib/wx/doc/gen/html/html_help_window.rb +1 -1
  200. data/lib/wx/doc/gen/html/html_link_event.rb +2 -3
  201. data/lib/wx/doc/gen/html/html_list_box.rb +10 -12
  202. data/lib/wx/doc/gen/html/html_printout.rb +1 -2
  203. data/lib/wx/doc/gen/html/html_window.rb +13 -7
  204. data/lib/wx/doc/gen/hyperlink_ctrl.rb +9 -9
  205. data/lib/wx/doc/gen/hyperlink_event.rb +2 -3
  206. data/lib/wx/doc/gen/icon.rb +5 -29
  207. data/lib/wx/doc/gen/icon_location.rb +0 -1
  208. data/lib/wx/doc/gen/image.rb +83 -17
  209. data/lib/wx/doc/gen/image_list.rb +15 -6
  210. data/lib/wx/doc/gen/info_bar.rb +2 -2
  211. data/lib/wx/doc/gen/keyboard_state.rb +0 -1
  212. data/lib/wx/doc/gen/list_box.rb +33 -21
  213. data/lib/wx/doc/gen/list_ctrl.rb +79 -32
  214. data/lib/wx/doc/gen/list_event.rb +3 -4
  215. data/lib/wx/doc/gen/listbook.rb +6 -7
  216. data/lib/wx/doc/gen/locale.rb +46 -4
  217. data/lib/wx/doc/gen/log.rb +16 -12
  218. data/lib/wx/doc/gen/mdi_client_window.rb +8 -2
  219. data/lib/wx/doc/gen/mdi_frame.rb +32 -11
  220. data/lib/wx/doc/gen/media_ctrl.rb +28 -20
  221. data/lib/wx/doc/gen/media_event.rb +5 -4
  222. data/lib/wx/doc/gen/memory_dc.rb +6 -6
  223. data/lib/wx/doc/gen/menu.rb +37 -23
  224. data/lib/wx/doc/gen/menu_bar.rb +52 -12
  225. data/lib/wx/doc/gen/menu_item.rb +117 -95
  226. data/lib/wx/doc/gen/message_dialog.rb +7 -8
  227. data/lib/wx/doc/gen/mini_frame.rb +13 -7
  228. data/lib/wx/doc/gen/mirror_dc.rb +0 -2
  229. data/lib/wx/doc/gen/mouse_state.rb +0 -1
  230. data/lib/wx/doc/gen/multi_choice_dialog.rb +7 -4
  231. data/lib/wx/doc/gen/non_owned_window.rb +1 -1
  232. data/lib/wx/doc/gen/notebook.rb +19 -11
  233. data/lib/wx/doc/gen/number_entry_dialog.rb +1 -1
  234. data/lib/wx/doc/gen/object.rb +0 -1
  235. data/lib/wx/doc/gen/paint_dc.rb +0 -1
  236. data/lib/wx/doc/gen/palette.rb +0 -1
  237. data/lib/wx/doc/gen/panel.rb +19 -10
  238. data/lib/wx/doc/gen/pen.rb +17 -8
  239. data/lib/wx/doc/gen/pg/event_list.rb +97 -93
  240. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +2 -0
  241. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +9 -1
  242. data/lib/wx/doc/gen/pg/pg_cell.rb +8 -5
  243. data/lib/wx/doc/gen/pg/pg_editor.rb +115 -16
  244. data/lib/wx/doc/gen/pg/pg_multi_button.rb +1 -2
  245. data/lib/wx/doc/gen/pg/pg_properties.rb +515 -83
  246. data/lib/wx/doc/gen/pg/pg_property.rb +296 -69
  247. data/lib/wx/doc/gen/pg/pg_validation_info.rb +9 -4
  248. data/lib/wx/doc/gen/pg/property_grid.rb +83 -22
  249. data/lib/wx/doc/gen/pg/property_grid_event.rb +31 -9
  250. data/lib/wx/doc/gen/pg/property_grid_interface.rb +212 -34
  251. data/lib/wx/doc/gen/pg/property_grid_manager.rb +42 -12
  252. data/lib/wx/doc/gen/pg/property_grid_page.rb +26 -8
  253. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +13 -4
  254. data/lib/wx/doc/gen/picker_base.rb +12 -5
  255. data/lib/wx/doc/gen/platform_info.rb +4 -9
  256. data/lib/wx/doc/gen/popup_window.rb +2 -5
  257. data/lib/wx/doc/gen/progress_dialog.rb +1 -0
  258. data/lib/wx/doc/gen/property_sheet_dialog.rb +15 -5
  259. data/lib/wx/doc/gen/prt/event_list.rb +8 -4
  260. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +1 -1
  261. data/lib/wx/doc/gen/prt/post_script_dc.rb +2 -2
  262. data/lib/wx/doc/gen/prt/preview_frame.rb +2 -2
  263. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +4 -1
  264. data/lib/wx/doc/gen/prt/print_data.rb +4 -3
  265. data/lib/wx/doc/gen/prt/print_dialog.rb +1 -1
  266. data/lib/wx/doc/gen/prt/printer.rb +50 -11
  267. data/lib/wx/doc/gen/prt/printer_dc.rb +1 -1
  268. data/lib/wx/doc/gen/query_layout_info_event.rb +1 -3
  269. data/lib/wx/doc/gen/radio_box.rb +13 -14
  270. data/lib/wx/doc/gen/radio_button.rb +15 -11
  271. data/lib/wx/doc/gen/rbn/event_list.rb +127 -123
  272. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +19 -3
  273. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +3 -4
  274. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +2 -2
  275. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +18 -6
  276. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +2 -2
  277. data/lib/wx/doc/gen/rbn/ribbon_control.rb +2 -2
  278. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +4 -4
  279. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -3
  280. data/lib/wx/doc/gen/rbn/ribbon_page.rb +1 -2
  281. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +5 -4
  282. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +2 -3
  283. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +2 -3
  284. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +2 -1
  285. data/lib/wx/doc/gen/rearrange_ctrl.rb +3 -4
  286. data/lib/wx/doc/gen/rearrange_list.rb +5 -6
  287. data/lib/wx/doc/gen/region.rb +75 -17
  288. data/lib/wx/doc/gen/region_iterator.rb +0 -1
  289. data/lib/wx/doc/gen/rtc/event_list.rb +116 -112
  290. data/lib/wx/doc/gen/rtc/rich_text_box.rb +3 -2
  291. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +6 -9
  292. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -2
  293. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +3 -6
  294. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +12 -9
  295. data/lib/wx/doc/gen/rtc/rich_text_event.rb +3 -4
  296. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +3 -5
  297. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +4 -5
  298. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +3 -2
  299. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +2 -3
  300. data/lib/wx/doc/gen/rtc/rich_text_image.rb +2 -4
  301. data/lib/wx/doc/gen/rtc/rich_text_object.rb +28 -23
  302. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +7 -11
  303. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +3 -3
  304. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +14 -14
  305. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +3 -3
  306. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +3 -4
  307. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +3 -4
  308. data/lib/wx/doc/gen/sash_event.rb +12 -4
  309. data/lib/wx/doc/gen/sash_layout_window.rb +13 -6
  310. data/lib/wx/doc/gen/sash_window.rb +4 -5
  311. data/lib/wx/doc/gen/screen_dc.rb +0 -1
  312. data/lib/wx/doc/gen/scroll_bar.rb +21 -12
  313. data/lib/wx/doc/gen/scrolled_canvas.rb +34 -12
  314. data/lib/wx/doc/gen/scrolled_control.rb +34 -12
  315. data/lib/wx/doc/gen/scrolled_window.rb +34 -12
  316. data/lib/wx/doc/gen/search_ctrl.rb +10 -11
  317. data/lib/wx/doc/gen/simplebook.rb +1 -1
  318. data/lib/wx/doc/gen/single_choice_dialog.rb +7 -4
  319. data/lib/wx/doc/gen/sizer.rb +12 -7
  320. data/lib/wx/doc/gen/sizer_item.rb +5 -2
  321. data/lib/wx/doc/gen/slider.rb +29 -19
  322. data/lib/wx/doc/gen/spin_button.rb +16 -11
  323. data/lib/wx/doc/gen/spin_ctrl.rb +24 -9
  324. data/lib/wx/doc/gen/spin_ctrl_double.rb +6 -7
  325. data/lib/wx/doc/gen/spin_double_event.rb +3 -4
  326. data/lib/wx/doc/gen/spin_event.rb +3 -3
  327. data/lib/wx/doc/gen/splash_screen.rb +1 -2
  328. data/lib/wx/doc/gen/splitter_event.rb +3 -4
  329. data/lib/wx/doc/gen/splitter_window.rb +78 -20
  330. data/lib/wx/doc/gen/static_bitmap.rb +12 -7
  331. data/lib/wx/doc/gen/static_box.rb +13 -11
  332. data/lib/wx/doc/gen/static_box_sizer.rb +0 -2
  333. data/lib/wx/doc/gen/static_line.rb +5 -6
  334. data/lib/wx/doc/gen/static_text.rb +7 -8
  335. data/lib/wx/doc/gen/status_bar.rb +21 -11
  336. data/lib/wx/doc/gen/stc/event_list.rb +212 -208
  337. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +41 -15
  338. data/lib/wx/doc/gen/stc/styled_text_event.rb +5 -6
  339. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +0 -1
  340. data/lib/wx/doc/gen/svg_file_dc.rb +7 -8
  341. data/lib/wx/doc/gen/system_options.rb +6 -6
  342. data/lib/wx/doc/gen/system_settings.rb +2 -3
  343. data/lib/wx/doc/gen/task_bar_button.rb +312 -0
  344. data/lib/wx/doc/gen/task_bar_icon.rb +21 -8
  345. data/lib/wx/doc/gen/task_bar_icon_event.rb +4 -3
  346. data/lib/wx/doc/gen/text_attr.rb +20 -5
  347. data/lib/wx/doc/gen/text_ctrl.rb +92 -27
  348. data/lib/wx/doc/gen/text_entry.rb +31 -11
  349. data/lib/wx/doc/gen/text_entry_dialog.rb +2 -2
  350. data/lib/wx/doc/gen/text_validator.rb +43 -10
  351. data/lib/wx/doc/gen/time_picker_ctrl.rb +7 -8
  352. data/lib/wx/doc/gen/timer.rb +6 -2
  353. data/lib/wx/doc/gen/timer_event.rb +1 -2
  354. data/lib/wx/doc/gen/tip_provider.rb +1 -1
  355. data/lib/wx/doc/gen/toggle_button.rb +7 -8
  356. data/lib/wx/doc/gen/tool_bar.rb +99 -26
  357. data/lib/wx/doc/gen/tool_tip.rb +35 -5
  358. data/lib/wx/doc/gen/toolbook.rb +3 -4
  359. data/lib/wx/doc/gen/top_level_window.rb +71 -25
  360. data/lib/wx/doc/gen/tree_ctrl.rb +42 -18
  361. data/lib/wx/doc/gen/tree_event.rb +3 -4
  362. data/lib/wx/doc/gen/treebook.rb +7 -4
  363. data/lib/wx/doc/gen/ui_action_simulator.rb +6 -2
  364. data/lib/wx/doc/gen/utils.rb +39 -7
  365. data/lib/wx/doc/gen/v_list_box.rb +8 -4
  366. data/lib/wx/doc/gen/v_scrolled_window.rb +8 -6
  367. data/lib/wx/doc/gen/validator.rb +1 -1
  368. data/lib/wx/doc/gen/variant.rb +1 -0
  369. data/lib/wx/doc/gen/window.rb +200 -50
  370. data/lib/wx/doc/gen/window_dc.rb +0 -1
  371. data/lib/wx/doc/gen/window_disabler.rb +5 -2
  372. data/lib/wx/doc/gen/with_images.rb +6 -1
  373. data/lib/wx/doc/gen/wizard.rb +4 -4
  374. data/lib/wx/doc/gen/wizard_event.rb +3 -4
  375. data/lib/wx/doc/gen/wizard_page.rb +2 -2
  376. data/lib/wx/doc/gen/wizard_page_simple.rb +1 -1
  377. data/lib/wx/doc/gen/wrap_sizer.rb +0 -1
  378. data/lib/wx/doc/gen/xml_node.rb +19 -4
  379. data/lib/wx/doc/gen/xml_resource.rb +18 -5
  380. data/lib/wx/doc/graphics_context.rb +1 -0
  381. data/lib/wx/doc/grid/grid.rb +22 -1
  382. data/lib/wx/doc/help_controller.rb +11 -7
  383. data/lib/wx/doc/html/html_help_controller.rb +12 -4
  384. data/lib/wx/doc/list_ctrl.rb +33 -29
  385. data/lib/wx/doc/menu.rb +20 -0
  386. data/lib/wx/doc/notebook.rb +21 -0
  387. data/lib/wx/doc/pg/events.rb +13 -9
  388. data/lib/wx/doc/pg/pg_property.rb +18 -0
  389. data/lib/wx/doc/progress_dialog.rb +36 -32
  390. data/lib/wx/doc/prt/page_setup_dialog.rb +20 -12
  391. data/lib/wx/doc/prt/print_data.rb +13 -5
  392. data/lib/wx/doc/prt/print_dialog.rb +31 -23
  393. data/lib/wx/doc/prt/printer.rb +20 -12
  394. data/lib/wx/doc/radio_box.rb +19 -15
  395. data/lib/wx/doc/rbn/ribbon_bar.rb +13 -5
  396. data/lib/wx/doc/rbn/ribbon_button_bar.rb +13 -5
  397. data/lib/wx/doc/rbn/ribbon_gallery.rb +13 -5
  398. data/lib/wx/doc/rbn/ribbon_tool_bar.rb +13 -5
  399. data/lib/wx/doc/region_iterator.rb +32 -28
  400. data/lib/wx/doc/rtc/rich_text_composite_object.rb +24 -0
  401. data/lib/wx/doc/rtc/rich_text_ctrl.rb +24 -0
  402. data/lib/wx/doc/rtc/rich_text_paragraph.rb +24 -0
  403. data/lib/wx/doc/rtc/richtext_buffer.rb +27 -19
  404. data/lib/wx/doc/rtc/richtext_printing.rb +17 -9
  405. data/lib/wx/doc/rtc/richtext_style_sheet.rb +17 -9
  406. data/lib/wx/doc/sizer.rb +20 -0
  407. data/lib/wx/doc/stc/styled_text_ctrl.rb +24 -0
  408. data/lib/wx/doc/stream.rb +39 -35
  409. data/lib/wx/doc/system_settings.rb +30 -26
  410. data/lib/wx/doc/text_validator.rb +12 -8
  411. data/lib/wx/doc/textctrl.rb +16 -0
  412. data/lib/wx/doc/tree_ctrl.rb +95 -0
  413. data/lib/wx/doc/treebook.rb +9 -5
  414. data/lib/wx/doc/v_list_box.rb +9 -5
  415. data/lib/wx/doc/variant.rb +164 -160
  416. data/lib/wx/doc/window.rb +57 -42
  417. data/lib/wx/doc/window_disabler.rb +10 -6
  418. data/lib/wx/grid/grid.rb +27 -4
  419. data/lib/wx/keyword_defs.rb +43 -6
  420. data/lib/wx/pg/pg_property.rb +22 -0
  421. data/lib/wx/rtc/require.rb +3 -0
  422. data/lib/wx/rtc/rich_text_composite_object.rb +25 -0
  423. data/lib/wx/rtc/rich_text_ctrl.rb +25 -0
  424. data/lib/wx/rtc/rich_text_paragraph.rb +25 -0
  425. data/lib/wx/stc/require.rb +1 -0
  426. data/lib/wx/stc/styled_text_ctrl.rb +25 -0
  427. data/lib/wx/version.rb +1 -1
  428. data/lib/wxruby_aui.so +0 -0
  429. data/lib/wxruby_core.so +0 -0
  430. data/lib/wxruby_grid.so +0 -0
  431. data/lib/wxruby_html.so +0 -0
  432. data/lib/wxruby_pg.so +0 -0
  433. data/lib/wxruby_prt.so +0 -0
  434. data/lib/wxruby_rbn.so +0 -0
  435. data/lib/wxruby_rtc.so +0 -0
  436. data/lib/wxruby_stc.so +0 -0
  437. data/rakelib/lib/config/linux.rb +0 -3
  438. data/rakelib/lib/config/macosx.rb +1 -1
  439. data/rakelib/lib/config/mingw.rb +1 -1
  440. data/rakelib/lib/config/unixish.rb +1 -1
  441. data/rakelib/lib/config.rb +14 -4
  442. data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css +74 -2
  443. data/rakelib/yard/templates/default/fulldoc/html/full_list.erb +38 -0
  444. data/rakelib/yard/templates/default/fulldoc/html/setup.rb +39 -0
  445. data/rakelib/yard/templates/default/tags/html/wxrb_require.erb +10 -0
  446. data/rakelib/yard/templates/default/tags/setup.rb +16 -0
  447. data/rakelib/yard/yard-custom-templates.rb +3 -0
  448. data/samples/text/richtext.rb +0 -30
  449. data/samples/treectrl/treectrl.rb +1 -1
  450. data/tests/media/beep_lo.wav +0 -0
  451. data/tests/test_app_exit_exception.rb +36 -0
  452. data/tests/test_app_init_exception.rb +20 -0
  453. data/tests/test_book_controls.rb +29 -0
  454. data/tests/test_exceptions.rb +41 -0
  455. data/tests/test_list_ctrl.rb +1 -1
  456. data/tests/test_media_ctrl.rb +38 -0
  457. data/tests/test_menu.rb +69 -0
  458. data/tests/test_pg.rb +27 -0
  459. data/tests/test_richtext.rb +45 -0
  460. data/tests/test_sizer.rb +59 -0
  461. data/tests/test_std_controls.rb +78 -1
  462. data/tests/test_styled_text_ctrl.rb +46 -0
  463. data/tests/test_tree_ctrl.rb +138 -0
  464. data/tests/test_window.rb +12 -0
  465. data/tests/testapp_noframe.rb +1 -1
  466. metadata +38 -3
@@ -11,18 +11,16 @@ module Wx
11
11
  # If you need to ensure a continuous stream of idle events, you can either use {Wx::IdleEvent#request_more} method in your handler or call {wake_up_idle} periodically (for example from a timer event handler), but note that both of these approaches (and especially the first one) increase the system load and so should be avoided if possible.
12
12
  # By default, idle events are sent to all windows, including even the hidden ones because they may be shown if some condition is met from their {Wx::EVT_IDLE} (or related {Wx::EVT_UPDATE_UI}) handler. The children of hidden windows do not receive idle events however as they can't change their state in any way noticeable by the user. Finally, the global {Wx::App} object also receives these events, as usual, so it can be used for any global idle time processing.
13
13
  # If sending idle events to all windows is causing a significant overhead in your application, you can call {Wx::IdleEvent.set_mode} with the value {Wx::IdleMode::IDLE_PROCESS_SPECIFIED}, and set the {Wx::WS_EX_PROCESS_IDLE} extra window style for every window which should receive idle events, all the other ones will not receive them in this case.
14
- # === Events using this class
14
+ # ### Events using this class
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
19
  # - {Wx::EvtHandler#evt_idle}(meth = nil, &block): Process a {Wx::EVT_IDLE} event.
20
20
  #
21
- # ===
22
- #
23
21
  # Category: {Wx::Events}
24
22
  #
25
- # == Delayed Action Mechanism
23
+ # ## Delayed Action Mechanism
26
24
  #
27
25
  # {Wx::IdleEvent} can be used to perform some action "at slightly later time". This can be necessary in several circumstances when, for whatever reason, something can't be done in the current event handler. For example, if a mouse event handler is called with the mouse button pressed, the mouse can be currently captured and some operations with it notably capturing it again might be impossible or lead to undesirable results. If you still want to capture it, you can do it from {Wx::EVT_IDLE} handler when it is called the next time instead of doing it immediately.
28
26
  # This can be achieved in two different ways: when using static event tables, you will need a flag indicating to the (always connected) idle event handler whether the desired action should be performed. The originally called handler would then set it to indicate that it should indeed be done and the idle handler itself would reset it to prevent it from doing the same action again.
@@ -67,7 +65,6 @@ module Wx
67
65
 
68
66
  # This class is not used by the event handlers by itself, but is a base class for other event classes (such as {Wx::BookCtrlEvent}).
69
67
  # It (or an object of a derived class) is sent when the controls state is being changed and allows the program to {Wx::NotifyEvent#veto} this change if it wants to prevent it from happening.
70
- # ===
71
68
  #
72
69
  # Category: {Wx::Events}
73
70
  # @see Wx::BookCtrlEvent
@@ -76,7 +73,7 @@ module Wx
76
73
  class NotifyEvent < CommandEvent
77
74
 
78
75
  # Constructor (used internally by wxWidgets only).
79
- # @param eventType [Wx::CommandLinkButton::EventType]
76
+ # @param eventType [Wx::Slider::EventType]
80
77
  # @param id [Integer]
81
78
  # @return [Wx::NotifyEvent]
82
79
  def initialize(eventType=Wx::EVT_NULL, id=0) end
@@ -101,14 +98,19 @@ module Wx
101
98
  # A scroll event holds information about events sent from stand-alone scrollbars (see {Wx::ScrollBar}) and sliders (see {Wx::Slider}).
102
99
  # Note that scrolled windows send the {Wx::ScrollWinEvent} which does not derive from {Wx::CommandEvent}, but from {Wx::Event} directly - don't confuse these two kinds of events and use the event table macros mentioned below only for the scrollbar-like controls.
103
100
  #
104
- # == The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
101
+ # ## The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
105
102
  #
106
103
  # The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed by an EVT_SCROLL_CHANGED event).
107
104
  # The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE event does not happen).
108
105
  # In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving has finished independently of the way it had started. Please see the Widgets Sample ("Slider" page) to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
109
- # Note that unless specifying a scroll control identifier, you will need to test for scrollbar orientation with {Wx::ScrollEvent#get_orientation}, since horizontal and vertical scroll events are processed using the same event handler.
110
106
  #
111
- # === Events using this class
107
+ # <div class="wxrb-remark">
108
+ # <b>Remark:</b>
109
+ # <p>Note that unless specifying a scroll control identifier, you will need to test for scrollbar orientation with {Wx::ScrollEvent#get_orientation}, since horizontal and vertical scroll events are processed using the same event handler.
110
+ # </p>
111
+ # </div>>
112
+ #
113
+ # ### Events using this class
112
114
  #
113
115
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollEvent} events.
114
116
  # Event handler methods: except for this, the macros behave exactly the same.
@@ -153,8 +155,6 @@ module Wx
153
155
  #
154
156
  # - {Wx::EvtHandler#evt_command_scroll_changed}(meth = nil, &block): Process {Wx::EVT_SCROLL_CHANGED} end of scrolling events (MSW only).
155
157
  #
156
- # ===
157
- #
158
158
  # Category: {Wx::Events}
159
159
  # @see Wx::ScrollBar
160
160
  # @see Wx::Slider
@@ -166,7 +166,7 @@ module Wx
166
166
  class ScrollEvent < CommandEvent
167
167
 
168
168
  # Constructor.
169
- # @param commandType [Wx::CommandLinkButton::EventType]
169
+ # @param commandType [Wx::Slider::EventType]
170
170
  # @param id [Integer]
171
171
  # @param pos [Integer]
172
172
  # @param orientation [Integer]
@@ -197,7 +197,7 @@ module Wx
197
197
 
198
198
  # A scroll event holds information about events sent from scrolling windows.
199
199
  # Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events from the receiving window.
200
- # === Events using this class
200
+ # ### Events using this class
201
201
  #
202
202
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollWinEvent} events.
203
203
  # Event handler methods:
@@ -220,8 +220,6 @@ module Wx
220
220
  #
221
221
  # - {Wx::EvtHandler#evt_scrollwin_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBRELEASE} thumb release events.
222
222
  #
223
- # ===
224
- #
225
223
  # Category: {Wx::Events}
226
224
  # @see Wx::ScrollEvent
227
225
  # @see Events and Event Handling
@@ -230,7 +228,7 @@ module Wx
230
228
  class ScrollWinEvent < Event
231
229
 
232
230
  # Constructor.
233
- # @param commandType [Wx::CommandLinkButton::EventType]
231
+ # @param commandType [Wx::Slider::EventType]
234
232
  # @param pos [Integer]
235
233
  # @param orientation [Integer]
236
234
  # @return [Wx::ScrollWinEvent]
@@ -264,9 +262,14 @@ module Wx
264
262
  # All mouse events involving the buttons use {Wx::MouseButton::MOUSE_BTN_LEFT} for the left mouse button, {Wx::MouseButton::MOUSE_BTN_MIDDLE} for the middle one and {Wx::MouseButton::MOUSE_BTN_RIGHT} for the right one. And if the system supports more buttons, the {Wx::MouseButton::MOUSE_BTN_AUX1} and {Wx::MouseButton::MOUSE_BTN_AUX2} events can also be generated. Note that not all mice have even a middle button so a portable application should avoid relying on the events from it (but the right button click can be emulated using the left mouse button with the control key under Mac platforms with a single button mouse).
265
263
  # For the {Wx::EVT_ENTER_WINDOW} and {Wx::EVT_LEAVE_WINDOW} events purposes, the mouse is considered to be inside the window if it is in the window client area and not inside one of its children. In other words, the parent window receives {Wx::EVT_LEAVE_WINDOW} event not only when the mouse leaves the window entirely but also when it enters one of its children.
266
264
  # The position associated with a mouse event is expressed in the window coordinates of the window which generated the event, you can use {Wx::Window#client_to_screen} to convert it to screen coordinates and possibly call {Wx::Window#screen_to_client} next to convert it to window coordinates of another window.
267
- # Note the difference between methods like {Wx::MouseEvent#left_down} and the inherited {Wx::MouseState#left_is_down}: the former returns true when the event corresponds to the left mouse button click while the latter returns true if the left mouse button is currently being pressed. For example, when the user is dragging the mouse you can use {Wx::MouseEvent::LeftIsDown} to test whether the left mouse button is (still) depressed. Also, by convention, if {Wx::MouseEvent#left_down} returns true, {Wx::MouseEvent::LeftIsDown} will also return true in wxWidgets whatever the underlying GUI behaviour is (which is platform-dependent). The same applies, of course, to other mouse buttons as well.
268
265
  #
269
- # === Events using this class
266
+ # <div class="wxrb-note">
267
+ # <b>Note:</b>
268
+ # <p>Note the difference between methods like {Wx::MouseEvent#left_down} and the inherited {Wx::MouseState#left_is_down}: the former returns true when the event corresponds to the left mouse button click while the latter returns true if the left mouse button is currently being pressed. For example, when the user is dragging the mouse you can use {Wx::MouseEvent::LeftIsDown} to test whether the left mouse button is (still) depressed. Also, by convention, if {Wx::MouseEvent#left_down} returns true, {Wx::MouseEvent::LeftIsDown} will also return true in wxWidgets whatever the underlying GUI behaviour is (which is platform-dependent). The same applies, of course, to other mouse buttons as well.
269
+ # </p>
270
+ # </div>
271
+ #
272
+ # ### Events using this class
270
273
  #
271
274
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MouseEvent} events.
272
275
  # Event handler methods:
@@ -313,8 +316,6 @@ module Wx
313
316
  #
314
317
  # - {Wx::EvtHandler#evt_magnify}(meth = nil, &block): Process a {Wx::EVT_MAGNIFY} event (new since wxWidgets 3.1.0).
315
318
  #
316
- # ===
317
- #
318
319
  # Category: {Wx::Events}
319
320
  # @see Wx::KeyEvent
320
321
  #
@@ -363,7 +364,7 @@ module Wx
363
364
  # - {Wx::EVT_MOUSEWHEEL}
364
365
  #
365
366
  # - {Wx::EVT_MAGNIFY}
366
- # @param mouseEventType [Wx::CommandLinkButton::EventType]
367
+ # @param mouseEventType [Wx::Slider::EventType]
367
368
  # @return [Wx::MouseEvent]
368
369
  def initialize(mouseEventType=Wx::EVT_NULL) end
369
370
 
@@ -434,7 +435,7 @@ module Wx
434
435
  def get_button; end
435
436
 
436
437
  # Returns the number of mouse clicks for this event: 1 for a simple click, 2 for a double-click, 3 for a triple-click and so on.
437
- # Currently this function is implemented only in {Wx::Mac} and returns -1 for the other platforms (you can still distinguish simple clicks from double-clicks as they generate different kinds of events however).
438
+ # Currently this function is implemented only in WXOSX and returns -1 for the other platforms (you can still distinguish simple clicks from double-clicks as they generate different kinds of events however).
438
439
  # @return [Integer]
439
440
  def get_click_count; end
440
441
  alias_method :click_count, :get_click_count
@@ -733,15 +734,13 @@ module Wx
733
734
 
734
735
  # A {Wx::SetCursorEvent} is generated from {Wx::Window} when the mouse cursor is about to be set as a result of mouse motion.
735
736
  # This event gives the application the chance to perform specific mouse cursor processing based on the current position of the mouse within the window. Use {Wx::SetCursorEvent#set_cursor} to specify the cursor you want to be displayed.
736
- # === Events using this class
737
+ # ### Events using this class
737
738
  #
738
739
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SetCursorEvent} events.
739
740
  # Event handler methods:
740
741
  #
741
742
  # - {Wx::EvtHandler#evt_set_cursor}(meth = nil, &block): Process a {Wx::EVT_SET_CURSOR} event.
742
743
  #
743
- # ===
744
- #
745
744
  # Category: {Wx::Events}
746
745
  # @see Wx::SetCursor
747
746
  # @see Wx::Window#set_cursor
@@ -771,7 +770,11 @@ module Wx
771
770
  alias_method :y, :get_y
772
771
 
773
772
  # Returns true if the cursor specified by this event is a valid cursor.
774
- # You cannot specify {Wx::NULL_CURSOR} with this event, as it is not considered a valid cursor.
773
+ # <div class="wxrb-remark">
774
+ # <b>Remark:</b>
775
+ # <p>You cannot specify {Wx::NULL_CURSOR} with this event, as it is not considered a valid cursor.
776
+ # </p>
777
+ # </div>>
775
778
  # @return [Boolean]
776
779
  def has_cursor; end
777
780
  alias_method :has_cursor?, :has_cursor
@@ -785,9 +788,11 @@ module Wx
785
788
  end # SetCursorEvent
786
789
 
787
790
  # This is the base class for all supported gesture events.
788
- # Gesture events are not generated by default, you must call {Wx::Window#enable_touch_events} with the appropriate parameter to request their generation.
789
- #
790
- # ===
791
+ # <div class="wxrb-note">
792
+ # <b>Note:</b>
793
+ # <p>Gesture events are not generated by default, you must call {Wx::Window#enable_touch_events} with the appropriate parameter to request their generation.
794
+ # </p>
795
+ # </div>
791
796
  #
792
797
  # Category: {Wx::Events}
793
798
  # @see Wx::PanGestureEvent
@@ -799,7 +804,7 @@ module Wx
799
804
 
800
805
  # Constructor.
801
806
  # @param winid [Integer]
802
- # @param type [Wx::CommandLinkButton::EventType]
807
+ # @param type [Wx::Slider::EventType]
803
808
  # @return [Wx::GestureEvent]
804
809
  def initialize(winid=0, type=Wx::EVT_NULL) end
805
810
 
@@ -839,17 +844,15 @@ module Wx
839
844
  end # GestureEvent
840
845
 
841
846
  # This event is generated when the user moves a finger on the surface.
842
- # wxGTK also generates this event during mouse dragging (mouse motion while a left mouse button is depressed).
847
+ # WXGTK also generates this event during mouse dragging (mouse motion while a left mouse button is depressed).
843
848
  # Note that OSX requires the primary mouse button to be pressed while performing the finger movement.
844
- # === Events using this class
849
+ # ### Events using this class
845
850
  #
846
851
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::PanGestureEvent} events.
847
852
  # Event handler methods:
848
853
  #
849
854
  # - {Wx::EvtHandler#evt_gesture_pan}(id, meth = nil, &block): Process a {Wx::EVT_GESTURE_PAN}.
850
855
  #
851
- # ===
852
- #
853
856
  # Category: {Wx::Events}
854
857
  #
855
858
  class PanGestureEvent < GestureEvent
@@ -873,15 +876,13 @@ module Wx
873
876
  end # PanGestureEvent
874
877
 
875
878
  # This event is generated when two fingers pinch the surface to zoom in or out.
876
- # === Events using this class
879
+ # ### Events using this class
877
880
  #
878
881
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ZoomGestureEvent} events.
879
882
  # Event handler methods:
880
883
  #
881
884
  # - {Wx::EvtHandler#evt_gesture_zoom}(id, meth = nil, &block): Process a {Wx::EVT_GESTURE_ZOOM}.
882
885
  #
883
- # ===
884
- #
885
886
  # Category: {Wx::Events}
886
887
  #
887
888
  class ZoomGestureEvent < GestureEvent
@@ -906,15 +907,13 @@ module Wx
906
907
  end # ZoomGestureEvent
907
908
 
908
909
  # This event is generated when two fingers move in opposite directions on the surface.
909
- # === Events using this class
910
+ # ### Events using this class
910
911
  #
911
912
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::RotateGestureEvent} events.
912
913
  # Event handler methods:
913
914
  #
914
915
  # - {Wx::EvtHandler#evt_gesture_rotate}(id, meth = nil, &block): Process a {Wx::EVT_GESTURE_ROTATE}.
915
916
  #
916
- # ===
917
- #
918
917
  # Category: {Wx::Events}
919
918
  #
920
919
  class RotateGestureEvent < GestureEvent
@@ -940,15 +939,13 @@ module Wx
940
939
  end # RotateGestureEvent
941
940
 
942
941
  # This event is generated when two fingers touch the surface at the same time.
943
- # === Events using this class
942
+ # ### Events using this class
944
943
  #
945
944
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::TwoFingerTapEvent} events.
946
945
  # Event handler methods:
947
946
  #
948
947
  # - {Wx::EvtHandler#evt_two_finger_tap}(id, meth = nil, &block): Process a {Wx::EVT_TWO_FINGER_TAP}.
949
948
  #
950
- # ===
951
- #
952
949
  # Category: {Wx::Events}
953
950
  #
954
951
  class TwoFingerTapEvent < GestureEvent
@@ -961,17 +958,15 @@ module Wx
961
958
  end # TwoFingerTapEvent
962
959
 
963
960
  # This event is generated when one finger touches the surface and remains stationary.
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.
966
- # === Events using this class
961
+ # Note that currently it is only generated under WXGTK and WXOSX.
962
+ # WXGTK also generates this event when left mouse button is being pressed for some minimum duration of time.
963
+ # ### Events using this class
967
964
  #
968
965
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::LongPressEvent} events.
969
966
  # Event handler methods:
970
967
  #
971
968
  # - {Wx::EvtHandler#evt_long_press}(id, meth = nil, &block): Process a {Wx::EVT_LONG_PRESS}.
972
969
  #
973
- # ===
974
- #
975
970
  # Category: {Wx::Events}
976
971
  #
977
972
  class LongPressEvent < GestureEvent
@@ -985,15 +980,13 @@ module Wx
985
980
 
986
981
  # This event is generated when the user press the surface with one finger and taps with another.
987
982
  # Note that once started the event will also be generated when the finger that was pressed moves on surface.
988
- # === Events using this class
983
+ # ### Events using this class
989
984
  #
990
985
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::PressAndTapEvent} events.
991
986
  # Event handler methods:
992
987
  #
993
988
  # - {Wx::EvtHandler#evt_press_and_tap}(id, meth = nil, &block): Process a {Wx::EVT_PRESS_AND_TAP}.
994
989
  #
995
- # ===
996
- #
997
990
  # Category: {Wx::Events}
998
991
  #
999
992
  class PressAndTapEvent < GestureEvent
@@ -1006,7 +999,7 @@ module Wx
1006
999
  end # PressAndTapEvent
1007
1000
 
1008
1001
  # This event class contains information about key press and release events.
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.
1002
+ # 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::KeyCode::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::KeyCode::K_NONE} for any non-Latin-1 ones. If both {Wx::KeyEvent#get_unicode_key} and {Wx::KeyEvent#get_key_code} return {Wx::KeyCode::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::KeyCode::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::KeyCode::K_NONE} or simply ignore that key.
1010
1003
  # 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.
1011
1004
  # 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:
1012
1005
  #
@@ -1014,22 +1007,40 @@ module Wx
1014
1007
  # - 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
1008
  # - 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.
1016
1009
  #
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.
1010
+ # 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::KeyCode::K_NONE} in this case.
1018
1011
  # 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.
1019
1012
  # To summarize: you should handle {Wx::EVT_CHAR} if you need the translated key and {Wx::EVT_KEY_DOWN} if you only need the value of the key itself, independent of the current keyboard state.
1020
- # Not all key down events may be generated by the user. As an example, {Wx::EVT_KEY_DOWN} with <code>=</code> key code can be generated using the standard US keyboard layout but not using the German one because the <code>=</code> key corresponds to Shift-0 key combination in this layout and the key code for it is 0, not <code>=</code>. Because of this you should avoid requiring your users to type key events that might be impossible to enter on their keyboard.
1021
1013
  #
1022
- # Another difference between key and char events is that another kind of translation is done for the latter ones when the Control key is pressed: char events for ASCII letters in this case carry codes corresponding to the ASCII value of Ctrl-Latter, i.e. 1 for Ctrl-A, 2 for Ctrl-B and so on until 26 for Ctrl-Z. This is convenient for terminal-like applications and can be completely ignored by all the other ones (if you need to handle Ctrl-A it is probably a better idea to use the key event rather than the char one). Notice that currently no translation is done for the presses of <code></code>[, <code>\</code>, <code></code>], <code>^</code> and _ keys which might be mapped to ASCII values from 27 to 31. Since version 2.9.2, the enum values {Wx::K_CONTROL}_A - {Wx::K_CONTROL}_Z can be used instead of the non-descriptive constant values 1-26.
1023
- # Finally, modifier keys only generate key events but no char events at all. The modifiers keys are {Wx::K_SHIFT}, {Wx::K_CONTROL}, {Wx::K_ALT} and various {Wx::K_WINDOWS}_XXX from {Wx::KeyCode} enum.
1014
+ # <div class="wxrb-note">
1015
+ # <b>Note:</b>
1016
+ # <p>Not all key down events may be generated by the user. As an example, {Wx::EVT_KEY_DOWN} with <code>=</code> key code can be generated using the standard US keyboard layout but not using the German one because the <code>=</code> key corresponds to Shift-0 key combination in this layout and the key code for it is 0, not <code>=</code>. Because of this you should avoid requiring your users to type key events that might be impossible to enter on their keyboard.
1017
+ # </p>
1018
+ # </div>
1019
+ #
1020
+ # Another difference between key and char events is that another kind of translation is done for the latter ones when the Control key is pressed: char events for ASCII letters in this case carry codes corresponding to the ASCII value of Ctrl-Latter, i.e. 1 for Ctrl-A, 2 for Ctrl-B and so on until 26 for Ctrl-Z. This is convenient for terminal-like applications and can be completely ignored by all the other ones (if you need to handle Ctrl-A it is probably a better idea to use the key event rather than the char one). Notice that currently no translation is done for the presses of <code></code>[, <code>\</code>, <code></code>], <code>^</code> and _ keys which might be mapped to ASCII values from 27 to 31. Since version 2.9.2, the enum values {Wx::KeyCode::K_CONTROL}_A - {Wx::KeyCode::K_CONTROL}_Z can be used instead of the non-descriptive constant values 1-26.
1021
+ # Finally, modifier keys only generate key events but no char events at all. The modifiers keys are {Wx::KeyCode::K_SHIFT}, {Wx::KeyCode::K_CONTROL}, {Wx::KeyCode::K_ALT} and various {Wx::KeyCode::K_WINDOWS}_XXX from {Wx::KeyCode} enum.
1024
1022
  # Modifier keys events are special in one additional aspect: usually the keyboard state associated with a key press is well defined, e.g. {Wx::KeyboardState#shift_down} returns true only if the Shift key was held pressed when the key that generated this event itself was pressed. There is an ambiguity for the key press events for Shift key itself however. By convention, it is considered to be already pressed when it is pressed and already released when it is released. In other words, {Wx::EVT_KEY_DOWN} event for the Shift key itself will have {Wx::KeyModifier::MOD_SHIFT} in {Wx::KeyEvent#get_modifiers} and {Wx::KeyEvent#shift_down} will return true while the {Wx::EVT_KEY_UP} event for Shift itself will not have {Wx::KeyModifier::MOD_SHIFT} in its modifiers and {Wx::KeyEvent#shift_down} will return false.
1025
1023
  # <b>Tip:</b> You may discover the key codes and modifiers generated by all the keys on your system interactively by running the Key Event Sample wxWidgets sample and pressing some keys in it.
1026
- # If a key down (EVT_KEY_DOWN) event is caught and the event handler does not call <code>event.Skip()</code> then the corresponding char event (EVT_CHAR) will not happen. This is by design and enables the programs that handle both types of events to avoid processing the same key twice. As a consequence, if you do not want to suppress the {Wx::EVT_CHAR} events for the keys you handle, always call <code>event.Skip()</code> in your {Wx::EVT_KEY_DOWN} handler. Not doing may also prevent accelerators defined using this key from working.
1027
1024
  #
1028
- # If a key is maintained in a pressed state, you will typically get a lot of (automatically generated) key down events but only one key up one at the end when the key is released so it is wrong to assume that there is one up event corresponding to each down one.
1025
+ # <div class="wxrb-note">
1026
+ # <b>Note:</b>
1027
+ # <p>If a key down (EVT_KEY_DOWN) event is caught and the event handler does not call <code>event.Skip()</code> then the corresponding char event (EVT_CHAR) will not happen. This is by design and enables the programs that handle both types of events to avoid processing the same key twice. As a consequence, if you do not want to suppress the {Wx::EVT_CHAR} events for the keys you handle, always call <code>event.Skip()</code> in your {Wx::EVT_KEY_DOWN} handler. Not doing may also prevent accelerators defined using this key from working.
1028
+ # </p>
1029
+ # </div>
1030
+ #
1031
+ # <div class="wxrb-note">
1032
+ # <b>Note:</b>
1033
+ # <p>If a key is maintained in a pressed state, you will typically get a lot of (automatically generated) key down events but only one key up one at the end when the key is released so it is wrong to assume that there is one up event corresponding to each down one.
1034
+ # </p>
1035
+ # </div>
1029
1036
  #
1030
- # For Windows programmers: The key and char events in wxWidgets are similar to but slightly different from Windows WM_KEYDOWN and WM_CHAR events. In particular, Alt-x combination will generate a char event in wxWidgets (unless it is used as an accelerator) and almost all keys, including ones without ASCII equivalents, generate char events too.
1037
+ # <div class="wxrb-note">
1038
+ # <b>Note:</b>
1039
+ # <p>For Windows programmers: The key and char events in wxWidgets are similar to but slightly different from Windows WM_KEYDOWN and WM_CHAR events. In particular, Alt-x combination will generate a char event in wxWidgets (unless it is used as an accelerator) and almost all keys, including ones without ASCII equivalents, generate char events too.
1040
+ # </p>
1041
+ # </div>
1031
1042
  #
1032
- # === Events using this class
1043
+ # ### Events using this class
1033
1044
  #
1034
1045
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::KeyEvent} events.
1035
1046
  # Event handler methods:
@@ -1042,8 +1053,6 @@ module Wx
1042
1053
  #
1043
1054
  # - {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.
1044
1055
  #
1045
- # ===
1046
- #
1047
1056
  # Category: {Wx::Events}
1048
1057
  # @see Wx::KeyboardState
1049
1058
  #
@@ -1059,14 +1068,14 @@ module Wx
1059
1068
 
1060
1069
  # Constructor.
1061
1070
  # Currently, the only valid event types are {Wx::EVT_CHAR} and {Wx::EVT_CHAR_HOOK}.
1062
- # @param keyEventType [Wx::CommandLinkButton::EventType]
1071
+ # @param keyEventType [Wx::Slider::EventType]
1063
1072
  # @return [Wx::KeyEvent]
1064
1073
  def initialize(keyEventType=Wx::EVT_NULL) end
1065
1074
 
1066
1075
  # Returns the key code of the key that generated this event.
1067
- # ASCII symbols return normal ASCII values, while events from special keys such as "left cursor arrow" ({Wx::K_LEFT}) return values outside of the ASCII range. See {Wx::KeyCode} for a full list of the virtual key codes.
1068
- # Note that this method returns a meaningful value only for special non-alphanumeric keys or if the user entered a Latin-1 character (this includes ASCII and the accented letters found in Western European languages but not letters of other alphabets such as e.g. Cyrillic). Otherwise it simply method returns {Wx::K_NONE} and {Wx::KeyEvent#get_unicode_key} should be used to obtain the corresponding Unicode character.
1069
- # Using {Wx::KeyEvent#get_unicode_key} is in general the right thing to do if you are interested in the characters typed by the user, {Wx::KeyEvent#get_key_code} should be only used for special keys (for which {Wx::KeyEvent#get_unicode_key} returns nil). To handle both kinds of keys you might write:
1076
+ # ASCII symbols return normal ASCII values, while events from special keys such as "left cursor arrow" ({Wx::KeyCode::K_LEFT}) return values outside of the ASCII range. See {Wx::KeyCode} for a full list of the virtual key codes.
1077
+ # Note that this method returns a meaningful value only for special non-alphanumeric keys or if the user entered a Latin-1 character (this includes ASCII and the accented letters found in Western European languages but not letters of other alphabets such as e.g. Cyrillic). Otherwise it simply method returns {Wx::KeyCode::K_NONE} and {Wx::KeyEvent#get_unicode_key} should be used to obtain the corresponding Unicode character.
1078
+ # Using {Wx::KeyEvent#get_unicode_key} is in general the right thing to do if you are interested in the characters typed by the user, {Wx::KeyEvent#get_key_code} should be only used for special keys (for which {Wx::KeyEvent#get_unicode_key} returns {Wx::KeyCode::K_NONE}). To handle both kinds of keys you might write:
1070
1079
  # ```ruby
1071
1080
  # def on_char(event)
1072
1081
  # uc = event.get_unicode_key
@@ -1112,7 +1121,12 @@ module Wx
1112
1121
  # Under MSW, the raw key code is the value of wParam parameter of the corresponding message.
1113
1122
  # Under GTK, the raw key code is the keyval field of the corresponding GDK event.
1114
1123
  # Under macOS, the raw key code is the keyCode field of the corresponding NSEvent.
1115
- # Currently the raw key codes are not supported by all ports, use #ifdef {Wx::HAS_RAW_KEY_CODES} to determine if this feature is available.
1124
+ #
1125
+ # <div class="wxrb-note">
1126
+ # <b>Note:</b>
1127
+ # <p>Currently the raw key codes are not supported by all ports, use \#ifdef {Wx::HAS_RAW_KEY_CODES} to determine if this feature is available.
1128
+ # </p>
1129
+ # </div>
1116
1130
  # @return [Integer]
1117
1131
  def get_raw_key_code; end
1118
1132
  alias_method :raw_key_code, :get_raw_key_code
@@ -1122,13 +1136,18 @@ module Wx
1122
1136
  # Under MSW, the raw flags are just the value of lParam parameter of the corresponding message.
1123
1137
  # Under GTK, the raw flags contain the hardware_keycode field of the corresponding GDK event.
1124
1138
  # Under macOS, the raw flags contain the modifiers state.
1125
- # Currently the raw key flags are not supported by all ports, use #ifdef {Wx::HAS_RAW_KEY_CODES} to determine if this feature is available.
1139
+ #
1140
+ # <div class="wxrb-note">
1141
+ # <b>Note:</b>
1142
+ # <p>Currently the raw key flags are not supported by all ports, use \#ifdef {Wx::HAS_RAW_KEY_CODES} to determine if this feature is available.
1143
+ # </p>
1144
+ # </div>
1126
1145
  # @return [Integer]
1127
1146
  def get_raw_key_flags; end
1128
1147
  alias_method :raw_key_flags, :get_raw_key_flags
1129
1148
 
1130
1149
  # Returns the Unicode character corresponding to this key event.
1131
- # If the key pressed doesn't have any character value (e.g. a cursor key) this method will return nil. In this case you should use {Wx::KeyEvent#get_key_code} to retrieve the value of the key.
1150
+ # If the key pressed doesn't have any character value (e.g. a cursor key) this method will return {Wx::KeyCode::K_NONE}. In this case you should use {Wx::KeyEvent#get_key_code} to retrieve the value of the key.
1132
1151
  # This function is only available in Unicode build, i.e. when {Wx::Setup::USE_UNICODE} is 1.
1133
1152
  # @return [String]
1134
1153
  def get_unicode_key; end
@@ -1263,15 +1282,13 @@ module Wx
1263
1282
  # Note that the size passed is of the whole window: call {Wx::Window#get_client_size} for the area which may be used by the application.
1264
1283
  # When a window is resized, usually only a small part of the window is damaged and you may only need to repaint that area. However, if your drawing depends on the size of the window, you may need to clear the DC explicitly and repaint the whole window. In which case, you may need to call {Wx::Window#refresh} to invalidate the entire window.
1265
1284
  # <b>Important</b> : Sizers ( see Sizers Overview ) rely on size events to function correctly. Therefore, in a sizer-based layout, do not forget to call Skip on all size events you catch (and don't catch size events at all when you don't need to).
1266
- # === Events using this class
1285
+ # ### Events using this class
1267
1286
  #
1268
1287
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SizeEvent} events.
1269
1288
  # Event handler methods:
1270
1289
  #
1271
1290
  # - {Wx::EvtHandler#evt_size}(meth = nil, &block): Process a {Wx::EVT_SIZE} event.
1272
1291
  #
1273
- # ===
1274
- #
1275
1292
  # Category: {Wx::Events}
1276
1293
  # @see Wx::Size
1277
1294
  # @see Events and Event Handling
@@ -1308,21 +1325,19 @@ module Wx
1308
1325
  end # SizeEvent
1309
1326
 
1310
1327
  # A move event holds information about window position change.
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.
1312
- # === Events using this class
1328
+ # 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.
1329
+ # ### Events using this class
1313
1330
  #
1314
1331
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MoveEvent} events.
1315
1332
  # Event handler methods:
1316
1333
  #
1317
1334
  # - {Wx::EvtHandler#evt_move}(meth = nil, &block): Process a {Wx::EVT_MOVE} event, which is generated when a window is moved.
1318
1335
  #
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.
1336
+ # - {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.
1322
1337
  #
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.
1338
+ # - {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.
1324
1339
  #
1325
- # ===
1340
+ # - {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.
1326
1341
  #
1327
1342
  # Category: {Wx::Events}
1328
1343
  # @see Wx::Point
@@ -1378,10 +1393,6 @@ module Wx
1378
1393
  # vb_pt = get_view_start # Top left corner of client
1379
1394
  #
1380
1395
  # Wx::RegionIterator.for_region(get_update_region) do |region_it|
1381
- #
1382
- # int vX,vY,vW,vH
1383
- # wxRegionIterator upd(GetUpdateRegion()) # get the update rect list
1384
- #
1385
1396
  # region_it.each do |rct|
1386
1397
  # # rct == Dimensions of client area to repaint in pixels
1387
1398
  #
@@ -1393,17 +1404,19 @@ module Wx
1393
1404
  # end
1394
1405
  # ```
1395
1406
  #
1396
- # Please notice that in general it is impossible to change the drawing of a standard control (such as {Wx::Button}) and so you shouldn't attempt to handle paint events for them as even if it might work on some platforms, this is inherently not portable and won't work everywhere.
1407
+ # <div class="wxrb-remark">
1408
+ # <b>Remark:</b>
1409
+ # <p>Please notice that in general it is impossible to change the drawing of a standard control (such as {Wx::Button}) and so you shouldn't attempt to handle paint events for them as even if it might work on some platforms, this is inherently not portable and won't work everywhere.
1410
+ # </p>
1411
+ # </div>>
1397
1412
  #
1398
- # === Events using this class
1413
+ # ### Events using this class
1399
1414
  #
1400
1415
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::PaintEvent} events.
1401
1416
  # Event handler methods:
1402
1417
  #
1403
1418
  # - {Wx::EvtHandler#evt_paint}(meth = nil, &block): Process a {Wx::EVT_PAINT} event.
1404
1419
  #
1405
- # ===
1406
- #
1407
1420
  # Category: {Wx::Events}
1408
1421
  # @see Events and Event Handling
1409
1422
  #
@@ -1422,15 +1435,13 @@ module Wx
1422
1435
  # On some platforms, such as GTK+, this event is simulated (simply generated just before the paint event) and may cause flicker. It is therefore recommended that you set the text background colour explicitly in order to prevent flicker. The default background colour under GTK+ is grey.
1423
1436
  # To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table definition.
1424
1437
  # You must use the device context returned by {Wx::EraseEvent#get_dc} to draw on, don't create a {Wx::PaintDC} in the event handler.
1425
- # === Events using this class
1438
+ # ### Events using this class
1426
1439
  #
1427
1440
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::EraseEvent} events.
1428
1441
  # Event handler methods:
1429
1442
  #
1430
1443
  # - {Wx::EvtHandler#evt_erase_background}(meth = nil, &block): Process a {Wx::EVT_ERASE_BACKGROUND} event.
1431
1444
  #
1432
- # ===
1433
- #
1434
1445
  # Category: {Wx::Events}
1435
1446
  # @see Events and Event Handling
1436
1447
  #
@@ -1455,7 +1466,7 @@ module Wx
1455
1466
  # The window losing focus receives a "kill focus" event while the window gaining it gets a "set focus" one.
1456
1467
  # Notice that the set focus event happens both when the user gives focus to the window (whether using the mouse or keyboard) and when it is done from the program itself using {Wx::Window#set_focus}.
1457
1468
  # The focus event handlers should almost invariably call {Wx::Event#skip} on their event argument to allow the default handling to take place. Failure to do this may result in incorrect behaviour of the native controls. Also note that {Wx::EVT_KILL_FOCUS} handler must not call {Wx::Window#set_focus} as this, again, is not supported by all native controls. If you need to do this, consider using the Delayed Action Mechanism described in {Wx::IdleEvent} documentation.
1458
- # === Events using this class
1469
+ # ### Events using this class
1459
1470
  #
1460
1471
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FocusEvent} events.
1461
1472
  # Event handler methods:
@@ -1464,8 +1475,6 @@ module Wx
1464
1475
  #
1465
1476
  # - {Wx::EvtHandler#evt_kill_focus}(meth = nil, &block): Process a {Wx::EVT_KILL_FOCUS} event.
1466
1477
  #
1467
- # ===
1468
- #
1469
1478
  # Category: {Wx::Events}
1470
1479
  # @see Events and Event Handling
1471
1480
  #
@@ -1473,7 +1482,7 @@ module Wx
1473
1482
  class FocusEvent < Event
1474
1483
 
1475
1484
  # Constructor.
1476
- # @param eventType [Wx::CommandLinkButton::EventType]
1485
+ # @param eventType [Wx::Slider::EventType]
1477
1486
  # @param id [Integer]
1478
1487
  # @return [Wx::FocusEvent]
1479
1488
  def initialize(eventType=Wx::EVT_NULL, id=0) end
@@ -1492,7 +1501,7 @@ module Wx
1492
1501
  end # FocusEvent
1493
1502
 
1494
1503
  # An activate event is sent when a window or application is being activated or deactivated.
1495
- # === Events using this class
1504
+ # ### Events using this class
1496
1505
  #
1497
1506
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ActivateEvent} events.
1498
1507
  # Event handler methods:
@@ -1503,9 +1512,11 @@ module Wx
1503
1512
  #
1504
1513
  # - {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.
1505
1514
  #
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.
1507
- #
1508
- # ===
1515
+ # <div class="wxrb-note">
1516
+ # <b>Note:</b>
1517
+ # <p>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.
1518
+ # </p>
1519
+ # </div>
1509
1520
  #
1510
1521
  # Category: {Wx::Events}
1511
1522
  # @see Events and Event Handling
@@ -1531,7 +1542,7 @@ module Wx
1531
1542
  end # Reason
1532
1543
 
1533
1544
  # Constructor.
1534
- # @param eventType [Wx::CommandLinkButton::EventType]
1545
+ # @param eventType [Wx::Slider::EventType]
1535
1546
  # @param active [Boolean]
1536
1547
  # @param id [Integer]
1537
1548
  # @param activationReason [Wx::wxActivateEvent::Reason]
@@ -1544,7 +1555,7 @@ module Wx
1544
1555
  alias_method :active, :get_active
1545
1556
 
1546
1557
  # Allows checking if the window was activated by clicking it with the mouse or in some other way.
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).
1558
+ # 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).
1548
1559
  # Under all the other platforms, Reason_Unknown is always returned.
1549
1560
  # @return [Wx::wxActivateEvent::Reason]
1550
1561
  def get_activation_reason; end
@@ -1555,15 +1566,13 @@ module Wx
1555
1566
  # A {Wx::InitDialogEvent} is sent as a dialog or panel is being initialised.
1556
1567
  # Handlers for this event can transfer data to the window.
1557
1568
  # The default handler calls {Wx::Window#transfer_data_to_window}.
1558
- # === Events using this class
1569
+ # ### Events using this class
1559
1570
  #
1560
1571
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::InitDialogEvent} events.
1561
1572
  # Event handler methods:
1562
1573
  #
1563
1574
  # - {Wx::EvtHandler#evt_init_dialog}(meth = nil, &block): Process a {Wx::EVT_INIT_DIALOG} event.
1564
1575
  #
1565
- # ===
1566
- #
1567
1576
  # Category: {Wx::Events}
1568
1577
  # @see Events and Event Handling
1569
1578
  #
@@ -1588,7 +1597,7 @@ module Wx
1588
1597
  #
1589
1598
  # 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.
1590
1599
  # 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}.
1591
- # === Events using this class
1600
+ # ### Events using this class
1592
1601
  #
1593
1602
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MenuEvent} events.
1594
1603
  # Event handler methods:
@@ -1601,8 +1610,6 @@ module Wx
1601
1610
  #
1602
1611
  # - {Wx::EvtHandler#evt_menu_highlight_all}(meth = nil, &block): A menu item has been highlighted, i.e. the currently selected menu item has changed.
1603
1612
  #
1604
- # ===
1605
- #
1606
1613
  # Category: {Wx::Events}
1607
1614
  # @see Wx::CommandEvent
1608
1615
  # @see Events and Event Handling
@@ -1611,15 +1618,20 @@ module Wx
1611
1618
  class MenuEvent < Event
1612
1619
 
1613
1620
  # Constructor.
1614
- # @param type [Wx::CommandLinkButton::EventType]
1621
+ # @param type [Wx::Slider::EventType]
1615
1622
  # @param id [Integer]
1616
1623
  # @param menu [Wx::Menu]
1617
1624
  # @return [Wx::MenuEvent]
1618
1625
  def initialize(type=Wx::EVT_NULL, id=0, menu=nil) end
1619
1626
 
1620
1627
  # Returns the menu which is being opened or closed, or the menu containing the highlighted item.
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.
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.
1628
+ # 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.
1629
+ #
1630
+ # <div class="wxrb-remark">
1631
+ # <b>Remark:</b>
1632
+ # <p>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.
1633
+ # </p>
1634
+ # </div>>
1623
1635
  # @return [Wx::Menu]
1624
1636
  def get_menu; end
1625
1637
  alias_method :menu, :get_menu
@@ -1663,7 +1675,7 @@ module Wx
1663
1675
  #
1664
1676
  # See also <code>samples/dialogs</code> for a full example of interrupting closing an application when there are e.g. unsaved files.
1665
1677
  # The EVT_END_SESSION event is slightly different as it is sent by the system when the user session is ending (e.g. because of log out or shutdown) and so all windows are being forcefully closed. At least under MSW, after the handler for this event is executed the program is simply killed by the system. Because of this, the default handler for this event provided by wxWidgets calls all the usual cleanup code (including {Wx::App#on_exit}) so that it could still be executed and exit()s the process itself, without waiting for being killed. If this behaviour is for some reason undesirable, make sure that you define a handler for this event in your {Wx::App}-derived class and do not call <code>event.Skip()</code> in it (but be aware that the system will still kill your application).
1666
- # === Events using this class
1678
+ # ### Events using this class
1667
1679
  #
1668
1680
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CloseEvent} events.
1669
1681
  # Event handler methods:
@@ -1674,8 +1686,6 @@ module Wx
1674
1686
  #
1675
1687
  # - {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.
1676
1688
  #
1677
- # ===
1678
- #
1679
1689
  # Category: {Wx::Events}
1680
1690
  # @see Wx::Window#close
1681
1691
  # @see Window Deletion
@@ -1684,7 +1694,7 @@ module Wx
1684
1694
  class CloseEvent < Event
1685
1695
 
1686
1696
  # Constructor.
1687
- # @param commandEventType [Wx::CommandLinkButton::EventType]
1697
+ # @param commandEventType [Wx::Slider::EventType]
1688
1698
  # @param id [Integer]
1689
1699
  # @return [Wx::CloseEvent]
1690
1700
  def initialize(commandEventType=Wx::EVT_NULL, id=0) end
@@ -1726,16 +1736,14 @@ module Wx
1726
1736
  end # CloseEvent
1727
1737
 
1728
1738
  # An event being sent when the window is shown or hidden.
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.
1730
- # === Events using this class
1739
+ # 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.
1740
+ # ### Events using this class
1731
1741
  #
1732
1742
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ShowEvent} events.
1733
1743
  # Event handler methods:
1734
1744
  #
1735
1745
  # - {Wx::EvtHandler#evt_show}(meth = nil, &block): Process a {Wx::EVT_SHOW} event.
1736
1746
  #
1737
- # ===
1738
- #
1739
1747
  # Category: {Wx::Events}
1740
1748
  # @see Events and Event Handling
1741
1749
  # @see Wx::Window#show
@@ -1764,15 +1772,13 @@ module Wx
1764
1772
  end # ShowEvent
1765
1773
 
1766
1774
  # An event being sent when the frame is iconized (minimized) or restored.
1767
- # === Events using this class
1775
+ # ### Events using this class
1768
1776
  #
1769
1777
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::IconizeEvent} events.
1770
1778
  # Event handler methods:
1771
1779
  #
1772
1780
  # - {Wx::EvtHandler#evt_iconize}(meth = nil, &block): Process a {Wx::EVT_ICONIZE} event.
1773
1781
  #
1774
- # ===
1775
- #
1776
1782
  # Category: {Wx::Events}
1777
1783
  # @see Events and Event Handling
1778
1784
  # @see Wx::TopLevelWindow#iconize
@@ -1796,16 +1802,14 @@ module Wx
1796
1802
 
1797
1803
  # An event being sent when a top level window is maximized.
1798
1804
  # 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.
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.
1800
- # === Events using this class
1805
+ # 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.
1806
+ # ### Events using this class
1801
1807
  #
1802
1808
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MaximizeEvent} events.
1803
1809
  # Event handler methods:
1804
1810
  #
1805
1811
  # - {Wx::EvtHandler#evt_maximize}(meth = nil, &block): Process a {Wx::EVT_MAXIMIZE} event.
1806
1812
  #
1807
- # ===
1808
- #
1809
1813
  # Category: {Wx::Events}
1810
1814
  # @see Events and Event Handling
1811
1815
  # @see Wx::TopLevelWindow#maximize
@@ -1823,16 +1827,14 @@ module Wx
1823
1827
  end # MaximizeEvent
1824
1828
 
1825
1829
  # An event being sent when the user enters or exits full screen mode.
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}.
1827
- # === Events using this class
1830
+ # 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}.
1831
+ # ### Events using this class
1828
1832
  #
1829
1833
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FullScreenEvent} events.
1830
1834
  # Event handler methods:
1831
1835
  #
1832
1836
  # - {Wx::EvtHandler#evt_fullscreen}(meth = nil, &block): Process a {Wx::EVT_FULLSCREEN} event.
1833
1837
  #
1834
- # ===
1835
- #
1836
1838
  # Category: {Wx::Events}
1837
1839
  # @see Events and Event Handling
1838
1840
  # @see Wx::TopLevelWindow#enable_full_screen_view
@@ -1855,7 +1857,7 @@ module Wx
1855
1857
  end # FullScreenEvent
1856
1858
 
1857
1859
  # This event class contains information about joystick events, particularly events received by windows.
1858
- # === Events using this class
1860
+ # ### Events using this class
1859
1861
  #
1860
1862
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::JoystickEvent} events.
1861
1863
  # Event handler methods:
@@ -1870,8 +1872,6 @@ module Wx
1870
1872
  #
1871
1873
  # - {Wx::EvtHandler#evt_joystick_events}(meth = nil, &block): Processes all joystick events.
1872
1874
  #
1873
- # ===
1874
- #
1875
1875
  # Category: {Wx::Events}
1876
1876
  # @see Wx::Joystick
1877
1877
  #
@@ -1879,7 +1879,7 @@ module Wx
1879
1879
  class JoystickEvent < Event
1880
1880
 
1881
1881
  # Constructor.
1882
- # @param eventType [Wx::CommandLinkButton::EventType]
1882
+ # @param eventType [Wx::Slider::EventType]
1883
1883
  # @param state [Integer]
1884
1884
  # @param joystick [Integer]
1885
1885
  # @param change [Integer]
@@ -1962,16 +1962,18 @@ module Wx
1962
1962
  # This class is used for drop files events, that is, when files have been dropped onto the window.
1963
1963
  # The window must have previously been enabled for dropping by calling {Wx::Window#drag_accept_files}.
1964
1964
  # Important note: this is a separate implementation to the more general drag and drop implementation documented in the Drag and Drop Overview. It uses the older, Windows message-based approach of dropping files.
1965
- # === Events using this class
1965
+ # ### Events using this class
1966
1966
  #
1967
1967
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DropFilesEvent} events.
1968
1968
  # Event handler methods:
1969
1969
  #
1970
1970
  # - {Wx::EvtHandler#evt_drop_files}(meth = nil, &block): Process a {Wx::EVT_DROP_FILES} event.
1971
1971
  #
1972
- # Windows only until version 2.8.9, available on all platforms since 2.8.10.
1973
- #
1974
- # ===
1972
+ # <div class="wxrb-remark">
1973
+ # <b>Remark:</b>
1974
+ # <p>Windows only until version 2.8.9, available on all platforms since 2.8.10.
1975
+ # </p>
1976
+ # </div>>
1975
1977
  #
1976
1978
  # Category: {Wx::Events}
1977
1979
  # @see Events and Event Handling
@@ -1981,7 +1983,7 @@ module Wx
1981
1983
  class DropFilesEvent < Event
1982
1984
 
1983
1985
  # Constructor.
1984
- # @param id [Wx::CommandLinkButton::EventType]
1986
+ # @param id [Wx::Slider::EventType]
1985
1987
  # @param noFiles [Integer]
1986
1988
  # @param files [String]
1987
1989
  # @return [Wx::DropFilesEvent]
@@ -2018,7 +2020,7 @@ module Wx
2018
2020
  #
2019
2021
  # 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.
2020
2022
  # wxWidgets tries to optimize update events on some platforms. On Windows and GTK+, events for menubar items are only sent when the menu is about to be shown, and not in idle time.
2021
- # === Events using this class
2023
+ # ### Events using this class
2022
2024
  #
2023
2025
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::UpdateUIEvent} events.
2024
2026
  # Event handler methods:
@@ -2027,8 +2029,6 @@ module Wx
2027
2029
  #
2028
2030
  # - {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.
2029
2031
  #
2030
- # ===
2031
- #
2032
2032
  # Category: {Wx::Events}
2033
2033
  # @see Events and Event Handling
2034
2034
  #
@@ -2162,17 +2162,20 @@ module Wx
2162
2162
 
2163
2163
  # This class is used for system colour change events, which are generated when the user changes the colour settings or when the system theme changes (e.g. automatic dark mode switching on macOS).
2164
2164
  # Event handlers for this event can access the new system colour settings through {Wx::SystemSettings.get_colour}.
2165
- # The default event handler for this event propagates the event to child windows, since the system events are only sent to top-level windows. If intercepting this event for a top-level window, remember to either call {Wx::Event#skip} on the event, call the base class handler, or pass the event on to the window's children explicitly.
2166
2165
  #
2167
- # === Events using this class
2166
+ # <div class="wxrb-remark">
2167
+ # <b>Remark:</b>
2168
+ # <p>The default event handler for this event propagates the event to child windows, since the system events are only sent to top-level windows. If intercepting this event for a top-level window, remember to either call {Wx::Event#skip} on the event, call the base class handler, or pass the event on to the window's children explicitly.
2169
+ # </p>
2170
+ # </div>>
2171
+ #
2172
+ # ### Events using this class
2168
2173
  #
2169
2174
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SysColourChangedEvent} events.
2170
2175
  # Event handler methods:
2171
2176
  #
2172
2177
  # - {Wx::EvtHandler#evt_sys_colour_changed}(meth = nil, &block): Process a {Wx::EVT_SYS_COLOUR_CHANGED} event.
2173
2178
  #
2174
- # ===
2175
- #
2176
2179
  # Category: {Wx::Events}
2177
2180
  # @see Events and Event Handling
2178
2181
  #
@@ -2187,16 +2190,14 @@ module Wx
2187
2190
 
2188
2191
  # A mouse capture changed event is sent to a window that loses its mouse capture.
2189
2192
  # 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.
2190
- # Availability: only available for the wxMSW port. {Wx::msw}
2191
- # === Events using this class
2193
+ # Availability: only available for the WXMSW port.
2194
+ # ### Events using this class
2192
2195
  #
2193
2196
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MouseCaptureChangedEvent} events.
2194
2197
  # Event handler methods:
2195
2198
  #
2196
2199
  # - {Wx::EvtHandler#evt_mouse_capture_changed}(meth = nil, &block): Process a {Wx::EVT_MOUSE_CAPTURE_CHANGED} event.
2197
2200
  #
2198
- # ===
2199
- #
2200
2201
  # Category: {Wx::Events}
2201
2202
  # @see Wx::MouseCaptureLostEvent
2202
2203
  # @see Events and Event Handling
@@ -2223,15 +2224,14 @@ module Wx
2223
2224
  # A mouse capture lost event is sent to a window that had obtained mouse capture, which was subsequently lost due to an "external" event (for example, when a dialog box is shown or if another application captures the mouse).
2224
2225
  # If this happens, this event is sent to all windows that are on the capture stack (i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is not sent if the capture changes because of a call to CaptureMouse or ReleaseMouse.
2225
2226
  # This event is currently emitted under Windows only.
2226
- # === Events using this class
2227
+ # ### Events using this class
2227
2228
  #
2228
2229
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MouseCaptureLostEvent} events.
2229
2230
  # Event handler methods:
2230
2231
  #
2231
2232
  # - {Wx::EvtHandler#evt_mouse_capture_lost}(meth = nil, &block): Process a {Wx::EVT_MOUSE_CAPTURE_LOST} event.
2232
2233
  #
2233
- # Availability: only available for the wxMSW port. {Wx::msw}
2234
- # ===
2234
+ # Availability: only available for the WXMSW port.
2235
2235
  #
2236
2236
  # Category: {Wx::Events}
2237
2237
  # @see Wx::MouseCaptureChangedEvent
@@ -2252,15 +2252,14 @@ module Wx
2252
2252
 
2253
2253
  # A display changed event is sent to top-level windows when the display resolution has changed.
2254
2254
  # This event is currently emitted under Windows only.
2255
- # === Events using this class
2255
+ # ### Events using this class
2256
2256
  #
2257
2257
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DisplayChangedEvent} events.
2258
2258
  # Event handler methods:
2259
2259
  #
2260
2260
  # - {Wx::EvtHandler#evt_display_changed}(meth = nil, &block): Process a {Wx::EVT_DISPLAY_CHANGED} event.
2261
2261
  #
2262
- # Availability: only available for the wxMSW port. {Wx::msw}
2263
- # ===
2262
+ # Availability: only available for the WXMSW port.
2264
2263
  #
2265
2264
  # Category: {Wx::Events}
2266
2265
  # @see Wx::Display
@@ -2276,16 +2275,14 @@ module Wx
2276
2275
  # 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.
2277
2276
  # 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.
2278
2277
  # 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.
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).
2280
- # === Events using this class
2278
+ # 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).
2279
+ # ### Events using this class
2281
2280
  #
2282
2281
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DPIChangedEvent} events.
2283
2282
  # Event handler methods:
2284
2283
  #
2285
2284
  # - {Wx::EvtHandler#evt_dpi_changed}(meth = nil, &block): Process a {Wx::EVT_DPI_CHANGED} event.
2286
2285
  #
2287
- # ===
2288
- #
2289
2286
  # Category: {Wx::Events}
2290
2287
  # @see Events and Event Handling
2291
2288
  #
@@ -2365,15 +2362,13 @@ module Wx
2365
2362
 
2366
2363
  # This event class contains information about navigation events, generated by navigation keys such as tab and page down.
2367
2364
  # This event is mainly used by wxWidgets implementations. A {Wx::NavigationKeyEvent} handler is automatically provided by wxWidgets when you enable keyboard navigation inside a window by inheriting it from {Wx::NavigationEnabled}<>.
2368
- # === Events using this class
2365
+ # ### Events using this class
2369
2366
  #
2370
2367
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::NavigationKeyEvent} events.
2371
2368
  # Event handler methods:
2372
2369
  #
2373
2370
  # - {Wx::EvtHandler#evt_navigation_key}(meth = nil, &block): Process a navigation key event.
2374
2371
  #
2375
- # ===
2376
- #
2377
2372
  # Category: {Wx::Events}
2378
2373
  # @see Wx::Window#navigate
2379
2374
  # @see Wx::Window#navigate_in
@@ -2468,15 +2463,13 @@ module Wx
2468
2463
 
2469
2464
  # This event is sent just after the actual window associated with a {Wx::Window} object has been created.
2470
2465
  # Since it is derived from {Wx::CommandEvent}, the event propagates up the window hierarchy.
2471
- # === Events using this class
2466
+ # ### Events using this class
2472
2467
  #
2473
2468
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::WindowCreateEvent} events.
2474
2469
  # Event handler methods:
2475
2470
  #
2476
2471
  # - {Wx::EvtHandler#evt_window_create}(meth = nil, &block): Process a {Wx::EVT_CREATE} event.
2477
2472
  #
2478
- # ===
2479
- #
2480
2473
  # Category: {Wx::Events}
2481
2474
  # @see Events and Event Handling
2482
2475
  # @see Wx::WindowDestroyEvent
@@ -2500,7 +2493,6 @@ module Wx
2500
2493
  # For the top level windows, as early as possible means that this is done by {Wx::Frame} or {Wx::Dialog} destructor, i.e. after the destructor of the derived class was executed and so any methods specific to the derived class can't be called any more from this event handler. If you need to do this, you must call {Wx::Window#send_destroy_event} from your derived class destructor.
2501
2494
  # For the child windows, this event is generated just before deleting the window from {Wx::Window#destroy} (which is also called when the parent window is deleted) or from the window destructor if operator delete was used directly (which is not recommended for this very reason).
2502
2495
  # It is usually pointless to handle this event in the window itself but it ca be very useful to receive notifications about the window destruction in the parent window or in any other object interested in this window.
2503
- # ===
2504
2496
  #
2505
2497
  # Category: {Wx::Events}
2506
2498
  # @see Events and Event Handling
@@ -2526,7 +2518,7 @@ module Wx
2526
2518
  # A help event is sent to the window that the user clicked on, and is propagated up the window hierarchy until the event is processed or there are no more event handlers.
2527
2519
  # The application should call {Wx::Event#get_id} to check the identity of the clicked-on window, and then either show some suitable help or call {Wx::Event#skip} if the identifier is unrecognised.
2528
2520
  # Calling Skip is important because it allows wxWidgets to generate further events for ancestors of the clicked-on window. Otherwise it would be impossible to show help for container windows, since processing would stop after the first window found.
2529
- # === Events using this class
2521
+ # ### Events using this class
2530
2522
  #
2531
2523
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HelpEvent} events.
2532
2524
  # Event handler methods:
@@ -2535,8 +2527,6 @@ module Wx
2535
2527
  #
2536
2528
  # - {Wx::EvtHandler#evt_help_range}(id1, id2, meth = nil, &block): Process a {Wx::EVT_HELP} event for a range of ids.
2537
2529
  #
2538
- # ===
2539
- #
2540
2530
  # Category: {Wx::Events}
2541
2531
  # @see Wx::ContextHelp
2542
2532
  # @see Wx::Dialog
@@ -2566,7 +2556,7 @@ module Wx
2566
2556
  end # Origin
2567
2557
 
2568
2558
  # Constructor.
2569
- # @param type [Wx::CommandLinkButton::EventType]
2559
+ # @param type [Wx::Slider::EventType]
2570
2560
  # @param winid [Integer]
2571
2561
  # @param pt [Array(Integer, Integer), Wx::Point]
2572
2562
  # @param origin [Wx::wxHelpEvent::Origin]
@@ -2606,9 +2596,14 @@ module Wx
2606
2596
  # There are three types of corresponding events {Wx::EVT_TEXT_COPY}, {Wx::EVT_TEXT_CUT} and {Wx::EVT_TEXT_PASTE}.
2607
2597
  # 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.
2608
2598
  # 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.
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.
2610
2599
  #
2611
- # === Events using this class
2600
+ # <div class="wxrb-note">
2601
+ # <b>Note:</b>
2602
+ # <p>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.
2603
+ # </p>
2604
+ # </div>
2605
+ #
2606
+ # ### Events using this class
2612
2607
  #
2613
2608
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ClipboardTextEvent} events.
2614
2609
  # Event handler methods:
@@ -2619,8 +2614,6 @@ module Wx
2619
2614
  #
2620
2615
  # - {Wx::EvtHandler#evt_text_paste}(id, meth = nil, &block): Clipboard content was pasted into the control.
2621
2616
  #
2622
- # ===
2623
- #
2624
2617
  # Category: {Wx::Events}
2625
2618
  # @see Wx::Clipboard
2626
2619
  #
@@ -2628,7 +2621,7 @@ module Wx
2628
2621
  class ClipboardTextEvent < CommandEvent
2629
2622
 
2630
2623
  # Constructor.
2631
- # @param commandType [Wx::CommandLinkButton::EventType]
2624
+ # @param commandType [Wx::Slider::EventType]
2632
2625
  # @param id [Integer]
2633
2626
  # @return [Wx::ClipboardTextEvent]
2634
2627
  def initialize(commandType=Wx::EVT_NULL, id=0) end
@@ -2638,15 +2631,13 @@ module Wx
2638
2631
  # This class is used for context menu events, sent to give the application a chance to show a context (popup) menu for a {Wx::Window}.
2639
2632
  # Note that if {Wx::ContextMenuEvent#get_position} returns {Wx::DEFAULT_POSITION}, this means that the event originated from a keyboard context button event, and you should compute a suitable position yourself, for example by calling {get_mouse_position}.
2640
2633
  # Notice that the exact sequence of mouse events is different across the platforms. For example, under MSW the context menu event is generated after EVT_RIGHT_UP event and only if it was not handled but under GTK the context menu event is generated after EVT_RIGHT_DOWN event. This is correct in the sense that it ensures that the context menu is shown according to the current platform UI conventions and also means that you must not handle (or call {Wx::Event#skip} in your handler if you do have one) neither right mouse down nor right mouse up event if you plan on handling EVT_CONTEXT_MENU event.
2641
- # === Events using this class
2634
+ # ### Events using this class
2642
2635
  #
2643
2636
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ContextMenuEvent} events.
2644
2637
  # Event handler methods:
2645
2638
  #
2646
2639
  # - {Wx::EvtHandler#evt_context_menu}(meth = nil, &block): A right click (or other context menu command depending on platform) has been detected.
2647
2640
  #
2648
- # ===
2649
- #
2650
2641
  # Category: {Wx::Events}
2651
2642
  # @see Wx::CommandEvent
2652
2643
  # @see Events and Event Handling
@@ -2655,7 +2646,7 @@ module Wx
2655
2646
  class ContextMenuEvent < CommandEvent
2656
2647
 
2657
2648
  # Constructor.
2658
- # @param type [Wx::CommandLinkButton::EventType]
2649
+ # @param type [Wx::Slider::EventType]
2659
2650
  # @param id [Integer]
2660
2651
  # @param pos [Array(Integer, Integer), Wx::Point]
2661
2652
  # @return [Wx::ContextMenuEvent]
@@ -2679,15 +2670,13 @@ module Wx
2679
2670
 
2680
2671
  # A child focus event is sent to a (parent-)window when one of its child windows gains focus, so that the window could restore the focus back to its corresponding child if it loses it now and regains later.
2681
2672
  # Notice that child window is the direct child of the window receiving event. Use {Wx::Window.find_focus} to retrieve the window which is actually getting focus.
2682
- # === Events using this class
2673
+ # ### Events using this class
2683
2674
  #
2684
2675
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ChildFocusEvent} events.
2685
2676
  # Event handler methods:
2686
2677
  #
2687
2678
  # - {Wx::EvtHandler#evt_child_focus}(meth = nil, &block): Process a {Wx::EVT_CHILD_FOCUS} event.
2688
2679
  #
2689
- # ===
2690
- #
2691
2680
  # Category: {Wx::Events}
2692
2681
  # @see Events and Event Handling
2693
2682
  #