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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (740) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -0
  3. data/INSTALL.md +35 -29
  4. data/README.md +24 -15
  5. data/ext/wxbase32u_gcc_custom.dll +0 -0
  6. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  7. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  19. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  20. data/lib/wx/aui/aui_tab_ctrl.rb +18 -0
  21. data/lib/wx/aui/auinotebook.rb +6 -2
  22. data/lib/wx/aui/require.rb +1 -0
  23. data/lib/wx/core/app.rb +2 -2
  24. data/lib/wx/core/bitmap_combobox.rb +17 -21
  25. data/lib/wx/core/collapsible_pane.rb +1 -1
  26. data/lib/wx/core/combobox.rb +13 -3
  27. data/lib/wx/core/controlwithitems.rb +40 -128
  28. data/lib/wx/core/enum.rb +17 -1
  29. data/lib/wx/core/event.rb +6 -1
  30. data/lib/wx/core/events/evt_list.rb +5 -4
  31. data/lib/wx/core/evthandler.rb +8 -2
  32. data/lib/wx/core/generic_validator.rb +312 -0
  33. data/lib/wx/core/listbox.rb +2 -2
  34. data/lib/wx/core/log.rb +1 -1
  35. data/lib/wx/core/menu.rb +10 -0
  36. data/lib/wx/core/notebook.rb +6 -2
  37. data/lib/wx/core/owner_drawn_combobox.rb +45 -0
  38. data/lib/wx/core/size.rb +4 -0
  39. data/lib/wx/core/sizer.rb +12 -2
  40. data/lib/wx/core/standard_paths.rb +22 -0
  41. data/lib/wx/core/task_bar_button.rb +19 -0
  42. data/lib/wx/core/text_entry.rb +4 -1
  43. data/lib/wx/core/textctrl.rb +11 -1
  44. data/lib/wx/core/{treectrl.rb → tree_ctrl.rb} +31 -12
  45. data/lib/wx/core/validator.rb +70 -5
  46. data/lib/wx/core/window.rb +13 -7
  47. data/lib/wx/doc/app.rb +48 -38
  48. data/lib/wx/doc/art_locator.rb +48 -43
  49. data/lib/wx/doc/aui/auimanager.rb +16 -8
  50. data/lib/wx/doc/aui/auinotebook.rb +20 -5
  51. data/lib/wx/doc/clipboard.rb +11 -7
  52. data/lib/wx/doc/colour_dialog.rb +14 -10
  53. data/lib/wx/doc/comboctrl.rb +18 -0
  54. data/lib/wx/doc/controlwithitems.rb +34 -8
  55. data/lib/wx/doc/data_object.rb +2 -2
  56. data/lib/wx/doc/date_picker_ctrl.rb +23 -0
  57. data/lib/wx/doc/editable_listbox.rb +44 -0
  58. data/lib/wx/doc/enum.rb +15 -0
  59. data/lib/wx/doc/event.rb +12 -0
  60. data/lib/wx/doc/evthandler.rb +113 -108
  61. data/lib/wx/doc/extra/12_client_data.md +89 -0
  62. data/lib/wx/doc/extra/13_validators.md +139 -0
  63. data/lib/wx/doc/font.rb +1 -0
  64. data/lib/wx/doc/gc_dc.rb +6 -1
  65. data/lib/wx/doc/gdi_common.rb +4 -0
  66. data/lib/wx/doc/gen/about_dialog_info.rb +26 -2
  67. data/lib/wx/doc/gen/accelerator.rb +19 -4
  68. data/lib/wx/doc/gen/accessible.rb +48 -47
  69. data/lib/wx/doc/gen/activity_indicator.rb +10 -4
  70. data/lib/wx/doc/gen/animation.rb +19 -3
  71. data/lib/wx/doc/gen/animation_ctrl.rb +16 -7
  72. data/lib/wx/doc/gen/any_button.rb +22 -1
  73. data/lib/wx/doc/gen/app.rb +41 -5
  74. data/lib/wx/doc/gen/app_traits.rb +65 -15
  75. data/lib/wx/doc/gen/art_provider.rb +33 -7
  76. data/lib/wx/doc/gen/aui/aui_dock_art.rb +18 -3
  77. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +2 -0
  78. data/lib/wx/doc/gen/aui/aui_manager.rb +35 -8
  79. data/lib/wx/doc/gen/aui/aui_manager_event.rb +11 -4
  80. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +4 -0
  81. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +3 -0
  82. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +8 -1
  83. data/lib/wx/doc/gen/aui/aui_notebook.rb +31 -7
  84. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +5 -4
  85. data/lib/wx/doc/gen/aui/aui_pane_info.rb +38 -2
  86. data/lib/wx/doc/gen/aui/aui_tab_art.rb +9 -3
  87. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +2 -1
  88. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +20 -6
  89. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +4 -2
  90. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +5 -7
  91. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +5 -1
  92. data/lib/wx/doc/gen/aui/event_list.rb +164 -160
  93. data/lib/wx/doc/gen/banner_window.rb +8 -1
  94. data/lib/wx/doc/gen/bitmap.rb +94 -16
  95. data/lib/wx/doc/gen/bitmap_button.rb +16 -8
  96. data/lib/wx/doc/gen/bitmap_combo_box.rb +20 -10
  97. data/lib/wx/doc/gen/book_ctrl_base.rb +31 -4
  98. data/lib/wx/doc/gen/book_ctrl_event.rb +9 -3
  99. data/lib/wx/doc/gen/box_sizer.rb +5 -1
  100. data/lib/wx/doc/gen/brush.rb +20 -2
  101. data/lib/wx/doc/gen/busy_info.rb +10 -2
  102. data/lib/wx/doc/gen/button.rb +31 -11
  103. data/lib/wx/doc/gen/calculate_layout_event.rb +5 -3
  104. data/lib/wx/doc/gen/calendar_ctrl.rb +38 -13
  105. data/lib/wx/doc/gen/calendar_date_attr.rb +2 -1
  106. data/lib/wx/doc/gen/calendar_event.rb +5 -2
  107. data/lib/wx/doc/gen/caret.rb +3 -1
  108. data/lib/wx/doc/gen/check_box.rb +17 -7
  109. data/lib/wx/doc/gen/check_list_box.rb +8 -6
  110. data/lib/wx/doc/gen/choice.rb +28 -9
  111. data/lib/wx/doc/gen/choicebook.rb +7 -7
  112. data/lib/wx/doc/gen/client_dc.rb +6 -2
  113. data/lib/wx/doc/gen/clipboard.rb +16 -3
  114. data/lib/wx/doc/gen/collapsible_pane.rb +9 -7
  115. data/lib/wx/doc/gen/collapsible_pane_event.rb +3 -3
  116. data/lib/wx/doc/gen/colour.rb +28 -4
  117. data/lib/wx/doc/gen/colour_dialog.rb +15 -7
  118. data/lib/wx/doc/gen/colour_picker_ctrl.rb +13 -10
  119. data/lib/wx/doc/gen/colour_picker_event.rb +5 -5
  120. data/lib/wx/doc/gen/combo_box.rb +36 -14
  121. data/lib/wx/doc/gen/combo_ctrl.rb +117 -295
  122. data/lib/wx/doc/gen/command_link_button.rb +12 -5
  123. data/lib/wx/doc/gen/context_help_button.rb +13 -3
  124. data/lib/wx/doc/gen/control.rb +22 -8
  125. data/lib/wx/doc/gen/control_with_items.rb +45 -10
  126. data/lib/wx/doc/gen/core.rb +4 -4
  127. data/lib/wx/doc/gen/cursor.rb +10 -8
  128. data/lib/wx/doc/gen/data_format.rb +7 -1
  129. data/lib/wx/doc/gen/data_object.rb +42 -18
  130. data/lib/wx/doc/gen/date_event.rb +3 -2
  131. data/lib/wx/doc/gen/date_picker_ctrl.rb +18 -8
  132. data/lib/wx/doc/gen/dc.rb +238 -36
  133. data/lib/wx/doc/gen/defs.rb +51 -51
  134. data/lib/wx/doc/gen/dial_up_event.rb +2 -1
  135. data/lib/wx/doc/gen/dial_up_manager.rb +25 -5
  136. data/lib/wx/doc/gen/dialog.rb +72 -13
  137. data/lib/wx/doc/gen/dir_dialog.rb +22 -5
  138. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +2 -0
  139. data/lib/wx/doc/gen/dir_picker_ctrl.rb +14 -10
  140. data/lib/wx/doc/gen/drag_drop.rb +28 -7
  141. data/lib/wx/doc/gen/drag_image.rb +13 -2
  142. data/lib/wx/doc/gen/editable_list_box.rb +7 -5
  143. data/lib/wx/doc/gen/event.rb +57 -26
  144. data/lib/wx/doc/gen/event_blocker.rb +2 -3
  145. data/lib/wx/doc/gen/event_filter.rb +3 -0
  146. data/lib/wx/doc/gen/event_list.rb +1656 -1652
  147. data/lib/wx/doc/gen/events.rb +305 -173
  148. data/lib/wx/doc/gen/evt_handler.rb +49 -3
  149. data/lib/wx/doc/gen/ext_help_controller.rb +10 -1
  150. data/lib/wx/doc/gen/file_ctrl.rb +28 -10
  151. data/lib/wx/doc/gen/file_ctrl_event.rb +7 -4
  152. data/lib/wx/doc/gen/file_dialog.rb +44 -14
  153. data/lib/wx/doc/gen/file_dialog_custom_control.rb +19 -0
  154. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +11 -3
  155. data/lib/wx/doc/gen/file_dir_picker_event.rb +4 -4
  156. data/lib/wx/doc/gen/file_picker_ctrl.rb +12 -9
  157. data/lib/wx/doc/gen/file_system.rb +54 -15
  158. data/lib/wx/doc/gen/find_dialog_event.rb +6 -4
  159. data/lib/wx/doc/gen/find_replace_data.rb +2 -1
  160. data/lib/wx/doc/gen/find_replace_dialog.rb +4 -1
  161. data/lib/wx/doc/gen/flex_grid_sizer.rb +13 -1
  162. data/lib/wx/doc/gen/font.rb +103 -20
  163. data/lib/wx/doc/gen/font_data.rb +16 -3
  164. data/lib/wx/doc/gen/font_dialog.rb +6 -1
  165. data/lib/wx/doc/gen/font_picker_ctrl.rb +14 -7
  166. data/lib/wx/doc/gen/font_picker_event.rb +3 -3
  167. data/lib/wx/doc/gen/frame.rb +73 -15
  168. data/lib/wx/doc/gen/fs_file.rb +39 -10
  169. data/lib/wx/doc/gen/gauge.rb +19 -8
  170. data/lib/wx/doc/gen/gb_sizer_item.rb +5 -1
  171. data/lib/wx/doc/gen/gcdc.rb +3 -2
  172. data/lib/wx/doc/gen/gdi_common.rb +80 -11
  173. data/lib/wx/doc/gen/gdi_object.rb +1 -1
  174. data/lib/wx/doc/gen/generic_dir_ctrl.rb +13 -7
  175. data/lib/wx/doc/gen/graphics_context.rb +86 -10
  176. data/lib/wx/doc/gen/graphics_object.rb +35 -6
  177. data/lib/wx/doc/gen/grid/event_list.rb +168 -164
  178. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +3 -0
  179. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +16 -3
  180. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -1
  181. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +2 -1
  182. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +2 -1
  183. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -1
  184. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +2 -1
  185. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +2 -1
  186. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +2 -1
  187. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +2 -1
  188. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +10 -1
  189. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +2 -1
  190. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +2 -1
  191. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -1
  192. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +2 -1
  193. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +2 -1
  194. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -1
  195. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +7 -1
  196. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -1
  197. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -1
  198. data/lib/wx/doc/gen/grid/grid_ctrl.rb +256 -12
  199. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +6 -4
  200. data/lib/wx/doc/gen/grid/grid_event.rb +6 -4
  201. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +4 -4
  202. data/lib/wx/doc/gen/grid/grid_size_event.rb +4 -4
  203. data/lib/wx/doc/gen/grid/grid_string_table.rb +8 -0
  204. data/lib/wx/doc/gen/grid/grid_table_base.rb +28 -3
  205. data/lib/wx/doc/gen/grid/grid_table_message.rb +2 -0
  206. data/lib/wx/doc/gen/grid_bag_sizer.rb +21 -7
  207. data/lib/wx/doc/gen/grid_sizer.rb +11 -1
  208. data/lib/wx/doc/gen/gui_event_loop.rb +13 -3
  209. data/lib/wx/doc/gen/header_ctrl.rb +110 -11
  210. data/lib/wx/doc/gen/header_ctrl_event.rb +4 -2
  211. data/lib/wx/doc/gen/help_controller.rb +14 -3
  212. data/lib/wx/doc/gen/help_provider.rb +22 -4
  213. data/lib/wx/doc/gen/html/event_list.rb +41 -37
  214. data/lib/wx/doc/gen/html/html_cell.rb +48 -6
  215. data/lib/wx/doc/gen/html/html_cell_event.rb +5 -4
  216. data/lib/wx/doc/gen/html/html_easy_printing.rb +20 -3
  217. data/lib/wx/doc/gen/html/html_help_controller.rb +26 -2
  218. data/lib/wx/doc/gen/html/html_help_data.rb +8 -1
  219. data/lib/wx/doc/gen/html/html_help_window.rb +9 -1
  220. data/lib/wx/doc/gen/html/html_link_event.rb +3 -3
  221. data/lib/wx/doc/gen/html/html_list_box.rb +54 -16
  222. data/lib/wx/doc/gen/html/html_printout.rb +7 -1
  223. data/lib/wx/doc/gen/html/html_window.rb +43 -6
  224. data/lib/wx/doc/gen/hyperlink_ctrl.rb +9 -8
  225. data/lib/wx/doc/gen/hyperlink_event.rb +3 -3
  226. data/lib/wx/doc/gen/icon.rb +23 -29
  227. data/lib/wx/doc/gen/icon_location.rb +1 -1
  228. data/lib/wx/doc/gen/image.rb +143 -20
  229. data/lib/wx/doc/gen/image_list.rb +25 -6
  230. data/lib/wx/doc/gen/info_bar.rb +14 -2
  231. data/lib/wx/doc/gen/keyboard_state.rb +11 -1
  232. data/lib/wx/doc/gen/list_box.rb +46 -17
  233. data/lib/wx/doc/gen/list_ctrl.rb +165 -29
  234. data/lib/wx/doc/gen/list_event.rb +13 -4
  235. data/lib/wx/doc/gen/listbook.rb +7 -7
  236. data/lib/wx/doc/gen/locale.rb +68 -4
  237. data/lib/wx/doc/gen/log.rb +58 -12
  238. data/lib/wx/doc/gen/mdi_client_window.rb +11 -2
  239. data/lib/wx/doc/gen/mdi_frame.rb +51 -7
  240. data/lib/wx/doc/gen/media_ctrl.rb +43 -18
  241. data/lib/wx/doc/gen/media_event.rb +6 -4
  242. data/lib/wx/doc/gen/memory_dc.rb +16 -6
  243. data/lib/wx/doc/gen/menu.rb +81 -26
  244. data/lib/wx/doc/gen/menu_bar.rb +74 -15
  245. data/lib/wx/doc/gen/menu_item.rb +67 -19
  246. data/lib/wx/doc/gen/message_dialog.rb +17 -8
  247. data/lib/wx/doc/gen/mini_frame.rb +14 -5
  248. data/lib/wx/doc/gen/mirror_dc.rb +1 -2
  249. data/lib/wx/doc/gen/mouse_state.rb +1 -1
  250. data/lib/wx/doc/gen/multi_choice_dialog.rb +9 -4
  251. data/lib/wx/doc/gen/non_owned_window.rb +4 -1
  252. data/lib/wx/doc/gen/notebook.rb +27 -9
  253. data/lib/wx/doc/gen/num_validator.rb +37 -0
  254. data/lib/wx/doc/gen/number_entry_dialog.rb +5 -1
  255. data/lib/wx/doc/gen/object.rb +3 -1
  256. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +340 -0
  257. data/lib/wx/doc/gen/paint_dc.rb +1 -1
  258. data/lib/wx/doc/gen/palette.rb +5 -1
  259. data/lib/wx/doc/gen/panel.rb +25 -8
  260. data/lib/wx/doc/gen/pen.rb +46 -8
  261. data/lib/wx/doc/gen/pg/event_list.rb +97 -93
  262. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +4 -1
  263. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +12 -1
  264. data/lib/wx/doc/gen/pg/pg_cell.rb +11 -3
  265. data/lib/wx/doc/gen/pg/pg_editor.rb +161 -16
  266. data/lib/wx/doc/gen/pg/pg_multi_button.rb +3 -2
  267. data/lib/wx/doc/gen/pg/pg_properties.rb +632 -83
  268. data/lib/wx/doc/gen/pg/pg_property.rb +381 -77
  269. data/lib/wx/doc/gen/pg/pg_validation_info.rb +11 -4
  270. data/lib/wx/doc/gen/pg/property_grid.rb +123 -20
  271. data/lib/wx/doc/gen/pg/property_grid_event.rb +41 -9
  272. data/lib/wx/doc/gen/pg/property_grid_interface.rb +273 -34
  273. data/lib/wx/doc/gen/pg/property_grid_manager.rb +62 -10
  274. data/lib/wx/doc/gen/pg/property_grid_page.rb +33 -8
  275. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +18 -4
  276. data/lib/wx/doc/gen/picker_base.rb +22 -5
  277. data/lib/wx/doc/gen/platform_info.rb +35 -9
  278. data/lib/wx/doc/gen/popup_window.rb +7 -5
  279. data/lib/wx/doc/gen/progress_dialog.rb +5 -0
  280. data/lib/wx/doc/gen/property_sheet_dialog.rb +20 -4
  281. data/lib/wx/doc/gen/prt/event_list.rb +8 -4
  282. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +3 -1
  283. data/lib/wx/doc/gen/prt/post_script_dc.rb +3 -2
  284. data/lib/wx/doc/gen/prt/preview_frame.rb +5 -1
  285. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +4 -0
  286. data/lib/wx/doc/gen/prt/print_data.rb +31 -3
  287. data/lib/wx/doc/gen/prt/print_dialog.rb +5 -1
  288. data/lib/wx/doc/gen/prt/printer.rb +87 -11
  289. data/lib/wx/doc/gen/prt/printer_dc.rb +3 -1
  290. data/lib/wx/doc/gen/query_layout_info_event.rb +10 -3
  291. data/lib/wx/doc/gen/radio_box.rb +28 -10
  292. data/lib/wx/doc/gen/radio_button.rb +22 -9
  293. data/lib/wx/doc/gen/rbn/event_list.rb +127 -123
  294. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +82 -3
  295. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +26 -4
  296. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +3 -2
  297. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +50 -12
  298. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +3 -2
  299. data/lib/wx/doc/gen/rbn/ribbon_control.rb +11 -1
  300. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +21 -11
  301. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -2
  302. data/lib/wx/doc/gen/rbn/ribbon_page.rb +12 -1
  303. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +16 -4
  304. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +3 -3
  305. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +27 -3
  306. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +3 -1
  307. data/lib/wx/doc/gen/rearrange_ctrl.rb +5 -2
  308. data/lib/wx/doc/gen/rearrange_list.rb +12 -4
  309. data/lib/wx/doc/gen/region.rb +104 -17
  310. data/lib/wx/doc/gen/region_iterator.rb +1 -1
  311. data/lib/wx/doc/gen/rtc/event_list.rb +116 -112
  312. data/lib/wx/doc/gen/rtc/rich_text_box.rb +27 -9
  313. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +45 -11
  314. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -1
  315. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +23 -14
  316. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +84 -7
  317. data/lib/wx/doc/gen/rtc/rich_text_event.rb +8 -4
  318. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +8 -2
  319. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +8 -3
  320. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +4 -2
  321. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +6 -3
  322. data/lib/wx/doc/gen/rtc/rich_text_image.rb +7 -2
  323. data/lib/wx/doc/gen/rtc/rich_text_object.rb +82 -17
  324. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +54 -11
  325. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +15 -2
  326. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +14 -9
  327. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +4 -1
  328. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +4 -3
  329. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +2 -2
  330. data/lib/wx/doc/gen/sash_event.rb +13 -4
  331. data/lib/wx/doc/gen/sash_layout_window.rb +21 -4
  332. data/lib/wx/doc/gen/sash_window.rb +6 -4
  333. data/lib/wx/doc/gen/screen_dc.rb +1 -1
  334. data/lib/wx/doc/gen/scroll_bar.rb +28 -10
  335. data/lib/wx/doc/gen/scrolled_canvas.rb +48 -10
  336. data/lib/wx/doc/gen/scrolled_control.rb +48 -10
  337. data/lib/wx/doc/gen/scrolled_window.rb +48 -10
  338. data/lib/wx/doc/gen/search_ctrl.rb +14 -9
  339. data/lib/wx/doc/gen/simplebook.rb +8 -1
  340. data/lib/wx/doc/gen/single_choice_dialog.rb +9 -4
  341. data/lib/wx/doc/gen/sizer.rb +91 -16
  342. data/lib/wx/doc/gen/sizer_item.rb +21 -4
  343. data/lib/wx/doc/gen/slider.rb +50 -17
  344. data/lib/wx/doc/gen/spin_button.rb +24 -10
  345. data/lib/wx/doc/gen/spin_ctrl.rb +35 -9
  346. data/lib/wx/doc/gen/spin_ctrl_double.rb +13 -7
  347. data/lib/wx/doc/gen/spin_double_event.rb +6 -4
  348. data/lib/wx/doc/gen/spin_event.rb +4 -3
  349. data/lib/wx/doc/gen/splash_screen.rb +3 -2
  350. data/lib/wx/doc/gen/splitter_event.rb +12 -4
  351. data/lib/wx/doc/gen/splitter_window.rb +100 -18
  352. data/lib/wx/doc/gen/static_bitmap.rb +109 -7
  353. data/lib/wx/doc/gen/static_box.rb +15 -7
  354. data/lib/wx/doc/gen/static_box_sizer.rb +3 -2
  355. data/lib/wx/doc/gen/static_line.rb +7 -4
  356. data/lib/wx/doc/gen/static_text.rb +10 -6
  357. data/lib/wx/doc/gen/status_bar.rb +32 -8
  358. data/lib/wx/doc/gen/stc/event_list.rb +212 -208
  359. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +207 -13
  360. data/lib/wx/doc/gen/stc/styled_text_event.rb +31 -6
  361. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +7 -1
  362. data/lib/wx/doc/gen/svg_file_dc.rb +15 -7
  363. data/lib/wx/doc/gen/system_options.rb +14 -6
  364. data/lib/wx/doc/gen/system_settings.rb +9 -3
  365. data/lib/wx/doc/gen/task_bar_button.rb +324 -0
  366. data/lib/wx/doc/gen/task_bar_icon.rb +26 -8
  367. data/lib/wx/doc/gen/task_bar_icon_event.rb +5 -3
  368. data/lib/wx/doc/gen/text_attr.rb +47 -5
  369. data/lib/wx/doc/gen/text_ctrl.rb +114 -25
  370. data/lib/wx/doc/gen/text_entry.rb +69 -11
  371. data/lib/wx/doc/gen/text_entry_dialog.rb +14 -2
  372. data/lib/wx/doc/gen/text_validator.rb +58 -9
  373. data/lib/wx/doc/gen/time_picker_ctrl.rb +11 -6
  374. data/lib/wx/doc/gen/timer.rb +14 -2
  375. data/lib/wx/doc/gen/timer_event.rb +2 -2
  376. data/lib/wx/doc/gen/tip_provider.rb +6 -1
  377. data/lib/wx/doc/gen/toggle_button.rb +73 -6
  378. data/lib/wx/doc/gen/tool_bar.rb +141 -25
  379. data/lib/wx/doc/gen/tool_tip.rb +41 -5
  380. data/lib/wx/doc/gen/toolbook.rb +6 -4
  381. data/lib/wx/doc/gen/top_level_window.rb +100 -23
  382. data/lib/wx/doc/gen/tree_ctrl.rb +89 -16
  383. data/lib/wx/doc/gen/tree_event.rb +9 -4
  384. data/lib/wx/doc/gen/treebook.rb +16 -4
  385. data/lib/wx/doc/gen/ui_action_simulator.rb +10 -2
  386. data/lib/wx/doc/gen/utils.rb +94 -7
  387. data/lib/wx/doc/gen/v_list_box.rb +27 -2
  388. data/lib/wx/doc/gen/v_scrolled_window.rb +21 -4
  389. data/lib/wx/doc/gen/validator.rb +10 -14
  390. data/lib/wx/doc/gen/variant.rb +7 -0
  391. data/lib/wx/doc/gen/window.rb +415 -57
  392. data/lib/wx/doc/gen/window_dc.rb +2 -1
  393. data/lib/wx/doc/gen/window_disabler.rb +6 -2
  394. data/lib/wx/doc/gen/with_images.rb +13 -2
  395. data/lib/wx/doc/gen/wizard.rb +22 -4
  396. data/lib/wx/doc/gen/wizard_event.rb +5 -4
  397. data/lib/wx/doc/gen/wizard_page.rb +7 -2
  398. data/lib/wx/doc/gen/wizard_page_simple.rb +5 -1
  399. data/lib/wx/doc/gen/wrap_sizer.rb +5 -1
  400. data/lib/wx/doc/gen/xml_node.rb +33 -4
  401. data/lib/wx/doc/gen/xml_resource.rb +40 -5
  402. data/lib/wx/doc/generic_validator.rb +95 -0
  403. data/lib/wx/doc/graphics_context.rb +1 -0
  404. data/lib/wx/doc/grid/grid.rb +22 -1
  405. data/lib/wx/doc/help_controller.rb +11 -7
  406. data/lib/wx/doc/html/html_help_controller.rb +12 -4
  407. data/lib/wx/doc/html/simple_html_listbox.rb +22 -0
  408. data/lib/wx/doc/list_ctrl.rb +33 -29
  409. data/lib/wx/doc/menu.rb +20 -0
  410. data/lib/wx/doc/notebook.rb +21 -0
  411. data/lib/wx/doc/num_validator.rb +387 -0
  412. data/lib/wx/doc/owner_drawn_combobox.rb +96 -0
  413. data/lib/wx/doc/pg/events.rb +13 -9
  414. data/lib/wx/doc/pg/numeric_property_validator.rb +33 -0
  415. data/lib/wx/doc/pg/pg_property.rb +18 -0
  416. data/lib/wx/doc/progress_dialog.rb +36 -32
  417. data/lib/wx/doc/prt/page_setup_dialog.rb +20 -12
  418. data/lib/wx/doc/prt/print_data.rb +13 -5
  419. data/lib/wx/doc/prt/print_dialog.rb +31 -23
  420. data/lib/wx/doc/prt/printer.rb +20 -12
  421. data/lib/wx/doc/radio_box.rb +19 -15
  422. data/lib/wx/doc/rbn/ribbon_bar.rb +13 -5
  423. data/lib/wx/doc/rbn/ribbon_button_bar.rb +13 -5
  424. data/lib/wx/doc/rbn/ribbon_gallery.rb +13 -5
  425. data/lib/wx/doc/rbn/ribbon_tool_bar.rb +13 -5
  426. data/lib/wx/doc/region_iterator.rb +32 -28
  427. data/lib/wx/doc/rtc/rich_text_composite_object.rb +24 -0
  428. data/lib/wx/doc/rtc/rich_text_ctrl.rb +24 -0
  429. data/lib/wx/doc/rtc/rich_text_paragraph.rb +24 -0
  430. data/lib/wx/doc/rtc/richtext_buffer.rb +27 -19
  431. data/lib/wx/doc/rtc/richtext_printing.rb +17 -9
  432. data/lib/wx/doc/rtc/richtext_style_sheet.rb +17 -9
  433. data/lib/wx/doc/sizer.rb +20 -0
  434. data/lib/wx/doc/static_bitmap.rb +25 -0
  435. data/lib/wx/doc/stc/styled_text_ctrl.rb +24 -0
  436. data/lib/wx/doc/stream.rb +39 -35
  437. data/lib/wx/doc/system_settings.rb +30 -26
  438. data/lib/wx/doc/text_validator.rb +23 -9
  439. data/lib/wx/doc/textctrl.rb +16 -0
  440. data/lib/wx/doc/tree_ctrl.rb +95 -0
  441. data/lib/wx/doc/treebook.rb +9 -5
  442. data/lib/wx/doc/v_list_box.rb +9 -5
  443. data/lib/wx/doc/validator.rb +113 -0
  444. data/lib/wx/doc/variant.rb +164 -160
  445. data/lib/wx/doc/window.rb +87 -47
  446. data/lib/wx/doc/window_disabler.rb +10 -6
  447. data/lib/wx/grid/grid.rb +27 -4
  448. data/lib/wx/html/events/evt_list.rb +0 -10
  449. data/lib/wx/html/simple_html_listbox.rb +24 -91
  450. data/lib/wx/keyword_defs.rb +34 -2
  451. data/lib/wx/pg/pg_property.rb +22 -0
  452. data/lib/wx/rbn/ribbon_gallery.rb +0 -21
  453. data/lib/wx/rtc/require.rb +3 -0
  454. data/lib/wx/rtc/rich_text_composite_object.rb +25 -0
  455. data/lib/wx/rtc/rich_text_ctrl.rb +25 -0
  456. data/lib/wx/rtc/rich_text_paragraph.rb +25 -0
  457. data/lib/wx/stc/require.rb +1 -0
  458. data/lib/wx/stc/styled_text_ctrl.rb +25 -0
  459. data/lib/wx/version.rb +1 -1
  460. data/lib/wxruby_aui.so +0 -0
  461. data/lib/wxruby_core.so +0 -0
  462. data/lib/wxruby_grid.so +0 -0
  463. data/lib/wxruby_html.so +0 -0
  464. data/lib/wxruby_pg.so +0 -0
  465. data/lib/wxruby_prt.so +0 -0
  466. data/lib/wxruby_rbn.so +0 -0
  467. data/lib/wxruby_rtc.so +0 -0
  468. data/lib/wxruby_stc.so +0 -0
  469. data/rakelib/lib/config/linux.rb +0 -3
  470. data/rakelib/lib/config/macosx.rb +2 -2
  471. data/rakelib/lib/config/mingw.rb +13 -1
  472. data/rakelib/lib/config/unixish.rb +1 -1
  473. data/rakelib/lib/config.rb +14 -4
  474. data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css +74 -2
  475. data/rakelib/yard/templates/default/fulldoc/html/full_list.erb +38 -0
  476. data/rakelib/yard/templates/default/fulldoc/html/setup.rb +39 -0
  477. data/rakelib/yard/templates/default/tags/html/wxrb_require.erb +10 -0
  478. data/rakelib/yard/templates/default/tags/setup.rb +16 -0
  479. data/rakelib/yard/yard-custom-templates.rb +3 -0
  480. data/samples/aui/aui.rb +1237 -1233
  481. data/samples/calendar/calendar.rb +293 -289
  482. data/samples/controls/get_item_sample.rb +83 -79
  483. data/samples/controls/htlbox.rb +331 -327
  484. data/samples/dialogs/dialogs.rb +682 -694
  485. data/samples/dialogs/wizard.rb +52 -55
  486. data/samples/dragdrop/dragdrop.rb +146 -142
  487. data/samples/drawing/bitmap.rb +29 -26
  488. data/samples/drawing/bitmap_image.rb +84 -80
  489. data/samples/drawing/graphics_drawing.rb +209 -205
  490. data/samples/drawing/image_prt.rb +344 -340
  491. data/samples/drawing/maths_images.rb +18 -1
  492. data/samples/drawing/rmagic_bitmap_image.rb +88 -84
  493. data/samples/etc/caret.rb +306 -0
  494. data/samples/etc/miniframe.rb +65 -60
  495. data/samples/etc/sash.rb +109 -105
  496. data/samples/etc/scrollwin.rb +86 -80
  497. data/samples/etc/system_settings.rb +216 -209
  498. data/samples/event/activation.rb +72 -67
  499. data/samples/event/event.rb +160 -153
  500. data/samples/event/threaded.rb +8 -1
  501. data/samples/event/update_ui_event.rb +67 -60
  502. data/samples/grid/grid.rb +188 -181
  503. data/samples/grid/gridtablebase.rb +136 -129
  504. data/samples/html/html.rb +208 -204
  505. data/samples/mdi/mdi.rb +59 -54
  506. data/samples/minimal/minimal.rb +54 -51
  507. data/samples/minimal/nothing.rb +1 -0
  508. data/samples/printing/printing.rb +367 -377
  509. data/samples/printing/printing2.rb +203 -198
  510. data/samples/propgrid/propgrid.rb +2312 -2308
  511. data/samples/propgrid/propgrid_minimal.rb +57 -50
  512. data/samples/ribbon/ribbon.rb +780 -774
  513. data/samples/sampler/ext.rb +0 -33
  514. data/samples/sampler/sample.rb +4 -9
  515. data/samples/sampler.rb +1 -1
  516. data/samples/splash/splash.rb +118 -116
  517. data/samples/text/rich_textctrl.rb +207 -201
  518. data/samples/text/richtext.rb +1409 -1405
  519. data/samples/text/scintilla.rb +137 -128
  520. data/samples/text/textctrl.rb +89 -83
  521. data/samples/text/unicode.rb +175 -168
  522. data/samples/treectrl/treectrl.rb +1430 -1426
  523. data/samples/widgets/activityindicator.rb +95 -0
  524. data/samples/widgets/art/widgets/activityindicator.xpm +278 -0
  525. data/samples/widgets/art/widgets/bmpbtn.xpm +37 -0
  526. data/samples/widgets/art/widgets/bmpcombobox.xpm +54 -0
  527. data/samples/widgets/art/widgets/button.xpm +54 -0
  528. data/samples/widgets/art/widgets/checkbox.xpm +54 -0
  529. data/samples/{bigdemo/icons → widgets/art/widgets}/choice.xpm +1 -1
  530. data/samples/widgets/art/widgets/choicebk.xpm +54 -0
  531. data/samples/widgets/art/widgets/clrpicker.xpm +193 -0
  532. data/samples/widgets/art/widgets/combobox.xpm +54 -0
  533. data/samples/widgets/art/widgets/datepick.xpm +200 -0
  534. data/samples/widgets/art/widgets/dirctrl.xpm +54 -0
  535. data/samples/widgets/art/widgets/dirpicker.xpm +213 -0
  536. data/samples/widgets/art/widgets/filepicker.xpm +214 -0
  537. data/samples/widgets/art/widgets/fontpicker.xpm +185 -0
  538. data/samples/widgets/art/widgets/gauge.xpm +54 -0
  539. data/samples/widgets/art/widgets/header.xpm +54 -0
  540. data/samples/widgets/art/widgets/hyperlnk.xpm +54 -0
  541. data/samples/widgets/art/widgets/listbook.xpm +54 -0
  542. data/samples/widgets/art/widgets/listbox.xpm +54 -0
  543. data/samples/widgets/art/widgets/native.xpm +81 -0
  544. data/samples/widgets/art/widgets/notebook.xpm +54 -0
  545. data/samples/widgets/art/widgets/odcombobox.xpm +54 -0
  546. data/samples/widgets/art/widgets/radiobox.xpm +54 -0
  547. data/samples/widgets/art/widgets/scrolbar.xpm +54 -0
  548. data/samples/widgets/art/widgets/slider.xpm +54 -0
  549. data/samples/widgets/art/widgets/spinbtn.xpm +40 -0
  550. data/samples/widgets/art/widgets/statbmp.xpm +40 -0
  551. data/samples/widgets/art/widgets/statbox.xpm +54 -0
  552. data/samples/widgets/art/widgets/stattext.xpm +54 -0
  553. data/samples/widgets/art/widgets/text.xpm +54 -0
  554. data/samples/widgets/art/widgets/timepick.xpm +207 -0
  555. data/samples/widgets/art/widgets/toggle.xpm +54 -0
  556. data/samples/widgets/art/widgets/toucan.png +0 -0
  557. data/samples/widgets/bmpcombobox.rb +651 -0
  558. data/samples/widgets/button.rb +462 -0
  559. data/samples/widgets/checkbox.rb +211 -0
  560. data/samples/widgets/choice.rb +287 -0
  561. data/samples/widgets/clrpicker.rb +156 -0
  562. data/samples/widgets/combobox.rb +516 -0
  563. data/samples/widgets/datepick.rb +215 -0
  564. data/samples/widgets/dirctrl.rb +265 -0
  565. data/samples/widgets/dirpicker.rb +158 -0
  566. data/samples/widgets/editlbox.rb +122 -0
  567. data/samples/widgets/filectrl.rb +216 -0
  568. data/samples/widgets/filepicker.rb +214 -0
  569. data/samples/widgets/fontpicker.rb +135 -0
  570. data/samples/widgets/gauge.rb +311 -0
  571. data/samples/widgets/headerctrl.rb +236 -0
  572. data/samples/widgets/hyperlink.rb +203 -0
  573. data/samples/widgets/itemcontainer.rb +185 -0
  574. data/samples/widgets/listbox.rb +473 -0
  575. data/samples/widgets/notebook.rb +488 -0
  576. data/samples/widgets/odcombobox.rb +608 -0
  577. data/samples/widgets/radiobox.rb +328 -0
  578. data/samples/widgets/searchctrl.rb +159 -0
  579. data/samples/widgets/slider.rb +594 -0
  580. data/samples/widgets/spinbtn.rb +443 -0
  581. data/samples/widgets/statbmp.rb +130 -0
  582. data/samples/widgets/static.rb +436 -0
  583. data/samples/widgets/textctrl.rb +700 -0
  584. data/samples/widgets/timepick.rb +148 -0
  585. data/samples/widgets/tn_widgets.png +0 -0
  586. data/samples/widgets/toggle.rb +385 -0
  587. data/samples/widgets/widgets.rb +1233 -0
  588. data/samples/xrc/custom_xrc_sample.rb +47 -41
  589. data/samples/xrc/xrc_sample.rb +53 -47
  590. data/tests/media/beep_lo.wav +0 -0
  591. data/tests/test_event_handling.rb +52 -34
  592. data/tests/test_events.rb +7 -0
  593. data/tests/test_item_data.rb +24 -0
  594. data/tests/test_list_ctrl.rb +1 -1
  595. data/tests/test_media_ctrl.rb +38 -0
  596. data/tests/test_menu.rb +69 -0
  597. data/tests/test_pg.rb +27 -0
  598. data/tests/test_richtext.rb +45 -0
  599. data/tests/test_sizer.rb +59 -0
  600. data/tests/test_std_controls.rb +42 -1
  601. data/tests/test_styled_text_ctrl.rb +46 -0
  602. data/tests/test_tree_ctrl.rb +138 -0
  603. data/tests/test_validators.rb +805 -0
  604. data/tests/test_window.rb +12 -0
  605. data/tests/testapp_noframe.rb +1 -1
  606. metadata +113 -138
  607. data/lib/wx/core/choice.rb +0 -14
  608. data/lib/wx/core/combo_ctrl.rb +0 -110
  609. data/samples/bigdemo/About.rbw +0 -39
  610. data/samples/bigdemo/ColorPanel.rbw +0 -23
  611. data/samples/bigdemo/GridSimple.rbw +0 -78
  612. data/samples/bigdemo/MDIDemo.rbw +0 -57
  613. data/samples/bigdemo/PopupMenu.rbw +0 -146
  614. data/samples/bigdemo/ShapedWindow.rbw +0 -128
  615. data/samples/bigdemo/Sizers.rbw +0 -541
  616. data/samples/bigdemo/bigdemo.rb +0 -817
  617. data/samples/bigdemo/demoTemplate.rbw +0 -33
  618. data/samples/bigdemo/helpfile.htb +0 -0
  619. data/samples/bigdemo/icons/Test 015.jpg +0 -0
  620. data/samples/bigdemo/icons/Test 015.png +0 -0
  621. data/samples/bigdemo/icons/choice.bmp +0 -0
  622. data/samples/bigdemo/icons/combo.bmp +0 -0
  623. data/samples/bigdemo/icons/combo.xpm +0 -27
  624. data/samples/bigdemo/icons/copy.xpm +0 -25
  625. data/samples/bigdemo/icons/cut.xpm +0 -24
  626. data/samples/bigdemo/icons/gauge.bmp +0 -0
  627. data/samples/bigdemo/icons/gauge.xpm +0 -27
  628. data/samples/bigdemo/icons/help.xpm +0 -25
  629. data/samples/bigdemo/icons/list.bmp +0 -0
  630. data/samples/bigdemo/icons/list.xpm +0 -27
  631. data/samples/bigdemo/icons/mondrian.ico +0 -0
  632. data/samples/bigdemo/icons/mondrian.xpm +0 -44
  633. data/samples/bigdemo/icons/new.xpm +0 -24
  634. data/samples/bigdemo/icons/ogl.ico +0 -0
  635. data/samples/bigdemo/icons/ogl.xpm +0 -45
  636. data/samples/bigdemo/icons/open.xpm +0 -26
  637. data/samples/bigdemo/icons/paste.bmp +0 -0
  638. data/samples/bigdemo/icons/paste.xpm +0 -38
  639. data/samples/bigdemo/icons/pointy.png +0 -0
  640. data/samples/bigdemo/icons/preview.xpm +0 -26
  641. data/samples/bigdemo/icons/print.xpm +0 -26
  642. data/samples/bigdemo/icons/radio.bmp +0 -0
  643. data/samples/bigdemo/icons/radio.xpm +0 -27
  644. data/samples/bigdemo/icons/robert.xpm +0 -415
  645. data/samples/bigdemo/icons/sashtest.ico +0 -0
  646. data/samples/bigdemo/icons/save.xpm +0 -25
  647. data/samples/bigdemo/icons/smiles.bmp +0 -0
  648. data/samples/bigdemo/icons/smiles.xpm +0 -39
  649. data/samples/bigdemo/icons/smiley.ico +0 -0
  650. data/samples/bigdemo/icons/smiley.xpm +0 -42
  651. data/samples/bigdemo/icons/stattext.xpm +0 -24
  652. data/samples/bigdemo/icons/test2.bmp +0 -0
  653. data/samples/bigdemo/icons/test2.png +0 -0
  654. data/samples/bigdemo/icons/test2.xpm +0 -79
  655. data/samples/bigdemo/icons/text.bmp +0 -0
  656. data/samples/bigdemo/icons/text.xpm +0 -27
  657. data/samples/bigdemo/icons/tog1.bmp +0 -0
  658. data/samples/bigdemo/icons/tog1.xpm +0 -38
  659. data/samples/bigdemo/icons/tog2.bmp +0 -0
  660. data/samples/bigdemo/icons/tog2.xpm +0 -38
  661. data/samples/bigdemo/icons/wxruby-128x128.png +0 -0
  662. data/samples/bigdemo/icons/wxwin.ico +0 -0
  663. data/samples/bigdemo/icons/wxwin16x16.png +0 -0
  664. data/samples/bigdemo/icons/wxwin16x16.xpm +0 -25
  665. data/samples/bigdemo/icons/wxwin32x32.png +0 -0
  666. data/samples/bigdemo/icons/wxwin48x48.png +0 -0
  667. data/samples/bigdemo/run.rb +0 -98
  668. data/samples/bigdemo/tips.txt +0 -7
  669. data/samples/bigdemo/utils.rb +0 -20
  670. data/samples/bigdemo/wxArtProvider.rbw +0 -282
  671. data/samples/bigdemo/wxBitmapButton.rbw +0 -65
  672. data/samples/bigdemo/wxButton.rbw +0 -64
  673. data/samples/bigdemo/wxCalendarCtrl.rbw +0 -59
  674. data/samples/bigdemo/wxCheckBox.rbw +0 -50
  675. data/samples/bigdemo/wxCheckListBox.rbw +0 -65
  676. data/samples/bigdemo/wxChoice.rbw +0 -47
  677. data/samples/bigdemo/wxChoicebook.rbw +0 -78
  678. data/samples/bigdemo/wxColourDialog.rbw +0 -33
  679. data/samples/bigdemo/wxComboBox.rbw +0 -77
  680. data/samples/bigdemo/wxCursor.rbw +0 -136
  681. data/samples/bigdemo/wxDialog.rbw +0 -74
  682. data/samples/bigdemo/wxDirDialog.rbw +0 -29
  683. data/samples/bigdemo/wxDragImage.rbw +0 -70
  684. data/samples/bigdemo/wxFileDialog.rbw +0 -37
  685. data/samples/bigdemo/wxFileDialog_Save.rbw +0 -35
  686. data/samples/bigdemo/wxFindReplaceDialog.rbw +0 -82
  687. data/samples/bigdemo/wxFontDialog.rbw +0 -200
  688. data/samples/bigdemo/wxFrame.rbw +0 -53
  689. data/samples/bigdemo/wxGauge.rbw +0 -65
  690. data/samples/bigdemo/wxGenericDirCtrl.rbw +0 -74
  691. data/samples/bigdemo/wxGrid.rbw +0 -66
  692. data/samples/bigdemo/wxHtmlHelpController.rbw +0 -52
  693. data/samples/bigdemo/wxListBox.rbw +0 -140
  694. data/samples/bigdemo/wxListCtrl_virtual.rbw +0 -112
  695. data/samples/bigdemo/wxMDIWindows.rbw +0 -50
  696. data/samples/bigdemo/wxMenu.rbw +0 -247
  697. data/samples/bigdemo/wxMessageDialog.rbw +0 -27
  698. data/samples/bigdemo/wxMiniFrame.rbw +0 -70
  699. data/samples/bigdemo/wxMultipleChoiceDialog.rbw +0 -29
  700. data/samples/bigdemo/wxNotebook.rbw +0 -136
  701. data/samples/bigdemo/wxProgressDialog.rbw +0 -43
  702. data/samples/bigdemo/wxRadioBox.rbw +0 -72
  703. data/samples/bigdemo/wxRadioButton.rbw +0 -125
  704. data/samples/bigdemo/wxSashWindow.rbw +0 -141
  705. data/samples/bigdemo/wxScrolledMessageDialog.rbw +0 -57
  706. data/samples/bigdemo/wxScrolledWindow.rbw +0 -199
  707. data/samples/bigdemo/wxSingleChoiceDialog.rbw +0 -33
  708. data/samples/bigdemo/wxSlider.rbw +0 -42
  709. data/samples/bigdemo/wxSpinButton.rbw +0 -50
  710. data/samples/bigdemo/wxSpinCtrl.rbw +0 -51
  711. data/samples/bigdemo/wxSplitterWindow.rbw +0 -63
  712. data/samples/bigdemo/wxStaticBitmap.rbw +0 -47
  713. data/samples/bigdemo/wxStaticText.rbw +0 -55
  714. data/samples/bigdemo/wxStatusBar.rbw +0 -126
  715. data/samples/bigdemo/wxTextCtrl.rbw +0 -149
  716. data/samples/bigdemo/wxTextEntryDialog.rbw +0 -31
  717. data/samples/bigdemo/wxToggleButton.rbw +0 -49
  718. data/samples/bigdemo/wxToolBar.rbw +0 -131
  719. data/samples/bigdemo/wxTreeCtrl.rbw +0 -191
  720. data/samples/caret/caret.rb +0 -298
  721. data/samples/caret/mondrian.xpm +0 -44
  722. data/samples/controls/books.rb +0 -189
  723. data/samples/controls/choice.xpm +0 -27
  724. data/samples/controls/combo.xpm +0 -27
  725. data/samples/controls/controls.rb +0 -1099
  726. data/samples/controls/gauge.xpm +0 -27
  727. data/samples/controls/list.xpm +0 -27
  728. data/samples/controls/mondrian.ico +0 -0
  729. data/samples/controls/mondrian.xpm +0 -44
  730. data/samples/controls/radio.xpm +0 -27
  731. data/samples/controls/stattext.xpm +0 -24
  732. data/samples/controls/test2.bmp +0 -0
  733. data/samples/controls/text.xpm +0 -27
  734. data/samples/controls/tn_books.png +0 -0
  735. data/samples/controls/tn_controls.png +0 -0
  736. data/samples/etc/choice.rb +0 -87
  737. data/samples/etc/tn_choice.png +0 -0
  738. data/samples/text/mondrian.ico +0 -0
  739. data/samples/text/mondrian.xpm +0 -44
  740. /data/samples/{caret → etc}/tn_caret.png +0 -0
