wxruby3 0.9.2-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (646) hide show
  1. checksums.yaml +4 -4
  2. data/INSTALL.md +35 -29
  3. data/README.md +24 -15
  4. data/ext/wxbase32u_gcc_custom.dll +0 -0
  5. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  6. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  7. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  19. data/lib/wx/core/bitmap_combobox.rb +17 -21
  20. data/lib/wx/core/combobox.rb +13 -3
  21. data/lib/wx/core/controlwithitems.rb +40 -130
  22. data/lib/wx/core/enum.rb +17 -1
  23. data/lib/wx/core/event.rb +6 -1
  24. data/lib/wx/core/events/evt_list.rb +5 -4
  25. data/lib/wx/core/evthandler.rb +8 -2
  26. data/lib/wx/core/generic_validator.rb +312 -0
  27. data/lib/wx/core/listbox.rb +2 -2
  28. data/lib/wx/core/log.rb +1 -1
  29. data/lib/wx/core/owner_drawn_combobox.rb +45 -0
  30. data/lib/wx/core/size.rb +4 -0
  31. data/lib/wx/core/sizer.rb +1 -2
  32. data/lib/wx/core/standard_paths.rb +22 -0
  33. data/lib/wx/core/text_entry.rb +4 -1
  34. data/lib/wx/core/validator.rb +70 -5
  35. data/lib/wx/core/window.rb +3 -7
  36. data/lib/wx/doc/art_locator.rb +1 -0
  37. data/lib/wx/doc/comboctrl.rb +18 -0
  38. data/lib/wx/doc/controlwithitems.rb +16 -0
  39. data/lib/wx/doc/date_picker_ctrl.rb +23 -0
  40. data/lib/wx/doc/editable_listbox.rb +44 -0
  41. data/lib/wx/doc/enum.rb +15 -0
  42. data/lib/wx/doc/event.rb +12 -0
  43. data/lib/wx/doc/extra/12_client_data.md +89 -0
  44. data/lib/wx/doc/extra/13_validators.md +139 -0
  45. data/lib/wx/doc/gdi_common.rb +4 -0
  46. data/lib/wx/doc/gen/about_dialog_info.rb +25 -0
  47. data/lib/wx/doc/gen/accelerator.rb +7 -1
  48. data/lib/wx/doc/gen/accessible.rb +13 -0
  49. data/lib/wx/doc/gen/activity_indicator.rb +7 -0
  50. data/lib/wx/doc/gen/animation.rb +12 -0
  51. data/lib/wx/doc/gen/animation_ctrl.rb +10 -0
  52. data/lib/wx/doc/gen/any_button.rb +17 -1
  53. data/lib/wx/doc/gen/app.rb +35 -1
  54. data/lib/wx/doc/gen/app_traits.rb +38 -5
  55. data/lib/wx/doc/gen/art_provider.rb +14 -0
  56. data/lib/wx/doc/gen/aui/aui_dock_art.rb +12 -0
  57. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +1 -0
  58. data/lib/wx/doc/gen/aui/aui_manager.rb +24 -1
  59. data/lib/wx/doc/gen/aui/aui_manager_event.rb +9 -1
  60. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +3 -0
  61. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +2 -0
  62. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +3 -1
  63. data/lib/wx/doc/gen/aui/aui_notebook.rb +20 -2
  64. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +2 -1
  65. data/lib/wx/doc/gen/aui/aui_pane_info.rb +30 -1
  66. data/lib/wx/doc/gen/aui/aui_tab_art.rb +6 -0
  67. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +1 -0
  68. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +11 -0
  69. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +2 -0
  70. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +2 -1
  71. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +4 -0
  72. data/lib/wx/doc/gen/banner_window.rb +7 -0
  73. data/lib/wx/doc/gen/bitmap.rb +64 -3
  74. data/lib/wx/doc/gen/bitmap_button.rb +6 -1
  75. data/lib/wx/doc/gen/bitmap_combo_box.rb +9 -3
  76. data/lib/wx/doc/gen/book_ctrl_base.rb +17 -2
  77. data/lib/wx/doc/gen/book_ctrl_event.rb +3 -1
  78. data/lib/wx/doc/gen/box_sizer.rb +5 -0
  79. data/lib/wx/doc/gen/brush.rb +16 -1
  80. data/lib/wx/doc/gen/busy_info.rb +8 -0
  81. data/lib/wx/doc/gen/button.rb +11 -3
  82. data/lib/wx/doc/gen/calculate_layout_event.rb +4 -0
  83. data/lib/wx/doc/gen/calendar_ctrl.rb +22 -0
  84. data/lib/wx/doc/gen/calendar_date_attr.rb +1 -0
  85. data/lib/wx/doc/gen/calendar_event.rb +3 -1
  86. data/lib/wx/doc/gen/caret.rb +3 -0
  87. data/lib/wx/doc/gen/check_box.rb +10 -0
  88. data/lib/wx/doc/gen/check_list_box.rb +3 -0
  89. data/lib/wx/doc/gen/choice.rb +14 -2
  90. data/lib/wx/doc/gen/choicebook.rb +1 -0
  91. data/lib/wx/doc/gen/client_dc.rb +1 -0
  92. data/lib/wx/doc/gen/clipboard.rb +9 -0
  93. data/lib/wx/doc/gen/collapsible_pane.rb +3 -0
  94. data/lib/wx/doc/gen/collapsible_pane_event.rb +1 -0
  95. data/lib/wx/doc/gen/colour.rb +20 -0
  96. data/lib/wx/doc/gen/colour_dialog.rb +10 -0
  97. data/lib/wx/doc/gen/colour_picker_ctrl.rb +4 -0
  98. data/lib/wx/doc/gen/colour_picker_event.rb +1 -0
  99. data/lib/wx/doc/gen/combo_box.rb +20 -1
  100. data/lib/wx/doc/gen/combo_ctrl.rb +54 -295
  101. data/lib/wx/doc/gen/command_link_button.rb +8 -0
  102. data/lib/wx/doc/gen/context_help_button.rb +7 -1
  103. data/lib/wx/doc/gen/control.rb +12 -0
  104. data/lib/wx/doc/gen/control_with_items.rb +45 -9
  105. data/lib/wx/doc/gen/core.rb +2 -2
  106. data/lib/wx/doc/gen/cursor.rb +4 -0
  107. data/lib/wx/doc/gen/data_format.rb +1 -0
  108. data/lib/wx/doc/gen/data_object.rb +27 -5
  109. data/lib/wx/doc/gen/date_event.rb +2 -1
  110. data/lib/wx/doc/gen/date_picker_ctrl.rb +7 -1
  111. data/lib/wx/doc/gen/dc.rb +87 -3
  112. data/lib/wx/doc/gen/dial_up_event.rb +2 -0
  113. data/lib/wx/doc/gen/dial_up_manager.rb +12 -0
  114. data/lib/wx/doc/gen/dialog.rb +42 -3
  115. data/lib/wx/doc/gen/dir_dialog.rb +6 -1
  116. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -0
  117. data/lib/wx/doc/gen/dir_picker_ctrl.rb +5 -0
  118. data/lib/wx/doc/gen/drag_drop.rb +20 -0
  119. data/lib/wx/doc/gen/drag_image.rb +7 -0
  120. data/lib/wx/doc/gen/editable_list_box.rb +5 -3
  121. data/lib/wx/doc/gen/event.rb +26 -11
  122. data/lib/wx/doc/gen/event_blocker.rb +2 -1
  123. data/lib/wx/doc/gen/event_filter.rb +3 -0
  124. data/lib/wx/doc/gen/event_list.rb +4 -4
  125. data/lib/wx/doc/gen/events.rb +165 -26
  126. data/lib/wx/doc/gen/evt_handler.rb +40 -2
  127. data/lib/wx/doc/gen/ext_help_controller.rb +9 -0
  128. data/lib/wx/doc/gen/file_ctrl.rb +11 -2
  129. data/lib/wx/doc/gen/file_ctrl_event.rb +5 -1
  130. data/lib/wx/doc/gen/file_dialog.rb +13 -0
  131. data/lib/wx/doc/gen/file_dialog_custom_control.rb +12 -0
  132. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +9 -0
  133. data/lib/wx/doc/gen/file_dir_picker_event.rb +2 -1
  134. data/lib/wx/doc/gen/file_picker_ctrl.rb +4 -0
  135. data/lib/wx/doc/gen/file_system.rb +17 -1
  136. data/lib/wx/doc/gen/find_dialog_event.rb +2 -1
  137. data/lib/wx/doc/gen/find_replace_data.rb +1 -0
  138. data/lib/wx/doc/gen/find_replace_dialog.rb +3 -0
  139. data/lib/wx/doc/gen/flex_grid_sizer.rb +13 -0
  140. data/lib/wx/doc/gen/font.rb +75 -3
  141. data/lib/wx/doc/gen/font_data.rb +14 -0
  142. data/lib/wx/doc/gen/font_dialog.rb +6 -0
  143. data/lib/wx/doc/gen/font_picker_ctrl.rb +8 -0
  144. data/lib/wx/doc/gen/font_picker_event.rb +1 -0
  145. data/lib/wx/doc/gen/frame.rb +24 -7
  146. data/lib/wx/doc/gen/fs_file.rb +22 -0
  147. data/lib/wx/doc/gen/gauge.rb +8 -0
  148. data/lib/wx/doc/gen/gb_sizer_item.rb +5 -0
  149. data/lib/wx/doc/gen/gcdc.rb +2 -0
  150. data/lib/wx/doc/gen/gdi_common.rb +50 -0
  151. data/lib/wx/doc/gen/gdi_object.rb +1 -0
  152. data/lib/wx/doc/gen/generic_dir_ctrl.rb +7 -0
  153. data/lib/wx/doc/gen/graphics_context.rb +36 -7
  154. data/lib/wx/doc/gen/graphics_object.rb +24 -0
  155. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +2 -0
  156. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +14 -2
  157. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -0
  158. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +1 -0
  159. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +2 -0
  160. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -0
  161. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +2 -0
  162. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +1 -0
  163. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +1 -0
  164. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +1 -0
  165. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +9 -0
  166. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +1 -0
  167. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +1 -0
  168. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -0
  169. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +2 -0
  170. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +2 -0
  171. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -0
  172. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +6 -0
  173. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -0
  174. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -0
  175. data/lib/wx/doc/gen/grid/grid_ctrl.rb +229 -7
  176. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +4 -1
  177. data/lib/wx/doc/gen/grid/grid_event.rb +4 -1
  178. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +2 -1
  179. data/lib/wx/doc/gen/grid/grid_size_event.rb +2 -1
  180. data/lib/wx/doc/gen/grid/grid_string_table.rb +7 -0
  181. data/lib/wx/doc/gen/grid/grid_table_base.rb +27 -1
  182. data/lib/wx/doc/gen/grid/grid_table_message.rb +1 -0
  183. data/lib/wx/doc/gen/grid_bag_sizer.rb +24 -4
  184. data/lib/wx/doc/gen/grid_sizer.rb +11 -0
  185. data/lib/wx/doc/gen/gui_event_loop.rb +12 -0
  186. data/lib/wx/doc/gen/header_ctrl.rb +106 -0
  187. data/lib/wx/doc/gen/header_ctrl_event.rb +5 -1
  188. data/lib/wx/doc/gen/help_controller.rb +11 -0
  189. data/lib/wx/doc/gen/help_provider.rb +12 -3
  190. data/lib/wx/doc/gen/html/html_cell.rb +25 -0
  191. data/lib/wx/doc/gen/html/html_cell_event.rb +3 -1
  192. data/lib/wx/doc/gen/html/html_easy_printing.rb +13 -1
  193. data/lib/wx/doc/gen/html/html_help_controller.rb +18 -0
  194. data/lib/wx/doc/gen/html/html_help_data.rb +5 -0
  195. data/lib/wx/doc/gen/html/html_help_window.rb +8 -0
  196. data/lib/wx/doc/gen/html/html_link_event.rb +1 -0
  197. data/lib/wx/doc/gen/html/html_list_box.rb +49 -9
  198. data/lib/wx/doc/gen/html/html_printout.rb +7 -0
  199. data/lib/wx/doc/gen/html/html_window.rb +31 -0
  200. data/lib/wx/doc/gen/hyperlink_ctrl.rb +2 -1
  201. data/lib/wx/doc/gen/hyperlink_event.rb +1 -0
  202. data/lib/wx/doc/gen/icon.rb +19 -1
  203. data/lib/wx/doc/gen/icon_location.rb +1 -0
  204. data/lib/wx/doc/gen/image.rb +67 -10
  205. data/lib/wx/doc/gen/image_list.rb +12 -2
  206. data/lib/wx/doc/gen/info_bar.rb +12 -0
  207. data/lib/wx/doc/gen/keyboard_state.rb +11 -0
  208. data/lib/wx/doc/gen/list_box.rb +20 -3
  209. data/lib/wx/doc/gen/list_ctrl.rb +89 -0
  210. data/lib/wx/doc/gen/list_event.rb +11 -1
  211. data/lib/wx/doc/gen/listbook.rb +1 -0
  212. data/lib/wx/doc/gen/locale.rb +22 -0
  213. data/lib/wx/doc/gen/log.rb +42 -0
  214. data/lib/wx/doc/gen/mdi_client_window.rb +4 -1
  215. data/lib/wx/doc/gen/mdi_frame.rb +27 -4
  216. data/lib/wx/doc/gen/media_ctrl.rb +17 -0
  217. data/lib/wx/doc/gen/media_event.rb +2 -1
  218. data/lib/wx/doc/gen/memory_dc.rb +10 -0
  219. data/lib/wx/doc/gen/menu.rb +48 -7
  220. data/lib/wx/doc/gen/menu_bar.rb +32 -13
  221. data/lib/wx/doc/gen/menu_item.rb +26 -0
  222. data/lib/wx/doc/gen/message_dialog.rb +10 -0
  223. data/lib/wx/doc/gen/mini_frame.rb +5 -2
  224. data/lib/wx/doc/gen/mirror_dc.rb +1 -0
  225. data/lib/wx/doc/gen/mouse_state.rb +1 -0
  226. data/lib/wx/doc/gen/multi_choice_dialog.rb +3 -1
  227. data/lib/wx/doc/gen/non_owned_window.rb +3 -0
  228. data/lib/wx/doc/gen/notebook.rb +11 -1
  229. data/lib/wx/doc/gen/num_validator.rb +37 -0
  230. data/lib/wx/doc/gen/number_entry_dialog.rb +4 -0
  231. data/lib/wx/doc/gen/object.rb +3 -0
  232. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +340 -0
  233. data/lib/wx/doc/gen/paint_dc.rb +1 -0
  234. data/lib/wx/doc/gen/palette.rb +5 -0
  235. data/lib/wx/doc/gen/panel.rb +10 -2
  236. data/lib/wx/doc/gen/pen.rb +30 -1
  237. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +2 -1
  238. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +4 -1
  239. data/lib/wx/doc/gen/pg/pg_cell.rb +6 -1
  240. data/lib/wx/doc/gen/pg/pg_editor.rb +61 -15
  241. data/lib/wx/doc/gen/pg/pg_multi_button.rb +2 -0
  242. data/lib/wx/doc/gen/pg/pg_properties.rb +198 -81
  243. data/lib/wx/doc/gen/pg/pg_property.rb +129 -52
  244. data/lib/wx/doc/gen/pg/pg_validation_info.rb +2 -0
  245. data/lib/wx/doc/gen/pg/property_grid.rb +56 -14
  246. data/lib/wx/doc/gen/pg/property_grid_event.rb +16 -6
  247. data/lib/wx/doc/gen/pg/property_grid_interface.rb +98 -37
  248. data/lib/wx/doc/gen/pg/property_grid_manager.rb +29 -7
  249. data/lib/wx/doc/gen/pg/property_grid_page.rb +11 -4
  250. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +7 -2
  251. data/lib/wx/doc/gen/picker_base.rb +11 -1
  252. data/lib/wx/doc/gen/platform_info.rb +31 -0
  253. data/lib/wx/doc/gen/popup_window.rb +5 -0
  254. data/lib/wx/doc/gen/progress_dialog.rb +4 -0
  255. data/lib/wx/doc/gen/property_sheet_dialog.rb +7 -1
  256. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +2 -0
  257. data/lib/wx/doc/gen/prt/post_script_dc.rb +1 -0
  258. data/lib/wx/doc/gen/prt/preview_frame.rb +4 -0
  259. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +1 -0
  260. data/lib/wx/doc/gen/prt/print_data.rb +27 -0
  261. data/lib/wx/doc/gen/prt/print_dialog.rb +4 -0
  262. data/lib/wx/doc/gen/prt/printer.rb +42 -5
  263. data/lib/wx/doc/gen/prt/printer_dc.rb +2 -0
  264. data/lib/wx/doc/gen/query_layout_info_event.rb +9 -0
  265. data/lib/wx/doc/gen/radio_box.rb +19 -0
  266. data/lib/wx/doc/gen/radio_button.rb +9 -0
  267. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +63 -0
  268. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +23 -0
  269. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +2 -1
  270. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +35 -9
  271. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +2 -1
  272. data/lib/wx/doc/gen/rbn/ribbon_control.rb +10 -0
  273. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +17 -7
  274. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -1
  275. data/lib/wx/doc/gen/rbn/ribbon_page.rb +12 -0
  276. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +11 -0
  277. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +2 -1
  278. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +25 -0
  279. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +2 -1
  280. data/lib/wx/doc/gen/rearrange_ctrl.rb +4 -0
  281. data/lib/wx/doc/gen/rearrange_list.rb +9 -0
  282. data/lib/wx/doc/gen/region.rb +42 -13
  283. data/lib/wx/doc/gen/region_iterator.rb +1 -0
  284. data/lib/wx/doc/gen/rtc/rich_text_box.rb +25 -8
  285. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +41 -4
  286. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -0
  287. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +23 -11
  288. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +74 -0
  289. data/lib/wx/doc/gen/rtc/rich_text_event.rb +6 -1
  290. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +8 -0
  291. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +6 -0
  292. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +1 -0
  293. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +4 -0
  294. data/lib/wx/doc/gen/rtc/rich_text_image.rb +7 -0
  295. data/lib/wx/doc/gen/rtc/rich_text_object.rb +64 -4
  296. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +51 -4
  297. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +13 -0
  298. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +9 -4
  299. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +3 -0
  300. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +2 -0
  301. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +1 -0
  302. data/lib/wx/doc/gen/sash_event.rb +5 -1
  303. data/lib/wx/doc/gen/sash_layout_window.rb +10 -0
  304. data/lib/wx/doc/gen/sash_window.rb +3 -0
  305. data/lib/wx/doc/gen/screen_dc.rb +1 -0
  306. data/lib/wx/doc/gen/scroll_bar.rb +11 -2
  307. data/lib/wx/doc/gen/scrolled_canvas.rb +20 -4
  308. data/lib/wx/doc/gen/scrolled_control.rb +20 -4
  309. data/lib/wx/doc/gen/scrolled_window.rb +20 -4
  310. data/lib/wx/doc/gen/search_ctrl.rb +6 -0
  311. data/lib/wx/doc/gen/simplebook.rb +7 -0
  312. data/lib/wx/doc/gen/single_choice_dialog.rb +3 -1
  313. data/lib/wx/doc/gen/sizer.rb +79 -9
  314. data/lib/wx/doc/gen/sizer_item.rb +16 -2
  315. data/lib/wx/doc/gen/slider.rb +23 -0
  316. data/lib/wx/doc/gen/spin_button.rb +9 -0
  317. data/lib/wx/doc/gen/spin_ctrl.rb +11 -0
  318. data/lib/wx/doc/gen/spin_ctrl_double.rb +7 -0
  319. data/lib/wx/doc/gen/spin_double_event.rb +4 -1
  320. data/lib/wx/doc/gen/spin_event.rb +2 -1
  321. data/lib/wx/doc/gen/splash_screen.rb +2 -0
  322. data/lib/wx/doc/gen/splitter_event.rb +10 -1
  323. data/lib/wx/doc/gen/splitter_window.rb +38 -14
  324. data/lib/wx/doc/gen/static_bitmap.rb +99 -2
  325. data/lib/wx/doc/gen/static_box.rb +6 -0
  326. data/lib/wx/doc/gen/static_box_sizer.rb +3 -0
  327. data/lib/wx/doc/gen/static_line.rb +4 -0
  328. data/lib/wx/doc/gen/static_text.rb +5 -0
  329. data/lib/wx/doc/gen/status_bar.rb +17 -3
  330. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +174 -6
  331. data/lib/wx/doc/gen/stc/styled_text_event.rb +27 -1
  332. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +7 -0
  333. data/lib/wx/doc/gen/svg_file_dc.rb +9 -0
  334. data/lib/wx/doc/gen/system_options.rb +8 -0
  335. data/lib/wx/doc/gen/system_settings.rb +7 -0
  336. data/lib/wx/doc/gen/task_bar_button.rb +12 -0
  337. data/lib/wx/doc/gen/task_bar_icon.rb +5 -0
  338. data/lib/wx/doc/gen/task_bar_icon_event.rb +2 -1
  339. data/lib/wx/doc/gen/text_attr.rb +27 -0
  340. data/lib/wx/doc/gen/text_ctrl.rb +27 -3
  341. data/lib/wx/doc/gen/text_entry.rb +43 -5
  342. data/lib/wx/doc/gen/text_entry_dialog.rb +12 -0
  343. data/lib/wx/doc/gen/text_validator.rb +16 -0
  344. data/lib/wx/doc/gen/time_picker_ctrl.rb +6 -0
  345. data/lib/wx/doc/gen/timer.rb +8 -0
  346. data/lib/wx/doc/gen/timer_event.rb +1 -0
  347. data/lib/wx/doc/gen/tip_provider.rb +5 -0
  348. data/lib/wx/doc/gen/toggle_button.rb +68 -0
  349. data/lib/wx/doc/gen/tool_bar.rb +57 -14
  350. data/lib/wx/doc/gen/tool_tip.rb +6 -0
  351. data/lib/wx/doc/gen/toolbook.rb +3 -0
  352. data/lib/wx/doc/gen/top_level_window.rb +34 -3
  353. data/lib/wx/doc/gen/tree_ctrl.rb +49 -0
  354. data/lib/wx/doc/gen/tree_event.rb +7 -1
  355. data/lib/wx/doc/gen/treebook.rb +9 -0
  356. data/lib/wx/doc/gen/ui_action_simulator.rb +4 -0
  357. data/lib/wx/doc/gen/utils.rb +55 -0
  358. data/lib/wx/doc/gen/v_list_box.rb +21 -0
  359. data/lib/wx/doc/gen/v_scrolled_window.rb +15 -0
  360. data/lib/wx/doc/gen/validator.rb +9 -13
  361. data/lib/wx/doc/gen/variant.rb +6 -0
  362. data/lib/wx/doc/gen/window.rb +260 -52
  363. data/lib/wx/doc/gen/window_dc.rb +2 -0
  364. data/lib/wx/doc/gen/window_disabler.rb +1 -0
  365. data/lib/wx/doc/gen/with_images.rb +7 -1
  366. data/lib/wx/doc/gen/wizard.rb +18 -0
  367. data/lib/wx/doc/gen/wizard_event.rb +3 -1
  368. data/lib/wx/doc/gen/wizard_page.rb +5 -0
  369. data/lib/wx/doc/gen/wizard_page_simple.rb +4 -0
  370. data/lib/wx/doc/gen/wrap_sizer.rb +5 -0
  371. data/lib/wx/doc/gen/xml_node.rb +14 -0
  372. data/lib/wx/doc/gen/xml_resource.rb +22 -0
  373. data/lib/wx/doc/generic_validator.rb +95 -0
  374. data/lib/wx/doc/html/simple_html_listbox.rb +22 -0
  375. data/lib/wx/doc/num_validator.rb +387 -0
  376. data/lib/wx/doc/owner_drawn_combobox.rb +96 -0
  377. data/lib/wx/doc/pg/numeric_property_validator.rb +33 -0
  378. data/lib/wx/doc/static_bitmap.rb +25 -0
  379. data/lib/wx/doc/text_validator.rb +10 -0
  380. data/lib/wx/doc/validator.rb +113 -0
  381. data/lib/wx/doc/window.rb +30 -0
  382. data/lib/wx/html/events/evt_list.rb +0 -10
  383. data/lib/wx/html/simple_html_listbox.rb +24 -91
  384. data/lib/wx/keyword_defs.rb +34 -2
  385. data/lib/wx/rbn/ribbon_gallery.rb +0 -21
  386. data/lib/wx/version.rb +1 -1
  387. data/lib/wxruby_aui.so +0 -0
  388. data/lib/wxruby_core.so +0 -0
  389. data/lib/wxruby_grid.so +0 -0
  390. data/lib/wxruby_html.so +0 -0
  391. data/lib/wxruby_pg.so +0 -0
  392. data/lib/wxruby_prt.so +0 -0
  393. data/lib/wxruby_rbn.so +0 -0
  394. data/lib/wxruby_rtc.so +0 -0
  395. data/lib/wxruby_stc.so +0 -0
  396. data/rakelib/lib/config/mingw.rb +12 -0
  397. data/samples/aui/aui.rb +1237 -1233
  398. data/samples/calendar/calendar.rb +293 -289
  399. data/samples/controls/get_item_sample.rb +83 -79
  400. data/samples/controls/htlbox.rb +331 -327
  401. data/samples/dialogs/dialogs.rb +682 -694
  402. data/samples/dialogs/wizard.rb +52 -55
  403. data/samples/dragdrop/dragdrop.rb +146 -142
  404. data/samples/drawing/bitmap.rb +29 -26
  405. data/samples/drawing/bitmap_image.rb +84 -80
  406. data/samples/drawing/graphics_drawing.rb +209 -205
  407. data/samples/drawing/image_prt.rb +344 -340
  408. data/samples/drawing/maths_images.rb +18 -1
  409. data/samples/drawing/rmagic_bitmap_image.rb +88 -84
  410. data/samples/etc/caret.rb +306 -0
  411. data/samples/etc/miniframe.rb +65 -60
  412. data/samples/etc/sash.rb +109 -105
  413. data/samples/etc/scrollwin.rb +86 -80
  414. data/samples/etc/system_settings.rb +216 -209
  415. data/samples/event/activation.rb +72 -67
  416. data/samples/event/event.rb +160 -153
  417. data/samples/event/threaded.rb +8 -1
  418. data/samples/event/update_ui_event.rb +67 -60
  419. data/samples/grid/grid.rb +188 -181
  420. data/samples/grid/gridtablebase.rb +136 -129
  421. data/samples/html/html.rb +208 -204
  422. data/samples/mdi/mdi.rb +59 -54
  423. data/samples/minimal/minimal.rb +54 -51
  424. data/samples/minimal/nothing.rb +1 -0
  425. data/samples/printing/printing.rb +367 -377
  426. data/samples/printing/printing2.rb +203 -198
  427. data/samples/propgrid/propgrid.rb +2312 -2308
  428. data/samples/propgrid/propgrid_minimal.rb +57 -50
  429. data/samples/ribbon/ribbon.rb +780 -774
  430. data/samples/sampler/ext.rb +0 -33
  431. data/samples/sampler/sample.rb +4 -9
  432. data/samples/sampler.rb +1 -1
  433. data/samples/splash/splash.rb +118 -116
  434. data/samples/text/rich_textctrl.rb +207 -201
  435. data/samples/text/richtext.rb +1409 -1405
  436. data/samples/text/scintilla.rb +137 -128
  437. data/samples/text/textctrl.rb +89 -83
  438. data/samples/text/unicode.rb +175 -168
  439. data/samples/treectrl/treectrl.rb +1430 -1426
  440. data/samples/widgets/activityindicator.rb +95 -0
  441. data/samples/widgets/art/widgets/activityindicator.xpm +278 -0
  442. data/samples/widgets/art/widgets/bmpbtn.xpm +37 -0
  443. data/samples/widgets/art/widgets/bmpcombobox.xpm +54 -0
  444. data/samples/widgets/art/widgets/button.xpm +54 -0
  445. data/samples/widgets/art/widgets/checkbox.xpm +54 -0
  446. data/samples/{bigdemo/icons → widgets/art/widgets}/choice.xpm +1 -1
  447. data/samples/widgets/art/widgets/choicebk.xpm +54 -0
  448. data/samples/widgets/art/widgets/clrpicker.xpm +193 -0
  449. data/samples/widgets/art/widgets/combobox.xpm +54 -0
  450. data/samples/widgets/art/widgets/datepick.xpm +200 -0
  451. data/samples/widgets/art/widgets/dirctrl.xpm +54 -0
  452. data/samples/widgets/art/widgets/dirpicker.xpm +213 -0
  453. data/samples/widgets/art/widgets/filepicker.xpm +214 -0
  454. data/samples/widgets/art/widgets/fontpicker.xpm +185 -0
  455. data/samples/widgets/art/widgets/gauge.xpm +54 -0
  456. data/samples/widgets/art/widgets/header.xpm +54 -0
  457. data/samples/widgets/art/widgets/hyperlnk.xpm +54 -0
  458. data/samples/widgets/art/widgets/listbook.xpm +54 -0
  459. data/samples/widgets/art/widgets/listbox.xpm +54 -0
  460. data/samples/widgets/art/widgets/native.xpm +81 -0
  461. data/samples/widgets/art/widgets/notebook.xpm +54 -0
  462. data/samples/widgets/art/widgets/odcombobox.xpm +54 -0
  463. data/samples/widgets/art/widgets/radiobox.xpm +54 -0
  464. data/samples/widgets/art/widgets/scrolbar.xpm +54 -0
  465. data/samples/widgets/art/widgets/slider.xpm +54 -0
  466. data/samples/widgets/art/widgets/spinbtn.xpm +40 -0
  467. data/samples/widgets/art/widgets/statbmp.xpm +40 -0
  468. data/samples/widgets/art/widgets/statbox.xpm +54 -0
  469. data/samples/widgets/art/widgets/stattext.xpm +54 -0
  470. data/samples/widgets/art/widgets/text.xpm +54 -0
  471. data/samples/widgets/art/widgets/timepick.xpm +207 -0
  472. data/samples/widgets/art/widgets/toggle.xpm +54 -0
  473. data/samples/widgets/art/widgets/toucan.png +0 -0
  474. data/samples/widgets/bmpcombobox.rb +651 -0
  475. data/samples/widgets/button.rb +462 -0
  476. data/samples/widgets/checkbox.rb +211 -0
  477. data/samples/widgets/choice.rb +287 -0
  478. data/samples/widgets/clrpicker.rb +156 -0
  479. data/samples/widgets/combobox.rb +516 -0
  480. data/samples/widgets/datepick.rb +215 -0
  481. data/samples/widgets/dirctrl.rb +265 -0
  482. data/samples/widgets/dirpicker.rb +158 -0
  483. data/samples/widgets/editlbox.rb +122 -0
  484. data/samples/widgets/filectrl.rb +216 -0
  485. data/samples/widgets/filepicker.rb +214 -0
  486. data/samples/widgets/fontpicker.rb +135 -0
  487. data/samples/widgets/gauge.rb +311 -0
  488. data/samples/widgets/headerctrl.rb +236 -0
  489. data/samples/widgets/hyperlink.rb +203 -0
  490. data/samples/widgets/itemcontainer.rb +185 -0
  491. data/samples/widgets/listbox.rb +473 -0
  492. data/samples/widgets/notebook.rb +488 -0
  493. data/samples/widgets/odcombobox.rb +608 -0
  494. data/samples/widgets/radiobox.rb +328 -0
  495. data/samples/widgets/searchctrl.rb +159 -0
  496. data/samples/widgets/slider.rb +594 -0
  497. data/samples/widgets/spinbtn.rb +443 -0
  498. data/samples/widgets/statbmp.rb +130 -0
  499. data/samples/widgets/static.rb +436 -0
  500. data/samples/widgets/textctrl.rb +700 -0
  501. data/samples/widgets/timepick.rb +148 -0
  502. data/samples/widgets/tn_widgets.png +0 -0
  503. data/samples/widgets/toggle.rb +385 -0
  504. data/samples/widgets/widgets.rb +1233 -0
  505. data/samples/xrc/custom_xrc_sample.rb +47 -41
  506. data/samples/xrc/xrc_sample.rb +53 -47
  507. data/tests/test_event_handling.rb +52 -34
  508. data/tests/test_events.rb +7 -0
  509. data/tests/test_item_data.rb +24 -0
  510. data/tests/test_sizer.rb +44 -1
  511. data/tests/test_validators.rb +805 -0
  512. metadata +87 -137
  513. data/lib/wx/core/choice.rb +0 -14
  514. data/lib/wx/core/combo_ctrl.rb +0 -110
  515. data/samples/bigdemo/About.rbw +0 -39
  516. data/samples/bigdemo/ColorPanel.rbw +0 -23
  517. data/samples/bigdemo/GridSimple.rbw +0 -78
  518. data/samples/bigdemo/MDIDemo.rbw +0 -57
  519. data/samples/bigdemo/PopupMenu.rbw +0 -146
  520. data/samples/bigdemo/ShapedWindow.rbw +0 -128
  521. data/samples/bigdemo/Sizers.rbw +0 -541
  522. data/samples/bigdemo/bigdemo.rb +0 -817
  523. data/samples/bigdemo/demoTemplate.rbw +0 -33
  524. data/samples/bigdemo/helpfile.htb +0 -0
  525. data/samples/bigdemo/icons/Test 015.jpg +0 -0
  526. data/samples/bigdemo/icons/Test 015.png +0 -0
  527. data/samples/bigdemo/icons/choice.bmp +0 -0
  528. data/samples/bigdemo/icons/combo.bmp +0 -0
  529. data/samples/bigdemo/icons/combo.xpm +0 -27
  530. data/samples/bigdemo/icons/copy.xpm +0 -25
  531. data/samples/bigdemo/icons/cut.xpm +0 -24
  532. data/samples/bigdemo/icons/gauge.bmp +0 -0
  533. data/samples/bigdemo/icons/gauge.xpm +0 -27
  534. data/samples/bigdemo/icons/help.xpm +0 -25
  535. data/samples/bigdemo/icons/list.bmp +0 -0
  536. data/samples/bigdemo/icons/list.xpm +0 -27
  537. data/samples/bigdemo/icons/mondrian.ico +0 -0
  538. data/samples/bigdemo/icons/mondrian.xpm +0 -44
  539. data/samples/bigdemo/icons/new.xpm +0 -24
  540. data/samples/bigdemo/icons/ogl.ico +0 -0
  541. data/samples/bigdemo/icons/ogl.xpm +0 -45
  542. data/samples/bigdemo/icons/open.xpm +0 -26
  543. data/samples/bigdemo/icons/paste.bmp +0 -0
  544. data/samples/bigdemo/icons/paste.xpm +0 -38
  545. data/samples/bigdemo/icons/pointy.png +0 -0
  546. data/samples/bigdemo/icons/preview.xpm +0 -26
  547. data/samples/bigdemo/icons/print.xpm +0 -26
  548. data/samples/bigdemo/icons/radio.bmp +0 -0
  549. data/samples/bigdemo/icons/radio.xpm +0 -27
  550. data/samples/bigdemo/icons/robert.xpm +0 -415
  551. data/samples/bigdemo/icons/sashtest.ico +0 -0
  552. data/samples/bigdemo/icons/save.xpm +0 -25
  553. data/samples/bigdemo/icons/smiles.bmp +0 -0
  554. data/samples/bigdemo/icons/smiles.xpm +0 -39
  555. data/samples/bigdemo/icons/smiley.ico +0 -0
  556. data/samples/bigdemo/icons/smiley.xpm +0 -42
  557. data/samples/bigdemo/icons/stattext.xpm +0 -24
  558. data/samples/bigdemo/icons/test2.bmp +0 -0
  559. data/samples/bigdemo/icons/test2.png +0 -0
  560. data/samples/bigdemo/icons/test2.xpm +0 -79
  561. data/samples/bigdemo/icons/text.bmp +0 -0
  562. data/samples/bigdemo/icons/text.xpm +0 -27
  563. data/samples/bigdemo/icons/tog1.bmp +0 -0
  564. data/samples/bigdemo/icons/tog1.xpm +0 -38
  565. data/samples/bigdemo/icons/tog2.bmp +0 -0
  566. data/samples/bigdemo/icons/tog2.xpm +0 -38
  567. data/samples/bigdemo/icons/wxruby-128x128.png +0 -0
  568. data/samples/bigdemo/icons/wxwin.ico +0 -0
  569. data/samples/bigdemo/icons/wxwin16x16.png +0 -0
  570. data/samples/bigdemo/icons/wxwin16x16.xpm +0 -25
  571. data/samples/bigdemo/icons/wxwin32x32.png +0 -0
  572. data/samples/bigdemo/icons/wxwin48x48.png +0 -0
  573. data/samples/bigdemo/run.rb +0 -98
  574. data/samples/bigdemo/tips.txt +0 -7
  575. data/samples/bigdemo/utils.rb +0 -20
  576. data/samples/bigdemo/wxArtProvider.rbw +0 -282
  577. data/samples/bigdemo/wxBitmapButton.rbw +0 -65
  578. data/samples/bigdemo/wxButton.rbw +0 -64
  579. data/samples/bigdemo/wxCalendarCtrl.rbw +0 -59
  580. data/samples/bigdemo/wxCheckBox.rbw +0 -50
  581. data/samples/bigdemo/wxCheckListBox.rbw +0 -65
  582. data/samples/bigdemo/wxChoice.rbw +0 -47
  583. data/samples/bigdemo/wxChoicebook.rbw +0 -78
  584. data/samples/bigdemo/wxColourDialog.rbw +0 -33
  585. data/samples/bigdemo/wxComboBox.rbw +0 -77
  586. data/samples/bigdemo/wxCursor.rbw +0 -136
  587. data/samples/bigdemo/wxDialog.rbw +0 -74
  588. data/samples/bigdemo/wxDirDialog.rbw +0 -29
  589. data/samples/bigdemo/wxDragImage.rbw +0 -70
  590. data/samples/bigdemo/wxFileDialog.rbw +0 -37
  591. data/samples/bigdemo/wxFileDialog_Save.rbw +0 -35
  592. data/samples/bigdemo/wxFindReplaceDialog.rbw +0 -82
  593. data/samples/bigdemo/wxFontDialog.rbw +0 -200
  594. data/samples/bigdemo/wxFrame.rbw +0 -53
  595. data/samples/bigdemo/wxGauge.rbw +0 -65
  596. data/samples/bigdemo/wxGenericDirCtrl.rbw +0 -74
  597. data/samples/bigdemo/wxGrid.rbw +0 -66
  598. data/samples/bigdemo/wxHtmlHelpController.rbw +0 -52
  599. data/samples/bigdemo/wxListBox.rbw +0 -140
  600. data/samples/bigdemo/wxListCtrl_virtual.rbw +0 -112
  601. data/samples/bigdemo/wxMDIWindows.rbw +0 -50
  602. data/samples/bigdemo/wxMenu.rbw +0 -247
  603. data/samples/bigdemo/wxMessageDialog.rbw +0 -27
  604. data/samples/bigdemo/wxMiniFrame.rbw +0 -70
  605. data/samples/bigdemo/wxMultipleChoiceDialog.rbw +0 -29
  606. data/samples/bigdemo/wxNotebook.rbw +0 -136
  607. data/samples/bigdemo/wxProgressDialog.rbw +0 -43
  608. data/samples/bigdemo/wxRadioBox.rbw +0 -72
  609. data/samples/bigdemo/wxRadioButton.rbw +0 -125
  610. data/samples/bigdemo/wxSashWindow.rbw +0 -141
  611. data/samples/bigdemo/wxScrolledMessageDialog.rbw +0 -57
  612. data/samples/bigdemo/wxScrolledWindow.rbw +0 -199
  613. data/samples/bigdemo/wxSingleChoiceDialog.rbw +0 -33
  614. data/samples/bigdemo/wxSlider.rbw +0 -42
  615. data/samples/bigdemo/wxSpinButton.rbw +0 -50
  616. data/samples/bigdemo/wxSpinCtrl.rbw +0 -51
  617. data/samples/bigdemo/wxSplitterWindow.rbw +0 -63
  618. data/samples/bigdemo/wxStaticBitmap.rbw +0 -47
  619. data/samples/bigdemo/wxStaticText.rbw +0 -55
  620. data/samples/bigdemo/wxStatusBar.rbw +0 -126
  621. data/samples/bigdemo/wxTextCtrl.rbw +0 -149
  622. data/samples/bigdemo/wxTextEntryDialog.rbw +0 -31
  623. data/samples/bigdemo/wxToggleButton.rbw +0 -49
  624. data/samples/bigdemo/wxToolBar.rbw +0 -131
  625. data/samples/bigdemo/wxTreeCtrl.rbw +0 -191
  626. data/samples/caret/caret.rb +0 -298
  627. data/samples/caret/mondrian.xpm +0 -44
  628. data/samples/controls/books.rb +0 -189
  629. data/samples/controls/choice.xpm +0 -27
  630. data/samples/controls/combo.xpm +0 -27
  631. data/samples/controls/controls.rb +0 -1099
  632. data/samples/controls/gauge.xpm +0 -27
  633. data/samples/controls/list.xpm +0 -27
  634. data/samples/controls/mondrian.ico +0 -0
  635. data/samples/controls/mondrian.xpm +0 -44
  636. data/samples/controls/radio.xpm +0 -27
  637. data/samples/controls/stattext.xpm +0 -24
  638. data/samples/controls/test2.bmp +0 -0
  639. data/samples/controls/text.xpm +0 -27
  640. data/samples/controls/tn_books.png +0 -0
  641. data/samples/controls/tn_controls.png +0 -0
  642. data/samples/etc/choice.rb +0 -87
  643. data/samples/etc/tn_choice.png +0 -0
  644. data/samples/text/mondrian.ico +0 -0
  645. data/samples/text/mondrian.xpm +0 -44
  646. /data/samples/{caret → etc}/tn_caret.png +0 -0
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # A generic implementation of the GUI event loop.
10
+ #
10
11
  # Category: Application and Process Management
