wxruby3 0.9.1-x64-mingw-ucrt → 0.9.2-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (455) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -0
  3. data/ext/wxbase32u_gcc_custom.dll +0 -0
  4. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  5. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  6. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  7. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  18. data/lib/wx/aui/aui_tab_ctrl.rb +18 -0
  19. data/lib/wx/aui/auinotebook.rb +6 -2
  20. data/lib/wx/aui/require.rb +1 -0
  21. data/lib/wx/core/app.rb +2 -2
  22. data/lib/wx/core/collapsible_pane.rb +1 -1
  23. data/lib/wx/core/controlwithitems.rb +8 -6
  24. data/lib/wx/core/menu.rb +10 -0
  25. data/lib/wx/core/notebook.rb +6 -2
  26. data/lib/wx/core/sizer.rb +11 -0
  27. data/lib/wx/core/task_bar_button.rb +19 -0
  28. data/lib/wx/core/textctrl.rb +11 -1
  29. data/lib/wx/core/{treectrl.rb → tree_ctrl.rb} +31 -12
  30. data/lib/wx/core/window.rb +10 -0
  31. data/lib/wx/doc/app.rb +48 -38
  32. data/lib/wx/doc/art_locator.rb +47 -43
  33. data/lib/wx/doc/aui/auimanager.rb +16 -8
  34. data/lib/wx/doc/aui/auinotebook.rb +20 -5
  35. data/lib/wx/doc/clipboard.rb +11 -7
  36. data/lib/wx/doc/colour_dialog.rb +14 -10
  37. data/lib/wx/doc/controlwithitems.rb +17 -7
  38. data/lib/wx/doc/data_object.rb +2 -2
  39. data/lib/wx/doc/evthandler.rb +113 -108
  40. data/lib/wx/doc/font.rb +1 -0
  41. data/lib/wx/doc/gc_dc.rb +6 -1
  42. data/lib/wx/doc/gen/about_dialog_info.rb +1 -2
  43. data/lib/wx/doc/gen/accelerator.rb +14 -5
  44. data/lib/wx/doc/gen/accessible.rb +35 -47
  45. data/lib/wx/doc/gen/activity_indicator.rb +4 -5
  46. data/lib/wx/doc/gen/animation.rb +7 -3
  47. data/lib/wx/doc/gen/animation_ctrl.rb +6 -7
  48. data/lib/wx/doc/gen/any_button.rb +6 -1
  49. data/lib/wx/doc/gen/app.rb +7 -5
  50. data/lib/wx/doc/gen/app_traits.rb +27 -10
  51. data/lib/wx/doc/gen/art_provider.rb +19 -7
  52. data/lib/wx/doc/gen/aui/aui_dock_art.rb +6 -3
  53. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +1 -0
  54. data/lib/wx/doc/gen/aui/aui_manager.rb +11 -7
  55. data/lib/wx/doc/gen/aui/aui_manager_event.rb +3 -4
  56. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +1 -0
  57. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +1 -0
  58. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +6 -1
  59. data/lib/wx/doc/gen/aui/aui_notebook.rb +14 -8
  60. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +4 -4
  61. data/lib/wx/doc/gen/aui/aui_pane_info.rb +9 -2
  62. data/lib/wx/doc/gen/aui/aui_tab_art.rb +3 -3
  63. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +2 -2
  64. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +9 -6
  65. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +2 -2
  66. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +5 -8
  67. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +1 -1
  68. data/lib/wx/doc/gen/aui/event_list.rb +164 -160
  69. data/lib/wx/doc/gen/banner_window.rb +1 -1
  70. data/lib/wx/doc/gen/bitmap.rb +33 -16
  71. data/lib/wx/doc/gen/bitmap_button.rb +11 -8
  72. data/lib/wx/doc/gen/bitmap_combo_box.rb +12 -8
  73. data/lib/wx/doc/gen/book_ctrl_base.rb +16 -4
  74. data/lib/wx/doc/gen/book_ctrl_event.rb +7 -3
  75. data/lib/wx/doc/gen/box_sizer.rb +0 -1
  76. data/lib/wx/doc/gen/brush.rb +5 -2
  77. data/lib/wx/doc/gen/busy_info.rb +2 -2
  78. data/lib/wx/doc/gen/button.rb +23 -11
  79. data/lib/wx/doc/gen/calculate_layout_event.rb +1 -3
  80. data/lib/wx/doc/gen/calendar_ctrl.rb +16 -13
  81. data/lib/wx/doc/gen/calendar_date_attr.rb +1 -1
  82. data/lib/wx/doc/gen/calendar_event.rb +4 -3
  83. data/lib/wx/doc/gen/caret.rb +0 -1
  84. data/lib/wx/doc/gen/check_box.rb +7 -7
  85. data/lib/wx/doc/gen/check_list_box.rb +5 -6
  86. data/lib/wx/doc/gen/choice.rb +16 -9
  87. data/lib/wx/doc/gen/choicebook.rb +6 -7
  88. data/lib/wx/doc/gen/client_dc.rb +5 -2
  89. data/lib/wx/doc/gen/clipboard.rb +7 -3
  90. data/lib/wx/doc/gen/collapsible_pane.rb +6 -7
  91. data/lib/wx/doc/gen/collapsible_pane_event.rb +2 -3
  92. data/lib/wx/doc/gen/colour.rb +8 -4
  93. data/lib/wx/doc/gen/colour_dialog.rb +6 -8
  94. data/lib/wx/doc/gen/colour_picker_ctrl.rb +9 -10
  95. data/lib/wx/doc/gen/colour_picker_event.rb +4 -5
  96. data/lib/wx/doc/gen/combo_box.rb +16 -13
  97. data/lib/wx/doc/gen/combo_ctrl.rb +95 -32
  98. data/lib/wx/doc/gen/command_link_button.rb +4 -5
  99. data/lib/wx/doc/gen/context_help_button.rb +7 -3
  100. data/lib/wx/doc/gen/control.rb +10 -8
  101. data/lib/wx/doc/gen/control_with_items.rb +0 -1
  102. data/lib/wx/doc/gen/core.rb +4 -4
  103. data/lib/wx/doc/gen/cursor.rb +6 -8
  104. data/lib/wx/doc/gen/data_format.rb +6 -1
  105. data/lib/wx/doc/gen/data_object.rb +15 -13
  106. data/lib/wx/doc/gen/date_event.rb +2 -2
  107. data/lib/wx/doc/gen/date_picker_ctrl.rb +12 -8
  108. data/lib/wx/doc/gen/dc.rb +155 -37
  109. data/lib/wx/doc/gen/defs.rb +51 -51
  110. data/lib/wx/doc/gen/dial_up_event.rb +1 -2
  111. data/lib/wx/doc/gen/dial_up_manager.rb +13 -5
  112. data/lib/wx/doc/gen/dialog.rb +33 -13
  113. data/lib/wx/doc/gen/dir_dialog.rb +17 -5
  114. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -0
  115. data/lib/wx/doc/gen/dir_picker_ctrl.rb +9 -10
  116. data/lib/wx/doc/gen/drag_drop.rb +11 -10
  117. data/lib/wx/doc/gen/drag_image.rb +6 -2
  118. data/lib/wx/doc/gen/editable_list_box.rb +2 -2
  119. data/lib/wx/doc/gen/event.rb +35 -19
  120. data/lib/wx/doc/gen/event_blocker.rb +1 -3
  121. data/lib/wx/doc/gen/event_list.rb +1656 -1652
  122. data/lib/wx/doc/gen/events.rb +162 -169
  123. data/lib/wx/doc/gen/evt_handler.rb +11 -3
  124. data/lib/wx/doc/gen/ext_help_controller.rb +1 -1
  125. data/lib/wx/doc/gen/file_ctrl.rb +19 -10
  126. data/lib/wx/doc/gen/file_ctrl_event.rb +3 -4
  127. data/lib/wx/doc/gen/file_dialog.rb +31 -14
  128. data/lib/wx/doc/gen/file_dialog_custom_control.rb +7 -0
  129. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +2 -3
  130. data/lib/wx/doc/gen/file_dir_picker_event.rb +3 -4
  131. data/lib/wx/doc/gen/file_picker_ctrl.rb +8 -9
  132. data/lib/wx/doc/gen/file_system.rb +38 -15
  133. data/lib/wx/doc/gen/find_dialog_event.rb +5 -4
  134. data/lib/wx/doc/gen/find_replace_data.rb +1 -1
  135. data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
  136. data/lib/wx/doc/gen/flex_grid_sizer.rb +0 -1
  137. data/lib/wx/doc/gen/font.rb +31 -20
  138. data/lib/wx/doc/gen/font_data.rb +3 -4
  139. data/lib/wx/doc/gen/font_dialog.rb +1 -2
  140. data/lib/wx/doc/gen/font_picker_ctrl.rb +6 -7
  141. data/lib/wx/doc/gen/font_picker_event.rb +2 -3
  142. data/lib/wx/doc/gen/frame.rb +56 -15
  143. data/lib/wx/doc/gen/fs_file.rb +17 -10
  144. data/lib/wx/doc/gen/gauge.rb +11 -8
  145. data/lib/wx/doc/gen/gb_sizer_item.rb +0 -1
  146. data/lib/wx/doc/gen/gcdc.rb +1 -2
  147. data/lib/wx/doc/gen/gdi_common.rb +30 -11
  148. data/lib/wx/doc/gen/gdi_object.rb +0 -1
  149. data/lib/wx/doc/gen/generic_dir_ctrl.rb +6 -7
  150. data/lib/wx/doc/gen/graphics_context.rb +58 -11
  151. data/lib/wx/doc/gen/graphics_object.rb +11 -6
  152. data/lib/wx/doc/gen/grid/event_list.rb +168 -164
  153. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +1 -0
  154. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +2 -1
  155. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -2
  156. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +1 -1
  157. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +1 -2
  158. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -2
  159. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +1 -2
  160. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +1 -1
  161. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +1 -1
  162. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +1 -1
  163. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +1 -1
  164. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +1 -1
  165. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +1 -1
  166. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -2
  167. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +1 -2
  168. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +1 -2
  169. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -2
  170. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +1 -1
  171. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -2
  172. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -2
  173. data/lib/wx/doc/gen/grid/grid_ctrl.rb +27 -5
  174. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +3 -4
  175. data/lib/wx/doc/gen/grid/grid_event.rb +3 -4
  176. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +3 -4
  177. data/lib/wx/doc/gen/grid/grid_size_event.rb +3 -4
  178. data/lib/wx/doc/gen/grid/grid_string_table.rb +1 -0
  179. data/lib/wx/doc/gen/grid/grid_table_base.rb +1 -2
  180. data/lib/wx/doc/gen/grid/grid_table_message.rb +1 -0
  181. data/lib/wx/doc/gen/grid_bag_sizer.rb +0 -6
  182. data/lib/wx/doc/gen/grid_sizer.rb +0 -1
  183. data/lib/wx/doc/gen/gui_event_loop.rb +2 -4
  184. data/lib/wx/doc/gen/header_ctrl.rb +4 -11
  185. data/lib/wx/doc/gen/header_ctrl_event.rb +1 -3
  186. data/lib/wx/doc/gen/help_controller.rb +3 -3
  187. data/lib/wx/doc/gen/help_provider.rb +12 -3
  188. data/lib/wx/doc/gen/html/event_list.rb +41 -37
  189. data/lib/wx/doc/gen/html/html_cell.rb +23 -6
  190. data/lib/wx/doc/gen/html/html_cell_event.rb +3 -4
  191. data/lib/wx/doc/gen/html/html_easy_printing.rb +7 -2
  192. data/lib/wx/doc/gen/html/html_help_controller.rb +8 -2
  193. data/lib/wx/doc/gen/html/html_help_data.rb +3 -1
  194. data/lib/wx/doc/gen/html/html_help_window.rb +1 -1
  195. data/lib/wx/doc/gen/html/html_link_event.rb +2 -3
  196. data/lib/wx/doc/gen/html/html_list_box.rb +5 -7
  197. data/lib/wx/doc/gen/html/html_printout.rb +1 -2
  198. data/lib/wx/doc/gen/html/html_window.rb +12 -6
  199. data/lib/wx/doc/gen/hyperlink_ctrl.rb +7 -7
  200. data/lib/wx/doc/gen/hyperlink_event.rb +2 -3
  201. data/lib/wx/doc/gen/icon.rb +5 -29
  202. data/lib/wx/doc/gen/icon_location.rb +0 -1
  203. data/lib/wx/doc/gen/image.rb +83 -17
  204. data/lib/wx/doc/gen/image_list.rb +15 -6
  205. data/lib/wx/doc/gen/info_bar.rb +2 -2
  206. data/lib/wx/doc/gen/keyboard_state.rb +0 -1
  207. data/lib/wx/doc/gen/list_box.rb +29 -17
  208. data/lib/wx/doc/gen/list_ctrl.rb +76 -29
  209. data/lib/wx/doc/gen/list_event.rb +3 -4
  210. data/lib/wx/doc/gen/listbook.rb +6 -7
  211. data/lib/wx/doc/gen/locale.rb +46 -4
  212. data/lib/wx/doc/gen/log.rb +16 -12
  213. data/lib/wx/doc/gen/mdi_client_window.rb +8 -2
  214. data/lib/wx/doc/gen/mdi_frame.rb +28 -7
  215. data/lib/wx/doc/gen/media_ctrl.rb +26 -18
  216. data/lib/wx/doc/gen/media_event.rb +5 -4
  217. data/lib/wx/doc/gen/memory_dc.rb +6 -6
  218. data/lib/wx/doc/gen/menu.rb +37 -23
  219. data/lib/wx/doc/gen/menu_bar.rb +52 -12
  220. data/lib/wx/doc/gen/menu_item.rb +41 -19
  221. data/lib/wx/doc/gen/message_dialog.rb +7 -8
  222. data/lib/wx/doc/gen/mini_frame.rb +11 -5
  223. data/lib/wx/doc/gen/mirror_dc.rb +0 -2
  224. data/lib/wx/doc/gen/mouse_state.rb +0 -1
  225. data/lib/wx/doc/gen/multi_choice_dialog.rb +7 -4
  226. data/lib/wx/doc/gen/non_owned_window.rb +1 -1
  227. data/lib/wx/doc/gen/notebook.rb +17 -9
  228. data/lib/wx/doc/gen/number_entry_dialog.rb +1 -1
  229. data/lib/wx/doc/gen/object.rb +0 -1
  230. data/lib/wx/doc/gen/paint_dc.rb +0 -1
  231. data/lib/wx/doc/gen/palette.rb +0 -1
  232. data/lib/wx/doc/gen/panel.rb +17 -8
  233. data/lib/wx/doc/gen/pen.rb +17 -8
  234. data/lib/wx/doc/gen/pg/event_list.rb +97 -93
  235. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +2 -0
  236. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +9 -1
  237. data/lib/wx/doc/gen/pg/pg_cell.rb +8 -5
  238. data/lib/wx/doc/gen/pg/pg_editor.rb +115 -16
  239. data/lib/wx/doc/gen/pg/pg_multi_button.rb +1 -2
  240. data/lib/wx/doc/gen/pg/pg_properties.rb +515 -83
  241. data/lib/wx/doc/gen/pg/pg_property.rb +296 -69
  242. data/lib/wx/doc/gen/pg/pg_validation_info.rb +9 -4
  243. data/lib/wx/doc/gen/pg/property_grid.rb +81 -20
  244. data/lib/wx/doc/gen/pg/property_grid_event.rb +31 -9
  245. data/lib/wx/doc/gen/pg/property_grid_interface.rb +214 -36
  246. data/lib/wx/doc/gen/pg/property_grid_manager.rb +40 -10
  247. data/lib/wx/doc/gen/pg/property_grid_page.rb +26 -8
  248. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +13 -4
  249. data/lib/wx/doc/gen/picker_base.rb +12 -5
  250. data/lib/wx/doc/gen/platform_info.rb +4 -9
  251. data/lib/wx/doc/gen/popup_window.rb +2 -5
  252. data/lib/wx/doc/gen/progress_dialog.rb +1 -0
  253. data/lib/wx/doc/gen/property_sheet_dialog.rb +13 -3
  254. data/lib/wx/doc/gen/prt/event_list.rb +8 -4
  255. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +1 -1
  256. data/lib/wx/doc/gen/prt/post_script_dc.rb +2 -2
  257. data/lib/wx/doc/gen/prt/preview_frame.rb +1 -1
  258. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +3 -0
  259. data/lib/wx/doc/gen/prt/print_data.rb +4 -3
  260. data/lib/wx/doc/gen/prt/print_dialog.rb +1 -1
  261. data/lib/wx/doc/gen/prt/printer.rb +50 -11
  262. data/lib/wx/doc/gen/prt/printer_dc.rb +1 -1
  263. data/lib/wx/doc/gen/query_layout_info_event.rb +1 -3
  264. data/lib/wx/doc/gen/radio_box.rb +9 -10
  265. data/lib/wx/doc/gen/radio_button.rb +13 -9
  266. data/lib/wx/doc/gen/rbn/event_list.rb +127 -123
  267. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +19 -3
  268. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +3 -4
  269. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +2 -2
  270. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +18 -6
  271. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +2 -2
  272. data/lib/wx/doc/gen/rbn/ribbon_control.rb +1 -1
  273. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +4 -4
  274. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -3
  275. data/lib/wx/doc/gen/rbn/ribbon_page.rb +1 -2
  276. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +5 -4
  277. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +2 -3
  278. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +2 -3
  279. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +2 -1
  280. data/lib/wx/doc/gen/rearrange_ctrl.rb +1 -2
  281. data/lib/wx/doc/gen/rearrange_list.rb +3 -4
  282. data/lib/wx/doc/gen/region.rb +75 -17
  283. data/lib/wx/doc/gen/region_iterator.rb +0 -1
  284. data/lib/wx/doc/gen/rtc/event_list.rb +116 -112
  285. data/lib/wx/doc/gen/rtc/rich_text_box.rb +3 -2
  286. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +6 -9
  287. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -2
  288. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +3 -6
  289. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +10 -7
  290. data/lib/wx/doc/gen/rtc/rich_text_event.rb +3 -4
  291. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +2 -4
  292. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +2 -3
  293. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +3 -2
  294. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +2 -3
  295. data/lib/wx/doc/gen/rtc/rich_text_image.rb +2 -4
  296. data/lib/wx/doc/gen/rtc/rich_text_object.rb +28 -23
  297. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +7 -11
  298. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +2 -2
  299. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +5 -5
  300. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +1 -1
  301. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +2 -3
  302. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +1 -2
  303. data/lib/wx/doc/gen/sash_event.rb +9 -4
  304. data/lib/wx/doc/gen/sash_layout_window.rb +11 -4
  305. data/lib/wx/doc/gen/sash_window.rb +3 -4
  306. data/lib/wx/doc/gen/screen_dc.rb +0 -1
  307. data/lib/wx/doc/gen/scroll_bar.rb +19 -10
  308. data/lib/wx/doc/gen/scrolled_canvas.rb +32 -10
  309. data/lib/wx/doc/gen/scrolled_control.rb +32 -10
  310. data/lib/wx/doc/gen/scrolled_window.rb +32 -10
  311. data/lib/wx/doc/gen/search_ctrl.rb +8 -9
  312. data/lib/wx/doc/gen/simplebook.rb +1 -1
  313. data/lib/wx/doc/gen/single_choice_dialog.rb +7 -4
  314. data/lib/wx/doc/gen/sizer.rb +12 -7
  315. data/lib/wx/doc/gen/sizer_item.rb +5 -2
  316. data/lib/wx/doc/gen/slider.rb +27 -17
  317. data/lib/wx/doc/gen/spin_button.rb +15 -10
  318. data/lib/wx/doc/gen/spin_ctrl.rb +24 -9
  319. data/lib/wx/doc/gen/spin_ctrl_double.rb +6 -7
  320. data/lib/wx/doc/gen/spin_double_event.rb +3 -4
  321. data/lib/wx/doc/gen/spin_event.rb +3 -3
  322. data/lib/wx/doc/gen/splash_screen.rb +1 -2
  323. data/lib/wx/doc/gen/splitter_event.rb +3 -4
  324. data/lib/wx/doc/gen/splitter_window.rb +76 -18
  325. data/lib/wx/doc/gen/static_bitmap.rb +10 -5
  326. data/lib/wx/doc/gen/static_box.rb +9 -7
  327. data/lib/wx/doc/gen/static_box_sizer.rb +0 -2
  328. data/lib/wx/doc/gen/static_line.rb +3 -4
  329. data/lib/wx/doc/gen/static_text.rb +5 -6
  330. data/lib/wx/doc/gen/status_bar.rb +19 -9
  331. data/lib/wx/doc/gen/stc/event_list.rb +212 -208
  332. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +39 -13
  333. data/lib/wx/doc/gen/stc/styled_text_event.rb +5 -6
  334. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +0 -1
  335. data/lib/wx/doc/gen/svg_file_dc.rb +7 -8
  336. data/lib/wx/doc/gen/system_options.rb +6 -6
  337. data/lib/wx/doc/gen/system_settings.rb +2 -3
  338. data/lib/wx/doc/gen/task_bar_button.rb +312 -0
  339. data/lib/wx/doc/gen/task_bar_icon.rb +21 -8
  340. data/lib/wx/doc/gen/task_bar_icon_event.rb +4 -3
  341. data/lib/wx/doc/gen/text_attr.rb +20 -5
  342. data/lib/wx/doc/gen/text_ctrl.rb +90 -25
  343. data/lib/wx/doc/gen/text_entry.rb +31 -11
  344. data/lib/wx/doc/gen/text_entry_dialog.rb +2 -2
  345. data/lib/wx/doc/gen/text_validator.rb +43 -10
  346. data/lib/wx/doc/gen/time_picker_ctrl.rb +5 -6
  347. data/lib/wx/doc/gen/timer.rb +6 -2
  348. data/lib/wx/doc/gen/timer_event.rb +1 -2
  349. data/lib/wx/doc/gen/tip_provider.rb +1 -1
  350. data/lib/wx/doc/gen/toggle_button.rb +5 -6
  351. data/lib/wx/doc/gen/tool_bar.rb +98 -25
  352. data/lib/wx/doc/gen/tool_tip.rb +35 -5
  353. data/lib/wx/doc/gen/toolbook.rb +3 -4
  354. data/lib/wx/doc/gen/top_level_window.rb +69 -23
  355. data/lib/wx/doc/gen/tree_ctrl.rb +40 -16
  356. data/lib/wx/doc/gen/tree_event.rb +3 -4
  357. data/lib/wx/doc/gen/treebook.rb +7 -4
  358. data/lib/wx/doc/gen/ui_action_simulator.rb +6 -2
  359. data/lib/wx/doc/gen/utils.rb +39 -7
  360. data/lib/wx/doc/gen/v_list_box.rb +6 -2
  361. data/lib/wx/doc/gen/v_scrolled_window.rb +6 -4
  362. data/lib/wx/doc/gen/validator.rb +1 -1
  363. data/lib/wx/doc/gen/variant.rb +1 -0
  364. data/lib/wx/doc/gen/window.rb +195 -45
  365. data/lib/wx/doc/gen/window_dc.rb +0 -1
  366. data/lib/wx/doc/gen/window_disabler.rb +5 -2
  367. data/lib/wx/doc/gen/with_images.rb +6 -1
  368. data/lib/wx/doc/gen/wizard.rb +4 -4
  369. data/lib/wx/doc/gen/wizard_event.rb +3 -4
  370. data/lib/wx/doc/gen/wizard_page.rb +2 -2
  371. data/lib/wx/doc/gen/wizard_page_simple.rb +1 -1
  372. data/lib/wx/doc/gen/wrap_sizer.rb +0 -1
  373. data/lib/wx/doc/gen/xml_node.rb +19 -4
  374. data/lib/wx/doc/gen/xml_resource.rb +18 -5
  375. data/lib/wx/doc/graphics_context.rb +1 -0
  376. data/lib/wx/doc/grid/grid.rb +22 -1
  377. data/lib/wx/doc/help_controller.rb +11 -7
  378. data/lib/wx/doc/html/html_help_controller.rb +12 -4
  379. data/lib/wx/doc/list_ctrl.rb +33 -29
  380. data/lib/wx/doc/menu.rb +20 -0
  381. data/lib/wx/doc/notebook.rb +21 -0
  382. data/lib/wx/doc/pg/events.rb +13 -9
  383. data/lib/wx/doc/pg/pg_property.rb +18 -0
  384. data/lib/wx/doc/progress_dialog.rb +36 -32
  385. data/lib/wx/doc/prt/page_setup_dialog.rb +20 -12
  386. data/lib/wx/doc/prt/print_data.rb +13 -5
  387. data/lib/wx/doc/prt/print_dialog.rb +31 -23
  388. data/lib/wx/doc/prt/printer.rb +20 -12
  389. data/lib/wx/doc/radio_box.rb +19 -15
  390. data/lib/wx/doc/rbn/ribbon_bar.rb +13 -5
  391. data/lib/wx/doc/rbn/ribbon_button_bar.rb +13 -5
  392. data/lib/wx/doc/rbn/ribbon_gallery.rb +13 -5
  393. data/lib/wx/doc/rbn/ribbon_tool_bar.rb +13 -5
  394. data/lib/wx/doc/region_iterator.rb +32 -28
  395. data/lib/wx/doc/rtc/rich_text_composite_object.rb +24 -0
  396. data/lib/wx/doc/rtc/rich_text_ctrl.rb +24 -0
  397. data/lib/wx/doc/rtc/rich_text_paragraph.rb +24 -0
  398. data/lib/wx/doc/rtc/richtext_buffer.rb +27 -19
  399. data/lib/wx/doc/rtc/richtext_printing.rb +17 -9
  400. data/lib/wx/doc/rtc/richtext_style_sheet.rb +17 -9
  401. data/lib/wx/doc/sizer.rb +20 -0
  402. data/lib/wx/doc/stc/styled_text_ctrl.rb +24 -0
  403. data/lib/wx/doc/stream.rb +39 -35
  404. data/lib/wx/doc/system_settings.rb +30 -26
  405. data/lib/wx/doc/text_validator.rb +12 -8
  406. data/lib/wx/doc/textctrl.rb +16 -0
  407. data/lib/wx/doc/tree_ctrl.rb +95 -0
  408. data/lib/wx/doc/treebook.rb +9 -5
  409. data/lib/wx/doc/v_list_box.rb +9 -5
  410. data/lib/wx/doc/variant.rb +164 -160
  411. data/lib/wx/doc/window.rb +57 -47
  412. data/lib/wx/doc/window_disabler.rb +10 -6
  413. data/lib/wx/grid/grid.rb +27 -4
  414. data/lib/wx/pg/pg_property.rb +22 -0
  415. data/lib/wx/rtc/require.rb +3 -0
  416. data/lib/wx/rtc/rich_text_composite_object.rb +25 -0
  417. data/lib/wx/rtc/rich_text_ctrl.rb +25 -0
  418. data/lib/wx/rtc/rich_text_paragraph.rb +25 -0
  419. data/lib/wx/stc/require.rb +1 -0
  420. data/lib/wx/stc/styled_text_ctrl.rb +25 -0
  421. data/lib/wx/version.rb +1 -1
  422. data/lib/wxruby_aui.so +0 -0
  423. data/lib/wxruby_core.so +0 -0
  424. data/lib/wxruby_grid.so +0 -0
  425. data/lib/wxruby_html.so +0 -0
  426. data/lib/wxruby_pg.so +0 -0
  427. data/lib/wxruby_prt.so +0 -0
  428. data/lib/wxruby_rbn.so +0 -0
  429. data/lib/wxruby_rtc.so +0 -0
  430. data/lib/wxruby_stc.so +0 -0
  431. data/rakelib/lib/config/linux.rb +0 -3
  432. data/rakelib/lib/config/macosx.rb +2 -2
  433. data/rakelib/lib/config/mingw.rb +1 -1
  434. data/rakelib/lib/config/unixish.rb +1 -1
  435. data/rakelib/lib/config.rb +14 -4
  436. data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css +74 -2
  437. data/rakelib/yard/templates/default/fulldoc/html/full_list.erb +38 -0
  438. data/rakelib/yard/templates/default/fulldoc/html/setup.rb +39 -0
  439. data/rakelib/yard/templates/default/tags/html/wxrb_require.erb +10 -0
  440. data/rakelib/yard/templates/default/tags/setup.rb +16 -0
  441. data/rakelib/yard/yard-custom-templates.rb +3 -0
  442. data/samples/treectrl/treectrl.rb +1 -1
  443. data/tests/media/beep_lo.wav +0 -0
  444. data/tests/test_list_ctrl.rb +1 -1
  445. data/tests/test_media_ctrl.rb +38 -0
  446. data/tests/test_menu.rb +69 -0
  447. data/tests/test_pg.rb +27 -0
  448. data/tests/test_richtext.rb +45 -0
  449. data/tests/test_sizer.rb +16 -0
  450. data/tests/test_std_controls.rb +42 -1
  451. data/tests/test_styled_text_ctrl.rb +46 -0
  452. data/tests/test_tree_ctrl.rb +138 -0
  453. data/tests/test_window.rb +12 -0
  454. data/tests/testapp_noframe.rb +1 -1
  455. metadata +28 -3