@@ -136,22 +136,25 @@ module Wx
136
136
  def self.get_active_window; end
137
137
 
138
138
  # Returns the first top level parent of the given window, or in other words, the frame or dialog containing it, or NULL.
139
+ #
139
140
  # Notice that if window is itself already a TLW, it is returned directly.
140
141
  # @param window [Wx::Window]
141
142
  # @return [Wx::Window]
142
143
  def self.get_top_level_parent(window) end
143
144
 
144
145
  # Return a string with human-readable platform-specific description of the window useful for diagnostic purposes.
146
+ #
145
147
  # The string returned from this function doesn't have any fixed form and can vary between different wxWidgets ports and versions, but contains some useful description of the window and uniquely identifies it. This can be useful to include in debug or tracing messages.
146
148
  # @param window [Wx::Window] Window pointer which is allowed to be NULL.
147
149
  # @return [String]
148
150
  def self.dump_window(window) end
149
151
 
150
152
  # {Wx::Window} is the base class for all windows and represents any visible object on screen.
153
+ #
151
154
  # All controls, top level windows and so on are windows. Sizers and device contexts are not, however, as they don't appear on screen themselves.
152
155
  # Please note that all children of the window will be deleted automatically by the destructor before the window itself is deleted which means that you don't have to worry about deleting them manually. Please see the window deletion overview for more information.