11
12
  #
12
13
  #
@@ -17,12 +18,14 @@ module Wx
17
18
  def initialize; end
18
19
 
19
20
  # Start the event loop, return the exit code when it is finished.
21
+ #
20
22
  # Logically, this method calls {Wx::GUIEventLoop#dispatch} in a loop until it returns false and also takes care of generating idle events during each loop iteration. However not all implementations of this class really implement it like this (e.g. WXGTK does not) so you shouldn't rely on {Wx::GUIEventLoop#dispatch} being called from inside this function.
21
23
  # The argument passed to {Wx::GUIEventLoop#exit} which terminated this event loop.
22
24
  # @return [Integer]
23
25
  def run; end
24
26
 
25
27
  # Return true if this event loop is currently running.
28
+ #
26
29
  # Notice that even if this event loop hasn't terminated yet but has just spawned a nested (e.g. modal) event loop, this method would return false.
27
30
  # @return [Boolean]
28
31
  def is_running; end
@@ -34,6 +37,7 @@ module Wx
34
37
  alias_method :ok?, :is_ok
35
38
 
36
39
  # Exit the currently running loop with the given exit code.
40
+ #
37
41
  # The loop will exit, i.e. its {Wx::GUIEventLoop#run} method will return, during the next event loop iteration.
38
42
  # Notice that this method can only be used if this event loop is the currently running one, i.e. its {Wx::GUIEventLoop#is_running} returns true. If this is not the case, an assert failure is triggered and nothing is done as outer event loops can't be exited from immediately. Use {Wx::GUIEventLoop#schedule_exit} if you'd like to exit this loop even if it doesn't run currently.
