wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (740) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -0
  3. data/INSTALL.md +35 -29
  4. data/README.md +24 -15
  5. data/ext/wxbase32u_gcc_custom.dll +0 -0
  6. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  7. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  19. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  20. data/lib/wx/aui/aui_tab_ctrl.rb +18 -0
  21. data/lib/wx/aui/auinotebook.rb +6 -2
  22. data/lib/wx/aui/require.rb +1 -0
  23. data/lib/wx/core/app.rb +2 -2
  24. data/lib/wx/core/bitmap_combobox.rb +17 -21
  25. data/lib/wx/core/collapsible_pane.rb +1 -1
  26. data/lib/wx/core/combobox.rb +13 -3
  27. data/lib/wx/core/controlwithitems.rb +40 -128
  28. data/lib/wx/core/enum.rb +17 -1
  29. data/lib/wx/core/event.rb +6 -1
  30. data/lib/wx/core/events/evt_list.rb +5 -4
  31. data/lib/wx/core/evthandler.rb +8 -2
  32. data/lib/wx/core/generic_validator.rb +312 -0
  33. data/lib/wx/core/listbox.rb +2 -2
  34. data/lib/wx/core/log.rb +1 -1
  35. data/lib/wx/core/menu.rb +10 -0
  36. data/lib/wx/core/notebook.rb +6 -2
  37. data/lib/wx/core/owner_drawn_combobox.rb +45 -0
  38. data/lib/wx/core/size.rb +4 -0
  39. data/lib/wx/core/sizer.rb +12 -2
  40. data/lib/wx/core/standard_paths.rb +22 -0
  41. data/lib/wx/core/task_bar_button.rb +19 -0
  42. data/lib/wx/core/text_entry.rb +4 -1
  43. data/lib/wx/core/textctrl.rb +11 -1
  44. data/lib/wx/core/{treectrl.rb → tree_ctrl.rb} +31 -12
  45. data/lib/wx/core/validator.rb +70 -5
  46. data/lib/wx/core/window.rb +13 -7
  47. data/lib/wx/doc/app.rb +48 -38
  48. data/lib/wx/doc/art_locator.rb +48 -43
  49. data/lib/wx/doc/aui/auimanager.rb +16 -8
  50. data/lib/wx/doc/aui/auinotebook.rb +20 -5
  51. data/lib/wx/doc/clipboard.rb +11 -7
  52. data/lib/wx/doc/colour_dialog.rb +14 -10
  53. data/lib/wx/doc/comboctrl.rb +18 -0
  54. data/lib/wx/doc/controlwithitems.rb +34 -8
  55. data/lib/wx/doc/data_object.rb +2 -2
  56. data/lib/wx/doc/date_picker_ctrl.rb +23 -0
  57. data/lib/wx/doc/editable_listbox.rb +44 -0
  58. data/lib/wx/doc/enum.rb +15 -0
  59. data/lib/wx/doc/event.rb +12 -0
  60. data/lib/wx/doc/evthandler.rb +113 -108
  61. data/lib/wx/doc/extra/12_client_data.md +89 -0
  62. data/lib/wx/doc/extra/13_validators.md +139 -0
  63. data/lib/wx/doc/font.rb +1 -0
  64. data/lib/wx/doc/gc_dc.rb +6 -1
  65. data/lib/wx/doc/gdi_common.rb +4 -0
  66. data/lib/wx/doc/gen/about_dialog_info.rb +26 -2
  67. data/lib/wx/doc/gen/accelerator.rb +19 -4
  68. data/lib/wx/doc/gen/accessible.rb +48 -47
  69. data/lib/wx/doc/gen/activity_indicator.rb +10 -4
  70. data/lib/wx/doc/gen/animation.rb +19 -3
  71. data/lib/wx/doc/gen/animation_ctrl.rb +16 -7
  72. data/lib/wx/doc/gen/any_button.rb +22 -1
  73. data/lib/wx/doc/gen/app.rb +41 -5
  74. data/lib/wx/doc/gen/app_traits.rb +65 -15
  75. data/lib/wx/doc/gen/art_provider.rb +33 -7
  76. data/lib/wx/doc/gen/aui/aui_dock_art.rb +18 -3
  77. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +2 -0
  78. data/lib/wx/doc/gen/aui/aui_manager.rb +35 -8
  79. data/lib/wx/doc/gen/aui/aui_manager_event.rb +11 -4
  80. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +4 -0
  81. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +3 -0
  82. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +8 -1
  83. data/lib/wx/doc/gen/aui/aui_notebook.rb +31 -7
  84. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +5 -4
  85. data/lib/wx/doc/gen/aui/aui_pane_info.rb +38 -2
  86. data/lib/wx/doc/gen/aui/aui_tab_art.rb +9 -3
  87. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +2 -1
  88. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +20 -6
  89. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +4 -2
  90. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +5 -7
  91. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +5 -1
  92. data/lib/wx/doc/gen/aui/event_list.rb +164 -160
  93. data/lib/wx/doc/gen/banner_window.rb +8 -1
  94. data/lib/wx/doc/gen/bitmap.rb +94 -16
  95. data/lib/wx/doc/gen/bitmap_button.rb +16 -8
  96. data/lib/wx/doc/gen/bitmap_combo_box.rb +20 -10
  97. data/lib/wx/doc/gen/book_ctrl_base.rb +31 -4
  98. data/lib/wx/doc/gen/book_ctrl_event.rb +9 -3
  99. data/lib/wx/doc/gen/box_sizer.rb +5 -1
  100. data/lib/wx/doc/gen/brush.rb +20 -2
  101. data/lib/wx/doc/gen/busy_info.rb +10 -2
  102. data/lib/wx/doc/gen/button.rb +31 -11
  103. data/lib/wx/doc/gen/calculate_layout_event.rb +5 -3
  104. data/lib/wx/doc/gen/calendar_ctrl.rb +38 -13
  105. data/lib/wx/doc/gen/calendar_date_attr.rb +2 -1
  106. data/lib/wx/doc/gen/calendar_event.rb +5 -2
  107. data/lib/wx/doc/gen/caret.rb +3 -1
  108. data/lib/wx/doc/gen/check_box.rb +17 -7
  109. data/lib/wx/doc/gen/check_list_box.rb +8 -6
  110. data/lib/wx/doc/gen/choice.rb +28 -9
  111. data/lib/wx/doc/gen/choicebook.rb +7 -7
  112. data/lib/wx/doc/gen/client_dc.rb +6 -2
  113. data/lib/wx/doc/gen/clipboard.rb +16 -3
  114. data/lib/wx/doc/gen/collapsible_pane.rb +9 -7
  115. data/lib/wx/doc/gen/collapsible_pane_event.rb +3 -3
  116. data/lib/wx/doc/gen/colour.rb +28 -4
  117. data/lib/wx/doc/gen/colour_dialog.rb +15 -7
  118. data/lib/wx/doc/gen/colour_picker_ctrl.rb +13 -10
  119. data/lib/wx/doc/gen/colour_picker_event.rb +5 -5
  120. data/lib/wx/doc/gen/combo_box.rb +36 -14
  121. data/lib/wx/doc/gen/combo_ctrl.rb +117 -295
  122. data/lib/wx/doc/gen/command_link_button.rb +12 -5
  123. data/lib/wx/doc/gen/context_help_button.rb +13 -3
  124. data/lib/wx/doc/gen/control.rb +22 -8
  125. data/lib/wx/doc/gen/control_with_items.rb +45 -10
  126. data/lib/wx/doc/gen/core.rb +4 -4
  127. data/lib/wx/doc/gen/cursor.rb +10 -8
  128. data/lib/wx/doc/gen/data_format.rb +7 -1
  129. data/lib/wx/doc/gen/data_object.rb +42 -18
  130. data/lib/wx/doc/gen/date_event.rb +3 -2
  131. data/lib/wx/doc/gen/date_picker_ctrl.rb +18 -8
  132. data/lib/wx/doc/gen/dc.rb +238 -36
  133. data/lib/wx/doc/gen/defs.rb +51 -51
  134. data/lib/wx/doc/gen/dial_up_event.rb +2 -1
  135. data/lib/wx/doc/gen/dial_up_manager.rb +25 -5
  136. data/lib/wx/doc/gen/dialog.rb +72 -13
  137. data/lib/wx/doc/gen/dir_dialog.rb +22 -5
  138. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +2 -0
  139. data/lib/wx/doc/gen/dir_picker_ctrl.rb +14 -10
  140. data/lib/wx/doc/gen/drag_drop.rb +28 -7
  141. data/lib/wx/doc/gen/drag_image.rb +13 -2
  142. data/lib/wx/doc/gen/editable_list_box.rb +7 -5
  143. data/lib/wx/doc/gen/event.rb +57 -26
  144. data/lib/wx/doc/gen/event_blocker.rb +2 -3
  145. data/lib/wx/doc/gen/event_filter.rb +3 -0
  146. data/lib/wx/doc/gen/event_list.rb +1656 -1652
  147. data/lib/wx/doc/gen/events.rb +305 -173
  148. data/lib/wx/doc/gen/evt_handler.rb +49 -3
  149. data/lib/wx/doc/gen/ext_help_controller.rb +10 -1
  150. data/lib/wx/doc/gen/file_ctrl.rb +28 -10
  151. data/lib/wx/doc/gen/file_ctrl_event.rb +7 -4
  152. data/lib/wx/doc/gen/file_dialog.rb +44 -14
  153. data/lib/wx/doc/gen/file_dialog_custom_control.rb +19 -0
  154. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +11 -3
  155. data/lib/wx/doc/gen/file_dir_picker_event.rb +4 -4
  156. data/lib/wx/doc/gen/file_picker_ctrl.rb +12 -9
  157. data/lib/wx/doc/gen/file_system.rb +54 -15
  158. data/lib/wx/doc/gen/find_dialog_event.rb +6 -4
  159. data/lib/wx/doc/gen/find_replace_data.rb +2 -1
  160. data/lib/wx/doc/gen/find_replace_dialog.rb +4 -1
  161. data/lib/wx/doc/gen/flex_grid_sizer.rb +13 -1
  162. data/lib/wx/doc/gen/font.rb +103 -20
  163. data/lib/wx/doc/gen/font_data.rb +16 -3
  164. data/lib/wx/doc/gen/font_dialog.rb +6 -1
  165. data/lib/wx/doc/gen/font_picker_ctrl.rb +14 -7
  166. data/lib/wx/doc/gen/font_picker_event.rb +3 -3
  167. data/lib/wx/doc/gen/frame.rb +73 -15
  168. data/lib/wx/doc/gen/fs_file.rb +39 -10
  169. data/lib/wx/doc/gen/gauge.rb +19 -8
  170. data/lib/wx/doc/gen/gb_sizer_item.rb +5 -1
  171. data/lib/wx/doc/gen/gcdc.rb +3 -2
  172. data/lib/wx/doc/gen/gdi_common.rb +80 -11
  173. data/lib/wx/doc/gen/gdi_object.rb +1 -1
  174. data/lib/wx/doc/gen/generic_dir_ctrl.rb +13 -7
  175. data/lib/wx/doc/gen/graphics_context.rb +86 -10
  176. data/lib/wx/doc/gen/graphics_object.rb +35 -6
  177. data/lib/wx/doc/gen/grid/event_list.rb +168 -164
  178. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +3 -0
  179. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +16 -3
  180. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -1
  181. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +2 -1
  182. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +2 -1
  183. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -1
  184. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +2 -1
  185. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +2 -1
  186. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +2 -1
  187. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +2 -1
  188. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +10 -1
  189. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +2 -1
  190. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +2 -1
  191. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -1
  192. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +2 -1
  193. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +2 -1
  194. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -1
  195. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +7 -1
  196. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -1
  197. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -1
  198. data/lib/wx/doc/gen/grid/grid_ctrl.rb +256 -12
  199. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +6 -4
  200. data/lib/wx/doc/gen/grid/grid_event.rb +6 -4
  201. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +4 -4
  202. data/lib/wx/doc/gen/grid/grid_size_event.rb +4 -4
  203. data/lib/wx/doc/gen/grid/grid_string_table.rb +8 -0
  204. data/lib/wx/doc/gen/grid/grid_table_base.rb +28 -3
  205. data/lib/wx/doc/gen/grid/grid_table_message.rb +2 -0
  206. data/lib/wx/doc/gen/grid_bag_sizer.rb +21 -7
  207. data/lib/wx/doc/gen/grid_sizer.rb +11 -1
  208. data/lib/wx/doc/gen/gui_event_loop.rb +13 -3
  209. data/lib/wx/doc/gen/header_ctrl.rb +110 -11
  210. data/lib/wx/doc/gen/header_ctrl_event.rb +4 -2
  211. data/lib/wx/doc/gen/help_controller.rb +14 -3
  212. data/lib/wx/doc/gen/help_provider.rb +22 -4
  213. data/lib/wx/doc/gen/html/event_list.rb +41 -37
  214. data/lib/wx/doc/gen/html/html_cell.rb +48 -6
  215. data/lib/wx/doc/gen/html/html_cell_event.rb +5 -4
  216. data/lib/wx/doc/gen/html/html_easy_printing.rb +20 -3
  217. data/lib/wx/doc/gen/html/html_help_controller.rb +26 -2
  218. data/lib/wx/doc/gen/html/html_help_data.rb +8 -1
  219. data/lib/wx/doc/gen/html/html_help_window.rb +9 -1
  220. data/lib/wx/doc/gen/html/html_link_event.rb +3 -3
  221. data/lib/wx/doc/gen/html/html_list_box.rb +54 -16
  222. data/lib/wx/doc/gen/html/html_printout.rb +7 -1
  223. data/lib/wx/doc/gen/html/html_window.rb +43 -6
  224. data/lib/wx/doc/gen/hyperlink_ctrl.rb +9 -8
  225. data/lib/wx/doc/gen/hyperlink_event.rb +3 -3
  226. data/lib/wx/doc/gen/icon.rb +23 -29
  227. data/lib/wx/doc/gen/icon_location.rb +1 -1
  228. data/lib/wx/doc/gen/image.rb +143 -20
  229. data/lib/wx/doc/gen/image_list.rb +25 -6
  230. data/lib/wx/doc/gen/info_bar.rb +14 -2
  231. data/lib/wx/doc/gen/keyboard_state.rb +11 -1
  232. data/lib/wx/doc/gen/list_box.rb +46 -17
  233. data/lib/wx/doc/gen/list_ctrl.rb +165 -29
  234. data/lib/wx/doc/gen/list_event.rb +13 -4
  235. data/lib/wx/doc/gen/listbook.rb +7 -7
  236. data/lib/wx/doc/gen/locale.rb +68 -4
  237. data/lib/wx/doc/gen/log.rb +58 -12
  238. data/lib/wx/doc/gen/mdi_client_window.rb +11 -2
  239. data/lib/wx/doc/gen/mdi_frame.rb +51 -7
  240. data/lib/wx/doc/gen/media_ctrl.rb +43 -18
  241. data/lib/wx/doc/gen/media_event.rb +6 -4
  242. data/lib/wx/doc/gen/memory_dc.rb +16 -6
  243. data/lib/wx/doc/gen/menu.rb +81 -26
  244. data/lib/wx/doc/gen/menu_bar.rb +74 -15
  245. data/lib/wx/doc/gen/menu_item.rb +67 -19
  246. data/lib/wx/doc/gen/message_dialog.rb +17 -8
  247. data/lib/wx/doc/gen/mini_frame.rb +14 -5
  248. data/lib/wx/doc/gen/mirror_dc.rb +1 -2
  249. data/lib/wx/doc/gen/mouse_state.rb +1 -1
  250. data/lib/wx/doc/gen/multi_choice_dialog.rb +9 -4
  251. data/lib/wx/doc/gen/non_owned_window.rb +4 -1
  252. data/lib/wx/doc/gen/notebook.rb +27 -9
  253. data/lib/wx/doc/gen/num_validator.rb +37 -0
  254. data/lib/wx/doc/gen/number_entry_dialog.rb +5 -1
  255. data/lib/wx/doc/gen/object.rb +3 -1
  256. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +340 -0
  257. data/lib/wx/doc/gen/paint_dc.rb +1 -1
  258. data/lib/wx/doc/gen/palette.rb +5 -1
  259. data/lib/wx/doc/gen/panel.rb +25 -8
  260. data/lib/wx/doc/gen/pen.rb +46 -8
  261. data/lib/wx/doc/gen/pg/event_list.rb +97 -93
  262. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +4 -1
  263. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +12 -1
  264. data/lib/wx/doc/gen/pg/pg_cell.rb +11 -3
  265. data/lib/wx/doc/gen/pg/pg_editor.rb +161 -16
  266. data/lib/wx/doc/gen/pg/pg_multi_button.rb +3 -2
  267. data/lib/wx/doc/gen/pg/pg_properties.rb +632 -83
  268. data/lib/wx/doc/gen/pg/pg_property.rb +381 -77
  269. data/lib/wx/doc/gen/pg/pg_validation_info.rb +11 -4
  270. data/lib/wx/doc/gen/pg/property_grid.rb +123 -20
  271. data/lib/wx/doc/gen/pg/property_grid_event.rb +41 -9
  272. data/lib/wx/doc/gen/pg/property_grid_interface.rb +273 -34
  273. data/lib/wx/doc/gen/pg/property_grid_manager.rb +62 -10
  274. data/lib/wx/doc/gen/pg/property_grid_page.rb +33 -8
  275. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +18 -4
  276. data/lib/wx/doc/gen/picker_base.rb +22 -5
  277. data/lib/wx/doc/gen/platform_info.rb +35 -9
  278. data/lib/wx/doc/gen/popup_window.rb +7 -5
  279. data/lib/wx/doc/gen/progress_dialog.rb +5 -0
  280. data/lib/wx/doc/gen/property_sheet_dialog.rb +20 -4
  281. data/lib/wx/doc/gen/prt/event_list.rb +8 -4
  282. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +3 -1
  283. data/lib/wx/doc/gen/prt/post_script_dc.rb +3 -2
  284. data/lib/wx/doc/gen/prt/preview_frame.rb +5 -1
  285. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +4 -0
  286. data/lib/wx/doc/gen/prt/print_data.rb +31 -3
  287. data/lib/wx/doc/gen/prt/print_dialog.rb +5 -1
  288. data/lib/wx/doc/gen/prt/printer.rb +87 -11
  289. data/lib/wx/doc/gen/prt/printer_dc.rb +3 -1
  290. data/lib/wx/doc/gen/query_layout_info_event.rb +10 -3
  291. data/lib/wx/doc/gen/radio_box.rb +28 -10
  292. data/lib/wx/doc/gen/radio_button.rb +22 -9
  293. data/lib/wx/doc/gen/rbn/event_list.rb +127 -123
  294. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +82 -3
  295. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +26 -4
  296. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +3 -2
  297. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +50 -12
  298. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +3 -2
  299. data/lib/wx/doc/gen/rbn/ribbon_control.rb +11 -1
  300. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +21 -11
  301. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -2
  302. data/lib/wx/doc/gen/rbn/ribbon_page.rb +12 -1
  303. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +16 -4
  304. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +3 -3
  305. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +27 -3
  306. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +3 -1
  307. data/lib/wx/doc/gen/rearrange_ctrl.rb +5 -2
  308. data/lib/wx/doc/gen/rearrange_list.rb +12 -4
  309. data/lib/wx/doc/gen/region.rb +104 -17
  310. data/lib/wx/doc/gen/region_iterator.rb +1 -1
  311. data/lib/wx/doc/gen/rtc/event_list.rb +116 -112
  312. data/lib/wx/doc/gen/rtc/rich_text_box.rb +27 -9
  313. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +45 -11
  314. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -1
  315. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +23 -14
  316. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +84 -7
  317. data/lib/wx/doc/gen/rtc/rich_text_event.rb +8 -4
  318. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +8 -2
  319. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +8 -3
  320. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +4 -2
  321. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +6 -3
  322. data/lib/wx/doc/gen/rtc/rich_text_image.rb +7 -2
  323. data/lib/wx/doc/gen/rtc/rich_text_object.rb +82 -17
  324. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +54 -11
  325. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +15 -2
  326. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +14 -9
  327. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +4 -1
  328. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +4 -3
  329. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +2 -2
  330. data/lib/wx/doc/gen/sash_event.rb +13 -4
  331. data/lib/wx/doc/gen/sash_layout_window.rb +21 -4
  332. data/lib/wx/doc/gen/sash_window.rb +6 -4
  333. data/lib/wx/doc/gen/screen_dc.rb +1 -1
  334. data/lib/wx/doc/gen/scroll_bar.rb +28 -10
  335. data/lib/wx/doc/gen/scrolled_canvas.rb +48 -10
  336. data/lib/wx/doc/gen/scrolled_control.rb +48 -10
  337. data/lib/wx/doc/gen/scrolled_window.rb +48 -10
  338. data/lib/wx/doc/gen/search_ctrl.rb +14 -9
  339. data/lib/wx/doc/gen/simplebook.rb +8 -1
  340. data/lib/wx/doc/gen/single_choice_dialog.rb +9 -4
  341. data/lib/wx/doc/gen/sizer.rb +91 -16
  342. data/lib/wx/doc/gen/sizer_item.rb +21 -4
  343. data/lib/wx/doc/gen/slider.rb +50 -17
  344. data/lib/wx/doc/gen/spin_button.rb +24 -10
  345. data/lib/wx/doc/gen/spin_ctrl.rb +35 -9
  346. data/lib/wx/doc/gen/spin_ctrl_double.rb +13 -7
  347. data/lib/wx/doc/gen/spin_double_event.rb +6 -4
  348. data/lib/wx/doc/gen/spin_event.rb +4 -3
  349. data/lib/wx/doc/gen/splash_screen.rb +3 -2
  350. data/lib/wx/doc/gen/splitter_event.rb +12 -4
  351. data/lib/wx/doc/gen/splitter_window.rb +100 -18
  352. data/lib/wx/doc/gen/static_bitmap.rb +109 -7
  353. data/lib/wx/doc/gen/static_box.rb +15 -7
  354. data/lib/wx/doc/gen/static_box_sizer.rb +3 -2
  355. data/lib/wx/doc/gen/static_line.rb +7 -4
  356. data/lib/wx/doc/gen/static_text.rb +10 -6
  357. data/lib/wx/doc/gen/status_bar.rb +32 -8
  358. data/lib/wx/doc/gen/stc/event_list.rb +212 -208
  359. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +207 -13
  360. data/lib/wx/doc/gen/stc/styled_text_event.rb +31 -6
  361. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +7 -1
  362. data/lib/wx/doc/gen/svg_file_dc.rb +15 -7
  363. data/lib/wx/doc/gen/system_options.rb +14 -6
  364. data/lib/wx/doc/gen/system_settings.rb +9 -3
  365. data/lib/wx/doc/gen/task_bar_button.rb +324 -0
  366. data/lib/wx/doc/gen/task_bar_icon.rb +26 -8
  367. data/lib/wx/doc/gen/task_bar_icon_event.rb +5 -3
  368. data/lib/wx/doc/gen/text_attr.rb +47 -5
  369. data/lib/wx/doc/gen/text_ctrl.rb +114 -25
  370. data/lib/wx/doc/gen/text_entry.rb +69 -11
  371. data/lib/wx/doc/gen/text_entry_dialog.rb +14 -2
  372. data/lib/wx/doc/gen/text_validator.rb +58 -9
  373. data/lib/wx/doc/gen/time_picker_ctrl.rb +11 -6
  374. data/lib/wx/doc/gen/timer.rb +14 -2
  375. data/lib/wx/doc/gen/timer_event.rb +2 -2
  376. data/lib/wx/doc/gen/tip_provider.rb +6 -1
  377. data/lib/wx/doc/gen/toggle_button.rb +73 -6
  378. data/lib/wx/doc/gen/tool_bar.rb +141 -25
  379. data/lib/wx/doc/gen/tool_tip.rb +41 -5
  380. data/lib/wx/doc/gen/toolbook.rb +6 -4
  381. data/lib/wx/doc/gen/top_level_window.rb +100 -23
  382. data/lib/wx/doc/gen/tree_ctrl.rb +89 -16
  383. data/lib/wx/doc/gen/tree_event.rb +9 -4
  384. data/lib/wx/doc/gen/treebook.rb +16 -4
  385. data/lib/wx/doc/gen/ui_action_simulator.rb +10 -2
  386. data/lib/wx/doc/gen/utils.rb +94 -7
  387. data/lib/wx/doc/gen/v_list_box.rb +27 -2
  388. data/lib/wx/doc/gen/v_scrolled_window.rb +21 -4
  389. data/lib/wx/doc/gen/validator.rb +10 -14
  390. data/lib/wx/doc/gen/variant.rb +7 -0
  391. data/lib/wx/doc/gen/window.rb +415 -57
  392. data/lib/wx/doc/gen/window_dc.rb +2 -1
  393. data/lib/wx/doc/gen/window_disabler.rb +6 -2
  394. data/lib/wx/doc/gen/with_images.rb +13 -2
  395. data/lib/wx/doc/gen/wizard.rb +22 -4
  396. data/lib/wx/doc/gen/wizard_event.rb +5 -4
  397. data/lib/wx/doc/gen/wizard_page.rb +7 -2
  398. data/lib/wx/doc/gen/wizard_page_simple.rb +5 -1
  399. data/lib/wx/doc/gen/wrap_sizer.rb +5 -1
  400. data/lib/wx/doc/gen/xml_node.rb +33 -4
  401. data/lib/wx/doc/gen/xml_resource.rb +40 -5
  402. data/lib/wx/doc/generic_validator.rb +95 -0
  403. data/lib/wx/doc/graphics_context.rb +1 -0
  404. data/lib/wx/doc/grid/grid.rb +22 -1
  405. data/lib/wx/doc/help_controller.rb +11 -7
  406. data/lib/wx/doc/html/html_help_controller.rb +12 -4
  407. data/lib/wx/doc/html/simple_html_listbox.rb +22 -0
  408. data/lib/wx/doc/list_ctrl.rb +33 -29
  409. data/lib/wx/doc/menu.rb +20 -0
  410. data/lib/wx/doc/notebook.rb +21 -0
  411. data/lib/wx/doc/num_validator.rb +387 -0
  412. data/lib/wx/doc/owner_drawn_combobox.rb +96 -0
  413. data/lib/wx/doc/pg/events.rb +13 -9
  414. data/lib/wx/doc/pg/numeric_property_validator.rb +33 -0
  415. data/lib/wx/doc/pg/pg_property.rb +18 -0
  416. data/lib/wx/doc/progress_dialog.rb +36 -32
  417. data/lib/wx/doc/prt/page_setup_dialog.rb +20 -12
  418. data/lib/wx/doc/prt/print_data.rb +13 -5
  419. data/lib/wx/doc/prt/print_dialog.rb +31 -23
  420. data/lib/wx/doc/prt/printer.rb +20 -12
  421. data/lib/wx/doc/radio_box.rb +19 -15
  422. data/lib/wx/doc/rbn/ribbon_bar.rb +13 -5
  423. data/lib/wx/doc/rbn/ribbon_button_bar.rb +13 -5
  424. data/lib/wx/doc/rbn/ribbon_gallery.rb +13 -5
  425. data/lib/wx/doc/rbn/ribbon_tool_bar.rb +13 -5
  426. data/lib/wx/doc/region_iterator.rb +32 -28
  427. data/lib/wx/doc/rtc/rich_text_composite_object.rb +24 -0
  428. data/lib/wx/doc/rtc/rich_text_ctrl.rb +24 -0
  429. data/lib/wx/doc/rtc/rich_text_paragraph.rb +24 -0
  430. data/lib/wx/doc/rtc/richtext_buffer.rb +27 -19
  431. data/lib/wx/doc/rtc/richtext_printing.rb +17 -9
  432. data/lib/wx/doc/rtc/richtext_style_sheet.rb +17 -9
  433. data/lib/wx/doc/sizer.rb +20 -0
  434. data/lib/wx/doc/static_bitmap.rb +25 -0
  435. data/lib/wx/doc/stc/styled_text_ctrl.rb +24 -0
  436. data/lib/wx/doc/stream.rb +39 -35
  437. data/lib/wx/doc/system_settings.rb +30 -26
  438. data/lib/wx/doc/text_validator.rb +23 -9
  439. data/lib/wx/doc/textctrl.rb +16 -0
  440. data/lib/wx/doc/tree_ctrl.rb +95 -0
  441. data/lib/wx/doc/treebook.rb +9 -5
  442. data/lib/wx/doc/v_list_box.rb +9 -5
  443. data/lib/wx/doc/validator.rb +113 -0
  444. data/lib/wx/doc/variant.rb +164 -160
  445. data/lib/wx/doc/window.rb +87 -47
  446. data/lib/wx/doc/window_disabler.rb +10 -6
  447. data/lib/wx/grid/grid.rb +27 -4
  448. data/lib/wx/html/events/evt_list.rb +0 -10
  449. data/lib/wx/html/simple_html_listbox.rb +24 -91
  450. data/lib/wx/keyword_defs.rb +34 -2
  451. data/lib/wx/pg/pg_property.rb +22 -0
  452. data/lib/wx/rbn/ribbon_gallery.rb +0 -21
  453. data/lib/wx/rtc/require.rb +3 -0
  454. data/lib/wx/rtc/rich_text_composite_object.rb +25 -0
  455. data/lib/wx/rtc/rich_text_ctrl.rb +25 -0
  456. data/lib/wx/rtc/rich_text_paragraph.rb +25 -0
  457. data/lib/wx/stc/require.rb +1 -0
  458. data/lib/wx/stc/styled_text_ctrl.rb +25 -0
  459. data/lib/wx/version.rb +1 -1
  460. data/lib/wxruby_aui.so +0 -0
  461. data/lib/wxruby_core.so +0 -0
  462. data/lib/wxruby_grid.so +0 -0
  463. data/lib/wxruby_html.so +0 -0
  464. data/lib/wxruby_pg.so +0 -0
  465. data/lib/wxruby_prt.so +0 -0
  466. data/lib/wxruby_rbn.so +0 -0
  467. data/lib/wxruby_rtc.so +0 -0
  468. data/lib/wxruby_stc.so +0 -0
  469. data/rakelib/lib/config/linux.rb +0 -3
  470. data/rakelib/lib/config/macosx.rb +2 -2
  471. data/rakelib/lib/config/mingw.rb +13 -1
  472. data/rakelib/lib/config/unixish.rb +1 -1
  473. data/rakelib/lib/config.rb +14 -4
  474. data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css +74 -2
  475. data/rakelib/yard/templates/default/fulldoc/html/full_list.erb +38 -0
  476. data/rakelib/yard/templates/default/fulldoc/html/setup.rb +39 -0
  477. data/rakelib/yard/templates/default/tags/html/wxrb_require.erb +10 -0
  478. data/rakelib/yard/templates/default/tags/setup.rb +16 -0
  479. data/rakelib/yard/yard-custom-templates.rb +3 -0
  480. data/samples/aui/aui.rb +1237 -1233
  481. data/samples/calendar/calendar.rb +293 -289
  482. data/samples/controls/get_item_sample.rb +83 -79
  483. data/samples/controls/htlbox.rb +331 -327
  484. data/samples/dialogs/dialogs.rb +682 -694
  485. data/samples/dialogs/wizard.rb +52 -55
  486. data/samples/dragdrop/dragdrop.rb +146 -142
  487. data/samples/drawing/bitmap.rb +29 -26
  488. data/samples/drawing/bitmap_image.rb +84 -80
  489. data/samples/drawing/graphics_drawing.rb +209 -205
  490. data/samples/drawing/image_prt.rb +344 -340
  491. data/samples/drawing/maths_images.rb +18 -1
  492. data/samples/drawing/rmagic_bitmap_image.rb +88 -84
  493. data/samples/etc/caret.rb +306 -0
  494. data/samples/etc/miniframe.rb +65 -60
  495. data/samples/etc/sash.rb +109 -105
  496. data/samples/etc/scrollwin.rb +86 -80
  497. data/samples/etc/system_settings.rb +216 -209
  498. data/samples/event/activation.rb +72 -67
  499. data/samples/event/event.rb +160 -153
  500. data/samples/event/threaded.rb +8 -1
  501. data/samples/event/update_ui_event.rb +67 -60
  502. data/samples/grid/grid.rb +188 -181
  503. data/samples/grid/gridtablebase.rb +136 -129
  504. data/samples/html/html.rb +208 -204
  505. data/samples/mdi/mdi.rb +59 -54
  506. data/samples/minimal/minimal.rb +54 -51
  507. data/samples/minimal/nothing.rb +1 -0
  508. data/samples/printing/printing.rb +367 -377
  509. data/samples/printing/printing2.rb +203 -198
  510. data/samples/propgrid/propgrid.rb +2312 -2308
  511. data/samples/propgrid/propgrid_minimal.rb +57 -50
  512. data/samples/ribbon/ribbon.rb +780 -774
  513. data/samples/sampler/ext.rb +0 -33
  514. data/samples/sampler/sample.rb +4 -9
  515. data/samples/sampler.rb +1 -1
  516. data/samples/splash/splash.rb +118 -116
  517. data/samples/text/rich_textctrl.rb +207 -201
  518. data/samples/text/richtext.rb +1409 -1405
  519. data/samples/text/scintilla.rb +137 -128
  520. data/samples/text/textctrl.rb +89 -83
  521. data/samples/text/unicode.rb +175 -168
  522. data/samples/treectrl/treectrl.rb +1430 -1426
  523. data/samples/widgets/activityindicator.rb +95 -0
  524. data/samples/widgets/art/widgets/activityindicator.xpm +278 -0
  525. data/samples/widgets/art/widgets/bmpbtn.xpm +37 -0
  526. data/samples/widgets/art/widgets/bmpcombobox.xpm +54 -0
  527. data/samples/widgets/art/widgets/button.xpm +54 -0
  528. data/samples/widgets/art/widgets/checkbox.xpm +54 -0
  529. data/samples/{bigdemo/icons → widgets/art/widgets}/choice.xpm +1 -1
  530. data/samples/widgets/art/widgets/choicebk.xpm +54 -0
  531. data/samples/widgets/art/widgets/clrpicker.xpm +193 -0
  532. data/samples/widgets/art/widgets/combobox.xpm +54 -0
  533. data/samples/widgets/art/widgets/datepick.xpm +200 -0
  534. data/samples/widgets/art/widgets/dirctrl.xpm +54 -0
  535. data/samples/widgets/art/widgets/dirpicker.xpm +213 -0
  536. data/samples/widgets/art/widgets/filepicker.xpm +214 -0
  537. data/samples/widgets/art/widgets/fontpicker.xpm +185 -0
  538. data/samples/widgets/art/widgets/gauge.xpm +54 -0
  539. data/samples/widgets/art/widgets/header.xpm +54 -0
  540. data/samples/widgets/art/widgets/hyperlnk.xpm +54 -0
  541. data/samples/widgets/art/widgets/listbook.xpm +54 -0
  542. data/samples/widgets/art/widgets/listbox.xpm +54 -0
  543. data/samples/widgets/art/widgets/native.xpm +81 -0
  544. data/samples/widgets/art/widgets/notebook.xpm +54 -0
  545. data/samples/widgets/art/widgets/odcombobox.xpm +54 -0
  546. data/samples/widgets/art/widgets/radiobox.xpm +54 -0
  547. data/samples/widgets/art/widgets/scrolbar.xpm +54 -0
  548. data/samples/widgets/art/widgets/slider.xpm +54 -0
  549. data/samples/widgets/art/widgets/spinbtn.xpm +40 -0
  550. data/samples/widgets/art/widgets/statbmp.xpm +40 -0
  551. data/samples/widgets/art/widgets/statbox.xpm +54 -0
  552. data/samples/widgets/art/widgets/stattext.xpm +54 -0
  553. data/samples/widgets/art/widgets/text.xpm +54 -0
  554. data/samples/widgets/art/widgets/timepick.xpm +207 -0
  555. data/samples/widgets/art/widgets/toggle.xpm +54 -0
  556. data/samples/widgets/art/widgets/toucan.png +0 -0
  557. data/samples/widgets/bmpcombobox.rb +651 -0
  558. data/samples/widgets/button.rb +462 -0
  559. data/samples/widgets/checkbox.rb +211 -0
  560. data/samples/widgets/choice.rb +287 -0
  561. data/samples/widgets/clrpicker.rb +156 -0
  562. data/samples/widgets/combobox.rb +516 -0
  563. data/samples/widgets/datepick.rb +215 -0
  564. data/samples/widgets/dirctrl.rb +265 -0
  565. data/samples/widgets/dirpicker.rb +158 -0
  566. data/samples/widgets/editlbox.rb +122 -0
  567. data/samples/widgets/filectrl.rb +216 -0
  568. data/samples/widgets/filepicker.rb +214 -0
  569. data/samples/widgets/fontpicker.rb +135 -0
  570. data/samples/widgets/gauge.rb +311 -0
  571. data/samples/widgets/headerctrl.rb +236 -0
  572. data/samples/widgets/hyperlink.rb +203 -0
  573. data/samples/widgets/itemcontainer.rb +185 -0
  574. data/samples/widgets/listbox.rb +473 -0
  575. data/samples/widgets/notebook.rb +488 -0
  576. data/samples/widgets/odcombobox.rb +608 -0
  577. data/samples/widgets/radiobox.rb +328 -0
  578. data/samples/widgets/searchctrl.rb +159 -0
  579. data/samples/widgets/slider.rb +594 -0
  580. data/samples/widgets/spinbtn.rb +443 -0
  581. data/samples/widgets/statbmp.rb +130 -0
  582. data/samples/widgets/static.rb +436 -0
  583. data/samples/widgets/textctrl.rb +700 -0
  584. data/samples/widgets/timepick.rb +148 -0
  585. data/samples/widgets/tn_widgets.png +0 -0
  586. data/samples/widgets/toggle.rb +385 -0
  587. data/samples/widgets/widgets.rb +1233 -0
  588. data/samples/xrc/custom_xrc_sample.rb +47 -41
  589. data/samples/xrc/xrc_sample.rb +53 -47
  590. data/tests/media/beep_lo.wav +0 -0
  591. data/tests/test_event_handling.rb +52 -34
  592. data/tests/test_events.rb +7 -0
  593. data/tests/test_item_data.rb +24 -0
  594. data/tests/test_list_ctrl.rb +1 -1
  595. data/tests/test_media_ctrl.rb +38 -0
  596. data/tests/test_menu.rb +69 -0
  597. data/tests/test_pg.rb +27 -0
  598. data/tests/test_richtext.rb +45 -0
  599. data/tests/test_sizer.rb +59 -0
  600. data/tests/test_std_controls.rb +42 -1
  601. data/tests/test_styled_text_ctrl.rb +46 -0
  602. data/tests/test_tree_ctrl.rb +138 -0
  603. data/tests/test_validators.rb +805 -0
  604. data/tests/test_window.rb +12 -0
  605. data/tests/testapp_noframe.rb +1 -1
  606. metadata +113 -138
  607. data/lib/wx/core/choice.rb +0 -14
  608. data/lib/wx/core/combo_ctrl.rb +0 -110
  609. data/samples/bigdemo/About.rbw +0 -39
  610. data/samples/bigdemo/ColorPanel.rbw +0 -23
  611. data/samples/bigdemo/GridSimple.rbw +0 -78
  612. data/samples/bigdemo/MDIDemo.rbw +0 -57
  613. data/samples/bigdemo/PopupMenu.rbw +0 -146
  614. data/samples/bigdemo/ShapedWindow.rbw +0 -128
  615. data/samples/bigdemo/Sizers.rbw +0 -541
  616. data/samples/bigdemo/bigdemo.rb +0 -817
  617. data/samples/bigdemo/demoTemplate.rbw +0 -33
  618. data/samples/bigdemo/helpfile.htb +0 -0
  619. data/samples/bigdemo/icons/Test 015.jpg +0 -0
  620. data/samples/bigdemo/icons/Test 015.png +0 -0
  621. data/samples/bigdemo/icons/choice.bmp +0 -0
  622. data/samples/bigdemo/icons/combo.bmp +0 -0
  623. data/samples/bigdemo/icons/combo.xpm +0 -27
  624. data/samples/bigdemo/icons/copy.xpm +0 -25
  625. data/samples/bigdemo/icons/cut.xpm +0 -24
  626. data/samples/bigdemo/icons/gauge.bmp +0 -0
  627. data/samples/bigdemo/icons/gauge.xpm +0 -27
  628. data/samples/bigdemo/icons/help.xpm +0 -25
  629. data/samples/bigdemo/icons/list.bmp +0 -0
  630. data/samples/bigdemo/icons/list.xpm +0 -27
  631. data/samples/bigdemo/icons/mondrian.ico +0 -0
  632. data/samples/bigdemo/icons/mondrian.xpm +0 -44
  633. data/samples/bigdemo/icons/new.xpm +0 -24
  634. data/samples/bigdemo/icons/ogl.ico +0 -0
  635. data/samples/bigdemo/icons/ogl.xpm +0 -45
  636. data/samples/bigdemo/icons/open.xpm +0 -26
  637. data/samples/bigdemo/icons/paste.bmp +0 -0
  638. data/samples/bigdemo/icons/paste.xpm +0 -38
  639. data/samples/bigdemo/icons/pointy.png +0 -0
  640. data/samples/bigdemo/icons/preview.xpm +0 -26
  641. data/samples/bigdemo/icons/print.xpm +0 -26
  642. data/samples/bigdemo/icons/radio.bmp +0 -0
  643. data/samples/bigdemo/icons/radio.xpm +0 -27
  644. data/samples/bigdemo/icons/robert.xpm +0 -415
  645. data/samples/bigdemo/icons/sashtest.ico +0 -0
  646. data/samples/bigdemo/icons/save.xpm +0 -25
  647. data/samples/bigdemo/icons/smiles.bmp +0 -0
  648. data/samples/bigdemo/icons/smiles.xpm +0 -39
  649. data/samples/bigdemo/icons/smiley.ico +0 -0
  650. data/samples/bigdemo/icons/smiley.xpm +0 -42
  651. data/samples/bigdemo/icons/stattext.xpm +0 -24
  652. data/samples/bigdemo/icons/test2.bmp +0 -0
  653. data/samples/bigdemo/icons/test2.png +0 -0
  654. data/samples/bigdemo/icons/test2.xpm +0 -79
  655. data/samples/bigdemo/icons/text.bmp +0 -0
  656. data/samples/bigdemo/icons/text.xpm +0 -27
  657. data/samples/bigdemo/icons/tog1.bmp +0 -0
  658. data/samples/bigdemo/icons/tog1.xpm +0 -38
  659. data/samples/bigdemo/icons/tog2.bmp +0 -0
  660. data/samples/bigdemo/icons/tog2.xpm +0 -38
  661. data/samples/bigdemo/icons/wxruby-128x128.png +0 -0
  662. data/samples/bigdemo/icons/wxwin.ico +0 -0
  663. data/samples/bigdemo/icons/wxwin16x16.png +0 -0
  664. data/samples/bigdemo/icons/wxwin16x16.xpm +0 -25
  665. data/samples/bigdemo/icons/wxwin32x32.png +0 -0
  666. data/samples/bigdemo/icons/wxwin48x48.png +0 -0
  667. data/samples/bigdemo/run.rb +0 -98
  668. data/samples/bigdemo/tips.txt +0 -7
  669. data/samples/bigdemo/utils.rb +0 -20
  670. data/samples/bigdemo/wxArtProvider.rbw +0 -282
  671. data/samples/bigdemo/wxBitmapButton.rbw +0 -65
  672. data/samples/bigdemo/wxButton.rbw +0 -64
  673. data/samples/bigdemo/wxCalendarCtrl.rbw +0 -59
  674. data/samples/bigdemo/wxCheckBox.rbw +0 -50
  675. data/samples/bigdemo/wxCheckListBox.rbw +0 -65
  676. data/samples/bigdemo/wxChoice.rbw +0 -47
  677. data/samples/bigdemo/wxChoicebook.rbw +0 -78
  678. data/samples/bigdemo/wxColourDialog.rbw +0 -33
  679. data/samples/bigdemo/wxComboBox.rbw +0 -77
  680. data/samples/bigdemo/wxCursor.rbw +0 -136
  681. data/samples/bigdemo/wxDialog.rbw +0 -74
  682. data/samples/bigdemo/wxDirDialog.rbw +0 -29
  683. data/samples/bigdemo/wxDragImage.rbw +0 -70
  684. data/samples/bigdemo/wxFileDialog.rbw +0 -37
  685. data/samples/bigdemo/wxFileDialog_Save.rbw +0 -35
  686. data/samples/bigdemo/wxFindReplaceDialog.rbw +0 -82
  687. data/samples/bigdemo/wxFontDialog.rbw +0 -200
  688. data/samples/bigdemo/wxFrame.rbw +0 -53
  689. data/samples/bigdemo/wxGauge.rbw +0 -65
  690. data/samples/bigdemo/wxGenericDirCtrl.rbw +0 -74
  691. data/samples/bigdemo/wxGrid.rbw +0 -66
  692. data/samples/bigdemo/wxHtmlHelpController.rbw +0 -52
  693. data/samples/bigdemo/wxListBox.rbw +0 -140
  694. data/samples/bigdemo/wxListCtrl_virtual.rbw +0 -112
  695. data/samples/bigdemo/wxMDIWindows.rbw +0 -50
  696. data/samples/bigdemo/wxMenu.rbw +0 -247
  697. data/samples/bigdemo/wxMessageDialog.rbw +0 -27
  698. data/samples/bigdemo/wxMiniFrame.rbw +0 -70
  699. data/samples/bigdemo/wxMultipleChoiceDialog.rbw +0 -29
  700. data/samples/bigdemo/wxNotebook.rbw +0 -136
  701. data/samples/bigdemo/wxProgressDialog.rbw +0 -43
  702. data/samples/bigdemo/wxRadioBox.rbw +0 -72
  703. data/samples/bigdemo/wxRadioButton.rbw +0 -125
  704. data/samples/bigdemo/wxSashWindow.rbw +0 -141
  705. data/samples/bigdemo/wxScrolledMessageDialog.rbw +0 -57
  706. data/samples/bigdemo/wxScrolledWindow.rbw +0 -199
  707. data/samples/bigdemo/wxSingleChoiceDialog.rbw +0 -33
  708. data/samples/bigdemo/wxSlider.rbw +0 -42
  709. data/samples/bigdemo/wxSpinButton.rbw +0 -50
  710. data/samples/bigdemo/wxSpinCtrl.rbw +0 -51
  711. data/samples/bigdemo/wxSplitterWindow.rbw +0 -63
  712. data/samples/bigdemo/wxStaticBitmap.rbw +0 -47
  713. data/samples/bigdemo/wxStaticText.rbw +0 -55
  714. data/samples/bigdemo/wxStatusBar.rbw +0 -126
  715. data/samples/bigdemo/wxTextCtrl.rbw +0 -149
  716. data/samples/bigdemo/wxTextEntryDialog.rbw +0 -31
  717. data/samples/bigdemo/wxToggleButton.rbw +0 -49
  718. data/samples/bigdemo/wxToolBar.rbw +0 -131
  719. data/samples/bigdemo/wxTreeCtrl.rbw +0 -191
  720. data/samples/caret/caret.rb +0 -298
  721. data/samples/caret/mondrian.xpm +0 -44
  722. data/samples/controls/books.rb +0 -189
  723. data/samples/controls/choice.xpm +0 -27
  724. data/samples/controls/combo.xpm +0 -27
  725. data/samples/controls/controls.rb +0 -1099
  726. data/samples/controls/gauge.xpm +0 -27
  727. data/samples/controls/list.xpm +0 -27
  728. data/samples/controls/mondrian.ico +0 -0
  729. data/samples/controls/mondrian.xpm +0 -44
  730. data/samples/controls/radio.xpm +0 -27
  731. data/samples/controls/stattext.xpm +0 -24
  732. data/samples/controls/test2.bmp +0 -0
  733. data/samples/controls/text.xpm +0 -27
  734. data/samples/controls/tn_books.png +0 -0
  735. data/samples/controls/tn_controls.png +0 -0
  736. data/samples/etc/choice.rb +0 -87
  737. data/samples/etc/tn_choice.png +0 -0
  738. data/samples/text/mondrian.ico +0 -0
  739. data/samples/text/mondrian.xpm +0 -44
  740. /data/samples/{caret → etc}/tn_caret.png +0 -0
