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
@@ -13,6 +13,7 @@ module Wx::GRID
13
13
  #
14
14
  #
15
15
  #
16
+ # @wxrb_require USE_GRID
16
17
  class GridCellFloatFormat < Wx::Enum
17
18
 
18
19
  # Decimal floating point (f).
@@ -41,6 +42,7 @@ module Wx::GRID
41
42
  #
42
43
  #
43
44
  #
45
+ # @wxrb_require USE_GRID
44
46
  class GridTableRequest < Wx::Enum
45
47
 
46
48
  # New rows have been inserted into the table.
@@ -73,6 +75,7 @@ module Wx::GRID
73
75
  #
74
76
  #
75
77
  #
78
+ # @wxrb_require USE_GRID
76
79
  class GridRenderStyle < Wx::Enum
77
80
 
78
81
  # Draw grid row header labels.
@@ -202,6 +205,7 @@ module Wx::GRID
202
205
  EVT_GRID_TABBING = 10075
203
206
 
204
207
  # {Wx::GRID::Grid} and its related classes are used for displaying and editing tabular data.
208
+ #
205
209
  # They provide a rich set of features for display, editing, and interacting with a variety of data sources. For simple applications, and to help you get started, {Wx::GRID::Grid} is the only class you need to refer to directly. It will set up default instances of the other classes and manage them for you. For more complex applications you can derive your own classes for custom grid views, grid data tables, cell editors and renderers. The wxGrid Overview has examples of simple and more complex applications, explains the relationship between the various grid classes and has a summary of the keyboard shortcuts and mouse functions provided by {Wx::GRID::Grid}.
206
210
  # A {Wx::GRID::GridTableBase} class holds the actual data to be displayed by a {Wx::GRID::Grid} class. One or more {Wx::GRID::Grid} classes may act as a view for one table class. The default table class is called {Wx::GRID::GridStringTable} and holds an array of strings. An instance of such a class is created by {Wx::GRID::Grid#create_grid}.
207
211
  # {Wx::GRID::GridCellRenderer} is the abstract base class for rendering contents in a cell. The following renderers are predefined:
@@ -224,19 +228,20 @@ module Wx::GRID
224
228
  # - {Wx::GRID::GridCellDateEditor}
225
229
  #
226
230
  # Please see {Wx::GRID::GridEvent}, {Wx::GRID::GridSizeEvent}, {Wx::GRID::GridRangeSelectEvent}, and {Wx::GRID::GridEditorCreatedEvent} for the documentation of all event types you can use with {Wx::GRID::Grid}.
227
- # ===
228
231
  #
229
232
  # Category: Grid Related Classes
230
233
  # @see wxGrid Overview
231
234
  # @see Wx::GridUpdateLocker
232
235
  #
233
236
  #
237
+ # @wxrb_require USE_GRID
234
238
  class Grid < ScrolledCanvas
235
239
 
236
240
  # Different selection modes supported by the grid.
237
241
  #
238
242
  #
239
243
  #
244
+ # @wxrb_require USE_GRID
240
245
  class GridSelectionModes < Wx::Enum
241
246
 
242
247
  # The default selection mode allowing selection of the individual cells as well as of the entire rows and columns.
@@ -265,6 +270,7 @@ module Wx::GRID
265
270
  #
266
271
  #
267
272
  #
273
+ # @wxrb_require USE_GRID
268
274
  class CellSpan < Wx::Enum
269
275
 
270
276
  # This cell is inside a span covered by another cell.
@@ -288,6 +294,7 @@ module Wx::GRID
288
294
  # @see Wx::GRID::EVT_GRID_TABBING
289
295
  #
290
296
  #
297
+ # @wxrb_require USE_GRID
291
298
  class TabBehaviour < Wx::Enum
292
299
 
293
300
  # Do nothing, this is default.
@@ -306,10 +313,12 @@ module Wx::GRID
306
313
 
307
314
  # @overload initialize()
308
315
  # Default constructor.
316
+ #
309
317
  # You must call {Wx::GRID::Grid#create} to really create the grid window and also call {Wx::GRID::Grid#create_grid} or {Wx::GRID::Grid#set_table} or {Wx::GRID::Grid#assign_table} to initialize its contents.
310
318
  # @return [Wx::GRID::Grid]
311
319
  # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::WANTS_CHARS, name=Wx::GRID_NAME_STR)
312
320
  # Constructor creating the grid window.
321
+ #
313
322
  # You must call either {Wx::GRID::Grid#create_grid} or {Wx::GRID::Grid#set_table} or {Wx::GRID::Grid#assign_table} to initialize the grid contents before using it.
314
323
  # @param parent [Wx::Window]
315
324
  # @param id [Integer]
@@ -321,6 +330,7 @@ module Wx::GRID
321
330
  def initialize(*args) end
322
331
 
323
332
  # Creates the grid window for an object initialized using the default constructor.
333
+ #
324
334
  # You must call either {Wx::GRID::Grid#create_grid} or {Wx::GRID::Grid#set_table} or {Wx::GRID::Grid#assign_table} to initialize the grid contents before using it.
325
335
  # @param parent [Wx::Window]
326
336
  # @param id [Integer]
@@ -332,19 +342,21 @@ module Wx::GRID
332
342
  def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::WANTS_CHARS, name=Wx::GRID_NAME_STR) end
333
343
 
334
344
  # Creates a grid with the specified initial number of rows and columns.
345
+ #
335
346
  # Call this directly after the grid constructor. When you use this function {Wx::GRID::Grid} will create and manage a simple table of string values for you. All of the grid data will be stored in memory.
336
347
  # For applications with more complex data types or relationships, or for dealing with very large datasets, you should derive your own grid table class and pass a table object to the grid with {Wx::GRID::Grid#set_table} or {Wx::GRID::Grid#assign_table}.
337
348
  # @param numRows [Integer]
338
349
  # @param numCols [Integer]
339
- # @param selmode [Wx::wxGrid::GridSelectionModes]
350
+ # @param selmode [Wx::Grid::GridSelectionModes]
340
351
  # @return [Boolean]
341
352
  def create_grid(numRows, numCols, selmode=Wx::GRID::Grid::GridSelectionModes::GridSelectCells) end
342
353
 
343
354
  # Assigns a pointer to a custom grid table to be used by the grid.
355
+ #
344
356
  # This function is identical to {Wx::GRID::Grid#set_table} with takeOwnership parameter set to true, i.e. it simply always takes the ownership of the passed in pointer. This makes it simpler to use than {Wx::GRID::Grid#set_table} in the common case when the table should be owned by the grid object.
345
357
  # Note that this function should be called at most once and can't be used to change the table used by the grid later on or reset it: if such extra flexibility is needed, use {Wx::GRID::Grid#set_table} directly.
346
358
  # @param table [Wx::GRID::GridTableBase] The heap-allocated pointer to the table.
347
- # @param selmode [Wx::wxGrid::GridSelectionModes] Selection mode to use.
359
+ # @param selmode [Wx::Grid::GridSelectionModes] Selection mode to use.
348
360
  # @return [void]
349
361
  def assign_table(table, selmode=Wx::GRID::Grid::GridSelectionModes::GridSelectCells) end
350
362
 
@@ -359,6 +371,7 @@ module Wx::GRID
359
371
  def enable_grid_lines(enable=true) end
360
372
 
361
373
  # Returns the pen used for vertical grid lines.
374
+ #
362
375
  # This virtual function may be overridden in derived classes in order to change the appearance of individual grid lines for the given column col.
363
376
  # See {Wx::GRID::Grid#get_row_grid_line_pen} for an example.
364
377
  # @param col [Integer]
@@ -367,6 +380,7 @@ module Wx::GRID
367
380
  alias_method :col_grid_line_pen, :get_col_grid_line_pen
368
381
 
369
382
  # Returns the pen used for grid lines.
383
+ #
370
384
  # This virtual function may be overridden in derived classes in order to change the appearance of grid lines. Note that currently the pen width must be 1.
371
385
  # @see Wx::GRID::Grid#get_col_grid_line_pen
372
386
  # @see Wx::GRID::Grid#get_row_grid_line_pen
@@ -376,12 +390,14 @@ module Wx::GRID
376
390
 
377
391
  # Returns the colour used for grid lines.
378
392
  #
393
+ #
379
394
  # @see Wx::GRID::Grid#get_default_grid_line_pen
380
395
  # @return [Wx::Colour]
381
396
  def get_grid_line_colour; end
382
397
  alias_method :grid_line_colour, :get_grid_line_colour
383
398
 
384
399
  # Returns the pen used for horizontal grid lines.
400
+ #
385
401
  # This virtual function may be overridden in derived classes in order to change the appearance of individual grid line for the given row.
386
402
  # Example:
387
403
  # ```ruby
@@ -417,6 +433,7 @@ module Wx::GRID
417
433
  alias_method :grid_line_colour=, :set_grid_line_colour
418
434
 
419
435
  # Sets the arguments to the current column label alignment values.
436
+ #
420
437
  # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
421
438
  # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
422
439
  # @return [Array(Integer,Integer)]
@@ -429,6 +446,7 @@ module Wx::GRID
429
446
  alias_method :col_label_text_orientation, :get_col_label_text_orientation
430
447
 
431
448
  # Returns the specified column label.
449
+ #
432
450
  # The default grid table class provides column labels of the form A,B...Z,AA,AB...ZZ,AAA... If you are using a custom grid table you can override {Wx::GRID::GridTableBase#get_col_label_value} to provide your own labels.
433
451
  # @param col [Integer]
434
452
  # @return [String]
@@ -436,6 +454,7 @@ module Wx::GRID
436
454
  alias_method :col_label_value, :get_col_label_value
437
455
 
438
456
  # Sets the arguments to the current corner label alignment values.
457
+ #
439
458
  # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
440
459
  # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
441
460
  # @return [Array(Integer,Integer)]
@@ -468,6 +487,7 @@ module Wx::GRID
468
487
  alias_method :label_text_colour, :get_label_text_colour
469
488
 
470
489
  # Returns the alignment used for row labels.
490
+ #
471
491
  # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
472
492
  # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
473
493
  # @return [Array(Integer,Integer)]
@@ -475,6 +495,7 @@ module Wx::GRID
475
495
  alias_method :row_label_alignment, :get_row_label_alignment
476
496
 
477
497
  # Returns the specified row label.
498
+ #
478
499
  # The default grid table class provides numeric row labels. If you are using a custom grid table you can override {Wx::GRID::GridTableBase#get_row_label_value} to provide your own labels.
479
500
  # @param row [Integer]
480
501
  # @return [String]
@@ -482,6 +503,7 @@ module Wx::GRID
482
503
  alias_method :row_label_value, :get_row_label_value
483
504
 
484
505
  # Hides the column labels by calling {Wx::GRID::Grid#set_col_label_size} with a size of 0.
506
+ #
485
507
  # The labels can be shown again by calling {Wx::GRID::Grid#set_col_label_size} with a height greater than 0.
486
508
  # Note that when the column labels are hidden, the grid won't have any visible border on the top side, which may result in a less than ideal appearance. Because of this, you may want to create the grid window with a border style, such as {Wx::Border::BORDER_SIMPLE}, when you don't plan to show the column labels for it.
487
509
  # @see Wx::GRID::Grid#hide_row_labels
@@ -489,12 +511,14 @@ module Wx::GRID
489
511
  def hide_col_labels; end
490
512
 
491
513
  # Hides the row labels by calling {Wx::GRID::Grid#set_row_label_size} with a size of 0.
514
+ #
492
515
  # The labels can be shown again by calling {Wx::GRID::Grid#set_row_label_size} with a width greater than 0.
493
516
  # See {Wx::GRID::Grid#hide_col_labels} for a note explaining why you may want to use a border with a grid without the row labels.
494
517
  # @return [void]
495
518
  def hide_row_labels; end
496
519
 
497
520
  # Sets the horizontal and vertical alignment of column label text.
521
+ #
498
522
  # Horizontal alignment should be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}. Vertical alignment should be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
499
523
  # @param horiz [Integer]
500
524
  # @param vert [Integer]
@@ -508,6 +532,7 @@ module Wx::GRID
508
532
  alias_method :col_label_text_orientation=, :set_col_label_text_orientation
509
533
 
510
534
  # Set the value for the given column label.
535
+ #
511
536
  # If you are using a custom grid table you must override {Wx::GRID::GridTableBase#set_col_label_value} for this to have any effect.
512
537
  # @param col [Integer]
513
538
  # @param value [String]
@@ -515,6 +540,7 @@ module Wx::GRID
515
540
  def set_col_label_value(col, value) end
516
541
 
517
542
  # Sets the horizontal and vertical alignment of the (top-left) corner label text.
543
+ #
518
544
  # Horizontal alignment should be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}. Vertical alignment should be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
519
545
  # @param horiz [Integer]
520
546
  # @param vert [Integer]
@@ -528,6 +554,7 @@ module Wx::GRID
528
554
  alias_method :corner_label_text_orientation=, :set_corner_label_text_orientation
529
555
 
530
556
  # Set the value for the (top-left) corner label.
557
+ #
531
558
  # If you are using a custom grid table you must override {Wx::GRID::GridTableBase#set_corner_label_value} for this to have any effect.
532
559
  # @param arg [String]
533
560
  # @return [void]
@@ -553,6 +580,7 @@ module Wx::GRID
553
580
  alias_method :label_text_colour=, :set_label_text_colour
554
581
 
555
582
  # Sets the horizontal and vertical alignment of row label text.
583
+ #
556
584
  # Horizontal alignment should be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}. Vertical alignment should be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
557
585
  # @param horiz [Integer]
558
586
  # @param vert [Integer]
@@ -560,6 +588,7 @@ module Wx::GRID
560
588
  def set_row_label_alignment(horiz, vert) end
561
589
 
562
590
  # Sets the value for the given row label.
591
+ #
563
592
  # If you are using a derived grid table you must override {Wx::GRID::GridTableBase#set_row_label_value} for this to have any effect.