153
156
  # Also note that in this, and many others, wxWidgets classes some <code>GetXXX()</code> methods may be overloaded (as, for example, {Wx::Window#get_size} or {Wx::Window#get_client_size}). In this case, the overloads are non-virtual because having multiple virtual functions with the same name results in a virtual function name hiding at the derived class level (in English, this means that the derived class has to override all overloaded variants if it overrides any of them). To allow overriding them in the derived class, wxWidgets uses a unique protected virtual <code>DoGetXXX()</code> method and all <code>GetXXX()</code> ones are forwarded to it, so overriding the former changes the behaviour of the latter.
154
- # === Styles
157
+ # ### Styles
155
158
  #
156
159
  # This class supports the following styles:
157
160
  #
@@ -183,13 +186,13 @@ module Wx
183
186
  #
184
187
  # - {Wx::HSCROLL}: Use this style to enable a horizontal scrollbar. The same limitations as for {Wx::VSCROLL} apply to this style.
185
188
  #
186
- # - {Wx::ALWAYS_SHOW_SB}: If a window has scrollbars, disable them instead of hiding them when they are not needed (i.e. when the size of the window is big enough to not require the scrollbars to navigate it). This style is currently implemented for wxMSW, wxGTK and {Wx::Universal} and does nothing on the other platforms.
189
+ # - {Wx::ALWAYS_SHOW_SB}: If a window has scrollbars, disable them instead of hiding them when they are not needed (i.e. when the size of the window is big enough to not require the scrollbars to navigate it). This style is currently implemented for WXMSW, WXGTK and {Wx::Universal} and does nothing on the other platforms.
187
190
  #
188
191
  # - {Wx::CLIP_CHILDREN}: Use this style to eliminate flicker caused by the background being repainted, then children being painted over them. Windows only.
189
192
  #
190
193
  # - {Wx::FULL_REPAINT_ON_RESIZE}: Use this style to force a complete redraw of the window whenever it is resized instead of redrawing just the part of the window affected by resizing. Note that this was the behaviour by default before 2.5.1 release and that if you experience redraw problems with code which previously used to work you may want to try this. Currently this style applies on GTK+ 2 and Windows only, and full repainting is always done on other platforms.
191
194
  #
192
- # === Extra Styles
195
+ # ### Extra Styles
193
196
  #
194
197
  # This class supports the following extra styles:
195
198
  #
@@ -203,7 +206,7 @@ module Wx
203
206
  #
204
207
  # - {Wx::WS_EX_PROCESS_UI_UPDATES}: This window should always process UI update events, even if the mode set by {Wx::UpdateUIEvent.set_mode} is {Wx::UpdateUIMode::UPDATE_UI_PROCESS_SPECIFIED}.
205
208
  #
206
- # === Events emitted by this class
209
+ # ### Events emitted by this class
207
210
  #
208
211
  # Event handler methods for events emitted by this class:
209
212
  #
@@ -255,8 +258,6 @@ module Wx
255
258
  #
256
259
  # - {Wx::EvtHandler#evt_sys_colour_changed}(meth = nil, &block): Process a {Wx::EVT_SYS_COLOUR_CHANGED} event. See {Wx::SysColourChangedEvent}.
257
260
  #
258
- # ===
259
- #
260
261
  # Category: Miscellaneous Windows
261
262
  # @see Events and Event Handling
262
263
  # @see Window Sizing Overview
@@ -266,6 +267,7 @@ module Wx
266
267
 
267
268
  # This method may be overridden in the derived classes to return false to indicate that this control doesn't accept input at all (i.e. behaves like e.g. {Wx::StaticText}) and so doesn't need focus.
268
269
  #
270
+ #
269
271
  # @see Wx::Window#accepts_focus_from_keyboard
270
272
  # @return [Boolean]
271
273
  def accepts_focus; end
@@ -275,11 +277,13 @@ module Wx
275
277
  def accepts_focus_from_keyboard; end
276
278
 
277
279
  # Overridden to indicate whether this window or one of its children accepts focus.
280
+ #
278
281
  # Usually it's the same as {Wx::Window#accepts_focus} but is overridden for container windows.
279
282
  # @return [Boolean]
280
283
  def accepts_focus_recursively; end
281
284
 
282
285
  # Disable giving focus to this window using the keyboard navigation keys.
286
+ #
283
287
  # Pressing TAB key will skip this window if this function was called on it, but it will still be possible to focus it by clicking on it with a pointing device.
284
288
  # @return [void]
285
289
  def disable_focus_from_keyboard; end
@@ -290,6 +294,7 @@ module Wx
290
294
  alias_method :focusable?, :is_focusable
291
295
 
292
296
  # Can this window have focus right now?
297
+ #
293
298
  # If this method returns true, it means that calling {Wx::Window#set_focus} will put focus either to this window or one of its children, if you need to know whether this window accepts focus itself, use {Wx::Window#is_focusable}
294
299
  # @return [Boolean]
295
300
  def can_accept_focus; end
@@ -302,12 +307,14 @@ module Wx
302
307
 
303
308
  # Returns true if the window (or in case of composite controls, its main child window) has focus.
304
309
  #
310
+ #
305
311
  # @see Wx::Window.find_focus
306
312
  # @return [Boolean]
307
313
  def has_focus; end
308
314
  alias_method :has_focus?, :has_focus
309
315
 
310
316
  # This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0).
317
+ #
311
318
  # It is called by wxWidgets' container control code to give the native system a hint when doing TAB traversal. A call to this does not disable or change the effect of programmatically calling {Wx::Window#set_focus}.
312
319
  # @see Wx::FocusEvent
313
320
  # @see Wx::Panel#set_focus
@@ -318,6 +325,7 @@ module Wx
318
325
  alias_method :can_focus=, :set_can_focus
319
326
 
320
327
  # Enables or disables visible indication of keyboard focus.
328
+ #
321
329
  # By default, controls behave in platform-appropriate way and show focus in the same way native applications do. In some very rare circumstances it may be desirable to change the default (notably multiline text controls don't normally have a focus indicator on Mac), which this method allows. It should only be used if you have a good understanding of the native platform's guidelines and user expectations.
322
330
  # This method is only implemented on Mac.
323
331
  # @param enable [Boolean]
@@ -326,6 +334,7 @@ module Wx
326
334
 
327
335
  # This sets the window to receive keyboard input.
328
336
  #
337
+ #
329
338
  # @see Wx::Window#has_focus
330
339
  # @see Wx::FocusEvent
331
340
  # @see Wx::Panel#set_focus
@@ -334,28 +343,33 @@ module Wx
334
343
  def set_focus; end
335
344
 
336
345
  # This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g. using TAB key).
346
+ #
337
347
  # By default this method simply calls {Wx::Window#set_focus} but can be overridden to do something in addition to this in the derived classes.
338
348
  # @return [void]
339
349
  def set_focus_from_kbd; end
340
350
 
341
351
  # Adds a child window.
352
+ #
342
353
  # This is called automatically by window creation functions so should not be required by the application programmer. Notice that this function is mostly internal to wxWidgets and shouldn't be called by the user code.
343
354
  # @param child [Wx::Window] Child window to add.
344
355
  # @return [void]
345
356
  def add_child(child) end
346
357
 
347
358
  # Destroys all children of a window.
359
+ #
348
360
  # Called automatically by the destructor.
349
361
  # @return [Boolean]
350
362
  def destroy_children; end
351
363
 
352
364
  # Returns a const reference to the list of the window's children.
365
+ #
353
366
  # {Wx::WindowList} is a type-safe {Wx::List}-like class whose elements are of type <code>wxWindow*</code>.
354
367
  # @return [Wx::WindowList]
355
368
  def get_children; end
356
369
  alias_method :children, :get_children
357
370
 
358
371
  # Removes a child window.
372
+ #
359
373
  # This is called automatically by window deletion functions so should not be required by the application programmer. Notice that this function is mostly internal to wxWidgets and shouldn't be called by the user code.
360
374
  # @param child [Wx::Window] Child window to remove.
361
375
  # @return [void]
@@ -368,6 +382,7 @@ module Wx
368
382
 
369
383
  # Returns the next window after this one among the parent's children or NULL if this window is the last child.
370
384
  #
385
+ #
371
386
  # @see Wx::Window#get_prev_sibling
372
387
  # @return [Wx::Window]
373
388
  def get_next_sibling; end
@@ -380,12 +395,14 @@ module Wx
380
395
 
381
396
  # Returns the previous window before this one among the parent's children or <code></code> NULL if this window is the first child.
382
397
  #
398
+ #
383
399
  # @see Wx::Window#get_next_sibling
384
400
  # @return [Wx::Window]
385
401
  def get_prev_sibling; end
386
402
  alias_method :prev_sibling, :get_prev_sibling
387
403
 
388
404
  # Check if the specified window is a descendant of this one.
405
+ #
389
406
  # Returns true if the window is a descendant (i.e. a child or grand-child or grand-grand-child or ...) of this one.
390
407
  # Notice that a window can never be a descendant of another one if they are in different top level windows, i.e. a child of a {Wx::Dialog} is not considered to be a descendant of dialogs parent {Wx::Frame}.
391
408
  # @param win [Wx::Window] Any window, possible NULL (false is always returned then).
@@ -394,6 +411,7 @@ module Wx
394
411
  alias_method :descendant?, :is_descendant
395
412
 
396
413
  # Reparents the window, i.e. the window will be removed from its current parent window (e.g.
414
+ #
397
415
  # a non-standard toolbar in a {Wx::Frame}) and then re-inserted into another.
398
416
  # Notice that currently you need to explicitly call {Wx::Notebook#remove_page} before reparenting a notebook page.
399
417
  # @param newParent [Wx::Window] New parent.
@@ -401,7 +419,12 @@ module Wx
401
419
  def reparent(newParent) end
402
420
 
403
421
  # Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.
404
- # This function is currently not implemented.
422
+ #
423
+ # <div class="wxrb-remark">
424
+ # <b>Remark:</b>
425
+ # <p>This function is currently not implemented.
426
+ # </p>
427
+ # </div>
405
428
  # @param hflag [Boolean] Whether the horizontal scroll bar should always be visible.
406
429
  # @param vflag [Boolean] Whether the vertical scroll bar should always be visible.
407
430
  # @return [void]
@@ -409,6 +432,7 @@ module Wx
409
432
 
410
433
  # Returns the built-in scrollbar position.
411
434
  #
435
+ #
412
436
  # @see Wx::Window#set_scrollbar
413
437
  # @param orientation [Integer]
414
438
  # @return [Integer]
@@ -417,6 +441,7 @@ module Wx
417
441
 
418
442
  # Returns the built-in scrollbar range.
419
443
  #
444
+ #
420
445
  # @see Wx::Window#set_scrollbar
421
446
  # @param orientation [Integer]
422
447
  # @return [Integer]
@@ -425,6 +450,7 @@ module Wx
425
450
 
426
451
  # Returns the built-in scrollbar thumb size.
427
452
  #
453
+ #
428
454
  # @see Wx::Window#set_scrollbar
429
455
  # @param orientation [Integer]
430
456
  # @return [Integer]
@@ -438,6 +464,7 @@ module Wx
438
464
  alias_method :can_scroll?, :can_scroll
439
465
 
440
466
  # Returns true if this window currently has a scroll bar for this orientation.
467
+ #
441
468
  # This method may return false even when {Wx::Window#can_scroll} for the same orientation returns true, but if {Wx::Window#can_scroll} returns false, i.e. scrolling in this direction is not enabled at all, {Wx::Window#has_scrollbar} always returns false as well.
442
469
  # @param orient [Integer] Orientation to check, either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}.
443
470
  # @return [Boolean]
@@ -446,6 +473,7 @@ module Wx
446
473
 
447
474
  # Return whether a scrollbar is always shown.
448
475
  #
476
+ #
449
477
  # @see Wx::Window#always_show_scrollbars
450
478
  # @param orient [Integer] Orientation to check, either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}.
451
479
  # @return [Boolean]
@@ -453,28 +481,43 @@ module Wx
453
481
  alias_method :scrollbar_always_shown?, :is_scrollbar_always_shown
454
482
 
455
483
  # Scrolls the window by the given number of lines down (if lines is positive) or up.
484
+ #
456
485
  # Returns true if the window was scrolled, false if it was already on top/bottom and nothing was done.
457
486
  #
458
- # This function is currently only implemented under MSW and {Wx::TextCtrl} under wxGTK (it also works for {Wx::Scrolled} classes under all platforms).
487
+ # <div class="wxrb-remark">
488
+ # <b>Remark:</b>
489
+ # <p>This function is currently only implemented under MSW and {Wx::TextCtrl} under WXGTK (it also works for {Wx::Scrolled} classes under all platforms).
490
+ # </p>
491
+ # </div>
459
492
  # @see Wx::Window#scroll_pages
460
493
  # @param lines [Integer]
461
494
  # @return [Boolean]
462
495
  def scroll_lines(lines) end
463
496
 
464
497
  # Scrolls the window by the given number of pages down (if pages is positive) or up.
498
+ #
465
499
  # Returns true if the window was scrolled, false if it was already on top/bottom and nothing was done.
466
500
  #
467
- # This function is currently only implemented under MSW and wxGTK.
501
+ # <div class="wxrb-remark">
502
+ # <b>Remark:</b>
503
+ # <p>This function is currently only implemented under MSW and WXGTK.
504
+ # </p>
505
+ # </div>
468
506
  # @see Wx::Window#scroll_lines
469
507
  # @param pages [Integer]
470
508
  # @return [Boolean]
471
509
  def scroll_pages(pages) end
472
510
 
473
511
  # Physically scrolls the pixels in the window and move child windows accordingly.
474
- # Note that you can often use {Wx::Scrolled} instead of using this function directly.
512
+ #
513
+ # <div class="wxrb-remark">
514
+ # <b>Remark:</b>
515
+ # <p>Note that you can often use {Wx::Scrolled} instead of using this function directly.
516
+ # </p>
517
+ # </div>
475
518
  # @param dx [Integer] Amount to scroll horizontally.
