wxruby3 0.9.2-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 (646) hide show
  1. checksums.yaml +4 -4
  2. data/INSTALL.md +35 -29
  3. data/README.md +24 -15
  4. data/ext/wxbase32u_gcc_custom.dll +0 -0
  5. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  6. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  7. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  19. data/lib/wx/core/bitmap_combobox.rb +17 -21
  20. data/lib/wx/core/combobox.rb +13 -3
  21. data/lib/wx/core/controlwithitems.rb +40 -130
  22. data/lib/wx/core/enum.rb +17 -1
  23. data/lib/wx/core/event.rb +6 -1
  24. data/lib/wx/core/events/evt_list.rb +5 -4
  25. data/lib/wx/core/evthandler.rb +8 -2
  26. data/lib/wx/core/generic_validator.rb +312 -0
  27. data/lib/wx/core/listbox.rb +2 -2
  28. data/lib/wx/core/log.rb +1 -1
  29. data/lib/wx/core/owner_drawn_combobox.rb +45 -0
  30. data/lib/wx/core/size.rb +4 -0
  31. data/lib/wx/core/sizer.rb +1 -2
  32. data/lib/wx/core/standard_paths.rb +22 -0
  33. data/lib/wx/core/text_entry.rb +4 -1
  34. data/lib/wx/core/validator.rb +70 -5
  35. data/lib/wx/core/window.rb +3 -7
  36. data/lib/wx/doc/art_locator.rb +1 -0
  37. data/lib/wx/doc/comboctrl.rb +18 -0
  38. data/lib/wx/doc/controlwithitems.rb +16 -0
  39. data/lib/wx/doc/date_picker_ctrl.rb +23 -0
  40. data/lib/wx/doc/editable_listbox.rb +44 -0
  41. data/lib/wx/doc/enum.rb +15 -0
  42. data/lib/wx/doc/event.rb +12 -0
  43. data/lib/wx/doc/extra/12_client_data.md +89 -0
  44. data/lib/wx/doc/extra/13_validators.md +139 -0
  45. data/lib/wx/doc/gdi_common.rb +4 -0
  46. data/lib/wx/doc/gen/about_dialog_info.rb +25 -0
  47. data/lib/wx/doc/gen/accelerator.rb +7 -1
  48. data/lib/wx/doc/gen/accessible.rb +13 -0
  49. data/lib/wx/doc/gen/activity_indicator.rb +7 -0
  50. data/lib/wx/doc/gen/animation.rb +12 -0
  51. data/lib/wx/doc/gen/animation_ctrl.rb +10 -0
  52. data/lib/wx/doc/gen/any_button.rb +17 -1
  53. data/lib/wx/doc/gen/app.rb +35 -1
  54. data/lib/wx/doc/gen/app_traits.rb +38 -5
  55. data/lib/wx/doc/gen/art_provider.rb +14 -0
  56. data/lib/wx/doc/gen/aui/aui_dock_art.rb +12 -0
  57. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +1 -0
  58. data/lib/wx/doc/gen/aui/aui_manager.rb +24 -1
  59. data/lib/wx/doc/gen/aui/aui_manager_event.rb +9 -1
  60. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +3 -0
  61. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +2 -0
  62. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +3 -1
  63. data/lib/wx/doc/gen/aui/aui_notebook.rb +20 -2
  64. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +2 -1
  65. data/lib/wx/doc/gen/aui/aui_pane_info.rb +30 -1
  66. data/lib/wx/doc/gen/aui/aui_tab_art.rb +6 -0
  67. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +1 -0
  68. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +11 -0
  69. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +2 -0
  70. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +2 -1
  71. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +4 -0
  72. data/lib/wx/doc/gen/banner_window.rb +7 -0
  73. data/lib/wx/doc/gen/bitmap.rb +64 -3
  74. data/lib/wx/doc/gen/bitmap_button.rb +6 -1
  75. data/lib/wx/doc/gen/bitmap_combo_box.rb +9 -3
  76. data/lib/wx/doc/gen/book_ctrl_base.rb +17 -2
  77. data/lib/wx/doc/gen/book_ctrl_event.rb +3 -1
  78. data/lib/wx/doc/gen/box_sizer.rb +5 -0
  79. data/lib/wx/doc/gen/brush.rb +16 -1
  80. data/lib/wx/doc/gen/busy_info.rb +8 -0
  81. data/lib/wx/doc/gen/button.rb +11 -3
  82. data/lib/wx/doc/gen/calculate_layout_event.rb +4 -0
  83. data/lib/wx/doc/gen/calendar_ctrl.rb +22 -0
  84. data/lib/wx/doc/gen/calendar_date_attr.rb +1 -0
  85. data/lib/wx/doc/gen/calendar_event.rb +3 -1
  86. data/lib/wx/doc/gen/caret.rb +3 -0
  87. data/lib/wx/doc/gen/check_box.rb +10 -0
  88. data/lib/wx/doc/gen/check_list_box.rb +3 -0
  89. data/lib/wx/doc/gen/choice.rb +14 -2
  90. data/lib/wx/doc/gen/choicebook.rb +1 -0
  91. data/lib/wx/doc/gen/client_dc.rb +1 -0
  92. data/lib/wx/doc/gen/clipboard.rb +9 -0
  93. data/lib/wx/doc/gen/collapsible_pane.rb +3 -0
  94. data/lib/wx/doc/gen/collapsible_pane_event.rb +1 -0
  95. data/lib/wx/doc/gen/colour.rb +20 -0
  96. data/lib/wx/doc/gen/colour_dialog.rb +10 -0
  97. data/lib/wx/doc/gen/colour_picker_ctrl.rb +4 -0
  98. data/lib/wx/doc/gen/colour_picker_event.rb +1 -0
  99. data/lib/wx/doc/gen/combo_box.rb +20 -1
  100. data/lib/wx/doc/gen/combo_ctrl.rb +54 -295
  101. data/lib/wx/doc/gen/command_link_button.rb +8 -0
  102. data/lib/wx/doc/gen/context_help_button.rb +7 -1
  103. data/lib/wx/doc/gen/control.rb +12 -0
  104. data/lib/wx/doc/gen/control_with_items.rb +45 -9
  105. data/lib/wx/doc/gen/core.rb +2 -2
  106. data/lib/wx/doc/gen/cursor.rb +4 -0
  107. data/lib/wx/doc/gen/data_format.rb +1 -0
  108. data/lib/wx/doc/gen/data_object.rb +27 -5
  109. data/lib/wx/doc/gen/date_event.rb +2 -1
  110. data/lib/wx/doc/gen/date_picker_ctrl.rb +7 -1
  111. data/lib/wx/doc/gen/dc.rb +87 -3
  112. data/lib/wx/doc/gen/dial_up_event.rb +2 -0
  113. data/lib/wx/doc/gen/dial_up_manager.rb +12 -0
  114. data/lib/wx/doc/gen/dialog.rb +42 -3
  115. data/lib/wx/doc/gen/dir_dialog.rb +6 -1
  116. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -0
  117. data/lib/wx/doc/gen/dir_picker_ctrl.rb +5 -0
  118. data/lib/wx/doc/gen/drag_drop.rb +20 -0
  119. data/lib/wx/doc/gen/drag_image.rb +7 -0
  120. data/lib/wx/doc/gen/editable_list_box.rb +5 -3
  121. data/lib/wx/doc/gen/event.rb +26 -11
  122. data/lib/wx/doc/gen/event_blocker.rb +2 -1
  123. data/lib/wx/doc/gen/event_filter.rb +3 -0
  124. data/lib/wx/doc/gen/event_list.rb +4 -4
  125. data/lib/wx/doc/gen/events.rb +165 -26
  126. data/lib/wx/doc/gen/evt_handler.rb +40 -2
  127. data/lib/wx/doc/gen/ext_help_controller.rb +9 -0
  128. data/lib/wx/doc/gen/file_ctrl.rb +11 -2
  129. data/lib/wx/doc/gen/file_ctrl_event.rb +5 -1
  130. data/lib/wx/doc/gen/file_dialog.rb +13 -0
  131. data/lib/wx/doc/gen/file_dialog_custom_control.rb +12 -0
  132. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +9 -0
  133. data/lib/wx/doc/gen/file_dir_picker_event.rb +2 -1
  134. data/lib/wx/doc/gen/file_picker_ctrl.rb +4 -0
  135. data/lib/wx/doc/gen/file_system.rb +17 -1
  136. data/lib/wx/doc/gen/find_dialog_event.rb +2 -1
  137. data/lib/wx/doc/gen/find_replace_data.rb +1 -0
  138. data/lib/wx/doc/gen/find_replace_dialog.rb +3 -0
  139. data/lib/wx/doc/gen/flex_grid_sizer.rb +13 -0
  140. data/lib/wx/doc/gen/font.rb +75 -3
  141. data/lib/wx/doc/gen/font_data.rb +14 -0
  142. data/lib/wx/doc/gen/font_dialog.rb +6 -0
  143. data/lib/wx/doc/gen/font_picker_ctrl.rb +8 -0
  144. data/lib/wx/doc/gen/font_picker_event.rb +1 -0
  145. data/lib/wx/doc/gen/frame.rb +24 -7
  146. data/lib/wx/doc/gen/fs_file.rb +22 -0
  147. data/lib/wx/doc/gen/gauge.rb +8 -0
  148. data/lib/wx/doc/gen/gb_sizer_item.rb +5 -0
  149. data/lib/wx/doc/gen/gcdc.rb +2 -0
  150. data/lib/wx/doc/gen/gdi_common.rb +50 -0
  151. data/lib/wx/doc/gen/gdi_object.rb +1 -0
  152. data/lib/wx/doc/gen/generic_dir_ctrl.rb +7 -0
  153. data/lib/wx/doc/gen/graphics_context.rb +36 -7
  154. data/lib/wx/doc/gen/graphics_object.rb +24 -0
  155. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +2 -0
  156. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +14 -2
  157. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -0
  158. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +1 -0
  159. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +2 -0
  160. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -0
  161. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +2 -0
  162. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +1 -0
  163. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +1 -0
  164. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +1 -0
  165. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +9 -0
  166. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +1 -0
  167. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +1 -0
  168. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -0
  169. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +2 -0
  170. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +2 -0
  171. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -0
  172. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +6 -0
  173. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -0
  174. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -0
  175. data/lib/wx/doc/gen/grid/grid_ctrl.rb +229 -7
  176. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +4 -1
  177. data/lib/wx/doc/gen/grid/grid_event.rb +4 -1
  178. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +2 -1
  179. data/lib/wx/doc/gen/grid/grid_size_event.rb +2 -1
  180. data/lib/wx/doc/gen/grid/grid_string_table.rb +7 -0
  181. data/lib/wx/doc/gen/grid/grid_table_base.rb +27 -1
  182. data/lib/wx/doc/gen/grid/grid_table_message.rb +1 -0
  183. data/lib/wx/doc/gen/grid_bag_sizer.rb +24 -4
  184. data/lib/wx/doc/gen/grid_sizer.rb +11 -0
  185. data/lib/wx/doc/gen/gui_event_loop.rb +12 -0
  186. data/lib/wx/doc/gen/header_ctrl.rb +106 -0
  187. data/lib/wx/doc/gen/header_ctrl_event.rb +5 -1
  188. data/lib/wx/doc/gen/help_controller.rb +11 -0
  189. data/lib/wx/doc/gen/help_provider.rb +12 -3
  190. data/lib/wx/doc/gen/html/html_cell.rb +25 -0
  191. data/lib/wx/doc/gen/html/html_cell_event.rb +3 -1
  192. data/lib/wx/doc/gen/html/html_easy_printing.rb +13 -1
  193. data/lib/wx/doc/gen/html/html_help_controller.rb +18 -0
  194. data/lib/wx/doc/gen/html/html_help_data.rb +5 -0
  195. data/lib/wx/doc/gen/html/html_help_window.rb +8 -0
  196. data/lib/wx/doc/gen/html/html_link_event.rb +1 -0
  197. data/lib/wx/doc/gen/html/html_list_box.rb +49 -9
  198. data/lib/wx/doc/gen/html/html_printout.rb +7 -0
  199. data/lib/wx/doc/gen/html/html_window.rb +31 -0
  200. data/lib/wx/doc/gen/hyperlink_ctrl.rb +2 -1
  201. data/lib/wx/doc/gen/hyperlink_event.rb +1 -0
  202. data/lib/wx/doc/gen/icon.rb +19 -1
  203. data/lib/wx/doc/gen/icon_location.rb +1 -0
  204. data/lib/wx/doc/gen/image.rb +67 -10
  205. data/lib/wx/doc/gen/image_list.rb +12 -2
  206. data/lib/wx/doc/gen/info_bar.rb +12 -0
  207. data/lib/wx/doc/gen/keyboard_state.rb +11 -0
  208. data/lib/wx/doc/gen/list_box.rb +20 -3
  209. data/lib/wx/doc/gen/list_ctrl.rb +89 -0
  210. data/lib/wx/doc/gen/list_event.rb +11 -1
  211. data/lib/wx/doc/gen/listbook.rb +1 -0
  212. data/lib/wx/doc/gen/locale.rb +22 -0
  213. data/lib/wx/doc/gen/log.rb +42 -0
  214. data/lib/wx/doc/gen/mdi_client_window.rb +4 -1
  215. data/lib/wx/doc/gen/mdi_frame.rb +27 -4
  216. data/lib/wx/doc/gen/media_ctrl.rb +17 -0
  217. data/lib/wx/doc/gen/media_event.rb +2 -1
  218. data/lib/wx/doc/gen/memory_dc.rb +10 -0
  219. data/lib/wx/doc/gen/menu.rb +48 -7
  220. data/lib/wx/doc/gen/menu_bar.rb +32 -13
  221. data/lib/wx/doc/gen/menu_item.rb +26 -0
  222. data/lib/wx/doc/gen/message_dialog.rb +10 -0
  223. data/lib/wx/doc/gen/mini_frame.rb +5 -2
  224. data/lib/wx/doc/gen/mirror_dc.rb +1 -0
  225. data/lib/wx/doc/gen/mouse_state.rb +1 -0
  226. data/lib/wx/doc/gen/multi_choice_dialog.rb +3 -1
  227. data/lib/wx/doc/gen/non_owned_window.rb +3 -0
  228. data/lib/wx/doc/gen/notebook.rb +11 -1
  229. data/lib/wx/doc/gen/num_validator.rb +37 -0
  230. data/lib/wx/doc/gen/number_entry_dialog.rb +4 -0
  231. data/lib/wx/doc/gen/object.rb +3 -0
  232. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +340 -0
  233. data/lib/wx/doc/gen/paint_dc.rb +1 -0
  234. data/lib/wx/doc/gen/palette.rb +5 -0
  235. data/lib/wx/doc/gen/panel.rb +10 -2
  236. data/lib/wx/doc/gen/pen.rb +30 -1
  237. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +2 -1
  238. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +4 -1
  239. data/lib/wx/doc/gen/pg/pg_cell.rb +6 -1
  240. data/lib/wx/doc/gen/pg/pg_editor.rb +61 -15
  241. data/lib/wx/doc/gen/pg/pg_multi_button.rb +2 -0
  242. data/lib/wx/doc/gen/pg/pg_properties.rb +198 -81
  243. data/lib/wx/doc/gen/pg/pg_property.rb +129 -52
  244. data/lib/wx/doc/gen/pg/pg_validation_info.rb +2 -0
  245. data/lib/wx/doc/gen/pg/property_grid.rb +56 -14
  246. data/lib/wx/doc/gen/pg/property_grid_event.rb +16 -6
  247. data/lib/wx/doc/gen/pg/property_grid_interface.rb +98 -37
  248. data/lib/wx/doc/gen/pg/property_grid_manager.rb +29 -7
  249. data/lib/wx/doc/gen/pg/property_grid_page.rb +11 -4
  250. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +7 -2
  251. data/lib/wx/doc/gen/picker_base.rb +11 -1
  252. data/lib/wx/doc/gen/platform_info.rb +31 -0
  253. data/lib/wx/doc/gen/popup_window.rb +5 -0
  254. data/lib/wx/doc/gen/progress_dialog.rb +4 -0
  255. data/lib/wx/doc/gen/property_sheet_dialog.rb +7 -1
  256. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +2 -0
  257. data/lib/wx/doc/gen/prt/post_script_dc.rb +1 -0
  258. data/lib/wx/doc/gen/prt/preview_frame.rb +4 -0
  259. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +1 -0
  260. data/lib/wx/doc/gen/prt/print_data.rb +27 -0
  261. data/lib/wx/doc/gen/prt/print_dialog.rb +4 -0
  262. data/lib/wx/doc/gen/prt/printer.rb +42 -5
  263. data/lib/wx/doc/gen/prt/printer_dc.rb +2 -0
  264. data/lib/wx/doc/gen/query_layout_info_event.rb +9 -0
  265. data/lib/wx/doc/gen/radio_box.rb +19 -0
  266. data/lib/wx/doc/gen/radio_button.rb +9 -0
  267. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +63 -0
  268. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +23 -0
  269. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +2 -1
  270. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +35 -9
  271. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +2 -1
  272. data/lib/wx/doc/gen/rbn/ribbon_control.rb +10 -0
  273. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +17 -7
  274. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -1
  275. data/lib/wx/doc/gen/rbn/ribbon_page.rb +12 -0
  276. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +11 -0
  277. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +2 -1
  278. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +25 -0
  279. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +2 -1
  280. data/lib/wx/doc/gen/rearrange_ctrl.rb +4 -0
  281. data/lib/wx/doc/gen/rearrange_list.rb +9 -0
  282. data/lib/wx/doc/gen/region.rb +42 -13
  283. data/lib/wx/doc/gen/region_iterator.rb +1 -0
  284. data/lib/wx/doc/gen/rtc/rich_text_box.rb +25 -8
  285. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +41 -4
  286. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -0
  287. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +23 -11
  288. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +74 -0
  289. data/lib/wx/doc/gen/rtc/rich_text_event.rb +6 -1
  290. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +8 -0
  291. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +6 -0
  292. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +1 -0
  293. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +4 -0
  294. data/lib/wx/doc/gen/rtc/rich_text_image.rb +7 -0
  295. data/lib/wx/doc/gen/rtc/rich_text_object.rb +64 -4
  296. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +51 -4
  297. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +13 -0
  298. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +9 -4
  299. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +3 -0
  300. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +2 -0
  301. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +1 -0
  302. data/lib/wx/doc/gen/sash_event.rb +5 -1
  303. data/lib/wx/doc/gen/sash_layout_window.rb +10 -0
  304. data/lib/wx/doc/gen/sash_window.rb +3 -0
  305. data/lib/wx/doc/gen/screen_dc.rb +1 -0
  306. data/lib/wx/doc/gen/scroll_bar.rb +11 -2
  307. data/lib/wx/doc/gen/scrolled_canvas.rb +20 -4
  308. data/lib/wx/doc/gen/scrolled_control.rb +20 -4
  309. data/lib/wx/doc/gen/scrolled_window.rb +20 -4
  310. data/lib/wx/doc/gen/search_ctrl.rb +6 -0
  311. data/lib/wx/doc/gen/simplebook.rb +7 -0
  312. data/lib/wx/doc/gen/single_choice_dialog.rb +3 -1
  313. data/lib/wx/doc/gen/sizer.rb +79 -9
  314. data/lib/wx/doc/gen/sizer_item.rb +16 -2
  315. data/lib/wx/doc/gen/slider.rb +23 -0
  316. data/lib/wx/doc/gen/spin_button.rb +9 -0
  317. data/lib/wx/doc/gen/spin_ctrl.rb +11 -0
  318. data/lib/wx/doc/gen/spin_ctrl_double.rb +7 -0
  319. data/lib/wx/doc/gen/spin_double_event.rb +4 -1
  320. data/lib/wx/doc/gen/spin_event.rb +2 -1
  321. data/lib/wx/doc/gen/splash_screen.rb +2 -0
  322. data/lib/wx/doc/gen/splitter_event.rb +10 -1
  323. data/lib/wx/doc/gen/splitter_window.rb +38 -14
  324. data/lib/wx/doc/gen/static_bitmap.rb +99 -2
  325. data/lib/wx/doc/gen/static_box.rb +6 -0
  326. data/lib/wx/doc/gen/static_box_sizer.rb +3 -0
  327. data/lib/wx/doc/gen/static_line.rb +4 -0
  328. data/lib/wx/doc/gen/static_text.rb +5 -0
  329. data/lib/wx/doc/gen/status_bar.rb +17 -3
  330. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +174 -6
  331. data/lib/wx/doc/gen/stc/styled_text_event.rb +27 -1
  332. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +7 -0
  333. data/lib/wx/doc/gen/svg_file_dc.rb +9 -0
  334. data/lib/wx/doc/gen/system_options.rb +8 -0
  335. data/lib/wx/doc/gen/system_settings.rb +7 -0
  336. data/lib/wx/doc/gen/task_bar_button.rb +12 -0
  337. data/lib/wx/doc/gen/task_bar_icon.rb +5 -0
  338. data/lib/wx/doc/gen/task_bar_icon_event.rb +2 -1
  339. data/lib/wx/doc/gen/text_attr.rb +27 -0
  340. data/lib/wx/doc/gen/text_ctrl.rb +27 -3
  341. data/lib/wx/doc/gen/text_entry.rb +43 -5
  342. data/lib/wx/doc/gen/text_entry_dialog.rb +12 -0
  343. data/lib/wx/doc/gen/text_validator.rb +16 -0
  344. data/lib/wx/doc/gen/time_picker_ctrl.rb +6 -0
  345. data/lib/wx/doc/gen/timer.rb +8 -0
  346. data/lib/wx/doc/gen/timer_event.rb +1 -0
  347. data/lib/wx/doc/gen/tip_provider.rb +5 -0
  348. data/lib/wx/doc/gen/toggle_button.rb +68 -0
  349. data/lib/wx/doc/gen/tool_bar.rb +57 -14
  350. data/lib/wx/doc/gen/tool_tip.rb +6 -0
  351. data/lib/wx/doc/gen/toolbook.rb +3 -0
  352. data/lib/wx/doc/gen/top_level_window.rb +34 -3
  353. data/lib/wx/doc/gen/tree_ctrl.rb +49 -0
  354. data/lib/wx/doc/gen/tree_event.rb +7 -1
  355. data/lib/wx/doc/gen/treebook.rb +9 -0
  356. data/lib/wx/doc/gen/ui_action_simulator.rb +4 -0
  357. data/lib/wx/doc/gen/utils.rb +55 -0
  358. data/lib/wx/doc/gen/v_list_box.rb +21 -0
  359. data/lib/wx/doc/gen/v_scrolled_window.rb +15 -0
  360. data/lib/wx/doc/gen/validator.rb +9 -13
  361. data/lib/wx/doc/gen/variant.rb +6 -0
  362. data/lib/wx/doc/gen/window.rb +260 -52
  363. data/lib/wx/doc/gen/window_dc.rb +2 -0
  364. data/lib/wx/doc/gen/window_disabler.rb +1 -0
  365. data/lib/wx/doc/gen/with_images.rb +7 -1
  366. data/lib/wx/doc/gen/wizard.rb +18 -0
  367. data/lib/wx/doc/gen/wizard_event.rb +3 -1
  368. data/lib/wx/doc/gen/wizard_page.rb +5 -0
  369. data/lib/wx/doc/gen/wizard_page_simple.rb +4 -0
  370. data/lib/wx/doc/gen/wrap_sizer.rb +5 -0
  371. data/lib/wx/doc/gen/xml_node.rb +14 -0
  372. data/lib/wx/doc/gen/xml_resource.rb +22 -0
  373. data/lib/wx/doc/generic_validator.rb +95 -0
  374. data/lib/wx/doc/html/simple_html_listbox.rb +22 -0
  375. data/lib/wx/doc/num_validator.rb +387 -0
  376. data/lib/wx/doc/owner_drawn_combobox.rb +96 -0
  377. data/lib/wx/doc/pg/numeric_property_validator.rb +33 -0
  378. data/lib/wx/doc/static_bitmap.rb +25 -0
  379. data/lib/wx/doc/text_validator.rb +10 -0
  380. data/lib/wx/doc/validator.rb +113 -0
  381. data/lib/wx/doc/window.rb +30 -0
  382. data/lib/wx/html/events/evt_list.rb +0 -10
  383. data/lib/wx/html/simple_html_listbox.rb +24 -91
  384. data/lib/wx/keyword_defs.rb +34 -2
  385. data/lib/wx/rbn/ribbon_gallery.rb +0 -21
  386. data/lib/wx/version.rb +1 -1
  387. data/lib/wxruby_aui.so +0 -0
  388. data/lib/wxruby_core.so +0 -0
  389. data/lib/wxruby_grid.so +0 -0
  390. data/lib/wxruby_html.so +0 -0
  391. data/lib/wxruby_pg.so +0 -0
  392. data/lib/wxruby_prt.so +0 -0
  393. data/lib/wxruby_rbn.so +0 -0
  394. data/lib/wxruby_rtc.so +0 -0
  395. data/lib/wxruby_stc.so +0 -0
  396. data/rakelib/lib/config/mingw.rb +12 -0
  397. data/samples/aui/aui.rb +1237 -1233
  398. data/samples/calendar/calendar.rb +293 -289
  399. data/samples/controls/get_item_sample.rb +83 -79
  400. data/samples/controls/htlbox.rb +331 -327
  401. data/samples/dialogs/dialogs.rb +682 -694
  402. data/samples/dialogs/wizard.rb +52 -55
  403. data/samples/dragdrop/dragdrop.rb +146 -142
  404. data/samples/drawing/bitmap.rb +29 -26
  405. data/samples/drawing/bitmap_image.rb +84 -80
  406. data/samples/drawing/graphics_drawing.rb +209 -205
  407. data/samples/drawing/image_prt.rb +344 -340
  408. data/samples/drawing/maths_images.rb +18 -1
  409. data/samples/drawing/rmagic_bitmap_image.rb +88 -84
  410. data/samples/etc/caret.rb +306 -0
  411. data/samples/etc/miniframe.rb +65 -60
  412. data/samples/etc/sash.rb +109 -105
  413. data/samples/etc/scrollwin.rb +86 -80
  414. data/samples/etc/system_settings.rb +216 -209
  415. data/samples/event/activation.rb +72 -67
  416. data/samples/event/event.rb +160 -153
  417. data/samples/event/threaded.rb +8 -1
  418. data/samples/event/update_ui_event.rb +67 -60
  419. data/samples/grid/grid.rb +188 -181
  420. data/samples/grid/gridtablebase.rb +136 -129
  421. data/samples/html/html.rb +208 -204
  422. data/samples/mdi/mdi.rb +59 -54
  423. data/samples/minimal/minimal.rb +54 -51
  424. data/samples/minimal/nothing.rb +1 -0
  425. data/samples/printing/printing.rb +367 -377
  426. data/samples/printing/printing2.rb +203 -198
  427. data/samples/propgrid/propgrid.rb +2312 -2308
  428. data/samples/propgrid/propgrid_minimal.rb +57 -50
  429. data/samples/ribbon/ribbon.rb +780 -774
  430. data/samples/sampler/ext.rb +0 -33
  431. data/samples/sampler/sample.rb +4 -9
  432. data/samples/sampler.rb +1 -1
  433. data/samples/splash/splash.rb +118 -116
  434. data/samples/text/rich_textctrl.rb +207 -201
  435. data/samples/text/richtext.rb +1409 -1405
  436. data/samples/text/scintilla.rb +137 -128
  437. data/samples/text/textctrl.rb +89 -83
  438. data/samples/text/unicode.rb +175 -168
  439. data/samples/treectrl/treectrl.rb +1430 -1426
  440. data/samples/widgets/activityindicator.rb +95 -0
  441. data/samples/widgets/art/widgets/activityindicator.xpm +278 -0
  442. data/samples/widgets/art/widgets/bmpbtn.xpm +37 -0
  443. data/samples/widgets/art/widgets/bmpcombobox.xpm +54 -0
  444. data/samples/widgets/art/widgets/button.xpm +54 -0
  445. data/samples/widgets/art/widgets/checkbox.xpm +54 -0
  446. data/samples/{bigdemo/icons → widgets/art/widgets}/choice.xpm +1 -1
  447. data/samples/widgets/art/widgets/choicebk.xpm +54 -0
  448. data/samples/widgets/art/widgets/clrpicker.xpm +193 -0
  449. data/samples/widgets/art/widgets/combobox.xpm +54 -0
  450. data/samples/widgets/art/widgets/datepick.xpm +200 -0
  451. data/samples/widgets/art/widgets/dirctrl.xpm +54 -0
  452. data/samples/widgets/art/widgets/dirpicker.xpm +213 -0
  453. data/samples/widgets/art/widgets/filepicker.xpm +214 -0
  454. data/samples/widgets/art/widgets/fontpicker.xpm +185 -0
  455. data/samples/widgets/art/widgets/gauge.xpm +54 -0
  456. data/samples/widgets/art/widgets/header.xpm +54 -0
  457. data/samples/widgets/art/widgets/hyperlnk.xpm +54 -0
  458. data/samples/widgets/art/widgets/listbook.xpm +54 -0
  459. data/samples/widgets/art/widgets/listbox.xpm +54 -0
  460. data/samples/widgets/art/widgets/native.xpm +81 -0
  461. data/samples/widgets/art/widgets/notebook.xpm +54 -0
  462. data/samples/widgets/art/widgets/odcombobox.xpm +54 -0
  463. data/samples/widgets/art/widgets/radiobox.xpm +54 -0
  464. data/samples/widgets/art/widgets/scrolbar.xpm +54 -0
  465. data/samples/widgets/art/widgets/slider.xpm +54 -0
  466. data/samples/widgets/art/widgets/spinbtn.xpm +40 -0
  467. data/samples/widgets/art/widgets/statbmp.xpm +40 -0
  468. data/samples/widgets/art/widgets/statbox.xpm +54 -0
  469. data/samples/widgets/art/widgets/stattext.xpm +54 -0
  470. data/samples/widgets/art/widgets/text.xpm +54 -0
  471. data/samples/widgets/art/widgets/timepick.xpm +207 -0
  472. data/samples/widgets/art/widgets/toggle.xpm +54 -0
  473. data/samples/widgets/art/widgets/toucan.png +0 -0
  474. data/samples/widgets/bmpcombobox.rb +651 -0
  475. data/samples/widgets/button.rb +462 -0
  476. data/samples/widgets/checkbox.rb +211 -0
  477. data/samples/widgets/choice.rb +287 -0
  478. data/samples/widgets/clrpicker.rb +156 -0
  479. data/samples/widgets/combobox.rb +516 -0
  480. data/samples/widgets/datepick.rb +215 -0
  481. data/samples/widgets/dirctrl.rb +265 -0
  482. data/samples/widgets/dirpicker.rb +158 -0
  483. data/samples/widgets/editlbox.rb +122 -0
  484. data/samples/widgets/filectrl.rb +216 -0
  485. data/samples/widgets/filepicker.rb +214 -0
  486. data/samples/widgets/fontpicker.rb +135 -0
  487. data/samples/widgets/gauge.rb +311 -0
  488. data/samples/widgets/headerctrl.rb +236 -0
  489. data/samples/widgets/hyperlink.rb +203 -0
  490. data/samples/widgets/itemcontainer.rb +185 -0
  491. data/samples/widgets/listbox.rb +473 -0
  492. data/samples/widgets/notebook.rb +488 -0
  493. data/samples/widgets/odcombobox.rb +608 -0
  494. data/samples/widgets/radiobox.rb +328 -0
  495. data/samples/widgets/searchctrl.rb +159 -0
  496. data/samples/widgets/slider.rb +594 -0
  497. data/samples/widgets/spinbtn.rb +443 -0
  498. data/samples/widgets/statbmp.rb +130 -0
  499. data/samples/widgets/static.rb +436 -0
  500. data/samples/widgets/textctrl.rb +700 -0
  501. data/samples/widgets/timepick.rb +148 -0
  502. data/samples/widgets/tn_widgets.png +0 -0
  503. data/samples/widgets/toggle.rb +385 -0
  504. data/samples/widgets/widgets.rb +1233 -0
  505. data/samples/xrc/custom_xrc_sample.rb +47 -41
  506. data/samples/xrc/xrc_sample.rb +53 -47
  507. data/tests/test_event_handling.rb +52 -34
  508. data/tests/test_events.rb +7 -0
  509. data/tests/test_item_data.rb +24 -0
  510. data/tests/test_sizer.rb +44 -1
  511. data/tests/test_validators.rb +805 -0
  512. metadata +87 -137
  513. data/lib/wx/core/choice.rb +0 -14
  514. data/lib/wx/core/combo_ctrl.rb +0 -110
  515. data/samples/bigdemo/About.rbw +0 -39
  516. data/samples/bigdemo/ColorPanel.rbw +0 -23
  517. data/samples/bigdemo/GridSimple.rbw +0 -78
  518. data/samples/bigdemo/MDIDemo.rbw +0 -57
  519. data/samples/bigdemo/PopupMenu.rbw +0 -146
  520. data/samples/bigdemo/ShapedWindow.rbw +0 -128
  521. data/samples/bigdemo/Sizers.rbw +0 -541
  522. data/samples/bigdemo/bigdemo.rb +0 -817
  523. data/samples/bigdemo/demoTemplate.rbw +0 -33
  524. data/samples/bigdemo/helpfile.htb +0 -0
  525. data/samples/bigdemo/icons/Test 015.jpg +0 -0
  526. data/samples/bigdemo/icons/Test 015.png +0 -0
  527. data/samples/bigdemo/icons/choice.bmp +0 -0
  528. data/samples/bigdemo/icons/combo.bmp +0 -0
  529. data/samples/bigdemo/icons/combo.xpm +0 -27
  530. data/samples/bigdemo/icons/copy.xpm +0 -25
  531. data/samples/bigdemo/icons/cut.xpm +0 -24
  532. data/samples/bigdemo/icons/gauge.bmp +0 -0
  533. data/samples/bigdemo/icons/gauge.xpm +0 -27
  534. data/samples/bigdemo/icons/help.xpm +0 -25
  535. data/samples/bigdemo/icons/list.bmp +0 -0
  536. data/samples/bigdemo/icons/list.xpm +0 -27
  537. data/samples/bigdemo/icons/mondrian.ico +0 -0
  538. data/samples/bigdemo/icons/mondrian.xpm +0 -44
  539. data/samples/bigdemo/icons/new.xpm +0 -24
  540. data/samples/bigdemo/icons/ogl.ico +0 -0
  541. data/samples/bigdemo/icons/ogl.xpm +0 -45
  542. data/samples/bigdemo/icons/open.xpm +0 -26
  543. data/samples/bigdemo/icons/paste.bmp +0 -0
  544. data/samples/bigdemo/icons/paste.xpm +0 -38
  545. data/samples/bigdemo/icons/pointy.png +0 -0
  546. data/samples/bigdemo/icons/preview.xpm +0 -26
  547. data/samples/bigdemo/icons/print.xpm +0 -26
  548. data/samples/bigdemo/icons/radio.bmp +0 -0
  549. data/samples/bigdemo/icons/radio.xpm +0 -27
  550. data/samples/bigdemo/icons/robert.xpm +0 -415
  551. data/samples/bigdemo/icons/sashtest.ico +0 -0
  552. data/samples/bigdemo/icons/save.xpm +0 -25
  553. data/samples/bigdemo/icons/smiles.bmp +0 -0
  554. data/samples/bigdemo/icons/smiles.xpm +0 -39
  555. data/samples/bigdemo/icons/smiley.ico +0 -0
  556. data/samples/bigdemo/icons/smiley.xpm +0 -42
  557. data/samples/bigdemo/icons/stattext.xpm +0 -24
  558. data/samples/bigdemo/icons/test2.bmp +0 -0
  559. data/samples/bigdemo/icons/test2.png +0 -0
  560. data/samples/bigdemo/icons/test2.xpm +0 -79
  561. data/samples/bigdemo/icons/text.bmp +0 -0
  562. data/samples/bigdemo/icons/text.xpm +0 -27
  563. data/samples/bigdemo/icons/tog1.bmp +0 -0
  564. data/samples/bigdemo/icons/tog1.xpm +0 -38
  565. data/samples/bigdemo/icons/tog2.bmp +0 -0
  566. data/samples/bigdemo/icons/tog2.xpm +0 -38
  567. data/samples/bigdemo/icons/wxruby-128x128.png +0 -0
  568. data/samples/bigdemo/icons/wxwin.ico +0 -0
  569. data/samples/bigdemo/icons/wxwin16x16.png +0 -0
  570. data/samples/bigdemo/icons/wxwin16x16.xpm +0 -25
  571. data/samples/bigdemo/icons/wxwin32x32.png +0 -0
  572. data/samples/bigdemo/icons/wxwin48x48.png +0 -0
  573. data/samples/bigdemo/run.rb +0 -98
  574. data/samples/bigdemo/tips.txt +0 -7
  575. data/samples/bigdemo/utils.rb +0 -20
  576. data/samples/bigdemo/wxArtProvider.rbw +0 -282
  577. data/samples/bigdemo/wxBitmapButton.rbw +0 -65
  578. data/samples/bigdemo/wxButton.rbw +0 -64
  579. data/samples/bigdemo/wxCalendarCtrl.rbw +0 -59
  580. data/samples/bigdemo/wxCheckBox.rbw +0 -50
  581. data/samples/bigdemo/wxCheckListBox.rbw +0 -65
  582. data/samples/bigdemo/wxChoice.rbw +0 -47
  583. data/samples/bigdemo/wxChoicebook.rbw +0 -78
  584. data/samples/bigdemo/wxColourDialog.rbw +0 -33
  585. data/samples/bigdemo/wxComboBox.rbw +0 -77
  586. data/samples/bigdemo/wxCursor.rbw +0 -136
  587. data/samples/bigdemo/wxDialog.rbw +0 -74
  588. data/samples/bigdemo/wxDirDialog.rbw +0 -29
  589. data/samples/bigdemo/wxDragImage.rbw +0 -70
  590. data/samples/bigdemo/wxFileDialog.rbw +0 -37
  591. data/samples/bigdemo/wxFileDialog_Save.rbw +0 -35
  592. data/samples/bigdemo/wxFindReplaceDialog.rbw +0 -82
  593. data/samples/bigdemo/wxFontDialog.rbw +0 -200
  594. data/samples/bigdemo/wxFrame.rbw +0 -53
  595. data/samples/bigdemo/wxGauge.rbw +0 -65
  596. data/samples/bigdemo/wxGenericDirCtrl.rbw +0 -74
  597. data/samples/bigdemo/wxGrid.rbw +0 -66
  598. data/samples/bigdemo/wxHtmlHelpController.rbw +0 -52
  599. data/samples/bigdemo/wxListBox.rbw +0 -140
  600. data/samples/bigdemo/wxListCtrl_virtual.rbw +0 -112
  601. data/samples/bigdemo/wxMDIWindows.rbw +0 -50
  602. data/samples/bigdemo/wxMenu.rbw +0 -247
  603. data/samples/bigdemo/wxMessageDialog.rbw +0 -27
  604. data/samples/bigdemo/wxMiniFrame.rbw +0 -70
  605. data/samples/bigdemo/wxMultipleChoiceDialog.rbw +0 -29
  606. data/samples/bigdemo/wxNotebook.rbw +0 -136
  607. data/samples/bigdemo/wxProgressDialog.rbw +0 -43
  608. data/samples/bigdemo/wxRadioBox.rbw +0 -72
  609. data/samples/bigdemo/wxRadioButton.rbw +0 -125
  610. data/samples/bigdemo/wxSashWindow.rbw +0 -141
  611. data/samples/bigdemo/wxScrolledMessageDialog.rbw +0 -57
  612. data/samples/bigdemo/wxScrolledWindow.rbw +0 -199
  613. data/samples/bigdemo/wxSingleChoiceDialog.rbw +0 -33
  614. data/samples/bigdemo/wxSlider.rbw +0 -42
  615. data/samples/bigdemo/wxSpinButton.rbw +0 -50
  616. data/samples/bigdemo/wxSpinCtrl.rbw +0 -51
  617. data/samples/bigdemo/wxSplitterWindow.rbw +0 -63
  618. data/samples/bigdemo/wxStaticBitmap.rbw +0 -47
  619. data/samples/bigdemo/wxStaticText.rbw +0 -55
  620. data/samples/bigdemo/wxStatusBar.rbw +0 -126
  621. data/samples/bigdemo/wxTextCtrl.rbw +0 -149
  622. data/samples/bigdemo/wxTextEntryDialog.rbw +0 -31
  623. data/samples/bigdemo/wxToggleButton.rbw +0 -49
  624. data/samples/bigdemo/wxToolBar.rbw +0 -131
  625. data/samples/bigdemo/wxTreeCtrl.rbw +0 -191
  626. data/samples/caret/caret.rb +0 -298
  627. data/samples/caret/mondrian.xpm +0 -44
  628. data/samples/controls/books.rb +0 -189
  629. data/samples/controls/choice.xpm +0 -27
  630. data/samples/controls/combo.xpm +0 -27
  631. data/samples/controls/controls.rb +0 -1099
  632. data/samples/controls/gauge.xpm +0 -27
  633. data/samples/controls/list.xpm +0 -27
  634. data/samples/controls/mondrian.ico +0 -0
  635. data/samples/controls/mondrian.xpm +0 -44
  636. data/samples/controls/radio.xpm +0 -27
  637. data/samples/controls/stattext.xpm +0 -24
  638. data/samples/controls/test2.bmp +0 -0
  639. data/samples/controls/text.xpm +0 -27
  640. data/samples/controls/tn_books.png +0 -0
  641. data/samples/controls/tn_controls.png +0 -0
  642. data/samples/etc/choice.rb +0 -87
  643. data/samples/etc/tn_choice.png +0 -0
  644. data/samples/text/mondrian.ico +0 -0
  645. data/samples/text/mondrian.xpm +0 -44
  646. /data/samples/{caret → etc}/tn_caret.png +0 -0
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # A class that can handle events from the windowing system.
10
+ #
10
11
  # {Wx::Window} is (and therefore all window classes are) derived from this class.