564
593
  # @param row [Integer]
565
594
  # @param value [String]
@@ -567,6 +596,7 @@ module Wx::GRID
567
596
  def set_row_label_value(row, value) end
568
597
 
569
598
  # Call this in order to make the column labels use a native look by using Wx::RendererNative#draw_header_button internally.
599
+ #
570
600
  # There is no equivalent method for drawing row columns as there is not native look for that. This option is useful when using {Wx::GRID::Grid} for displaying tables and not as a spread-sheet.
571
601
  # @see Wx::GRID::Grid#use_native_col_header
572
602
  # @param native [Boolean]
@@ -575,6 +605,7 @@ module Wx::GRID
575
605
  alias_method :use_native_col_labels=, :set_use_native_col_labels
576
606
 
577
607
  # Enable the use of native header window for column labels.
608
+ #
578
609
  # If this function is called with true argument, a {Wx::HeaderCtrl} is used instead to display the column labels instead of drawing them in {Wx::GRID::Grid} code itself. This has the advantage of making the grid look and feel perfectly the same as native applications (using {Wx::GRID::Grid#set_use_native_col_labels} the grid can be made to look more natively but it still doesn't feel natively, notably the column resizing and dragging still works slightly differently as it is implemented in wxWidgets itself) but results in different behaviour for column and row headers, for which there is no equivalent function, and, most importantly, is unsuitable for grids with huge numbers of columns as {Wx::HeaderCtrl} doesn't support virtual mode. Because of this, by default the grid does not use the native header control but you should call this function to enable it if you are using the grid to display tabular data and don't have thousands of columns in it.
579
610
  # Another difference between the default behaviour and the native header behaviour is that the latter provides the user with a context menu (which appears on right clicking the header) allowing to rearrange the grid columns if {Wx::GRID::Grid#can_drag_col_move} returns true. If you want to prevent this from happening for some reason, you need to define a handler for {Wx::GRID::EVT_GRID_LABEL_RIGHT_CLICK} event which simply does nothing (in particular doesn't skip the event) as this will prevent the default right click handling from working.
580
611
  # Also note that currently {Wx::GRID::EVT_GRID_LABEL_RIGHT_DCLICK} event is not generated for the column labels if the native columns header is used (but this limitation could possibly be lifted in the future).
@@ -584,6 +615,7 @@ module Wx::GRID
584
615
  def use_native_col_header(native=true) end
585
616
 
586
617
  # Sets the arguments to the horizontal and vertical text alignment values for the grid cell at the specified location.
618
+ #
587
619
  # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
588
620
  # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
589
621
  # @param row [Integer]
@@ -614,6 +646,7 @@ module Wx::GRID
614
646
  alias_method :cell_text_colour, :get_cell_text_colour
615
647
 
616
648
  # Returns the default cell alignment.
649
+ #
617
650
  # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
618
651
  # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
619
652
  # @see Wx::GRID::Grid#set_default_cell_alignment
@@ -637,6 +670,7 @@ module Wx::GRID
637
670
  alias_method :default_cell_text_colour, :get_default_cell_text_colour
638
671
 
639
672
  # Sets the horizontal and vertical alignment for grid cell text at the specified location.
673
+ #
640
674
  # Horizontal alignment should be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
641
675
  # Vertical alignment should be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
642
676
  # @param row [Integer]
@@ -666,9 +700,9 @@ module Wx::GRID
666
700
  # @param colour [Wx::Colour,String,Symbol]
667
701
  # @return [void]
668
702
  def set_cell_text_colour(row, col, colour) end
669
- alias_method :cell_text_colour=, :set_cell_text_colour
670
703
 
671
704
  # Sets the default horizontal and vertical alignment for grid cell text.
705
+ #
672
706
  # Horizontal alignment should be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}. Vertical alignment should be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
673
707
  # @param horiz [Integer]
674
708
  # @param vert [Integer]
@@ -694,17 +728,20 @@ module Wx::GRID
694
728
  alias_method :default_cell_text_colour=, :set_default_cell_text_colour
695
729
 
696
730
  # Returns true if the in-place edit control for the current grid cell can be used and false otherwise.
731
+ #
697
732
  # This function always returns false for the read-only cells.
698
733
  # @return [Boolean]
699
734
  def can_enable_cell_control; end
700
735
  alias_method :can_enable_cell_control?, :can_enable_cell_control
701
736
 
702
737
  # Disables in-place editing of grid cells.
738
+ #
703
739
  # Equivalent to calling EnableCellEditControl(false).
704
740
  # @return [void]
705
741
  def disable_cell_edit_control; end
706
742
 
707
743
  # Enables or disables in-place editing of grid cell data.
744
+ #
708
745
  # Enabling in-place editing generates {Wx::GRID::EVT_GRID_EDITOR_SHOWN} and, if it isn't vetoed by the application, shows the in-place editor which allows the user to change the cell value.
709
746
  # Disabling in-place editing does nothing if the in-place editor isn't currently shown, otherwise the {Wx::GRID::EVT_GRID_EDITOR_HIDDEN} event is generated but, unlike the "shown" event, it can't be vetoed and the in-place editor is dismissed unconditionally.
710
747
  # Note that it is an error to call this function if the current cell is read-only, use {Wx::GRID::Grid#can_enable_cell_control} to check for this precondition.
@@ -713,6 +750,7 @@ module Wx::GRID
713
750
  def enable_cell_edit_control(enable=true) end
714
751
 
715
752
  # Makes the grid globally editable or read-only.
753
+ #
716
754
  # If the edit argument is false this function sets the whole grid as read-only. If the argument is true the grid is set to the default state where cells may be editable. In the default state you can set single grid cells and whole rows and columns to be editable or read-only via {Wx::GRID::GridCellAttr#set_read_only}. For single cells you can also use the shortcut function {Wx::GRID::Grid#set_read_only}.
717
755
  # For more information about controlling grid cell attributes see the {Wx::GRID::GridCellAttr} class and the wxGrid Overview.
718
756
  # @param edit [Boolean]
@@ -720,6 +758,7 @@ module Wx::GRID
720
758
  def enable_editing(edit) end
721
759
 
722
760
  # Returns a pointer to the editor for the cell at the specified location.
761
+ #
723
762
  # See {Wx::GRID::GridCellEditor} and the wxGrid Overview for more information about cell editors and renderers.
724
763
  # The caller must call DecRef() on the returned pointer.
725
764
  # @param row [Integer]
@@ -729,6 +768,7 @@ module Wx::GRID
729
768
  alias_method :cell_editor, :get_cell_editor
730
769
 
731
770
  # Returns a pointer to the renderer for the grid cell at the specified location.
771
+ #
732
772
  # See {Wx::GRID::GridCellRenderer} and the wxGrid Overview for more information about cell editors and renderers.
733
773
  # The caller must call DecRef() on the returned pointer.
734
774
  # @param row [Integer]
@@ -738,6 +778,7 @@ module Wx::GRID
738
778
  alias_method :cell_renderer, :get_cell_renderer
739
779
 
740
780
  # Returns the string contained in the cell at the specified location.
781
+ #
741
782
  # For simple applications where a grid object automatically uses a default grid table of string values you use this function together with {Wx::GRID::Grid#set_cell_value} to access cell values. For more complex applications where you have derived your own grid table class that contains various data types (e.g. numeric, boolean or user-defined custom types) then you only use this function for those cells that contain string values.
742
783
  # See {Wx::GRID::GridTableBase#can_get_value_as} and the wxGrid Overview for more information.
743
784
  # @param row [Integer]
@@ -747,12 +788,14 @@ module Wx::GRID
747
788
  alias_method :cell_value, :get_cell_value
748
789
 
749
790
  # Returns a pointer to the current default grid cell editor.
791
+ #
750
792
  # See {Wx::GRID::GridCellEditor} and the wxGrid Overview for more information about cell editors and renderers.
751
793
  # @return [Wx::GRID::GridCellEditor]
752
794
  def get_default_editor; end
753
795
  alias_method :default_editor, :get_default_editor
754
796
 
755
797
  # Returns the default editor for the specified cell.
798
+ #
756
799
  # The base class version returns the editor appropriate for the current cell type but this method may be overridden in the derived classes to use custom editors for some cells by default.
757
800
  # Notice that the same may be achieved in a usually simpler way by associating a custom editor with the given cell or cells.
758
801
  # The caller must call DecRef() on the returned pointer.
@@ -763,6 +806,7 @@ module Wx::GRID
763
806
  alias_method :default_editor_for_cell, :get_default_editor_for_cell
764
807
 
765
808
  # Returns the default editor for the cells containing values of the given type.
809
+ #
766
810
  # The base class version returns the editor which was associated with the specified typeName when it was registered {Wx::GRID::Grid#register_data_type} but this function may be overridden to return something different. This allows overriding an editor used for one of the standard types.
767
811
  # The caller must call DecRef() on the returned pointer.
768
812
  # @param typeName [String]
@@ -771,6 +815,7 @@ module Wx::GRID
771
815
  alias_method :default_editor_for_type, :get_default_editor_for_type
772
816
 
773
817
  # Returns a pointer to the current default grid cell renderer.
818
+ #
774
819
  # See {Wx::GRID::GridCellRenderer} and the wxGrid Overview for more information about cell editors and renderers.
775
820
  # The caller must call DecRef() on the returned pointer.
776
821
  # @return [Wx::GRID::GridCellRenderer]
@@ -778,6 +823,7 @@ module Wx::GRID
778
823
  alias_method :default_renderer, :get_default_renderer
779
824
 
780
825
  # Returns the default renderer for the given cell.
826
+ #
781
827
  # The base class version returns the renderer appropriate for the current cell type but this method may be overridden in the derived classes to use custom renderers for some cells by default.
782
828
  # The caller must call DecRef() on the returned pointer.
783
829
  # @param row [Integer]
@@ -788,6 +834,7 @@ module Wx::GRID
788
834
 
789
835
  # Returns the default renderer for the cell containing values of the given type.
790
836
  #
837
+ #
791
838
  # @see Wx::GRID::Grid#get_default_editor_for_type
792
839
  # @param typeName [String]
793
840
  # @return [Wx::GRID::GridCellRenderer]
@@ -805,6 +852,7 @@ module Wx::GRID
805
852
 
806
853
  # Returns true if the in-place edit control is currently shown.
807
854
  #
855
+ #
808
856
  # @see Wx::GRID::Grid#hide_cell_edit_control
809
857
  # @return [Boolean]
810
858
  def is_cell_edit_control_shown; end
@@ -812,6 +860,7 @@ module Wx::GRID
812
860
 
813
861
  # Returns true if the current cell is read-only.
814
862
  #
863
+ #
815
864
  # @see Wx::GRID::Grid#set_read_only
816
865
  # @see Wx::GRID::Grid#is_read_only
817
866
  # @return [Boolean]
@@ -819,6 +868,7 @@ module Wx::GRID
819
868
  alias_method :current_cell_read_only?, :is_current_cell_read_only
820
869
 
821
870
  # Returns false if the whole grid has been set as read-only or true otherwise.
871
+ #
822
872
  # See {Wx::GRID::Grid#enable_editing} for more information about controlling the editing status of grid cells.
823
873
  # @return [Boolean]
824
874
  def is_editable; end
@@ -826,6 +876,7 @@ module Wx::GRID
826
876
 
827
877
  # Returns true if the cell at the specified location can't be edited.
828
878
  #
879
+ #
829
880
  # @see Wx::GRID::Grid#set_read_only
830
881
  # @see Wx::GRID::Grid#is_current_cell_read_only
831
882
  # @param row [Integer]
@@ -835,6 +886,7 @@ module Wx::GRID
835
886
  alias_method :read_only?, :is_read_only
836
887
 
837
888
  # Register a new data type.
889
+ #
838
890
  # The data types allow to naturally associate specific renderers and editors to the cells containing values of the given type. For example, the grid automatically registers a data type with the name {Wx::GRID::GRID_VALUE_STRING} which uses {Wx::GRID::GridCellStringRenderer} and {Wx::GRID::GridCellTextEditor} as its renderer and editor respectively this is the data type used by all the cells of the default {Wx::GRID::GridStringTable}, so this renderer and editor are used by default for all grid cells.
839
891
  # However if a custom table returns {Wx::GRID::GRID_VALUE_BOOL} from its {Wx::GRID::GridTableBase#get_type_name} method, then {Wx::GRID::GridCellBoolRenderer} and {Wx::GRID::GridCellBoolEditor} are used for it because the grid also registers a boolean data type with this name.
840
892
  # And as this mechanism is completely generic, you may register your own data types using your own custom renderers and editors. Just remember that the table must identify a cell as being of the given type for them to be used for this cell.
@@ -845,11 +897,13 @@ module Wx::GRID
845
897
  def register_data_type(typeName, renderer, editor) end
846
898
 
847
899
  # Sets the value of the current grid cell to the current in-place edit control value.
900
+ #
848
901
  # This is called automatically when the grid cursor moves from the current cell to a new cell. It is also a good idea to call this function when closing a grid since any edits to the final cell location will not be saved otherwise.
849
902
  # @return [void]
850
903
  def save_edit_control_value; end
851
904
 
852
905
  # Sets the editor for the grid cell at the specified location.
906
+ #
853
907
  # The grid will take ownership of the pointer.
854
908
  # See {Wx::GRID::GridCellEditor} and the wxGrid Overview for more information about cell editors and renderers.
855
909
  # @param row [Integer]
@@ -859,6 +913,7 @@ module Wx::GRID
859
913
  def set_cell_editor(row, col, editor) end
860
914
 
861
915
  # Sets the renderer for the grid cell at the specified location.
916
+ #
862
917
  # The grid will take ownership of the pointer.
863
918
  # See {Wx::GRID::GridCellRenderer} and the wxGrid Overview for more information about cell editors and renderers.
864
919
  # @param row [Integer]
@@ -868,6 +923,7 @@ module Wx::GRID
868
923
  def set_cell_renderer(row, col, renderer) end
869
924
 