@@ -9,7 +9,7 @@ module Wx
9
9
  # A menu item represents an item in a menu.
10
10
  # Note that you usually don't have to deal with it directly as {Wx::Menu} methods usually construct an object of this class for you.
11
11
  # Also please note that the methods related to fonts and bitmaps are currently only implemented for Windows, Mac and GTK+.
12
- # === Events emitted by this class
12
+ # ### Events emitted by this class
13
13
  #
14
14
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MenuEvent} events.
15
15
  # Event handler methods for events emitted by this class:
@@ -26,18 +26,18 @@ module Wx
26
26
  #
27
27
  # - {Wx::EvtHandler#evt_menu_highlight_all}(meth = nil, &block): A menu item has been highlighted, i.e. the currently selected menu item has changed. This type of event is sent as {Wx::MenuEvent}.
28
28
  #
29
- # ===
30
- #
31
29
  # Category: {Wx::Menus}
32
30
  # @see Wx::MenuBar
33
31
  # @see Wx::Menu
34
32
  #
35
33
  #
34
+ # @wxrb_require USE_MENUS
36
35
  class MenuItem < Object
37
36
 
38
37
  # Returns the background colour associated with the menu item.
39
- # Availability: only available for the wxMSW port. {Wx::msw}
38
+ # Availability: only available for the WXMSW port.
40
39
  # @return [Wx::Colour]