476
519
  # @param dy [Integer] Amount to scroll vertically.
477
- # @param rect [Wx::Rect] Rectangle to scroll, if it is NULL, the whole window is scrolled (this is always the case under wxGTK which doesn't support this parameter)
520
+ # @param rect [Wx::Rect] Rectangle to scroll, if it is NULL, the whole window is scrolled (this is always the case under WXGTK which doesn't support this parameter)
478
521
  # @return [void]
479
522
  def scroll_window(dx, dy, rect=nil) end
480
523
 
@@ -495,7 +538,12 @@ module Wx
495
538
  def page_down; end
496
539
 
497
540
  # Sets the position of one of the built-in scrollbars.
498
- # This function does not directly affect the contents of the window: it is up to the application to take note of scrollbar attributes and redraw contents accordingly.
541
+ #
542
+ # <div class="wxrb-remark">
543
+ # <b>Remark:</b>
544
+ # <p>This function does not directly affect the contents of the window: it is up to the application to take note of scrollbar attributes and redraw contents accordingly.
545
+ # </p>
546
+ # </div>
499
547
  # @see Wx::Window#set_scrollbar
500
548
  # @see Wx::Window#get_scroll_pos
501
549
  # @see Wx::Window#get_scroll_thumb
@@ -508,11 +556,16 @@ module Wx
508
556
  def set_scroll_pos(orientation, pos, refresh=true) end
509
557
 
510
558
  # Sets the scrollbar properties of a built-in scrollbar.
511
- # Let's say you wish to display 50 lines of text, using the same font. The window is sized so that you can only see 16 lines at a time. You would use:
559
+ #
560
+ # <div class="wxrb-remark">
561
+ # <b>Remark:</b>
562
+ # <p>Let's say you wish to display 50 lines of text, using the same font. The window is sized so that you can only see 16 lines at a time. You would use:
512
563
  # ```ruby
513
564
  # set_scrollbar(Wx::VERTICAL, 0, 16, 50)
514
565
  # ```
515
566
  # Note that with the window at this size, the thumb position can never go above 50 minus 16, or 34. You can determine how many lines are currently visible by dividing the current view size by the character height in pixels. When defining your own scrollbar behaviour, you will always need to recalculate the scrollbar settings when the window size changes. You could therefore put your scrollbar calculations and SetScrollbar call into a function named AdjustScrollbars, which can be called initially and also from your {Wx::SizeEvent} handler function.
567
+ # </p>
568
+ # </div>
516
569
  # @see Scrolled Windows
517
570
  # @see Wx::ScrollBar
518
571
  # @see Wx::Scrolled
@@ -520,30 +573,34 @@ module Wx
520
573
  # @param orientation [Integer] Determines the scrollbar whose page size is to be set. May be {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}.
521
574
  # @param position [Integer] The position of the scrollbar in scroll units.
522
575
  # @param thumbSize [Integer] The size of the thumb, or visible portion of the scrollbar, in scroll units.
523
- # @param range [Integer] The maximum position of the scrollbar. Value of -1 can be used to ask for the scrollbar to be shown but in the disabled state: this can be used to avoid removing the scrollbar even when it is not needed (currently this is only implemented in wxMSW port).
576
+ # @param range [Integer] The maximum position of the scrollbar. Value of -1 can be used to ask for the scrollbar to be shown but in the disabled state: this can be used to avoid removing the scrollbar even when it is not needed (currently this is only implemented in WXMSW port).
524
577
  # @param refresh [Boolean] true to redraw the scrollbar, false otherwise.
525
578
  # @return [void]
526
579
  def set_scrollbar(orientation, position, thumbSize, range, refresh=true) end
527
580
 
528
581
  # Prepare for changing positions of multiple child windows.
582
+ #
529
583
  # This method should be called before changing positions of multiple child windows to reduce flicker and, in MSW case, even avoid display corruption in some cases. It is used internally by wxWidgets and called automatically when the window size changes but it can also be useful to call it from outside of the library if a repositioning involving multiple children is done without changing the window size.
530
584
  # If this method returns true, then {Wx::Window#end_repositioning_children} must be called after setting all children positions. Use {Wx::ChildrenRepositioningGuard} class to ensure that this requirement is satisfied.
531
585
  # @return [Boolean]
532
586
  def begin_repositioning_children; end
533
587
 
534
588
  # Fix child window positions after setting all of them at once.
589
+ #
535
590
  # This method must be called if and only if the previous call to {Wx::Window#begin_repositioning_children} returned true.
536
591
  # @return [void]
537
592
  def end_repositioning_children; end
538
593
 
539
594
  # Sets the cached best size value.
540
595
  #
596
+ #
541
597
  # @see Wx::Window#get_best_size
542
598
  # @param size [Array(Integer, Integer), Wx::Size]
543
599
  # @return [void]
544
600
  def cache_best_size(size) end
545
601
 
546
602
  # Converts client area size size to corresponding window size.
603
+ #
547
604
  # In other words, the returned value is what would {Wx::Window#get_size} return if this window had client area of given size. Components with {Wx::DEFAULT_COORD} value are left unchanged. Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars.
548
605
  # @see Wx::Window#window_to_client_size
549
606
  # @param size [Array(Integer, Integer), Wx::Size]
@@ -551,6 +608,7 @@ module Wx
551
608
  def client_to_window_size(size) end
552
609
 
553
610
  # Converts window size size to corresponding client area size In other words, the returned value is what would {Wx::Window#get_client_size} return if this window had given window size.
611
+ #
554
612
  # Components with {Wx::DEFAULT_COORD} value are left unchanged.
555
613
  # Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars.
556
614
  # @see Wx::Window#client_to_window_size
@@ -559,6 +617,7 @@ module Wx
559
617
  def window_to_client_size(size) end
560
618
 
561
619
  # Sizes the window to fit its best size.
620
+ #
562
621
  # Using this function is equivalent to setting window size to the return value of {Wx::Window#get_best_size}.
563
622
  # Note that, unlike {Wx::Window#set_sizer_and_fit}, this function only changes the current window size and doesn't change its minimal size.
564
623
  # @see Window Sizing Overview
@@ -566,12 +625,14 @@ module Wx
566
625
  def fit; end
567
626
 
568
627
  # Similar to {Wx::Window#fit}, but sizes the interior (virtual) size of a window.
628
+ #
569
629
  # Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won't do anything if there are no subwindows.
570
630
  # @return [void]
571
631
  def fit_inside; end
572
632
 
573
633
  # @overload from_dip(sz)
574
634
  # Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.
635
+ #
575
636
  # A DPI-independent pixel is just a pixel at the standard 96 DPI resolution. To keep the same physical size at higher resolution, the physical pixel value must be scaled by {Wx::Window#get_dpi_scale_factor} but this scaling may be already done by the underlying toolkit (GTK+, Cocoa, ...) automatically. This method performs the conversion only if it is not already done by the lower level toolkit and so by using it with pixel values you can guarantee that the physical size of the corresponding elements will remain the same in all resolutions under all platforms. For example, instead of creating a bitmap of the hard coded size of 32 pixels you should use
576
637
  # ```ruby
577
638
  # bmp = Wx::Bitmap.new(from_dip(Wx::Size.new(32, 32)))
@@ -587,6 +648,7 @@ module Wx
587
648
  # @return [Wx::Point]
588
649
  # @overload from_dip(d)
589
650
  # Convert DPI-independent distance in pixels to the value in pixels appropriate for the current toolkit.
651
+ #
590
652
  # This is the same as FromDIP(const {Wx::Size}& sz) overload, but assumes that the resolution is the same in horizontal and vertical directions.
591
653
  # If d has the special value of -1, it is returned unchanged independently of the current DPI.
592
654
  # @param d [Integer]
@@ -595,6 +657,7 @@ module Wx
595
657
 
596
658
  # @overload self.from_dip(sz, w)
597
659
  # Non window-specific DPI-independent pixels conversion functions.
660
+ #
598
661
  # The display resolution depends on the window in general as different windows can appear on different monitors using different resolutions, however sometimes no window is available for converting the resolution independent pixels to the physical values and in this case these static overloads can be used with NULL value for w argument.
599
662
  # Using these methods is discouraged as passing NULL will prevent your application from correctly supporting monitors with different resolutions even in the future wxWidgets versions which will add support for them, and passing non-NULL window is just a less convenient way of calling the non-static {Wx::Window#from_dip} method.
600
663
  # @param sz [Array(Integer, Integer), Wx::Size]
@@ -614,6 +677,7 @@ module Wx
614
677
 
615
678
  # @overload to_dip(sz)
616
679
  # Convert pixel values of the current toolkit to DPI-independent pixel values.
680
+ #
617
681
  # A DPI-independent pixel is just a pixel at the standard 96 DPI resolution. To keep the same physical size at higher resolution, the physical pixel value must be scaled by {Wx::Window#get_dpi_scale_factor} but this scaling may be already done by the underlying toolkit (GTK+, Cocoa, ...) automatically. This method performs the conversion only if it is not already done by the lower level toolkit, For example, you may want to use this to store window sizes and positions so that they can be re-used regardless of the display DPI:
618
682
  # ```ruby
619
683
  # pt = Wx::Point.new(to_dip(get_position))
@@ -629,6 +693,7 @@ module Wx
629
693
  # @return [Wx::Point]
630
694
  # @overload to_dip(d)
631
695
  # Convert pixel values of the current toolkit to DPI-independent pixel values.
696
+ #
632
697
  # This is the same as ToDIP(const {Wx::Size}& sz) overload, but assumes that the resolution is the same in horizontal and vertical directions.
633
698
  # If d has the special value of -1, it is returned unchanged independently of the current DPI.
634
699
  # @param d [Integer]
@@ -637,6 +702,7 @@ module Wx
637
702
 
638
703
  # @overload self.to_dip(sz, w)
639
704
  # Non window-specific pixel to DPI-independent pixels conversion functions.
705
+ #
640
706
  # The display resolution depends on the window in general as different windows can appear on different monitors using different resolutions, however sometimes no window is available for converting the resolution independent pixels to the physical values and in this case these static overloads can be used with NULL value for w argument.
641
707
  # Using these methods is discouraged as passing NULL will prevent your application from correctly supporting monitors with different resolutions even in the future wxWidgets versions which will add support for them, and passing non-NULL window is just a less convenient way of calling the non-static {Wx::Window#to_dip} method.
642
708
  # @param sz [Array(Integer, Integer), Wx::Size]
@@ -656,6 +722,7 @@ module Wx
656
722
 
657
723
  # @overload from_phys(sz)
658
724
  # Convert from physical pixels to logical pixels.
725
+ #
659
726
  # All window coordinates in wxWidgets API are always expressed in logical pixels, but the meaning of logical pixels depends on the platform. Physical pixels always mean the same thing and refer to the actual display pixels or, also, sizes of the bitmaps. Under some platforms logical pixels are actually the same as physical ones (this is the case for MSW), but under other platforms (e.g. GTK or macOS) this is not the case and {Wx::Window#get_content_scale_factor} defines the ratio between one logical and one physical pixel.
660
727
  # This function can be used to convert a value in physical pixels to logical pixels independently of the platform used. It simply does nothing under MSW, but divides the input value by the content scale factor under the other platforms.
661
728
  # Note that dividing an integer value by scale factor doesn't always yield an integer value. This function rounds the resulting value to the closest integer, e.g. 15 physical pixels are translated to 8, not 7, logical pixels in 200% DPI scaling. This ensures that a physical bitmap of size 15 is not truncated if the result of this function is used to create a window to show it, but it does mean that there will be one extra pixel, not covered by this bitmap, left.
@@ -675,6 +742,7 @@ module Wx
675
742
 
676
743
  # @overload self.from_phys(sz, w)
677
744
  # Convert from physical pixels to logical pixels for any window.
745
+ #
678
746
  # This function can be used without any window pointer, i.e. w can be NULL. In this case, it uses the content scale factor of the main screen if supported or just does nothing (i.e. uses scale factor of 1) otherwise.
679
747
  # Using member overloads is always preferable, if possible, as they always use the actually appropriate content scale factor.
680
748
  # @param sz [Array(Integer, Integer), Wx::Size]
@@ -694,6 +762,7 @@ module Wx
694
762
 
695
763
  # @overload to_phys(sz)
696
764
  # Convert from logical pixels to physical pixels.
765
+ #
697
766
  # This function performs the transformation in the converse direction compared to {Wx::Window#from_phys}.
698
767
  # @param sz [Array(Integer, Integer), Wx::Size]
699
768
  # @return [Wx::Size]
@@ -709,6 +778,7 @@ module Wx
709
778
 
710
779
  # @overload self.to_phys(sz, w)
711
780
  # Convert from logical pixels to physical pixels for any window.
781
+ #
712
782
  # This function can be used without any window pointer, i.e. w can be NULL. In this case, it uses the content scale factor of the main screen if supported or just does nothing (i.e. uses scale factor of 1) otherwise.
713
783
  # Using member overloads is always preferable, if possible, as they always use the actually appropriate content scale factor.
714
784
  # @param sz [Array(Integer, Integer), Wx::Size]
@@ -727,6 +797,7 @@ module Wx
727
797
  def self.to_phys(*args) end
728
798
 
729
799
  # This functions returns the best acceptable minimal size for the window.
800
+ #
730
801
  # For example, for a static control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (typically {Wx::Panel}), the size returned by this function will be the same as the size the window would have had after calling {Wx::Window#fit}.
731
802
  # Override virtual {Wx::Window#do_get_best_size} or, better, because it's usually more convenient, {Wx::Window#do_get_best_client_size} when writing your own custom window class to change the value returned by this public non-virtual method.
732
803
  # Notice that the best size respects the minimal and maximal size explicitly set for the window, if any. So even if some window believes that it needs 200 pixels horizontally, calling {Wx::Window#set_max_size} with a width of 100 would ensure that {Wx::Window#get_best_size} returns the width of at most 100 pixels.
@@ -738,6 +809,7 @@ module Wx
738
809
 
739
810
  # Returns the best height needed by this window if it had the given width.
740
811
  #
812
+ #
741
813
  # @see Wx::Window#do_get_best_client_height
742
814
  # @param width [Integer]
743
815
  # @return [Integer]
@@ -746,6 +818,7 @@ module Wx
746
818
 
747
819
  # Returns the best width needed by this window if it had the given height.
748
820
  #
821
+ #
749
822
  # @see Wx::Window#do_get_best_client_width
750
823
  # @param height [Integer]
751
824
  # @return [Integer]
@@ -758,6 +831,7 @@ module Wx
758
831
  alias_method :client_size, :get_client_size
759
832
 
760
833
  # Merges the window's best size into the min size and returns the result.
834
+ #
761
835
  # This is the value used by sizers to determine the appropriate amount of space to allocate for the widget.
762
836
  # This is the method called by a {Wx::Sizer} when it queries the size of a window or control.
763
837
  # @see Wx::Window#get_best_size
@@ -768,6 +842,7 @@ module Wx
768
842
  alias_method :effective_min_size, :get_effective_min_size
769
843
 
770
844
  # Returns the maximum size of window's client area.
845
+ #
771
846
  # This is an indication to the sizer layout mechanism that this is the maximum possible size as well as the upper bound on window's size settable using {Wx::Window#set_client_size}.
772
847
  # @see Wx::Window#get_max_size
773
848
  # @see Window Sizing Overview
@@ -776,6 +851,7 @@ module Wx
776
851
  alias_method :max_client_size, :get_max_client_size
777
852
 
778
853
  # Returns the maximum size of the window.
854
+ #
779
855
  # This is an indication to the sizer layout mechanism that this is the maximum possible size as well as the upper bound on window's size settable using {Wx::Window#set_size}.
780
856
  # @see Wx::Window#get_max_client_size
781
857
  # @see Window Sizing Overview
@@ -784,6 +860,7 @@ module Wx
784
860
  alias_method :max_size, :get_max_size
785
861
 
786
862
  # Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.
863
+ #
787
864
  # It normally just returns the value set by {Wx::Window#set_min_client_size}, but it can be overridden to do the calculation on demand.
788
865
  # @see Wx::Window#get_min_size
789
866
  # @see Window Sizing Overview
@@ -792,6 +869,7 @@ module Wx
792
869
  alias_method :min_client_size, :get_min_client_size
793
870
 
794
871
  # Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.
872
+ #
795
873
  # This method normally just returns the value set by {Wx::Window#set_min_size}, but it can be overridden to do the calculation on demand.
796
874
  # @see Wx::Window#get_min_client_size
797
875
  # @see Window Sizing Overview
@@ -800,6 +878,7 @@ module Wx
800
878
  alias_method :min_size, :get_min_size
801
879
 
802
880
  # Returns the horizontal component of window minimal size.
881
+ #
803
882
  # The returned value is {Wx::DEFAULT_COORD} if the minimal width was not set.
804
883
  # @see Wx::Window#get_min_size
805
884
  # @return [Integer]
@@ -807,6 +886,7 @@ module Wx
807
886
  alias_method :min_width, :get_min_width
808
887
 
809
888
  # Returns the vertical component of window minimal size.
889
+ #
810
890
  # The returned value is {Wx::DEFAULT_COORD} if the minimal height was not set.
811
891
  # @see Wx::Window#get_min_size
812
892
  # @return [Integer]
@@ -814,6 +894,7 @@ module Wx
814
894
  alias_method :min_height, :get_min_height
815
895
 
816
896
  # Returns the horizontal component of window maximal size.
897
+ #
817
898
  # The returned value is {Wx::DEFAULT_COORD} if the maximal width was not set.
818
899
  # @see Wx::Window#get_max_size
819
900
  # @return [Integer]
@@ -821,6 +902,7 @@ module Wx
821
902
  alias_method :max_width, :get_max_width
822
903
 
823
904
  # Returns the vertical component of window maximal size.
905
+ #
824
906
  # The returned value is {Wx::DEFAULT_COORD} if the maximal width was not set.
825
907
  # @see Wx::Window#get_max_size
826
908
  # @return [Integer]
@@ -833,6 +915,7 @@ module Wx
833
915
  alias_method :size, :get_size
834
916
 
835
917
  # This gets the virtual size of the window in pixels.
918
+ #
836
919
  # By default it returns the client size of the window, but after a call to {Wx::Window#set_virtual_size} it will return the size set with that method.
837
920
  # @see Window Sizing Overview
838
921
  # @return [Wx::Size]
@@ -845,14 +928,21 @@ module Wx
845
928
  alias_method :best_virtual_size, :get_best_virtual_size
846
929
 
847
930
  # Returns the factor mapping logical pixels of this window to physical pixels.
931
+ #
848
932
  # This function can be used to portably determine the number of physical pixels in a window of the given size, by multiplying the window size by the value returned from it. I.e. it returns the factor converting window coordinates to "content view" coordinates, where the view can be just a simple window displaying a {Wx::Bitmap} or {Wx::GLCanvas} or any other kind of window rendering arbitrary "content" on screen.
849
933
  # For the platforms not doing any pixel mapping, i.e. where logical and physical pixels are one and the same, this function always returns 1.0 and so using it is, in principle, unnecessary and could be avoided by using preprocessor check for {Wx::HAS_DPI_INDEPENDENT_PIXELS} not being defined, however using this function unconditionally under all platforms is usually simpler and so preferable.
850
- # Current behaviour of this function is compatible with wxWidgets 3.0, but different from its behaviour in versions 3.1.0 to 3.1.3, where it returned the same value as {Wx::Window#get_dpi_scale_factor}. Please use the other function if you need to use a scaling factor greater than 1.0 even for the platforms without {Wx::HAS_DPI_INDEPENDENT_PIXELS}, such as wxMSW.
934
+ #
935
+ # <div class="wxrb-note">
936
+ # <b>Note:</b>
937
+ # <p>Current behaviour of this function is compatible with wxWidgets 3.0, but different from its behaviour in versions 3.1.0 to 3.1.3, where it returned the same value as {Wx::Window#get_dpi_scale_factor}. Please use the other function if you need to use a scaling factor greater than 1.0 even for the platforms without {Wx::HAS_DPI_INDEPENDENT_PIXELS}, such as WXMSW.
938
+ # </p>
939
+ # </div>
851
940
  # @return [Float]
852
941
  def get_content_scale_factor; end
853
942
  alias_method :content_scale_factor, :get_content_scale_factor
854
943
 
855
944
  # Returns the ratio of the DPI used by this window to the standard DPI.
945
+ #
856
946
  # The returned value is 1 for standard DPI screens or 2 for "200%
857
947
  # scaling" and, unlike for {Wx::Window#get_content_scale_factor}, is the same under all platforms.
858
948
  # This factor should be used to increase the size of icons and similar windows whose best size is not based on text metrics when using DPI scaling.
@@ -868,6 +958,7 @@ module Wx
868
958
  alias_method :window_border_size, :get_window_border_size
869
959
 
870
960
  # {Wx::Sizer} and friends use this to give a chance to a component to recalc its min size once one of the final size components is known.
961
+ #
871
962
  # Override this function when that is useful (such as for {Wx::StaticText} which can stretch over several lines). Parameter availableOtherDir tells the item how much more space there is available in the opposite direction (-1 if unknown).
872
963
  # @param direction [Integer]
873
964
  # @param size [Integer]
@@ -877,21 +968,25 @@ module Wx
877
968
 