870
925
  # Sets the string value for the cell at the specified location.
926
+ #
871
927
  # For simple applications where a grid object automatically uses a default grid table of string values you use this function together with {Wx::GRID::Grid#get_cell_value} to access cell values. For more complex applications where you have derived your own grid table class that contains various data types (e.g. numeric, boolean or user-defined custom types) then you only use this function for those cells that contain string values.
872
928
  # See {Wx::GRID::GridTableBase#can_set_value_as} and the wxGrid Overview for more information.
873
929
  # @param row [Integer]
@@ -878,6 +934,7 @@ module Wx::GRID
878
934
 
879
935
  # Sets the specified column to display boolean values.
880
936
  #
937
+ #
881
938
  # @see Wx::GRID::Grid#set_col_format_custom
882
939
  # @param col [Integer]
883
940
  # @return [void]
@@ -885,6 +942,7 @@ module Wx::GRID
885
942
  alias_method :col_format_bool=, :set_col_format_bool
886
943
 
887
944
  # Sets the specified column to display data in a custom format.
945
+ #
888
946
  # This method provides an alternative to defining a custom grid table which would return typeName from its GetTypeName() method for the cells in this column: while it doesn't really change the type of the cells in this column, it does associate the renderer and editor used for the cells of the specified type with them.
889
947
  # See the wxGrid Overview for more information on working with custom data types.
890
948
  # @param col [Integer]
@@ -894,6 +952,7 @@ module Wx::GRID
894
952
 
895
953
  # Sets the specified column to display floating point values with the given width and precision.
896
954
  #
955
+ #
897
956
  # @see Wx::GRID::Grid#set_col_format_custom
898
957
  # @param col [Integer]
899
958
  # @param width [Integer]
@@ -904,6 +963,7 @@ module Wx::GRID
904
963
 
905
964
  # Sets the specified column to display integer values.
906
965
  #
966
+ #
907
967
  # @see Wx::GRID::Grid#set_col_format_custom
908
968
  # @param col [Integer]
909
969
  # @return [void]
@@ -911,6 +971,7 @@ module Wx::GRID
911
971
  alias_method :col_format_number=, :set_col_format_number
912
972
 
913
973
  # Sets the specified column to display date values.
974
+ #
914
975
  # The format argument is used with {Wx::GRID::GridCellDateRenderer} and allows to specify the strftime-like format string to use for displaying the dates in this column.
915
976
  # @see Wx::GRID::Grid#set_col_format_custom
916
977
  # @param col [Integer]
@@ -920,6 +981,7 @@ module Wx::GRID
920
981
  alias_method :col_format_date=, :set_col_format_date
921
982
 
922
983
  # Sets the default editor for grid cells.
984
+ #
923
985
  # The grid will take ownership of the pointer.
924
986
  # See {Wx::GRID::GridCellEditor} and the wxGrid Overview for more information about cell editors and renderers.
925
987
  # @param editor [Wx::GRID::GridCellEditor]
@@ -928,6 +990,7 @@ module Wx::GRID
928
990
  alias_method :default_editor=, :set_default_editor
929
991
 
930
992
  # Sets the default renderer for grid cells.
993
+ #
931
994
  # The grid will take ownership of the pointer.
932
995
  # See {Wx::GRID::GridCellRenderer} and the wxGrid Overview for more information about cell editors and renderers.
933
996
  # @param renderer [Wx::GRID::GridCellRenderer]
@@ -937,6 +1000,7 @@ module Wx::GRID
937
1000
 
938
1001
  # Makes the cell at the specified location read-only or editable.
939
1002
  #
1003
+ #
940
1004
  # @see Wx::GRID::Grid#is_read_only
941
1005
  # @param row [Integer]
942
1006
  # @param col [Integer]
@@ -945,6 +1009,7 @@ module Wx::GRID
945
1009
  def set_read_only(row, col, isReadOnly=true) end
946
1010
 
947
1011
  # Displays the active in-place cell edit control for the current cell after it was hidden.
1012
+ #
948
1013
  # This method should only be called after calling {Wx::GRID::Grid#hide_cell_edit_control}, to start editing the current grid cell use {Wx::GRID::Grid#enable_cell_edit_control} instead.
949
1014
  # @return [void]
950
1015
  def show_cell_edit_control; end
@@ -959,6 +1024,7 @@ module Wx::GRID
959
1024
  def auto_size_col_label_size(col) end
960
1025
 
961
1026
  # Automatically sizes the column to fit its contents.
1027
+ #
962
1028
  # If setAsMin is true the calculated width will also be set as the minimal width for the column.
963
1029
  # @param col [Integer]
964
1030
  # @param setAsMin [Boolean]
@@ -966,12 +1032,14 @@ module Wx::GRID
966
1032
  def auto_size_column(col, setAsMin=true) end
967
1033
 
968
1034
  # Automatically sizes all columns to fit their contents.
1035
+ #
969
1036
  # If setAsMin is true the calculated widths will also be set as the minimal widths for the columns.
970
1037
  # @param setAsMin [Boolean]
971
1038
  # @return [void]
972
1039
  def auto_size_columns(setAsMin=true) end
973
1040
 
974
1041
  # Automatically sizes the row to fit its contents.
1042
+ #
975
1043
  # If setAsMin is true the calculated height will also be set as the minimal height for the row.
976
1044
  # @param row [Integer]
977
1045
  # @param setAsMin [Boolean]
@@ -984,6 +1052,7 @@ module Wx::GRID
984
1052
  def auto_size_row_label_size(col) end
985
1053
 
986
1054
  # Automatically sizes all rows to fit their contents.
1055
+ #
987
1056
  # If setAsMin is true the calculated heights will also be set as the minimal heights for the rows.
988
1057
  # @param setAsMin [Boolean]
989
1058
  # @return [void]
@@ -991,6 +1060,7 @@ module Wx::GRID
991
1060
 
992
1061
  # Returns the cell fitting mode.
993
1062
  #
1063
+ #
994
1064
  # @see Wx::GRID::GridFitMode
995
1065
  # @param row [Integer]
996
1066
  # @param col [Integer]
@@ -999,6 +1069,7 @@ module Wx::GRID
999
1069
  alias_method :cell_fit_mode, :get_cell_fit_mode
1000
1070
 
1001
1071
  # Returns true if the cell value can overflow.
1072
+ #
1002
1073
  # This is identical to calling {Wx::GRID::Grid#get_cell_fit_mode} and using {Wx::GRID::GridFitMode#is_overflow} on the returned value.
1003
1074
  # Prefer using {Wx::GRID::Grid#get_cell_fit_mode} directly in the new code.
1004
1075
  # @param row [Integer]
@@ -1013,6 +1084,7 @@ module Wx::GRID
1013
1084
  alias_method :col_label_size, :get_col_label_size
1014
1085
 
1015
1086
  # Returns the minimal width to which a column may be resized.
1087
+ #
1016
1088
  # Use {Wx::GRID::Grid#set_col_minimal_acceptable_width} to change this value globally or {Wx::GRID::Grid#set_col_minimal_width} to do it for individual columns.
1017
1089
  # @see Wx::GRID::Grid#get_row_minimal_acceptable_height
1018
1090
  # @return [Integer]
@@ -1032,6 +1104,7 @@ module Wx::GRID
1032
1104
  alias_method :col_shown?, :is_col_shown
1033
1105
 
1034
1106
  # Returns the default cell fitting mode.
1107
+ #
1035
1108
  # The default mode is "overflow", but can be modified using {Wx::GRID::Grid#set_default_cell_fit_mode}.
1036
1109
  # @see Wx::GRID::GridFitMode
1037
1110
  # @return [Wx::GRID::GridFitMode]
@@ -1039,6 +1112,7 @@ module Wx::GRID
1039
1112
  alias_method :default_cell_fit_mode, :get_default_cell_fit_mode
1040
1113
 
1041
1114
  # Returns true if the cells can overflow by default.
1115
+ #
1042
1116
  # This is identical to calling {Wx::GRID::Grid#get_default_cell_fit_mode} and using {Wx::GRID::GridFitMode#is_overflow} on the returned value.
1043
1117
  # Prefer using {Wx::GRID::Grid#get_default_cell_fit_mode} directly in the new code.
1044
1118
  # @return [Boolean]
@@ -1066,6 +1140,7 @@ module Wx::GRID
1066
1140
  alias_method :default_row_size, :get_default_row_size
1067
1141
 
1068
1142
  # Returns the minimal size to which rows can be resized.
1143
+ #
1069
1144
  # Use {Wx::GRID::Grid#set_row_minimal_acceptable_height} to change this value globally or {Wx::GRID::Grid#set_row_minimal_height} to do it for individual cells.
1070
1145
  # @see Wx::GRID::Grid#get_col_minimal_acceptable_width
1071
1146
  # @return [Integer]
@@ -1091,6 +1166,7 @@ module Wx::GRID
1091
1166
 
1092
1167
  # Specifies the behaviour of the cell contents if it doesn't fit into the available space.
1093
1168
  #
1169
+ #
1094
1170
  # @see Wx::GRID::GridFitMode
1095
1171
  # @param row [Integer]
1096
1172
  # @param col [Integer]
@@ -1099,6 +1175,7 @@ module Wx::GRID
1099
1175
  def set_cell_fit_mode(row, col, fitMode) end
1100
1176
 
1101
1177
  # Sets the overflow permission of the cell.
1178
+ #
1102
1179
  # Prefer using {Wx::GRID::Grid#set_cell_fit_mode} in the new code.
1103
1180
  # @param row [Integer]
1104
1181
  # @param col [Integer]
@@ -1107,6 +1184,7 @@ module Wx::GRID
1107
1184
  def set_cell_overflow(row, col, allow) end
1108
1185
 
1109
1186
  # Sets the height of the column labels.
1187
+ #
1110
1188
  # If height equals to {Wx::GRID::GRID_AUTOSIZE} then height is calculated automatically so that no label is truncated. Note that this could be slow for a large table.
1111
1189
  # @param height [Integer]
1112
1190
  # @return [void]
@@ -1115,6 +1193,7 @@ module Wx::GRID
1115
1193
 
1116
1194
  # Sets the minimal width to which the user can resize columns.
1117
1195
  #
1196
+ #
1118
1197
  # @see Wx::GRID::Grid#get_col_minimal_acceptable_width
1119
1198
  # @param width [Integer]
1120
1199
  # @return [void]
@@ -1122,6 +1201,7 @@ module Wx::GRID
1122
1201
  alias_method :col_minimal_acceptable_width=, :set_col_minimal_acceptable_width
1123
1202
 
1124
1203
  # Sets the minimal width for the specified column col.
1204
+ #
1125
1205
  # It is usually best to call this method during grid creation as calling it later will not resize the column to the given minimal width even if it is currently narrower than it.
1126
1206
  # width must be greater than the minimal acceptable column width as returned by {Wx::GRID::Grid#get_col_minimal_acceptable_width}.
1127
1207
  # @param col [Integer]
@@ -1136,6 +1216,7 @@ module Wx::GRID
1136
1216
  def set_col_size(col, width) end
1137
1217
 
1138
1218
  # Hides the specified column.
1219
+ #
1139
1220
  # To show the column later you need to call {Wx::GRID::Grid#set_col_size} with non-0 width or {Wx::GRID::Grid#show_col} to restore the previous column width.
1140
1221
  # If the column is already hidden, this method doesn't do anything.
1141
1222
  # @param col [Integer] The column index.
@@ -1143,6 +1224,7 @@ module Wx::GRID
1143
1224
  def hide_col(col) end
1144
1225
 
1145
1226
  # Shows the previously hidden column by resizing it to non-0 size.
1227
+ #
1146
1228
  # The column is shown again with the same width that it had before {Wx::GRID::Grid#hide_col} call.
1147
1229
  # If the column is currently shown, this method doesn't do anything.
1148
1230
  # @see Wx::GRID::Grid#hide_col
@@ -1153,6 +1235,7 @@ module Wx::GRID
1153
1235
 
1154
1236
  # Specifies the default behaviour of the cell contents if it doesn't fit into the available space.
1155
1237
  #
1238
+ #
1156
1239
  # @see Wx::GRID::GridFitMode
1157
1240
  # @param fitMode [Wx::GRID::GridFitMode]
1158
1241
  # @return [void]
@@ -1160,6 +1243,7 @@ module Wx::GRID
1160
1243
  alias_method :default_cell_fit_mode=, :set_default_cell_fit_mode
1161
1244
 
1162
1245
  # Sets the default overflow permission of the cells.
1246
+ #
1163
1247
  # Prefer using {Wx::GRID::Grid#set_default_cell_fit_mode} in the new code.
1164
1248
  # @param allow [Boolean]
1165
1249
  # @return [void]
@@ -1167,6 +1251,7 @@ module Wx::GRID
1167
1251
  alias_method :default_cell_overflow=, :set_default_cell_overflow
1168
1252
 
1169
1253
  # Sets the default width for columns in the grid.
1254
+ #
1170
1255
  # This will only affect columns subsequently added to the grid unless resizeExistingCols is true.
1171
1256
  # If width is less than {Wx::GRID::Grid#get_col_minimal_acceptable_width}, then the minimal acceptable width is used instead of it.
1172
1257
  # @param width [Integer]
@@ -1176,6 +1261,7 @@ module Wx::GRID
1176
1261
  alias_method :default_col_size=, :set_default_col_size
1177
1262
 
1178
1263
  # Sets the default height for rows in the grid.
1264
+ #
1179
1265
  # This will only affect rows subsequently added to the grid unless resizeExistingRows is true.
1180
1266
  # If height is less than {Wx::GRID::Grid#get_row_minimal_acceptable_height}, then the minimal acceptable height is used instead of it.
1181
1267
  # @param height [Integer]
@@ -1185,6 +1271,7 @@ module Wx::GRID
1185
1271
  alias_method :default_row_size=, :set_default_row_size
1186
1272
 
1187
1273
  # Sets the width of the row labels.