11
12
  # When events are received, {Wx::EvtHandler} invokes the method listed in the event table using itself as the object. When using multiple inheritance <b>it is imperative that the {Wx::EvtHandler}(-derived) class is the first class inherited</b> such that the this pointer for the overall object will be identical to the this pointer of the {Wx::EvtHandler} portion.
12
13
  #
@@ -19,6 +20,7 @@ module Wx
19
20
  class EvtHandler < Object
20
21
 
21
22
  # Queue event for a later processing.
23
+ #
22
24
  # This method is similar to {Wx::EvtHandler#process_event} but while the latter is synchronous, i.e. the event is processed immediately, before the function returns, this one is asynchronous and returns immediately while the event will be processed at some later time (usually during the next event loop iteration).
23
25
  # Another important difference is that this method takes ownership of the event parameter, i.e. it will delete it itself. This implies that the pointer can't be used any more after the function returns (as it can be deleted at any moment).
24
26
  #
@@ -28,6 +30,7 @@ module Wx
28
30
  def queue_event(event) end
29
31
 
30
32
  # Post an event to be processed later.
33
+ #
31
34
  # This function is similar to {Wx::EvtHandler#queue_event} but can't be used to post events from worker threads for the event objects with {Wx::String} fields (i.e. in practice most of them) because of an unsafe use of the same {Wx::String} object which happens because the {Wx::String} field in the original event object and its copy made internally by this function share the same string buffer internally. Use {Wx::EvtHandler#queue_event} to avoid this.