40
+ # @wxrb_require WXMSW
41
41
  def get_background_colour; end
42
42
  alias_method :background_colour, :get_background_colour
43
43
 
@@ -55,14 +55,16 @@ module Wx
55
55
  alias_method :bitmap_bundle, :get_bitmap_bundle
56
56
 
57
57
  # Returns the bitmap used for disabled items.
58
- # Availability: only available for the wxMSW port. {Wx::msw}
58
+ # Availability: only available for the WXMSW port.
59
59
  # @return [Wx::Bitmap]
60
+ # @wxrb_require WXMSW
60
61
  def get_disabled_bitmap; end
61
62
  alias_method :disabled_bitmap, :get_disabled_bitmap
62
63
 
63
64
  # Returns the font associated with the menu item.
64
- # Availability: only available for the wxMSW port. {Wx::msw}
65
+ # Availability: only available for the WXMSW port.
65
66
  # @return [Wx::Font]
67
+ # @wxrb_require WXMSW
66
68
  def get_font; end
67
69
  alias_method :font, :get_font
68
70
 
@@ -98,8 +100,9 @@ module Wx
98
100
  alias_method :kind, :get_kind
99
101
 
100
102
  # Gets the width of the menu item checkmark bitmap.
101
- # Availability: only available for the wxMSW port. {Wx::msw}
103
+ # Availability: only available for the WXMSW port.
102
104
  # @return [Integer]