1274
+ #
1188
1275
  # If width equals {Wx::GRID::GRID_AUTOSIZE} then width is calculated automatically so that no label is truncated. Note that this could be slow for a large table.
1189
1276
  # @param width [Integer]
1190
1277
  # @return [void]
@@ -1192,6 +1279,7 @@ module Wx::GRID
1192
1279
  alias_method :row_label_size=, :set_row_label_size
1193
1280
 
1194
1281
  # Sets the minimal row height used by default.
1282
+ #
1195
1283
  # See {Wx::GRID::Grid#set_col_minimal_acceptable_width} for more information.
1196
1284
  # @param height [Integer]
1197
1285
  # @return [void]
@@ -1199,6 +1287,7 @@ module Wx::GRID
1199
1287
  alias_method :row_minimal_acceptable_height=, :set_row_minimal_acceptable_height
1200
1288
 
1201
1289
  # Sets the minimal height for the specified row.
1290
+ #
1202
1291
  # See {Wx::GRID::Grid#set_col_minimal_width} for more information.
1203
1292
  # @param row [Integer]
1204
1293
  # @param height [Integer]
@@ -1206,6 +1295,7 @@ module Wx::GRID
1206
1295
  def set_row_minimal_height(row, height) end
1207
1296
 
1208
1297
  # Sets the height of the specified row.
1298
+ #
1209
1299
  # See {Wx::GRID::Grid#set_col_size} for more information.
1210
1300
  # @param row [Integer]
1211
1301
  # @param height [Integer]
@@ -1213,6 +1303,7 @@ module Wx::GRID
1213
1303
  def set_row_size(row, height) end
1214
1304
 
1215
1305
  # Hides the specified row.
1306
+ #
1216
1307
  # To show the row later you need to call {Wx::GRID::Grid#set_row_size} with non-0 width or {Wx::GRID::Grid#show_row} to restore its original height.
1217
1308
  # If the row is already hidden, this method doesn't do anything.
1218
1309
  # @param col [Integer] The row index.
@@ -1220,6 +1311,7 @@ module Wx::GRID
1220
1311
  def hide_row(col) end
1221
1312
 
1222
1313
  # Shows the previously hidden row.
1314
+ #
1223
1315
  # The row is shown again with the same height that it had before {Wx::GRID::Grid#hide_row} call.
1224
1316
  # If the row is currently shown, this method doesn't do anything.
1225
1317
  # @see Wx::GRID::Grid#hide_row
@@ -1229,6 +1321,7 @@ module Wx::GRID
1229
1321
  def show_row(col) end
1230
1322
 
1231
1323
  # Get size information for all columns at once.
1324
+ #
1232
1325
  # This method is useful when the information about all column widths needs to be saved. The widths can be later restored using {Wx::GRID::Grid#set_col_sizes}.
1233
1326
  # @see Wx::GRID::GridSizesInfo
1234
1327
  # @see Wx::GRID::Grid#get_row_sizes
@@ -1238,6 +1331,7 @@ module Wx::GRID
1238
1331
 
1239
1332
  # Get size information for all row at once.
1240
1333
  #
1334
+ #
1241
1335
  # @see Wx::GRID::GridSizesInfo
1242
1336
  # @see Wx::GRID::Grid#get_col_sizes
1243
1337
  # @return [Wx::GRID::GridSizesInfo]
@@ -1245,6 +1339,7 @@ module Wx::GRID
1245
1339
  alias_method :row_sizes, :get_row_sizes
1246
1340
 
1247
1341
  # Restore all columns sizes.
1342
+ #
1248
1343
  # This is usually called with {Wx::GRID::GridSizesInfo} object previously returned by {Wx::GRID::Grid#get_col_sizes}.
1249
1344
  # @see Wx::GRID::Grid#set_row_sizes
1250
1345
  # @param sizeInfo [Wx::GRID::GridSizesInfo]
@@ -1254,6 +1349,7 @@ module Wx::GRID
1254
1349
 
1255
1350
  # Restore all rows sizes.
1256
1351
  #
1352
+ #
1257
1353
  # @see Wx::GRID::Grid#set_col_sizes
1258
1354
  # @param sizeInfo [Wx::GRID::GridSizesInfo]
1259
1355
  # @return [void]
@@ -1261,6 +1357,7 @@ module Wx::GRID
1261
1357
  alias_method :row_sizes=, :set_row_sizes
1262
1358
 
1263
1359
  # Set the size of the cell.
1360
+ #
1264
1361
  # Specifying a value of more than 1 in num_rows or num_cols will make the cell at (row, col) span the block of the specified size, covering the other cells which would be normally shown in it. Passing 1 for both arguments resets the cell to normal appearance.
1265
1362
  # @see Wx::GRID::Grid#get_cell_size
1266
1363
  # @param row [Integer] The row of the cell.
@@ -1272,6 +1369,7 @@ module Wx::GRID
1272
1369
 
1273
1370
  # @overload get_cell_size(row, col)
1274
1371
  # Get the size of the cell in number of cells covered by it.
1372
+ #
1275
1373
  # For normal cells, the function fills both num_rows and num_cols with 1 and returns CellSpan_None. For cells which span multiple cells, i.e. for which {Wx::GRID::Grid#set_cell_size} had been called, the returned values are the same ones as were passed to {Wx::GRID::Grid#set_cell_size} call and the function return value is CellSpan_Main.
1276
1374
  # More unexpectedly, perhaps, the returned values may be negative for the cells which are inside a span covered by a cell occupying multiple rows or columns. They correspond to the offset of the main cell of the span from the cell passed to this functions and the function returns CellSpan_Inside value to indicate this.
1277
1375
  # As an example, consider a 3*3 grid with the cell (1, 1) (the one in the middle) having a span of 2 rows and 2 columns, i.e. the grid looks like
@@ -1289,9 +1387,10 @@ module Wx::GRID
1289
1387
  # The kind of this cell span (the return value is new in wxWidgets 2.9.1, this function was void in previous wxWidgets versions).
1290
1388
  # @param row [Integer] The row of the cell.
1291
1389
  # @param col [Integer] The column of the cell.
1292
- # @return [Array(Wx::wxGrid::CellSpan,Integer,Integer)]
1390
+ # @return [Array(Wx::Grid::CellSpan,Integer,Integer)]
1293
1391
  # @overload get_cell_size(coords)
1294
1392
  # Get the number of rows and columns allocated for this cell.
1393
+ #
1295
1394
  # This overload doesn't return a CellSpan value but the values returned may still be negative, see GetCellSize(int, int, int *, int *) for details.
1296
1395
  # @param coords [Array(Integer, Integer)]
1297
1396
  # @return [Wx::Size]
@@ -1304,12 +1403,14 @@ module Wx::GRID
1304
1403
  alias_method :can_drag_cell?, :can_drag_cell
1305
1404
 
1306
1405
  # Returns true if columns can be moved by dragging with the mouse.
1406
+ #
1307
1407
  # Columns can be moved by dragging on their labels.
1308
1408
  # @return [Boolean]
1309
1409
  def can_drag_col_move; end
1310
1410
  alias_method :can_drag_col_move?, :can_drag_col_move
1311
1411
 
1312
1412
  # Returns true if the given column can be resized by dragging with the mouse.
1413
+ #
1313
1414
  # This function returns true if resizing the columns interactively is globally enabled, i.e. if {Wx::GRID::Grid#disable_drag_col_size} hadn't been called, and if this column wasn't explicitly marked as non-resizable with {Wx::GRID::Grid#disable_col_resize}.
1314
1415
  # @param col [Integer]
1315
1416
  # @return [Boolean]
@@ -1318,6 +1419,7 @@ module Wx::GRID
1318
1419
 
1319
1420
  # Return true if column edges inside the grid can be dragged to resize the rows.
1320
1421
  #
1422
+ #
1321
1423
  # @see Wx::GRID::Grid#can_drag_grid_size
1322
1424
  # @see Wx::GRID::Grid#can_drag_col_size
1323
1425
  # @return [Boolean]
@@ -1326,6 +1428,7 @@ module Wx::GRID
1326
1428
 
1327
1429
  # Return true if row edges inside the grid can be dragged to resize the rows.
1328
1430
  #
1431
+ #
1329
1432
  # @see Wx::GRID::Grid#can_drag_grid_size
1330
1433
  # @see Wx::GRID::Grid#can_drag_row_size
1331
1434
  # @return [Boolean]
@@ -1338,12 +1441,14 @@ module Wx::GRID
1338
1441
  alias_method :can_drag_grid_size?, :can_drag_grid_size
1339
1442
 
1340
1443
  # Returns true if rows can be moved by dragging with the mouse.
1444
+ #
1341
1445
  # Rows can be moved by dragging on their labels.
1342
1446
  # @return [Boolean]
1343
1447
  def can_drag_row_move; end
1344
1448
  alias_method :can_drag_row_move?, :can_drag_row_move
1345
1449
 
1346
1450
  # Returns true if the given row can be resized by dragging with the mouse.
1451
+ #
1347
1452
  # This is the same as {Wx::GRID::Grid#can_drag_col_size} but for rows.
1348
1453
  # @param row [Integer]
1349
1454
  # @return [Boolean]
@@ -1356,6 +1461,7 @@ module Wx::GRID
1356
1461
  alias_method :can_hide_columns?, :can_hide_columns
1357
1462
 
1358
1463
  # Disable interactive resizing of the specified column.
1464
+ #
1359
1465
  # This method allows one to disable resizing of an individual column in a grid where the columns are otherwise resizable (which is the case by default).
1360
1466
  # Notice that currently there is no way to make some columns resizable in a grid where columns can't be resized by default as there doesn't seem to be any need for this in practice. There is also no way to make the column marked as fixed using this method resizable again because it is supposed that fixed columns are used for static parts of the grid and so should remain fixed during the entire grid lifetime.
1361
1467
  # Also notice that disabling interactive column resizing will not prevent the program from changing the column size.
@@ -1365,6 +1471,7 @@ module Wx::GRID
1365
1471
  def disable_col_resize(col) end
1366
1472
 
1367
1473
  # Disable interactive resizing of the specified row.
1474
+ #
1368
1475
  # This is the same as {Wx::GRID::Grid#disable_col_resize} but for rows.
1369
1476
  # @see Wx::GRID::Grid#enable_drag_row_size
1370
1477
  # @param row [Integer]
@@ -1372,31 +1479,37 @@ module Wx::GRID
1372
1479
  def disable_row_resize(row) end
1373
1480
 
1374
1481
  # Disables column moving by dragging with the mouse.
1482
+ #
1375
1483
  # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_col_move}.
1376
1484
  # @return [void]
1377
1485
  def disable_drag_col_move; end
1378
1486
 
1379
1487
  # Disables row moving by dragging with the mouse.
1488
+ #
1380
1489
  # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_row_move}.
1381
1490
  # @return [void]
1382
1491
  def disable_drag_row_move; end
1383
1492
 
1384
1493
  # Disables column sizing by dragging with the mouse.
1494
+ #
1385
1495
  # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_col_size}.
1386
1496
  # @return [void]
1387
1497
  def disable_drag_col_size; end
1388
1498
 
1389
1499
  # Disable mouse dragging of grid lines to resize rows and columns.
1500
+ #
1390
1501
  # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_grid_size}
1391
1502
  # @return [void]
1392
1503
  def disable_drag_grid_size; end
1393
1504
 
1394
1505
  # Disables row sizing by dragging with the mouse.
1506
+ #
1395
1507
  # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_row_size}.
1396
1508
  # @return [void]
1397
1509
  def disable_drag_row_size; end
1398
1510
 
1399
1511
  # Disables column hiding from the header popup menu.
1512
+ #
1400
1513
  # Equivalent to passing false to {Wx::GRID::Grid#enable_hiding_columns}.
1401
1514
  # @return [void]
1402
1515
  def disable_hiding_columns; end
@@ -1407,12 +1520,14 @@ module Wx::GRID
1407
1520
  def enable_drag_cell(enable=true) end
1408
1521
 
1409
1522
  # Enables or disables column moving by dragging with the mouse.
1523
+ #
1410
1524
  # Note that reordering columns by dragging them is currently not supported when the grid has any frozen columns (see {Wx::GRID::Grid#freeze_to}) and if this method is called with enable equal to true in this situation, it returns false without doing anything. Otherwise it returns true to indicate that it was successful.
1411
1525
  # @param enable [Boolean]
1412
1526
  # @return [Boolean]
1413
1527
  def enable_drag_col_move(enable=true) end
1414
1528
 
1415
1529
  # Enables or disables row moving by dragging with the mouse.
1530
+ #
1416
1531
  # Note that reordering rows by dragging them is currently not supported when the grid has any frozen columns (see {Wx::GRID::Grid#freeze_to}) and if this method is called with enable equal to true in this situation, it returns false without doing anything. Otherwise it returns true to indicate that it was successful.
1417
1532
  # @param enable [Boolean]
1418
1533
  # @return [Boolean]
@@ -1420,6 +1535,7 @@ module Wx::GRID
1420
1535
 
1421
1536
  # Enables or disables column sizing by dragging with the mouse.
1422
1537
  #
1538
+ #
1423
1539
  # @see Wx::GRID::Grid#disable_col_resize
1424
1540
  # @param enable [Boolean]
1425
1541
  # @return [void]
@@ -1432,12 +1548,14 @@ module Wx::GRID
1432
1548
 
1433
1549
  # Enables or disables row sizing by dragging with the mouse.
1434
1550
  #
1551
+ #
1435
1552
  # @see Wx::GRID::Grid#disable_row_resize
1436
1553
  # @param enable [Boolean]
1437
1554
  # @return [void]
1438
1555
  def enable_drag_row_size(enable=true) end
1439
1556
 
1440
1557
  # Enables or disables column hiding from the header popup menu.
1558
+ #
1441
1559
  # Note that currently the popup menu can only be shown when using {Wx::HeaderCtrl}, i.e. if {Wx::GRID::Grid#use_native_col_header} had been called.