@@ -7,22 +7,21 @@
7
7
  module Wx
8
8
 
9
9
  # This class is used for idle events, which are generated when the system becomes idle.
10
+ #
10
11
  # Note that, unless you do something specifically, the idle events are not sent if the system remains idle once it has become it, e.g. only a single idle event will be generated until something else resulting in more normal events happens and only then is the next idle event sent again.
11
12
  # 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
13
  # 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
14
  # 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
15
+ # ### Events using this class
15
16
  #
16
17
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::IdleEvent} events.
17
18
  # Event handler methods:
18
19
  #
19
20
  # - {Wx::EvtHandler#evt_idle}(meth = nil, &block): Process a {Wx::EVT_IDLE} event.
20
21
  #
21
- # ===
22
- #
23
22
  # Category: {Wx::Events}
24
23
  #
25
- # == Delayed Action Mechanism
24
+ # ## Delayed Action Mechanism
26
25
  #
27
26
  # {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
27
  # 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.
@@ -40,11 +39,13 @@ module Wx
40
39
 
41
40
  # Returns true if the OnIdle function processing this event requested more processing time.
42
41
  #
42
+ #
43
43
  # @see Wx::IdleEvent#request_more
44
44
  # @return [Boolean]
45
45
  def more_requested; end
46
46
 