39
43
  # @param rc [Integer]
@@ -41,6 +45,7 @@ module Wx
41
45
  def exit(rc=0) end
42
46
 
43
47
  # Schedule an exit from the loop with the given exit code.
48
+ #
44
49
  # This method is similar to {Wx::GUIEventLoop#exit} but can be called even if this event loop is not the currently running one and if it is the active loop, then it works in exactly the same way as {Wx::GUIEventLoop#exit}.
45
50
  # The loop will exit as soon as the control flow returns to it, i.e. after any nested loops terminate.
46
51
  # @param rc [Integer]
@@ -48,11 +53,13 @@ module Wx
48
53
  def schedule_exit(rc=0) end
49
54
 
50
55
  # Return true if any events are available.
56
+ #
51
57
  # If this method returns true, calling {Wx::GUIEventLoop#dispatch} will not block.
52
58
  # @return [Boolean]
53
59
  def pending; end
54
60
 
55
61
  # Dispatches the next event in the windowing system event queue.
62
+ #
56
63
  # Blocks until an event appears if there are none currently (use {Wx::GUIEventLoop#pending} if this is not wanted).
57
64
  # This can be used for programming event loops, e.g.
58
65
  #
@@ -68,6 +75,7 @@ module Wx
68
75
  def dispatch; end