32
35
  # A copy of event is made by the function, so the original can be deleted as soon as function returns (it is common that the original is created on the stack). This requires that the {Wx::Event#clone} method be implemented by event so that it can be duplicated and stored until it gets processed.
33
36
  # @param event [Wx::Event] Event to add to the pending events queue.
@@ -35,6 +38,7 @@ module Wx
35
38
  def add_pending_event(event) end
36
39
 
37
40
  # Try to process the event in this handler and all those chained to it.
41
+ #
38
42
  # As explained in {Wx::EvtHandler#process_event} documentation, the event handlers may be chained in a doubly-linked list. This function tries to process the event in this handler (including performing any pre-processing done in {Wx::EvtHandler#try_before}, e.g. applying validators) and all those following it in the chain until the event is processed or the chain is exhausted.
39
43
  # This function is called from {Wx::EvtHandler#process_event} and, in turn, calls {Wx::EvtHandler#try_before} and {Wx::EvtHandler#try_after}. It is not virtual and so cannot be overridden but can, and should, be called to forward an event to another handler instead of {Wx::EvtHandler#process_event} which would result in a duplicate call to {Wx::EvtHandler#try_after}, e.g. resulting in all unprocessed events being sent to the application object multiple times.
40
44
  #
@@ -44,6 +48,7 @@ module Wx
44
48
  def process_event_locally(event) end