47
47
  # Tells wxWidgets that more processing is required.
48
+ #
48
49
  # This function can be called by an OnIdle handler for a window or window event handler to indicate that {Wx::App::OnIdle} should forward the OnIdle event once more to the application windows.
49
50
  # If no window calls this function during OnIdle, then the application will remain in a passive event loop (not calling OnIdle) until a new event is posted to the application by the windowing system.
50
51
  # @see Wx::IdleEvent#more_requested
@@ -54,6 +55,7 @@ module Wx
54
55
 
55
56
  # Static function returning a value specifying how wxWidgets will send idle events: to all windows, or only to those which specify that they will process the events.
56
57
  #
58
+ #
57
59
  # @see Wx::IdleEvent.set_mode.
58
60
  # @return [Wx::IdleMode]
59
61
  def self.get_mode; end
@@ -66,8 +68,8 @@ module Wx
66
68
  end # IdleEvent
67
69
 
68
70
  # This class is not used by the event handlers by itself, but is a base class for other event classes (such as {Wx::BookCtrlEvent}).
71
+ #
69
72
  # 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
73
  #
72
74
  # Category: {Wx::Events}
73
75
  # @see Wx::BookCtrlEvent
@@ -76,12 +78,13 @@ module Wx
76
78
  class NotifyEvent < CommandEvent