69
76
 
70
77
  # Dispatch an event but not wait longer than the specified timeout for it.
78
+ #
71
79
  # If an event is received before the specified timeout expires, it is processed and the function returns 1 normally or 0 if the event loop should quite. Otherwise, i.e. if the timeout expires, the functions returns -1 without processing any events.
72
80
  #
73
81
  # 1 if an event was processed, 0 if the event loop should quit or -1 if the timeout expired.
@@ -84,6 +92,7 @@ module Wx
84
92
  def wake_up_idle; end
85
93
 
86
94
  # This virtual function is called when the application becomes idle and normally just sends {Wx::IdleEvent} to all interested parties.
95
+ #
87
96
  # It should return true if more idle events are needed, false if not.
88
97
  # @return [Boolean]
89
98
  def process_idle; end
@@ -94,6 +103,7 @@ module Wx
94
103
  alias_method :yielding?, :is_yielding
95
104
 
96
105
  # Yields control to pending messages in the windowing system.
106
+ #
97
107
  # This can be useful, for example, when a time-consuming process writes to a text window. Without an occasional yield, the text window will not be updated properly, and on systems with cooperative multitasking, other processes will not respond.
98
108
  # Caution should be exercised, however, since yielding may allow the user to perform actions which are not compatible with the current task. Disabling menu items or whole menus during processing can avoid unwanted reentrance of code: see {Wx::SafeYield} for a better function.