45
49
 
46
50
  # Processes an event by calling {Wx::EvtHandler#process_event} and handles any exceptions that occur in the process.
51
+ #
47
52
  # If an exception is thrown in event handler, {Wx::App::OnExceptionInMainLoop} is called.
48
53
  #
49
54
  # true if the event was processed, false if no handler was found or an exception was thrown.
@@ -53,18 +58,40 @@ module Wx
53
58
  def safely_process_event(event) end
54
59
 
55
60
  # Processes the pending events previously queued using {Wx::EvtHandler#queue_event} or {Wx::EvtHandler#add_pending_event}; you must call this function only if you are sure there are pending events for this handler, otherwise a {Wx::CHECK} will fail.
61
+ #
56
62
  # The real processing still happens in {Wx::EvtHandler#process_event} which is called by this function.
57
63
  # Note that this function needs a valid application object (see Wx::AppConsole#get_instance) because {Wx::App} holds the list of the event handlers with pending events and this function manipulates that list.
58
64
  # @return [void]
59
65
  def process_pending_events; end
60
66
 
61
67
  # Deletes all events queued on this event handler using {Wx::EvtHandler#queue_event} or {Wx::EvtHandler#add_pending_event}.
68
+ #
62
69
  # Use with care because the events which are deleted are (obviously) not processed and this may have unwanted consequences (e.g. user actions events will be lost).