77
79
 
78
80
  # Constructor (used internally by wxWidgets only).
79
- # @param eventType [Wx::CommandLinkButton::EventType]
81
+ # @param eventType [Wx::StaticLine::EventType]
80
82
  # @param id [Integer]
81
83
  # @return [Wx::NotifyEvent]
82
84
  def initialize(eventType=Wx::EVT_NULL, id=0) end
83
85
 
84
86
  # This is the opposite of {Wx::NotifyEvent#veto}: it explicitly allows the event to be processed.
87
+ #
85
88
  # For most events it is not necessary to call this method as the events are allowed anyhow but some are forbidden by default (this will be mentioned in the corresponding event description).
86
89
  # @return [void]
87
90
  def allow; end
@@ -92,6 +95,7 @@ module Wx
92
95
  alias_method :allowed?, :is_allowed
93
96
 
94
97
  # Prevents the change announced by this event from happening.
98
+ #
95
99
  # It is in general a good idea to notify the user about the reasons for vetoing the change because otherwise the applications behaviour (which just refuses to do what the user wants) might be quite surprising.
96
100
  # @return [void]
97
101
  def veto; end
@@ -99,16 +103,22 @@ module Wx
99
103
  end # NotifyEvent
100
104
 
101
105
  # A scroll event holds information about events sent from stand-alone scrollbars (see {Wx::ScrollBar}) and sliders (see {Wx::Slider}).
106
+ #
102
107
  # 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
108
  #
104
- # == The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
109
+ # ## The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
105
110
  #
106
111
  # 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
112
  # 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
113
  # 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
114
  #
111
- # === Events using this class
115
+ # <div class="wxrb-remark">
116
+ # <b>Remark:</b>
117
+ # <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.
118
+ # </p>
119
+ # </div>
120
+ #
121
+ # ### Events using this class
112
122
  #
113
123
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollEvent} events.
114
124
  # Event handler methods: except for this, the macros behave exactly the same.
@@ -153,8 +163,6 @@ module Wx
153
163
  #
154
164
  # - {Wx::EvtHandler#evt_command_scroll_changed}(meth = nil, &block): Process {Wx::EVT_SCROLL_CHANGED} end of scrolling events (MSW only).
155
165
  #
156
- # ===
157
- #
158
166
  # Category: {Wx::Events}
159
167
  # @see Wx::ScrollBar
160
168
  # @see Wx::Slider
@@ -166,7 +174,7 @@ module Wx
166
174
  class ScrollEvent < CommandEvent
167
175
 
168
176
  # Constructor.
169
- # @param commandType [Wx::CommandLinkButton::EventType]
177
+ # @param commandType [Wx::StaticLine::EventType]
170
178
  # @param id [Integer]
171
179
  # @param pos [Integer]
172
180
  # @param orientation [Integer]
@@ -196,8 +204,9 @@ module Wx
196
204
  end # ScrollEvent
197
205
 
198
206
  # A scroll event holds information about events sent from scrolling windows.
207
+ #
199
208
  # Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events from the receiving window.
200
- # === Events using this class
209
+ # ### Events using this class
201
210
  #
202
211
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollWinEvent} events.
203
212
  # Event handler methods:
@@ -220,8 +229,6 @@ module Wx
220
229
  #
221
230
  # - {Wx::EvtHandler#evt_scrollwin_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBRELEASE} thumb release events.
222
231
  #
223
- # ===
224
- #
225
232
  # Category: {Wx::Events}
226
233
  # @see Wx::ScrollEvent
227
234
  # @see Events and Event Handling
@@ -230,19 +237,21 @@ module Wx
230
237
  class ScrollWinEvent < Event
231
238
 
232
239
  # Constructor.
233
- # @param commandType [Wx::CommandLinkButton::EventType]
240
+ # @param commandType [Wx::StaticLine::EventType]
234
241
  # @param pos [Integer]
235
242
  # @param orientation [Integer]
236
243
  # @return [Wx::ScrollWinEvent]
237
244
  def initialize(commandType=Wx::EVT_NULL, pos=0, orientation=0) end
238
245
 
239
246
  # Returns {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}, depending on the orientation of the scrollbar.
247
+ #
240
248
  # Todo{Wx::Orientation::HORIZONTAL} and {Wx::Orientation::VERTICAL} should go in their own enum
241
249
  # @return [Integer]
242
250
  def get_orientation; end
243
251
  alias_method :orientation, :get_orientation
244
252
 
245
253
  # Returns the position of the scrollbar for the thumb track and release events.
254
+ #
246
255
  # Note that this field can't be used for the other events, you need to query the window itself for the current position in that case.
247
256
  # @return [Integer]
248
257
  def get_position; end
@@ -261,12 +270,18 @@ module Wx
261
270
  end # ScrollWinEvent
262
271
 
263
272
  # This event class contains information about the events generated by the mouse: they include mouse buttons press and release events and mouse move events.
273
+ #
264
274
  # 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
275
  # 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
276
  # 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
277
  #
269
- # === Events using this class
278
+ # <div class="wxrb-note">
279
+ # <b>Note:</b>
280
+ # <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.
281
+ # </p>
282
+ # </div>
283
+ #
284
+ # ### Events using this class
270
285
  #
271
286
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MouseEvent} events.
272
287
  # Event handler methods:
@@ -313,8 +328,6 @@ module Wx
313
328
  #
314
329
  # - {Wx::EvtHandler#evt_magnify}(meth = nil, &block): Process a {Wx::EVT_MAGNIFY} event (new since wxWidgets 3.1.0).
315
330
  #
316
- # ===
317
- #
318
331
  # Category: {Wx::Events}
319
332
  # @see Wx::KeyEvent
320
333
  #
@@ -322,6 +335,7 @@ module Wx
322
335
  class MouseEvent < Event
323
336
 
324
337
  # Constructor.
338
+ #
325
339
  # Valid event types are:
326
340
  #
327
341
  # - {Wx::EVT_ENTER_WINDOW}
@@ -363,7 +377,7 @@ module Wx
363
377
  # - {Wx::EVT_MOUSEWHEEL}
364
378
  #
365
379
  # - {Wx::EVT_MAGNIFY}
366
- # @param mouseEventType [Wx::CommandLinkButton::EventType]
380
+ # @param mouseEventType [Wx::StaticLine::EventType]
367
381
  # @return [Wx::MouseEvent]
368
382
  def initialize(mouseEventType=Wx::EVT_NULL) end
369
383
 
@@ -393,24 +407,28 @@ module Wx
393
407
 
394
408
  # Returns true if the event was generated by the specified button.
395
409
  #
410
+ #
396
411
  # @see wxMouseState::ButtoinIsDown()
397
412
  # @param but [Wx::MouseButton]
398
413
  # @return [Boolean]
399
414
  def button(but) end
400
415
 
401
416
  # If the argument is omitted, this returns true if the event was a mouse double click event.
417
+ #
402
418
  # Otherwise the argument specifies which double click event was generated (see {Wx::MouseEvent#button} for the possible values).
403
419
  # @param but [Wx::MouseButton]
404
420
  # @return [Boolean]
405
421
  def button_d_click(but=Wx::MouseButton::MOUSE_BTN_ANY) end
406
422
 
407
423
  # If the argument is omitted, this returns true if the event was a mouse button down event.
424
+ #
408
425
  # Otherwise the argument specifies which button-down event was generated (see {Wx::MouseEvent#button} for the possible values).
409
426
  # @param but [Wx::MouseButton]
410
427
  # @return [Boolean]
411
428
  def button_down(but=Wx::MouseButton::MOUSE_BTN_ANY) end
412
429
 
413
430
  # If the argument is omitted, this returns true if the event was a mouse button up event.
431
+ #
414
432
  # Otherwise the argument specifies which button-up event was generated (see {Wx::MouseEvent#button} for the possible values).
415
433
  # @param but [Wx::MouseButton]
416
434
  # @return [Boolean]
@@ -418,28 +436,33 @@ module Wx
418
436
 
419
437
  # Returns true if this was a dragging event (motion while a button is depressed).
420
438
  #
439
+ #
421
440
  # @see Wx::MouseEvent#moving
422
441
  # @return [Boolean]
423
442
  def dragging; end
424
443
 
425
444
  # Returns true if the mouse was entering the window.
426
445
  #
446
+ #
427
447
  # @see Wx::MouseEvent#leaving
428
448
  # @return [Boolean]
429
449
  def entering; end
430
450
 
431
451
  # Returns the mouse button which generated this event or {Wx::MouseButton::MOUSE_BTN_NONE} if no button is involved (for mouse move, enter or leave event, for example).
452
+ #
432
453
  # Otherwise {Wx::MouseButton::MOUSE_BTN_LEFT} is returned for the left button down, up and double click events, {Wx::MouseButton::MOUSE_BTN_MIDDLE} and {Wx::MouseButton::MOUSE_BTN_RIGHT} for the same events for the middle and the right buttons respectively.
433
454
  # @return [Integer]
434
455
  def get_button; end
435
456
 
436
457
  # 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 wxMac and returns -1 for the other platforms (you can still distinguish simple clicks from double-clicks as they generate different kinds of events however).
458
+ #
459
+ # 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
460
  # @return [Integer]
439
461
  def get_click_count; end
440
462
  alias_method :click_count, :get_click_count
441
463
 
442
464
  # Returns the configured number of lines (or whatever) to be scrolled per wheel action.
465
+ #
443
466
  # Default value under most platforms is three.
444
467
  # @see Wx::MouseEvent#get_columns_per_action
445
468
  # @return [Integer]
@@ -447,6 +470,7 @@ module Wx
447
470
  alias_method :lines_per_action, :get_lines_per_action
448
471
 
449
472
  # Returns the configured number of columns (or whatever) to be scrolled per wheel action.
473
+ #
450
474
  # Default value under most platforms is three.
451
475
  # @see Wx::MouseEvent#get_lines_per_action
452
476
  # @return [Integer]
@@ -460,6 +484,7 @@ module Wx
460
484
  alias_method :logical_position, :get_logical_position
461
485
 
462
486
  # For magnify (pinch to zoom) events: returns the change in magnification.
487
+ #
463
488
  # A value of 0 means no change, a positive value means we should enlarge (or zoom in), a negative value means we should shrink (or zoom out).
464
489
  # This method is only valid to call for {Wx::EVT_MAGNIFY} events which are currently only generated under macOS.
465
490
  # @see Wx::MouseEvent#magnify
@@ -468,18 +493,21 @@ module Wx
468
493
  alias_method :magnification, :get_magnification
469
494
 
470
495
  # Get wheel delta, normally 120.
496
+ #
471
497
  # This is the threshold for action to be taken, and one such action (for example, scrolling one increment) should occur for each delta.
472
498
  # @return [Integer]
473
499
  def get_wheel_delta; end
474
500
  alias_method :wheel_delta, :get_wheel_delta
475
501
 
476
502
  # On Mac, has the user selected "Natural" scrolling in their System Preferences? Currently false on all other OS's.
503
+ #
477
504
  # "Natural" scrolling means that content scrolling happens in the opposite direction, and if you are indeed scrolling content then you don't need to use this function because macOS has already inverted the scroll direction. But there can be special situations where you want the mouse wheel action to work always in the same direction and in that case you will need this function.
478
505
  # @return [Boolean]
479
506
  def is_wheel_inverted; end
480
507
  alias_method :wheel_inverted?, :is_wheel_inverted
481
508
 
482
509
  # Get wheel rotation, positive or negative indicates direction of rotation.
510
+ #
483
511
  # Current devices all send an event when rotation is at least +/-WheelDelta, but finer resolution devices can be created in the future.
484
512
  # Because of this you shouldn't assume that one event is equal to 1 line, but you should be able to either do partial line scrolling or wait until several events accumulate before scrolling.
485
513
  # @return [Integer]
@@ -487,6 +515,7 @@ module Wx
487
515
  alias_method :wheel_rotation, :get_wheel_rotation
488
516
 
489
517
  # Gets the axis the wheel operation concerns.
518
+ #
490
519
  # Usually the mouse wheel is used to scroll vertically so {Wx::MouseWheelAxis::MOUSE_WHEEL_VERTICAL} is returned but some mice (and most trackpads) also allow to use the wheel to scroll horizontally in which case {Wx::MouseWheelAxis::MOUSE_WHEEL_HORIZONTAL} is returned.
491
520
  # Notice that before wxWidgets 2.9.4 this method returned int.
492
521
  # @return [Wx::MouseWheelAxis]
@@ -505,6 +534,7 @@ module Wx
505
534
 
506
535
  # Returns true if the mouse was leaving the window.
507
536
  #
537
+ #
508
538
  # @see Wx::MouseEvent#entering.
509
539
  # @return [Boolean]
510
540
  def leaving; end
@@ -522,6 +552,7 @@ module Wx
522
552
  def left_up; end
523
553
 
524
554
  # Returns true if the event is a magnify (i.e. pinch to zoom) event.
555
+ #
525
556
  # Such events are currently generated only under macOS.
526
557
  # @see Wx::MouseEvent#get_magnification
527
558
  # @return [Boolean]
@@ -544,6 +575,7 @@ module Wx
544
575
  def middle_up; end
545
576
 
546
577
  # Returns true if this was a motion event and no mouse buttons were pressed.
578
+ #
547
579
  # If any mouse button is held pressed, then this method returns false and {Wx::MouseEvent#dragging} returns true.
548
580
  # @return [Boolean]
549
581
  def moving; end
@@ -641,6 +673,7 @@ module Wx
641
673
  alias_method :state=, :set_state
642
674
 
643
675
  # Return the bit mask of all pressed modifier keys.
676
+ #
644
677
  # The return value is a combination of {Wx::KeyModifier::MOD_ALT}, {Wx::KeyModifier::MOD_CONTROL}, {Wx::KeyModifier::MOD_SHIFT} and {Wx::KeyModifier::MOD_META} bit masks. Additionally, {Wx::KeyModifier::MOD_NONE} is defined as 0, i.e. corresponds to no modifiers (see {Wx::MouseEvent#has_any_modifiers}) and {Wx::KeyModifier::MOD_CMD} is either {Wx::KeyModifier::MOD_CONTROL} (MSW and Unix) or {Wx::KeyModifier::MOD_META} (Mac), see {Wx::MouseEvent#cmd_down}. See {Wx::KeyModifier} for the full list of modifiers.
645
678
  # Notice that this function is easier to use correctly than, for example, {Wx::MouseEvent#control_down} because when using the latter you also have to remember to test that none of the other modifiers is pressed:
646
679
  #
@@ -662,6 +695,7 @@ module Wx
662
695
  alias_method :modifiers, :get_modifiers
663
696
 
664
697
  # Returns true if any modifiers at all are pressed.
698
+ #
665
699
  # This is equivalent to <code>Wx::MouseEvent#get_modifiers</code> <code>!=</code> {Wx::KeyModifier::MOD_NONE}.
666
700
  # Notice that this is different from {Wx::MouseEvent#has_modifiers} method which doesn't take e.g. Shift modifier into account. This method is most suitable for mouse events when any modifier, including Shift, can change the interpretation of the event.
667
701
  # @return [Boolean]
@@ -669,6 +703,7 @@ module Wx
669
703
  alias_method :has_any_modifiers?, :has_any_modifiers
670
704
 
671
705
  # Returns true if Control or Alt are pressed.
706
+ #
672
707
  # Checks if Control, Alt or, under macOS only, Command key are pressed (notice that the real Control key is still taken into account under OS X too).
673
708
  # This method returns false if only Shift is pressed for compatibility reasons and also because pressing Shift usually doesn't change the interpretation of key events, see {Wx::MouseEvent#has_any_modifiers} if you want to take Shift into account as well.
674
709
  # @return [Boolean]
@@ -676,29 +711,34 @@ module Wx
676
711
  alias_method :has_modifiers?, :has_modifiers
677
712
 
678
713
  # Returns true if the Control key or Apple/Command key under macOS is pressed.
714
+ #
679
715
  # This function doesn't distinguish between right and left control keys.
680
716
  # Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
681
717
  # @return [Boolean]
682
718
  def control_down; end
683
719
 
684
720
  # Returns true if the Control key (also under macOS).
721
+ #
685
722
  # This function doesn't distinguish between right and left control keys.