99
109
  # Note that {Wx::GUIEventLoop#yield} will not flush the message logs. This is intentional as calling {Wx::GUIEventLoop#yield} is usually done to quickly update the screen and popping up a message box dialog may be undesirable. If you do wish to flush the log messages immediately (otherwise it will be done during the next idle loop iteration), call {Wx::Log.flush_active}.
@@ -103,6 +113,7 @@ module Wx
103
113
  def yield(onlyIfNeeded=false) end
104
114
 
105
115
  # Works like {Wx::GUIEventLoop#yield} with onlyIfNeeded == true, except that it allows the caller to specify a mask of the {Wx::EventCategory} values which indicates which events should be processed and which should instead be "delayed" (i.e.
116
+ #
106
117
  # processed by the main loop later).
107
118
  # Note that this is a safer alternative to {Wx::GUIEventLoop#yield} since it ensures that only the events you're interested to will be processed; i.e. this method helps to avoid unwanted reentrancies.
108
119
  # Note that currently only WXMSW and WXGTK do support selective yield of native events coming from the underlying GUI toolkit. wxWidgets events posted using {Wx::EvtHandler#add_pending_event} or {Wx::EvtHandler#queue_event} are instead selectively processed by all ports.
@@ -112,6 +123,7 @@ module Wx
112
123
  def yield_for(eventsToProcess) end
113
124
 
114
125
  # Returns true if the given event category is allowed inside a {Wx::GUIEventLoop#yield_for} call (i.e.
126
+ #
115
127
  # compares the given category against the last mask passed to {Wx::GUIEventLoop#yield_for}).
116
128
  # @see Wx::Event#get_event_category
117
129
  # @param cat [Wx::EventCategory]
@@ -6,7 +6,52 @@
6
6
 
7
7
  module Wx
8
8
 
9
+ #
10
+ #
11
+ HD_ALLOW_REORDER = 1
12
+
13
+ #
14
+ #
15
+ HD_ALLOW_HIDE = 2
16
+
17
+ #
18
+ #
19
+ HD_BITMAP_ON_RIGHT = 4
20
+
21
+ #
22
+ #
23
+ HD_DEFAULT_STYLE = 1
24
+
25
+ # Special value used for column width meaning unspecified or default.
26
+ #
27
+ COL_WIDTH_DEFAULT = -1
28
+
29
+ # Size the column automatically to fit all values.
30
+ #
31
+ COL_WIDTH_AUTOSIZE = -2
32
+
33
+ # Column can be resized (included in default flags).
34
+ #
35
+ COL_RESIZABLE = 1
36
+
37
+ # Column can be clicked to toggle the sort order by its contents.
38
+ #
39
+ COL_SORTABLE = 2
40
+
41
+ # Column can be dragged to change its order (included in default).
42
+ #
43
+ COL_REORDERABLE = 4
44
+
45
+ # Column is not shown at all.
46
+ #
47
+ COL_HIDDEN = 8
48
+
49
+ # Default flags for {Wx::HeaderColumn} ctor.
50
+ #
51
+ COL_DEFAULT_FLAGS = 5
52
+
9
53
  # {Wx::HeaderCtrl} is the control containing the column headings which is usually used for display of tabular data.
54
+ #
10
55
  # It is used as part of {Wx::GRID::Grid}, in generic version {Wx::DataViewCtrl} and report view of {Wx::ListCtrl} but can be also used independently. In general this class is meant to be used as part of another control which already stores the column information somewhere as it can't be used directly: instead you need to inherit from it and implement the {Wx::HeaderCtrl#get_column} method to provide column information. See {Wx::HeaderCtrlSimple} for a concrete control class which can be used directly.
11
56
  # In addition to labeling the columns, the control has the following features:
12
57
  #
@@ -76,10 +121,12 @@ module Wx
76
121
 