63
70
  # @return [void]
64
71
  def delete_pending_events; end
65
72
 
73
+ # Returns a pointer to the user-supplied client data object.
74
+ #
75
+ #
76
+ # @see Wx::EvtHandler#set_client_object
77
+ # @see Wx::ClientData
78
+ # @return [Object]
79
+ def get_client_object; end
80
+ alias_method :client_object, :get_client_object
81
+
82
+ # Set the client data object.
83
+ #
84
+ # Any previous object will be deleted.
85
+ # @see Wx::EvtHandler#get_client_object
86
+ # @see Wx::ClientData
87
+ # @param data [Object]
88
+ # @return [void]
89
+ def set_client_object(data) end
90
+ alias_method :client_object=, :set_client_object
91
+
66
92
  # Returns true if the event handler is enabled, false otherwise.
67
93
  #
94
+ #
68
95
  # @see Wx::EvtHandler#set_evt_handler_enabled
69
96
  # @return [Boolean]
70
97
  def get_evt_handler_enabled; end
@@ -72,6 +99,7 @@ module Wx
72
99
 
73
100
  # Returns the pointer to the next handler in the chain.
74
101
  #
102
+ #
75
103
  # @see Wx::EvtHandler#set_next_handler
76
104
  # @see Wx::EvtHandler#get_previous_handler
77
105
  # @see Wx::EvtHandler#set_previous_handler
@@ -83,6 +111,7 @@ module Wx
83
111
 
84
112
  # Returns the pointer to the previous handler in the chain.
85
113
  #
114
+ #
86
115
  # @see Wx::EvtHandler#set_previous_handler
87
116
  # @see Wx::EvtHandler#get_next_handler
88
117
  # @see Wx::EvtHandler#set_next_handler
@@ -93,11 +122,12 @@ module Wx
93
122
  alias_method :previous_handler, :get_previous_handler
94
123
 
95
124
  # Enables or disables the event handler.
125
+ #
96
126
  # <div class="wxrb-remark">
97
127
  # <b>Remark:</b>
98
128
  # <p>You can use this function to avoid having to remove the event handler from the chain, for example when implementing a dialog editor and changing from edit to test mode.
99
129
  # </p>
100
- # </div>>
130
+ # </div>
101
131
  # @see Wx::EvtHandler#get_evt_handler_enabled
102
132
  # @param enabled [Boolean] true if the event handler is to be enabled, false if it is to be disabled.
103
133
  # @return [void]
@@ -105,6 +135,7 @@ module Wx
105
135
  alias_method :evt_handler_enabled=, :set_evt_handler_enabled