105
+ # @wxrb_require WXMSW
103
106
  def get_margin_width; end
104
107
  alias_method :margin_width, :get_margin_width
105
108
 
@@ -114,13 +117,15 @@ module Wx
114
117
  alias_method :sub_menu, :get_sub_menu
115
118
 
116
119
  # Returns the text colour associated with the menu item.
117
- # Availability: only available for the wxMSW port. {Wx::msw}
120
+ # Availability: only available for the WXMSW port.
118
121
  # @return [Wx::Colour]
122
+ # @wxrb_require WXMSW
119
123
  def get_text_colour; end
120
124
  alias_method :text_colour, :get_text_colour
121
125
 
122
126
  # Get our accelerator or NULL (caller must delete the pointer)
123
127
  # @return [Wx::AcceleratorEntry]
128
+ # @wxrb_require USE_ACCEL
124
129
  def get_accel; end
125
130
  alias_method :accel, :get_accel
126
131
 
@@ -162,9 +167,10 @@ module Wx
162
167
  alias_method :sub_menu?, :is_sub_menu
163
168
 
164
169
  # Sets the background colour associated with the menu item.
165
- # Availability: only available for the wxMSW port. {Wx::msw}
170
+ # Availability: only available for the WXMSW port.
166
171
  # @param colour [Wx::Colour,String,Symbol]
167
172
  # @return [void]
173
+ # @wxrb_require WXMSW
168
174
  def set_background_colour(colour) end
169
175
  alias_method :background_colour=, :set_background_colour
170
176
 
@@ -177,33 +183,37 @@ module Wx
177
183
  # Sets the checked or unchecked bitmap for the menu item.
178
184
  # It is equivalent to {Wx::MenuItem#set_bitmaps(bmp,wxNullBitmap)} if checked is true or SetBitmaps({Wx::NULL_BITMAP}, bmp) otherwise.