77
122
  # @overload initialize()
78
123
  # Default constructor not creating the underlying window.
124
+ #
79
125
  # You must use {Wx::HeaderCtrl#create} after creating the object using this constructor.
80
126
  # @return [Wx::HeaderCtrl]
81
127
  # @overload initialize(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HD_DEFAULT_STYLE, name=Wx::HEADER_CTRL_NAME_STR)
82
128
  # Constructor creating the window.
129
+ #
83
130
  # Please see {Wx::HeaderCtrl#create} for the parameters documentation.
84
131
  # @param parent [Wx::Window]
85
132
  # @param winid [Integer]
@@ -105,6 +152,7 @@ module Wx
105
152
  def create(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HD_DEFAULT_STYLE, name=Wx::HEADER_CTRL_NAME_STR) end
106
153
 
107
154
  # Set the number of columns in the control.
155
+ #
108
156
  # The control will use {Wx::HeaderCtrl#get_column} to get information about all the new columns and refresh itself, i.e. this method also has the same effect as calling {Wx::HeaderCtrl#update_column} for all columns but it should only be used if the number of columns really changed.
109
157
  # @param count [Integer]
110
158
  # @return [void]
@@ -112,6 +160,7 @@ module Wx
112
160
  alias_method :column_count=, :set_column_count
113
161
 
114
162
  # Return the number of columns in the control.
163
+ #
115
164
  # Number of columns as previously set by {Wx::HeaderCtrl#set_column_count}.
116
165
  # @see Wx::HeaderCtrl#is_empty
117
166
  # @return [Integer]
@@ -120,18 +169,21 @@ module Wx
120
169
 
121
170
  # Return whether the control has any columns.
122
171
  #
172
+ #
123
173
  # @see Wx::HeaderCtrl#get_column_count
124
174
  # @return [Boolean]
125
175
  def is_empty; end
126
176
  alias_method :empty?, :is_empty
127
177
 
128
178
  # Update the column with the given index.
179
+ #
129
180
  # When the value returned by {Wx::HeaderCtrl#get_column} changes, this method must be called to notify the control about the change and update the visual display to match the new column data.
130
181
  # @param idx [Integer] The column index, must be less than {Wx::HeaderCtrl#get_column_count}.
131
182
  # @return [void]
132
183
  def update_column(idx) end
133
184
 
134
185
  # Change the columns display order.
186
+ #
135
187
  # The display order defines the order in which the columns appear on the screen and does not affect the interpretation of indices by all the other class methods.
136
188
  # The order array specifies the column indices corresponding to the display positions.
137
189
  # @see Wx::ListCtrl#set_columns_order
@@ -141,6 +193,7 @@ module Wx
141
193
  alias_method :columns_order=, :set_columns_order
142
194
 
143
195
  # Return the array describing the columns display order.
196
+ #
144
197
  # For the controls without {Wx::HD_ALLOW_REORDER} style the returned array will be the same as was passed to {Wx::HeaderCtrl#set_columns_order} previously or define the default order (with n-th element being n) if it hadn't been called. But for the controls with {Wx::HD_ALLOW_REORDER} style, the columns can be also reordered by user.
145
198
  # @return [Array<Integer>]
146
199
  def get_columns_order; end
@@ -148,6 +201,7 @@ module Wx
148
201
 
149
202
  # Return the index of the column displayed at the given position.
150
203
  #
204
+ #
151
205
  # @see Wx::HeaderCtrl#get_column_pos
152
206
  # @param pos [Integer] The display position, e.g. 0 for the left-most column, 1 for the next one and so on until {Wx::HeaderCtrl#get_column_count} - 1.
153
207
  # @return [Integer]
@@ -155,6 +209,7 @@ module Wx
155
209
  alias_method :column_at, :get_column_at
156
210
 
157
211
  # Get the position at which this column is currently displayed.
212
+ #
158
213
  # Notice that a valid position is returned even for the hidden columns currently.
159
214
  # @see Wx::HeaderCtrl#get_column_at
160
215
  # @param idx [Integer] The column index, must be less than {Wx::HeaderCtrl#get_column_count}.
@@ -163,11 +218,13 @@ module Wx
163
218
  alias_method :column_pos, :get_column_pos
164
219
 
165
220
  # Reset the columns order to the natural one.
221
+ #
166
222
  # After calling this function, the column with index idx appears at position idx in the control.
167
223
  # @return [void]
168
224
  def reset_columns_order; end
169
225
 
170
226
  # Show the popup menu allowing the user to show or hide the columns.
227
+ #
171
228
  # This functions shows the popup menu containing all columns with check marks for the ones which are currently shown and allows the user to check or uncheck them to toggle their visibility. It is called from the default EVT_HEADER_RIGHT_CLICK handler for the controls which have {Wx::HD_ALLOW_HIDE} style. And if the column has {Wx::HD_ALLOW_REORDER} style as well, the menu also contains an item to customize the columns shown using which results in {Wx::HeaderCtrl#show_customize_dialog} being called, please see its description for more details.
172
229
  # If a column was toggled, {Wx::HeaderCtrl#update_column_visibility} virtual function is called so it must be implemented for the controls with {Wx::HD_ALLOW_HIDE} style or if you call this function explicitly.
173
230
  #
@@ -178,6 +235,7 @@ module Wx
178
235
  def show_columns_menu(pt, title=(())) end
179
236
 
180
237
  # Helper function appending the checkable items corresponding to all the columns to the given menu.
238
+ #
181
239
  # This function is used by {Wx::HeaderCtrl#show_columns_menu} but can also be used if you show your own custom columns menu and still want all the columns shown in it. It appends menu items with column labels as their text and consecutive ids starting from idColumnsBase to the menu and checks the items corresponding to the currently visible columns.
182
240
  # Example of use:
183
241
  # ```
@@ -195,6 +253,7 @@ module Wx
195
253
  def add_columns_items(menu, idColumnsBase=0) end
196
254
 
197
255
  # Show the column customization dialog.
256
+ #
198
257
  # This function displays a modal dialog containing the list of all columns which the user can use to reorder them as well as show or hide individual columns.
199
258
  # If the user accepts the changes done in the dialog, the virtual methods {Wx::HeaderCtrl#update_column_visibility} and {Wx::HeaderCtrl#update_columns_order} will be called so they must be overridden in the derived class if this method is ever called. Please notice that the user will be able to invoke it interactively from the header popup menu if the control has both {Wx::HD_ALLOW_HIDE} and {Wx::HD_ALLOW_REORDER} styles.
200
259
  # @see Wx::RearrangeDialog
@@ -207,6 +266,7 @@ module Wx
207
266
  # @return [Integer]
208
267
  # @overload get_column_title_width(idx)
209
268
  # Returns width needed for the column with the given index.
269
+ #
210
270
  # This is just a convenient wrapper for the overload taking {Wx::HeaderColumn}.
211
271
  # @param idx [Integer]
212
272
  # @return [Integer]
@@ -214,6 +274,7 @@ module Wx
214
274
  alias_method :column_title_width, :get_column_title_width
215
275
 
216
276
  # Helper function to manipulate the array of column indices.
277
+ #
217
278
  # This function reshuffles the array of column indices indexed by positions (i.e. using the same convention as for {Wx::HeaderCtrl#set_columns_order}) so that the column with the given index is found at the specified position.
218
279
  # @param order [Array<Integer>] Array containing the indices of columns in order of their positions.
219
280
  # @param idx [Integer] The index of the column to move.
@@ -231,6 +292,7 @@ module Wx
231
292
  alias_method :column, :get_column
232
293
 
233
294
  # Method called when the column visibility is changed by the user.
295
+ #
234
296
  # This method is called from {Wx::HeaderCtrl#show_columns_menu} or {Wx::HeaderCtrl#show_customize_dialog} when the user interactively hides or shows a column. A typical implementation will simply update the internally stored column state. Notice that there is no need to call {Wx::HeaderCtrl#update_column} from this method as it is already done by {Wx::HeaderCtrl} itself.
235
297
  # The base class version doesn't do anything and must be overridden if this method is called.
236
298
  # @param idx [Integer] The index of the column whose visibility was toggled.
@@ -239,6 +301,7 @@ module Wx
239
301
  def update_column_visibility(idx, show) end
240
302
 
241
303
  # Method called when the columns order is changed in the customization dialog.
304
+ #
242
305
  # This method is only called from {Wx::HeaderCtrl#show_customize_dialog} when the user changes the order of columns. In particular it is not called if a single column changes place because the user dragged it to the new location, the EVT_HEADER_END_REORDER event handler should be used to react to this.
243
306
  # A typical implementation in a derived class will update the display order of the columns in the associated control, if any. Notice that there is no need to call {Wx::HeaderCtrl#set_columns_order} from it as {Wx::HeaderCtrl} does it itself.
244
307
  # The base class version doesn't do anything and must be overridden if this method is called.
@@ -247,6 +310,7 @@ module Wx
247
310
  def update_columns_order(order) end
248
311
 
249
312
  # Method which may be implemented by the derived classes to allow double clicking the column separator to resize the column to fit its contents.
313
+ #
250
314
  # When a separator is double clicked, the default handler of EVT_HEADER_SEPARATOR_DCLICK event calls this function and refreshes the column if it returns true so to implement the resizing of the column to fit its width on header double click you need to implement this method using logic similar to this example:
251
315
  # ```
252
316
  # class MyHeaderColumn : public wxHeaderColumn
@@ -290,6 +354,7 @@ module Wx
290
354
  def update_column_width_to_fit(idx, widthTitle) end
291
355
 
292
356
  # Can be overridden in the derived class to update internal data structures when the number of the columns in the control changes.
357
+ #
293
358
  # This method is called by {Wx::HeaderCtrl#set_column_count} before effectively changing the number of columns.
294
359
  # The base class version does nothing but it is good practice to still call it from the overridden version in the derived class.
295
360
  # @param count [Integer]
@@ -299,6 +364,7 @@ module Wx
299
364
  end # HeaderCtrl
300
365
 
301
366
  # Represents a column header in controls displaying tabular data such as {Wx::DataViewCtrl} or {Wx::GRID::Grid}.