106
136
 
107
137
  # Sets the pointer to the next handler.
138
+ #
108
139
  # <div class="wxrb-remark">
109
140
  # <b>Remark:</b>
110
141
  # <p>See {Wx::EvtHandler#process_event} for more info about how the chains of event handlers are internally used. Also remember that {Wx::EvtHandler} uses double-linked lists and thus if you use this function, you should also call {Wx::EvtHandler#set_previous_handler} on the argument passed to this function:
@@ -114,7 +145,7 @@ module Wx
114
145
  # ```
115
146
  #
116
147
  # </p>
117
- # </div>>
148
+ # </div>
118
149
  # @see How Events are Processed
119
150
  # @param handler [Wx::EvtHandler] The event handler to be set as the next handler. Cannot be NULL.
120
151
  # @return [void]
@@ -122,6 +153,7 @@ module Wx
122
153
  alias_method :next_handler=, :set_next_handler
123
154
 
124
155
  # Sets the pointer to the previous handler.
156
+ #
125
157
  # All remarks about {Wx::EvtHandler#set_next_handler} apply to this function as well.
126
158
  # @see How Events are Processed
127
159
  # @param handler [Wx::EvtHandler] The event handler to be set as the previous handler. Cannot be NULL.
@@ -130,6 +162,7 @@ module Wx
130
162
  alias_method :previous_handler=, :set_previous_handler
131
163
 
132
164
  # Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).
165
+ #
133
166
  # E.g. if before calling {Wx::EvtHandler#unlink} you have the following chain:
134
167
  # then after calling <code>B->Wx::EvtHandler#unlink</code> you'll have:
135
168
  # @return [void]
@@ -137,6 +170,7 @@ module Wx
137
170
 
138
171
  # Returns true if the next and the previous handler pointers of this event handler instance are NULL.
139
172
  #
173
+ #
140
174
  # @see Wx::EvtHandler#set_previous_handler
141
175
  # @see Wx::EvtHandler#set_next_handler
142
176
  # @return [Boolean]
@@ -144,12 +178,14 @@ module Wx
144
178
  alias_method :unlinked?, :is_unlinked
145
179
 
146
180
  # Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.
181
+ #
147
182
  # The filters are called in LIFO order and {Wx::App} is registered as an event filter by default. The pointer must remain valid until it's removed with {Wx::EvtHandler.remove_filter} and is not deleted by {Wx::EvtHandler}.
148
183
  # @param filter [Wx::EventFilter,Wx::App]
149
184
  # @return [void]
150
185
  def self.add_filter(filter) end
151
186
 
152
187
  # Remove a filter previously installed with {Wx::EvtHandler.add_filter}.
188
+ #
153
189
  # It's an error to remove a filter that hadn't been previously added or was already removed.
154
190
  # @param filter [Wx::EventFilter,Wx::App]
155
191
  # @return [void]
@@ -163,6 +199,7 @@ module Wx
163
199
  protected
164
200
 
165
201
  # Method called by {Wx::EvtHandler#process_event} before examining this object event tables.
202
+ #
166
203
  # This method can be overridden to hook into the event processing logic as early as possible. You should usually call the base class version when overriding this method, even if {Wx::EvtHandler} itself does nothing here, some derived classes do use this method, e.g. {Wx::Window} implements support for {Wx::Validator} in it.
167
204
  # Example:
168
205
  # ```ruby
@@ -183,6 +220,7 @@ module Wx
183
220
  def try_before(event) end
184
221
 
185
222
  # Method called by {Wx::EvtHandler#process_event} as last resort.
223
+ #
186
224
  # This method can be overridden to implement post-processing for the events which were not processed anywhere else.
187
225
  # The base class version handles forwarding the unprocessed events to {Wx::App} at {Wx::EvtHandler} level and propagating them upwards the window child-parent chain at {Wx::Window} level and so should usually be called when overriding this method:
188
226
  # ```ruby
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # This class implements help via an external browser.
10
+ #
10
11
  # It requires the name of a directory containing the documentation and a file mapping numerical Section numbers to relative URLS.
11
12
  # The map file contains two or three fields per line: numeric_id relative_URL [; comment/documentation]
12
13
  # The numeric_id is the id used to look up the entry in {Wx::ExtHelpController#display_section}/DisplayBlock(). The relative_URL is a filename of an html file, relative to the help directory. The optional comment/documentation field (after a ';') is used for keyword searches, so some meaningful text here does not hurt. If the documentation itself contains a ';', only the part before that will be displayed in the listbox, but all of it used for search.
@@ -24,6 +25,7 @@ module Wx
24
25
  def initialize(parentWindow=nil) end
25
26
 
26
27
  # Tell it which browser to use.
28
+ #
27
29
  # The Netscape support will check whether Netscape is already running (by looking at the .netscape/lock file in the user's home directory) and tell it to load the page into the existing window.
28
30
  # @param viewer [String] The command to call a browser/html viewer.
29
31
  # @param flags [Integer] Set this to {Wx::HELP_NETSCAPE} if the browser is some variant of Netscape.
@@ -32,6 +34,7 @@ module Wx
32
34
  alias_method :viewer=, :set_viewer
33
35
 
34
36
  # This must be called to tell the controller where to find the documentation.
37
+ #
35
38
  # If a locale is set, look in file/localename, i.e. If passed "/usr/local/myapp/help" and the current {Wx::Locale} is set to be "de", then look in "/usr/local/myapp/help/de/" first and fall back to "/usr/local/myapp/help" if that doesn't exist.
36
39
  #
37
40
  # true on success
@@ -40,11 +43,13 @@ module Wx
40
43
  def init(dir) end
41
44
 
42
45
  # Display list of all help entries.
46
+ #
43
47
  # true on success
44
48
  # @return [Boolean]
45
49
  def display_contents; end
46
50
 
47
51
  # Search comment/documentation fields in map file and present a list to chose from.
52
+ #
48
53
  # true on success
49
54
  # @param k [String] string to search for, empty string will list all entries
50
55
  # @param mode [Wx::HelpSearchMode] optional parameter allows the search the index ({Wx::HelpSearchMode::HELP_SEARCH_INDEX}) but this currently only supported by the {Wx::HTML::HtmlHelpController}.
@@ -69,12 +74,14 @@ module Wx
69
74
  def set_frame_parameters(titleFormat, size, pos=Wx::DEFAULT_POSITION, newFrameEachTime=false) end
70
75
 
71
76
  # Displays the section as a popup window using a context id.
77
+ #
72
78
  # Returns false if unsuccessful or not implemented.
73
79
  # @param contextId [Integer]
74
80
  # @return [Boolean]
75
81
  def display_context_popup(contextId) end
76
82
 
77
83
  # Displays the text in a popup window, if possible.
84
+ #
78
85
  # Returns false if unsuccessful or not implemented.
79
86
  # @param text [String]
80
87
  # @param pos [Array(Integer, Integer), Wx::Point]
@@ -82,12 +89,14 @@ module Wx
82
89
  def display_text_popup(text, pos) end
83
90
 
84
91
  # Returns the window to be used as the parent for the help window.
92
+ #
85
93
  # This window is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
86
94
  # @return [Wx::Window]
87
95
  def get_parent_window; end
88
96
  alias_method :parent_window, :get_parent_window
89
97
 
90
98
  # Sets the window to be used as the parent for the help window.
99
+ #
91
100
  # This is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
92
101
  # @param parentWindow [Wx::Window]
93
102
  # @return [void]
@@ -42,6 +42,7 @@ module Wx
42
42
  EVT_FILECTRL_FILTERCHANGED = 10176
43
43
 
44
44
  # This control allows the user to select a file.
45
+ #
45
46
  # Two implementations of this class exist, one for Gtk and another generic one for all the other ports.
46
47
  # This class is only available if {Wx::Setup::USE_FILECTRL} is set to 1.
47
48
  # ### Styles
@@ -99,6 +100,7 @@ module Wx
99
100
  def initialize(*args) end
100
101
 
101
102
  # Create function for two-step construction.
103
+ #
102
104
  # See {Wx::FileCtrl#initialize} for details.
103
105
  # true if the control was successfully created or false if creation failed.
104
106
  # @param parent [Wx::Window]
@@ -119,19 +121,21 @@ module Wx
119
121
  alias_method :directory, :get_directory
120
122
 
121
123
  # Returns the currently selected filename.
124
+ #
122
125
  # For the controls having the {Wx::FC_MULTIPLE} style, use {Wx::FileCtrl#get_filenames} instead.
123
126
  # @return [String]
124
127
  def get_filename; end
125
128
  alias_method :filename, :get_filename
126
129
 
127
130
  # Fills the array filenames with the filenames only of selected items.
131
+ #
128
132
  # This function should only be used with the controls having the {Wx::FC_MULTIPLE} style, use {Wx::FileCtrl#get_filename} for the others.
129
133
  #
130
134
  # <div class="wxrb-remark">
131
135
  # <b>Remark:</b>
132
136
  # <p>filenames is emptied first.
133
137
  # </p>
134
- # </div>>
138
+ # </div>
135
139
  # @return [Array<String>]
136
140
  def get_filenames; end
137
141
  alias_method :filenames, :get_filenames
@@ -142,19 +146,21 @@ module Wx
142
146
  alias_method :filter_index, :get_filter_index
143
147
 
144
148
  # Returns the full path (directory and filename) of the currently selected file.
149
+ #
145
150
  # For the controls having the {Wx::FC_MULTIPLE} style, use {Wx::FileCtrl#get_paths} instead.
146
151
  # @return [String]
147
152
  def get_path; end
148
153
  alias_method :path, :get_path
149
154
 
150
155
  # Fills the array paths with the full paths of the files chosen.
156
+ #
151
157
  # This function should be used with the controls having the {Wx::FC_MULTIPLE} style, use {Wx::FileCtrl#get_path} otherwise.
152
158
  #
153
159
  # <div class="wxrb-remark">