179
185
  # Note that different bitmaps for checked and unchecked item states are not supported in most ports, while setting just a single bitmap using the overload above is supported in all of them.
180
- # Availability: only available for the wxMSW port. {Wx::msw}
186
+ # Availability: only available for the WXMSW port.
181
187
  # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
182
188
  # @param checked [Boolean]
183
189
  # @return [void]
190
+ # @wxrb_require WXMSW
184
191
  def set_bitmap(*args) end
185
192
  alias_method :bitmap=, :set_bitmap
186
193
 
187
194
  # Sets the checked/unchecked bitmaps for the menu item.
188
195
  # The first bitmap is also used as the single bitmap for uncheckable menu items.
189
- # Availability: only available for the wxMSW port. {Wx::msw}
196
+ # Availability: only available for the WXMSW port.
190
197
  # @param checked [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
191
198
  # @param unchecked [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
192
199
  # @return [void]
200
+ # @wxrb_require WXMSW
193
201
  def set_bitmaps(checked, unchecked=Wx::NULL_BITMAP) end
194
202
  alias_method :bitmaps=, :set_bitmaps
195
203
 
196
204
  # Sets the to be used for disabled menu items.
197
- # Availability: only available for the wxMSW port. {Wx::msw}
205
+ # Availability: only available for the WXMSW port.
198
206
  # @param disabled [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
199
207
  # @return [void]
208
+ # @wxrb_require WXMSW
200
209
  def set_disabled_bitmap(disabled) end
201
210
  alias_method :disabled_bitmap=, :set_disabled_bitmap
202
211
 
203
212
  # Sets the font associated with the menu item.
204
- # Availability: only available for the wxMSW port. {Wx::msw}
213
+ # Availability: only available for the WXMSW port.
205
214
  # @param font [Wx::Font,Wx::FontInfo]
206
215
  # @return [void]
216
+ # @wxrb_require WXMSW
207
217
  def set_font(font) end
208
218
  alias_method :font=, :set_font
209
219
 
@@ -288,9 +298,15 @@ module Wx
288
298
  # @my_menu_item4.set_item_label("Item with &accelerator")
289
299
  # ```
290
300
  #
291
- # In wxGTK using <code>"SHIFT"</code> with non-alphabetic characters currently doesn't work, even in combination with other modifiers, due to GTK+ limitation. E.g. <code>Shift+Ctrl+A</code> works but <code>Shift+Ctrl+1</code> or <code>Shift+/</code> do not, so avoid using accelerators of this form in portable code.
301
+ # <div class="wxrb-note">
302
+ # <b>Note:</b>
303
+ # <p>In WXGTK using <code>"SHIFT"</code> with non-alphabetic characters currently doesn't work, even in combination with other modifiers, due to GTK+ limitation. E.g. <code>Shift+Ctrl+A</code> works but <code>Shift+Ctrl+1</code> or <code>Shift+/</code> do not, so avoid using accelerators of this form in portable code.
304
+ # </p>
305
+ # </div>
292
306
  #
293
- # In {Wx::GTk}, the left/right/up/down arrow keys do not work as accelerator keys for a menu item unless a modifier key is used. Additionally, the following keycodes are not supported as menu accelerator keys:
307
+ # <div class="wxrb-note">
308
+ # <b>Note:</b>
309
+ # <p>In {Wx::GTk}, the left/right/up/down arrow keys do not work as accelerator keys for a menu item unless a modifier key is used. Additionally, the following keycodes are not supported as menu accelerator keys:
294
310
  #
295
311
  # - {Wx::KeyCode::K_COMMAND}/{Wx::KeyCode::K_CONTROL}
296
312
  # - {Wx::KeyCode::K_SHIFT}
@@ -308,6 +324,9 @@ module Wx
308
324
  # - {Wx::KeyCode::K_DECIMAL}
309
325
  # - {Wx::KeyCode::K_DIVIDE}
310
326
  # - {Wx::KeyCode::K_SNAPSHOT}
327
+ #
328
+ # </p>
329
+ # </div>
311
330
  # @see Wx::MenuItem#get_item_label
312
331
  # @see Wx::MenuItem#get_item_label_text
313
332
  # @param label [String]
@@ -316,9 +335,10 @@ module Wx
316
335
  alias_method :item_label=, :set_item_label
317
336
 
318
337
  # Sets the width of the menu item checkmark bitmap.
319
- # Availability: only available for the wxMSW port. {Wx::msw}
338
+ # Availability: only available for the WXMSW port.
320
339
  # @param width [Integer]
321
340
  # @return [void]
341
+ # @wxrb_require WXMSW
322
342
  def set_margin_width(width) end
323
343
  alias_method :margin_width=, :set_margin_width
324
344
 
@@ -335,9 +355,10 @@ module Wx
335
355
  alias_method :sub_menu=, :set_sub_menu
336
356
 
337
357
  # Sets the text colour associated with the menu item.
338
- # Availability: only available for the wxMSW port. {Wx::msw}
358
+ # Availability: only available for the WXMSW port.
339
359
  # @param colour [Wx::Colour,String,Symbol]
340
360
  # @return [void]
361
+ # @wxrb_require WXMSW
341
362
  def set_text_colour(colour) end
342
363
  alias_method :text_colour=, :set_text_colour
343
364
 
@@ -350,9 +371,10 @@ module Wx
350
371
  # Add an extra accelerator for this menu item.
351
372
  # Additional accelerators are not shown in the item's label, but still will trigger the menu command when pressed.
352
373
  # They can be useful to let multiple keys be used as accelerators for the same command, e.g. {Wx::KeyCode::K_ADD} and {Wx::KeyCode::K_NUMPAD}_ADD.
353
- # Availability: only available for the wxMSW, wxGTK ports. {Wx::msw},{Wx::gtk}
374
+ # Availability: only available for the WXMSW, WXGTK ports.
354
375
  # @param accel [Wx::AcceleratorEntry]
355
376
  # @return [void]
377
+ # @wxrb_require WXMSW|WXGTK
356
378
  def add_extra_accel(accel) end
357
379
 
358
380
  # Clear the extra accelerators list.
@@ -361,7 +383,7 @@ module Wx
361
383
  def clear_extra_accels; end
362
384
 
363
385
  # Constructs a {Wx::MenuItem} object.
364
- # Menu items can be standard, or "stock menu items", or custom. For the standard menu items (such as commands to open a file, exit the program and so on, see Stock Items for the full list) it is enough to specify just the stock ID and leave text and helpString empty. Some platforms (currently wxGTK only, and see the remark in {Wx::MenuItem#set_bitmap} documentation) will also show standard bitmaps for stock menu items.
386
+ # Menu items can be standard, or "stock menu items", or custom. For the standard menu items (such as commands to open a file, exit the program and so on, see Stock Items for the full list) it is enough to specify just the stock ID and leave text and helpString empty. Some platforms (currently WXGTK only, and see the remark in {Wx::MenuItem#set_bitmap} documentation) will also show standard bitmaps for stock menu items.
365
387
  # Leaving at least text empty for the stock menu items is actually strongly recommended as they will have appearance and keyboard interface (including standard accelerators) familiar to the user.
366
388
  # For the custom (non-stock) menu items, text must be specified and while helpString may be left empty, it's recommended to pass the item description (which is automatically shown by the library in the status bar when the menu item is selected) in this parameter.
367
389
  # Finally note that you can e.g. use a stock menu label without using its stock help string:
@@ -31,7 +31,7 @@ module Wx
31
31
  def self.message_box(message, caption=Wx::MESSAGE_BOX_CAPTION_STR, style=(Wx::OK|Wx::GeometryCentre::CENTRE), parent=nil, x=Wx::DEFAULT_COORD, y=Wx::DEFAULT_COORD) end
32
32
 
33
33
  # This class represents a dialog that shows a single or multi-line message, with a choice of OK, Yes, No and Cancel buttons.
34
- # === Styles
34
+ # ### Styles
35
35
  #
36
36
  # This class supports the following styles:
37
37
  #
@@ -39,13 +39,13 @@ module Wx
39
39
  #
40
40
  # - {Wx::CANCEL}: Puts a Cancel button in the message box. Must be combined with either {Wx::OK} or {Wx::YES_NO}.
41
41
  #
42
- # - {Wx::YES_NO}: Puts Yes and No buttons in the message box. It is recommended to always use {Wx::CANCEL} with this style as otherwise the message box won't have a close button under wxMSW and the user will be forced to answer it.
42
+ # - {Wx::YES_NO}: Puts Yes and No buttons in the message box. It is recommended to always use {Wx::CANCEL} with this style as otherwise the message box won't have a close button under WXMSW and the user will be forced to answer it.
43
43
  #