686
723
  # Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
687
724
  # @return [Boolean]
688
725
  def raw_control_down; end
689
726
 
690
727
  # Returns true if the Shift key is pressed.
728
+ #
691
729
  # This function doesn't distinguish between right and left shift keys.
692
730
  # Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
693
731
  # @return [Boolean]
694
732
  def shift_down; end
695
733
 
696
734
  # Returns true if the Alt key is pressed.
735
+ #
697
736
  # Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
698
737
  # @return [Boolean]
699
738
  def alt_down; end
700
739
 
701
740
  # Returns true if the key used for command accelerators is pressed.
741
+ #
702
742
  # Same as {Wx::MouseEvent#control_down}. Deprecated.
703
743
  # Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
704
744
  # @return [Boolean]
@@ -732,16 +772,15 @@ module Wx
732
772
  end # MouseEvent
733
773
 
734
774
  # A {Wx::SetCursorEvent} is generated from {Wx::Window} when the mouse cursor is about to be set as a result of mouse motion.
775
+ #
735
776
  # 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
777
+ # ### Events using this class
737
778
  #
738
779
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SetCursorEvent} events.
739
780
  # Event handler methods:
740
781
  #
741
782
  # - {Wx::EvtHandler#evt_set_cursor}(meth = nil, &block): Process a {Wx::EVT_SET_CURSOR} event.
742
783
  #
743
- # ===
744
- #
745
784
  # Category: {Wx::Events}
746
785
  # @see Wx::SetCursor
747
786
  # @see Wx::Window#set_cursor
@@ -771,7 +810,12 @@ module Wx
771
810
  alias_method :y, :get_y
772
811
 
773
812
  # 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.
813
+ #
814
+ # <div class="wxrb-remark">
815
+ # <b>Remark:</b>
816
+ # <p>You cannot specify {Wx::NULL_CURSOR} with this event, as it is not considered a valid cursor.
817
+ # </p>
818
+ # </div>
775
819
  # @return [Boolean]
776
820
  def has_cursor; end
777
821
  alias_method :has_cursor?, :has_cursor
@@ -785,9 +829,12 @@ module Wx
785
829
  end # SetCursorEvent
786
830
 
787
831
  # 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
832
  #
790
- # ===
833
+ # <div class="wxrb-note">
834
+ # <b>Note:</b>
835
+ # <p>Gesture events are not generated by default, you must call {Wx::Window#enable_touch_events} with the appropriate parameter to request their generation.
836
+ # </p>
837
+ # </div>
791
838
  #
792
839
  # Category: {Wx::Events}
793
840
  # @see Wx::PanGestureEvent
@@ -799,7 +846,7 @@ module Wx
799
846
 
800
847
  # Constructor.
801
848
  # @param winid [Integer]
802
- # @param type [Wx::CommandLinkButton::EventType]
849
+ # @param type [Wx::StaticLine::EventType]
803
850
  # @return [Wx::GestureEvent]
804
851
  def initialize(winid=0, type=Wx::EVT_NULL) end
805
852
 
@@ -839,17 +886,16 @@ module Wx
839
886
  end # GestureEvent
840
887
 
841
888
  # 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).
889
+ #
890
+ # WXGTK also generates this event during mouse dragging (mouse motion while a left mouse button is depressed).
843
891
  # Note that OSX requires the primary mouse button to be pressed while performing the finger movement.
844
- # === Events using this class
892
+ # ### Events using this class
845
893
  #
846
894
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::PanGestureEvent} events.
847
895
  # Event handler methods:
848
896
  #
849
897
  # - {Wx::EvtHandler#evt_gesture_pan}(id, meth = nil, &block): Process a {Wx::EVT_GESTURE_PAN}.
850
898
  #
851
- # ===
852
- #
853
899
  # Category: {Wx::Events}
854
900
  #
855
901
  class PanGestureEvent < GestureEvent
@@ -873,15 +919,14 @@ module Wx
873
919
  end # PanGestureEvent
874
920
 
875
921
  # This event is generated when two fingers pinch the surface to zoom in or out.
876
- # === Events using this class
922
+ #
923
+ # ### Events using this class
877
924
  #
878
925
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ZoomGestureEvent} events.
879
926
  # Event handler methods:
880
927
  #
881
928
  # - {Wx::EvtHandler#evt_gesture_zoom}(id, meth = nil, &block): Process a {Wx::EVT_GESTURE_ZOOM}.
882
929
  #
883
- # ===
884
- #
885
930
  # Category: {Wx::Events}
886
931
  #
887
932
  class ZoomGestureEvent < GestureEvent
@@ -892,6 +937,7 @@ module Wx
892
937
  def initialize(windid=0) end
893
938
 
894
939
  # Returns the zoom Factor since the gesture started.
940
+ #
895
941
  # Hence, starting of the gesture is considered as 1:1. A value greater than 1.0 means we should enlarge (or zoom in), a value less than 1.0 means we should shrink (or zoom out).
896
942
  # @return [Float]
897
943
  def get_zoom_factor; end
@@ -906,15 +952,14 @@ module Wx
906
952
  end # ZoomGestureEvent
907
953
 
908
954
  # This event is generated when two fingers move in opposite directions on the surface.
909
- # === Events using this class
955
+ #
956
+ # ### Events using this class
910
957
  #
911
958
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::RotateGestureEvent} events.
912
959
  # Event handler methods:
913
960
  #
914
961
  # - {Wx::EvtHandler#evt_gesture_rotate}(id, meth = nil, &block): Process a {Wx::EVT_GESTURE_ROTATE}.
915
962
  #
916
- # ===
917
- #
918
963
  # Category: {Wx::Events}
919
964
  #
920
965
  class RotateGestureEvent < GestureEvent
@@ -925,12 +970,14 @@ module Wx
925
970
  def initialize(windid=0) end
926
971
 
927
972
  # Returns the total angle of rotation in radians in clockwise direction since the gesture was first started i.e.
973
+ #
928
974
  # when {Wx::RotateGestureEvent#is_gesture_start} returned true. This value is always greater than or equal to zero.
929
975
  # @return [Float]
930
976
  def get_rotation_angle; end
931
977
  alias_method :rotation_angle, :get_rotation_angle
932
978
 
933
979
  # Sets the total angle of rotation in radians in clockwise direction since the gesture was first started i.e.
980
+ #
934
981
  # when {Wx::RotateGestureEvent#is_gesture_start} returned true. This value is always greater than or equal to zero.
935
982
  # @param rotationAngle [Float]
936
983
  # @return [void]
@@ -940,15 +987,14 @@ module Wx
940
987
  end # RotateGestureEvent
941
988
 
942
989
  # This event is generated when two fingers touch the surface at the same time.
943
- # === Events using this class
990
+ #
991
+ # ### Events using this class
944
992
  #
945
993
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::TwoFingerTapEvent} events.
946
994
  # Event handler methods:
947
995
  #
948
996
  # - {Wx::EvtHandler#evt_two_finger_tap}(id, meth = nil, &block): Process a {Wx::EVT_TWO_FINGER_TAP}.
949
997
  #
950
- # ===
951
- #
952
998
  # Category: {Wx::Events}
953
999
  #
954
1000
  class TwoFingerTapEvent < GestureEvent
@@ -961,17 +1007,16 @@ module Wx
961
1007
  end # TwoFingerTapEvent
962
1008
 
963
1009
  # 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
1010
+ #
1011
+ # Note that currently it is only generated under WXGTK and WXOSX.
1012
+ # WXGTK also generates this event when left mouse button is being pressed for some minimum duration of time.
1013
+ # ### Events using this class
967
1014
  #
968
1015
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::LongPressEvent} events.
969
1016
  # Event handler methods:
970
1017
  #
971
1018
  # - {Wx::EvtHandler#evt_long_press}(id, meth = nil, &block): Process a {Wx::EVT_LONG_PRESS}.
972
1019
  #
973
- # ===
974
- #
975
1020
  # Category: {Wx::Events}
976
1021
  #
977
1022
  class LongPressEvent < GestureEvent
@@ -984,16 +1029,15 @@ module Wx
984
1029
  end # LongPressEvent
985
1030
 
986
1031
  # This event is generated when the user press the surface with one finger and taps with another.
1032
+ #
987
1033
  # Note that once started the event will also be generated when the finger that was pressed moves on surface.
988
- # === Events using this class
1034
+ # ### Events using this class
989
1035
  #
990
1036
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::PressAndTapEvent} events.
991
1037
  # Event handler methods:
992
1038
  #
993
1039
  # - {Wx::EvtHandler#evt_press_and_tap}(id, meth = nil, &block): Process a {Wx::EVT_PRESS_AND_TAP}.
994
1040
  #
995
- # ===
996
- #
997
1041
  # Category: {Wx::Events}
998
1042
  #
999
1043
  class PressAndTapEvent < GestureEvent
@@ -1006,6 +1050,7 @@ module Wx
1006
1050
  end # PressAndTapEvent
1007
1051
 
1008
1052
  # This event class contains information about key press and release events.
1053
+ #
1009
1054
  # 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
1055
  # 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
1056
  # 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:
@@ -1017,19 +1062,37 @@ module Wx
1017
1062
  # 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
1063
  # 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
1064
  # 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.
1065
+ #
1066
+ # <div class="wxrb-note">
1067
+ # <b>Note:</b>
1068
+ # <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.
1069
+ # </p>
1070
+ # </div>
1021
1071
  #
1022
1072
  # 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.
1023
1073
  # 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
1074
  # 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
1075
  # <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
1076
  #
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.
1077
+ # <div class="wxrb-note">
1078
+ # <b>Note:</b>
1079
+ # <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.
1080
+ # </p>
1081
+ # </div>
1082
+ #
1083
+ # <div class="wxrb-note">
1084
+ # <b>Note:</b>
1085
+ # <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.
1086
+ # </p>
1087
+ # </div>
1029
1088
  #
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.
1089
+ # <div class="wxrb-note">
1090
+ # <b>Note:</b>
1091
+ # <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.
1092
+ # </p>
1093
+ # </div>
1031
1094
  #
1032
- # === Events using this class
1095
+ # ### Events using this class
1033
1096
  #
1034
1097
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::KeyEvent} events.
1035
1098
  # Event handler methods:
@@ -1042,8 +1105,6 @@ module Wx
1042
1105
  #
1043
1106
  # - {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
1107
  #
1045
- # ===
1046
- #
1047
1108
  # Category: {Wx::Events}
1048
1109
  # @see Wx::KeyboardState
1049
1110
  #
@@ -1051,6 +1112,7 @@ module Wx
1051
1112
  class KeyEvent < Event
1052
1113
 
1053
1114
  # Obtains the position (in client coordinates) at which the key was pressed.
1115
+ #
1054
1116
  # Notice that under most platforms this position is simply the current mouse pointer position and has no special relationship to the key event itself.
1055
1117
  # x and y may be NULL if the corresponding coordinate is not needed.
1056
1118
  # @return [Wx::Point]
@@ -1058,12 +1120,14 @@ module Wx
1058
1120
  alias_method :position, :get_position
1059
1121
 
1060
1122
  # Constructor.
1123
+ #
1061
1124
  # Currently, the only valid event types are {Wx::EVT_CHAR} and {Wx::EVT_CHAR_HOOK}.
1062
- # @param keyEventType [Wx::CommandLinkButton::EventType]
1125
+ # @param keyEventType [Wx::StaticLine::EventType]
1063
1126
  # @return [Wx::KeyEvent]
1064
1127
  def initialize(keyEventType=Wx::EVT_NULL) end
1065
1128
 
1066
1129
  # Returns the key code of the key that generated this event.
1130
+ #
1067
1131
  # 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.
1068
1132
  # 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.
1069
1133
  # 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:
@@ -1108,26 +1172,39 @@ module Wx
1108
1172
  alias_method :auto_repeat?, :is_auto_repeat
1109
1173
 
1110
1174
  # Returns the raw key code for this event.
1175
+ #
1111
1176
  # The flags are platform-dependent and should only be used if the functionality provided by other {Wx::KeyEvent} methods is insufficient.
1112
1177
  # Under MSW, the raw key code is the value of wParam parameter of the corresponding message.
1113
1178
  # Under GTK, the raw key code is the keyval field of the corresponding GDK event.
1114
1179
  # 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.
1180
+ #
1181
+ # <div class="wxrb-note">
1182
+ # <b>Note:</b>
1183
+ # <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.
1184
+ # </p>
1185
+ # </div>
1116
1186
  # @return [Integer]
1117
1187
  def get_raw_key_code; end
1118
1188
  alias_method :raw_key_code, :get_raw_key_code
1119
1189
 
1120
1190
  # Returns the low level key flags for this event.
1191
+ #
1121
1192
  # The flags are platform-dependent and should only be used if the functionality provided by other {Wx::KeyEvent} methods is insufficient.
1122
1193
  # Under MSW, the raw flags are just the value of lParam parameter of the corresponding message.
1123
1194
  # Under GTK, the raw flags contain the hardware_keycode field of the corresponding GDK event.
1124
1195
  # Under macOS, the raw flags contain the modifiers state.
1125
- # Currently the raw key flags are not supported by all ports.
1196
+ #
1197
+ # <div class="wxrb-note">
1198
+ # <b>Note:</b>
1199
+ # <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.
1200
+ # </p>
1201
+ # </div>
1126
1202
  # @return [Integer]
1127
1203
  def get_raw_key_flags; end
1128
1204
  alias_method :raw_key_flags, :get_raw_key_flags
1129
1205
 
1130
1206
  # Returns the Unicode character corresponding to this key event.
1207
+ #
1131
1208
  # 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
1209
  # This function is only available in Unicode build, i.e. when {Wx::Setup::USE_UNICODE} is 1.
1133
1210
  # @return [String]
@@ -1136,6 +1213,7 @@ module Wx
1136
1213
 
1137
1214
  # Returns the X position (in client coordinates) of the event.
1138
1215
  #
1216
+ #
1139
1217
  # @see Wx::KeyEvent#get_position
1140
1218
  # @return [Integer]
1141
1219
  def get_x; end
@@ -1143,24 +1221,28 @@ module Wx
1143
1221
 
1144
1222
  # Returns the Y position (in client coordinates) of the event.
1145
1223
  #
1224
+ #
1146
1225
  # @see Wx::KeyEvent#get_position
1147
1226
  # @return [Integer]
1148
1227
  def get_y; end
1149
1228
  alias_method :y, :get_y
1150
1229
 
1151
1230
  # Allow normal key events generation.
1231
+ #
1152
1232
  # Can be called from {Wx::EVT_CHAR_HOOK} handler to indicate that the generation of normal events should not be suppressed, as it happens by default when this event is handled.
1153
1233
  # The intended use of this method is to allow some window object to prevent {Wx::EVT_CHAR_HOOK} handler in its parent window from running by defining its own handler for this event. Without calling this method, this would result in not generating {Wx::EVT_KEY_DOWN} nor {Wx::EVT_CHAR} events at all but by calling it you can ensure that these events would still be generated, even if {Wx::EVT_CHAR_HOOK} event was handled.
1154
1234
  # @return [void]
1155
1235
  def do_allow_next_event; end
1156
1236
 
1157
1237
  # Returns true if {Wx::KeyEvent#do_allow_next_event} had been called, false by default.
1238
+ #
1158
1239
  # This method is used by wxWidgets itself to determine whether the normal key events should be generated after {Wx::EVT_CHAR_HOOK} processing.
1159
1240
  # @return [Boolean]
1160
1241
  def is_next_event_allowed; end
1161
1242
  alias_method :next_event_allowed?, :is_next_event_allowed
1162
1243
 
1163
1244
  # Return the bit mask of all pressed modifier keys.
1245
+ #
1164
1246
  # The return value is a combination of {Wx::KeyModifier::MOD_ALT}, {Wx::KeyModifier::MOD_CONTROL}, {Wx::KeyModifier::MOD_SHIFT} and {Wx::KeyModifier::MOD_META} bit masks. Additionally, {Wx::KeyModifier::MOD_NONE} is defined as 0, i.e. corresponds to no modifiers (see {Wx::KeyEvent#has_any_modifiers}) and {Wx::KeyModifier::MOD_CMD} is either {Wx::KeyModifier::MOD_CONTROL} (MSW and Unix) or {Wx::KeyModifier::MOD_META} (Mac), see {Wx::KeyEvent#cmd_down}. See {Wx::KeyModifier} for the full list of modifiers.
1165
1247
  # Notice that this function is easier to use correctly than, for example, {Wx::KeyEvent#control_down} because when using the latter you also have to remember to test that none of the other modifiers is pressed:
1166
1248
  #
@@ -1182,6 +1264,7 @@ module Wx
1182
1264
  alias_method :modifiers, :get_modifiers
1183
1265
 
1184
1266
  # Returns true if any modifiers at all are pressed.
1267
+ #
1185
1268
  # This is equivalent to <code>Wx::KeyEvent#get_modifiers</code> <code>!=</code> {Wx::KeyModifier::MOD_NONE}.