1442
1560
  # If the native header is not used, this method always simply returns false without doing anything, as hiding columns is not supported anyhow. If enable value is the same as {Wx::GRID::Grid#can_hide_columns}, it also returns false to indicate that nothing was done. Otherwise, it returns true to indicate that the value of this option was successfully changed.
1443
1561
  # The main use case for this method is to disallow hiding the columns interactively when using the native header.
@@ -1465,6 +1583,7 @@ module Wx::GRID
1465
1583
  def set_col_pos(colID, newPos) end
1466
1584
 
1467
1585
  # Sets the positions of all columns at once.
1586
+ #
1468
1587
  # This method takes an array containing the indices of the columns in their display order, i.e. uses the same convention as {Wx::HeaderCtrl#set_columns_order}.
1469
1588
  # @param order [Array<Integer>]
1470
1589
  # @return [void]
@@ -1494,6 +1613,7 @@ module Wx::GRID
1494
1613
  def set_row_pos(rowID, newPos) end
1495
1614
 
1496
1615
  # Sets the positions of all rows at once.
1616
+ #
1497
1617
  # This method takes an array containing the indices of the rows in their display order.
1498
1618
  # @param order [Array<Integer>]
1499
1619
  # @return [void]
@@ -1505,6 +1625,7 @@ module Wx::GRID
1505
1625
  def reset_row_pos; end
1506
1626
 
1507
1627
  # Returns the current grid cursor position.
1628
+ #
1508
1629
  # If grid cursor doesn't have any valid position (e.g. if the grid is completely empty and doesn't have any rows or columns), returns {Wx::GridNoCellCoords} which has both row and columns set to <code>-1</code>.
1509
1630
  # @return [Array(Integer, Integer)]
1510
1631
  def get_grid_cursor_coords; end
@@ -1512,6 +1633,7 @@ module Wx::GRID
1512
1633
 
1513
1634
  # Returns the current grid cell column position.
1514
1635
  #
1636
+ #
1515
1637
  # @see Wx::GRID::Grid#get_grid_cursor_coords
1516
1638
  # @return [Integer]
1517
1639
  def get_grid_cursor_col; end
@@ -1519,6 +1641,7 @@ module Wx::GRID
1519
1641
 
1520
1642
  # Returns the current grid cell row position.
1521
1643
  #
1644
+ #
1522
1645
  # @see Wx::GRID::Grid#get_grid_cursor_coords
1523
1646
  # @return [Integer]
1524
1647
  def get_grid_cursor_row; end
@@ -1526,60 +1649,70 @@ module Wx::GRID
1526
1649
 
1527
1650
  # @overload go_to_cell(row, col)
1528
1651
  # Make the given cell current and ensure it is visible.
1652
+ #
1529
1653
  # This method is equivalent to calling {Wx::GRID::Grid#make_cell_visible} and {Wx::GRID::Grid#set_grid_cursor} and so, as with the latter, a {Wx::GRID::EVT_GRID_SELECT_CELL} event is generated by it and the selected cell doesn't change if the event is vetoed.
1530
1654
  # @param row [Integer]
1531
1655
  # @param col [Integer]
1532
1656
  # @return [void]
1533
1657
  # @overload go_to_cell(coords)
1534
1658
  # Make the given cell current and ensure it is visible.
1659
+ #
1535
1660
  # This method is equivalent to calling {Wx::GRID::Grid#make_cell_visible} and {Wx::GRID::Grid#set_grid_cursor} and so, as with the latter, a {Wx::GRID::EVT_GRID_SELECT_CELL} event is generated by it and the selected cell doesn't change if the event is vetoed.
1536
1661
  # @param coords [Array(Integer, Integer)]
1537
1662
  # @return [void]
1538
1663
  def go_to_cell(*args) end
1539
1664
 
1540
1665
  # Moves the grid cursor down by one row.
1666
+ #
1541
1667
  # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1542
1668
  # @param expandSelection [Boolean]
1543
1669
  # @return [Boolean]
1544
1670
  def move_cursor_down(expandSelection) end
1545
1671
 
1546
1672
  # Moves the grid cursor down in the current column such that it skips to the beginning or end of a block of non-empty cells.
1673
+ #
1547
1674
  # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1548
1675
  # @param expandSelection [Boolean]
1549
1676
  # @return [Boolean]
1550
1677
  def move_cursor_down_block(expandSelection) end
1551
1678
 
1552
1679
  # Moves the grid cursor left by one column.
1680
+ #
1553
1681
  # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1554
1682
  # @param expandSelection [Boolean]
1555
1683
  # @return [Boolean]
1556
1684
  def move_cursor_left(expandSelection) end
1557
1685
 
1558
1686
  # Moves the grid cursor left in the current row such that it skips to the beginning or end of a block of non-empty cells.
1687
+ #
1559
1688
  # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1560
1689
  # @param expandSelection [Boolean]
1561
1690
  # @return [Boolean]
1562
1691
  def move_cursor_left_block(expandSelection) end
1563
1692
 
1564
1693
  # Moves the grid cursor right by one column.
1694
+ #
1565
1695
  # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1566
1696
  # @param expandSelection [Boolean]
1567
1697
  # @return [Boolean]
1568
1698
  def move_cursor_right(expandSelection) end
1569
1699
 
1570
1700
  # Moves the grid cursor right in the current row such that it skips to the beginning or end of a block of non-empty cells.
1701
+ #
1571
1702
  # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1572
1703
  # @param expandSelection [Boolean]
1573
1704
  # @return [Boolean]
1574
1705
  def move_cursor_right_block(expandSelection) end
1575
1706
 
1576
1707
  # Moves the grid cursor up by one row.
1708
+ #
1577
1709
  # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1578
1710
  # @param expandSelection [Boolean]
1579
1711
  # @return [Boolean]
1580
1712
  def move_cursor_up(expandSelection) end
1581
1713
 
1582
1714
  # Moves the grid cursor up in the current column such that it skips to the beginning or end of a block of non-empty cells.
1715
+ #
1583
1716
  # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1584
1717
  # @param expandSelection [Boolean]
1585
1718
  # @return [Boolean]
@@ -1595,6 +1728,7 @@ module Wx::GRID
1595
1728
 
1596
1729
  # @overload set_grid_cursor(row, col)
1597
1730
  # Set the grid cursor to the specified cell.
1731
+ #
1598
1732
  # The grid cursor indicates the current cell and can be moved by the user using the arrow keys or the mouse.
1599
1733
  # Calling this function generates a {Wx::GRID::EVT_GRID_SELECT_CELL} event and if the event handler vetoes this event, the cursor is not moved.
1600
1734
  # This function doesn't make the target call visible, use {Wx::GRID::Grid#go_to_cell} to do this.
@@ -1603,6 +1737,7 @@ module Wx::GRID
1603
1737
  # @return [void]
1604
1738
  # @overload set_grid_cursor(coords)
1605
1739
  # Set the grid cursor to the specified cell.
1740
+ #
1606
1741
  # The grid cursor indicates the current cell and can be moved by the user using the arrow keys or the mouse.
1607
1742
  # Calling this function generates a {Wx::GRID::EVT_GRID_SELECT_CELL} event and if the event handler vetoes this event, the cursor is not moved.
1608
1743
  # This function doesn't make the target call visible, use {Wx::GRID::Grid#go_to_cell} to do this.
@@ -1612,10 +1747,11 @@ module Wx::GRID
1612
1747
  alias_method :grid_cursor=, :set_grid_cursor
1613
1748
 
1614
1749
  # Set the grid's behaviour when the user presses the TAB key.
1750
+ #
1615
1751
  # Pressing the TAB key moves the grid cursor right in the current row, if there is a cell at the right and, similarly, Shift-TAB moves the cursor to the left in the current row if it's not in the first column.
1616
1752
  # What happens if the cursor can't be moved because it it's already at the beginning or end of the row can be configured using this function, see {Wx::GRID::Grid::TabBehaviour} documentation for the detailed description.
1617
1753
  # IF none of the standard behaviours is appropriate, you can always handle {Wx::GRID::EVT_GRID_TABBING} event directly to implement a custom TAB-handling logic.
1618
- # @param behaviour [Wx::wxGrid::TabBehaviour]
1754
+ # @param behaviour [Wx::Grid::TabBehaviour]
1619
1755
  # @return [void]
1620
1756
  def set_tab_behaviour(behaviour) end
1621
1757
  alias_method :tab_behaviour=, :set_tab_behaviour
@@ -1640,24 +1776,42 @@ module Wx::GRID
1640
1776
  # @return [void]
1641
1777
  def deselect_cell(row, col) end
1642
1778
 
1779
+ # Returns a range of grid selection blocks.
1780
+ #
1781
+ # The returned range can be iterated over, e.g. with C++11 range-for loop:
1782
+ # ```
1783
+ # for ( const auto block: grid->GetSelectedBlocks() ) {
1784
+ # if ( block.Intersects(myBlock) )
1785
+ # break;
1786
+ # }
1787
+ # ```
1788
+ #
1789
+ # Notice that the blocks returned by this method are not ordered in any particular way and may overlap. For grids using rows or columns-only selection modes, {Wx::GRID::Grid#get_selected_row_blocks} or {Wx::GRID::Grid#get_selected_col_blocks} can be more convenient, as they return ordered and non-overlapping blocks.
1790
+ # @return [Array<Wx::GRID::GridBlockCoords>]
1791
+ def get_selected_blocks; end
1792
+ alias_method :selected_blocks, :get_selected_blocks
1793
+
1643
1794
  # Returns an ordered range of non-overlapping selected rows.
1795
+ #
1644
1796
  # For the grids using {Wx::GRID::Grid::GridSelectionModes::GridSelectRows} selection mode, returns the possibly empty vector containing the coordinates of non-overlapping selected row blocks in the natural order, i.e. from smallest to the biggest row indices.
1645
1797
  # To see the difference between this method and {Wx::GRID::Grid#get_selected_blocks}, consider the case when the user selects rows 2..4 in the grid and then also selects (using Ctrl/Shift keys) the rows 1..3. Iterating over the result of {Wx::GRID::Grid#get_selected_blocks} would yield two blocks directly corresponding to the users selection, while this method returns a vector with a single element corresponding to the rows 1..4.
1646
1798
  # This method returns empty vector for the other selection modes.
1647
1799
  # @see Wx::GRID::Grid#get_selected_blocks
1648
1800
  # @see Wx::GRID::Grid#get_selected_col_blocks
1649
- # @return [Array<Wx::GRID::GridBlockCoords]
1801
+ # @return [Array<Wx::GRID::GridBlockCoords>]
1650
1802
  def get_selected_row_blocks; end
1651
1803
  alias_method :selected_row_blocks, :get_selected_row_blocks
1652
1804
 
1653
1805
  # Returns an ordered range of non-overlapping selected columns.
1806
+ #
1654
1807
  # This method is symmetric to {Wx::GRID::Grid#get_selected_row_blocks}, but is useful only in {Wx::GRID::Grid::GridSelectionModes::GridSelectColumns} selection mode.
1655
1808
  # @see Wx::GRID::Grid#get_selected_blocks
1656
- # @return [Array<Wx::GRID::GridBlockCoords]
1809
+ # @return [Array<Wx::GRID::GridBlockCoords>]
1657
1810
  def get_selected_col_blocks; end
1658
1811
  alias_method :selected_col_blocks, :get_selected_col_blocks
1659
1812
 
1660
1813
  # Returns an array of individually selected cells.
1814
+ #
1661
1815
  # Notice that this array does not contain all the selected cells in general as it doesn't include the cells selected as part of column, row or block selection. You must use this method, {Wx::GRID::Grid#get_selected_cols}, {Wx::GRID::Grid#get_selected_rows} and {Wx::GRID::Grid#get_selection_block_top_left} and {Wx::GRID::Grid#get_selection_block_bottom_right} methods to obtain the entire selection in general.
1662
1816
  # Please notice this behaviour is by design and is needed in order to support grids of arbitrary size (when an entire column is selected in a grid with a million of columns, we don't want to create an array with a million of entries in this function, instead it returns an empty array and {Wx::GRID::Grid#get_selected_cols} returns an array containing one element).
1663
1817
  # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
@@ -1666,6 +1820,7 @@ module Wx::GRID
1666
1820
  alias_method :selected_cells, :get_selected_cells
1667
1821
 
1668
1822
  # Returns an array of selected columns.
1823
+ #
1669
1824
  # Please notice that this method alone is not sufficient to find all the selected columns as it contains only the columns which were individually selected but not those being part of the block selection or being selected in virtue of all of their cells being selected individually, please see {Wx::GRID::Grid#get_selected_cells} for more details.
1670
1825
  # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1671
1826
  # @return [Array<Integer>]
@@ -1673,6 +1828,7 @@ module Wx::GRID
1673
1828
  alias_method :selected_cols, :get_selected_cols
1674
1829
 
1675
1830
  # Returns an array of selected rows.
1831
+ #
1676
1832
  # Please notice that this method alone is not sufficient to find all the selected rows as it contains only the rows which were individually selected but not those being part of the block selection or being selected in virtue of all of their cells being selected individually, please see {Wx::GRID::Grid#get_selected_cells} for more details.
1677
1833
  # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1678
1834
  # @return [Array<Integer>]
@@ -1685,6 +1841,7 @@ module Wx::GRID
1685
1841
  alias_method :selection_background, :get_selection_background
1686
1842
 
1687
1843
  # Returns an array of the bottom right corners of blocks of selected cells.
1844
+ #
1688
1845
  # Please see {Wx::GRID::Grid#get_selected_cells} for more information about the selection representation in {Wx::GRID::Grid}.
1689
1846
  # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1690
1847
  # @see Wx::GRID::Grid#get_selection_block_top_left
@@ -1693,6 +1850,7 @@ module Wx::GRID
1693
1850
  alias_method :selection_block_bottom_right, :get_selection_block_bottom_right
1694
1851
 
1695
1852
  # Returns an array of the top left corners of blocks of selected cells.
1853
+ #
1696
1854
  # Please see {Wx::GRID::Grid#get_selected_cells} for more information about the selection representation in {Wx::GRID::Grid}.