44
- # - {Wx::HELP}: Puts a Help button to the message box. This button can have special appearance or be specially positioned if its label is not changed from the default one. Notice that using this button is not supported when showing a message box from non-main thread in wxOSX/Cocoa. Available since wxWidgets 2.9.3.
44
+ # - {Wx::HELP}: Puts a Help button to the message box. This button can have special appearance or be specially positioned if its label is not changed from the default one. Notice that using this button is not supported when showing a message box from non-main thread in WXOSX/Cocoa. Available since wxWidgets 2.9.3.
45
45
  #
46
46
  # - {Wx::NO_DEFAULT}: Makes the "No" button default, can only be used with {Wx::YES_NO}.
47
47
  #
48
- # - {Wx::CANCEL_DEFAULT}: Makes the "Cancel" button default, can only be used with {Wx::CANCEL}. This style is currently not supported (and ignored) in wxOSX.
48
+ # - {Wx::CANCEL_DEFAULT}: Makes the "Cancel" button default, can only be used with {Wx::CANCEL}. This style is currently not supported (and ignored) in WXOSX.
49
49
  #
50
50
  # - {Wx::YES_DEFAULT}: Makes the "Yes" button default, this is the default behaviour and this flag exists solely for symmetry with {Wx::NO_DEFAULT}.
51
51
  #
@@ -57,7 +57,7 @@ module Wx
57
57
  #
58
58
  # - {Wx::ICON_WARNING}: Displays a warning icon in the dialog. This style should be used for informative warnings or, in combination with {Wx::YES_NO} or {Wx::CANCEL}, for questions that have potentially serious consequences (caution icon is used on macOS in this case).
59
59
  #
60
- # - {Wx::ICON_QUESTION}: Displays a question mark symbol. This icon is automatically used with {Wx::YES_NO} so it's usually unnecessary to specify it explicitly. This style is not supported for message dialogs under wxMSW when a task dialog is used to implement them (i.e. when running under Windows Vista or later) because Microsoft guidelines indicate that no icon should be used for routine confirmations. If it is specified, no icon will be displayed.
60
+ # - {Wx::ICON_QUESTION}: Displays a question mark symbol. This icon is automatically used with {Wx::YES_NO} so it's usually unnecessary to specify it explicitly. This style is not supported for message dialogs under WXMSW when a task dialog is used to implement them (i.e. when running under Windows Vista or later) because Microsoft guidelines indicate that no icon should be used for routine confirmations. If it is specified, no icon will be displayed.
61
61
  #
62
62
  # - {Wx::ICON_INFORMATION}: Displays an information symbol. This icon is used by default if {Wx::YES_NO} is not given so it is usually unnecessary to specify it explicitly.
63
63
  #
@@ -65,20 +65,19 @@ module Wx
65
65
  #
66
66
  # - {Wx::ICON_HAND}: Alias for {Wx::ICON_ERROR}.
67
67
  #
68
- # - {Wx::ICON_AUTH_NEEDED}: Displays an authentication needed symbol. This style is only supported for message dialogs under wxMSW when a task dialog is used to implement them (i.e. when running under Windows Vista or later). In other cases the default icon selection logic will be used. Note this can be combined with other styles to provide a fallback. For instance, using {Wx::ICON_AUTH_NEEDED} | {Wx::ICON_QUESTION} will show a shield symbol on Windows Vista or above and a question symbol on other platforms. Available since wxWidgets 2.9.5
68
+ # - {Wx::ICON_AUTH_NEEDED}: Displays an authentication needed symbol. This style is only supported for message dialogs under WXMSW when a task dialog is used to implement them (i.e. when running under Windows Vista or later). In other cases the default icon selection logic will be used. Note this can be combined with other styles to provide a fallback. For instance, using {Wx::ICON_AUTH_NEEDED} | {Wx::ICON_QUESTION} will show a shield symbol on Windows Vista or above and a question symbol on other platforms. Available since wxWidgets 2.9.5
69
69
  #
70
70
  # - {Wx::STAY_ON_TOP}: Makes the message box stay on top of all other windows and not only just its parent (currently implemented only under MSW and GTK).
71
71
  #
72
72
  # - {Wx::GeometryCentre::CENTRE}: Centre the message box on its parent or on the screen if parent is not specified. Setting this style under MSW makes no differences as the dialog is always centered on the parent.
73
73
  #
74
- # ===
75
- #
76
74
  # Category: Common Dialogs
77
75
  # @see wxMessageDialog Overview
78
76
  #
79
77
  # @see Wx::RichMessageDialog
80
78
  #
81
79
  #
80
+ # @wxrb_require USE_MSGDLG
82
81
  class MessageDialog < Dialog
83
82
 
84
83
  # Constructor specifying the message box properties.
@@ -9,7 +9,7 @@ module Wx
9
9
  # A miniframe is a frame with a small title bar.
10
10
  # It is suitable for floating toolbars that must not take up too much screen area.
11
11
  # An example of mini frame can be seen in the Dialogs Sample using the "Mini frame" command of the "Generic dialogs" submenu.
12
- # === Styles
12
+ # ### Styles
13
13
  #
14
14
  # This class supports the following styles:
15
15
  #
@@ -33,9 +33,11 @@ module Wx
33
33
  #
34
34
  # - {Wx::RESIZE_BORDER}: Displays a resizable border around the window.
35
35
  #
36
- # This class has miniframe functionality under Windows and GTK, i.e. the presence of mini frame will not be noted in the task bar and focus behaviour is different. On other platforms, it behaves like a normal frame.
37
- #
38
- # ===
36
+ # <div class="wxrb-remark">
37
+ # <b>Remark:</b>
38
+ # <p>This class has miniframe functionality under Windows and GTK, i.e. the presence of mini frame will not be noted in the task bar and focus behaviour is different. On other platforms, it behaves like a normal frame.
39
+ # </p>
40
+ # </div>>
39
41
  #
40
42
  # Category: Managed Windows
41
43
  # @see Wx::MDIParentFrame
@@ -51,7 +53,11 @@ module Wx
51
53
  # @return [Wx::MiniFrame]
52
54
  # @overload initialize(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::CAPTION|Wx::RESIZE_BORDER), name=Wx::FRAME_NAME_STR)
53
55
  # Constructor, creating the window.
54
- # The frame behaves like a normal frame on non-Windows platforms.
56
+ # <div class="wxrb-remark">
57
+ # <b>Remark:</b>
58
+ # <p>The frame behaves like a normal frame on non-Windows platforms.
59
+ # </p>
60
+ # </div>>
55
61
  # @see Wx::MiniFrame#create
56
62
  # @param parent [Wx::Window] The window parent. This may be NULL. If it is non-NULL, the frame will always be displayed on top of the parent window on Windows.
57
63
  # @param id [Integer] The window identifier. It may take a value of -1 to indicate a default value.
@@ -9,8 +9,6 @@ module Wx
9
9
  # {Wx::MirrorDC} is a simple wrapper class which is always associated with a real {Wx::DC} object and either forwards all of its operations to it without changes (no mirroring takes place) or exchanges x and y coordinates which makes it possible to reuse the same code to draw a figure and its mirror i.e.
10
10
  # reflection related to the diagonal line x == y.
11
11
  #
12
- # ===
13
- #
14
12
  # Category: Device Contexts
15
13
  #
16
14
  #
@@ -49,7 +49,6 @@ module Wx
49
49
  # Represents the mouse state.
50
50
  # This class is used as a base class by {Wx::MouseEvent} and so its methods may be used to obtain information about the mouse state for the mouse events. It also inherits from {Wx::KeyboardState} and so carries information about the keyboard state and not only the mouse one.
51
51
  # This class is implemented entirely inline in <{Wx::/mousestate.h}> and thus has no linking requirements.
52
- # ===
53
52
  #
54
53
  # Category: {Wx::Events}
55
54
  # @see get_mouse_state
@@ -7,7 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # This class represents a dialog that shows a list of strings, and allows the user to select one or more.
10
- # === Styles
10
+ # ### Styles
11
11
  #
12
12
  # This class supports the following styles:
13
13
  #
@@ -17,17 +17,20 @@ module Wx
17
17
  #
18
18
  # - {Wx::GeometryCentre::CENTRE}: Centre the message.
19
19
  #
20
- # ===
21
- #
22
20
  # Category: Common Dialogs
23
21
  # @see wxMultiChoiceDialog Overview
24
22
  # @see Wx::SingleChoiceDialog
25
23
  #
26
24
  #