878
969
  # Resets the cached best size value so it will be recalculated the next time it is needed.
879
970
  #
971
+ #
880
972
  # @see Wx::Window#cache_best_size
881
973
  # @return [void]
882
974
  def invalidate_best_size; end
883
975
 
884
976
  # Posts a size event to the window.
977
+ #
885
978
  # This is the same as {Wx::Window#send_size_event} with {Wx::SEND_EVENT_POST} argument.
886
979
  # @return [void]
887
980
  def post_size_event; end
888
981
 
889
982
  # Posts a size event to the parent of this window.
983
+ #
890
984
  # This is the same as {Wx::Window#send_size_event_to_parent} with {Wx::SEND_EVENT_POST} argument.
891
985
  # @return [void]
892
986
  def post_size_event_to_parent; end
893
987
 
894
988
  # This function sends a dummy size event to the window allowing it to re-layout its children positions.
989
+ #
895
990
  # It is sometimes useful to call this function after adding or deleting a children after the frame creation or if a child size changes. Note that if the frame is using either sizers or constraints for the children layout, it is enough to call {Wx::Window#layout} directly and this function should not be used in this case.
896
991
  # If flags includes {Wx::SEND_EVENT_POST} value, this function posts the event, i.e. schedules it for later processing, instead of dispatching it directly. You can also use {Wx::Window#post_size_event} as a more readable equivalent of calling this function with this flag.
897
992
  # @param flags [Integer] May include {Wx::SEND_EVENT_POST}. Default value is 0.
@@ -899,6 +994,7 @@ module Wx
899
994
  def send_size_event(flags=0) end
900
995
 
901
996
  # Safe wrapper for {Wx::Window#get_parent}->{Wx::Window#send_size_event}.
997
+ #
902
998
  # This function simply checks that the window has a valid parent which is not in process of being deleted and calls {Wx::Window#send_size_event} on it. It is used internally by windows such as toolbars changes to whose state should result in parent re-layout (e.g. when a toolbar is added to the top of the window, all the other windows must be shifted down).
903
999
  # @see Wx::Window#post_size_event_to_parent
904
1000
  # @param flags [Integer] See description of this parameter in {Wx::Window#send_size_event} documentation.
@@ -907,6 +1003,7 @@ module Wx
907
1003
 
908
1004
  # @overload set_client_size(width, height)
909
1005
  # This sets the size of the window client area in pixels.
1006
+ #
910
1007
  # Using this function to size a window tends to be more device-independent than {Wx::Window#set_size}, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
911
1008
  # Note that special value of -1 which can be used in some other functions to preserve the existing size is not supported for width and height here, i.e. they both must be valid, positive integers.
912
1009
  # @see Window Sizing Overview
@@ -925,6 +1022,7 @@ module Wx
925
1022
  alias_method :client_size=, :set_client_size
926
1023
 
927
1024
  # Used by {Wx::Sizer} internally to notify the window about being managed by the given sizer.
1025
+ #
928
1026
  # This method should not be called from outside the library, unless you're implementing a custom sizer class and in the latter case you must call this method with the pointer to the sizer itself whenever a window is added to it and with NULL argument when the window is removed from it.
929
1027
  # @param sizer [Wx::Sizer]
930
1028
  # @return [void]
@@ -932,6 +1030,7 @@ module Wx
932
1030
  alias_method :containing_sizer=, :set_containing_sizer
933
1031
 
934
1032
  # A smart SetSize that will fill in default size components with the window's best size values.
1033
+ #
935
1034
  # Also sets the window's minsize to the value passed in for use with sizers. This means that if a full or partial size is passed to this function then the sizers will use that size instead of the results of {Wx::Window#get_best_size} to determine the minimum needs of the window for layout.
936
1035
  # Most controls will use this to set their initial size, and their min size to the passed in value (if any.)
937
1036
  # @see Wx::Window#set_size
@@ -944,6 +1043,7 @@ module Wx
944
1043
  alias_method :initial_size=, :set_initial_size
945
1044
 
946
1045
  # Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.
1046
+ #
947
1047
  # Note that this method is just a shortcut for:
948
1048
  # ```ruby
949
1049
  # set_max_size(client_to_window_size(size))
@@ -957,6 +1057,7 @@ module Wx
957
1057
 
958
1058
  # Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.
959
1059
  #
1060
+ #
960
1061
  # @see Wx::Window#set_max_client_size
961
1062
  # @see Window Sizing Overview
962
1063
  # @param size [Array(Integer, Integer), Wx::Size]
@@ -965,6 +1066,7 @@ module Wx
965
1066
  alias_method :max_size=, :set_max_size
966
1067
 
967
1068
  # Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.
1069
+ #
968
1070
  # You may need to call this if you change the window size after construction and before adding to its parent sizer.
969
1071
  # Note, that just as with {Wx::Window#set_min_size}, calling this method doesn't prevent the program from explicitly making the window smaller than the specified size.
970
1072
  # Note that this method is just a shortcut for:
@@ -979,6 +1081,7 @@ module Wx
979
1081
  alias_method :min_client_size=, :set_min_client_size
980
1082
 
981
1083
  # Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.
1084
+ #
982
1085
  # You may need to call this if you change the window size after construction and before adding to its parent sizer.
983
1086
  # Notice that calling this method doesn't prevent the program from making the window explicitly smaller than the specified size by calling {Wx::Window#set_size}, it just ensures that it won't become smaller than this size during the automatic layout.
984
1087
  # @see Wx::Window#set_min_client_size
@@ -990,7 +1093,12 @@ module Wx
990
1093
 
991
1094
  # @overload set_size(x, y, width, height, sizeFlags=Wx::SIZE_AUTO)
992
1095
  # Sets the size of the window in pixels.
993
- # This overload sets the position and optionally size, of the window. Parameters may be {Wx::DEFAULT_COORD} to indicate either that a default should be supplied by wxWidgets, or that the current value of the dimension should be used.
1096
+ #
1097
+ # <div class="wxrb-remark">
1098
+ # <b>Remark:</b>
1099
+ # <p>This overload sets the position and optionally size, of the window. Parameters may be {Wx::DEFAULT_COORD} to indicate either that a default should be supplied by wxWidgets, or that the current value of the dimension should be used.
1100
+ # </p>
1101
+ # </div>
994
1102
  # @see Wx::Window#move
995
1103
  # @see Window Sizing Overview
996
1104
  # @param x [Integer] Required x position in pixels, or {Wx::DEFAULT_COORD} to indicate that the existing value should be used.
@@ -1008,8 +1116,14 @@ module Wx
1008
1116
  # @return [void]
1009
1117
  # @overload set_size(rect)
1010
1118
  # Sets the size of the window in pixels.
1119
+ #
1011
1120
  # The size is specified using a {Wx::Rect}, {Wx::Size} or by a couple of int objects.
1012
- # This form must be used with non-default width and height values.
1121
+ #
1122
+ # <div class="wxrb-remark">
1123
+ # <b>Remark:</b>
1124
+ # <p>This form must be used with non-default width and height values.
1125
+ # </p>
1126
+ # </div>
1013
1127
  # @see Wx::Window#move
1014
1128
  # @see Window Sizing Overview
1015
1129
  # @param rect [Wx::Rect]
@@ -1023,6 +1137,7 @@ module Wx
1023
1137
 
1024
1138
  # @overload set_size_hints(minSize, maxSize=Wx::DEFAULT_SIZE, incSize=Wx::DEFAULT_SIZE)
1025
1139
  # Use of this function for windows which are not toplevel windows (such as {Wx::Dialog} or {Wx::Frame}) is discouraged.
1140
+ #
1026
1141
  # Please use {Wx::Window#set_min_size} and {Wx::Window#set_max_size} instead.
1027
1142
  # @see Wx::TopLevelWindow#set_size_hints
1028
1143
  # @see Window Sizing Overview
@@ -1045,6 +1160,7 @@ module Wx
1045
1160
  # @overload set_virtual_size(width, height)
1046
1161
  # Sets the virtual size of the window in pixels.
1047
1162
  #
1163
+ #
1048
1164
  # @see Window Sizing Overview
1049
1165
  # @param width [Integer]
1050
1166
  # @param height [Integer]
@@ -1067,16 +1183,26 @@ module Wx
1067
1183
  def center_on_parent(dir=Wx::Orientation::BOTH) end
1068
1184
 
1069
1185
  # Centres the window.
1070
- # If the window is a top level one (i.e. doesn't have a parent), it will be centred relative to the screen anyhow.
1186
+ #
1187
+ # <div class="wxrb-remark">
1188
+ # <b>Remark:</b>
1189
+ # <p>If the window is a top level one (i.e. doesn't have a parent), it will be centred relative to the screen anyhow.
1190
+ # </p>
1191
+ # </div>
1071
1192
  # @see Wx::Window#center
1072
1193
  # @param direction [Integer] Specifies the direction for the centring. May be {Wx::Orientation::HORIZONTAL}, {Wx::Orientation::VERTICAL} or {Wx::Orientation::BOTH}. It may also include the {Wx::CENTRE_ON_SCREEN} flag if you want to centre the window on the entire screen and not on its parent window.
1073
1194
  # @return [void]
1074
1195
  def centre(direction=Wx::Orientation::BOTH) end
1075
1196
 
1076
1197
  # Centres the window on its parent.
1198
+ #
1077
1199
  # This is a more readable synonym for {Wx::Window#centre}.
1078
1200
  #
1079
- # This methods provides for a way to centre top level windows over their parents instead of the entire screen. If there is no parent or if the window is not a top level window, then behaviour is the same as {Wx::Window#centre}.
1201
+ # <div class="wxrb-remark">
1202
+ # <b>Remark:</b>
1203
+ # <p>This methods provides for a way to centre top level windows over their parents instead of the entire screen. If there is no parent or if the window is not a top level window, then behaviour is the same as {Wx::Window#centre}.
1204
+ # </p>
1205
+ # </div>
1080
1206
  # @see Wx::TopLevelWindow#centre_on_screen
1081
1207
  # @param direction [Integer] Specifies the direction for the centring. May be {Wx::Orientation::HORIZONTAL}, {Wx::Orientation::VERTICAL} or {Wx::Orientation::BOTH}.
1082
1208
  # @return [void]
@@ -1084,6 +1210,7 @@ module Wx
1084
1210
 
1085
1211
  # This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.
1086
1212
  #
1213
+ #
1087
1214
  # @see Wx::Window#get_screen_position
1088
1215
  # @return [Wx::Point]
1089
1216
  def get_position; end
@@ -1091,6 +1218,7 @@ module Wx
1091
1218
 
1092
1219
  # Returns the position and size of the window as a {Wx::Rect} object.
1093
1220
  #
1221
+ #
1094
1222
  # @see Wx::Window#get_screen_rect
1095
1223
  # @return [Wx::Rect]
1096
1224
  def get_rect; end
@@ -1098,6 +1226,7 @@ module Wx
1098
1226
 
1099
1227
  # Returns the window position in screen coordinates, whether the window is a child window or a top level one.
1100
1228
  #
1229
+ #
1101
1230
  # @see Wx::Window#get_position
1102
1231
  # @return [Wx::Point]
1103
1232
  def get_screen_position; end
@@ -1105,6 +1234,7 @@ module Wx
1105
1234
 
1106
1235
  # Returns the position and size of the window on the screen as a {Wx::Rect} object.
1107
1236
  #
1237
+ #
1108
1238
  # @see Wx::Window#get_rect
1109
1239
  # @return [Wx::Rect]
1110
1240
  def get_screen_rect; end
@@ -1122,10 +1252,16 @@ module Wx
1122
1252
 
1123
1253
  # @overload move(x, y, flags=Wx::SIZE_USE_EXISTING)
1124
1254
  # Moves the window to the given position.
1125
- # Implementations of SetSize can also implicitly implement the {Wx::Window#move} function, which is defined in the base {Wx::Window} class as the call:
1255
+ #
1256
+ # <div class="wxrb-remark">
1257
+ # <b>Remark:</b>
1258
+ # <p>Implementations of SetSize can also implicitly implement the {Wx::Window#move} function, which is defined in the base {Wx::Window} class as the call:
1126
1259
  # ```ruby
1127
1260
  # set_size(x, y, Wx::DEFAULT_COORD, Wx::DEFAULT_COORD, Wx::SIZE_USE_EXISTING)
1128
1261
  # ```
1262
+ #
1263
+ # </p>
1264
+ # </div>
1129
1265
  # @see Wx::Window#set_size
1130
1266
  # @param x [Integer] Required x position.
1131
1267
  # @param y [Integer] Required y position.
@@ -1133,10 +1269,16 @@ module Wx
1133
1269
  # @return [void]
1134
1270
  # @overload move(pt, flags=Wx::SIZE_USE_EXISTING)
1135
1271
  # Moves the window to the given position.
1136
- # Implementations of {Wx::Window#set_size} can also implicitly implement the {Wx::Window#move} function, which is defined in the base {Wx::Window} class as the call:
1272
+ #
1273
+ # <div class="wxrb-remark">
1274
+ # <b>Remark:</b>
1275
+ # <p>Implementations of {Wx::Window#set_size} can also implicitly implement the {Wx::Window#move} function, which is defined in the base {Wx::Window} class as the call:
1137
1276
  # ```ruby
1138
1277
  # set_size(x, y, Wx::DEFAULT_COORD, Wx::DEFAULT_COORD, Wx::SIZE_USE_EXISTING)
1139
1278
  # ```
1279
+ #
1280
+ # </p>
1281
+ # </div>
1140
1282
  # @see Wx::Window#set_size
1141
1283
  # @param pt [Array(Integer, Integer), Wx::Point] {Wx::Point} object representing the position.
1142
1284
  # @param flags [Integer] See {Wx::Window#set_size} for more info about this parameter.
@@ -1144,6 +1286,7 @@ module Wx
1144
1286
  def move(*args) end
1145
1287
 
1146
1288
  # Moves the window to the specified position.
1289
+ #
1147
1290
  # This is exactly the same as calling {Wx::Window#move} with the default arguments.
1148
1291
  # @param pt [Array(Integer, Integer), Wx::Point]
1149
1292
  # @return [void]
@@ -1157,8 +1300,14 @@ module Wx
1157
1300
 
1158
1301
  # @overload convert_dialog_to_pixels(pt)
1159
1302
  # Converts a point or size from dialog units to pixels.
1303
+ #
1160
1304
  # For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
1161
- # Dialog units are used for maintaining a dialog's proportions even if the font changes. You can also use these functions programmatically.
1305
+ #
1306
+ # <div class="wxrb-remark">
1307
+ # <b>Remark:</b>
1308
+ # <p>Dialog units are used for maintaining a dialog's proportions even if the font changes. You can also use these functions programmatically.
1309
+ # </p>
1310
+ # </div>
1162
1311
  # @see Wx::Window#convert_pixels_to_dialog
1163
1312
  # @param pt [Array(Integer, Integer), Wx::Point]
1164
1313
  # @return [Wx::Point]
@@ -1170,8 +1319,14 @@ module Wx
1170
1319
 
1171
1320
  # @overload convert_pixels_to_dialog(pt)
1172
1321
  # Converts a point or size from pixels to dialog units.
1322
+ #
1173
1323
  # For the x dimension, the pixels are multiplied by 4 and then divided by the average character width. For the y dimension, the pixels are multiplied by 8 and then divided by the average character height.
1174
- # Dialog units are used for maintaining a dialog's proportions even if the font changes.
1324
+ #
1325
+ # <div class="wxrb-remark">
1326
+ # <b>Remark:</b>
1327
+ # <p>Dialog units are used for maintaining a dialog's proportions even if the font changes.
1328
+ # </p>
1329
+ # </div>
1175
1330
  # @see Wx::Window#convert_dialog_to_pixels
1176
1331
  # @param pt [Array(Integer, Integer), Wx::Point]
1177
1332
  # @return [Wx::Point]
@@ -1187,15 +1342,17 @@ module Wx
1187
1342
  def screen_to_client(pt) end
1188
1343
 
1189
1344
  # Clears the window by filling it with the current background colour.
1345
+ #
1190
1346
  # Does not cause an erase background event to be generated.
1191
1347
  # Notice that this uses {Wx::ClientDC} to draw on the window and the results of doing it while also drawing on {Wx::PaintDC} for this window are undefined. Hence this method shouldn't be used from EVT_PAINT handlers, just use {Wx::DC#clear} on the {Wx::PaintDC} you already use there instead.
1192
1348
  # @return [void]
1193
1349
  def clear_background; end
1194
1350
 
1195
1351
  # Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.
1352
+ #
1196
1353
  # {Wx::Window#thaw} must be called to re-enable window redrawing. Calls to these two functions may be nested but to ensure that the window is properly repainted again, you must thaw it exactly as many times as you froze it.
1197
1354
  # If the window has any children, they are recursively frozen too.
1198
- # This method is useful for visual appearance optimization (for example, it is a good idea to use it before doing many large text insertions in a row into a {Wx::TextCtrl} under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWidgets and not a mandatory directive.
1355
+ # This method is useful for visual appearance optimization (for example, it is a good idea to use it before doing many large text insertions in a row into a {Wx::TextCtrl} under WXGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWidgets and not a mandatory directive.
1199
1356
  # @see Wx::WindowUpdateLocker
1200
1357
  # @see Wx::Window#thaw
1201
1358
  # @see Wx::Window#is_frozen
@@ -1203,6 +1360,7 @@ module Wx
1203
1360
  def freeze; end
1204
1361
 
1205
1362
  # Re-enables window updating after a previous call to {Wx::Window#freeze}.
1363
+ #
1206
1364
  # To really thaw the control, it must be called exactly the same number of times as {Wx::Window#freeze}.
1207
1365
  # If the window has any children, they are recursively thawed too.
1208
1366
  # @see Wx::WindowUpdateLocker
@@ -1213,6 +1371,7 @@ module Wx
1213
1371
 
1214
1372
  # Returns true if the window is currently frozen by a call to {Wx::Window#freeze}.
1215
1373
  #
1374
+ #
1216
1375
  # @see Wx::Window#freeze
1217
1376
  # @see Wx::Window#thaw
1218
1377
  # @return [Boolean]
@@ -1221,6 +1380,7 @@ module Wx
1221
1380
 
1222
1381
  # Returns the background colour of the window.
1223
1382
  #
1383
+ #
1224
1384
  # @see Wx::Window#set_background_colour
1225
1385
  # @see Wx::Window#set_foreground_colour
1226
1386
  # @see Wx::Window#get_foreground_colour
@@ -1230,6 +1390,7 @@ module Wx
1230
1390
 
1231
1391
  # Returns the background style of the window.
1232
1392
  #
1393
+ #
1233
1394
  # @see Wx::Window#set_background_colour
1234
1395
  # @see Wx::Window#get_foreground_colour
1235
1396
  # @see Wx::Window#set_background_style
@@ -1249,6 +1410,7 @@ module Wx
1249
1410
  alias_method :char_width, :get_char_width
1250
1411
 
1251
1412
  # Currently this is the same as calling {Wx::Window.get_class_default_attributes(wx_window}.
1413
+ #
1252
1414
  # One advantage of using this function compared to the static version is that the call is automatically dispatched to the correct class (as usual with virtual functions) and you don't have to specify the class name explicitly.
1253
1415
  # The other one is that in the future this function could return different results, for example it might return a different font for an "Ok" button than for a generic button if the users GUI is configured to show such buttons in bold font. Of course, the down side is that it is impossible to call this function without actually having an object to apply it to whereas the static version can be used without having to create an object first.
1254
1416
  # @return [Wx::VisualAttributes]
@@ -1256,6 +1418,7 @@ module Wx
1256
1418
  alias_method :default_attributes, :get_default_attributes
1257
1419
 
1258
1420
  # Return the DPI of the display used by this window.
1421
+ #
1259
1422
  # The returned value can be different for different windows on systems with support for per-monitor DPI values, such as Microsoft Windows 10.
1260
1423
  # If the DPI is not available, returns <code>size(0,0)</code> object.
1261
1424
  # @see Wx::Display#get_ppi
@@ -1266,13 +1429,19 @@ module Wx
1266
1429
 
1267
1430
  # Returns the font for this window.
1268
1431
  #
1432
+ #
1269
1433
  # @see Wx::Window#set_font
1270
1434
  # @return [Wx::Font]
1271
1435
  def get_font; end
1272
1436
  alias_method :font, :get_font
1273
1437
 
1274
1438
  # Returns the foreground colour of the window.
1275
- # The meaning of foreground colour varies according to the window class; it may be the text colour or other colour, or it may not be used at all.
1439
+ #
1440
+ # <div class="wxrb-remark">
1441
+ # <b>Remark:</b>
1442
+ # <p>The meaning of foreground colour varies according to the window class; it may be the text colour or other colour, or it may not be used at all.
1443
+ # </p>
1444
+ # </div>
1276
1445
  # @see Wx::Window#set_foreground_colour
1277
1446
  # @see Wx::Window#set_background_colour
1278
1447
  # @see Wx::Window#get_background_colour
@@ -1287,6 +1456,7 @@ module Wx
1287
1456
  alias_method :text_extent, :get_text_extent
1288
1457
 
1289
1458
  # Returns the region specifying which parts of the window have been damaged.
1459
+ #
1290
1460
  # Should only be called within a {Wx::PaintEvent} handler.