1697
1855
  # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1698
1856
  # @see Wx::GRID::Grid#get_selection_block_bottom_right
@@ -1707,8 +1865,9 @@ module Wx::GRID
1707
1865
 
1708
1866
  # Returns the current selection mode.
1709
1867
  #
1868
+ #
1710
1869
  # @see Wx::GRID::Grid#set_selection_mode.
1711
- # @return [Wx::wxGrid::GridSelectionModes]
1870
+ # @return [Wx::Grid::GridSelectionModes]
1712
1871
  def get_selection_mode; end
1713
1872
  alias_method :selection_mode, :get_selection_mode
1714
1873
 
@@ -1729,6 +1888,7 @@ module Wx::GRID
1729
1888
  def select_all; end
1730
1889
 
1731
1890
  # Selects a rectangular block of cells.
1891
+ #
1732
1892
  # If addToSelected is false then any existing selection will be deselected; if true the column will be added to the existing selection.
1733
1893
  # @param topRow [Integer]
1734
1894
  # @param leftCol [Integer]
@@ -1739,6 +1899,7 @@ module Wx::GRID
1739
1899
  def select_block(topRow, leftCol, bottomRow, rightCol, addToSelected=false) end
1740
1900
 
1741
1901
  # Selects the specified column.
1902
+ #
1742
1903
  # If addToSelected is false then any existing selection will be deselected; if true the column will be added to the existing selection.
1743
1904
  # This method won't select anything if the current selection mode is {Wx::GRID::Grid::GridSelectionModes::GridSelectRows}.
1744
1905
  # @param col [Integer]
@@ -1747,6 +1908,7 @@ module Wx::GRID
1747
1908
  def select_col(col, addToSelected=false) end
1748
1909
 
1749
1910
  # Selects the specified row.
1911
+ #
1750
1912
  # If addToSelected is false then any existing selection will be deselected; if true the row will be added to the existing selection.
1751
1913
  # This method won't select anything if the current selection mode is {Wx::GRID::Grid::GridSelectionModes::GridSelectColumns}.
1752
1914
  # @param row [Integer]
@@ -1767,13 +1929,15 @@ module Wx::GRID
1767
1929
  alias_method :selection_foreground=, :set_selection_foreground
1768
1930
 
1769
1931
  # Set the selection behaviour of the grid.
1932
+ #
1770
1933
  # The existing selection is converted to conform to the new mode if possible and discarded otherwise (e.g. any individual selected cells are deselected if the new mode allows only the selection of the entire rows or columns).
1771
- # @param selmode [Wx::wxGrid::GridSelectionModes]
1934
+ # @param selmode [Wx::Grid::GridSelectionModes]
1772
1935
  # @return [void]
1773
1936
  def set_selection_mode(selmode) end
1774
1937
  alias_method :selection_mode=, :set_selection_mode
1775
1938
 
1776
1939
  # Returns the number of pixels per horizontal scroll increment.
1940
+ #
1777
1941
  # The default is 15.
1778
1942
  # @see Wx::GRID::Grid#get_scroll_line_y
1779
1943
  # @see Wx::GRID::Grid#set_scroll_line_x
@@ -1783,6 +1947,7 @@ module Wx::GRID
1783
1947
  alias_method :scroll_line_x, :get_scroll_line_x
1784
1948
 
1785
1949
  # Returns the number of pixels per vertical scroll increment.
1950
+ #
1786
1951
  # The default is 15.
1787
1952
  # @see Wx::GRID::Grid#get_scroll_line_x
1788
1953
  # @see Wx::GRID::Grid#set_scroll_line_x
@@ -1792,6 +1957,7 @@ module Wx::GRID
1792
1957
  alias_method :scroll_line_y, :get_scroll_line_y
1793
1958
 
1794
1959
  # Returns true if a cell is either entirely or at least partially visible in the grid window.
1960
+ #
1795
1961
  # By default, the cell must be entirely visible for this function to return true but if wholeCellVisible is false, the function returns true even if the cell is only partially visible.
1796
1962
  # @param row [Integer]
1797
1963
  # @param col [Integer]
@@ -1801,6 +1967,7 @@ module Wx::GRID
1801
1967
  alias_method :visible?, :is_visible
1802
1968
 
1803
1969
  # Brings the specified cell into the visible grid cell area with minimal scrolling.
1970
+ #
1804
1971
  # Does nothing if the cell is already visible.
1805
1972
  # @param row [Integer]
1806
1973
  # @param col [Integer]
@@ -1808,18 +1975,21 @@ module Wx::GRID
1808
1975
  def make_cell_visible(row, col) end
1809
1976
 
1810
1977
  # Returns the topmost row of the current visible area.
1978
+ #
1811
1979
  # Returns -1 if the grid doesn't have any rows.
1812
1980
  # @return [Integer]
1813
1981
  def get_first_fully_visible_row; end
1814
1982
  alias_method :first_fully_visible_row, :get_first_fully_visible_row
1815
1983
 
1816
1984
  # Returns the leftmost column of the current visible area.
1985
+ #
1817
1986
  # Returns -1 if the grid doesn't have any columns.
1818
1987
  # @return [Integer]
1819
1988
  def get_first_fully_visible_column; end
1820
1989
  alias_method :first_fully_visible_column, :get_first_fully_visible_column
1821
1990
 
1822
1991
  # Sets the number of pixels per horizontal scroll increment.
1992
+ #
1823
1993
  # The default is 15.
1824
1994
  # @see Wx::GRID::Grid#get_scroll_line_x
1825
1995
  # @see Wx::GRID::Grid#get_scroll_line_y
@@ -1830,6 +2000,7 @@ module Wx::GRID
1830
2000
  alias_method :scroll_line_x=, :set_scroll_line_x
1831
2001
 
1832
2002
  # Sets the number of pixels per vertical scroll increment.
2003
+ #
1833
2004
  # The default is 15.
1834
2005
  # @see Wx::GRID::Grid#get_scroll_line_x
1835
2006
  # @see Wx::GRID::Grid#get_scroll_line_y
@@ -1840,6 +2011,7 @@ module Wx::GRID
1840
2011
  alias_method :scroll_line_y=, :set_scroll_line_y
1841
2012
 
1842
2013
  # Convert grid cell coordinates to grid window pixel coordinates.
2014
+ #
1843
2015
  # This function returns the rectangle that encloses the block of cells limited by topLeft and bottomRight cell in device coords and clipped to the client size of the grid window.
1844
2016
  # @see Wx::GRID::Grid#cell_to_rect
1845
2017
  # @param topLeft [Array(Integer, Integer)]
@@ -1850,6 +2022,7 @@ module Wx::GRID
1850
2022
 
1851
2023
  # Return the rectangle corresponding to the grid cell's size and position in logical coordinates.
1852
2024
  #
2025
+ #
1853
2026
  # @see Wx::GRID::Grid#block_to_device_rect
1854
2027
  # @param row [Integer]
1855
2028
  # @param col [Integer]
@@ -1858,6 +2031,7 @@ module Wx::GRID
1858
2031
 
1859
2032
  # @overload cell_to_grid_window(row, col)
1860
2033
  # Returns the grid window that contains the cell.
2034
+ #
1861
2035
  # In a grid without frozen rows or columns (see {Wx::GRID::Grid#freeze_to}), this will always return the same window as {Wx::GRID::Grid#get_grid_window}, however if some parts of the grid are frozen, this function returns the window containing the given cell.
1862
2036
  # @param row [Integer]
1863
2037
  # @param col [Integer]
@@ -1898,6 +2072,7 @@ module Wx::GRID
1898
2072
  def calc_grid_window_scrolled_position(pt, gridWindow) end
1899
2073
 
1900
2074
  # Returns the column at the given pixel position depending on the window.
2075
+ #
1901
2076
  # The column index or {Wx::NOT_FOUND}.
1902
2077
  # @param x [Integer] The x position to evaluate.
1903
2078
  # @param clipToMinMax [Boolean] If true, rather than returning {Wx::NOT_FOUND}, it returns either the first or last column depending on whether x is too far to the left or right respectively.
@@ -1906,6 +2081,7 @@ module Wx::GRID
1906
2081
  def x_to_col(x, clipToMinMax=false, gridWindow=nil) end
1907
2082
 
1908
2083
  # Returns the column whose right hand edge is close to the given logical x position.
2084
+ #
1909
2085
  # If no column edge is near to this position {Wx::NOT_FOUND} is returned.
1910
2086
  # @param x [Integer]
1911
2087
  # @return [Integer]
@@ -1913,6 +2089,7 @@ module Wx::GRID
1913
2089
 
1914
2090
  # @overload xy_to_cell(x, y, gridWindow=nil)
1915
2091
  # Translates logical pixel coordinates to the grid cell coordinates.
2092
+ #
1916
2093
  # Notice that this function expects logical coordinates on input so if you use this function in a mouse event handler you need to translate the mouse position, which is expressed in device coordinates, to logical ones.
1917
2094
  # The parameter gridWindow is new since wxWidgets 3.1.3. If it is specified, i.e. non-NULL, the coordinates must be in this window coordinate system and only the cells of this window are considered, i.e. the function returns {Wx::NOT_FOUND} if the coordinates are out of bounds.
1918
2095
  # If gridWindow is NULL, coordinates are relative to the main grid window and all cells are considered.
@@ -1930,12 +2107,14 @@ module Wx::GRID
1930
2107
  def xy_to_cell(*args) end
1931
2108
 
1932
2109
  # Returns the row whose bottom edge is close to the given logical y position.
2110
+ #
1933
2111
  # If no row edge is near to this position {Wx::NOT_FOUND} is returned.
1934
2112
  # @param y [Integer]
1935
2113
  # @return [Integer]
1936
2114
  def y_to_edge_of_row(y) end
1937
2115
 
1938
2116
  # Returns the grid row that corresponds to the logical y coordinate.
2117
+ #
1939
2118
  # The parameter gridWindow is new since wxWidgets 3.1.3. If it is specified, i.e. non-NULL, only the cells of this window are considered, i.e. the function returns {Wx::NOT_FOUND} if y is out of bounds.
1940
2119
  # If gridWindow is NULL, the function returns {Wx::NOT_FOUND} only if there is no row at all at the y position.
1941
2120
  # @param y [Integer]
@@ -1945,6 +2124,7 @@ module Wx::GRID
1945
2124
  def y_to_row(y, clipToMinMax=false, gridWindow=nil) end
1946
2125
 
1947
2126
  # Appends one or more new columns to the right of the grid.
2127
+ #
1948
2128
  # The updateLabels argument is not used at present. If you are using a derived grid table class you will need to override {Wx::GRID::GridTableBase#append_cols}. See {Wx::GRID::Grid#insert_cols} for further information.
1949
2129
  # true on success or false if appending columns failed.
1950
2130
  # @param numCols [Integer]
@@ -1953,6 +2133,7 @@ module Wx::GRID
1953
2133
  def append_cols(numCols=1, updateLabels=true) end
1954
2134
 
1955
2135
  # Appends one or more new rows to the bottom of the grid.
2136
+ #
1956
2137
  # The updateLabels argument is not used at present. If you are using a derived grid table class you will need to override {Wx::GRID::GridTableBase#append_rows}. See {Wx::GRID::Grid#insert_rows} for further information.
1957
2138
  # true on success or false if appending rows failed.
1958
2139
  # @param numRows [Integer]
@@ -1961,6 +2142,7 @@ module Wx::GRID
1961
2142
  def append_rows(numRows=1, updateLabels=true) end
1962
2143
 
1963
2144
  # Return true if the horizontal grid lines stop at the last column boundary or false if they continue to the end of the window.
2145
+ #
1964
2146
  # The default is to clip grid lines.
1965
2147
  # @see Wx::GRID::Grid#clip_horz_grid_lines
1966
2148
  # @see Wx::GRID::Grid#are_vert_grid_lines_clipped
@@ -1968,6 +2150,7 @@ module Wx::GRID
1968
2150
  def are_horz_grid_lines_clipped; end
1969
2151
 
1970
2152
  # Return true if the vertical grid lines stop at the last row boundary or false if they continue to the end of the window.
2153
+ #
1971
2154
  # The default is to clip grid lines.
1972
2155
  # @see Wx::GRID::Grid#clip_vert_grid_lines
1973
2156
  # @see Wx::GRID::Grid#are_horz_grid_lines_clipped
@@ -1975,17 +2158,20 @@ module Wx::GRID
1975
2158
  def are_vert_grid_lines_clipped; end
1976
2159
 
1977
2160
  # Increments the grid's batch count.
2161
+ #
1978
2162
  # When the count is greater than zero repainting of the grid is suppressed. Each call to BeginBatch must be matched by a later call to {Wx::GRID::Grid#end_batch}. Code that does a lot of grid modification can be enclosed between {Wx::GRID::Grid#begin_batch} and {Wx::GRID::Grid#end_batch} calls to avoid screen flicker. The final {Wx::GRID::Grid#end_batch} call will cause the grid to be repainted.
1979
2163
  # Notice that you should use {Wx::GridUpdateLocker} which ensures that there is always a matching {Wx::GRID::Grid#end_batch} call for this {Wx::GRID::Grid#begin_batch} if possible instead of calling this method directly.
1980
2164
  # @return [void]
1981
2165
  def begin_batch; end
1982
2166
 
1983
2167
  # Clears all data in the underlying grid table and repaints the grid.
2168
+ #
1984
2169
  # The table is not deleted by this function. If you are using a derived table class then you need to override {Wx::GRID::GridTableBase#clear} for this function to have any effect.
1985
2170
  # @return [void]
1986
2171
  def clear_grid; end
1987
2172
 
1988
2173
  # Change whether the horizontal grid lines are clipped by the end of the last column.
2174
+ #
1989
2175
  # By default the grid lines are not drawn beyond the end of the last column but after calling this function with clip set to false they will be drawn across the entire grid window.
1990
2176
  # @see Wx::GRID::Grid#are_horz_grid_lines_clipped