154
160
  # <b>Remark:</b>
155
161
  # <p>paths is emptied first.
156
162
  # </p>
157
- # </div>>
163
+ # </div>
158
164
  # @return [Array<String>]
159
165
  def get_paths; end
160
166
  alias_method :paths, :get_paths
@@ -165,6 +171,7 @@ module Wx
165
171
  alias_method :wildcard, :get_wildcard
166
172
 
167
173
  # Sets(changes) the current directory displayed in the control.
174
+ #
168
175
  # Returns true on success, false otherwise.
169
176
  # @param directory [String]
170
177
  # @return [Boolean]
@@ -172,6 +179,7 @@ module Wx
172
179
  alias_method :directory=, :set_directory
173
180
 
174
181
  # Selects a certain file.
182
+ #
175
183
  # Returns true on success, false otherwise
176
184
  # @param filename [String]
177
185
  # @return [Boolean]
@@ -179,6 +187,7 @@ module Wx
179
187
  alias_method :filename=, :set_filename
180
188
 
181
189
  # Changes to a certain directory and selects a certain file.
190
+ #
182
191
  # If path includes the directory part, it must exist, otherwise false is returned and nothing else is done.
183
192
  # Returns true on success, false otherwise
184
193
  # @param path [String]
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # A file control event holds information about events associated with {Wx::FileCtrl} objects.
10
+ #
10
11
  # ### Events using this class
11
12
  #
12
13
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FileCtrlEvent} events.
@@ -26,13 +27,14 @@ module Wx
26
27
  class FileCtrlEvent < CommandEvent
27
28
 
28
29
  # Constructor.
29
- # @param type [Wx::Slider::EventType]
30
+ # @param type [Wx::StaticLine::EventType]
30
31
  # @param evtObject [Wx::Object]
31
32
  # @param id [Integer]
32
33
  # @return [Wx::FileCtrlEvent]
33
34
  def initialize(type, evtObject, id) end
34
35
 
35
36
  # Returns the current directory.
37
+ #
36
38
  # In case of a <b>EVT_FILECTRL_FOLDERCHANGED</b>, this method returns the new directory.
37
39
  # @return [String]
38
40
  def get_directory; end
@@ -44,12 +46,14 @@ module Wx
44
46
  alias_method :file, :get_file
45
47
 
46
48
  # Returns the files selected.
49
+ #
47
50
  # In case of a <b>EVT_FILECTRL_SELECTIONCHANGED</b>, this method returns the files selected after the event.
48
51
  # @return [Array<String>]
49
52
  def get_files; end
50
53
  alias_method :files, :get_files
51
54
 
52
55
  # Returns the current file filter index.
56
+ #
53
57
  # For a <b>EVT_FILECTRL_FILTERCHANGED</b> event, this method returns the new file filter index.
54
58
  # @return [Integer]
55
59
  def get_filter_index; end
@@ -50,6 +50,7 @@ module Wx
50
50
  FILE_SELECTOR_DEFAULT_WILDCARD_STR = "*.*"
51
51
 
52
52
  # This class represents the file chooser dialog.
53
+ #
53
54
  # The path and filename are distinct elements of a full file pathname. If path is {Wx::EmptyString}, the current directory will be used. If filename is {Wx::EmptyString}, no default filename will be supplied. The wildcard determines what files are displayed in the file selector, and file extension supplies a type extension for the required filename.
54
55
  # The typical usage for the open file dialog is:
55
56
  # ```ruby
@@ -164,6 +165,7 @@ module Wx
164
165
  class FileDialog < Dialog
165
166
 
166
167
  # Constructor.
168
+ #
167
169
  # Use {Wx::FileDialog#show_modal} to show the dialog.
168
170
  # @param parent [Wx::Window] Parent window.
169
171
  # @param message [String] Message to show on the dialog.
@@ -178,6 +180,7 @@ module Wx
178
180
  def initialize(parent, message=Wx::FILE_SELECTOR_PROMPT_STR, defaultDir=(''), defaultFile=(''), wildcard=Wx::FILE_SELECTOR_DEFAULT_WILDCARD_STR, style=Wx::FD_DEFAULT_STYLE, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, name=Wx::FILE_DIALOG_NAME_STR) end
179
181
 
180
182
  # Returns the path of the file currently selected in dialog.
183
+ #
181
184
  # Notice that this file is not necessarily going to be accepted by the user, so calling this function mostly makes sense from an update UI event handler of a custom file dialog extra control to update its state depending on the currently selected file.
182
185
  # Currently this function is fully implemented under GTK and MSW and always returns an empty string elsewhere.
183
186
  #
@@ -188,6 +191,7 @@ module Wx
188
191
  alias_method :currently_selected_filename, :get_currently_selected_filename
189
192
 
190
193
  # Returns the file type filter index currently selected in dialog.
194
+ #
191
195
  # Notice that this file type filter is not necessarily going to be the one finally accepted by the user, so calling this function mostly makes sense from an update UI event handler of a custom file dialog extra control to update its state depending on the currently selected file type filter.
192
196
  # Currently this function is fully implemented under macOS and MSW and always returns {Wx::NOT_FOUND} elsewhere.
193
197
  #
@@ -207,12 +211,14 @@ module Wx
207
211
  alias_method :directory, :get_directory
208
212
 
209
213
  # If functions {Wx::FileDialog#set_extra_control_creator} and {Wx::FileDialog#show_modal} were called, returns the extra window.
214
+ #
210
215
  # Otherwise returns NULL.
211
216
  # @return [Wx::Window]
212
217
  def get_extra_control; end
213
218
  alias_method :extra_control, :get_extra_control
214
219
 
215
220
  # Returns the default filename.
221
+ #
216
222
  # <div class="wxrb-note">
217
223
  # <b>Note:</b>
218
224
  # <p>This function can't be used with dialogs which have the {Wx::FD_MULTIPLE} style, use {Wx::FileDialog#get_filenames} instead.
@@ -223,6 +229,7 @@ module Wx
223
229
  alias_method :filename, :get_filename
224
230
 
225
231
  # Fills the array filenames with the names of the files chosen.
232
+ #
226
233
  # This function should only be used with the dialogs which have {Wx::FD_MULTIPLE} style, use {Wx::FileDialog#get_filename} for the others.
227
234
  # Note that under Windows, if the user selects shortcuts, the filenames include paths, since the application cannot determine the full path of each referenced file by appending the directory containing the shortcuts to the filename.
228
235
  # @return [Array<String>]
@@ -230,6 +237,7 @@ module Wx
230
237
  alias_method :filenames, :get_filenames
231
238
 
232
239
  # Returns the index into the list of filters supplied, optionally, in the wildcard parameter.
240
+ #
233
241
  # Before the dialog is shown, this is the index which will be used when the dialog is first displayed.
234
242
  # After the dialog is shown, this is the index selected by the user.
235
243
  # @return [Integer]
@@ -242,6 +250,7 @@ module Wx
242
250
  alias_method :message, :get_message
243
251
 
244
252
  # Returns the full path (directory and filename) of the selected file.
253
+ #
245
254
  # <div class="wxrb-note">
246
255
  # <b>Note:</b>
247
256
  # <p>This function can't be used with dialogs which have the {Wx::FD_MULTIPLE} style, use {Wx::FileDialog#get_paths} instead.
@@ -252,6 +261,7 @@ module Wx
252
261
  alias_method :path, :get_path
253
262
 
254
263
  # Fills the array paths with the full paths of the files chosen.
264
+ #
255
265
  # This function should only be used with the dialogs which have {Wx::FD_MULTIPLE} style, use {Wx::FileDialog#get_path} for the others.
256
266
  # @return [Array<String>]
257
267
  def get_paths; end
@@ -263,6 +273,7 @@ module Wx
263
273
  alias_method :wildcard, :get_wildcard
264
274
 
265
275
  # Set the hook to be used for customizing the dialog contents.
276
+ #
266
277
  # This function can be called before calling {Wx::FileDialog#show_modal} to specify that the dialog contents should be customized using the provided hook. See {Wx::FileDialogCustomizeHook} documentation and Dialogs Sample for the examples of using it.
267
278
  #
268
279
  # <div class="wxrb-note">
@@ -284,6 +295,7 @@ module Wx
284
295
  alias_method :directory=, :set_directory
285
296
 
286
297
  # Sets the default filename.
298
+ #
287
299
  # In WXGTK this will have little effect unless a default directory has previously been set.
288
300
  # @param setfilename [String]
289
301
  # @return [void]
@@ -309,6 +321,7 @@ module Wx
309
321
  alias_method :path=, :set_path
310
322
 
311
323
  # Sets the wildcard, which can contain multiple file types, for example: "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".
324
+ #
312
325
  # Note that the native Motif dialog has some limitations with respect to wildcards; see the Remarks section above.
313
326
  # @param wildCard [String]
314
327
  # @return [void]
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # The base class for all {Wx::FileDialog} custom controls.
10
+ #
10
11
  # Unlike normal controls, inheriting from {Wx::Window}, custom controls in {Wx::FileDialog} are not actual windows, but they do provide some window-like operations, and can be disabled or hidden, just as the windows are.
11
12
  # Also, similarly to the normal windows, objects of this and derived classes belong to wxWidgets and must not be deleted by the application code.
12
13
  # Unlike windows, custom controls cannot be created directly, but can only be returned from {Wx::FileDialogCustomize} functions that are specifically provided for creating them.
@@ -20,6 +21,7 @@ module Wx
20
21
  def show(show=true) end
21
22
 
22
23
  # Hide this control.
24
+ #
23
25
  # This is equivalent to <code>Show(false)</code>.
24
26
  # @return [void]
25
27
  def hide; end
@@ -30,6 +32,7 @@ module Wx
30
32
  def enable(enable=true) end
31
33
 
32
34
  # Disable this control.
35
+ #
33
36
  # This is equivalent to <code>Enable(false)</code>.
34
37
  # @return [void]