1291
1461
  # @see Wx::Region
1292
1462
  # @see Wx::RegionIterator
@@ -1300,12 +1470,14 @@ module Wx
1300
1470
  alias_method :update_client_rect, :get_update_client_rect
1301
1471
 
1302
1472
  # Returns true if this window background is transparent (as, for example, for {Wx::StaticText}) and should show the parent window background.
1473
+ #
1303
1474
  # This method is mostly used internally by the library itself and you normally shouldn't have to call it. You may, however, have to override it in your {Wx::Window}-derived class to ensure that background is painted correctly.
1304
1475
  # @return [Boolean]
1305
1476
  def has_transparent_background; end
1306
1477
  alias_method :has_transparent_background?, :has_transparent_background
1307
1478
 
1308
1479
  # Causes this window, and all of its children recursively, to be repainted.
1480
+ #
1309
1481
  # Note that repainting doesn't happen immediately but only during the next event loop iteration, if you need to update the window immediately you should use {Wx::Window#update} instead.
1310
1482
  # @see Wx::Window#refresh_rect
1311
1483
  # @param eraseBackground [Boolean] If true, the background will be erased too. Note that in non-MSW ports background is always erased.
@@ -1314,6 +1486,7 @@ module Wx
1314
1486
  def refresh(eraseBackground=true, rect=nil) end
1315
1487
 
1316
1488
  # Redraws the contents of the given rectangle: only the area inside it will be repainted.
1489
+ #
1317
1490
  # This is the same as {Wx::Window#refresh} but has a nicer syntax as it can be called with a temporary {Wx::Rect} object as argument like this <code>RefreshRect(wxRect(x, y, w, h))</code>.
1318
1491
  # @param rect [Wx::Rect]
1319
1492
  # @param eraseBackground [Boolean]
@@ -1321,15 +1494,21 @@ module Wx
1321
1494
  def refresh_rect(rect, eraseBackground=true) end
1322
1495
 
1323
1496
  # Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).
1497
+ #
1324
1498
  # Notice that this function doesn't invalidate any area of the window so nothing happens if nothing has been invalidated (i.e. marked as requiring a redraw). Use {Wx::Window#refresh} first if you want to immediately redraw the window unconditionally.
1325
1499
  # @return [void]
1326
1500
  def update; end
1327
1501
 
1328
1502
  # Sets the background colour of the window.
1503
+ #
1329
1504
  # Notice that as with {Wx::Window#set_foreground_colour}, setting the background colour of a native control may not affect the entire control and could be not supported at all depending on the control and platform.
1330
1505
  # Please see {Wx::Window#inherit_attributes} for explanation of the difference between this method and {Wx::Window#set_own_background_colour}.
1331
1506
  #
1332
- # The background colour is usually painted by the default {Wx::EraseEvent} event handler function under Windows and automatically under GTK. Note that setting the background colour does not cause an immediate refresh, so you may wish to call {Wx::Window#clear_background} or {Wx::Window#refresh} after calling this function. Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system.
1507
+ # <div class="wxrb-remark">
1508
+ # <b>Remark:</b>
1509
+ # <p>The background colour is usually painted by the default {Wx::EraseEvent} event handler function under Windows and automatically under GTK. Note that setting the background colour does not cause an immediate refresh, so you may wish to call {Wx::Window#clear_background} or {Wx::Window#refresh} after calling this function. Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system.
1510
+ # </p>
1511
+ # </div>
1333
1512
  #
1334
1513
  # true if the colour was really changed, false if it was already set to this colour and nothing was done.
1335
1514
  # @see Wx::Window#get_background_colour
@@ -1345,9 +1524,10 @@ module Wx
1345
1524
  alias_method :background_colour=, :set_background_colour
1346
1525
 
1347
1526
  # Sets the background style of the window.
1527
+ #
1348
1528
  # The default background style is {Wx::BackgroundStyle::BG_STYLE_ERASE} which indicates that the window background may be erased in EVT_ERASE_BACKGROUND handler. This is a safe, compatibility default; however you may want to change it to {Wx::BackgroundStyle::BG_STYLE_SYSTEM} if you don't define any erase background event handlers at all, to avoid unnecessary generation of erase background events and always let system erase the background. And you should change the background style to {Wx::BackgroundStyle::BG_STYLE_PAINT} if you define an EVT_PAINT handler which completely overwrites the window background as in this case erasing it previously, either in EVT_ERASE_BACKGROUND handler or in the system default handler, would result in flicker as the background pixels will be repainted twice every time the window is redrawn. Do ensure that the background is entirely erased by your EVT_PAINT handler in this case however as otherwise garbage may be left on screen.
1349
1529
  # Notice that in previous versions of wxWidgets a common way to work around the above mentioned flickering problem was to define an empty EVT_ERASE_BACKGROUND handler. Setting background style to {Wx::BackgroundStyle::BG_STYLE_PAINT} is a simpler and more efficient solution to the same problem.
1350
- # Under wxGTK and wxOSX, you can use {Wx::BackgroundStyle::BG_STYLE_TRANSPARENT} to obtain full transparency of the window background. Note that wxGTK supports this only since GTK 2.12 with a compositing manager enabled, call {Wx::Window#is_transparent_background_supported} to check whether this is the case, see the example of doing it in the shapedsample".
1530
+ # Under WXGTK and WXOSX, you can use {Wx::BackgroundStyle::BG_STYLE_TRANSPARENT} to obtain full transparency of the window background. Note that WXGTK supports this only since GTK 2.12 with a compositing manager enabled, call {Wx::Window#is_transparent_background_supported} to check whether this is the case, see the example of doing it in the shapedsample".
1351
1531
  # Also, in order for <code>SetBackgroundStyle(wxBG_STYLE_TRANSPARENT)</code> to work, it must be called before {Wx::Window#create}. If you're using your own {Wx::Window}-derived class you should write your code in the following way:
1352
1532
  # ```ruby
1353
1533
  # class MyWidget < Wx::Window
@@ -1371,6 +1551,7 @@ module Wx
1371
1551
  alias_method :background_style=, :set_background_style
1372
1552
 
1373
1553
  # Checks whether using transparent background might work.
1554
+ #
1374
1555
  # If this function returns false, calling {Wx::Window#set_background_style} with {Wx::BackgroundStyle::BG_STYLE_TRANSPARENT} is not going to work. If it returns true, setting transparent style should normally succeed.
1375
1556
  # Notice that this function would typically be called on the parent of a window you want to set transparent background style for as the window for which this method is called must be fully created.
1376
1557
  #
@@ -1381,6 +1562,7 @@ module Wx
1381
1562
  alias_method :transparent_background_supported?, :is_transparent_background_supported
1382
1563
 
1383
1564
  # Sets the font for this window.
1565
+ #
1384
1566
  # This function should not be called for the parent window if you don't want its font to be inherited by its children, use {Wx::Window#set_own_font} instead in this case and see {Wx::Window#inherit_attributes} for more explanations.
1385
1567
  # Please notice that the given font is not automatically used for {Wx::PaintDC} objects associated with this window, you need to call {Wx::DC#set_font} too. However this font is used by any standard controls for drawing their text as well as by {Wx::Window#get_text_extent}.
1386
1568
  #
@@ -1393,6 +1575,7 @@ module Wx
1393
1575
  alias_method :font=, :set_font
1394
1576
 
1395
1577
  # Sets the foreground colour of the window.
1578
+ #
1396
1579
  # The meaning of foreground colour varies according to the window class; it may be the text colour or other colour, or it may not be used at all. Additionally, not all native controls support changing their foreground colour so this method may change their colour only partially or even not at all.
1397
1580
  # Please see {Wx::Window#inherit_attributes} for explanation of the difference between this method and {Wx::Window#set_own_foreground_colour}.
1398
1581
  #
@@ -1408,6 +1591,7 @@ module Wx
1408
1591
 
1409
1592
  # Sets the background colour of the window but prevents it from being inherited by the children of this window.
1410
1593
  #
1594
+ #
1411
1595
  # @see Wx::Window#set_background_colour
1412
1596
  # @see Wx::Window#inherit_attributes
1413
1597
  # @param colour [Wx::Colour,String,Symbol]
@@ -1417,6 +1601,7 @@ module Wx
1417
1601
 
1418
1602
  # Return true if this window inherits the background colour from its parent.
1419
1603
  #
1604
+ #
1420
1605
  # @see Wx::Window#set_own_background_colour
1421
1606
  # @see Wx::Window#inherit_attributes
1422
1607
  # @return [Boolean]
@@ -1427,12 +1612,14 @@ module Wx
1427
1612
  def use_bg_col; end
1428
1613
 
1429
1614
  # Return true if a background colour has been set for this window.
1615
+ #
1430
1616
  # Same as {Wx::Window#use_bg_col}
1431
1617
  # @return [Boolean]
1432
1618
  def use_background_colour; end
1433
1619
 
1434
1620
  # Sets the font of the window but prevents it from being inherited by the children of this window.
1435
1621
  #
1622
+ #
1436
1623
  # @see Wx::Window#set_font
1437
1624
  # @see Wx::Window#inherit_attributes
1438
1625
  # @param font [Wx::Font,Wx::FontInfo]
@@ -1442,6 +1629,7 @@ module Wx
1442
1629
 
1443
1630
  # Sets the foreground colour of the window but prevents it from being inherited by the children of this window.
1444
1631
  #
1632
+ #
1445
1633
  # @see Wx::Window#set_foreground_colour
1446
1634
  # @see Wx::Window#inherit_attributes
1447
1635
  # @param colour [Wx::Colour,String,Symbol]
@@ -1455,18 +1643,21 @@ module Wx
1455
1643
 
1456
1644
  # Return true if this window inherits the foreground colour from its parent.
1457
1645
  #
1646
+ #
1458
1647
  # @see Wx::Window#set_own_foreground_colour
1459
1648
  # @see Wx::Window#inherit_attributes
1460
1649
  # @return [Boolean]
1461
1650
  def inherits_foreground_colour; end
1462
1651
 
1463
1652
  # Return true from here to allow the colours of this window to be changed by {Wx::Window#inherit_attributes}.
1653
+ #
1464
1654
  # Returning false forbids inheriting them from the parent window.
1465
1655
  # The base class version returns false, but this method is overridden in {Wx::Control} where it returns true.
1466
1656
  # @return [Boolean]
1467
1657
  def should_inherit_colours; end
1468
1658
 
1469
1659
  # This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.
1660
+ #
1470
1661
  # This does not always have any effect since the underlying platform obviously needs to support the notion of themes in user defined windows. One such platform is GTK+ where windows can have (very colourful) backgrounds defined by a user's selected theme.
1471
1662
  # Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best.
1472
1663
  # @see Wx::Window#get_theme_enabled
@@ -1477,18 +1668,21 @@ module Wx
1477
1668
 
1478
1669
  # Returns true if the window uses the system theme for drawing its background.
1479
1670
  #
1671
+ #
1480
1672
  # @see Wx::Window#set_theme_enabled
1481
1673
  # @return [Boolean]
1482
1674
  def get_theme_enabled; end
1483
1675
  alias_method :theme_enabled, :get_theme_enabled
1484
1676
 
1485
1677
  # Returns true if the system supports transparent windows and calling {Wx::Window#set_transparent} may succeed.
1678
+ #
1486
1679
  # If this function returns false, transparent windows are definitely not supported by the current system.
1487
1680
  # @return [Boolean]
1488
1681
  def can_set_transparent; end
1489
1682
  alias_method :can_set_transparent?, :can_set_transparent
1490
1683
 
1491
1684
  # Set the transparency of the window.
1685
+ #
1492
1686
  # If the system supports transparent windows, returns true, otherwise returns false and the window remains fully opaque. See also {Wx::Window#can_set_transparent}.
1493
1687
  # The parameter alpha is in the range 0..255 where 0 corresponds to a fully transparent window and 255 to the fully opaque one. The constants {Wx::IMAGE_ALPHA_TRANSPARENT} and {Wx::IMAGE_ALPHA_OPAQUE} can be used.
1494
1688
  # @param alpha [Integer]
@@ -1497,6 +1691,7 @@ module Wx
1497
1691
  alias_method :transparent=, :set_transparent
1498
1692
 
1499
1693
  # Returns the event handler for this window.
1694
+ #
1500
1695
  # By default, the window is its own event handler.
1501
1696
  # @see Wx::Window#set_event_handler
1502
1697
  # @see Wx::Window#push_event_handler
@@ -1508,6 +1703,7 @@ module Wx
1508
1703
  alias_method :event_handler, :get_event_handler
1509
1704
 
1510
1705
  # This function will generate the appropriate call to {Wx::Window#navigate} if the key event is one normally used for keyboard navigation and return true in this case.
1706
+ #
1511
1707
  # Returns true if the key pressed was for navigation and was handled, false otherwise.
1512
1708
  # @see Wx::Window#navigate
1513
1709
  # @param event [Wx::KeyEvent]
@@ -1515,6 +1711,7 @@ module Wx
1515
1711
  def handle_as_navigation_key(event) end
1516
1712
 
1517
1713
  # Shorthand for:
1714
+ #
1518
1715
  # ```ruby
1519
1716
  # get_event_handler.safely_process_event(event)
1520
1717
  # ```
@@ -1524,6 +1721,7 @@ module Wx
1524
1721
  def handle_window_event(event) end
1525
1722
 
1526
1723
  # Convenient wrapper for {Wx::Window#process_event}.
1724
+ #
1527
1725
  # This is the same as writing
1528
1726
  # ```ruby
1529
1727
  # get_event_handler.process_event(event)
@@ -1534,12 +1732,14 @@ module Wx
1534
1732
  def process_window_event(event) end
1535
1733
 
1536
1734
  # Wrapper for {Wx::EvtHandler#process_event_locally}.
1735
+ #
1537
1736
  # This method is similar to {Wx::Window#process_window_event} but can be used to search for the event handler only in this window and any event handlers pushed on top of it. Unlike {Wx::Window#process_window_event} it won't propagate the event upwards. But it will use the validator and event handlers associated with this window, if any.
1538
1737
  # @param event [Wx::Event]
1539
1738
  # @return [Boolean]
1540
1739
  def process_window_event_locally(event) end
1541
1740
 
1542
1741
  # Pushes this event handler onto the event stack for the window.
1742
+ #
1543
1743
  # An event handler is an object that is capable of processing the events sent to a window. By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes.
1544
1744
  # {Wx::Window#push_event_handler} allows an application to set up a stack of event handlers, where an event not handled by one event handler is handed to the next one in the chain.
1545
1745
  # E.g. if you have two event handlers A and B and a {Wx::Window} instance W and you call:
@@ -1556,6 +1756,7 @@ module Wx
1556
1756
  def push_event_handler(handler) end
1557
1757
 
1558
1758
  # Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.
1759
+ #
1559
1760
  # See {Wx::EvtHandler#unlink} for more info.
1560
1761
  #
1561
1762
  # Returns true if it was found and false otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there).
@@ -1566,6 +1767,7 @@ module Wx
1566
1767
  def remove_event_handler(handler) end
1567
1768
 
1568
1769
  # Sets the event handler for this window.
1770
+ #
1569
1771
  # Note that if you use this function you may want to use as the "next" handler of handler the window itself; in this way when handler doesn't process an event, the window itself will have a chance to do it.
1570
1772
  # @see How Events are Processed
1571
1773
  # @param handler [Wx::EvtHandler] Specifies the handler to be set. Cannot be NULL.
@@ -1574,6 +1776,7 @@ module Wx
1574
1776
  alias_method :event_handler=, :set_event_handler
1575
1777
 
1576
1778
  # {Wx::WINDOWS} cannot be used to form event handler chains; this function thus will assert when called.
1779
+ #
1577
1780
  # Note that instead you can use {Wx::Window#push_event_handler} or {Wx::Window#set_event_handler} to implement a stack of event handlers to override {Wx::Window}'s own event handling mechanism.
1578
1781
  # @param handler [Wx::EvtHandler]
1579
1782
  # @return [void]
@@ -1581,6 +1784,7 @@ module Wx
1581
1784
  alias_method :next_handler=, :set_next_handler
1582
1785
 
1583
1786
  # {Wx::WINDOWS} cannot be used to form event handler chains; this function thus will assert when called.
1787
+ #
1584
1788
  # Note that instead you can use {Wx::Window#push_event_handler} or {Wx::Window#set_event_handler} to implement a stack of event handlers to override {Wx::Window}'s own event handling mechanism.
1585
1789
  # @param handler [Wx::EvtHandler]
1586
1790
  # @return [void]
@@ -1593,6 +1797,7 @@ module Wx
1593
1797
  alias_method :extra_style, :get_extra_style
1594
1798
 
1595
1799
  # Gets the window style that was passed to the constructor or {Wx::Window#create} method.
1800
+ #
1596
1801
  # {Wx::Window#get_window_style} is another name for the same function.
1597
1802
  # @return [Integer]
1598
1803
  def get_window_style_flag; end
@@ -1605,6 +1810,7 @@ module Wx
1605
1810
 
1606
1811
  # Returns true if the window has the given exFlag bit set in its extra styles.
1607
1812
  #
1813
+ #
1608
1814
  # @see Wx::Window#set_extra_style
1609
1815
  # @param exFlag [Integer]
1610
1816
  # @return [Boolean]
@@ -1618,6 +1824,7 @@ module Wx
1618
1824
  alias_method :has_flag?, :has_flag
1619
1825
 
1620
1826
  # Sets the extra style bits for the window.
1827
+ #
1621
1828
  # The currently defined extra style bits are reported in the class description.
1622
1829
  # @param exStyle [Integer]
1623
1830
  # @return [void]
@@ -1625,6 +1832,7 @@ module Wx
1625
1832
  alias_method :extra_style=, :set_extra_style
1626
1833
 
1627
1834
  # Sets the style of the window.
1835
+ #
1628
1836
  # Please note that some styles cannot be changed after the window creation and that {Wx::Window#refresh} might need to be called after changing the others for the change to take place immediately.
1629
1837
  # See Window styles for more information about flags.
1630
1838
  # @see Wx::Window#get_window_style_flag
@@ -1640,6 +1848,7 @@ module Wx
1640
1848
  alias_method :window_style=, :set_window_style
1641
1849
 
1642
1850
  # Turns the given flag on if it's currently turned off and vice versa.
1851
+ #
1643
1852
  # This function cannot be used if the value of the flag is 0 (which is often the case for default flags).
1644
1853
  # Also, please notice that not all styles can be changed after the control creation.
1645
1854
  # Returns true if the style was turned on by this function, false if it was switched off.
@@ -1650,6 +1859,7 @@ module Wx
1650
1859
  def toggle_window_style(flag) end
1651
1860
 
1652
1861
  # Moves this window in the tab navigation order after the specified win.
1862
+ #
1653
1863
  # This means that when the user presses TAB key on that other window, the focus switches to this window.
1654
1864
  # Default tab order is the same as creation order, this function and {Wx::Window#move_before_in_tab_order} allow to change it after creating all the windows.
1655
1865
  # @param win [Wx::Window] A sibling of this window which should precede it in tab order, must not be NULL
@@ -1662,39 +1872,33 @@ module Wx
1662
1872
  def move_before_in_tab_order(win) end
1663
1873
 
1664
1874
  # Performs a keyboard navigation action starting from this window.
1875
+ #
1665
1876
  # This method is equivalent to calling {Wx::Window#navigate_in} method on the parent window.
1666
1877
  #
1667
1878
  # Returns true if the focus was moved to another window or false if nothing changed.
1668
1879
  #
1669
- # You may wish to call this from a text control custom keypress handler to do the default navigation behaviour for the tab key, since the standard default behaviour for a multiline text control with the {Wx::TE_PROCESS_TAB} style is to insert a tab and not navigate to the next control. See also {Wx::NavigationKeyEvent} and HandleAsNavigationKey.
1880
+ # <div class="wxrb-remark">
1881
+ # <b>Remark:</b>
1882
+ # <p>You may wish to call this from a text control custom keypress handler to do the default navigation behaviour for the tab key, since the standard default behaviour for a multiline text control with the {Wx::TE_PROCESS_TAB} style is to insert a tab and not navigate to the next control. See also {Wx::NavigationKeyEvent} and HandleAsNavigationKey.
1883
+ # </p>
1884
+ # </div>
1670
1885
  # @param flags [Integer] A combination of {Wx::NavigationKeyEvent::NavigationKeyEventFlags::IsForward} and {Wx::NavigationKeyEvent::NavigationKeyEventFlags::WinChange}.
1671
1886
  # @return [Boolean]
1672
1887
  def navigate(flags=NavigationKeyEvent::IsForward) end
1673
1888
 
1674
1889
  # Performs a keyboard navigation action inside this window.
1890
+ #
1675
1891
  # See {Wx::Window#navigate} for more information.
1676
1892
  # @param flags [Integer]
1677
1893
  # @return [Boolean]
1678
1894
  def navigate_in(flags=NavigationKeyEvent::IsForward) end
1679
1895
 