1991
2177
  # @see Wx::GRID::Grid#clip_vert_grid_lines
@@ -1994,6 +2180,7 @@ module Wx::GRID
1994
2180
  def clip_horz_grid_lines(clip) end
1995
2181
 
1996
2182
  # Change whether the vertical grid lines are clipped by the end of the last row.
2183
+ #
1997
2184
  # By default the grid lines are not drawn beyond the end of the last row but after calling this function with clip set to false they will be drawn across the entire grid window.
1998
2185
  # @see Wx::GRID::Grid#are_vert_grid_lines_clipped
1999
2186
  # @see Wx::GRID::Grid#clip_horz_grid_lines
@@ -2002,6 +2189,7 @@ module Wx::GRID
2002
2189
  def clip_vert_grid_lines(clip) end
2003
2190
 
2004
2191
  # Deletes one or more columns from a grid starting at the specified position.
2192
+ #
2005
2193
  # The updateLabels argument is not used at present. If you are using a derived grid table class you will need to override {Wx::GRID::GridTableBase#delete_cols}. See {Wx::GRID::Grid#insert_cols} for further information.
2006
2194
  # true on success or false if deleting columns failed.
2007
2195
  # @param pos [Integer]
@@ -2011,6 +2199,7 @@ module Wx::GRID
2011
2199
  def delete_cols(pos=0, numCols=1, updateLabels=true) end
2012
2200
 
2013
2201
  # Deletes one or more rows from a grid starting at the specified position.
2202
+ #
2014
2203
  # The updateLabels argument is not used at present. If you are using a derived grid table class you will need to override {Wx::GRID::GridTableBase#delete_rows}. See {Wx::GRID::Grid#insert_rows} for further information.
2015
2204
  # true on success or false if deleting rows failed.
2016
2205
  # @param pos [Integer]
@@ -2021,6 +2210,7 @@ module Wx::GRID
2021
2210
 
2022
2211
  # @overload freeze_to(row, col)
2023
2212
  # Sets or resets the frozen columns and rows.
2213
+ #
2024
2214
  # true on success or false if it failed.
2025
2215
  #
2026
2216
  # Note that this method doesn't do anything, and returns false, if any of the following conditions are true:
@@ -2041,6 +2231,7 @@ module Wx::GRID
2041
2231
  def freeze_to(*args) end
2042
2232
 
2043
2233
  # Decrements the grid's batch count.
2234
+ #
2044
2235
  # When the count is greater than zero repainting of the grid is suppressed. Each previous call to {Wx::GRID::Grid#begin_batch} must be matched by a later call to {Wx::GRID::Grid#end_batch}. Code that does a lot of grid modification can be enclosed between {Wx::GRID::Grid#begin_batch} and {Wx::GRID::Grid#end_batch} calls to avoid screen flicker. The final {Wx::GRID::Grid#end_batch} will cause the grid to be repainted.
2045
2236
  # @see Wx::GridUpdateLocker
2046
2237
  # @return [void]
@@ -2051,29 +2242,34 @@ module Wx::GRID
2051
2242
  def fit; end
2052
2243
 
2053
2244
  # Causes immediate repainting of the grid.
2245
+ #
2054
2246
  # Use this instead of the usual {Wx::Window#refresh}.
2055
2247
  # @return [void]
2056
2248
  def force_refresh; end
2057
2249
 
2058
2250
  # Returns the number of times that {Wx::GRID::Grid#begin_batch} has been called without (yet) matching calls to {Wx::GRID::Grid#end_batch}.
2251
+ #
2059
2252
  # While the grid's batch count is greater than zero the display will not be updated.
2060
2253
  # @return [Integer]
2061
2254
  def get_batch_count; end
2062
2255
  alias_method :batch_count, :get_batch_count
2063
2256
 
2064
2257
  # Returns the total number of grid columns.
2258
+ #
2065
2259
  # This is the same as the number of columns in the underlying grid table.
2066
2260
  # @return [Integer]
2067
2261
  def get_number_cols; end
2068
2262
  alias_method :number_cols, :get_number_cols
2069
2263
 
2070
2264
  # Returns the total number of grid rows.
2265
+ #
2071
2266
  # This is the same as the number of rows in the underlying grid table.
2072
2267
  # @return [Integer]
2073
2268
  def get_number_rows; end
2074
2269
  alias_method :number_rows, :get_number_rows
2075
2270
 
2076
2271
  # Returns the number of frozen grid columns.
2272
+ #
2077
2273
  # If there are no frozen columns, returns 0.
2078
2274
  # @see Wx::GRID::Grid#freeze_to
2079
2275
  # @return [Integer]
@@ -2081,6 +2277,7 @@ module Wx::GRID
2081
2277
  alias_method :number_frozen_cols, :get_number_frozen_cols
2082
2278
 
2083
2279
  # Returns the number of frozen grid rows.
2280
+ #
2084
2281
  # If there are no frozen rows, returns 0.
2085
2282
  # @see Wx::GRID::Grid#freeze_to
2086
2283
  # @return [Integer]
@@ -2088,6 +2285,7 @@ module Wx::GRID
2088
2285
  alias_method :number_frozen_rows, :get_number_frozen_rows
2089
2286
 
2090
2287
  # Returns the attribute for the given cell creating one if necessary.
2288
+ #
2091
2289
  # If the cell already has an attribute, it is returned. Otherwise a new attribute is created, associated with the cell and returned. In any case the caller must call DecRef() on the returned pointer.
2092
2290
  # Prefer to use {Wx::GRID::Grid#get_or_create_cell_attr_ptr} to avoid the need to call DecRef() on the returned pointer.
2093
2291
  # This function may only be called if {Wx::GRID::Grid#can_have_attributes} returns true.
@@ -2098,12 +2296,14 @@ module Wx::GRID
2098
2296
  alias_method :or_create_cell_attr, :get_or_create_cell_attr
2099
2297
 
2100
2298
  # Returns a base pointer to the current table object.
2299
+ #
2101
2300
  # The returned pointer is still owned by the grid.
2102
2301
  # @return [Wx::GRID::GridTableBase]
2103
2302
  def get_table; end
2104
2303
  alias_method :table, :get_table
2105
2304
 
2106
2305
  # Inserts one or more new columns into a grid with the first new column at the specified position.
2306
+ #
2107
2307
  # Notice that inserting the columns in the grid requires grid table cooperation: when this method is called, grid object begins by requesting the underlying grid table to insert new columns. If this is successful the table notifies the grid and the grid updates the display. For a default grid (one where you have called {Wx::GRID::Grid#create_grid}) this process is automatic. If you are using a custom grid table (specified with {Wx::GRID::Grid#set_table} or {Wx::GRID::Grid#assign_table}) then you must override {Wx::GRID::GridTableBase#insert_cols} in your derived table class.
2108
2308
  #
2109
2309
  # true if the columns were successfully inserted, false if an error occurred (most likely the table couldn't be updated).
@@ -2114,6 +2314,7 @@ module Wx::GRID
2114
2314
  def insert_cols(pos=0, numCols=1, updateLabels=true) end
2115
2315
 
2116
2316
  # Inserts one or more new rows into a grid with the first new row at the specified position.
2317
+ #
2117
2318
  # Notice that you must implement {Wx::GRID::GridTableBase#insert_rows} if you use a grid with a custom table, please see {Wx::GRID::Grid#insert_cols} for more information.
2118
2319
  #
2119
2320
  # true if the rows were successfully inserted, false if an error occurred (most likely the table couldn't be updated).
@@ -2124,6 +2325,7 @@ module Wx::GRID
2124
2325
  def insert_rows(pos=0, numRows=1, updateLabels=true) end
2125
2326
 
2126
2327
  # Invalidates the cached attribute for the given cell.
2328
+ #
2127
2329
  # For efficiency reasons, {Wx::GRID::Grid} may cache the recently used attributes (currently it caches only the single most recently used one, in fact) which can result in the cell appearance not being refreshed even when the attribute returned by your custom {Wx::GridCellAttrProvider}-derived class has changed. To force the grid to refresh the cell attribute, this function may be used. Notice that calling it will not result in actually redrawing the cell, you still need to call {Wx::Window#refresh_rect} to invalidate the area occupied by the cell in the window to do this. Also note that you don't need to call this function if you store the attributes in {Wx::GRID::Grid} itself, i.e. use its {Wx::GRID::Grid#set_attr} and similar methods, it is only useful when using a separate custom attributes provider.
2128
2330
  # @param row [Integer] The row of the cell whose attribute needs to be queried again.
2129
2331
  # @param col [Integer] The column of the cell whose attribute needs to be queried again.
@@ -2132,6 +2334,7 @@ module Wx::GRID
2132
2334
 
2133
2335
  # @overload refresh_block(topLeft, bottomRight)
2134
2336
  # Redraw all the cells in the given block.
2337
+ #
2135
2338
  # Refresh the block of cells with the given corners.
2136
2339
  # If the bottom right corner coordinates are invalid, i.e. set to <code>-1</code>, the top left corner coordinates are used for it, i.e. just a single cell is refreshed. If the top left corner coordinates are invalid as well, the function simply returns without doing anything. Note, however, that both coordinates need to be valid or invalid simultaneously, i.e. setting the top row to <code>-1</code> but using a valid value for the left column is unsupported and would result in an assertion failure.
2137
2340
  # @param topLeft [Array(Integer, Integer)]
@@ -2147,6 +2350,7 @@ module Wx::GRID
2147
2350
  def refresh_block(*args) end
2148
2351
 
2149
2352
  # Draws part or all of a {Wx::GRID::Grid} on a {Wx::DC} for printing or display.
2353
+ #
2150
2354
  # Pagination can be accomplished by using sequential {Wx::GRID::Grid#render} calls with appropriate values in {Wx::GridCellCoords} topLeft and bottomRight.
2151
2355
  # @param dc [Wx::DC] The {Wx::DC} to be drawn on.
2152
2356
  # @param pos [Array(Integer, Integer), Wx::Point] The position on the {Wx::DC} where rendering should begin. If not specified drawing will begin at the {Wx::DC} MaxX() and MaxY().
@@ -2158,6 +2362,7 @@ module Wx::GRID
2158
2362
  def render(dc, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, topLeft=(Wx::GridCellCoords.new(-1, -1)), bottomRight=(Wx::GridCellCoords.new(-1, -1)), style=Wx::GRID::GridRenderStyle::GRID_DRAW_DEFAULT) end
2159
2363
 
2160
2364
  # Sets the cell attributes for the specified cell.
2365
+ #
2161
2366
  # The grid takes ownership of the attribute pointer.
2162
2367
  # See the {Wx::GRID::GridCellAttr} class for more information about controlling cell attributes.
2163
2368
  # @param row [Integer]
@@ -2167,6 +2372,7 @@ module Wx::GRID
2167
2372
  def set_attr(row, col, attr) end
2168
2373
 
2169
2374
  # Sets the cell attributes for all cells in the specified column.
2375
+ #
2170
2376
  # For more information about controlling grid cell attributes see the {Wx::GRID::GridCellAttr} cell attribute class and the wxGrid Overview.
2171
2377
  # @param col [Integer]
2172
2378
  # @param attr [Wx::GRID::GridCellAttr]
@@ -2174,6 +2380,7 @@ module Wx::GRID
2174
2380
  def set_col_attr(col, attr) end
2175
2381
 
2176
2382
  # Sets the extra margins used around the grid area.
2383
+ #
2177
2384
  # A grid may occupy more space than needed for its data display and this function allows setting how big this extra space is
2178
2385
  # @param extraWidth [Integer]
2179
2386
  # @param extraHeight [Integer]
@@ -2181,6 +2388,7 @@ module Wx::GRID
2181
2388
  def set_margins(extraWidth, extraHeight) end
2182
2389
 
2183
2390
  # Sets the cell attributes for all cells in the specified row.
2391
+ #
2184
2392
  # The grid takes ownership of the attribute pointer.
2185
2393
  # See the {Wx::GRID::GridCellAttr} class for more information about controlling cell attributes.
2186
2394
  # @param row [Integer]
@@ -2189,6 +2397,7 @@ module Wx::GRID
2189
2397
  def set_row_attr(row, attr) end
2190
2398
 
2191
2399
  # Appends one or more new columns to the right of the grid.
2400
+ #
2192
2401
  # The updateLabels argument is not used at present. If you are using a derived grid table class you will need to override {Wx::GRID::GridTableBase#append_cols}. See {Wx::GRID::Grid#insert_cols} for further information.
2193
2402
  # true on success or false if appending columns failed.
2194
2403
  # @param reg [Wx::Region]
@@ -2197,6 +2406,7 @@ module Wx::GRID
2197
2406
  def calc_row_labels_exposed(reg, gridWindow=nil) end
2198
2407
 
2199
2408
  # Appends one or more new columns to the right of the grid.
2409
+ #
2200
2410
  # The updateLabels argument is not used at present. If you are using a derived grid table class you will need to override {Wx::GRID::GridTableBase#append_cols}. See {Wx::GRID::Grid#insert_cols} for further information.
2201
2411
  # true on success or false if appending columns failed.
2202
2412
  # @param reg [Wx::Region]
@@ -2205,6 +2415,7 @@ module Wx::GRID
2205
2415
  def calc_col_labels_exposed(reg, gridWindow=nil) end
2206
2416
 
2207
2417
  # Appends one or more new columns to the right of the grid.
2418
+ #
2208
2419
  # The updateLabels argument is not used at present. If you are using a derived grid table class you will need to override {Wx::GRID::GridTableBase#append_cols}. See {Wx::GRID::Grid#insert_cols} for further information.
2209
2420
  # true on success or false if appending columns failed.
2210
2421
  # @param reg [Wx::Region]
@@ -2213,6 +2424,7 @@ module Wx::GRID
2213
2424
  def calc_cells_exposed(reg, gridWindow=nil) end
2214
2425
 
2215
2426
  # Return the column in which the sorting indicator is currently displayed.