367
+ #
302
368
  # Notice that this is an abstract base class which is implemented (usually using the information stored in the associated control) by the different controls using {Wx::HeaderCtrl}. As the control only needs to retrieve the information about the column, this class defines only the methods for accessing the various column properties but not for changing them as the setters might not be needed at all, e.g. if the column attributes can only be changed via the methods of the main associated control (this is the case for {Wx::GRID::Grid} for example). If you do want to allow changing them directly using the column itself, you should inherit from {Wx::SettableHeaderColumn} instead of this class.
303
369
  # Finally, if you don't already store the column information at all anywhere, you should use the concrete {Wx::HeaderColumnSimple} class and {Wx::HeaderCtrlSimple}.
304
370
  #
@@ -319,6 +385,7 @@ module Wx
319
385
  alias_method :bitmap, :get_bitmap
320
386
 
321
387
  # Returns the bitmap in the header of the column, if any.
388
+ #
322
389
  # If the column has no associated bitmap, empty {Wx::BitmapBundle} should be returned.
323
390
  # Override this function to return the bundle containing the bitmap to show in the column header. By default delegates to {Wx::HeaderColumn#get_bitmap} but should be overridden if the bitmaps are used.
324
391
  # @return [Wx::BitmapBundle]
@@ -326,24 +393,28 @@ module Wx
326
393
  alias_method :bitmap_bundle, :get_bitmap_bundle
327
394
 
328
395
  # Returns the current width of the column.
396
+ #
329
397
  # Width of the column in pixels, never {Wx::COL_WIDTH_DEFAULT} or {Wx::COL_WIDTH_AUTOSIZE}.
330
398
  # @return [Integer]
331
399
  def get_width; end
332
400
  alias_method :width, :get_width
333
401
 
334
402
  # Return the minimal column width.
403
+ #
335
404
  # The minimal width such that the user can't resize the column to lesser size (notice that it is still possible to set the column width to smaller value from the program code). Return 0 from here to allow resizing the column to arbitrarily small size.
336
405
  # @return [Integer]
337
406
  def get_min_width; end
338
407
  alias_method :min_width, :get_min_width
339
408
 
340
409
  # Returns the current column alignment.
410
+ #
341
411
  # One of {Wx::Alignment::ALIGN_CENTRE}, {Wx::Alignment::ALIGN_LEFT} or {Wx::Alignment::ALIGN_RIGHT}.
342
412
  # @return [Wx::Alignment]
343
413
  def get_alignment; end
344
414
  alias_method :alignment, :get_alignment
345
415
 
346
416
  # Get the column flags.
417
+ #
347
418
  # This method retrieves all the flags at once, you can also use {Wx::HeaderColumn#has_flag} to test for any individual flag or {Wx::HeaderColumn#is_resizeable}, {Wx::HeaderColumn#is_sortable}, {Wx::HeaderColumn#is_reorderable} and {Wx::HeaderColumn#is_hidden} to test for particular flags.
348
419
  # @return [Integer]
349
420
  def get_flags; end
@@ -356,30 +427,35 @@ module Wx
356
427
  alias_method :has_flag?, :has_flag
357
428
 
358
429
  # Return true if the column can be resized by the user.
430
+ #
359
431
  # Equivalent to HasFlag({Wx::COL_RESIZABLE}).
360
432
  # @return [Boolean]
361
433
  def is_resizeable; end
362
434
  alias_method :resizeable?, :is_resizeable
363
435
 
364
436
  # Returns true if the column can be clicked by user to sort the control contents by the field in this column.
437
+ #
365
438
  # This corresponds to {Wx::COL_SORTABLE} flag which is off by default.
366
439
  # @return [Boolean]
367
440
  def is_sortable; end
368
441
  alias_method :sortable?, :is_sortable
369
442
 
370
443
  # Returns true if the column can be dragged by user to change its order.
444
+ #
371
445
  # This corresponds to {Wx::COL_REORDERABLE} flag which is on by default.
372
446
  # @return [Boolean]
373
447
  def is_reorderable; end
374
448
  alias_method :reorderable?, :is_reorderable
375
449
 
376
450
  # Returns true if the column is currently hidden.
451
+ #
377
452
  # This corresponds to {Wx::COL_HIDDEN} flag which is off by default.
378
453
  # @return [Boolean]
379
454
  def is_hidden; end
380
455
  alias_method :hidden?, :is_hidden
381
456
 
382
457
  # Returns true if the column is currently shown.
458
+ #
383
459
  # This corresponds to the absence of {Wx::COL_HIDDEN} flag.
384
460
  # @return [Boolean]
385
461
  def is_shown; end
@@ -391,6 +467,7 @@ module Wx
391
467
  alias_method :sort_key?, :is_sort_key
392
468
 
393
469
  # Returns true, if the sort order is ascending.
470
+ #
394
471
  # Notice that it only makes sense to call this function if the column is used for sorting at all, i.e. if {Wx::HeaderColumn#is_sort_key} returns true.
395
472
  # @return [Boolean]
396
473
  def is_sort_order_ascending; end
@@ -399,6 +476,7 @@ module Wx
399
476
  end # HeaderColumn
400
477
 
401
478
  # {Wx::HeaderCtrlSimple} is a concrete header control which can be used directly, without inheriting from it as you need to do when using {Wx::HeaderCtrl} itself.
479
+ #
402
480
  # When using it, you need to use simple {Wx::HeaderCtrlSimple#append_column}, {Wx::HeaderCtrlSimple#insert_column} and {Wx::HeaderCtrlSimple#delete_column} methods instead of setting the number of columns with {Wx::HeaderCtrlSimple#set_column_count} and returning the information about them from the overridden {Wx::HeaderCtrlSimple#get_column}.
403
481
  #
404
482
  # Category: {Wx::Controls}
@@ -409,10 +487,12 @@ module Wx
409
487
 
410
488
  # @overload initialize()
411
489
  # Default constructor not creating the underlying window.
490
+ #
412
491
  # You must use {Wx::HeaderCtrlSimple#create} after creating the object using this constructor.
413
492
  # @return [Wx::HeaderCtrlSimple]
414
493
  # @overload initialize(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HD_DEFAULT_STYLE, name=Wx::HEADER_CTRL_NAME_STR)
415
494
  # Constructor creating the window.
495
+ #
416
496
  # Please see the base class {Wx::HeaderCtrl#create} method for the parameters description.
417
497
  # @param parent [Wx::Window]
418
498
  # @param winid [Integer]
@@ -425,6 +505,7 @@ module Wx
425
505
 
426
506
  # Insert the column at the given position.
427
507
  #
508
+ #
428
509
  # @see Wx::HeaderCtrlSimple#append_column
429
510
  # @param col [Wx::HeaderColumnSimple] The column to insert. Notice that because of the existence of implicit conversion from {Wx::String} to {Wx::HeaderColumn} a string can be passed directly here.
430
511
  # @param idx [Integer] The position of the new column, from 0 to {Wx::HeaderCtrlSimple#get_column_count}. Using {Wx::HeaderCtrlSimple#get_column_count} means to append the column to the end.
@@ -433,6 +514,7 @@ module Wx
433
514
 
434
515
  # Append the column to the end of the control.
435
516
  #
517
+ #
436
518
  # @see Wx::HeaderCtrlSimple#insert_column
437
519
  # @param col [Wx::HeaderColumnSimple]
438
520
  # @return [void]
@@ -440,6 +522,7 @@ module Wx
440
522
 
441
523
  # Delete the column at the given position.
442
524
  #
525
+ #
443
526
  # @see Wx::HeaderCtrlSimple#insert_column
444
527
  # @see Wx::HeaderCtrlSimple#append_column
445
528
  # @param idx [Integer]
@@ -447,6 +530,7 @@ module Wx
447
530
  def delete_column(idx) end
448
531
 
449
532
  # Show or hide the column.
533
+ #
450
534
  # Initially the column is shown by default or hidden if it was added with {Wx::COL_HIDDEN} flag set.
451
535
  # When a column is hidden, it doesn't appear at all on the screen but its index is still taken into account when working with other columns. E.g. if there are three columns 0, 1 and 2 and the column 1 is hidden you still need to use index 2 to refer to the last visible column.
452
536
  # @param idx [Integer] The index of the column to show or hide, from 0 to {Wx::HeaderCtrlSimple#get_column_count}.
@@ -455,6 +539,7 @@ module Wx
455
539
  def show_column(idx, show=true) end
456
540
 
457
541
  # Hide the column with the given index.
542
+ #
458
543
  # This is the same as calling
459
544
  # ```
460
545
  # ShowColumn(idx, false)
@@ -465,6 +550,7 @@ module Wx
465
550
  def hide_column(idx) end
466
551
 
467
552
  # Update the column sort indicator.
553
+ #
468
554
  # The sort indicator, if shown, is typically an arrow pointing upwards or downwards depending on whether the control contents is sorted in ascending or descending order.
469
555
  # @param idx [Integer] The column to set the sort indicator for. If <code>-1</code> is given, then the currently shown sort indicator will be removed.
470
556
  # @param sortOrder [Boolean] If true or false show the sort indicator corresponding to ascending or descending sort order respectively.
@@ -473,6 +559,7 @@ module Wx
473
559
 
474
560
  # Remove the sort indicator from the column being used as sort key.
475
561
  #
562
+ #
476
563
  # @see Wx::HeaderCtrlSimple#show_sort_indicator
477
564
  # @return [void]
478
565
  def remove_sort_indicator; end
@@ -481,6 +568,7 @@ module Wx
481
568
  protected
482
569
 
483
570
  # This function can be overridden in the classes deriving from this control instead of overriding {Wx::HeaderCtrlSimple#update_column_width_to_fit}.
571
+ #
484
572
  # To implement automatic column resizing to fit its contents width when the column divider is double clicked, you need to simply return the fitting width for the given column idx from this method, the control will automatically use the biggest value between the one returned from here and the one needed for the display of the column title itself.
485
573
  # The base class version returns -1 indicating that this function is not implemented.
486
574
  # @param idx [Integer]
@@ -491,6 +579,7 @@ module Wx
491
579
  end # HeaderCtrlSimple
492
580
 
493
581
  # Adds methods to set the column attributes to {Wx::HeaderColumn}.