1680
- # Lowers the window to the bottom of the window hierarchy (Z-order).
1681
- # This function only works for {Wx::TopLevelWindow}-derived classes.
1682
- # @see Wx::Window#raise
1683
- # @return [void]
1684
- def lower; end
1685
-
1686
- # Raises the window to the top of the window hierarchy (Z-order).
1687
- # Notice that this function only requests the window manager to raise this window to the top of Z-order. Depending on its configuration, the window manager may raise the window, not do it at all or indicate that a window requested to be raised in some other way, e.g. by flashing its icon if it is minimized.
1688
- # This function only works for {Wx::TopLevelWindow}-derived classes.
1689
- # @see Wx::Window#lower
1690
- # @return [void]
1691
- def raise; end
1692
-
1693
1896
  # Equivalent to calling {Wx::Window#show}(false).
1694
1897
  # @return [Boolean]
1695
1898
  def hide; end
1696
1899
 
1697
1900
  # This function hides a window, like {Wx::Window#hide}, but using a special visual effect if possible.
1901
+ #
1698
1902
  # The parameters of this function are the same as for {Wx::Window#show_with_effect}, please see their description there.
1699
1903
  # @param effect [Wx::ShowEffect]
1700
1904
  # @param timeout [Integer]
@@ -1702,6 +1906,7 @@ module Wx
1702
1906
  def hide_with_effect(effect, timeout=0) end
1703
1907
 
1704
1908
  # Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.
1909
+ #
1705
1910
  # Notice that this method can return false even if this window itself hadn't been explicitly disabled when one of its parent windows is disabled. To get the intrinsic status of this window, use {Wx::Window#is_this_enabled}
1706
1911
  # @see Wx::Window#enable
1707
1912
  # @return [Boolean]
@@ -1710,6 +1915,7 @@ module Wx
1710
1915
 
1711
1916
  # @overload is_exposed(x, y)
1712
1917
  # Returns true if the given point or rectangle area has been exposed since the last repaint.
1918
+ #
1713
1919
  # Call this in a paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
1714
1920
  # @param x [Integer]
1715
1921
  # @param y [Integer]
@@ -1734,6 +1940,7 @@ module Wx
1734
1940
 
1735
1941
  # Returns true if the window is shown, false if it has been hidden.
1736
1942
  #
1943
+ #
1737
1944
  # @see Wx::Window#is_shown_on_screen
1738
1945
  # @return [Boolean]
1739
1946
  def is_shown; end
@@ -1741,18 +1948,21 @@ module Wx
1741
1948
 
1742
1949
  # Returns true if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well.
1743
1950
  #
1951
+ #
1744
1952
  # @see Wx::Window#is_shown
1745
1953
  # @return [Boolean]
1746
1954
  def is_shown_on_screen; end
1747
1955
  alias_method :shown_on_screen?, :is_shown_on_screen
1748
1956
 
1749
1957
  # Disables the window.
1958
+ #
1750
1959
  # Same as {Wx::Window#enable} Enable(false).
1751
1960
  # Returns true if the window has been disabled, false if it had been already disabled before the call to this function.
1752
1961
  # @return [Boolean]
1753
1962
  def disable; end
1754
1963
 
1755
1964
  # Enable or disable the window for user input.
1965
+ #
1756
1966
  # Note that when a parent window is disabled, all of its children are disabled as well and they are re-enabled again when the parent is.
1757
1967
  # A window can be created initially disabled by calling this method on it before calling {Wx::Window#create} to create the actual underlying window, e.g.
1758
1968
  # ```ruby
@@ -1770,6 +1980,7 @@ module Wx
1770
1980
  def enable(enable=true) end
1771
1981
 
1772
1982
  # Shows or hides the window.
1983
+ #
1773
1984
  # You may need to call {Wx::Window#raise} for a top level window if you want to bring it to top, although this is not needed if {Wx::Window#show} is called immediately after the frame creation.
1774
1985
  # Notice that the default state of newly created top level windows is hidden (to allow you to create their contents without flicker) unlike for all the other, not derived from {Wx::TopLevelWindow}, windows that are by default created in the shown state.
1775
1986
  #
@@ -1783,7 +1994,12 @@ module Wx
1783
1994
  def show(show=true) end
1784
1995
 
1785
1996
  # This function shows a window, like {Wx::Window#show}, but using a special visual effect if possible.
1786
- # Currently this function is only implemented in wxMSW and wxOSX and does the same thing as {Wx::Window#show} in the other ports.
1997
+ #
1998
+ # <div class="wxrb-note">
1999
+ # <b>Note:</b>
2000
+ # <p>Currently this function is only implemented in WXMSW and WXOSX and does the same thing as {Wx::Window#show} in the other ports.
2001
+ # </p>
2002
+ # </div>
1787
2003
  # @see Wx::Window#hide_with_effect
1788
2004
  # @param effect [Wx::ShowEffect] The effect to use.
1789
2005
  # @param timeout [Integer] The timeout parameter specifies the time of the animation, in milliseconds. If the default value of 0 is used, the default animation time for the current platform is used.
@@ -1791,6 +2007,7 @@ module Wx
1791
2007
  def show_with_effect(effect, timeout=0) end
1792
2008
 
1793
2009
  # Gets the help text to be used as context-sensitive help for this window.
2010
+ #
1794
2011
  # Note that the text is actually stored by the current {Wx::HelpProvider} implementation, and not in the window object itself.
1795
2012
  # @see Wx::Window#set_help_text
1796
2013
  # @see Wx::Window#get_help_text_at_point
@@ -1800,6 +2017,7 @@ module Wx
1800
2017
  alias_method :help_text, :get_help_text
1801
2018
 
1802
2019
  # Sets the help text to be used as context-sensitive help for this window.
2020
+ #
1803
2021
  # Note that the text is actually stored by the current {Wx::HelpProvider} implementation, and not in the window object itself.
1804
2022
  # @see Wx::Window#get_help_text
1805
2023
  # @see Wx::HelpProvider#add_help
@@ -1809,9 +2027,10 @@ module Wx
1809
2027
  alias_method :help_text=, :set_help_text
1810
2028
 
1811
2029
  # Gets the help text to be used as context-sensitive help for this window.
2030
+ #
1812
2031
  # This method should be overridden if the help message depends on the position inside the window, otherwise {Wx::Window#get_help_text} can be used.
1813
2032
  # @param point [Array(Integer, Integer), Wx::Point] Coordinates of the mouse at the moment of help event emission.
1814
- # @param origin [Wx::wxHelpEvent::Origin] Help event origin, see also {Wx::HelpEvent#get_origin}.
2033
+ # @param origin [Wx::HelpEvent::Origin] Help event origin, see also {Wx::HelpEvent#get_origin}.
1815
2034
  # @return [String]
1816
2035
  def get_help_text_at_point(point, origin) end
1817
2036
  alias_method :help_text_at_point, :get_help_text_at_point
@@ -1828,6 +2047,7 @@ module Wx
1828
2047
 
1829
2048
  # @overload set_tool_tip(tipString)
1830
2049
  # Attach a tooltip to the window.
2050
+ #
1831
2051
  # {Wx::ToolTip} pointer can be NULL in the overload taking the pointer, meaning to unset any existing tooltips; however {Wx::Window#unset_tool_tip} provides a more readable alternative to this operation.
1832
2052
  # Notice that these methods are always available, even if wxWidgets was compiled with {Wx::Setup::USE_TOOLTIPS} set to 0, but don't do anything in this case.
1833
2053
  # @see Wx::Window#get_tool_tip
@@ -1843,15 +2063,17 @@ module Wx
1843
2063
 
1844
2064
  # Unset any existing tooltip.
1845
2065
  #
2066
+ #
1846
2067
  # @see Wx::Window#set_tool_tip
1847
2068
  # @return [void]
1848
2069
  def unset_tool_tip; end
1849
2070
 
1850
2071
  # @overload get_popup_menu_selection_from_user(menu, pos=Wx::DEFAULT_POSITION)
1851
2072
  # This function shows a popup menu at the given position in this window and returns the selected id.
2073
+ #
1852
2074
  # It can be more convenient than the general purpose {Wx::Window#popup_menu} function for simple menus proposing a choice in a list of strings to the user.
1853
2075
  # Notice that to avoid unexpected conflicts between the (usually consecutive range of) ids used by the menu passed to this function and the existing EVT_UPDATE_UI() handlers, this function temporarily disables UI updates for the window, so you need to manually disable (or toggle or ...) any items which should be disabled in the menu before showing it.
1854
- # The parameter menu is the menu to show. The parameter pos (or the parameters x and y) is the position at which to show the menu in client coordinates. It is recommended to not explicitly specify coordinates when calling this method in response to mouse click, because some of the ports (namely, wxGTK) can do a better job of positioning the menu in that case.
2076
+ # The parameter menu is the menu to show. The parameter pos (or the parameters x and y) is the position at which to show the menu in client coordinates. It is recommended to not explicitly specify coordinates when calling this method in response to mouse click, because some of the ports (namely, WXGTK) can do a better job of positioning the menu in that case.
1855
2077
  # The selected menu item id or {Wx::StandardID::ID_NONE} if none selected or an error occurred.
1856
2078
  # @param menu [Wx::Menu]
1857
2079
  # @param pos [Array(Integer, Integer), Wx::Point]
@@ -1867,11 +2089,17 @@ module Wx
1867
2089
 
1868
2090
  # @overload popup_menu(menu, pos=Wx::DEFAULT_POSITION)
1869
2091
  # Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.
2092
+ #
1870
2093
  # If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If coordinates are not specified, the current mouse cursor position is used.
1871
2094
  # menu is the menu to pop up.
1872
2095
  # The position where the menu will appear can be specified either as a {Wx::Point} pos or by two integers (x and y).
1873
2096
  # Note that this function switches focus to this window before showing the menu.
1874
- # Just before the menu is popped up, {Wx::Menu::UpdateUI} is called to ensure that the menu items are in the correct state. The menu does not get deleted by the window. It is recommended to not explicitly specify coordinates when calling PopupMenu in response to mouse click, because some of the ports (namely, wxGTK) can do a better job of positioning the menu in that case.
2097
+ #
2098
+ # <div class="wxrb-remark">
2099
+ # <b>Remark:</b>
2100
+ # <p>Just before the menu is popped up, {Wx::Menu::UpdateUI} is called to ensure that the menu items are in the correct state. The menu does not get deleted by the window. It is recommended to not explicitly specify coordinates when calling PopupMenu in response to mouse click, because some of the ports (namely, WXGTK) can do a better job of positioning the menu in that case.
2101
+ # </p>
2102
+ # </div>
1875
2103
  # @see Wx::Menu
1876
2104
  # @param menu [Wx::Menu]
1877
2105
  # @param pos [Array(Integer, Integer), Wx::Point]
@@ -1885,6 +2113,7 @@ module Wx
1885
2113
  def popup_menu(*args) end
1886
2114
 
1887
2115
  # Validator functions.
2116
+ #
1888
2117
  # Returns a pointer to the current validator for the window, or NULL if there is none.
1889
2118
  # @return [Wx::Validator]
1890
2119
  def get_validator; end
@@ -1896,7 +2125,28 @@ module Wx
1896
2125
  def set_validator(validator) end
1897
2126
  alias_method :validator=, :set_validator
1898
2127
 
2128
+ # Transfers values from child controls to data areas specified by their validators.
2129
+ #
2130
+ # Returns false if a transfer failed.
2131
+ # Notice that this also calls {Wx::Window#transfer_data_from_window} for all children recursively.
2132
+ # @see Wx::Window#transfer_data_to_window
2133
+ # @see Wx::Validator
2134
+ # @see Wx::Window#validate
2135
+ # @return [Boolean]
2136
+ def transfer_data_from_window; end
2137
+
2138
+ # Transfers values to child controls from data areas specified by their validators.
2139
+ #
2140
+ # Notice that this also calls {Wx::Window#transfer_data_to_window} for all children recursively.
2141
+ # Returns false if a transfer failed.
2142
+ # @see Wx::Window#transfer_data_from_window
2143
+ # @see Wx::Validator
2144
+ # @see Wx::Window#validate
2145
+ # @return [Boolean]
2146
+ def transfer_data_to_window; end
2147
+
1899
2148
  # Validates the current values of the child controls using their validators.
2149
+ #
1900
2150
  # Notice that this also calls {Wx::Window#validate} for all children recursively.
1901
2151
  # Returns false if any of the validations failed.
1902
2152
  # @see Wx::Window#transfer_data_from_window
@@ -1906,7 +2156,12 @@ module Wx
1906
2156
  def validate; end
1907
2157
 
1908
2158
  # Returns the identifier of the window.
1909
- # Each window has an integer identifier. If the application has not provided one (or the default {Wx::StandardID::ID_ANY}) a unique identifier with a negative value will be generated.
2159
+ #
2160
+ # <div class="wxrb-remark">
2161
+ # <b>Remark:</b>
2162
+ # <p>Each window has an integer identifier. If the application has not provided one (or the default {Wx::StandardID::ID_ANY}) a unique identifier with a negative value will be generated.
2163
+ # </p>
2164
+ # </div>
1910
2165
  # @see Wx::Window#set_id
1911
2166
  # @see Window IDs
1912
2167
  # @return [Integer]
@@ -1914,7 +2169,12 @@ module Wx
1914
2169
  alias_method :id, :get_id
1915
2170
 
1916
2171
  # Generic way of getting a label from any window, for identification purposes.
1917
- # The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs (such as testing tools or special-needs access programs) which need to identify windows by name.
2172
+ #
2173
+ # <div class="wxrb-remark">
2174
+ # <b>Remark:</b>
2175
+ # <p>The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs (such as testing tools or special-needs access programs) which need to identify windows by name.
2176
+ # </p>
2177
+ # </div>
1918
2178
  # @return [String]
1919
2179
  def get_label; end
1920
2180
  alias_method :label, :get_label
@@ -1932,7 +2192,12 @@ module Wx
1932
2192
  def adjust_for_layout_direction(x, width, widthTotal) end
1933
2193
 
1934
2194
  # Returns the window's name.
1935
- # This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via {Wx::Window#set_name}.
2195
+ #
2196
+ # <div class="wxrb-remark">
2197
+ # <b>Remark:</b>
2198
+ # <p>This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via {Wx::Window#set_name}.
2199
+ # </p>
2200
+ # </div>
1936
2201
  # @see Wx::Window#set_name
1937
2202
  # @return [String]
1938
2203
  def get_name; end
@@ -1944,7 +2209,12 @@ module Wx
1944
2209
  alias_method :window_variant, :get_window_variant
1945
2210
 
1946
2211
  # Sets the identifier of the window.
1947
- # Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.
2212
+ #
2213
+ # <div class="wxrb-remark">
2214
+ # <b>Remark:</b>
2215
+ # <p>Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.
2216
+ # </p>
2217
+ # </div>
1948
2218
  # @see Wx::Window#get_id
1949
2219
  # @see Window IDs
1950
2220
  # @param winid [Integer]
@@ -1954,6 +2224,7 @@ module Wx
1954
2224
 
1955
2225
  # Sets the window's label.
1956
2226
  #
2227
+ #
1957
2228
  # @see Wx::Window#get_label
1958
2229
  # @param label [String] The window label.
1959
2230
  # @return [void]
@@ -1961,6 +2232,7 @@ module Wx
1961
2232
  alias_method :label=, :set_label
1962
2233
 
1963
2234
  # Sets the layout direction for this window.
2235
+ #
1964
2236
  # This function is only supported under MSW and GTK platforms, but not under Mac currently.
1965
2237
  # @param dir [Wx::LayoutDirection]
1966
2238
  # @return [void]
@@ -1969,6 +2241,7 @@ module Wx
1969
2241
 
1970
2242
  # Sets the window's name.
1971
2243
  #
2244
+ #
1972
2245
  # @see Wx::Window#get_name
1973
2246
  # @param name [String] A name to set for the window.
1974
2247
  # @return [void]
@@ -1976,6 +2249,7 @@ module Wx
1976
2249
  alias_method :name=, :set_name
1977
2250
 
1978
2251
  # Chooses a different variant of the window display to use.
2252
+ #
1979
2253
  # Window variants currently just differ in size, as can be seen from {Wx::WindowVariant} documentation. Under all platforms but macOS, this function does nothing more than change the font used by the window. However under macOS it is implemented natively and selects the appropriate variant of the native widget, which has better appearance than just scaled down or up version of the normal variant, so it should be preferred to directly tweaking the font size.
1980
2254
  # By default the controls naturally use the normal variant.
1981
2255
  # @param variant [Wx::WindowVariant]
@@ -1984,12 +2258,21 @@ module Wx
1984
2258
  alias_method :window_variant=, :set_window_variant
1985
2259
 
1986
2260
  # Gets the accelerator table for this window.
2261
+ #
1987
2262
  # See {Wx::AcceleratorTable}.
1988
2263
  # @return [Wx::AcceleratorTable]
1989
2264
  def get_accelerator_table; end
1990
2265
  alias_method :accelerator_table, :get_accelerator_table
1991
2266
 
2267
+ # Returns the accessible object for this window, if any.
2268
+ #
2269
+ # See also {Wx::Accessible}.
2270
+ # @return [Wx::Accessible]
2271
+ def get_accessible; end
2272
+ alias_method :accessible, :get_accessible
2273
+
1992
2274
  # Sets the accelerator table for this window.
2275
+ #
1993
2276
  # See {Wx::AcceleratorTable}.
1994
2277
  # @param accel [Wx::AcceleratorTable]
1995
2278
  # @return [void]
@@ -1997,6 +2280,7 @@ module Wx
1997
2280
  alias_method :accelerator_table=, :set_accelerator_table
1998
2281
 
1999
2282
  # Sets the accessible for this window.
2283
+ #
2000
2284
  # Any existing accessible for this window will be deleted first, if not identical to accessible. See also {Wx::Accessible}.
2001
2285
  # @param accessible [Wx::Accessible]
2002
2286
  # @return [void]
@@ -2004,11 +2288,16 @@ module Wx
2004
2288
  alias_method :accessible=, :set_accessible
2005
2289
 
2006
2290
  # This function simply generates a {Wx::CloseEvent} whose handler usually tries to close the window.
2291
+ #
2007
2292
  # It doesn't close the window itself, however.
2008
2293
  #
2009
2294
  # true if the event was handled and not vetoed, false otherwise.
2010
2295
  #
2011
- # Close calls the close handler for the window, providing an opportunity for the window to choose whether to destroy the window. Usually it is only used with the top level windows ({Wx::Frame} and {Wx::Dialog} classes) as the others are not supposed to have any special OnClose() logic. The close handler should check whether the window is being deleted forcibly, using {Wx::CloseEvent#can_veto}, in which case it should destroy the window using {Wx::Window#destroy}. Note that calling Close does not guarantee that the window will be destroyed; but it provides a way to simulate a manual close of a window, which may or may not be implemented by destroying the window. The default implementation of {Wx::Dialog::OnCloseWindow} does not necessarily delete the dialog, since it will simply simulate a {Wx::StandardID::ID_CANCEL} event which is handled by the appropriate button event handler and may do anything at all. To guarantee that the window will be destroyed, call {Wx::Window#destroy} instead
2296
+ # <div class="wxrb-remark">
2297
+ # <b>Remark:</b>
2298
+ # <p>Close calls the close handler for the window, providing an opportunity for the window to choose whether to destroy the window. Usually it is only used with the top level windows ({Wx::Frame} and {Wx::Dialog} classes) as the others are not supposed to have any special OnClose() logic. The close handler should check whether the window is being deleted forcibly, using {Wx::CloseEvent#can_veto}, in which case it should destroy the window using {Wx::Window#destroy}. Note that calling Close does not guarantee that the window will be destroyed; but it provides a way to simulate a manual close of a window, which may or may not be implemented by destroying the window. The default implementation of {Wx::Dialog::OnCloseWindow} does not necessarily delete the dialog, since it will simply simulate a {Wx::StandardID::ID_CANCEL} event which is handled by the appropriate button event handler and may do anything at all. To guarantee that the window will be destroyed, call {Wx::Window#destroy} instead
2299
+ # </p>
2300
+ # </div>
2012
2301
  # @see Window Deletion Overview
2013
2302
  # @see Wx::Window#destroy
2014
2303
  # @see Wx::CloseEvent
@@ -2017,12 +2306,14 @@ module Wx
2017
2306
  def close(force=false) end
2018
2307
 
2019
2308
  # Destroys the window safely.
2309
+ #
2020
2310
  # Use this function instead of the delete operator, since different window classes can be destroyed differently. Frames and dialogs are not destroyed immediately when this function is called they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows.
2021
2311
  # true if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.
2022
2312
  # @return [Boolean]
2023
2313
  def destroy; end
2024
2314
 
2025
2315
  # Returns true if this window is in process of being destroyed.
2316
+ #
2026
2317
  # Top level windows are not deleted immediately but are rather scheduled for later destruction to give them time to process any pending messages; see {Wx::Window#destroy} description.
2027
2318
  # This function returns true if this window, or one of its parent windows, is scheduled for destruction and can be useful to avoid manipulating it as it's usually useless to do something with a window which is at the point of disappearing anyhow.
2028
2319
  # @return [Boolean]
@@ -2031,6 +2322,7 @@ module Wx
2031
2322
 
2032
2323
  # Returns the associated drop target, which may be NULL.
2033
2324
  #
2325
+ #
2034
2326
  # @see Wx::Window#set_drop_target
2035
2327
  # @see Drag and Drop Overview
2036
2328
  # @return [Wx::DropTarget]
@@ -2038,6 +2330,7 @@ module Wx
2038
2330
  alias_method :drop_target, :get_drop_target