35
38
  def disable; end
@@ -37,6 +40,7 @@ module Wx
37
40
  end # FileDialogCustomControl
38
41
 
39
42
  # Represents a custom button inside {Wx::FileDialog}.
43
+ #
40
44
  # Objects of this class can only be created by {Wx::FileDialogCustomize#add_button}.
41
45
  # It is possible to bind to {Wx::EVT_BUTTON} events on this object, which will be generated when the button is clicked.
42
46
  # See {Wx::FileDialogCustomControl} for more information.
@@ -47,6 +51,7 @@ module Wx
47
51
  end # FileDialogButton
48
52
 
49
53
  # Represents a custom checkbox inside {Wx::FileDialog}.
54
+ #
50
55
  # Objects of this class can only be created by {Wx::FileDialogCustomize#add_check_box}.
51
56
  # It is possible to bind to {Wx::EVT_CHECKBOX} events on this object, which will be generated when the checkbox is clicked.
52
57
  # See {Wx::FileDialogCustomControl} for more information.
@@ -68,6 +73,7 @@ module Wx
68
73
  end # FileDialogCheckBox
69
74
 
70
75
  # Represents a custom radio button inside {Wx::FileDialog}.
76
+ #
71
77
  # Objects of this class can only be created by {Wx::FileDialogCustomize#add_radio_button}.
72
78
  # It is possible to bind to {Wx::EVT_RADIOBUTTON} events on this object, which will be generated when the radio button is selected.
73
79
  # See {Wx::FileDialogCustomControl} for more information.
@@ -81,6 +87,7 @@ module Wx
81
87
  alias_method :value, :get_value
82
88
 
83
89
  # Select the value of the radio button.
90
+ #
84
91
  # Using false for value is not supported, this argument only exists for consistency with {Wx::RadioButton#set_value}.
85
92
  # @param value [Boolean]
86
93
  # @return [void]
@@ -90,6 +97,7 @@ module Wx
90
97
  end # FileDialogRadioButton
91
98
 
92
99
  # Represents a custom read-only combobox inside {Wx::FileDialog}.
100
+ #
93
101
  # Objects of this class can only be created by {Wx::FileDialogCustomize#add_choice}.
94
102
  # It is possible to bind to {Wx::EVT_CHOICE} events on this object, which will be generated when the selection in the combobox changes.
95
103
  # See {Wx::FileDialogCustomControl} for more information.
@@ -103,6 +111,7 @@ module Wx
103
111
  alias_method :selection, :get_selection
104
112
 
105
113
  # Set the selection to the item with the given index.
114
+ #
106
115
  # Using {Wx::NOT_FOUND} for n is not supported, once a selection is made it cannot be undone.
107
116
  # @param n [Integer]
108
117
  # @return [void]
@@ -112,6 +121,7 @@ module Wx
112
121
  end # FileDialogChoice
113
122
 
114
123
  # Represents a custom text control inside {Wx::FileDialog}.
124
+ #
115
125
  # Objects of this class can only be created by {Wx::FileDialogCustomize#add_text_ctrl}.
116
126
  # Objects of this class don't generate any events currently.
117
127
  # See {Wx::FileDialogCustomControl} for more information.
@@ -133,6 +143,7 @@ module Wx
133
143
  end # FileDialogTextCtrl
134
144
 
135
145
  # Represents a custom static text inside {Wx::FileDialog}.
146
+ #
136
147
  # Objects of this class can only be created by {Wx::FileDialogCustomize#add_static_text}.
137
148
  # Objects of this class don't generate any events.
138
149
  # See {Wx::FileDialogCustomControl} for more information.
@@ -141,6 +152,7 @@ module Wx
141
152
  class FileDialogStaticText < FileDialogCustomControl
142
153
 
143
154
  # Set the text shown in the label.
155
+ #
144
156
  # Any ampersands in the text will be escaped, there is no need to do it manually, e.g. using {Wx::Control.escape_mnemonics}.
145
157
  # @param text [String]
146
158
  # @return [void]
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # Base class for customization hooks used with {Wx::FileDialog}.
10
+ #
10
11
  # {Wx::FileDialogCustomizeHook} is an abstract base class, i.e. in order to use a concrete class inheriting from it and implementing its pure virtual {Wx::FileDialogCustomizeHook#add_custom_controls} function must be defined. Then an object of this class should be passed to {Wx::FileDialog#set_customize_hook}, which will result in its {Wx::FileDialogCustomizeHook#add_custom_controls} being called before the dialog is shown, {Wx::FileDialogCustomizeHook#update_custom_controls} being called whenever something changes in the dialog while it is shown and, finally, {Wx::FileDialogCustomizeHook#transfer_data_from_custom_controls} being called when the user accepts their choice in the dialog.
11
12
  # Putting all this together, here is an example of customizing the file dialog using this class:
12
13
  # ```
@@ -82,6 +83,7 @@ module Wx
82
83
  class FileDialogCustomizeHook < ::Object
83
84
 
84
85
  # Must be overridden to add custom controls to the dialog using the provided customizer object.
86
+ #
85
87
  # Call {Wx::FileDialogCustomize} functions to add controls and possibly bind to their events.
86
88
  # Note that there is no possibility to define the custom controls layout, they will appear more or less consecutively, but the exact layout is determined by the current platform.
87
89
  # @param customizer [Wx::FileDialogCustomize]
@@ -89,6 +91,7 @@ module Wx
89
91
  def add_custom_controls(customizer) end
90
92
 
91
93
  # May be overridden to update the custom controls whenever something changes in the dialog.
94
+ #
92
95
  # This function is called when the user selects a file, changes the directory or changes the current filter in the dialog, for example. It can be used to update the custom controls state depending on the currently selected file, for example.
93
96
  # Note that it is not necessarily called when the value of a custom control changes.
94
97
  # Base class version does nothing.
@@ -96,6 +99,7 @@ module Wx
96
99
  def update_custom_controls; end
97
100
 
98
101
  # Should typically be overridden to save the values of the custom controls when the dialog is accepted.
102
+ #
99
103
  # Custom controls are destroyed and cannot be used any longer once {Wx::FileDialog#show_modal} returns, so their values must be retrieved in this function, which is called just before this happens.
100
104
  # This function is not called if the user cancels the dialog.
101
105
  # Base class version does nothing.
@@ -105,6 +109,7 @@ module Wx
105
109
  end # FileDialogCustomizeHook
106
110
 
107
111
  # Used with {Wx::FileDialogCustomizeHook} to add custom controls to {Wx::FileDialog}.
112
+ #
108
113
  # An object of this class is passed to {Wx::FileDialogCustomizeHook#add_custom_controls} to allow it to actually add controls to the dialog.
109
114
  # The pointers returned by the functions of this class belong to wxWidgets and should not be deleted by the application, just as {Wx::Window}-derived objects (even if these controls do not inherit from {Wx::Window}). These pointers become invalid when {Wx::FileDialog#show_modal} returns, and the dialog containing them is destroyed, and the latest point at which they can be still used is when {Wx::FileDialogCustomizeHook#transfer_data_from_custom_controls} is called.
110
115
  #
@@ -126,6 +131,7 @@ module Wx
126
131
  def add_check_box(label) end
127
132
 
128
133
  # Add a radio button with the specified label.
134
+ #
129
135
  # The first radio button added will be initially checked. All the radio buttons added immediately after it will become part of the same radio group and will not be checked, but checking any one of them later will uncheck the first button and all the other ones.
130
136
  # If two consecutive but distinct radio groups are required, {Wx::FileDialogCustomize#add_static_text} with an empty label can be used to separate them.
131
137
  # @param label [String]
@@ -133,6 +139,7 @@ module Wx
133
139
  def add_radio_button(label) end
134
140
 
135
141
  # Add a read-only combobox with the specified contents.
142
+ #
136
143
  # The combobox doesn't have any initial selection, i.e. {Wx::FileDialogChoice#get_selection} returns {Wx::NOT_FOUND}, if some item must be selected, use {Wx::FileDialogChoice#set_selection} explicitly to do it.
137
144
  # @param n [Integer] The number of strings, must be positive, as there is no way to add more strings later and creating an empty combobox is not very useful.
138
145
  # @param strings [String] A non-NULL pointer to an array of n strings.
@@ -140,6 +147,7 @@ module Wx
140
147
  def add_choice(n, strings) end
141
148
 
142
149
  # Add a text control with an optional label preceding it.
150
+ #
143
151
  # Unlike all the other functions for adding controls, the label parameter here doesn't specify the contents of the text control itself, but rather the label appearing before it. Unlike static controls added by {Wx::FileDialogCustomize#add_static_text}, this label is guaranteed to be immediately adjacent to it.
144
152
  # If label is empty, no label is created.
145
153
  # @param label [String]
@@ -147,6 +155,7 @@ module Wx
147
155
  def add_text_ctrl(label=(())) end
148
156
 
149
157
  # Add a static text with the given contents.
158
+ #
150
159
  # The contents of the static text can be updated later, i.e. it doesn't need to be actually static.
151
160
  # @param label [String]
152
161
  # @return [Wx::FileDialogStaticText]
@@ -54,6 +54,7 @@ module Wx
54
54
  EVT_DIRPICKER_CHANGED = 10172
55
55
 
56
56
  # This event class is used for the events generated by {Wx::FilePickerCtrl} and by {Wx::DirPickerCtrl}.
57
+ #
57
58
  # ### Events using this class
58
59
  #
59
60
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FileDirPickerEvent} events.
@@ -75,7 +76,7 @@ module Wx
75
76
  # @return [Wx::FileDirPickerEvent]
76
77
  # @overload initialize(type, generator, id, path)
77
78
  # The constructor is not normally used by the user code.
78
- # @param type [Wx::Slider::EventType]
79
+ # @param type [Wx::StaticLine::EventType]
79
80
  # @param generator [Wx::Object]
80
81
  # @param id [Integer]
81
82
  # @param path [String]