582
+ #
494
583
  # This class adds setters for the column attributes defined by {Wx::HeaderColumn}. It is still an abstract base class and needs to be implemented before using it with {Wx::HeaderCtrl}.
495
584
  #
496
585
  # Category: {Wx::Controls}
@@ -506,6 +595,7 @@ module Wx
506
595
  alias_method :title=, :set_title
507
596
 
508
597
  # Set the bitmap to be displayed in the column header.
598
+ #
509
599
  # Notice that the bitmaps displayed in different columns of the same control must all be of the same size.
510
600
  # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
511
601
  # @return [void]
@@ -519,6 +609,7 @@ module Wx
519
609
  alias_method :width=, :set_width
520
610
 
521
611
  # Set the minimal column width.
612
+ #
522
613
  # This method can be used with resizable columns (i.e. those for which {Wx::COL_RESIZABLE} flag is set in {Wx::SettableHeaderColumn#get_flags} or, alternatively, {Wx::SettableHeaderColumn#is_resizeable} returns true) to prevent the user from making them narrower than the given width.
523
614
  # @param minWidth [Integer] The minimal column width in pixels, may be 0 to remove any previously set restrictions.
524
615
  # @return [void]
@@ -532,6 +623,7 @@ module Wx
532
623
  alias_method :alignment=, :set_alignment
533
624
 
534
625
  # Set the column flags.
626
+ #
535
627
  # This method allows setting all flags at once, see also generic {Wx::SettableHeaderColumn#change_flag}, {Wx::SettableHeaderColumn#set_flag}, {Wx::SettableHeaderColumn#clear_flag} and {Wx::SettableHeaderColumn#toggle_flag} methods below as well as specific {Wx::SettableHeaderColumn#set_resizeable}, {Wx::SettableHeaderColumn#set_sortable}, {Wx::SettableHeaderColumn#set_reorderable} and {Wx::SettableHeaderColumn#set_hidden} ones.
536
628
  # @param flags [Integer] Combination of {Wx::COL_RESIZABLE}, {Wx::COL_SORTABLE}, {Wx::COL_REORDERABLE} and {Wx::COL_HIDDEN} bit flags.
537
629
  # @return [void]
@@ -540,6 +632,7 @@ module Wx
540
632
 
541
633
  # Set or clear the given flag.
542
634
  #
635
+ #
543
636
  # @see Wx::SettableHeaderColumn#set_flags
544
637
  # @param flag [Integer] The flag to set or clear.
545
638
  # @param set [Boolean] If true, set the flag, i.e. equivalent to calling {Wx::SettableHeaderColumn#set_flag}, otherwise clear it, as {Wx::SettableHeaderColumn#clear_flag}.
@@ -548,6 +641,7 @@ module Wx
548
641
 
549
642
  # Set the specified flag for the column.
550
643
  #
644
+ #
551
645
  # @see Wx::SettableHeaderColumn#set_flags
552
646
  # @param flag [Integer]
553
647
  # @return [void]
@@ -556,12 +650,14 @@ module Wx
556
650
 
557
651
  # Clear the specified flag for the column.
558
652
  #
653
+ #
559
654
  # @see Wx::SettableHeaderColumn#set_flags
560
655
  # @param flag [Integer]
561
656
  # @return [void]
562
657
  def clear_flag(flag) end
563
658
 
564
659
  # Toggle the specified flag for the column.
660
+ #
565
661
  # If the flag is currently set, equivalent to {Wx::SettableHeaderColumn#clear_flag}, otherwise to {Wx::SettableHeaderColumn#set_flag}.
566
662
  # @see Wx::SettableHeaderColumn#set_flags
567
663
  # @param flag [Integer]
@@ -569,6 +665,7 @@ module Wx
569
665
  def toggle_flag(flag) end
570
666
 
571
667
  # Call this to enable or disable interactive resizing of the column by the user.
668
+ #
572
669
  # By default, the columns are resizable.
573
670
  # Equivalent to ChangeFlag({Wx::COL_RESIZABLE}, resizable).
574
671
  # @param resizable [Boolean]
@@ -577,6 +674,7 @@ module Wx
577
674
  alias_method :resizeable=, :set_resizeable
578
675
 
579
676
  # Allow clicking the column to sort the control contents by the field in this column.
677
+ #
580
678
  # By default, the columns are not sortable so you need to explicitly call this function to allow sorting by the field corresponding to this column.
581
679
  # Equivalent to ChangeFlag({Wx::COL_SORTABLE}, sortable).
582
680
  # @param sortable [Boolean]
@@ -585,6 +683,7 @@ module Wx
585
683
  alias_method :sortable=, :set_sortable
586
684
 
587
685
  # Allow changing the column order by dragging it.
686
+ #
588
687
  # Equivalent to ChangeFlag({Wx::COL_REORDERABLE}, reorderable).
589
688
  # @param reorderable [Boolean]
590
689
  # @return [void]
@@ -592,6 +691,7 @@ module Wx
592
691
  alias_method :reorderable=, :set_reorderable
593
692
 
594
693
  # Hide or show the column.
694
+ #
595
695
  # By default all columns are shown but some of them can be completely hidden from view by calling this function.
596
696
  # Equivalent to ChangeFlag({Wx::COL_HIDDEN}, hidden).
597
697
  # @param hidden [Boolean]
@@ -600,11 +700,13 @@ module Wx
600
700
  alias_method :hidden=, :set_hidden
601
701
 
602
702
  # Don't use this column for sorting.
703
+ #
603
704
  # This is the reverse of {Wx::SettableHeaderColumn#set_sort_order} and is called to indicate that this column is not used for sorting any longer.
604
705
  # @return [void]
605
706
  def unset_as_sort_key; end
606
707
 
607
708
  # Sets this column as the sort key for the associated control.
709
+ #
608
710
  # This function indicates that this column is currently used for sorting the control and also sets the sorting direction. Notice that actual sorting is only done in the control associated with the header, this function doesn't do any sorting on its own.
609
711
  # Don't confuse this function with {Wx::SettableHeaderColumn#set_sortable} which should be used to indicate that the column may be used for sorting while this one is used to indicate that it currently is used for sorting. Of course, {Wx::SettableHeaderColumn#set_sort_order} can be only called for sortable columns.
610
712
  # @param ascending [Boolean] If true, sort in ascending order, otherwise in descending order.
@@ -613,6 +715,7 @@ module Wx
613
715
  alias_method :sort_order=, :set_sort_order
614
716
 
615
717
  # Inverses the sort order.
718
+ #
616
719
  # This function is typically called when the user clicks on a column used for sorting to change sort order from ascending to descending or vice versa.
617
720
  # @see Wx::SettableHeaderColumn#set_sort_order
618
721
  # @see Wx::SettableHeaderColumn#is_sort_order_ascending
@@ -622,6 +725,7 @@ module Wx
622
725
  end # SettableHeaderColumn
623
726
 
624
727
  # Simple container for the information about the column.
728
+ #
625
729
  # This is a concrete class implementing all {Wx::SettableHeaderColumn} class methods in a trivial way, i.e. by just storing the information in the object itself. It is used by and with {Wx::HeaderCtrlSimple}, e.g.
626
730
  # ```
627
731
  # wxHeaderCtrlSimple * header = new wxHeaderCtrlSimple(...);
@@ -639,6 +743,7 @@ module Wx
639
743
 
640
744
  # @overload initialize(title, width=Wx::COL_WIDTH_DEFAULT, align=Wx::Alignment::ALIGN_NOT, flags=Wx::COL_DEFAULT_FLAGS)
641
745
  # Constructor for a column header.
746
+ #
642
747
  # The first constructor creates a header showing the given text title while the second one creates one showing the specified bitmap image.
643
748
  # @param title [String]
644
749
  # @param width [Integer]
@@ -647,6 +752,7 @@ module Wx
647
752
  # @return [Wx::HeaderColumnSimple]
648
753
  # @overload initialize(bitmap, width=Wx::COL_WIDTH_DEFAULT, align=Wx::Alignment::ALIGN_CENTER, flags=Wx::COL_DEFAULT_FLAGS)
649
754
  # Constructor for a column header.
755
+ #
650
756
  # The first constructor creates a header showing the given text title while the second one creates one showing the specified bitmap image.
651
757
  # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
652
758
  # @param width [Integer]
@@ -75,6 +75,7 @@ module Wx
75
75
  EVT_HEADER_DRAGGING_CANCELLED = 10169
76
76
 
77
77
  # Event class representing the events generated by {Wx::HeaderCtrl}.
78
+ #
78
79
  # Category: {Wx::Events}
79
80
  # @see Wx::HeaderCtrl
80
81
  #
@@ -82,7 +83,7 @@ module Wx
82
83
  class HeaderCtrlEvent < NotifyEvent
83
84
 
84
85
  # @overload initialize(commandType=Wx::EVT_NULL, winid=0)
85
- # @param commandType [Wx::Slider::EventType]
86
+ # @param commandType [Wx::StaticLine::EventType]
86
87
  # @param winid [Integer]
87
88
  # @return [Wx::HeaderCtrlEvent]
88
89
  # @overload initialize(event)
@@ -91,6 +92,7 @@ module Wx
91
92
  def initialize(*args) end
92
93
 
93
94
  # Return the index of the column affected by this event.
95
+ #
94
96
  # This method can be called for all header control events.
95
97
  # @return [Integer]
96
98
  def get_column; end
@@ -102,6 +104,7 @@ module Wx
102
104
  alias_method :column=, :set_column
103
105
 
104
106
  # Return the current width of the column.
107
+ #
105
108
  # This method can only be called for the dragging events.
106
109
  # @return [Integer]
107
110
  def get_width; end
@@ -113,6 +116,7 @@ module Wx
113
116
  alias_method :width=, :set_width
114
117
 
115
118
  # Return the new order of the column.
119
+ #
116
120
  # This method can only be called for a reorder event for which it indicates the tentative new position for the column {Wx::HeaderCtrlEvent#get_column} selected by the user. If the event is not vetoed, this will become the new column position in {Wx::HeaderCtrl#get_columns_order}.
117
121
  # @return [Integer]
118
122
  def get_new_order; end