1186
1269
  # Notice that this is different from {Wx::KeyEvent#has_modifiers} method which doesn't take e.g. Shift modifier into account. This method is most suitable for mouse events when any modifier, including Shift, can change the interpretation of the event.
1187
1270
  # @return [Boolean]
@@ -1189,6 +1272,7 @@ module Wx
1189
1272
  alias_method :has_any_modifiers?, :has_any_modifiers
1190
1273
 
1191
1274
  # Returns true if Control or Alt are pressed.
1275
+ #
1192
1276
  # Checks if Control, Alt or, under macOS only, Command key are pressed (notice that the real Control key is still taken into account under OS X too).
1193
1277
  # This method returns false if only Shift is pressed for compatibility reasons and also because pressing Shift usually doesn't change the interpretation of key events, see {Wx::KeyEvent#has_any_modifiers} if you want to take Shift into account as well.
1194
1278
  # @return [Boolean]
@@ -1196,35 +1280,41 @@ module Wx
1196
1280
  alias_method :has_modifiers?, :has_modifiers
1197
1281
 
1198
1282
  # Returns true if the Control key or Apple/Command key under macOS is pressed.
1283
+ #
1199
1284
  # This function doesn't distinguish between right and left control keys.
1200
1285
  # Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
1201
1286
  # @return [Boolean]
1202
1287
  def control_down; end
1203
1288
 
1204
1289
  # Returns true if the Control key (also under macOS).
1290
+ #
1205
1291
  # This function doesn't distinguish between right and left control keys.
1206
1292
  # Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
1207
1293
  # @return [Boolean]
1208
1294
  def raw_control_down; end
1209
1295
 
1210
1296
  # Returns true if the Shift key is pressed.
1297
+ #
1211
1298
  # This function doesn't distinguish between right and left shift keys.
1212
1299
  # Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
1213
1300
  # @return [Boolean]
1214
1301
  def shift_down; end
1215
1302
 
1216
1303
  # Returns true if the Meta/Windows/Apple key is pressed.
1304
+ #
1217
1305
  # This function tests the state of the key traditionally called Meta under Unix systems, Windows keys under MSW Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
1218
1306
  # @see Wx::KeyEvent#cmd_down
1219
1307
  # @return [Boolean]
1220
1308
  def meta_down; end
1221
1309
 
1222
1310
  # Returns true if the Alt key is pressed.
1311
+ #
1223
1312
  # Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
1224
1313
  # @return [Boolean]
1225
1314
  def alt_down; end
1226
1315
 
1227
1316
  # Returns true if the key used for command accelerators is pressed.
1317
+ #
1228
1318
  # Same as {Wx::KeyEvent#control_down}. Deprecated.
1229
1319
  # Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
1230
1320
  # @return [Boolean]
@@ -1258,20 +1348,19 @@ module Wx
1258
1348
  end # KeyEvent
1259
1349
 
1260
1350
  # A size event holds information about size change events of {Wx::Window}.
1351
+ #
1261
1352
  # The EVT_SIZE handler function will be called when the window has been resized.
1262
1353
  # You may wish to use this for frames to resize their child windows as appropriate.
1263
1354
  # 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
1355
  # 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
1356
  # <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
1357
+ # ### Events using this class
1267
1358
  #
1268
1359
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SizeEvent} events.
1269
1360
  # Event handler methods:
1270
1361
  #
1271
1362
  # - {Wx::EvtHandler#evt_size}(meth = nil, &block): Process a {Wx::EVT_SIZE} event.
1272
1363
  #
1273
- # ===
1274
- #
1275
1364
  # Category: {Wx::Events}
1276
1365
  # @see Wx::Size
1277
1366
  # @see Events and Event Handling
@@ -1286,6 +1375,7 @@ module Wx
1286
1375
  def initialize(sz, id=0) end
1287
1376
 
1288
1377
  # Returns the entire size of the window generating the size change event.
1378
+ #
1289
1379
  # This is the new total size of the window, i.e. the same size as would be returned by {Wx::Window#get_size} if it were called now. Use {Wx::Window#get_client_size} if you catch this event in a top level window such as {Wx::Frame} to find the size available for the window contents.
1290
1380
  # @return [Wx::Size]
1291
1381
  def get_size; end
@@ -1308,21 +1398,20 @@ module Wx
1308
1398
  end # SizeEvent
1309
1399
 
1310
1400
  # 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
1401
+ #
1402
+ # 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.
1403
+ # ### Events using this class
1313
1404
  #
1314
1405
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MoveEvent} events.
1315
1406
  # Event handler methods:
1316
1407
  #
1317
1408
  # - {Wx::EvtHandler#evt_move}(meth = nil, &block): Process a {Wx::EVT_MOVE} event, which is generated when a window is moved.
1318
1409
  #
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.
1410
+ # - {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
1411
  #
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.
1412
+ # - {Wx::EvtHandler#evt_moving}(meth = nil, &block): Process a {Wx::EVT_MOVING} event, which is generated while the user is moving the window. WXMSW only.
1322
1413
  #
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.
1324
- #
1325
- # ===
1414
+ # - {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
1415
  #
1327
1416
  # Category: {Wx::Events}
1328
1417
  # @see Wx::Point
@@ -1359,6 +1448,7 @@ module Wx
1359
1448
  end # MoveEvent
1360
1449
 
1361
1450
  # A paint event is sent when a window's contents needs to be repainted.
1451
+ #
1362
1452
  # The handler of this event must create a {Wx::PaintDC} object and use it for painting the window contents. For example:
1363
1453
  # ```ruby
1364
1454
  # def on_paint(event)
@@ -1389,17 +1479,19 @@ module Wx
1389
1479
  # end
1390
1480
  # ```
1391
1481
  #
1392
- # 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.
1482
+ # <div class="wxrb-remark">
1483
+ # <b>Remark:</b>
1484
+ # <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.
1485
+ # </p>
1486
+ # </div>
1393
1487
  #
1394
- # === Events using this class
1488
+ # ### Events using this class
1395
1489
  #
1396
1490
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::PaintEvent} events.
1397
1491
  # Event handler methods:
1398
1492
  #
1399
1493
  # - {Wx::EvtHandler#evt_paint}(meth = nil, &block): Process a {Wx::EVT_PAINT} event.
1400
1494
  #
1401
- # ===
1402
- #
1403
1495
  # Category: {Wx::Events}
1404
1496
  # @see Events and Event Handling
1405
1497
  #
@@ -1407,6 +1499,7 @@ module Wx
1407
1499
  class PaintEvent < Event
1408
1500
 
1409
1501
  # Constructor for exclusive use of wxWidgets itself.
1502
+ #
1410
1503
  # Note that the objects of this class can not be created from application code, they're only created by the library itself. If you need a window to be repainted, use {Wx::Window#refresh} instead of trying to manually create an event of this class.
1411
1504
  # @param window [Wx::Window]
1412
1505
  # @return [Wx::PaintEvent]
@@ -1415,18 +1508,17 @@ module Wx
1415
1508
  end # PaintEvent
1416
1509
 
1417
1510
  # An erase event is sent when a window's background needs to be repainted.
1511
+ #
1418
1512
  # 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.
1419
1513
  # To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table definition.
1420
1514
  # 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.
1421
- # === Events using this class
1515
+ # ### Events using this class
1422
1516
  #
1423
1517
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::EraseEvent} events.
1424
1518
  # Event handler methods:
1425
1519
  #
1426
1520
  # - {Wx::EvtHandler#evt_erase_background}(meth = nil, &block): Process a {Wx::EVT_ERASE_BACKGROUND} event.
1427
1521
  #
1428
- # ===
1429
- #
1430
1522
  # Category: {Wx::Events}
1431
1523
  # @see Events and Event Handling
1432
1524
  #
@@ -1440,6 +1532,7 @@ module Wx
1440
1532
  def initialize(id=0, dc=nil) end
1441
1533
 
1442
1534
  # Returns the device context associated with the erase event to draw on.
1535
+ #
1443
1536
  # The returned pointer is never NULL.
1444
1537
  # @return [Wx::DC]
1445
1538
  def get_dc; end
@@ -1448,10 +1541,11 @@ module Wx
1448
1541
  end # EraseEvent
1449
1542
 
1450
1543
  # A focus event is sent when a window's focus changes.
1544
+ #
1451
1545
  # The window losing focus receives a "kill focus" event while the window gaining it gets a "set focus" one.
1452
1546
  # 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}.
1453
1547
  # 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.
1454
- # === Events using this class
1548
+ # ### Events using this class
1455
1549
  #
1456
1550
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FocusEvent} events.
1457
1551
  # Event handler methods:
@@ -1460,8 +1554,6 @@ module Wx
1460
1554
  #
1461
1555
  # - {Wx::EvtHandler#evt_kill_focus}(meth = nil, &block): Process a {Wx::EVT_KILL_FOCUS} event.
1462
1556
  #
1463
- # ===
1464
- #
1465
1557
  # Category: {Wx::Events}
1466
1558
  # @see Events and Event Handling
1467
1559
  #
@@ -1469,12 +1561,13 @@ module Wx
1469
1561
  class FocusEvent < Event
1470
1562
 
1471
1563
  # Constructor.
1472
- # @param eventType [Wx::CommandLinkButton::EventType]
1564
+ # @param eventType [Wx::StaticLine::EventType]
1473
1565
  # @param id [Integer]
1474
1566
  # @return [Wx::FocusEvent]
1475
1567
  def initialize(eventType=Wx::EVT_NULL, id=0) end
1476
1568
 
1477
1569
  # Returns the window associated with this event, that is the window which had the focus before for the {Wx::EVT_SET_FOCUS} event and the window which is going to receive focus for the {Wx::EVT_KILL_FOCUS} one.
1570
+ #
1478
1571
  # Warning: the window pointer may be NULL!
1479
1572
  # @return [Wx::Window]
1480
1573
  def get_window; end
@@ -1488,7 +1581,8 @@ module Wx
1488
1581
  end # FocusEvent
1489
1582
 
1490
1583
  # An activate event is sent when a window or application is being activated or deactivated.
1491
- # === Events using this class
1584
+ #
1585
+ # ### Events using this class
1492
1586
  #
1493
1587
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ActivateEvent} events.
1494
1588
  # Event handler methods:
@@ -1499,9 +1593,11 @@ module Wx
1499
1593
  #
1500
1594
  # - {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.
1501
1595
  #
1502
- # 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.
1503
- #
1504
- # ===
1596
+ # <div class="wxrb-note">
1597
+ # <b>Note:</b>
1598
+ # <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.
1599
+ # </p>
1600
+ # </div>
1505
1601
  #
1506
1602
  # Category: {Wx::Events}
1507
1603
  # @see Events and Event Handling
@@ -1527,10 +1623,10 @@ module Wx
1527
1623
  end # Reason
1528
1624
 
1529
1625
  # Constructor.
1530
- # @param eventType [Wx::CommandLinkButton::EventType]
1626
+ # @param eventType [Wx::StaticLine::EventType]
1531
1627
  # @param active [Boolean]
1532
1628
  # @param id [Integer]
1533
- # @param activationReason [Wx::wxActivateEvent::Reason]
1629
+ # @param activationReason [Wx::ActivateEvent::Reason]
1534
1630
  # @return [Wx::ActivateEvent]
1535
1631
  def initialize(eventType=Wx::EVT_NULL, active=true, id=0, activationReason=Wx::ActivateEvent::Reason::Reason_Unknown) end
1536
1632
 
@@ -1540,26 +1636,26 @@ module Wx
1540
1636
  alias_method :active, :get_active
1541
1637
 
1542
1638
  # Allows checking if the window was activated by clicking it with the mouse or in some other way.
1543
- # 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).
1639
+ #
1640
+ # 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).
1544
1641
  # Under all the other platforms, Reason_Unknown is always returned.
1545
- # @return [Wx::wxActivateEvent::Reason]
1642
+ # @return [Wx::ActivateEvent::Reason]
1546
1643
  def get_activation_reason; end
1547
1644
  alias_method :activation_reason, :get_activation_reason
1548
1645
 
1549
1646
  end # ActivateEvent
1550
1647
 
1551
1648
  # A {Wx::InitDialogEvent} is sent as a dialog or panel is being initialised.
1649
+ #
1552
1650
  # Handlers for this event can transfer data to the window.
1553
1651
  # The default handler calls {Wx::Window#transfer_data_to_window}.
1554
- # === Events using this class
1652
+ # ### Events using this class
1555
1653
  #
1556
1654
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::InitDialogEvent} events.
1557
1655
  # Event handler methods:
1558
1656
  #
1559
1657
  # - {Wx::EvtHandler#evt_init_dialog}(meth = nil, &block): Process a {Wx::EVT_INIT_DIALOG} event.
1560
1658
  #
1561
- # ===
1562
- #
1563
1659
  # Category: {Wx::Events}
1564
1660
  # @see Events and Event Handling
1565
1661
  #
@@ -1574,6 +1670,7 @@ module Wx
1574
1670
  end # InitDialogEvent
1575
1671
 
1576
1672
  # This class is used for a variety of menu-related events.
1673
+ #
1577
1674
  # Note that these do not include menu command events, which are handled using {Wx::CommandEvent} objects.
1578
1675
  # Events of this class are generated by both menus that are part of a {Wx::MenuBar}, attached to {Wx::Frame}, and popup menus shown by {Wx::Window#popup_menu}. They are sent to the following objects until one of them handles the event:
1579
1676
  #
@@ -1584,7 +1681,7 @@ module Wx
1584
1681
  #
1585
1682
  # 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.
1586
1683
  # 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}.
1587
- # === Events using this class
1684
+ # ### Events using this class
1588
1685
  #
1589
1686
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MenuEvent} events.
1590
1687
  # Event handler methods:
@@ -1597,8 +1694,6 @@ module Wx
1597
1694
  #
1598
1695
  # - {Wx::EvtHandler#evt_menu_highlight_all}(meth = nil, &block): A menu item has been highlighted, i.e. the currently selected menu item has changed.
1599
1696
  #
1600
- # ===
1601
- #
1602
1697
  # Category: {Wx::Events}
1603
1698
  # @see Wx::CommandEvent
1604
1699
  # @see Events and Event Handling
@@ -1607,26 +1702,34 @@ module Wx
1607
1702
  class MenuEvent < Event
1608
1703
 
1609
1704
  # Constructor.
1610
- # @param type [Wx::CommandLinkButton::EventType]
1705
+ # @param type [Wx::StaticLine::EventType]
1611
1706
  # @param id [Integer]
1612
1707
  # @param menu [Wx::Menu]
1613
1708
  # @return [Wx::MenuEvent]
1614
1709
  def initialize(type=Wx::EVT_NULL, id=0, menu=nil) end
1615
1710
 
1616
1711
  # Returns the menu which is being opened or closed, or the menu containing the highlighted item.
1617
- # 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.
1618
- # 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.
1712
+ #
1713
+ # 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.
1714
+ #
1715
+ # <div class="wxrb-remark">
1716
+ # <b>Remark:</b>
1717
+ # <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.
1718
+ # </p>
1719
+ # </div>
1619
1720
  # @return [Wx::Menu]
1620
1721
  def get_menu; end
1621
1722
  alias_method :menu, :get_menu
1622
1723
 
1623
1724
  # Returns the menu identifier associated with the event.
1725
+ #
1624
1726
  # This method should be only used with the HIGHLIGHT events.
1625
1727
  # @return [Integer]
1626
1728
  def get_menu_id; end
1627
1729
  alias_method :menu_id, :get_menu_id
1628
1730
 
1629
1731
  # Returns true if the menu which is being opened or closed is a popup menu, false if it is a normal one.
1732
+ #
1630
1733
  # This method should only be used with the OPEN and CLOSE events.
1631
1734
  # @return [Boolean]
1632
1735
  def is_popup; end
@@ -1635,6 +1738,7 @@ module Wx
1635
1738
  end # MenuEvent
1636
1739
 
1637
1740
  # This event class contains information about window and session close events.
1741
+ #
1638
1742
  # The handler function for EVT_CLOSE is called when the user has tried to close a a frame or dialog box using the window manager (X) or system menu (Windows). It can also be invoked by the application itself programmatically, for example by calling the {Wx::Window#close} function.
1639
1743
  # You should check whether the application is forcing the deletion of the window using {Wx::CloseEvent#can_veto}. If this is false, you must destroy the window using {Wx::Window#destroy}.
1640
1744
  # If the return value is true, it is up to you whether you respond by destroying the window.
@@ -1659,7 +1763,7 @@ module Wx
1659
1763
  #
1660
1764
  # See also <code>samples/dialogs</code> for a full example of interrupting closing an application when there are e.g. unsaved files.
1661
1765
  # 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).
1662
- # === Events using this class
1766
+ # ### Events using this class
1663
1767
  #
1664
1768
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CloseEvent} events.
1665
1769
  # Event handler methods:
@@ -1670,8 +1774,6 @@ module Wx
1670
1774
  #
1671
1775
  # - {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.
1672
1776
  #
1673
- # ===
1674
- #
1675
1777
  # Category: {Wx::Events}
1676
1778
  # @see Wx::Window#close
1677
1779
  # @see Window Deletion
@@ -1680,18 +1782,20 @@ module Wx
1680
1782
  class CloseEvent < Event
1681
1783
 
1682
1784
  # Constructor.
1683
- # @param commandEventType [Wx::CommandLinkButton::EventType]
1785
+ # @param commandEventType [Wx::StaticLine::EventType]
1684
1786
  # @param id [Integer]
1685
1787
  # @return [Wx::CloseEvent]
1686
1788
  def initialize(commandEventType=Wx::EVT_NULL, id=0) end
1687
1789
 
1688
1790
  # Returns true if you can veto a system shutdown or a window close event.
1791
+ #
1689
1792
  # Vetoing a window close event is not possible if the calling code wishes to force the application to exit, and so this function must be called to check this.
1690
1793
  # @return [Boolean]
1691
1794
  def can_veto; end
1692
1795
  alias_method :can_veto?, :can_veto
1693
1796
 
1694
1797
  # Returns true if the user is just logging off or false if the system is shutting down.
1798
+ #
1695
1799
  # This method can only be called for end session and query end session events, it doesn't make sense for close window event.
1696
1800
  # @return [Boolean]
1697
1801
  def get_logging_off; end
@@ -1710,6 +1814,7 @@ module Wx
1710
1814
  alias_method :logging_off=, :set_logging_off
1711
1815
 
1712
1816
  # Call this from your event handler to veto a system shutdown or to signal to the calling application that a window close did not happen.
1817
+ #
1713
1818
  # You can only veto a shutdown if {Wx::CloseEvent#can_veto} returns true.
1714
1819
  # @param veto [Boolean]
1715
1820
  # @return [void]
@@ -1722,16 +1827,15 @@ module Wx
1722
1827
  end # CloseEvent
1723
1828
 
1724
1829
  # An event being sent when the window is shown or hidden.
1725
- # 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.
1726
- # === Events using this class
1830
+ #
1831
+ # 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.
1832
+ # ### Events using this class
1727
1833
  #
1728
1834
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ShowEvent} events.
1729
1835
  # Event handler methods:
1730
1836
  #
1731
1837
  # - {Wx::EvtHandler#evt_show}(meth = nil, &block): Process a {Wx::EVT_SHOW} event.
1732
1838
  #
1733
- # ===
1734
- #
1735
1839
  # Category: {Wx::Events}
1736
1840
  # @see Events and Event Handling
1737
1841
  # @see Wx::Window#show
@@ -1760,15 +1864,14 @@ module Wx
1760
1864
  end # ShowEvent
1761
1865
 
1762
1866
  # An event being sent when the frame is iconized (minimized) or restored.
1763
- # === Events using this class
1867
+ #
1868
+ # ### Events using this class
1764
1869
  #
1765
1870
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::IconizeEvent} events.
1766
1871
  # Event handler methods:
1767
1872
  #
1768
1873
  # - {Wx::EvtHandler#evt_iconize}(meth = nil, &block): Process a {Wx::EVT_ICONIZE} event.
1769
1874
  #
1770
- # ===
1771
- #
1772
1875
  # Category: {Wx::Events}
1773
1876
  # @see Events and Event Handling
1774
1877
  # @see Wx::TopLevelWindow#iconize
@@ -1791,17 +1894,16 @@ module Wx
1791
1894
  end # IconizeEvent
1792
1895
 
1793
1896
  # An event being sent when a top level window is maximized.
1897
+ #
1794
1898
  # 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.
1795
- # 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.
1796
- # === Events using this class
1899
+ # 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.
1900
+ # ### Events using this class
1797
1901
  #
1798
1902
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MaximizeEvent} events.
1799
1903
  # Event handler methods:
1800
1904
  #
1801
1905
  # - {Wx::EvtHandler#evt_maximize}(meth = nil, &block): Process a {Wx::EVT_MAXIMIZE} event.
1802
1906
  #
1803
- # ===
1804
- #
1805
1907
  # Category: {Wx::Events}
1806
1908
  # @see Events and Event Handling
1807
1909
  # @see Wx::TopLevelWindow#maximize
@@ -1811,6 +1913,7 @@ module Wx
1811
1913
  class MaximizeEvent < Event
1812
1914
 
1813
1915
  # Constructor.
1916
+ #
1814
1917
  # Only used by wxWidgets internally.
1815
1918
  # @param id [Integer]
1816
1919
  # @return [Wx::MaximizeEvent]
@@ -1819,16 +1922,15 @@ module Wx
1819
1922
  end # MaximizeEvent
1820
1923
 
1821
1924
  # An event being sent when the user enters or exits full screen mode.
1822
- # 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}.
1823
- # === Events using this class
1925
+ #
1926
+ # 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}.
1927
+ # ### Events using this class
1824
1928
  #
1825
1929
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FullScreenEvent} events.
1826
1930
  # Event handler methods:
1827
1931
  #
1828
1932
  # - {Wx::EvtHandler#evt_fullscreen}(meth = nil, &block): Process a {Wx::EVT_FULLSCREEN} event.
1829
1933
  #
1830
- # ===
1831
- #
1832
1934
  # Category: {Wx::Events}
1833
1935
  # @see Events and Event Handling
1834
1936
  # @see Wx::TopLevelWindow#enable_full_screen_view
@@ -1851,7 +1953,8 @@ module Wx
1851
1953
  end # FullScreenEvent
1852
1954
 
1853
1955
  # This event class contains information about joystick events, particularly events received by windows.
1854
- # === Events using this class
1956
+ #
1957
+ # ### Events using this class
1855
1958
  #
1856
1959
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::JoystickEvent} events.
1857
1960
  # Event handler methods:
@@ -1866,8 +1969,6 @@ module Wx
1866
1969
  #
1867
1970
  # - {Wx::EvtHandler#evt_joystick_events}(meth = nil, &block): Processes all joystick events.
1868
1971
  #
1869
- # ===
1870
- #
1871
1972
  # Category: {Wx::Events}
1872
1973
  # @see Wx::Joystick
1873
1974
  #
@@ -1875,7 +1976,7 @@ module Wx
1875
1976
  class JoystickEvent < Event
1876
1977
 
1877
1978
  # Constructor.
1878
- # @param eventType [Wx::CommandLinkButton::EventType]
1979
+ # @param eventType [Wx::StaticLine::EventType]
1879
1980
  # @param state [Integer]
1880
1981
  # @param joystick [Integer]
1881
1982
  # @param change [Integer]
@@ -1898,6 +1999,7 @@ module Wx
1898
1999
  def button_up(button=Wx::JOY_BUTTON_ANY) end
1899
2000
 
1900
2001
  # Returns the identifier of the button changing state.
2002
+ #
1901
2003
  # The return value is
1902
2004
  # ```
1903
2005
  # 1 << n
@@ -1910,12 +2012,14 @@ module Wx
1910
2012
 
1911
2013
  # Returns the 0-indexed ordinal of the button changing state.
1912
2014
  #
2015
+ #
1913
2016
  # @see Wx::JoystickEvent#get_button_change
1914
2017
  # @return [Integer]
1915
2018
  def get_button_ordinal; end
1916
2019
  alias_method :button_ordinal, :get_button_ordinal
1917
2020
 
1918
2021
  # Returns the down state of the buttons.
2022
+ #
1919
2023
  # This is a {Wx::JOY_BUTTONn} identifier, where n is one of 1, 2, 3, 4.
1920
2024
  # @return [Integer]
1921
2025
  def get_button_state; end
@@ -1927,12 +2031,14 @@ module Wx
1927
2031
  alias_method :joystick, :get_joystick
1928
2032
 
1929
2033
  # Returns the x, y position of the joystick event.
2034
+ #
1930
2035
  # These coordinates are valid for all the events except {Wx::EVT_JOY_ZMOVE}.
1931
2036
  # @return [Wx::Point]
1932
2037
  def get_position; end
1933
2038
  alias_method :position, :get_position
1934
2039
 
1935
2040
  # Returns the z position of the joystick event.
2041
+ #
1936
2042
  # This method can only be used for {Wx::EVT_JOY_ZMOVE} events.
1937
2043
  # @return [Integer]
1938
2044
  def get_z_position; end
@@ -1956,18 +2062,21 @@ module Wx
1956
2062
  end # JoystickEvent
1957
2063
 
1958
2064
  # This class is used for drop files events, that is, when files have been dropped onto the window.
2065
+ #
1959
2066
  # The window must have previously been enabled for dropping by calling {Wx::Window#drag_accept_files}.
1960
2067
  # 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.
1961
- # === Events using this class
2068
+ # ### Events using this class
1962
2069
  #
1963
2070
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DropFilesEvent} events.
1964
2071
  # Event handler methods:
1965
2072
  #
1966
2073
  # - {Wx::EvtHandler#evt_drop_files}(meth = nil, &block): Process a {Wx::EVT_DROP_FILES} event.
1967
2074
  #
1968
- # Windows only until version 2.8.9, available on all platforms since 2.8.10.
1969
- #
1970
- # ===
2075
+ # <div class="wxrb-remark">
2076
+ # <b>Remark:</b>
2077
+ # <p>Windows only until version 2.8.9, available on all platforms since 2.8.10.
2078
+ # </p>
2079
+ # </div>
1971
2080
  #
1972
2081
  # Category: {Wx::Events}
1973
2082
  # @see Events and Event Handling
@@ -1977,7 +2086,7 @@ module Wx
1977
2086
  class DropFilesEvent < Event
1978
2087
 
1979
2088
  # Constructor.
1980
- # @param id [Wx::CommandLinkButton::EventType]
2089
+ # @param id [Wx::StaticLine::EventType]
1981
2090
  # @param noFiles [Integer]
1982
2091
  # @param files [String]
1983
2092
  # @return [Wx::DropFilesEvent]
@@ -1994,6 +2103,7 @@ module Wx
1994
2103
  alias_method :number_of_files, :get_number_of_files
1995
2104
 
1996
2105
  # Returns the position at which the files were dropped.
2106
+ #
1997
2107
  # Returns an array of filenames.
1998
2108
  # @return [Wx::Point]
1999
2109
  def get_position; end
@@ -2002,6 +2112,7 @@ module Wx
2002
2112
  end # DropFilesEvent
2003
2113
 
2004
2114
  # This class is used for pseudo-events which are called by wxWidgets to give an application the chance to update various user interface elements.
2115
+ #
2005
2116
  # Without update UI events, an application has to work hard to check/uncheck, enable/disable, show/hide, and set the text for elements such as menu items and toolbar buttons. The code for doing this has to be mixed up with the code that is invoked when an action is invoked for a menu item or button.
2006
2117
  # With update UI events, you define an event handler to look at the state of the application and change UI elements accordingly. wxWidgets will call your member functions in idle time, so you don't have to worry where to call this code.
2007
2118
  # In addition to being a clearer and more declarative method, it also means you don't have to worry whether you're updating a toolbar or menubar identifier. The same handler can update a menu item and toolbar button, if the identifier is the same. Instead of directly manipulating the menu or button, you call functions in the event object, such as {Wx::UpdateUIEvent#check}. wxWidgets will determine whether such a call has been made, and which UI element to update.
@@ -2014,7 +2125,7 @@ module Wx
2014
2125
  #
2015
2126
  # 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.
2016
2127
  # 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.
2017
- # === Events using this class
2128
+ # ### Events using this class
2018
2129
  #
2019
2130
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::UpdateUIEvent} events.
2020
2131
  # Event handler methods:
@@ -2023,8 +2134,6 @@ module Wx
2023
2134
  #
2024
2135
  # - {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.
2025
2136
  #
2026
- # ===
2027
- #
2028
2137
  # Category: {Wx::Events}
2029
2138
  # @see Events and Event Handling
2030
2139
  #
@@ -2057,6 +2166,7 @@ module Wx
2057
2166
  alias_method :enabled, :get_enabled
2058
2167
 
2059
2168
  # Returns true if the UI element can be checked.
2169
+ #
2060
2170
  # For the event handlers that can be used for multiple items, not all of which can be checked, this method can be useful to determine whether to call {Wx::UpdateUIEvent#check} on the event object or not, i.e. the main use case for this method is:
2061
2171
  # ```ruby
2062
2172
  # def on_update_ui(event)
@@ -2070,24 +2180,28 @@ module Wx
2070
2180
  alias_method :checkable?, :is_checkable
2071
2181
 
2072
2182
  # Returns true if the application has called {Wx::UpdateUIEvent#check}.
2183
+ #
2073
2184
  # For wxWidgets internal use only.
2074
2185
  # @return [Boolean]
2075
2186
  def get_set_checked; end
2076
2187
  alias_method :set_checked, :get_set_checked
2077
2188
 
2078
2189
  # Returns true if the application has called {Wx::UpdateUIEvent#enable}.
2190
+ #
2079
2191
  # For wxWidgets internal use only.
2080
2192
  # @return [Boolean]
2081
2193
  def get_set_enabled; end
2082
2194
  alias_method :set_enabled, :get_set_enabled
2083
2195
 
2084
2196
  # Returns true if the application has called {Wx::UpdateUIEvent#show}.
2197
+ #
2085
2198
  # For wxWidgets internal use only.
2086
2199
  # @return [Boolean]
2087
2200
  def get_set_shown; end
2088
2201
  alias_method :set_shown, :get_set_shown
2089
2202
 
2090
2203
  # Returns true if the application has called {Wx::UpdateUIEvent#set_text}.
2204
+ #
2091
2205
  # For wxWidgets internal use only.
2092
2206
  # @return [Boolean]
2093
2207
  def get_set_text; end
@@ -2114,6 +2228,7 @@ module Wx
2114
2228
  def show(show) end
2115
2229
 
2116
2230
  # Returns true if it is appropriate to update (send UI update events to) this window.
2231
+ #
2117
2232
  # This function looks at the mode used (see {Wx::UpdateUIEvent.set_mode}), the {Wx::WS_EX_PROCESS_UI_UPDATES} flag in window, the time update events were last sent in idle time, and the update interval, to determine whether events should be sent to this window now. By default this will always return true because the update mode is initially {Wx::UpdateUIMode::UPDATE_UI_PROCESS_ALL} and the interval is set to 0; so update events will be sent as often as possible. You can reduce the frequency that events are sent by changing the mode and/or setting an update interval.
2118
2233
  # @see Wx::UpdateUIEvent.reset_update_time
2119
2234
  # @see Wx::UpdateUIEvent.set_update_interval
@@ -2124,17 +2239,20 @@ module Wx
2124
2239
 
2125
2240
  # Static function returning a value specifying how wxWidgets will send update events: to all windows, or only to those which specify that they will process the events.
2126
2241
  #
2242
+ #
2127
2243
  # @see Wx::UpdateUIEvent.set_mode
2128
2244
  # @return [Wx::UpdateUIMode]
2129
2245
  def self.get_mode; end
2130
2246
 
2131
2247
  # Returns the current interval between updates in milliseconds.
2248
+ #
2132
2249
  # The value -1 disables updates, 0 updates as frequently as possible.
2133
2250
  # @see Wx::UpdateUIEvent.set_update_interval.
2134
2251
  # @return [Integer]
2135
2252
  def self.get_update_interval; end
2136
2253
 
2137
2254
  # Used internally to reset the last-updated time to the current time.
2255
+ #
2138
2256
  # It is assumed that update events are normally sent in idle time, so this is called at the end of idle processing.
2139
2257
  # @see Wx::UpdateUIEvent.can_update
2140
2258
  # @see Wx::UpdateUIEvent.set_update_interval
@@ -2148,6 +2266,7 @@ module Wx
2148
2266
  def self.set_mode(mode) end
2149
2267
 
2150
2268
  # Sets the interval between updates in milliseconds.
2269
+ #
2151
2270
  # Set to -1 to disable updates, or to 0 to update as frequently as possible. The default is 0.
2152
2271
  # Use this to reduce the overhead of UI update events if your application has a lot of windows. If you set the value to -1 or greater than 0, you may also need to call {Wx::Window#update_window_ui} at appropriate points in your application, such as when a dialog is about to be shown.
2153
2272
  # @param updateInterval [Integer]
@@ -2157,18 +2276,22 @@ module Wx
2157
2276
  end # UpdateUIEvent
2158
2277
 
2159
2278
  # 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).
2279
+ #
2160
2280
  # Event handlers for this event can access the new system colour settings through {Wx::SystemSettings.get_colour}.
2161
- # 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.
2162
2281
  #
2163
- # === Events using this class
2282
+ # <div class="wxrb-remark">
2283
+ # <b>Remark:</b>
2284
+ # <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.
2285
+ # </p>
2286
+ # </div>
2287
+ #
2288
+ # ### Events using this class
2164
2289
  #