2427
+ #
2216
2428
  # Returns {Wx::NOT_FOUND} if sorting indicator is not currently displayed at all.
2217
2429
  # @see Wx::GRID::Grid#set_sorting_column
2218
2430
  # @return [Integer]
@@ -2221,6 +2433,7 @@ module Wx::GRID
2221
2433
 
2222
2434
  # Return true if this column is currently used for sorting.
2223
2435
  #
2436
+ #
2224
2437
  # @see Wx::GRID::Grid#get_sorting_column
2225
2438
  # @param col [Integer]
2226
2439
  # @return [Boolean]
@@ -2228,6 +2441,7 @@ module Wx::GRID
2228
2441
  alias_method :sorting_by?, :is_sorting_by
2229
2442
 
2230
2443
  # Return true if the current sorting order is ascending or false if it is descending.
2444
+ #
2231
2445
  # It only makes sense to call this function if {Wx::GRID::Grid#get_sorting_column} returns a valid column index and not {Wx::NOT_FOUND}.
2232
2446
  # @see Wx::GRID::Grid#set_sorting_column
2233
2447
  # @return [Boolean]
@@ -2236,6 +2450,7 @@ module Wx::GRID
2236
2450
 
2237
2451
  # Set the column to display the sorting indicator in and its direction.
2238
2452
  #
2453
+ #
2239
2454
  # @see Wx::GRID::Grid#get_sorting_column
2240
2455
  # @see Wx::GRID::Grid#is_sort_order_ascending
2241
2456
  # @param col [Integer] The column to display the sorting indicator in or {Wx::NOT_FOUND} to remove any currently displayed sorting indicator.
@@ -2245,41 +2460,48 @@ module Wx::GRID
2245
2460
  alias_method :sorting_column=, :set_sorting_column
2246
2461
 
2247
2462
  # Remove any currently shown sorting indicator.
2463
+ #
2248
2464
  # This is equivalent to calling {Wx::GRID::Grid#set_sorting_column} with {Wx::NOT_FOUND} first argument.
2249
2465
  # @return [void]
2250
2466
  def unset_sorting_column; end
2251
2467
 
2252
2468
  # Return the main grid window containing the grid cells.
2469
+ #
2253
2470
  # This window is always shown.
2254
2471
  # @return [Wx::Window]
2255
2472
  def get_grid_window; end
2256
2473
  alias_method :grid_window, :get_grid_window
2257
2474
 
2258
2475
  # Return the corner grid window containing frozen cells.
2476
+ #
2259
2477
  # This window is shown only when there are frozen rows and columns.
2260
2478
  # @return [Wx::Window]
2261
2479
  def get_frozen_corner_grid_window; end
2262
2480
  alias_method :frozen_corner_grid_window, :get_frozen_corner_grid_window
2263
2481
 
2264
2482
  # Return the rows grid window containing row frozen cells.
2483
+ #
2265
2484
  # This window is shown only when there are frozen rows.
2266
2485
  # @return [Wx::Window]
2267
2486
  def get_frozen_row_grid_window; end
2268
2487
  alias_method :frozen_row_grid_window, :get_frozen_row_grid_window
2269
2488
 
2270
2489
  # Return the columns grid window containing column frozen cells.
2490
+ #
2271
2491
  # This window is shown only when there are frozen columns.
2272
2492
  # @return [Wx::Window]
2273
2493
  def get_frozen_col_grid_window; end
2274
2494
  alias_method :frozen_col_grid_window, :get_frozen_col_grid_window
2275
2495
 
2276
2496
  # Return the row labels window.
2497
+ #
2277
2498
  # This window is not shown if the row labels were hidden using {Wx::GRID::Grid#hide_row_labels}.
2278
2499
  # @return [Wx::Window]
2279
2500
  def get_grid_row_label_window; end
2280
2501
  alias_method :grid_row_label_window, :get_grid_row_label_window
2281
2502
 
2282
2503
  # Return the column labels window.
2504
+ #
2283
2505
  # This window is not shown if the columns labels were hidden using {Wx::GRID::Grid#hide_col_labels}.
2284
2506
  # Depending on whether {Wx::GRID::Grid#use_native_col_header} was called or not this can be either a {Wx::HeaderCtrl} or a plain {Wx::Window}. This function returns a valid window pointer in either case but in the former case you can also use {Wx::GRID::Grid#get_grid_col_header} to access it if you need {Wx::HeaderCtrl}-specific functionality.
2285
2507
  # @return [Wx::Window]
@@ -2287,12 +2509,14 @@ module Wx::GRID
2287
2509
  alias_method :grid_col_label_window, :get_grid_col_label_window
2288
2510
 
2289
2511
  # Return the window in the top left grid corner.
2512
+ #
2290
2513
  # This window is shown only of both columns and row labels are shown and normally doesn't contain anything. Clicking on it is handled by {Wx::GRID::Grid} however and can be used to select the entire grid.
2291
2514
  # @return [Wx::Window]
2292
2515
  def get_grid_corner_label_window; end
2293
2516
  alias_method :grid_corner_label_window, :get_grid_corner_label_window
2294
2517
 
2295
2518
  # Return the header control used for column labels display.
2519
+ #
2296
2520
  # This function can only be called if {Wx::GRID::Grid#use_native_col_header} had been called.
2297
2521
  # @see Wx::GRID::Grid#is_using_native_header
2298
2522
  # @return [Wx::HeaderCtrl]
@@ -2391,14 +2615,17 @@ module Wx::GRID
2391
2615
  end # Grid
2392
2616
 
2393
2617
  # Represents coordinates of a block of cells in the grid.
2618
+ #
2394
2619
  # An object of this class contains coordinates of the left top and the bottom right corners of a block.
2395
2620
  #
2396
2621
  #
2397
2622
  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2623
+ # @wxrb_require USE_GRID
2398
2624
  class GridBlockCoords < ::Object
2399
2625
 
2400
2626
  # @overload initialize()
2401
2627
  # Default constructor initializes the object to invalid state.
2628
+ #
2402
2629
  # Initially the coordinates are invalid (-1) and so {Wx::GRID::GridBlockCoords#!()} for an uninitialized {Wx::GRID::GridBlockCoords} returns true.
2403
2630
  # @return [Wx::GRID::GridBlockCoords]
2404
2631
  # @overload initialize(topRow, leftCol, bottomRow, rightCol)
@@ -2469,6 +2696,7 @@ module Wx::GRID
2469
2696
  def canonicalize; end
2470
2697
 
2471
2698
  # Whether the blocks intersect.
2699
+ #
2472
2700
  # true, if the block intersects with the other, false, otherwise.
2473
2701
  # @param other [Wx::GRID::GridBlockCoords]
2474
2702
  # @return [Boolean]
@@ -2476,17 +2704,20 @@ module Wx::GRID
2476
2704
 
2477
2705
  # @overload contains(cell)
2478
2706
  # Check whether this block contains the given cell.
2707
+ #
2479
2708
  # true, if the block contains the cell, false otherwise.
2480
2709
  # @param cell [Array(Integer, Integer)]
2481
2710
  # @return [Boolean]
2482
2711
  # @overload contains(other)
2483
2712
  # Check whether this block contains another one.
2713
+ #
2484
2714
  # true if other is entirely contained within this block.
2485
2715
  # @param other [Wx::GRID::GridBlockCoords]
2486
2716
  # @return [Boolean]
2487
2717
  def contains(*args) end
2488
2718
 
2489
2719
  # Calculates the result blocks by subtracting the other block from this block.
2720
+ #
2490
2721
  # Up to 4 blocks. If block doesn't exist in the result, it has value of {Wx::GridNoBlockCoords}.
2491
2722
  # @param other [Wx::GRID::GridBlockCoords] The block to subtract from this block.
2492
2723
  # @param splitOrientation [Integer] The block splitting orientation (either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}).
@@ -2494,6 +2725,7 @@ module Wx::GRID
2494
2725
  def difference(other, splitOrientation) end
2495
2726
 
2496
2727
  # Calculates the symmetric difference of the blocks.
2728
+ #
2497
2729
  # Up to 4 blocks. If block doesn't exist in the result, it has value of {Wx::GridNoBlockCoords}.
2498
2730
  # @param other [Wx::GRID::GridBlockCoords] The block to subtract from this block.
2499
2731
  # @return [Wx::GRID::GridBlockDiffResult]
@@ -2507,23 +2739,26 @@ module Wx::GRID
2507
2739
  end # GridBlockCoords
2508
2740
 
2509
2741
  # The helper struct uses as a result type for difference functions of {Wx::GRID::GridBlockCoords} class.
2742
+ #
2510
2743
  # Parts can be uninitialized (equals to {Wx::GridNoBlockCoords}), that means that the corresponding part doesn't exists in the result.
2511
2744
  #
2512
2745
  #
2513
2746
  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2747
+ # @wxrb_require USE_GRID
2514
2748
  class GridBlockDiffResult < ::Object
2515
2749
 
2516
2750
  end # GridBlockDiffResult
2517
2751
 
2518
2752
  # {Wx::GRID::GridSizesInfo} stores information about sizes of all {Wx::GRID::Grid} rows or columns.
2753
+ #
2519
2754
  # It assumes that most of the rows or columns (which are both called elements here as the difference between them doesn't matter at this class level) have the default size and so stores it separately. And it uses a {Wx::HashMap} to store the sizes of all elements which have the non-default size.
2520
2755
  # This structure is particularly useful for serializing the sizes of all {Wx::GRID::Grid} elements at once.
2521
- # ===
2522
2756
  #
2523
2757
  # Category: Grid Related Classes
2524
2758
  #
2525
2759
  #
2526
2760
  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2761
+ # @wxrb_require USE_GRID
2527
2762
  class GridSizesInfo < ::Object
2528
2763
 
2529
2764
  # Default size.
@@ -2552,10 +2787,12 @@ module Wx::GRID
2552
2787
 
2553
2788
  # @overload initialize()
2554
2789
  # Default constructor.
2790
+ #
2555
2791
  # m_sizeDefault and m_customSizes must be initialized later.
2556
2792
  # @return [Wx::GRID::GridSizesInfo]
2557
2793
  # @overload initialize(defSize, allSizes)
2558
2794
  # Constructor.
2795
+ #
2559
2796
  # This constructor is used by {Wx::GRID::Grid#get_row_sizes} and GetColSizes() methods. User code will usually use the default constructor instead.
2560
2797
  # @param defSize [Integer] The default element size.
2561
2798
  # @param allSizes [Array<Integer>] Array containing the sizes of all elements, including those which have the default size.
@@ -2563,6 +2800,7 @@ module Wx::GRID
2563
2800
  def initialize(*args) end
2564
2801
 
2565
2802
  # Get the element size.
2803
+ #
2566
2804
  # The size for this element, using m_customSizes if pos is in it or m_sizeDefault otherwise.
2567
2805
  # @param pos [unsigned] The index of the element.
2568
2806
  # @return [Integer]
@@ -2572,6 +2810,7 @@ module Wx::GRID
2572
2810
  end # GridSizesInfo
2573
2811
 
2574
2812
  # Allows to specify the behaviour when the cell contents doesn't fit into its allotted space.
2813
+ #
2575
2814
  # Objects of this class are used with {Wx::GRID::GridCellAttr#set_fit_mode} and {Wx::GRID::Grid#set_default_cell_fit_mode} and {Wx::GRID::Grid#set_cell_fit_mode} functions and allow to specify what should happen if the cell contents doesn't fit into the available space. The possibilities are:
2576
2815
  #
2577
2816
  # - Overflow into the cell to the right if it is empty, or possibly several cells, if the cell contents still doesn't fit after overflowing into the immediately neighbouring cell.
@@ -2584,38 +2823,43 @@ module Wx::GRID
2584
2823
  # ```
2585
2824
  #
2586
2825
  # Objects of this class are created using static functions instead of constructors for better readability and can't be changed after creating them except by using the assignment operator.
2587
- # ===
2588
2826
  #
2589
2827
  # Category: Grid Related Classes
2590
2828
  #
2591
2829
  #
2592
2830
  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2831
+ # @wxrb_require USE_GRID
2593
2832
  class GridFitMode < ::Object
2594
2833
 
2595
2834
  # Default constructor creates an object not specifying any behaviour.
2835
+ #
2596
2836
  # This constructor is not very useful, use static methods {Wx::GRID::GridFitMode.clip} and {Wx::GRID::GridFitMode.overflow} below to create objects of this class instead.
2597
2837
  # @return [Wx::GRID::GridFitMode]
2598
2838
  def initialize; end
2599
2839
 
2600
2840
  # Return true if the object specifies some particular behaviour.
2841
+ #
2601
2842
  # This method returns false for default-constructed objects of this type only.
2602
2843
  # @return [Boolean]
2603
2844
  def is_specified; end
2604
2845
  alias_method :specified?, :is_specified
2605
2846
 
2606
2847
  # Return true if the object specifies clipping behaviour.
2848
+ #
2607
2849
  # This method returns true only for the objects returned by {Wx::GRID::GridFitMode.clip}.
2608
2850
  # @return [Boolean]
2609
2851
  def is_clip; end
2610
2852
  alias_method :clip?, :is_clip
2611
2853
 
2612
2854
  # Return true if the object specifies overflow behaviour.
2855
+ #
2613
2856
  # This method returns true only for the objects returned by {Wx::GRID::GridFitMode.overflow}.
2614
2857
  # @return [Boolean]
2615
2858
  def is_overflow; end
2616
2859
  alias_method :overflow?, :is_overflow
2617
2860
 
2618
2861
  # Return ellipsize mode, possibly {Wx::EllipsizeMode::ELLIPSIZE_NONE}.
2862
+ #
2619
2863
  # For the objects constructed using {Wx::GRID::GridFitMode.ellipsize}, the same ellipsization mode as was passed to it is returned. For all the other objects, {Wx::EllipsizeMode::ELLIPSIZE_NONE} is.
2620
2864
  # @return [Wx::EllipsizeMode]
2621
2865
  def get_ellipsize_mode; end