25
+ # @wxrb_require USE_CHOICEDLG
27
26
  class MultiChoiceDialog < Dialog
28
27
 
29
28
  # Constructor taking an array of {Wx::String} choices.
30
- # Use {Wx::MultiChoiceDialog#show_modal} to show the dialog.
29
+ # <div class="wxrb-remark">
30
+ # <b>Remark:</b>
31
+ # <p>Use {Wx::MultiChoiceDialog#show_modal} to show the dialog.
32
+ # </p>
33
+ # </div>>
31
34
  # @param parent [Wx::Window] Parent window.
32
35
  # @param message [String] Message to show on the dialog.
33
36
  # @param caption [String] The dialog caption.
@@ -34,7 +34,7 @@ module Wx
34
34
  # ```
35
35
  #
36
36
  # Note that windows with non default shape have a fixed size and can't be resized using {Wx::NonOwnedWindow#set_size}.
37
- # As the overload above, this method is not guaranteed to work on all platforms but currently does work in wxMSW, wxOSX/Cocoa and wxGTK (with the appropriate but almost always present X11 extensions) ports.
37
+ # As the overload above, this method is not guaranteed to work on all platforms but currently does work in WXMSW, WXOSX/Cocoa and WXGTK (with the appropriate but almost always present X11 extensions) ports.
38
38
  # @param path [Wx::GraphicsPath]
39
39
  # @return [Boolean]
40
40
  def set_shape(*args) end
@@ -61,7 +61,7 @@ module Wx
61
61
  # This class represents a notebook control, which manages multiple windows with associated tabs.
62
62
  # To use the class, create a {Wx::Notebook} object and call {Wx::Notebook::AddPage} or {Wx::Notebook#insert_page}, passing a window to be used as the page. Do not explicitly delete the window for a page that is currently managed by {Wx::Notebook}.
63
63
  # <b>{Wx::NotebookPage}</b> is a typedef for {Wx::Window}.
64
- # === Styles
64
+ # ### Styles
65
65
  #
66
66
  # This class supports the following styles:
67
67
  #
@@ -80,7 +80,7 @@ module Wx
80
80
  # - {Wx::NB_NOPAGETHEME}: (Windows only) Display a solid colour on notebook pages, and not a gradient, which can reduce performance.
81
81
  #
82
82
  # The styles {Wx::NB_LEFT}, RIGHT and BOTTOM are not supported under Microsoft Windows when using visual themes.
83
- # === Events emitted by this class
83
+ # ### Events emitted by this class
84
84
  #
85
85
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::BookCtrlEvent} events.
86
86
  # Event handler methods for events emitted by this class:
@@ -89,7 +89,7 @@ module Wx
89
89
  #
90
90
  # - {Wx::EvtHandler#evt_notebook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_NOTEBOOK_PAGE_CHANGING} event. This event can be vetoed.
91
91
  #
92
- # == Page backgrounds
92
+ # ## Page backgrounds
93
93
  #
94
94
  # On Windows, the default theme paints a background on the notebook's pages. If you wish to suppress this theme, for aesthetic or performance reasons, there are three ways of doing it. You can use {Wx::NB_NOPAGETHEME} to disable themed drawing for a particular notebook, you can call {Wx::SystemOptions.set_option} to disable it for the whole application, or you can disable it for individual pages by using {Wx::Notebook#set_background_colour}.
95
95
  # To disable themed pages globally:
@@ -104,11 +104,10 @@ module Wx
104
104
  # ```
105
105
  #
106
106
  # On platforms other than Windows, or if the application is not using Windows themes, {Wx::Notebook#get_theme_background_colour} will return an uninitialised colour object, and the above code will therefore work on all platforms.
107
- # ===
108
107
  #
109
- # Category: Book Controls <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
110
- # </td><td> wxGTK Appearance
111
- # </td><td> wxOSX Appearance
108
+ # Category: Book Controls <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
109
+ # </td><td> WXGTK Appearance
110
+ # </td><td> WXOSX Appearance
112
111
  # </td></tr></table></div>
113
112
  # @see Wx::BookCtrl
114
113
  # @see Wx::BookCtrlEvent
@@ -116,6 +115,7 @@ module Wx
116
115
  # @see Notebook Sample
117
116
  #
118
117
  #
118
+ # @wxrb_require USE_NOTEBOOK
119
119
  class Notebook < BookCtrlBase
120
120
 
121
121
  # @overload initialize()
@@ -156,7 +156,11 @@ module Wx
156
156
  alias_method :theme_background_colour, :get_theme_background_colour
157
157
 
158
158
  # Sets the amount of space around each page's icon and label, in pixels.
159
- # The vertical padding cannot be changed in wxGTK.
159
+ # <div class="wxrb-note">
160
+ # <b>Note:</b>
161
+ # <p>The vertical padding cannot be changed in WXGTK.
162
+ # </p>
163
+ # </div>
160
164
  # @param padding [Array(Integer, Integer), Wx::Size]
161
165
  # @return [void]
162
166
  def set_padding(padding) end
@@ -211,7 +215,11 @@ module Wx
211
215
  # Inserts a new page at the specified position.
212
216
  # true if successful, false otherwise.
213
217
  #
214
- # Do not delete the page, it will be deleted by the book control.
218
+ # <div class="wxrb-remark">
219
+ # <b>Remark:</b>
220
+ # <p>Do not delete the page, it will be deleted by the book control.
221
+ # </p>
222
+ # </div>>
215
223
  # @see Wx::Notebook#add_page
216
224
  # @param index [Integer] Specifies the position for the new page.
217
225
  # @param page [Wx::Window] Specifies the new page.
@@ -25,12 +25,12 @@ module Wx
25
25
  # This class represents a dialog that requests a numeric input from the user.
26
26
  # Currently it is implemented as a generic wxWidgets dialog under all platforms.
27
27
  # You can use a convenience {get_number_from_user} function instead of using this dialog.
28
- # ===
29
28
  #
30
29
  # Category: Common Dialogs
31
30
  # @see wxNumberEntryDialog Overview
32
31
  #
33
32
  #
33
+ # @wxrb_require USE_NUMBERDLG
34
34
  class NumberEntryDialog < Dialog
35
35
 
36
36
  # @overload initialize()
@@ -16,7 +16,6 @@ module Wx
16
16
  # {Wx::Object} is the hub of a dynamic object creation scheme, enabling a program to create instances of a class only knowing its string class name, and to query the class hierarchy.
17
17
  # The class contains optional debugging versions of <b>new</b> and <b>delete</b>, which can help trace memory allocation and deallocation problems.
18
18
  # {Wx::Object} can be used to implement reference counted objects, such as {Wx::Pen}, {Wx::Bitmap} and others (see this list). See {Wx::RefCounter} and Reference Counting for more info about reference counting.
19
- # ===
20
19
  #
21
20
  # Category: Runtime Type Information (RTTI)
22
21
  # @see Wx::ClassInfo
@@ -10,7 +10,6 @@ module Wx
10
10
  # This should normally be constructed as a temporary stack object; don't store a {Wx::PaintDC} object. If you have an EVT_PAINT() handler, you must create a {Wx::PaintDC} object within it even if you don't actually use it.
11
11
  # Using {Wx::PaintDC} within your EVT_PAINT() handler is important because it automatically sets the clipping area to the damaged area of the window. Attempts to draw outside this area do not appear.
12
12
  # A {Wx::PaintDC} object is initialized to use the same font and colours as the window it is associated with.
13
- # ===
14
13
  #
15
14
  # Category: Device Contexts
16
15
  # @see Wx::DC
@@ -13,7 +13,6 @@ module Wx
13
13
  # A palette is a table that maps pixel values to RGB colours.
14
14
  # It allows the colours of a low-depth bitmap, for example, to be mapped to the available colours in a display. The notion of palettes is becoming more and more obsolete nowadays and only the MSW port is still using a native palette. All other ports use generic code which is basically just an array of colours.
15
15
  # It is likely that in the future the only use for palettes within wxWidgets will be for representing colour indices from images (such as GIF or PNG). The image handlers for these formats have been modified to create a palette if there is such information in the original image file (usually 256 or less colour images). See {Wx::Image} for more information.
16
- # ===
17
16
  #
18
17
  # Category: Graphics Device Interface (GDI)
19
18
  # Predefined objects/pointers: {Wx::NULL_PALETTE}
@@ -7,22 +7,27 @@
7
7
  module Wx
8
8
 
9
9
  # A panel is a window on which controls are placed.