2165
2290
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SysColourChangedEvent} events.
2166
2291
  # Event handler methods:
2167
2292
  #
2168
2293
  # - {Wx::EvtHandler#evt_sys_colour_changed}(meth = nil, &block): Process a {Wx::EVT_SYS_COLOUR_CHANGED} event.
2169
2294
  #
2170
- # ===
2171
- #
2172
2295
  # Category: {Wx::Events}
2173
2296
  # @see Events and Event Handling
2174
2297
  #
@@ -2182,17 +2305,16 @@ module Wx
2182
2305
  end # SysColourChangedEvent
2183
2306
 
2184
2307
  # A mouse capture changed event is sent to a window that loses its mouse capture.
2308
+ #
2185
2309
  # 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.
2186
- # Availability: only available for the wxMSW port. {Wx::msw}
2187
- # === Events using this class
2310
+ # Availability: only available for the WXMSW port.
2311
+ # ### Events using this class
2188
2312
  #
2189
2313
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MouseCaptureChangedEvent} events.
2190
2314
  # Event handler methods:
2191
2315
  #
2192
2316
  # - {Wx::EvtHandler#evt_mouse_capture_changed}(meth = nil, &block): Process a {Wx::EVT_MOUSE_CAPTURE_CHANGED} event.
2193
2317
  #
2194
- # ===
2195
- #
2196
2318
  # Category: {Wx::Events}
2197
2319
  # @see Wx::MouseCaptureLostEvent
2198
2320
  # @see Events and Event Handling
@@ -2217,17 +2339,17 @@ module Wx
2217
2339
  end # MouseCaptureChangedEvent
2218
2340
 
2219
2341
  # 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).
2342
+ #
2220
2343
  # 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.
2221
2344
  # This event is currently emitted under Windows only.
2222
- # === Events using this class
2345
+ # ### Events using this class
2223
2346
  #
2224
2347
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MouseCaptureLostEvent} events.
2225
2348
  # Event handler methods:
2226
2349
  #
2227
2350
  # - {Wx::EvtHandler#evt_mouse_capture_lost}(meth = nil, &block): Process a {Wx::EVT_MOUSE_CAPTURE_LOST} event.
2228
2351
  #
2229
- # Availability: only available for the wxMSW port. {Wx::msw}
2230
- # ===
2352
+ # Availability: only available for the WXMSW port.
2231
2353
  #
2232
2354
  # Category: {Wx::Events}
2233
2355
  # @see Wx::MouseCaptureChangedEvent
@@ -2247,16 +2369,16 @@ module Wx
2247
2369
  end # MouseCaptureLostEvent
2248
2370
 
2249
2371
  # A display changed event is sent to top-level windows when the display resolution has changed.
2372
+ #
2250
2373
  # This event is currently emitted under Windows only.
2251
- # === Events using this class
2374
+ # ### Events using this class
2252
2375
  #
2253
2376
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DisplayChangedEvent} events.
2254
2377
  # Event handler methods:
2255
2378
  #
2256
2379
  # - {Wx::EvtHandler#evt_display_changed}(meth = nil, &block): Process a {Wx::EVT_DISPLAY_CHANGED} event.
2257
2380
  #
2258
- # Availability: only available for the wxMSW port. {Wx::msw}
2259
- # ===
2381
+ # Availability: only available for the WXMSW port.
2260
2382
  #
2261
2383
  # Category: {Wx::Events}
2262
2384
  # @see Wx::Display
@@ -2270,18 +2392,17 @@ module Wx
2270
2392
  end # DisplayChangedEvent
2271
2393
 
2272
2394
  # 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.
2395
+ #
2273
2396
  # 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.
2274
2397
  # 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.
2275
- # 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).
2276
- # === Events using this class
2398
+ # 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).
2399
+ # ### Events using this class
2277
2400
  #
2278
2401
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DPIChangedEvent} events.
2279
2402
  # Event handler methods:
2280
2403
  #
2281
2404
  # - {Wx::EvtHandler#evt_dpi_changed}(meth = nil, &block): Process a {Wx::EVT_DPI_CHANGED} event.
2282
2405
  #
2283
- # ===
2284
- #
2285
2406
  # Category: {Wx::Events}
2286
2407
  # @see Events and Event Handling
2287
2408
  #
@@ -2299,6 +2420,7 @@ module Wx
2299
2420
  alias_method :new_dpi, :get_new_dpi
2300
2421
 
2301
2422
  # Rescale a value in pixels to match the new DPI.
2423
+ #
2302
2424
  # This is a convenience function to use in {Wx::EVT_DPI_CHANGED} event handlers, as they often need to update some sizes to the new DPI. It simply calls {mul_div_int32} with new and old DPI values, but is more readable and less error-prone.
2303
2425
  # For example, the returned value will be twice bigger than the original one when switching from normal (96) DPI to high (2x, 192) DPI.
2304
2426
  # @param sz [Wx::Size]
@@ -2306,12 +2428,14 @@ module Wx
2306
2428
  def scale(sz) end
2307
2429
 
2308
2430
  # Rescale horizontal component to match the new DPI.
2431
+ #
2309
2432
  # This is the same as {Wx::DPIChangedEvent#scale}, but for the horizontal component only.
2310
2433
  # @param x [Integer]
2311
2434
  # @return [Integer]
2312
2435
  def scale_x(x) end
2313
2436
 
2314
2437
  # Rescale vertical component to match the new DPI.
2438
+ #
2315
2439
  # This is the same as {Wx::DPIChangedEvent#scale}, but for the vertical component only.
2316
2440
  # @param y [Integer]
2317
2441
  # @return [Integer]
@@ -2322,6 +2446,7 @@ module Wx
2322
2446
  #
2323
2447
  #
2324
2448
  #
2449
+ #
2325
2450
  class PaletteChangedEvent < Event
2326
2451
 
2327
2452
  # @param winid [Integer]
@@ -2342,6 +2467,7 @@ module Wx
2342
2467
  #
2343
2468
  #
2344
2469
  #
2470
+ #
2345
2471
  class QueryNewPaletteEvent < Event
2346
2472
 
2347
2473
  # @param winid [Integer]
@@ -2360,16 +2486,15 @@ module Wx
2360
2486
  end # QueryNewPaletteEvent
2361
2487
 
2362
2488
  # This event class contains information about navigation events, generated by navigation keys such as tab and page down.
2489
+ #
2363
2490
  # 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}<>.
2364
- # === Events using this class
2491
+ # ### Events using this class
2365
2492
  #
2366
2493
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::NavigationKeyEvent} events.
2367
2494
  # Event handler methods:
2368
2495
  #
2369
2496
  # - {Wx::EvtHandler#evt_navigation_key}(meth = nil, &block): Process a navigation key event.
2370
2497
  #
2371
- # ===
2372
- #
2373
2498
  # Category: {Wx::Events}
2374
2499
  # @see Wx::Window#navigate
2375
2500
  # @see Wx::Window#navigate_in
@@ -2419,6 +2544,7 @@ module Wx
2419
2544
  alias_method :direction, :get_direction
2420
2545
 
2421
2546
  # Returns true if the navigation event was from a tab key.
2547
+ #
2422
2548
  # This is required for proper navigation over radio buttons.
2423
2549
  # @return [Boolean]
2424
2550
  def is_from_tab; end
@@ -2442,6 +2568,7 @@ module Wx
2442
2568
  alias_method :direction=, :set_direction
2443
2569
 
2444
2570
  # Sets the flags for this event.
2571
+ #
2445
2572
  # The flags can be a combination of the {Wx::NavigationKeyEvent::NavigationKeyEventFlags} values.
2446
2573
  # @param flags [Integer]
2447
2574
  # @return [void]
@@ -2463,16 +2590,15 @@ module Wx
2463
2590
  end # NavigationKeyEvent
2464
2591
 
2465
2592
  # This event is sent just after the actual window associated with a {Wx::Window} object has been created.
2593
+ #
2466
2594
  # Since it is derived from {Wx::CommandEvent}, the event propagates up the window hierarchy.
2467
- # === Events using this class
2595
+ # ### Events using this class
2468
2596
  #
2469
2597
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::WindowCreateEvent} events.
2470
2598
  # Event handler methods:
2471
2599
  #
2472
2600
  # - {Wx::EvtHandler#evt_window_create}(meth = nil, &block): Process a {Wx::EVT_CREATE} event.
2473
2601
  #
2474
- # ===
2475
- #
2476
2602
  # Category: {Wx::Events}
2477
2603
  # @see Events and Event Handling
2478
2604
  # @see Wx::WindowDestroyEvent
@@ -2493,10 +2619,10 @@ module Wx
2493
2619
  end # WindowCreateEvent
2494
2620
 
2495
2621
  # This event is sent as early as possible during the window destruction process.
2622
+ #
2496
2623
  # 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.
2497
2624
  # 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).
2498
2625
  # 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.
2499
- # ===
2500
2626
  #
2501
2627
  # Category: {Wx::Events}
2502
2628
  # @see Events and Event Handling
@@ -2518,11 +2644,12 @@ module Wx
2518
2644
  end # WindowDestroyEvent
2519
2645
 
2520
2646
  # A help event is sent when the user has requested context-sensitive help.
2647
+ #
2521
2648
  # This can either be caused by the application requesting context-sensitive help mode via {Wx::ContextHelp}, or (on MS Windows) by the system generating a WM_HELP message when the user pressed F1 or clicked on the query button in a dialog caption.
2522
2649
  # 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.
2523
2650
  # 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.
2524
2651
  # 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.
2525
- # === Events using this class
2652
+ # ### Events using this class
2526
2653
  #
2527
2654
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HelpEvent} events.
2528
2655
  # Event handler methods:
@@ -2531,8 +2658,6 @@ module Wx
2531
2658
  #
2532
2659
  # - {Wx::EvtHandler#evt_help_range}(id1, id2, meth = nil, &block): Process a {Wx::EVT_HELP} event for a range of ids.
2533
2660
  #
2534
- # ===
2535
- #
2536
2661
  # Category: {Wx::Events}
2537
2662
  # @see Wx::ContextHelp
2538
2663
  # @see Wx::Dialog
@@ -2562,21 +2687,23 @@ module Wx
2562
2687
  end # Origin
2563
2688
 
2564
2689
  # Constructor.
2565
- # @param type [Wx::CommandLinkButton::EventType]
2690
+ # @param type [Wx::StaticLine::EventType]
2566
2691
  # @param winid [Integer]
2567
2692
  # @param pt [Array(Integer, Integer), Wx::Point]
2568
- # @param origin [Wx::wxHelpEvent::Origin]
2693
+ # @param origin [Wx::HelpEvent::Origin]
2569
2694
  # @return [Wx::HelpEvent]
2570
2695
  def initialize(type=Wx::EVT_NULL, winid=0, pt=Wx::DEFAULT_POSITION, origin=Wx::HelpEvent::Origin::Origin_Unknown) end
2571
2696
 
2572
2697
  # Returns the origin of the help event which is one of the {Wx::HelpEvent::Origin} values.
2698
+ #
2573
2699
  # The application may handle events generated using the keyboard or mouse differently, e.g. by using {get_mouse_position} for the mouse events.
2574
2700
  # @see Wx::HelpEvent#set_origin
2575
- # @return [Wx::wxHelpEvent::Origin]
2701
+ # @return [Wx::HelpEvent::Origin]
2576
2702
  def get_origin; end
2577
2703
  alias_method :origin, :get_origin
2578
2704
 
2579
2705
  # Returns the left-click position of the mouse, in screen coordinates.
2706
+ #
2580
2707
  # This allows the application to position the help appropriately.
2581
2708
  # @return [Wx::Point]
2582
2709
  def get_position; end
@@ -2584,8 +2711,9 @@ module Wx
2584
2711
 
2585
2712
  # Set the help event origin, only used internally by wxWidgets normally.
2586
2713
  #
2714
+ #
2587
2715
  # @see Wx::HelpEvent#get_origin
2588
- # @param origin [Wx::wxHelpEvent::Origin]
2716
+ # @param origin [Wx::HelpEvent::Origin]
2589
2717
  # @return [void]
2590
2718
  def set_origin(origin) end
2591
2719
  alias_method :origin=, :set_origin
@@ -2599,12 +2727,18 @@ module Wx
2599
2727
  end # HelpEvent
2600
2728
 
2601
2729
  # This class represents the events generated by a control (typically a {Wx::TextCtrl} but other windows can generate these events as well) when its content gets copied or cut to, or pasted from the clipboard.
2730
+ #
2602
2731
  # There are three types of corresponding events {Wx::EVT_TEXT_COPY}, {Wx::EVT_TEXT_CUT} and {Wx::EVT_TEXT_PASTE}.
2603
2732
  # 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.
2604
2733
  # 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.
2605
- # 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.
2606
2734
  #
2607
- # === Events using this class
2735
+ # <div class="wxrb-note">
2736
+ # <b>Note:</b>
2737
+ # <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.
2738
+ # </p>
2739
+ # </div>
2740
+ #
2741
+ # ### Events using this class
2608
2742
  #
2609
2743
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ClipboardTextEvent} events.
2610
2744
  # Event handler methods:
@@ -2615,8 +2749,6 @@ module Wx
2615
2749
  #
2616
2750
  # - {Wx::EvtHandler#evt_text_paste}(id, meth = nil, &block): Clipboard content was pasted into the control.
2617
2751
  #
2618
- # ===
2619
- #
2620
2752
  # Category: {Wx::Events}
2621
2753
  # @see Wx::Clipboard
2622
2754
  #
@@ -2624,7 +2756,7 @@ module Wx
2624
2756
  class ClipboardTextEvent < CommandEvent
2625
2757
 
2626
2758
  # Constructor.
2627
- # @param commandType [Wx::CommandLinkButton::EventType]
2759
+ # @param commandType [Wx::StaticLine::EventType]
2628
2760
  # @param id [Integer]
2629
2761
  # @return [Wx::ClipboardTextEvent]
2630
2762
  def initialize(commandType=Wx::EVT_NULL, id=0) end
@@ -2632,17 +2764,16 @@ module Wx
2632
2764
  end # ClipboardTextEvent
2633
2765
 
2634
2766
  # 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}.
2767
+ #
2635
2768
  # 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}.
2636
2769
  # 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.
2637
- # === Events using this class
2770
+ # ### Events using this class
2638
2771
  #
2639
2772
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ContextMenuEvent} events.
2640
2773
  # Event handler methods:
2641
2774
  #
2642
2775
  # - {Wx::EvtHandler#evt_context_menu}(meth = nil, &block): A right click (or other context menu command depending on platform) has been detected.
2643
2776
  #
2644
- # ===
2645
- #
2646
2777
  # Category: {Wx::Events}
2647
2778
  # @see Wx::CommandEvent
2648
2779
  # @see Events and Event Handling
@@ -2651,13 +2782,14 @@ module Wx
2651
2782
  class ContextMenuEvent < CommandEvent
2652
2783
 
2653
2784
  # Constructor.
2654
- # @param type [Wx::CommandLinkButton::EventType]
2785
+ # @param type [Wx::StaticLine::EventType]
2655
2786
  # @param id [Integer]
2656
2787
  # @param pos [Array(Integer, Integer), Wx::Point]
2657
2788
  # @return [Wx::ContextMenuEvent]
2658
2789
  def initialize(type=Wx::EVT_NULL, id=0, pos=Wx::DEFAULT_POSITION) end
2659
2790
 
2660
2791
  # Returns the position in screen coordinates at which the menu should be shown.
2792
+ #
2661
2793
  # Use {Wx::Window#screen_to_client} to convert to client coordinates.
2662
2794
  # You can also omit a position from {Wx::Window#popup_menu} in order to use the current mouse pointer position.
2663
2795
  # If the event originated from a keyboard event, the value returned from this function will be {Wx::DEFAULT_POSITION}.
@@ -2674,16 +2806,15 @@ module Wx
2674
2806
  end # ContextMenuEvent
2675
2807
 
2676
2808
  # 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.
2809
+ #
2677
2810
  # 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.
2678
- # === Events using this class
2811
+ # ### Events using this class
2679
2812
  #
2680
2813
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ChildFocusEvent} events.
2681
2814
  # Event handler methods:
2682
2815
  #
2683
2816
  # - {Wx::EvtHandler#evt_child_focus}(meth = nil, &block): Process a {Wx::EVT_CHILD_FOCUS} event.
2684
2817
  #
2685
- # ===
2686
- #
2687
2818
  # Category: {Wx::Events}
2688
2819
  # @see Events and Event Handling
2689
2820
  #
@@ -2696,6 +2827,7 @@ module Wx
2696
2827
  def initialize(win=nil) end
2697
2828
 
2698
2829
  # Returns the direct child which receives the focus, or a (grand-)parent of the control receiving the focus.
2830
+ #
2699
2831
  # To get the actually focused control use {Wx::Window.find_focus}.
2700
2832
  # @return [Wx::Window]
2701
2833
  def get_window; end