2039
2331
 
2040
2332
  # Associates a drop target with this window.
2333
+ #
2041
2334
  # If the window already has a drop target, it is deleted.
2042
2335
  # @see Wx::Window#get_drop_target
2043
2336
  # @see Drag and Drop Overview
@@ -2047,7 +2340,12 @@ module Wx
2047
2340
  alias_method :drop_target=, :set_drop_target
2048
2341
 
2049
2342
  # Enables or disables eligibility for drop file events (OnDropFiles).
2050
- # Windows only until version 2.8.9, available on all platforms since 2.8.10. Cannot be used together with {Wx::Window#set_drop_target} on non-Windows platforms.
2343
+ #
2344
+ # <div class="wxrb-remark">
2345
+ # <b>Remark:</b>
2346
+ # <p>Windows only until version 2.8.9, available on all platforms since 2.8.10. Cannot be used together with {Wx::Window#set_drop_target} on non-Windows platforms.
2347
+ # </p>
2348
+ # </div>
2051
2349
  # @see Wx::Window#set_drop_target
2052
2350
  # @param accept [Boolean] If true, the window is eligible for drop file events. If false, the window will not accept drop file events.
2053
2351
  # @return [void]
@@ -2064,16 +2362,22 @@ module Wx
2064
2362
  alias_method :sizer, :get_sizer
2065
2363
 
2066
2364
  # Sets the window to have the given layout sizer.
2365
+ #
2067
2366
  # The window will then own the object, and will take care of its deletion. If an existing layout constraints object is already owned by the window, it will be deleted if the deleteOld parameter is true.
2068
2367
  # Note that this function will also call {Wx::Window#set_auto_layout} implicitly with true parameter if the sizer is non-NULL and false otherwise so that the sizer will be effectively used to layout the window children whenever it is resized.
2069
2368
  #
2070
- # SetSizer enables and disables Layout automatically.
2369
+ # <div class="wxrb-remark">
2370
+ # <b>Remark:</b>
2371
+ # <p>SetSizer enables and disables Layout automatically.
2372
+ # </p>
2373
+ # </div>
2071
2374
  # @param sizer [Wx::Sizer] The sizer to set. Pass NULL to disassociate and conditionally delete the window's sizer. See below.
2072
2375
  # @return [void]
2073
2376
  def set_sizer(sizer) end
2074
2377
  alias_method :sizer=, :set_sizer
2075
2378
 
2076
2379
  # Associate the sizer with the window and set the window size and minimal size accordingly.
2380
+ #
2077
2381
  # This method calls {Wx::Window#set_sizer} and then {Wx::Sizer#set_size_hints} which sets the initial window size to the size needed to accommodate all sizer elements and sets the minimal size to the same size, this preventing the user from resizing this window to be less than this minimal size (if it's a top-level window which can be directly resized by the user).
2078
2382
  # @param sizer [Wx::Sizer]
2079
2383
  # @return [void]
@@ -2081,6 +2385,7 @@ module Wx
2081
2385
  alias_method :sizer_and_fit=, :set_sizer_and_fit
2082
2386
 
2083
2387
  # Lays out the children of this window using the associated sizer.
2388
+ #
2084
2389
  # If a sizer hadn't been associated with this window (see {Wx::Window#set_sizer}), this function doesn't do anything, unless this is a top level window (see {Wx::TopLevelWindow#layout}).
2085
2390
  # Note that this method is called automatically when the window size changes if it has the associated sizer (or if {Wx::Window#set_auto_layout} with true argument had been explicitly called), ensuring that it is always laid out correctly.
2086
2391
  #
@@ -2090,6 +2395,7 @@ module Wx
2090
2395
  def layout; end
2091
2396
 
2092
2397
  # Determines whether the {Wx::Window#layout} function will be called automatically when the window is resized.
2398
+ #
2093
2399
  # This method is called implicitly by {Wx::Window#set_sizer} but if you use {Wx::Window#set_constraints} you should call it manually or otherwise the window layout won't be correctly updated when its size changes.
2094
2400
  # @see Wx::Window#set_sizer
2095
2401
  # @see Wx::Window#set_constraints
@@ -2099,12 +2405,14 @@ module Wx
2099
2405
  alias_method :auto_layout=, :set_auto_layout
2100
2406
 
2101
2407
  # Returns true if {Wx::Window#layout} is called automatically when the window is resized.
2408
+ #
2102
2409
  # This function is mostly useful for wxWidgets itself and is rarely needed in the application code.
2103
2410
  # @return [Boolean]
2104
2411
  def get_auto_layout; end
2105
2412
  alias_method :auto_layout, :get_auto_layout
2106
2413
 
2107
2414
  # Directs all mouse input to this window.
2415
+ #
2108
2416
  # Call {Wx::Window#release_mouse} to release the capture.
2109
2417
  # Note that wxWidgets maintains the stack of windows having captured the mouse and when the mouse is released the capture returns to the window which had had captured it previously and it is only really released if there were no previous window. In particular, this means that you must release the mouse as many times as you capture it, unless the window receives the {Wx::MouseCaptureLostEvent} event.
2110
2418
  # Any application which captures the mouse in the beginning of some operation must handle {Wx::MouseCaptureLostEvent} and cancel this operation when it receives the event. The event handler must not recapture mouse.
@@ -2120,6 +2428,7 @@ module Wx
2120
2428
 
2121
2429
  # Return the cursor associated with this window.
2122
2430
  #
2431
+ #
2123
2432
  # @see Wx::Window#set_cursor
2124
2433
  # @return [Wx::Cursor]
2125
2434
  def get_cursor; end
@@ -2127,6 +2436,7 @@ module Wx
2127
2436
 
2128
2437
  # Returns true if this window has the current mouse capture.
2129
2438
  #
2439
+ #
2130
2440
  # @see Wx::Window#capture_mouse
2131
2441
  # @see Wx::Window#release_mouse
2132
2442
  # @see Wx::MouseCaptureLostEvent
@@ -2137,6 +2447,7 @@ module Wx
2137
2447
 
2138
2448
  # Releases mouse input captured with {Wx::Window#capture_mouse}.
2139
2449
  #
2450
+ #
2140
2451
  # @see Wx::Window#capture_mouse
2141
2452
  # @see Wx::Window#has_capture
2142
2453
  # @see Wx::Window#release_mouse
@@ -2152,6 +2463,7 @@ module Wx
2152
2463
  alias_method :caret=, :set_caret
2153
2464
 
2154
2465
  # Sets the window's cursor.
2466
+ #
2155
2467
  # Notice that the window cursor also sets it for the children of the window implicitly.
2156
2468
  # The cursor may be {Wx::NULL_CURSOR} in which case the window cursor will be reset back to default.
2157
2469
  # @see Wx::SetCursor
@@ -2162,13 +2474,19 @@ module Wx
2162
2474
  alias_method :cursor=, :set_cursor
2163
2475
 
2164
2476
  # Moves the pointer to the given position on the window.
2165
- # Apple Human Interface Guidelines forbid moving the mouse cursor programmatically so you should avoid using this function in Mac applications (and probably avoid using it under the other platforms without good reason as well).
2477
+ #
2478
+ # <div class="wxrb-note">
2479
+ # <b>Note:</b>
2480
+ # <p>Apple Human Interface Guidelines forbid moving the mouse cursor programmatically so you should avoid using this function in Mac applications (and probably avoid using it under the other platforms without good reason as well).
2481
+ # </p>
2482
+ # </div>
2166
2483
  # @param x [Integer] The new x position for the cursor.
2167
2484
  # @param y [Integer] The new y position for the cursor.
2168
2485
  # @return [void]
2169
2486
  def warp_pointer(x, y) end
2170
2487
 
2171
2488
  # Request generation of touch events for this window.
2489
+ #
2172
2490
  # Each call to this function supersedes the previous ones, i.e. if you want to receive events for both zoom and rotate gestures, you need to call
2173
2491
  # ```ruby
2174
2492
  # enable_touch_events(Wx::TOUCH_ZOOM_GESTURE | Wx::TOUCH_ROTATE_GESTURE)
@@ -2182,6 +2500,7 @@ module Wx
2182
2500
 
2183
2501
  # @overload hit_test(x, y)
2184
2502
  # Return where the given point lies, exactly.
2503
+ #
2185
2504
  # This method is used to test whether the point lies inside the client window area or on one of its scrollbars.
2186
2505
  # The point coordinates are specified in client window coordinates.
2187
2506
  # @param x [Integer]
@@ -2204,6 +2523,7 @@ module Wx
2204
2523
  alias_method :border, :get_border
2205
2524
 
2206
2525
  # Does the window-specific updating after processing the update event.
2526
+ #
2207
2527
  # This function is called by {Wx::Window#update_window_ui} in order to check return values in the {Wx::UpdateUIEvent} and act appropriately. For example, to allow frame and dialog title updating, wxWidgets implements this function as follows:
2208
2528
  #
2209
2529
  # ```ruby
@@ -2225,12 +2545,14 @@ module Wx
2225
2545
  def do_update_window_ui(event) end
2226
2546
 
2227
2547
  # This method should be overridden to return true if this window has multiple pages.
2548
+ #
2228
2549
  # All standard class with multiple pages such as {Wx::Notebook}, {Wx::Listbook} and {Wx::Treebook} already override it to return true and user-defined classes with similar behaviour should also do so, to allow the library to handle such windows appropriately.
2229
2550
  # @return [Boolean]
2230
2551
  def has_multiple_pages; end
2231
2552
  alias_method :has_multiple_pages?, :has_multiple_pages
2232
2553
 
2233
2554
  # This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.
2555
+ #
2234
2556
  # By "intelligently" the following is meant: by default, all windows use their own {Wx::Window.get_class_default_attributes} default attributes. However if some of the parents attributes are explicitly (that is, using {Wx::Window#set_font} and not {Wx::Window#set_own_font}) changed and if the corresponding attribute hadn't been explicitly set for this window itself, then this window takes the same value as used by the parent. In addition, if the window overrides {Wx::Window#should_inherit_colours} to return false, the colours will not be changed no matter what and only the font might.
2235
2557
  # This rather complicated logic is necessary in order to accommodate the different usage scenarios. The most common one is when all default attributes are used and in this case, nothing should be inherited as in modern GUIs different controls use different fonts (and colours) than their siblings so they can't inherit the same value from the parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes.
2236
2558
  # @return [void]
@@ -2242,6 +2564,7 @@ module Wx
2242
2564
 
2243
2565
  # Returns true if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later.
2244
2566
  #
2567
+ #
2245
2568
  # @see Wx::BufferedDC
2246
2569
  # @return [Boolean]
2247
2570
  def is_double_buffered; end
@@ -2254,52 +2577,73 @@ module Wx
2254
2577
  alias_method :double_buffered=, :set_double_buffered
2255
2578
 
2256
2579
  # Returns true if the window is retained, false otherwise.
2257
- # Retained windows are only available on X platforms.
2580
+ #
2581
+ # <div class="wxrb-remark">
2582
+ # <b>Remark:</b>
2583
+ # <p>Retained windows are only available on X platforms.
2584
+ # </p>
2585
+ # </div>
2258
2586
  # @return [Boolean]
2259
2587
  def is_retained; end
2260
2588
  alias_method :retained?, :is_retained
2261
2589
 
2262
2590
  # Returns true if this window is intrinsically enabled, false otherwise, i.e. if {Wx::Window#enable} Enable(false) had been called.
2591
+ #
2263
2592
  # This method is mostly used for wxWidgets itself, user code should normally use {Wx::Window#is_enabled} instead.
2264
2593
  # @return [Boolean]
2265
2594
  def is_this_enabled; end
2266
2595
  alias_method :this_enabled?, :is_this_enabled
2267
2596
 
2268
2597
  # Returns true if the given window is a top-level one.
2598
+ #
2269
2599
  # Currently all frames and dialogs are considered to be top-level windows (even if they have a parent window).
2270
2600
  # @return [Boolean]
2271
2601
  def is_top_level; end
2272
2602
  alias_method :top_level?, :is_top_level
2273
2603
 
2274
2604
  # This virtual function is normally only used internally, but sometimes an application may need it to implement functionality that should not be disabled by an application defining an OnIdle handler in a derived class.
2605
+ #
2275
2606
  # This function may be used to do delayed painting, for example, and most implementations call {Wx::Window#update_window_ui} in order to send update events to the window in idle time.
2276
2607
  # @return [void]
2277
2608
  def on_internal_idle; end
2278
2609
 
2279
2610
  # Registers a system wide hotkey.
2611
+ #
2280
2612
  # Every time the user presses the hotkey registered here, this window will receive a hotkey event.
2281
2613
  # It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application.
2282
2614
  #
2283
2615
  # true if the hotkey was registered successfully. false if some other application already registered a hotkey with this modifier/virtualKeyCode combination.
2284
2616
  #
2285
- # Use EVT_HOTKEY(hotkeyId, fnc) in the event table to capture the event. This function is currently only implemented under MSW and macOS and always returns false in the other ports.
2617
+ # <div class="wxrb-remark">
2618
+ # <b>Remark:</b>
2619
+ # <p>Use EVT_HOTKEY(hotkeyId, fnc) in the event table to capture the event. This function is currently only implemented under MSW and macOS and always returns false in the other ports.
2620
+ # </p>
2621
+ # </div>
2286
2622
  # @see Wx::Window#unregister_hot_key
2287
2623
  # @param hotkeyId [Integer] Numeric identifier of the hotkey. For applications this must be between 0 and 0xBFFF. If this function is called from a shared DLL, it must be a system wide unique identifier between 0xC000 and 0xFFFF. This is a MSW specific detail.
2288
2624
  # @param modifiers [Integer] A bitwise combination of {Wx::KeyModifier::MOD_SHIFT}, {Wx::KeyModifier::MOD_CONTROL}, {Wx::KeyModifier::MOD_ALT} or {Wx::KeyModifier::MOD_WIN} specifying the modifier keys that have to be pressed along with the key.
2289
2625
  # @param virtualKeyCode [Integer] The key code of the hotkey, e.g. an ASCII character such as <code>'K'</code> or one of elements of {Wx::KeyCode} enum.
2290
2626
  # @return [Boolean]
2627
+ # @wxrb_require USE_HOTKEY
2291
2628
  def register_hot_key(hotkeyId, modifiers, virtualKeyCode) end
2292
2629
 
2293
2630
  # Unregisters a system wide hotkey.
2631
+ #
2294
2632
  # true if the hotkey was unregistered successfully, false if the id was invalid.
2295
2633
  #
2296
- # This function is currently only implemented under MSW.
2634
+ # <div class="wxrb-remark">
2635
+ # <b>Remark:</b>
2636
+ # <p>This function is currently only implemented under MSW.
2637
+ # </p>
2638
+ # </div>
2297
2639
  # @see Wx::Window#register_hot_key
2298
2640
  # @param hotkeyId [Integer] Numeric identifier of the hotkey. Must be the same id that was passed to {Wx::Window#register_hot_key}.
2299
2641
  # @return [Boolean]
2642
+ # @wxrb_require USE_HOTKEY
2300
2643
  def unregister_hot_key(hotkeyId) end
2301
2644
 
2302
2645
  # This function sends one or more {Wx::UpdateUIEvent} to the window.
2646
+ #
2303
2647
  # The particular implementation depends on the window; for example a {Wx::ToolBar} will send an update UI event for each toolbar button, and a {Wx::Frame} will send an update UI event for each menubar menu item.
2304
2648
  # You can call this function from your application to ensure that your UI is up-to-date at this point (as far as your {Wx::UpdateUIEvent} handlers are concerned). This may be necessary if you have called {Wx::UpdateUIEvent.set_mode} or {Wx::UpdateUIEvent.set_update_interval} to limit the overhead that wxWidgets incurs by sending update UI events in idle time. flags should be a bitlist of one or more of the {Wx::UpdateUI} enumeration.
2305
2649
  # If you are calling this function from an OnInternalIdle or OnIdle function, make sure you pass the {Wx::UpdateUI::UPDATE_UI_FROMIDLE} flag, since this tells the window to only update the UI elements that need to be updated in idle time. Some windows update their elements only when necessary, for example when a menu is about to be shown. The following is an example of how to call UpdateWindowUI from an idle function.
@@ -2321,6 +2665,7 @@ module Wx
2321
2665
  def update_window_ui(flags=Wx::UpdateUI::UPDATE_UI_NONE) end
2322
2666
 
2323
2667
  # Returns the default font and colours which are used by the control.
2668
+ #
2324
2669
  # This is useful if you want to use the same font or colour in your own control as in a standard control which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the users system, especially if it uses themes.
2325
2670
  # The variant parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of the returned font. See {Wx::Window#set_window_variant} for more about this.
2326
2671
  # This static method is "overridden" in many derived classes and so calling, for example, {Wx::Button#get_class_default_attributes} will typically return the values appropriate for a button which will be normally different from those returned by, say, {Wx::ListCtrl#get_class_default_attributes}.
@@ -2331,13 +2676,19 @@ module Wx
2331
2676
  def self.get_class_default_attributes(variant=Wx::WindowVariant::WINDOW_VARIANT_NORMAL) end
2332
2677
 
2333
2678
  # Finds the window or control which currently has the keyboard focus.
2334
- # Note that this is a static function, so it can be called without needing a {Wx::Window} pointer.
2679
+ #
2680
+ # <div class="wxrb-remark">
2681
+ # <b>Remark:</b>
2682
+ # <p>Note that this is a static function, so it can be called without needing a {Wx::Window} pointer.
2683
+ # </p>
2684
+ # </div>
2335
2685
  # @see Wx::Window#set_focus
2336
2686
  # @see Wx::Window#has_focus
2337
2687
  # @return [Wx::Window]
2338
2688
  def self.find_focus; end
2339
2689
 
2340
2690
  # Find the first window with the given id.
2691
+ #
2341
2692
  # If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases.
2342
2693
  #
2343
2694
  # Window with the given id or NULL if not found.
@@ -2348,6 +2699,7 @@ module Wx
2348
2699
  def self.find_window_by_id(id, parent=0) end
2349
2700
 
2350
2701
  # Find a window by its label.
2702
+ #
2351
2703
  # Depending on the type of window, the label may be a window title or panel item label. If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
2352
2704
  # The search is recursive in both cases and, unlike with {Wx::Window#find_window}, recurses into top level child windows too.
2353
2705
  #
@@ -2359,6 +2711,7 @@ module Wx
2359
2711
  def self.find_window_by_label(label, parent=0) end
2360
2712
 
2361
2713
  # Find a window by its name (as given in a window constructor or {Wx::Window#create} function call).
2714
+ #
2362
2715
  # If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
2363
2716
  # The search is recursive in both cases and, unlike {Wx::Window#find_window}, recurses into top level child windows too.
2364
2717
  # If no window with such name is found, {Wx::Window.find_window_by_label} is called, i.e. the name is interpreted as (internal) name first but if this fails, it's internal as (user-visible) label. As this behaviour may be confusing, it is usually better to use either the {Wx::Window#find_window} overload taking the name or {Wx::Window.find_window_by_label} directly.
@@ -2370,6 +2723,7 @@ module Wx
2370
2723
 
2371
2724
  # Returns the currently captured window.
2372
2725
  #
2726
+ #
2373
2727
  # @see Wx::Window#has_capture
2374
2728
  # @see Wx::Window#capture_mouse
2375
2729
  # @see Wx::Window#release_mouse
@@ -2379,6 +2733,7 @@ module Wx
2379
2733
  def self.get_capture; end
2380
2734
 
2381
2735
  # Create a new ID or range of IDs that are not currently in use.
2736
+ #
2382
2737
  # The IDs will be reserved until assigned to a {Wx::Window} ID or unreserved with {Wx::Window.unreserve_control_id}.
2383
2738
  # See Window IDs for more information.
2384
2739
  #
@@ -2391,6 +2746,7 @@ module Wx
2391
2746
  def self.new_control_id(count=1) end
2392
2747
 
2393
2748
  # Unreserve an ID or range of IDs that was reserved by {Wx::Window.new_control_id}.
2749
+ #
2394
2750
  # See Window IDs for more information.
2395
2751
  # @see Wx::Window.new_control_id
2396
2752
  # @see Wx::IdManager
@@ -2415,6 +2771,7 @@ module Wx
2415
2771
  def initialize(*args) end
2416
2772
 
2417
2773
  # Construct the actual window object after creating the C++ object.
2774
+ #
2418
2775
  # The non-default constructor of {Wx::Window} class does two things: it initializes the C++ object and it also creates the window object in the underlying graphical toolkit. The {Wx::Window#create} method can be used to perform the second part later, while the default constructor can be used to perform the first part only.
2419
2776
  # Please note that the underlying window must be created exactly once, i.e. if you use the default constructor, which doesn't do this, you must call {Wx::Window#create} before using the window and if you use the non-default constructor, you can not call {Wx::Window#create}, as the underlying window is already created.
2420
2777
  # Note that it is possible and, in fact, useful, to call some methods on the object between creating the C++ object itself and calling {Wx::Window#create} on it, e.g. a common pattern to avoid showing the contents of a window before it is fully initialized is:
@@ -2475,6 +2832,7 @@ module Wx
2475
2832
  #
2476
2833
  #
2477
2834
  #
2835
+ #
2478
2836
  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2479
2837
  class VisualAttributes < ::Object
2480
2838