10
- # It is usually placed within a frame. Its main feature over its parent class {Wx::Window} is code for handling child windows and TAB traversal, which is implemented natively if possible (e.g. in wxGTK) or by wxWidgets itself otherwise.
11
- # Tab traversal is implemented through an otherwise undocumented intermediate {Wx::ControlContainer} class from which any class can derive in addition to the normal {Wx::Window} base class. Please see <code>Wx::/containr.h</code> and <code>Wx::/panel.h</code> to find out how this is achieved.
10
+ # It is usually placed within a frame. Its main feature over its parent class {Wx::Window} is code for handling child windows and TAB traversal, which is implemented natively if possible (e.g. in WXGTK) or by wxWidgets itself otherwise.
12
11
  #
13
- # if not all characters are being intercepted by your OnKeyDown or OnChar handler, it may be because you are using the {Wx::TAB_TRAVERSAL} style, which grabs some keypresses for use by child controls.
12
+ # <div class="wxrb-note">
13
+ # <b>Note:</b>
14
+ # <p>if not all characters are being intercepted by your OnKeyDown or OnChar handler, it may be because you are using the {Wx::TAB_TRAVERSAL} style, which grabs some keypresses for use by child controls.
15
+ # </p>
16
+ # </div>
14
17
  #
15
- # By default, a panel has the same colouring as a dialog.
18
+ # <div class="wxrb-remark">
19
+ # <b>Remark:</b>
20
+ # <p>By default, a panel has the same colouring as a dialog.
21
+ # </p>
22
+ # </div>>
16
23
  #
17
- # === Events emitted by this class
24
+ # ### Events emitted by this class
18
25
  #
19
26
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::NavigationKeyEvent} events.
20
27
  # Event handler methods for events emitted by this class:
21
28
  #
22
29
  # - {Wx::EvtHandler#evt_navigation_key}(meth = nil, &block): Process a navigation key event.
23
30
  #
24
- # ===
25
- #
26
31
  # Category: Miscellaneous Windows
27
32
  # @see Wx::Dialog
28
33
  #
@@ -72,7 +77,11 @@ module Wx
72
77
  def layout; end
73
78
 
74
79
  # The default handler for {Wx::EVT_SYS_COLOUR_CHANGED}.
75
- # Changes the panel's colour to conform to the current settings. Add an event table entry for your panel class if you wish the behaviour to be different (such as keeping a user-defined background colour). If you do override this function, call {Wx::Event#skip} to propagate the notification to child windows and controls.
80
+ # <div class="wxrb-remark">
81
+ # <b>Remark:</b>
82
+ # <p>Changes the panel's colour to conform to the current settings. Add an event table entry for your panel class if you wish the behaviour to be different (such as keeping a user-defined background colour). If you do override this function, call {Wx::Event#skip} to propagate the notification to child windows and controls.
83
+ # </p>
84
+ # </div>>
76
85
  # @see Wx::SysColourChangedEvent
77
86
  # @param event [Wx::SysColourChangedEvent] The colour change event.
78
87
  # @return [void]
@@ -8,7 +8,7 @@ module Wx
8
8
 
9
9
  # The possible styles for a {Wx::Pen}.
10
10
  #
11
- # Note that hatched pen styles are not supported by X11-based ports, including wxGTK.
11
+ # Note that hatched pen styles are not supported by X11-based ports, including WXGTK.
12
12
  #
13
13
  class PenStyle < Wx::Enum
14
14
 
@@ -92,8 +92,8 @@ module Wx
92
92
 
93
93
  # Possible values for pen quality.
94
94
  #
95
- # Pen quality is currently only used in wxMSW, the other ports ignore it and always use the same default pen quality.
96
- # In wxMSW the choice of quality affects whether "cosmetic" or "geometric" native pens are used in situations when both are usable. Notably, for dotted and dashed pens of width 1, high quality geometric pens are used by default since wxWidgets 3.1.4, while previous versions used lower quality but much faster cosmetic pens. If drawing performance is more important than the exact appearance of the lines drawn using this pen, low quality may be explicitly selected.
95
+ # Pen quality is currently only used in WXMSW, the other ports ignore it and always use the same default pen quality.
96
+ # In WXMSW the choice of quality affects whether "cosmetic" or "geometric" native pens are used in situations when both are usable. Notably, for dotted and dashed pens of width 1, high quality geometric pens are used by default since wxWidgets 3.1.4, while previous versions used lower quality but much faster cosmetic pens. If drawing performance is more important than the exact appearance of the lines drawn using this pen, low quality may be explicitly selected.
97
97
  # See {Wx::PenInfo#quality} and {Wx::Pen#set_quality}.
98
98
  #
99
99
  class PenQuality < Wx::Enum
@@ -166,12 +166,16 @@ module Wx
166
166
 
167
167
  # A pen is a drawing tool for drawing outlines.
168
168
  # It is used for drawing lines and painting the outline of rectangles, ellipses, etc. It has a colour, a width and a style.
169
- # On a monochrome display, wxWidgets shows all non-white pens as black.
169
+ #
170
+ # <div class="wxrb-note">
171
+ # <b>Note:</b>
172
+ # <p>On a monochrome display, wxWidgets shows all non-white pens as black.
173
+ # </p>
174
+ # </div>
170
175
  #
171
176
  # Do not initialize objects on the stack before the program commences, since other required structures may not have been set up yet. Instead, define global pointers to objects and create them in {Wx::App#on_init} or when required.
172
177
  # An application may wish to dynamically create pens with different characteristics, and there is the consequent danger that a large number of duplicate pens will be created. Therefore an application may wish to get a pointer to a pen by using the global list of pens {Wx::ThePenList}, and calling the member function Wx::PenList#find_or_create_pen. See {Wx::PenList} for more info.
173
178
  # This class uses reference counting and copy-on-write internally so that assignments between two instances of this class are very cheap. You can therefore use actual objects instead of pointers without efficiency problems. If an instance of this class is changed it will create its own data internally so that other instances, which previously shared the data using the reference counting, are not affected.
174
- # ===
175
179
  #
176
180
  # Category: Graphics Device Interface (GDI)
177
181
  # Predefined objects/pointers:
@@ -233,7 +237,11 @@ module Wx
233
237
  # @return [Wx::Pen]
234
238
  # @overload initialize(colour, width=1, style=Wx::PenStyle::PENSTYLE_SOLID)
235
239
  # Constructs a pen from a colour object, pen width and style.
236
- # Different versions of Windows and different versions of other platforms support very different subsets of the styles above so handle with care.
240
+ # <div class="wxrb-remark">
241
+ # <b>Remark:</b>
242
+ # <p>Different versions of Windows and different versions of other platforms support very different subsets of the styles above so handle with care.
243
+ # </p>
244
+ # </div>>
237
245
  # @see Wx::Pen#set_style
238
246
  # @see Wx::Pen#set_colour
239
247
  # @see Wx::Pen#set_width
@@ -243,12 +251,13 @@ module Wx
243
251
  # @return [Wx::Pen]
244
252
  # @overload initialize(stipple, width)
245
253
  # Constructs a stippled pen from a stipple bitmap and a width.
246
- # Availability: only available for the wxMSW, wxOSX/Cocoa ports. {Wx::msw},{Wx::osx}
254
+ # Availability: only available for the WXMSW, WXOSX/Cocoa ports.
247
255
  # @see Wx::Pen#set_width
248
256
  # @see Wx::Pen#set_stipple
249
257
  # @param stipple [Wx::Bitmap] A stipple bitmap.
250
258
  # @param width [Integer] Pen width. Under Windows, the pen width cannot be greater than 1 if the style is {Wx::PenStyle::PENSTYLE_DOT}, {Wx::PenStyle::PENSTYLE_LONG_DASH}, {Wx::PenStyle::PENSTYLE_SHORT_DASH}, {Wx::PenStyle::PENSTYLE_DOT_DASH}, or {Wx::PenStyle::PENSTYLE_USER_DASH}.
251
259
  # @return [Wx::Pen]
260
+ # @wxrb_require WXMSW|WXOSX
252
261
  # @overload initialize(pen)
253
262
  # Copy constructor, uses Reference Counting.
254
263
  # @param pen [Wx::Pen] A pointer or reference to a pen to copy.
@@ -345,7 +354,7 @@ module Wx
345
354
  alias_method :cap=, :set_cap
346
355
 
347
356
  # Sets the pen quality.
348
- # Explicitly selecting low pen quality may be useful in wxMSW if drawing performance is more important than the exact appearance of the lines drawn with this pen.
357
+ # Explicitly selecting low pen quality may be useful in WXMSW if drawing performance is more important than the exact appearance of the lines drawn with this pen.
349
358
  # @see Wx::PenQuality
350
359
  # @param quality [Wx::PenQuality]
351
360
  # @return [void]