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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (646) hide show
  1. checksums.yaml +4 -4
  2. data/INSTALL.md +35 -29
  3. data/README.md +24 -15
  4. data/ext/wxbase32u_gcc_custom.dll +0 -0
  5. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  6. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  7. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  19. data/lib/wx/core/bitmap_combobox.rb +17 -21
  20. data/lib/wx/core/combobox.rb +13 -3
  21. data/lib/wx/core/controlwithitems.rb +40 -130
  22. data/lib/wx/core/enum.rb +17 -1
  23. data/lib/wx/core/event.rb +6 -1
  24. data/lib/wx/core/events/evt_list.rb +5 -4
  25. data/lib/wx/core/evthandler.rb +8 -2
  26. data/lib/wx/core/generic_validator.rb +312 -0
  27. data/lib/wx/core/listbox.rb +2 -2
  28. data/lib/wx/core/log.rb +1 -1
  29. data/lib/wx/core/owner_drawn_combobox.rb +45 -0
  30. data/lib/wx/core/size.rb +4 -0
  31. data/lib/wx/core/sizer.rb +1 -2
  32. data/lib/wx/core/standard_paths.rb +22 -0
  33. data/lib/wx/core/text_entry.rb +4 -1
  34. data/lib/wx/core/validator.rb +70 -5
  35. data/lib/wx/core/window.rb +3 -7
  36. data/lib/wx/doc/art_locator.rb +1 -0
  37. data/lib/wx/doc/comboctrl.rb +18 -0
  38. data/lib/wx/doc/controlwithitems.rb +16 -0
  39. data/lib/wx/doc/date_picker_ctrl.rb +23 -0
  40. data/lib/wx/doc/editable_listbox.rb +44 -0
  41. data/lib/wx/doc/enum.rb +15 -0
  42. data/lib/wx/doc/event.rb +12 -0
  43. data/lib/wx/doc/extra/12_client_data.md +89 -0
  44. data/lib/wx/doc/extra/13_validators.md +139 -0
  45. data/lib/wx/doc/gdi_common.rb +4 -0
  46. data/lib/wx/doc/gen/about_dialog_info.rb +25 -0
  47. data/lib/wx/doc/gen/accelerator.rb +7 -1
  48. data/lib/wx/doc/gen/accessible.rb +13 -0
  49. data/lib/wx/doc/gen/activity_indicator.rb +7 -0
  50. data/lib/wx/doc/gen/animation.rb +12 -0
  51. data/lib/wx/doc/gen/animation_ctrl.rb +10 -0
  52. data/lib/wx/doc/gen/any_button.rb +17 -1
  53. data/lib/wx/doc/gen/app.rb +35 -1
  54. data/lib/wx/doc/gen/app_traits.rb +38 -5
  55. data/lib/wx/doc/gen/art_provider.rb +14 -0
  56. data/lib/wx/doc/gen/aui/aui_dock_art.rb +12 -0
  57. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +1 -0
  58. data/lib/wx/doc/gen/aui/aui_manager.rb +24 -1
  59. data/lib/wx/doc/gen/aui/aui_manager_event.rb +9 -1
  60. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +3 -0
  61. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +2 -0
  62. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +3 -1
  63. data/lib/wx/doc/gen/aui/aui_notebook.rb +20 -2
  64. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +2 -1
  65. data/lib/wx/doc/gen/aui/aui_pane_info.rb +30 -1
  66. data/lib/wx/doc/gen/aui/aui_tab_art.rb +6 -0
  67. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +1 -0
  68. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +11 -0
  69. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +2 -0
  70. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +2 -1
  71. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +4 -0
  72. data/lib/wx/doc/gen/banner_window.rb +7 -0
  73. data/lib/wx/doc/gen/bitmap.rb +64 -3
  74. data/lib/wx/doc/gen/bitmap_button.rb +6 -1
  75. data/lib/wx/doc/gen/bitmap_combo_box.rb +9 -3
  76. data/lib/wx/doc/gen/book_ctrl_base.rb +17 -2
  77. data/lib/wx/doc/gen/book_ctrl_event.rb +3 -1
  78. data/lib/wx/doc/gen/box_sizer.rb +5 -0
  79. data/lib/wx/doc/gen/brush.rb +16 -1
  80. data/lib/wx/doc/gen/busy_info.rb +8 -0
  81. data/lib/wx/doc/gen/button.rb +11 -3
  82. data/lib/wx/doc/gen/calculate_layout_event.rb +4 -0
  83. data/lib/wx/doc/gen/calendar_ctrl.rb +22 -0
  84. data/lib/wx/doc/gen/calendar_date_attr.rb +1 -0
  85. data/lib/wx/doc/gen/calendar_event.rb +3 -1
  86. data/lib/wx/doc/gen/caret.rb +3 -0
  87. data/lib/wx/doc/gen/check_box.rb +10 -0
  88. data/lib/wx/doc/gen/check_list_box.rb +3 -0
  89. data/lib/wx/doc/gen/choice.rb +14 -2
  90. data/lib/wx/doc/gen/choicebook.rb +1 -0
  91. data/lib/wx/doc/gen/client_dc.rb +1 -0
  92. data/lib/wx/doc/gen/clipboard.rb +9 -0
  93. data/lib/wx/doc/gen/collapsible_pane.rb +3 -0
  94. data/lib/wx/doc/gen/collapsible_pane_event.rb +1 -0
  95. data/lib/wx/doc/gen/colour.rb +20 -0
  96. data/lib/wx/doc/gen/colour_dialog.rb +10 -0
  97. data/lib/wx/doc/gen/colour_picker_ctrl.rb +4 -0
  98. data/lib/wx/doc/gen/colour_picker_event.rb +1 -0
  99. data/lib/wx/doc/gen/combo_box.rb +20 -1
  100. data/lib/wx/doc/gen/combo_ctrl.rb +54 -295
  101. data/lib/wx/doc/gen/command_link_button.rb +8 -0
  102. data/lib/wx/doc/gen/context_help_button.rb +7 -1
  103. data/lib/wx/doc/gen/control.rb +12 -0
  104. data/lib/wx/doc/gen/control_with_items.rb +45 -9
  105. data/lib/wx/doc/gen/core.rb +2 -2
  106. data/lib/wx/doc/gen/cursor.rb +4 -0
  107. data/lib/wx/doc/gen/data_format.rb +1 -0
  108. data/lib/wx/doc/gen/data_object.rb +27 -5
  109. data/lib/wx/doc/gen/date_event.rb +2 -1
  110. data/lib/wx/doc/gen/date_picker_ctrl.rb +7 -1
  111. data/lib/wx/doc/gen/dc.rb +87 -3
  112. data/lib/wx/doc/gen/dial_up_event.rb +2 -0
  113. data/lib/wx/doc/gen/dial_up_manager.rb +12 -0
  114. data/lib/wx/doc/gen/dialog.rb +42 -3
  115. data/lib/wx/doc/gen/dir_dialog.rb +6 -1
  116. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -0
  117. data/lib/wx/doc/gen/dir_picker_ctrl.rb +5 -0
  118. data/lib/wx/doc/gen/drag_drop.rb +20 -0
  119. data/lib/wx/doc/gen/drag_image.rb +7 -0
  120. data/lib/wx/doc/gen/editable_list_box.rb +5 -3
  121. data/lib/wx/doc/gen/event.rb +26 -11
  122. data/lib/wx/doc/gen/event_blocker.rb +2 -1
  123. data/lib/wx/doc/gen/event_filter.rb +3 -0
  124. data/lib/wx/doc/gen/event_list.rb +4 -4
  125. data/lib/wx/doc/gen/events.rb +165 -26
  126. data/lib/wx/doc/gen/evt_handler.rb +40 -2
  127. data/lib/wx/doc/gen/ext_help_controller.rb +9 -0
  128. data/lib/wx/doc/gen/file_ctrl.rb +11 -2
  129. data/lib/wx/doc/gen/file_ctrl_event.rb +5 -1
  130. data/lib/wx/doc/gen/file_dialog.rb +13 -0
  131. data/lib/wx/doc/gen/file_dialog_custom_control.rb +12 -0
  132. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +9 -0
  133. data/lib/wx/doc/gen/file_dir_picker_event.rb +2 -1
  134. data/lib/wx/doc/gen/file_picker_ctrl.rb +4 -0
  135. data/lib/wx/doc/gen/file_system.rb +17 -1
  136. data/lib/wx/doc/gen/find_dialog_event.rb +2 -1
  137. data/lib/wx/doc/gen/find_replace_data.rb +1 -0
  138. data/lib/wx/doc/gen/find_replace_dialog.rb +3 -0
  139. data/lib/wx/doc/gen/flex_grid_sizer.rb +13 -0
  140. data/lib/wx/doc/gen/font.rb +75 -3
  141. data/lib/wx/doc/gen/font_data.rb +14 -0
  142. data/lib/wx/doc/gen/font_dialog.rb +6 -0
  143. data/lib/wx/doc/gen/font_picker_ctrl.rb +8 -0
  144. data/lib/wx/doc/gen/font_picker_event.rb +1 -0
  145. data/lib/wx/doc/gen/frame.rb +24 -7
  146. data/lib/wx/doc/gen/fs_file.rb +22 -0
  147. data/lib/wx/doc/gen/gauge.rb +8 -0
  148. data/lib/wx/doc/gen/gb_sizer_item.rb +5 -0
  149. data/lib/wx/doc/gen/gcdc.rb +2 -0
  150. data/lib/wx/doc/gen/gdi_common.rb +50 -0
  151. data/lib/wx/doc/gen/gdi_object.rb +1 -0
  152. data/lib/wx/doc/gen/generic_dir_ctrl.rb +7 -0
  153. data/lib/wx/doc/gen/graphics_context.rb +36 -7
  154. data/lib/wx/doc/gen/graphics_object.rb +24 -0
  155. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +2 -0
  156. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +14 -2
  157. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -0
  158. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +1 -0
  159. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +2 -0
  160. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -0
  161. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +2 -0
  162. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +1 -0
  163. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +1 -0
  164. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +1 -0
  165. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +9 -0
  166. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +1 -0
  167. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +1 -0
  168. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -0
  169. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +2 -0
  170. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +2 -0
  171. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -0
  172. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +6 -0
  173. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -0
  174. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -0
  175. data/lib/wx/doc/gen/grid/grid_ctrl.rb +229 -7
  176. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +4 -1
  177. data/lib/wx/doc/gen/grid/grid_event.rb +4 -1
  178. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +2 -1
  179. data/lib/wx/doc/gen/grid/grid_size_event.rb +2 -1
  180. data/lib/wx/doc/gen/grid/grid_string_table.rb +7 -0
  181. data/lib/wx/doc/gen/grid/grid_table_base.rb +27 -1
  182. data/lib/wx/doc/gen/grid/grid_table_message.rb +1 -0
  183. data/lib/wx/doc/gen/grid_bag_sizer.rb +24 -4
  184. data/lib/wx/doc/gen/grid_sizer.rb +11 -0
  185. data/lib/wx/doc/gen/gui_event_loop.rb +12 -0
  186. data/lib/wx/doc/gen/header_ctrl.rb +106 -0
  187. data/lib/wx/doc/gen/header_ctrl_event.rb +5 -1
  188. data/lib/wx/doc/gen/help_controller.rb +11 -0
  189. data/lib/wx/doc/gen/help_provider.rb +12 -3
  190. data/lib/wx/doc/gen/html/html_cell.rb +25 -0
  191. data/lib/wx/doc/gen/html/html_cell_event.rb +3 -1
  192. data/lib/wx/doc/gen/html/html_easy_printing.rb +13 -1
  193. data/lib/wx/doc/gen/html/html_help_controller.rb +18 -0
  194. data/lib/wx/doc/gen/html/html_help_data.rb +5 -0
  195. data/lib/wx/doc/gen/html/html_help_window.rb +8 -0
  196. data/lib/wx/doc/gen/html/html_link_event.rb +1 -0
  197. data/lib/wx/doc/gen/html/html_list_box.rb +49 -9
  198. data/lib/wx/doc/gen/html/html_printout.rb +7 -0
  199. data/lib/wx/doc/gen/html/html_window.rb +31 -0
  200. data/lib/wx/doc/gen/hyperlink_ctrl.rb +2 -1
  201. data/lib/wx/doc/gen/hyperlink_event.rb +1 -0
  202. data/lib/wx/doc/gen/icon.rb +19 -1
  203. data/lib/wx/doc/gen/icon_location.rb +1 -0
  204. data/lib/wx/doc/gen/image.rb +67 -10
  205. data/lib/wx/doc/gen/image_list.rb +12 -2
  206. data/lib/wx/doc/gen/info_bar.rb +12 -0
  207. data/lib/wx/doc/gen/keyboard_state.rb +11 -0
  208. data/lib/wx/doc/gen/list_box.rb +20 -3
  209. data/lib/wx/doc/gen/list_ctrl.rb +89 -0
  210. data/lib/wx/doc/gen/list_event.rb +11 -1
  211. data/lib/wx/doc/gen/listbook.rb +1 -0
  212. data/lib/wx/doc/gen/locale.rb +22 -0
  213. data/lib/wx/doc/gen/log.rb +42 -0
  214. data/lib/wx/doc/gen/mdi_client_window.rb +4 -1
  215. data/lib/wx/doc/gen/mdi_frame.rb +27 -4
  216. data/lib/wx/doc/gen/media_ctrl.rb +17 -0
  217. data/lib/wx/doc/gen/media_event.rb +2 -1
  218. data/lib/wx/doc/gen/memory_dc.rb +10 -0
  219. data/lib/wx/doc/gen/menu.rb +48 -7
  220. data/lib/wx/doc/gen/menu_bar.rb +32 -13
  221. data/lib/wx/doc/gen/menu_item.rb +26 -0
  222. data/lib/wx/doc/gen/message_dialog.rb +10 -0
  223. data/lib/wx/doc/gen/mini_frame.rb +5 -2
  224. data/lib/wx/doc/gen/mirror_dc.rb +1 -0
  225. data/lib/wx/doc/gen/mouse_state.rb +1 -0
  226. data/lib/wx/doc/gen/multi_choice_dialog.rb +3 -1
  227. data/lib/wx/doc/gen/non_owned_window.rb +3 -0
  228. data/lib/wx/doc/gen/notebook.rb +11 -1
  229. data/lib/wx/doc/gen/num_validator.rb +37 -0
  230. data/lib/wx/doc/gen/number_entry_dialog.rb +4 -0
  231. data/lib/wx/doc/gen/object.rb +3 -0
  232. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +340 -0
  233. data/lib/wx/doc/gen/paint_dc.rb +1 -0
  234. data/lib/wx/doc/gen/palette.rb +5 -0
  235. data/lib/wx/doc/gen/panel.rb +10 -2
  236. data/lib/wx/doc/gen/pen.rb +30 -1
  237. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +2 -1
  238. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +4 -1
  239. data/lib/wx/doc/gen/pg/pg_cell.rb +6 -1
  240. data/lib/wx/doc/gen/pg/pg_editor.rb +61 -15
  241. data/lib/wx/doc/gen/pg/pg_multi_button.rb +2 -0
  242. data/lib/wx/doc/gen/pg/pg_properties.rb +198 -81
  243. data/lib/wx/doc/gen/pg/pg_property.rb +129 -52
  244. data/lib/wx/doc/gen/pg/pg_validation_info.rb +2 -0
  245. data/lib/wx/doc/gen/pg/property_grid.rb +56 -14
  246. data/lib/wx/doc/gen/pg/property_grid_event.rb +16 -6
  247. data/lib/wx/doc/gen/pg/property_grid_interface.rb +98 -37
  248. data/lib/wx/doc/gen/pg/property_grid_manager.rb +29 -7
  249. data/lib/wx/doc/gen/pg/property_grid_page.rb +11 -4
  250. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +7 -2
  251. data/lib/wx/doc/gen/picker_base.rb +11 -1
  252. data/lib/wx/doc/gen/platform_info.rb +31 -0
  253. data/lib/wx/doc/gen/popup_window.rb +5 -0
  254. data/lib/wx/doc/gen/progress_dialog.rb +4 -0
  255. data/lib/wx/doc/gen/property_sheet_dialog.rb +7 -1
  256. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +2 -0
  257. data/lib/wx/doc/gen/prt/post_script_dc.rb +1 -0
  258. data/lib/wx/doc/gen/prt/preview_frame.rb +4 -0
  259. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +1 -0
  260. data/lib/wx/doc/gen/prt/print_data.rb +27 -0
  261. data/lib/wx/doc/gen/prt/print_dialog.rb +4 -0
  262. data/lib/wx/doc/gen/prt/printer.rb +42 -5
  263. data/lib/wx/doc/gen/prt/printer_dc.rb +2 -0
  264. data/lib/wx/doc/gen/query_layout_info_event.rb +9 -0
  265. data/lib/wx/doc/gen/radio_box.rb +19 -0
  266. data/lib/wx/doc/gen/radio_button.rb +9 -0
  267. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +63 -0
  268. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +23 -0
  269. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +2 -1
  270. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +35 -9
  271. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +2 -1
  272. data/lib/wx/doc/gen/rbn/ribbon_control.rb +10 -0
  273. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +17 -7
  274. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -1
  275. data/lib/wx/doc/gen/rbn/ribbon_page.rb +12 -0
  276. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +11 -0
  277. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +2 -1
  278. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +25 -0
  279. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +2 -1
  280. data/lib/wx/doc/gen/rearrange_ctrl.rb +4 -0
  281. data/lib/wx/doc/gen/rearrange_list.rb +9 -0
  282. data/lib/wx/doc/gen/region.rb +42 -13
  283. data/lib/wx/doc/gen/region_iterator.rb +1 -0
  284. data/lib/wx/doc/gen/rtc/rich_text_box.rb +25 -8
  285. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +41 -4
  286. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -0
  287. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +23 -11
  288. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +74 -0
  289. data/lib/wx/doc/gen/rtc/rich_text_event.rb +6 -1
  290. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +8 -0
  291. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +6 -0
  292. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +1 -0
  293. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +4 -0
  294. data/lib/wx/doc/gen/rtc/rich_text_image.rb +7 -0
  295. data/lib/wx/doc/gen/rtc/rich_text_object.rb +64 -4
  296. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +51 -4
  297. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +13 -0
  298. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +9 -4
  299. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +3 -0
  300. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +2 -0
  301. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +1 -0
  302. data/lib/wx/doc/gen/sash_event.rb +5 -1
  303. data/lib/wx/doc/gen/sash_layout_window.rb +10 -0
  304. data/lib/wx/doc/gen/sash_window.rb +3 -0
  305. data/lib/wx/doc/gen/screen_dc.rb +1 -0
  306. data/lib/wx/doc/gen/scroll_bar.rb +11 -2
  307. data/lib/wx/doc/gen/scrolled_canvas.rb +20 -4
  308. data/lib/wx/doc/gen/scrolled_control.rb +20 -4
  309. data/lib/wx/doc/gen/scrolled_window.rb +20 -4
  310. data/lib/wx/doc/gen/search_ctrl.rb +6 -0
  311. data/lib/wx/doc/gen/simplebook.rb +7 -0
  312. data/lib/wx/doc/gen/single_choice_dialog.rb +3 -1
  313. data/lib/wx/doc/gen/sizer.rb +79 -9
  314. data/lib/wx/doc/gen/sizer_item.rb +16 -2
  315. data/lib/wx/doc/gen/slider.rb +23 -0
  316. data/lib/wx/doc/gen/spin_button.rb +9 -0
  317. data/lib/wx/doc/gen/spin_ctrl.rb +11 -0
  318. data/lib/wx/doc/gen/spin_ctrl_double.rb +7 -0
  319. data/lib/wx/doc/gen/spin_double_event.rb +4 -1
  320. data/lib/wx/doc/gen/spin_event.rb +2 -1
  321. data/lib/wx/doc/gen/splash_screen.rb +2 -0
  322. data/lib/wx/doc/gen/splitter_event.rb +10 -1
  323. data/lib/wx/doc/gen/splitter_window.rb +38 -14
  324. data/lib/wx/doc/gen/static_bitmap.rb +99 -2
  325. data/lib/wx/doc/gen/static_box.rb +6 -0
  326. data/lib/wx/doc/gen/static_box_sizer.rb +3 -0
  327. data/lib/wx/doc/gen/static_line.rb +4 -0
  328. data/lib/wx/doc/gen/static_text.rb +5 -0
  329. data/lib/wx/doc/gen/status_bar.rb +17 -3
  330. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +174 -6
  331. data/lib/wx/doc/gen/stc/styled_text_event.rb +27 -1
  332. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +7 -0
  333. data/lib/wx/doc/gen/svg_file_dc.rb +9 -0
  334. data/lib/wx/doc/gen/system_options.rb +8 -0
  335. data/lib/wx/doc/gen/system_settings.rb +7 -0
  336. data/lib/wx/doc/gen/task_bar_button.rb +12 -0
  337. data/lib/wx/doc/gen/task_bar_icon.rb +5 -0
  338. data/lib/wx/doc/gen/task_bar_icon_event.rb +2 -1
  339. data/lib/wx/doc/gen/text_attr.rb +27 -0
  340. data/lib/wx/doc/gen/text_ctrl.rb +27 -3
  341. data/lib/wx/doc/gen/text_entry.rb +43 -5
  342. data/lib/wx/doc/gen/text_entry_dialog.rb +12 -0
  343. data/lib/wx/doc/gen/text_validator.rb +16 -0
  344. data/lib/wx/doc/gen/time_picker_ctrl.rb +6 -0
  345. data/lib/wx/doc/gen/timer.rb +8 -0
  346. data/lib/wx/doc/gen/timer_event.rb +1 -0
  347. data/lib/wx/doc/gen/tip_provider.rb +5 -0
  348. data/lib/wx/doc/gen/toggle_button.rb +68 -0
  349. data/lib/wx/doc/gen/tool_bar.rb +57 -14
  350. data/lib/wx/doc/gen/tool_tip.rb +6 -0
  351. data/lib/wx/doc/gen/toolbook.rb +3 -0
  352. data/lib/wx/doc/gen/top_level_window.rb +34 -3
  353. data/lib/wx/doc/gen/tree_ctrl.rb +49 -0
  354. data/lib/wx/doc/gen/tree_event.rb +7 -1
  355. data/lib/wx/doc/gen/treebook.rb +9 -0
  356. data/lib/wx/doc/gen/ui_action_simulator.rb +4 -0
  357. data/lib/wx/doc/gen/utils.rb +55 -0
  358. data/lib/wx/doc/gen/v_list_box.rb +21 -0
  359. data/lib/wx/doc/gen/v_scrolled_window.rb +15 -0
  360. data/lib/wx/doc/gen/validator.rb +9 -13
  361. data/lib/wx/doc/gen/variant.rb +6 -0
  362. data/lib/wx/doc/gen/window.rb +260 -52
  363. data/lib/wx/doc/gen/window_dc.rb +2 -0
  364. data/lib/wx/doc/gen/window_disabler.rb +1 -0
  365. data/lib/wx/doc/gen/with_images.rb +7 -1
  366. data/lib/wx/doc/gen/wizard.rb +18 -0
  367. data/lib/wx/doc/gen/wizard_event.rb +3 -1
  368. data/lib/wx/doc/gen/wizard_page.rb +5 -0
  369. data/lib/wx/doc/gen/wizard_page_simple.rb +4 -0
  370. data/lib/wx/doc/gen/wrap_sizer.rb +5 -0
  371. data/lib/wx/doc/gen/xml_node.rb +14 -0
  372. data/lib/wx/doc/gen/xml_resource.rb +22 -0
  373. data/lib/wx/doc/generic_validator.rb +95 -0
  374. data/lib/wx/doc/html/simple_html_listbox.rb +22 -0
  375. data/lib/wx/doc/num_validator.rb +387 -0
  376. data/lib/wx/doc/owner_drawn_combobox.rb +96 -0
  377. data/lib/wx/doc/pg/numeric_property_validator.rb +33 -0
  378. data/lib/wx/doc/static_bitmap.rb +25 -0
  379. data/lib/wx/doc/text_validator.rb +10 -0
  380. data/lib/wx/doc/validator.rb +113 -0
  381. data/lib/wx/doc/window.rb +30 -0
  382. data/lib/wx/html/events/evt_list.rb +0 -10
  383. data/lib/wx/html/simple_html_listbox.rb +24 -91
  384. data/lib/wx/keyword_defs.rb +34 -2
  385. data/lib/wx/rbn/ribbon_gallery.rb +0 -21
  386. data/lib/wx/version.rb +1 -1
  387. data/lib/wxruby_aui.so +0 -0
  388. data/lib/wxruby_core.so +0 -0
  389. data/lib/wxruby_grid.so +0 -0
  390. data/lib/wxruby_html.so +0 -0
  391. data/lib/wxruby_pg.so +0 -0
  392. data/lib/wxruby_prt.so +0 -0
  393. data/lib/wxruby_rbn.so +0 -0
  394. data/lib/wxruby_rtc.so +0 -0
  395. data/lib/wxruby_stc.so +0 -0
  396. data/rakelib/lib/config/mingw.rb +12 -0
  397. data/samples/aui/aui.rb +1237 -1233
  398. data/samples/calendar/calendar.rb +293 -289
  399. data/samples/controls/get_item_sample.rb +83 -79
  400. data/samples/controls/htlbox.rb +331 -327
  401. data/samples/dialogs/dialogs.rb +682 -694
  402. data/samples/dialogs/wizard.rb +52 -55
  403. data/samples/dragdrop/dragdrop.rb +146 -142
  404. data/samples/drawing/bitmap.rb +29 -26
  405. data/samples/drawing/bitmap_image.rb +84 -80
  406. data/samples/drawing/graphics_drawing.rb +209 -205
  407. data/samples/drawing/image_prt.rb +344 -340
  408. data/samples/drawing/maths_images.rb +18 -1
  409. data/samples/drawing/rmagic_bitmap_image.rb +88 -84
  410. data/samples/etc/caret.rb +306 -0
  411. data/samples/etc/miniframe.rb +65 -60
  412. data/samples/etc/sash.rb +109 -105
  413. data/samples/etc/scrollwin.rb +86 -80
  414. data/samples/etc/system_settings.rb +216 -209
  415. data/samples/event/activation.rb +72 -67
  416. data/samples/event/event.rb +160 -153
  417. data/samples/event/threaded.rb +8 -1
  418. data/samples/event/update_ui_event.rb +67 -60
  419. data/samples/grid/grid.rb +188 -181
  420. data/samples/grid/gridtablebase.rb +136 -129
  421. data/samples/html/html.rb +208 -204
  422. data/samples/mdi/mdi.rb +59 -54
  423. data/samples/minimal/minimal.rb +54 -51
  424. data/samples/minimal/nothing.rb +1 -0
  425. data/samples/printing/printing.rb +367 -377
  426. data/samples/printing/printing2.rb +203 -198
  427. data/samples/propgrid/propgrid.rb +2312 -2308
  428. data/samples/propgrid/propgrid_minimal.rb +57 -50
  429. data/samples/ribbon/ribbon.rb +780 -774
  430. data/samples/sampler/ext.rb +0 -33
  431. data/samples/sampler/sample.rb +4 -9
  432. data/samples/sampler.rb +1 -1
  433. data/samples/splash/splash.rb +118 -116
  434. data/samples/text/rich_textctrl.rb +207 -201
  435. data/samples/text/richtext.rb +1409 -1405
  436. data/samples/text/scintilla.rb +137 -128
  437. data/samples/text/textctrl.rb +89 -83
  438. data/samples/text/unicode.rb +175 -168
  439. data/samples/treectrl/treectrl.rb +1430 -1426
  440. data/samples/widgets/activityindicator.rb +95 -0
  441. data/samples/widgets/art/widgets/activityindicator.xpm +278 -0
  442. data/samples/widgets/art/widgets/bmpbtn.xpm +37 -0
  443. data/samples/widgets/art/widgets/bmpcombobox.xpm +54 -0
  444. data/samples/widgets/art/widgets/button.xpm +54 -0
  445. data/samples/widgets/art/widgets/checkbox.xpm +54 -0
  446. data/samples/{bigdemo/icons → widgets/art/widgets}/choice.xpm +1 -1
  447. data/samples/widgets/art/widgets/choicebk.xpm +54 -0
  448. data/samples/widgets/art/widgets/clrpicker.xpm +193 -0
  449. data/samples/widgets/art/widgets/combobox.xpm +54 -0
  450. data/samples/widgets/art/widgets/datepick.xpm +200 -0
  451. data/samples/widgets/art/widgets/dirctrl.xpm +54 -0
  452. data/samples/widgets/art/widgets/dirpicker.xpm +213 -0
  453. data/samples/widgets/art/widgets/filepicker.xpm +214 -0
  454. data/samples/widgets/art/widgets/fontpicker.xpm +185 -0
  455. data/samples/widgets/art/widgets/gauge.xpm +54 -0
  456. data/samples/widgets/art/widgets/header.xpm +54 -0
  457. data/samples/widgets/art/widgets/hyperlnk.xpm +54 -0
  458. data/samples/widgets/art/widgets/listbook.xpm +54 -0
  459. data/samples/widgets/art/widgets/listbox.xpm +54 -0
  460. data/samples/widgets/art/widgets/native.xpm +81 -0
  461. data/samples/widgets/art/widgets/notebook.xpm +54 -0
  462. data/samples/widgets/art/widgets/odcombobox.xpm +54 -0
  463. data/samples/widgets/art/widgets/radiobox.xpm +54 -0
  464. data/samples/widgets/art/widgets/scrolbar.xpm +54 -0
  465. data/samples/widgets/art/widgets/slider.xpm +54 -0
  466. data/samples/widgets/art/widgets/spinbtn.xpm +40 -0
  467. data/samples/widgets/art/widgets/statbmp.xpm +40 -0
  468. data/samples/widgets/art/widgets/statbox.xpm +54 -0
  469. data/samples/widgets/art/widgets/stattext.xpm +54 -0
  470. data/samples/widgets/art/widgets/text.xpm +54 -0
  471. data/samples/widgets/art/widgets/timepick.xpm +207 -0
  472. data/samples/widgets/art/widgets/toggle.xpm +54 -0
  473. data/samples/widgets/art/widgets/toucan.png +0 -0
  474. data/samples/widgets/bmpcombobox.rb +651 -0
  475. data/samples/widgets/button.rb +462 -0
  476. data/samples/widgets/checkbox.rb +211 -0
  477. data/samples/widgets/choice.rb +287 -0
  478. data/samples/widgets/clrpicker.rb +156 -0
  479. data/samples/widgets/combobox.rb +516 -0
  480. data/samples/widgets/datepick.rb +215 -0
  481. data/samples/widgets/dirctrl.rb +265 -0
  482. data/samples/widgets/dirpicker.rb +158 -0
  483. data/samples/widgets/editlbox.rb +122 -0
  484. data/samples/widgets/filectrl.rb +216 -0
  485. data/samples/widgets/filepicker.rb +214 -0
  486. data/samples/widgets/fontpicker.rb +135 -0
  487. data/samples/widgets/gauge.rb +311 -0
  488. data/samples/widgets/headerctrl.rb +236 -0
  489. data/samples/widgets/hyperlink.rb +203 -0
  490. data/samples/widgets/itemcontainer.rb +185 -0
  491. data/samples/widgets/listbox.rb +473 -0
  492. data/samples/widgets/notebook.rb +488 -0
  493. data/samples/widgets/odcombobox.rb +608 -0
  494. data/samples/widgets/radiobox.rb +328 -0
  495. data/samples/widgets/searchctrl.rb +159 -0
  496. data/samples/widgets/slider.rb +594 -0
  497. data/samples/widgets/spinbtn.rb +443 -0
  498. data/samples/widgets/statbmp.rb +130 -0
  499. data/samples/widgets/static.rb +436 -0
  500. data/samples/widgets/textctrl.rb +700 -0
  501. data/samples/widgets/timepick.rb +148 -0
  502. data/samples/widgets/tn_widgets.png +0 -0
  503. data/samples/widgets/toggle.rb +385 -0
  504. data/samples/widgets/widgets.rb +1233 -0
  505. data/samples/xrc/custom_xrc_sample.rb +47 -41
  506. data/samples/xrc/xrc_sample.rb +53 -47
  507. data/tests/test_event_handling.rb +52 -34
  508. data/tests/test_events.rb +7 -0
  509. data/tests/test_item_data.rb +24 -0
  510. data/tests/test_sizer.rb +44 -1
  511. data/tests/test_validators.rb +805 -0
  512. metadata +87 -137
  513. data/lib/wx/core/choice.rb +0 -14
  514. data/lib/wx/core/combo_ctrl.rb +0 -110
  515. data/samples/bigdemo/About.rbw +0 -39
  516. data/samples/bigdemo/ColorPanel.rbw +0 -23
  517. data/samples/bigdemo/GridSimple.rbw +0 -78
  518. data/samples/bigdemo/MDIDemo.rbw +0 -57
  519. data/samples/bigdemo/PopupMenu.rbw +0 -146
  520. data/samples/bigdemo/ShapedWindow.rbw +0 -128
  521. data/samples/bigdemo/Sizers.rbw +0 -541
  522. data/samples/bigdemo/bigdemo.rb +0 -817
  523. data/samples/bigdemo/demoTemplate.rbw +0 -33
  524. data/samples/bigdemo/helpfile.htb +0 -0
  525. data/samples/bigdemo/icons/Test 015.jpg +0 -0
  526. data/samples/bigdemo/icons/Test 015.png +0 -0
  527. data/samples/bigdemo/icons/choice.bmp +0 -0
  528. data/samples/bigdemo/icons/combo.bmp +0 -0
  529. data/samples/bigdemo/icons/combo.xpm +0 -27
  530. data/samples/bigdemo/icons/copy.xpm +0 -25
  531. data/samples/bigdemo/icons/cut.xpm +0 -24
  532. data/samples/bigdemo/icons/gauge.bmp +0 -0
  533. data/samples/bigdemo/icons/gauge.xpm +0 -27
  534. data/samples/bigdemo/icons/help.xpm +0 -25
  535. data/samples/bigdemo/icons/list.bmp +0 -0
  536. data/samples/bigdemo/icons/list.xpm +0 -27
  537. data/samples/bigdemo/icons/mondrian.ico +0 -0
  538. data/samples/bigdemo/icons/mondrian.xpm +0 -44
  539. data/samples/bigdemo/icons/new.xpm +0 -24
  540. data/samples/bigdemo/icons/ogl.ico +0 -0
  541. data/samples/bigdemo/icons/ogl.xpm +0 -45
  542. data/samples/bigdemo/icons/open.xpm +0 -26
  543. data/samples/bigdemo/icons/paste.bmp +0 -0
  544. data/samples/bigdemo/icons/paste.xpm +0 -38
  545. data/samples/bigdemo/icons/pointy.png +0 -0
  546. data/samples/bigdemo/icons/preview.xpm +0 -26
  547. data/samples/bigdemo/icons/print.xpm +0 -26
  548. data/samples/bigdemo/icons/radio.bmp +0 -0
  549. data/samples/bigdemo/icons/radio.xpm +0 -27
  550. data/samples/bigdemo/icons/robert.xpm +0 -415
  551. data/samples/bigdemo/icons/sashtest.ico +0 -0
  552. data/samples/bigdemo/icons/save.xpm +0 -25
  553. data/samples/bigdemo/icons/smiles.bmp +0 -0
  554. data/samples/bigdemo/icons/smiles.xpm +0 -39
  555. data/samples/bigdemo/icons/smiley.ico +0 -0
  556. data/samples/bigdemo/icons/smiley.xpm +0 -42
  557. data/samples/bigdemo/icons/stattext.xpm +0 -24
  558. data/samples/bigdemo/icons/test2.bmp +0 -0
  559. data/samples/bigdemo/icons/test2.png +0 -0
  560. data/samples/bigdemo/icons/test2.xpm +0 -79
  561. data/samples/bigdemo/icons/text.bmp +0 -0
  562. data/samples/bigdemo/icons/text.xpm +0 -27
  563. data/samples/bigdemo/icons/tog1.bmp +0 -0
  564. data/samples/bigdemo/icons/tog1.xpm +0 -38
  565. data/samples/bigdemo/icons/tog2.bmp +0 -0
  566. data/samples/bigdemo/icons/tog2.xpm +0 -38
  567. data/samples/bigdemo/icons/wxruby-128x128.png +0 -0
  568. data/samples/bigdemo/icons/wxwin.ico +0 -0
  569. data/samples/bigdemo/icons/wxwin16x16.png +0 -0
  570. data/samples/bigdemo/icons/wxwin16x16.xpm +0 -25
  571. data/samples/bigdemo/icons/wxwin32x32.png +0 -0
  572. data/samples/bigdemo/icons/wxwin48x48.png +0 -0
  573. data/samples/bigdemo/run.rb +0 -98
  574. data/samples/bigdemo/tips.txt +0 -7
  575. data/samples/bigdemo/utils.rb +0 -20
  576. data/samples/bigdemo/wxArtProvider.rbw +0 -282
  577. data/samples/bigdemo/wxBitmapButton.rbw +0 -65
  578. data/samples/bigdemo/wxButton.rbw +0 -64
  579. data/samples/bigdemo/wxCalendarCtrl.rbw +0 -59
  580. data/samples/bigdemo/wxCheckBox.rbw +0 -50
  581. data/samples/bigdemo/wxCheckListBox.rbw +0 -65
  582. data/samples/bigdemo/wxChoice.rbw +0 -47
  583. data/samples/bigdemo/wxChoicebook.rbw +0 -78
  584. data/samples/bigdemo/wxColourDialog.rbw +0 -33
  585. data/samples/bigdemo/wxComboBox.rbw +0 -77
  586. data/samples/bigdemo/wxCursor.rbw +0 -136
  587. data/samples/bigdemo/wxDialog.rbw +0 -74
  588. data/samples/bigdemo/wxDirDialog.rbw +0 -29
  589. data/samples/bigdemo/wxDragImage.rbw +0 -70
  590. data/samples/bigdemo/wxFileDialog.rbw +0 -37
  591. data/samples/bigdemo/wxFileDialog_Save.rbw +0 -35
  592. data/samples/bigdemo/wxFindReplaceDialog.rbw +0 -82
  593. data/samples/bigdemo/wxFontDialog.rbw +0 -200
  594. data/samples/bigdemo/wxFrame.rbw +0 -53
  595. data/samples/bigdemo/wxGauge.rbw +0 -65
  596. data/samples/bigdemo/wxGenericDirCtrl.rbw +0 -74
  597. data/samples/bigdemo/wxGrid.rbw +0 -66
  598. data/samples/bigdemo/wxHtmlHelpController.rbw +0 -52
  599. data/samples/bigdemo/wxListBox.rbw +0 -140
  600. data/samples/bigdemo/wxListCtrl_virtual.rbw +0 -112
  601. data/samples/bigdemo/wxMDIWindows.rbw +0 -50
  602. data/samples/bigdemo/wxMenu.rbw +0 -247
  603. data/samples/bigdemo/wxMessageDialog.rbw +0 -27
  604. data/samples/bigdemo/wxMiniFrame.rbw +0 -70
  605. data/samples/bigdemo/wxMultipleChoiceDialog.rbw +0 -29
  606. data/samples/bigdemo/wxNotebook.rbw +0 -136
  607. data/samples/bigdemo/wxProgressDialog.rbw +0 -43
  608. data/samples/bigdemo/wxRadioBox.rbw +0 -72
  609. data/samples/bigdemo/wxRadioButton.rbw +0 -125
  610. data/samples/bigdemo/wxSashWindow.rbw +0 -141
  611. data/samples/bigdemo/wxScrolledMessageDialog.rbw +0 -57
  612. data/samples/bigdemo/wxScrolledWindow.rbw +0 -199
  613. data/samples/bigdemo/wxSingleChoiceDialog.rbw +0 -33
  614. data/samples/bigdemo/wxSlider.rbw +0 -42
  615. data/samples/bigdemo/wxSpinButton.rbw +0 -50
  616. data/samples/bigdemo/wxSpinCtrl.rbw +0 -51
  617. data/samples/bigdemo/wxSplitterWindow.rbw +0 -63
  618. data/samples/bigdemo/wxStaticBitmap.rbw +0 -47
  619. data/samples/bigdemo/wxStaticText.rbw +0 -55
  620. data/samples/bigdemo/wxStatusBar.rbw +0 -126
  621. data/samples/bigdemo/wxTextCtrl.rbw +0 -149
  622. data/samples/bigdemo/wxTextEntryDialog.rbw +0 -31
  623. data/samples/bigdemo/wxToggleButton.rbw +0 -49
  624. data/samples/bigdemo/wxToolBar.rbw +0 -131
  625. data/samples/bigdemo/wxTreeCtrl.rbw +0 -191
  626. data/samples/caret/caret.rb +0 -298
  627. data/samples/caret/mondrian.xpm +0 -44
  628. data/samples/controls/books.rb +0 -189
  629. data/samples/controls/choice.xpm +0 -27
  630. data/samples/controls/combo.xpm +0 -27
  631. data/samples/controls/controls.rb +0 -1099
  632. data/samples/controls/gauge.xpm +0 -27
  633. data/samples/controls/list.xpm +0 -27
  634. data/samples/controls/mondrian.ico +0 -0
  635. data/samples/controls/mondrian.xpm +0 -44
  636. data/samples/controls/radio.xpm +0 -27
  637. data/samples/controls/stattext.xpm +0 -24
  638. data/samples/controls/test2.bmp +0 -0
  639. data/samples/controls/text.xpm +0 -27
  640. data/samples/controls/tn_books.png +0 -0
  641. data/samples/controls/tn_controls.png +0 -0
  642. data/samples/etc/choice.rb +0 -87
  643. data/samples/etc/tn_choice.png +0 -0
  644. data/samples/text/mondrian.ico +0 -0
  645. data/samples/text/mondrian.xpm +0 -44
  646. /data/samples/{caret → etc}/tn_caret.png +0 -0
@@ -205,6 +205,7 @@ module Wx::GRID
205
205
  EVT_GRID_TABBING = 10075
206
206
 
207
207
  # {Wx::GRID::Grid} and its related classes are used for displaying and editing tabular data.
208
+ #
208
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}.
209
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}.
210
211
  # {Wx::GRID::GridCellRenderer} is the abstract base class for rendering contents in a cell. The following renderers are predefined:
@@ -312,10 +313,12 @@ module Wx::GRID
312
313
 
313
314
  # @overload initialize()
314
315
  # Default constructor.
316
+ #
315
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.
316
318
  # @return [Wx::GRID::Grid]
317
319
  # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::WANTS_CHARS, name=Wx::GRID_NAME_STR)
318
320
  # Constructor creating the grid window.
321
+ #
319
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.
320
323
  # @param parent [Wx::Window]
321
324
  # @param id [Integer]
@@ -327,6 +330,7 @@ module Wx::GRID
327
330
  def initialize(*args) end
328
331
 
329
332
  # Creates the grid window for an object initialized using the default constructor.
333
+ #
330
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.
331
335
  # @param parent [Wx::Window]
332
336
  # @param id [Integer]
@@ -338,19 +342,21 @@ module Wx::GRID
338
342
  def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::WANTS_CHARS, name=Wx::GRID_NAME_STR) end
339
343
 
340
344
  # Creates a grid with the specified initial number of rows and columns.
345
+ #
341
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.
342
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}.
343
348
  # @param numRows [Integer]
344
349
  # @param numCols [Integer]
345
- # @param selmode [Wx::wxGrid::GridSelectionModes]
350
+ # @param selmode [Wx::Grid::GridSelectionModes]
346
351
  # @return [Boolean]
347
352
  def create_grid(numRows, numCols, selmode=Wx::GRID::Grid::GridSelectionModes::GridSelectCells) end
348
353
 
349
354
  # Assigns a pointer to a custom grid table to be used by the grid.
355
+ #
350
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.
351
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.
352
358
  # @param table [Wx::GRID::GridTableBase] The heap-allocated pointer to the table.
353
- # @param selmode [Wx::wxGrid::GridSelectionModes] Selection mode to use.
359
+ # @param selmode [Wx::Grid::GridSelectionModes] Selection mode to use.
354
360
  # @return [void]
355
361
  def assign_table(table, selmode=Wx::GRID::Grid::GridSelectionModes::GridSelectCells) end
356
362
 
@@ -365,6 +371,7 @@ module Wx::GRID
365
371
  def enable_grid_lines(enable=true) end
366
372
 
367
373
  # Returns the pen used for vertical grid lines.
374
+ #
368
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.
369
376
  # See {Wx::GRID::Grid#get_row_grid_line_pen} for an example.
370
377
  # @param col [Integer]
@@ -373,6 +380,7 @@ module Wx::GRID
373
380
  alias_method :col_grid_line_pen, :get_col_grid_line_pen
374
381
 
375
382
  # Returns the pen used for grid lines.
383
+ #
376
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.
377
385
  # @see Wx::GRID::Grid#get_col_grid_line_pen
378
386
  # @see Wx::GRID::Grid#get_row_grid_line_pen
@@ -382,12 +390,14 @@ module Wx::GRID
382
390
 
383
391
  # Returns the colour used for grid lines.
384
392
  #
393
+ #
385
394
  # @see Wx::GRID::Grid#get_default_grid_line_pen
386
395
  # @return [Wx::Colour]
387
396
  def get_grid_line_colour; end
388
397
  alias_method :grid_line_colour, :get_grid_line_colour
389
398
 
390
399
  # Returns the pen used for horizontal grid lines.
400
+ #
391
401
  # This virtual function may be overridden in derived classes in order to change the appearance of individual grid line for the given row.
392
402
  # Example:
393
403
  # ```ruby
@@ -423,6 +433,7 @@ module Wx::GRID
423
433
  alias_method :grid_line_colour=, :set_grid_line_colour
424
434
 
425
435
  # Sets the arguments to the current column label alignment values.
436
+ #
426
437
  # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
427
438
  # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
428
439
  # @return [Array(Integer,Integer)]
@@ -435,6 +446,7 @@ module Wx::GRID
435
446
  alias_method :col_label_text_orientation, :get_col_label_text_orientation
436
447
 
437
448
  # Returns the specified column label.
449
+ #
438
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.
439
451
  # @param col [Integer]
440
452
  # @return [String]
@@ -442,6 +454,7 @@ module Wx::GRID
442
454
  alias_method :col_label_value, :get_col_label_value
443
455
 
444
456
  # Sets the arguments to the current corner label alignment values.
457
+ #
445
458
  # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
446
459
  # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
447
460
  # @return [Array(Integer,Integer)]
@@ -474,6 +487,7 @@ module Wx::GRID
474
487
  alias_method :label_text_colour, :get_label_text_colour
475
488
 
476
489
  # Returns the alignment used for row labels.
490
+ #
477
491
  # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
478
492
  # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
479
493
  # @return [Array(Integer,Integer)]
@@ -481,6 +495,7 @@ module Wx::GRID
481
495
  alias_method :row_label_alignment, :get_row_label_alignment
482
496
 
483
497
  # Returns the specified row label.
498
+ #
484
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.
485
500
  # @param row [Integer]
486
501
  # @return [String]
@@ -488,6 +503,7 @@ module Wx::GRID
488
503
  alias_method :row_label_value, :get_row_label_value
489
504
 
490
505
  # Hides the column labels by calling {Wx::GRID::Grid#set_col_label_size} with a size of 0.
506
+ #
491
507
  # The labels can be shown again by calling {Wx::GRID::Grid#set_col_label_size} with a height greater than 0.
492
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.
493
509
  # @see Wx::GRID::Grid#hide_row_labels
@@ -495,12 +511,14 @@ module Wx::GRID
495
511
  def hide_col_labels; end
496
512
 
497
513
  # Hides the row labels by calling {Wx::GRID::Grid#set_row_label_size} with a size of 0.
514
+ #
498
515
  # The labels can be shown again by calling {Wx::GRID::Grid#set_row_label_size} with a width greater than 0.
499
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.
500
517
  # @return [void]
501
518
  def hide_row_labels; end
502
519
 
503
520
  # Sets the horizontal and vertical alignment of column label text.
521
+ #
504
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}.
505
523
  # @param horiz [Integer]
506
524
  # @param vert [Integer]
@@ -514,6 +532,7 @@ module Wx::GRID
514
532
  alias_method :col_label_text_orientation=, :set_col_label_text_orientation
515
533
 
516
534
  # Set the value for the given column label.
535
+ #
517
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.
518
537
  # @param col [Integer]
519
538
  # @param value [String]
@@ -521,6 +540,7 @@ module Wx::GRID
521
540
  def set_col_label_value(col, value) end
522
541
 
523
542
  # Sets the horizontal and vertical alignment of the (top-left) corner label text.
543
+ #
524
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}.
525
545
  # @param horiz [Integer]
526
546
  # @param vert [Integer]
@@ -534,6 +554,7 @@ module Wx::GRID
534
554
  alias_method :corner_label_text_orientation=, :set_corner_label_text_orientation
535
555
 
536
556
  # Set the value for the (top-left) corner label.
557
+ #
537
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.
538
559
  # @param arg [String]
539
560
  # @return [void]
@@ -559,6 +580,7 @@ module Wx::GRID
559
580
  alias_method :label_text_colour=, :set_label_text_colour
560
581
 
561
582
  # Sets the horizontal and vertical alignment of row label text.
583
+ #
562
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}.
563
585
  # @param horiz [Integer]
564
586
  # @param vert [Integer]
@@ -566,6 +588,7 @@ module Wx::GRID
566
588
  def set_row_label_alignment(horiz, vert) end
567
589
 
568
590
  # Sets the value for the given row label.
591
+ #
569
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.
570
593
  # @param row [Integer]
571
594
  # @param value [String]
@@ -573,6 +596,7 @@ module Wx::GRID
573
596
  def set_row_label_value(row, value) end
574
597
 
575
598
  # Call this in order to make the column labels use a native look by using Wx::RendererNative#draw_header_button internally.
599
+ #
576
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.
577
601
  # @see Wx::GRID::Grid#use_native_col_header
578
602
  # @param native [Boolean]
@@ -581,6 +605,7 @@ module Wx::GRID
581
605
  alias_method :use_native_col_labels=, :set_use_native_col_labels
582
606
 
583
607
  # Enable the use of native header window for column labels.
608
+ #
584
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.
585
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.
586
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).
@@ -590,6 +615,7 @@ module Wx::GRID
590
615
  def use_native_col_header(native=true) end
591
616
 
592
617
  # Sets the arguments to the horizontal and vertical text alignment values for the grid cell at the specified location.
618
+ #
593
619
  # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
594
620
  # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
595
621
  # @param row [Integer]
@@ -620,6 +646,7 @@ module Wx::GRID
620
646
  alias_method :cell_text_colour, :get_cell_text_colour
621
647
 
622
648
  # Returns the default cell alignment.
649
+ #
623
650
  # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
624
651
  # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
625
652
  # @see Wx::GRID::Grid#set_default_cell_alignment
@@ -643,6 +670,7 @@ module Wx::GRID
643
670
  alias_method :default_cell_text_colour, :get_default_cell_text_colour
644
671
 
645
672
  # Sets the horizontal and vertical alignment for grid cell text at the specified location.
673
+ #
646
674
  # Horizontal alignment should be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
647
675
  # Vertical alignment should be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
648
676
  # @param row [Integer]
@@ -672,9 +700,9 @@ module Wx::GRID
672
700
  # @param colour [Wx::Colour,String,Symbol]
673
701
  # @return [void]
674
702
  def set_cell_text_colour(row, col, colour) end
675
- alias_method :cell_text_colour=, :set_cell_text_colour
676
703
 
677
704
  # Sets the default horizontal and vertical alignment for grid cell text.
705
+ #
678
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}.
679
707
  # @param horiz [Integer]
680
708
  # @param vert [Integer]
@@ -700,17 +728,20 @@ module Wx::GRID
700
728
  alias_method :default_cell_text_colour=, :set_default_cell_text_colour
701
729
 
702
730
  # Returns true if the in-place edit control for the current grid cell can be used and false otherwise.
731
+ #
703
732
  # This function always returns false for the read-only cells.
704
733
  # @return [Boolean]
705
734
  def can_enable_cell_control; end
706
735
  alias_method :can_enable_cell_control?, :can_enable_cell_control
707
736
 
708
737
  # Disables in-place editing of grid cells.
738
+ #
709
739
  # Equivalent to calling EnableCellEditControl(false).
710
740
  # @return [void]
711
741
  def disable_cell_edit_control; end
712
742
 
713
743
  # Enables or disables in-place editing of grid cell data.
744
+ #
714
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.
715
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.
716
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.
@@ -719,6 +750,7 @@ module Wx::GRID
719
750
  def enable_cell_edit_control(enable=true) end
720
751
 
721
752
  # Makes the grid globally editable or read-only.
753
+ #
722
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}.
723
755
  # For more information about controlling grid cell attributes see the {Wx::GRID::GridCellAttr} class and the wxGrid Overview.
724
756
  # @param edit [Boolean]
@@ -726,6 +758,7 @@ module Wx::GRID
726
758
  def enable_editing(edit) end
727
759
 
728
760
  # Returns a pointer to the editor for the cell at the specified location.
761
+ #
729
762
  # See {Wx::GRID::GridCellEditor} and the wxGrid Overview for more information about cell editors and renderers.
730
763
  # The caller must call DecRef() on the returned pointer.
731
764
  # @param row [Integer]
@@ -735,6 +768,7 @@ module Wx::GRID
735
768
  alias_method :cell_editor, :get_cell_editor
736
769
 
737
770
  # Returns a pointer to the renderer for the grid cell at the specified location.
771
+ #
738
772
  # See {Wx::GRID::GridCellRenderer} and the wxGrid Overview for more information about cell editors and renderers.
739
773
  # The caller must call DecRef() on the returned pointer.
740
774
  # @param row [Integer]
@@ -744,6 +778,7 @@ module Wx::GRID
744
778
  alias_method :cell_renderer, :get_cell_renderer
745
779
 
746
780
  # Returns the string contained in the cell at the specified location.
781
+ #
747
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.
748
783
  # See {Wx::GRID::GridTableBase#can_get_value_as} and the wxGrid Overview for more information.
749
784
  # @param row [Integer]
@@ -753,12 +788,14 @@ module Wx::GRID
753
788
  alias_method :cell_value, :get_cell_value
754
789
 
755
790
  # Returns a pointer to the current default grid cell editor.
791
+ #
756
792
  # See {Wx::GRID::GridCellEditor} and the wxGrid Overview for more information about cell editors and renderers.
757
793
  # @return [Wx::GRID::GridCellEditor]
758
794
  def get_default_editor; end
759
795
  alias_method :default_editor, :get_default_editor
760
796
 
761
797
  # Returns the default editor for the specified cell.
798
+ #
762
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.
763
800
  # Notice that the same may be achieved in a usually simpler way by associating a custom editor with the given cell or cells.
764
801
  # The caller must call DecRef() on the returned pointer.
@@ -769,6 +806,7 @@ module Wx::GRID
769
806
  alias_method :default_editor_for_cell, :get_default_editor_for_cell
770
807
 
771
808
  # Returns the default editor for the cells containing values of the given type.
809
+ #
772
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.
773
811
  # The caller must call DecRef() on the returned pointer.
774
812
  # @param typeName [String]
@@ -777,6 +815,7 @@ module Wx::GRID
777
815
  alias_method :default_editor_for_type, :get_default_editor_for_type
778
816
 
779
817
  # Returns a pointer to the current default grid cell renderer.
818
+ #
780
819
  # See {Wx::GRID::GridCellRenderer} and the wxGrid Overview for more information about cell editors and renderers.
781
820
  # The caller must call DecRef() on the returned pointer.
782
821
  # @return [Wx::GRID::GridCellRenderer]
@@ -784,6 +823,7 @@ module Wx::GRID
784
823
  alias_method :default_renderer, :get_default_renderer
785
824
 
786
825
  # Returns the default renderer for the given cell.
826
+ #
787
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.
788
828
  # The caller must call DecRef() on the returned pointer.
789
829
  # @param row [Integer]
@@ -794,6 +834,7 @@ module Wx::GRID
794
834
 
795
835
  # Returns the default renderer for the cell containing values of the given type.
796
836
  #
837
+ #
797
838
  # @see Wx::GRID::Grid#get_default_editor_for_type
798
839
  # @param typeName [String]
799
840
  # @return [Wx::GRID::GridCellRenderer]
@@ -811,6 +852,7 @@ module Wx::GRID
811
852
 
812
853
  # Returns true if the in-place edit control is currently shown.
813
854
  #
855
+ #
814
856
  # @see Wx::GRID::Grid#hide_cell_edit_control
815
857
  # @return [Boolean]
816
858
  def is_cell_edit_control_shown; end
@@ -818,6 +860,7 @@ module Wx::GRID
818
860
 
819
861
  # Returns true if the current cell is read-only.
820
862
  #
863
+ #
821
864
  # @see Wx::GRID::Grid#set_read_only
822
865
  # @see Wx::GRID::Grid#is_read_only
823
866
  # @return [Boolean]
@@ -825,6 +868,7 @@ module Wx::GRID
825
868
  alias_method :current_cell_read_only?, :is_current_cell_read_only
826
869
 
827
870
  # Returns false if the whole grid has been set as read-only or true otherwise.
871
+ #
828
872
  # See {Wx::GRID::Grid#enable_editing} for more information about controlling the editing status of grid cells.
829
873
  # @return [Boolean]
830
874
  def is_editable; end
@@ -832,6 +876,7 @@ module Wx::GRID
832
876
 
833
877
  # Returns true if the cell at the specified location can't be edited.
834
878
  #
879
+ #
835
880
  # @see Wx::GRID::Grid#set_read_only
836
881
  # @see Wx::GRID::Grid#is_current_cell_read_only
837
882
  # @param row [Integer]
@@ -841,6 +886,7 @@ module Wx::GRID
841
886
  alias_method :read_only?, :is_read_only
842
887
 
843
888
  # Register a new data type.
889
+ #
844
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.
845
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.
846
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.
@@ -851,11 +897,13 @@ module Wx::GRID
851
897
  def register_data_type(typeName, renderer, editor) end
852
898
 
853
899
  # Sets the value of the current grid cell to the current in-place edit control value.
900
+ #
854
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.
855
902
  # @return [void]
856
903
  def save_edit_control_value; end
857
904
 
858
905
  # Sets the editor for the grid cell at the specified location.
906
+ #
859
907
  # The grid will take ownership of the pointer.
860
908
  # See {Wx::GRID::GridCellEditor} and the wxGrid Overview for more information about cell editors and renderers.
861
909
  # @param row [Integer]
@@ -865,6 +913,7 @@ module Wx::GRID
865
913
  def set_cell_editor(row, col, editor) end
866
914
 
867
915
  # Sets the renderer for the grid cell at the specified location.
916
+ #
868
917
  # The grid will take ownership of the pointer.
869
918
  # See {Wx::GRID::GridCellRenderer} and the wxGrid Overview for more information about cell editors and renderers.
870
919
  # @param row [Integer]
@@ -874,6 +923,7 @@ module Wx::GRID
874
923
  def set_cell_renderer(row, col, renderer) end
875
924
 
876
925
  # Sets the string value for the cell at the specified location.
926
+ #
877
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.
878
928
  # See {Wx::GRID::GridTableBase#can_set_value_as} and the wxGrid Overview for more information.
879
929
  # @param row [Integer]
@@ -884,6 +934,7 @@ module Wx::GRID
884
934
 
885
935
  # Sets the specified column to display boolean values.
886
936
  #
937
+ #
887
938
  # @see Wx::GRID::Grid#set_col_format_custom
888
939
  # @param col [Integer]
889
940
  # @return [void]
@@ -891,6 +942,7 @@ module Wx::GRID
891
942
  alias_method :col_format_bool=, :set_col_format_bool
892
943
 
893
944
  # Sets the specified column to display data in a custom format.
945
+ #
894
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.
895
947
  # See the wxGrid Overview for more information on working with custom data types.
896
948
  # @param col [Integer]
@@ -900,6 +952,7 @@ module Wx::GRID
900
952
 
901
953
  # Sets the specified column to display floating point values with the given width and precision.
902
954
  #
955
+ #
903
956
  # @see Wx::GRID::Grid#set_col_format_custom
904
957
  # @param col [Integer]
905
958
  # @param width [Integer]
@@ -910,6 +963,7 @@ module Wx::GRID
910
963
 
911
964
  # Sets the specified column to display integer values.
912
965
  #
966
+ #
913
967
  # @see Wx::GRID::Grid#set_col_format_custom
914
968
  # @param col [Integer]
915
969
  # @return [void]
@@ -917,6 +971,7 @@ module Wx::GRID
917
971
  alias_method :col_format_number=, :set_col_format_number
918
972
 
919
973
  # Sets the specified column to display date values.
974
+ #
920
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.
921
976
  # @see Wx::GRID::Grid#set_col_format_custom
922
977
  # @param col [Integer]
@@ -926,6 +981,7 @@ module Wx::GRID
926
981
  alias_method :col_format_date=, :set_col_format_date
927
982
 
928
983
  # Sets the default editor for grid cells.
984
+ #
929
985
  # The grid will take ownership of the pointer.
930
986
  # See {Wx::GRID::GridCellEditor} and the wxGrid Overview for more information about cell editors and renderers.
931
987
  # @param editor [Wx::GRID::GridCellEditor]
@@ -934,6 +990,7 @@ module Wx::GRID
934
990
  alias_method :default_editor=, :set_default_editor
935
991
 
936
992
  # Sets the default renderer for grid cells.
993
+ #
937
994
  # The grid will take ownership of the pointer.
938
995
  # See {Wx::GRID::GridCellRenderer} and the wxGrid Overview for more information about cell editors and renderers.
939
996
  # @param renderer [Wx::GRID::GridCellRenderer]
@@ -943,6 +1000,7 @@ module Wx::GRID
943
1000
 
944
1001
  # Makes the cell at the specified location read-only or editable.
945
1002
  #
1003
+ #
946
1004
  # @see Wx::GRID::Grid#is_read_only
947
1005
  # @param row [Integer]
948
1006
  # @param col [Integer]
@@ -951,6 +1009,7 @@ module Wx::GRID
951
1009
  def set_read_only(row, col, isReadOnly=true) end
952
1010
 
953
1011
  # Displays the active in-place cell edit control for the current cell after it was hidden.
1012
+ #
954
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.
955
1014
  # @return [void]
956
1015
  def show_cell_edit_control; end
@@ -965,6 +1024,7 @@ module Wx::GRID
965
1024
  def auto_size_col_label_size(col) end
966
1025
 
967
1026
  # Automatically sizes the column to fit its contents.
1027
+ #
968
1028
  # If setAsMin is true the calculated width will also be set as the minimal width for the column.
969
1029
  # @param col [Integer]
970
1030
  # @param setAsMin [Boolean]
@@ -972,12 +1032,14 @@ module Wx::GRID
972
1032
  def auto_size_column(col, setAsMin=true) end
973
1033
 
974
1034
  # Automatically sizes all columns to fit their contents.
1035
+ #
975
1036
  # If setAsMin is true the calculated widths will also be set as the minimal widths for the columns.
976
1037
  # @param setAsMin [Boolean]
977
1038
  # @return [void]
978
1039
  def auto_size_columns(setAsMin=true) end
979
1040
 
980
1041
  # Automatically sizes the row to fit its contents.
1042
+ #
981
1043
  # If setAsMin is true the calculated height will also be set as the minimal height for the row.
982
1044
  # @param row [Integer]
983
1045
  # @param setAsMin [Boolean]
@@ -990,6 +1052,7 @@ module Wx::GRID
990
1052
  def auto_size_row_label_size(col) end
991
1053
 
992
1054
  # Automatically sizes all rows to fit their contents.
1055
+ #
993
1056
  # If setAsMin is true the calculated heights will also be set as the minimal heights for the rows.
994
1057
  # @param setAsMin [Boolean]
995
1058
  # @return [void]
@@ -997,6 +1060,7 @@ module Wx::GRID
997
1060
 
998
1061
  # Returns the cell fitting mode.
999
1062
  #
1063
+ #
1000
1064
  # @see Wx::GRID::GridFitMode
1001
1065
  # @param row [Integer]
1002
1066
  # @param col [Integer]
@@ -1005,6 +1069,7 @@ module Wx::GRID
1005
1069
  alias_method :cell_fit_mode, :get_cell_fit_mode
1006
1070
 
1007
1071
  # Returns true if the cell value can overflow.
1072
+ #
1008
1073
  # This is identical to calling {Wx::GRID::Grid#get_cell_fit_mode} and using {Wx::GRID::GridFitMode#is_overflow} on the returned value.
1009
1074
  # Prefer using {Wx::GRID::Grid#get_cell_fit_mode} directly in the new code.
1010
1075
  # @param row [Integer]
@@ -1019,6 +1084,7 @@ module Wx::GRID
1019
1084
  alias_method :col_label_size, :get_col_label_size
1020
1085
 
1021
1086
  # Returns the minimal width to which a column may be resized.
1087
+ #
1022
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.
1023
1089
  # @see Wx::GRID::Grid#get_row_minimal_acceptable_height
1024
1090
  # @return [Integer]
@@ -1038,6 +1104,7 @@ module Wx::GRID
1038
1104
  alias_method :col_shown?, :is_col_shown
1039
1105
 
1040
1106
  # Returns the default cell fitting mode.
1107
+ #
1041
1108
  # The default mode is "overflow", but can be modified using {Wx::GRID::Grid#set_default_cell_fit_mode}.
1042
1109
  # @see Wx::GRID::GridFitMode
1043
1110
  # @return [Wx::GRID::GridFitMode]
@@ -1045,6 +1112,7 @@ module Wx::GRID
1045
1112
  alias_method :default_cell_fit_mode, :get_default_cell_fit_mode
1046
1113
 
1047
1114
  # Returns true if the cells can overflow by default.
1115
+ #
1048
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.
1049
1117
  # Prefer using {Wx::GRID::Grid#get_default_cell_fit_mode} directly in the new code.
1050
1118
  # @return [Boolean]
@@ -1072,6 +1140,7 @@ module Wx::GRID
1072
1140
  alias_method :default_row_size, :get_default_row_size
1073
1141
 
1074
1142
  # Returns the minimal size to which rows can be resized.
1143
+ #
1075
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.
1076
1145
  # @see Wx::GRID::Grid#get_col_minimal_acceptable_width
1077
1146
  # @return [Integer]
@@ -1097,6 +1166,7 @@ module Wx::GRID
1097
1166
 
1098
1167
  # Specifies the behaviour of the cell contents if it doesn't fit into the available space.
1099
1168
  #
1169
+ #
1100
1170
  # @see Wx::GRID::GridFitMode
1101
1171
  # @param row [Integer]
1102
1172
  # @param col [Integer]
@@ -1105,6 +1175,7 @@ module Wx::GRID
1105
1175
  def set_cell_fit_mode(row, col, fitMode) end
1106
1176
 
1107
1177
  # Sets the overflow permission of the cell.
1178
+ #
1108
1179
  # Prefer using {Wx::GRID::Grid#set_cell_fit_mode} in the new code.
1109
1180
  # @param row [Integer]
1110
1181
  # @param col [Integer]
@@ -1113,6 +1184,7 @@ module Wx::GRID
1113
1184
  def set_cell_overflow(row, col, allow) end
1114
1185
 
1115
1186
  # Sets the height of the column labels.
1187
+ #
1116
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.
1117
1189
  # @param height [Integer]
1118
1190
  # @return [void]
@@ -1121,6 +1193,7 @@ module Wx::GRID
1121
1193
 
1122
1194
  # Sets the minimal width to which the user can resize columns.
1123
1195
  #
1196
+ #
1124
1197
  # @see Wx::GRID::Grid#get_col_minimal_acceptable_width
1125
1198
  # @param width [Integer]
1126
1199
  # @return [void]
@@ -1128,6 +1201,7 @@ module Wx::GRID
1128
1201
  alias_method :col_minimal_acceptable_width=, :set_col_minimal_acceptable_width
1129
1202
 
1130
1203
  # Sets the minimal width for the specified column col.
1204
+ #
1131
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.
1132
1206
  # width must be greater than the minimal acceptable column width as returned by {Wx::GRID::Grid#get_col_minimal_acceptable_width}.
1133
1207
  # @param col [Integer]
@@ -1142,6 +1216,7 @@ module Wx::GRID
1142
1216
  def set_col_size(col, width) end
1143
1217
 
1144
1218
  # Hides the specified column.
1219
+ #
1145
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.
1146
1221
  # If the column is already hidden, this method doesn't do anything.
1147
1222
  # @param col [Integer] The column index.
@@ -1149,6 +1224,7 @@ module Wx::GRID
1149
1224
  def hide_col(col) end
1150
1225
 
1151
1226
  # Shows the previously hidden column by resizing it to non-0 size.
1227
+ #
1152
1228
  # The column is shown again with the same width that it had before {Wx::GRID::Grid#hide_col} call.
1153
1229
  # If the column is currently shown, this method doesn't do anything.
1154
1230
  # @see Wx::GRID::Grid#hide_col
@@ -1159,6 +1235,7 @@ module Wx::GRID
1159
1235
 
1160
1236
  # Specifies the default behaviour of the cell contents if it doesn't fit into the available space.
1161
1237
  #
1238
+ #
1162
1239
  # @see Wx::GRID::GridFitMode
1163
1240
  # @param fitMode [Wx::GRID::GridFitMode]
1164
1241
  # @return [void]
@@ -1166,6 +1243,7 @@ module Wx::GRID
1166
1243
  alias_method :default_cell_fit_mode=, :set_default_cell_fit_mode
1167
1244
 
1168
1245
  # Sets the default overflow permission of the cells.
1246
+ #
1169
1247
  # Prefer using {Wx::GRID::Grid#set_default_cell_fit_mode} in the new code.
1170
1248
  # @param allow [Boolean]
1171
1249
  # @return [void]
@@ -1173,6 +1251,7 @@ module Wx::GRID
1173
1251
  alias_method :default_cell_overflow=, :set_default_cell_overflow
1174
1252
 
1175
1253
  # Sets the default width for columns in the grid.
1254
+ #
1176
1255
  # This will only affect columns subsequently added to the grid unless resizeExistingCols is true.
1177
1256
  # If width is less than {Wx::GRID::Grid#get_col_minimal_acceptable_width}, then the minimal acceptable width is used instead of it.
1178
1257
  # @param width [Integer]
@@ -1182,6 +1261,7 @@ module Wx::GRID
1182
1261
  alias_method :default_col_size=, :set_default_col_size
1183
1262
 
1184
1263
  # Sets the default height for rows in the grid.
1264
+ #
1185
1265
  # This will only affect rows subsequently added to the grid unless resizeExistingRows is true.
1186
1266
  # If height is less than {Wx::GRID::Grid#get_row_minimal_acceptable_height}, then the minimal acceptable height is used instead of it.
1187
1267
  # @param height [Integer]
@@ -1191,6 +1271,7 @@ module Wx::GRID
1191
1271
  alias_method :default_row_size=, :set_default_row_size
1192
1272
 
1193
1273
  # Sets the width of the row labels.
1274
+ #
1194
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.
1195
1276
  # @param width [Integer]
1196
1277
  # @return [void]
@@ -1198,6 +1279,7 @@ module Wx::GRID
1198
1279
  alias_method :row_label_size=, :set_row_label_size
1199
1280
 
1200
1281
  # Sets the minimal row height used by default.
1282
+ #
1201
1283
  # See {Wx::GRID::Grid#set_col_minimal_acceptable_width} for more information.
1202
1284
  # @param height [Integer]
1203
1285
  # @return [void]
@@ -1205,6 +1287,7 @@ module Wx::GRID
1205
1287
  alias_method :row_minimal_acceptable_height=, :set_row_minimal_acceptable_height
1206
1288
 
1207
1289
  # Sets the minimal height for the specified row.
1290
+ #
1208
1291
  # See {Wx::GRID::Grid#set_col_minimal_width} for more information.
1209
1292
  # @param row [Integer]
1210
1293
  # @param height [Integer]
@@ -1212,6 +1295,7 @@ module Wx::GRID
1212
1295
  def set_row_minimal_height(row, height) end
1213
1296
 
1214
1297
  # Sets the height of the specified row.
1298
+ #
1215
1299
  # See {Wx::GRID::Grid#set_col_size} for more information.
1216
1300
  # @param row [Integer]
1217
1301
  # @param height [Integer]
@@ -1219,6 +1303,7 @@ module Wx::GRID
1219
1303
  def set_row_size(row, height) end
1220
1304
 
1221
1305
  # Hides the specified row.
1306
+ #
1222
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.
1223
1308
  # If the row is already hidden, this method doesn't do anything.
1224
1309
  # @param col [Integer] The row index.
@@ -1226,6 +1311,7 @@ module Wx::GRID
1226
1311
  def hide_row(col) end
1227
1312
 
1228
1313
  # Shows the previously hidden row.
1314
+ #
1229
1315
  # The row is shown again with the same height that it had before {Wx::GRID::Grid#hide_row} call.
1230
1316
  # If the row is currently shown, this method doesn't do anything.
1231
1317
  # @see Wx::GRID::Grid#hide_row
@@ -1235,6 +1321,7 @@ module Wx::GRID
1235
1321
  def show_row(col) end
1236
1322
 
1237
1323
  # Get size information for all columns at once.
1324
+ #
1238
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}.
1239
1326
  # @see Wx::GRID::GridSizesInfo
1240
1327
  # @see Wx::GRID::Grid#get_row_sizes
@@ -1244,6 +1331,7 @@ module Wx::GRID
1244
1331
 
1245
1332
  # Get size information for all row at once.
1246
1333
  #
1334
+ #
1247
1335
  # @see Wx::GRID::GridSizesInfo
1248
1336
  # @see Wx::GRID::Grid#get_col_sizes
1249
1337
  # @return [Wx::GRID::GridSizesInfo]
@@ -1251,6 +1339,7 @@ module Wx::GRID
1251
1339
  alias_method :row_sizes, :get_row_sizes
1252
1340
 
1253
1341
  # Restore all columns sizes.
1342
+ #
1254
1343
  # This is usually called with {Wx::GRID::GridSizesInfo} object previously returned by {Wx::GRID::Grid#get_col_sizes}.
1255
1344
  # @see Wx::GRID::Grid#set_row_sizes
1256
1345
  # @param sizeInfo [Wx::GRID::GridSizesInfo]
@@ -1260,6 +1349,7 @@ module Wx::GRID
1260
1349
 
1261
1350
  # Restore all rows sizes.
1262
1351
  #
1352
+ #
1263
1353
  # @see Wx::GRID::Grid#set_col_sizes
1264
1354
  # @param sizeInfo [Wx::GRID::GridSizesInfo]
1265
1355
  # @return [void]
@@ -1267,6 +1357,7 @@ module Wx::GRID
1267
1357
  alias_method :row_sizes=, :set_row_sizes
1268
1358
 
1269
1359
  # Set the size of the cell.
1360
+ #
1270
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.
1271
1362
  # @see Wx::GRID::Grid#get_cell_size
1272
1363
  # @param row [Integer] The row of the cell.
@@ -1278,6 +1369,7 @@ module Wx::GRID
1278
1369
 
1279
1370
  # @overload get_cell_size(row, col)
1280
1371
  # Get the size of the cell in number of cells covered by it.
1372
+ #
1281
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.
1282
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.
1283
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
@@ -1295,9 +1387,10 @@ module Wx::GRID
1295
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).
1296
1388
  # @param row [Integer] The row of the cell.
1297
1389
  # @param col [Integer] The column of the cell.
1298
- # @return [Array(Wx::wxGrid::CellSpan,Integer,Integer)]
1390
+ # @return [Array(Wx::Grid::CellSpan,Integer,Integer)]
1299
1391
  # @overload get_cell_size(coords)
1300
1392
  # Get the number of rows and columns allocated for this cell.
1393
+ #
1301
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.
1302
1395
  # @param coords [Array(Integer, Integer)]
1303
1396
  # @return [Wx::Size]
@@ -1310,12 +1403,14 @@ module Wx::GRID
1310
1403
  alias_method :can_drag_cell?, :can_drag_cell
1311
1404
 
1312
1405
  # Returns true if columns can be moved by dragging with the mouse.
1406
+ #
1313
1407
  # Columns can be moved by dragging on their labels.
1314
1408
  # @return [Boolean]
1315
1409
  def can_drag_col_move; end
1316
1410
  alias_method :can_drag_col_move?, :can_drag_col_move
1317
1411
 
1318
1412
  # Returns true if the given column can be resized by dragging with the mouse.
1413
+ #
1319
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}.
1320
1415
  # @param col [Integer]
1321
1416
  # @return [Boolean]
@@ -1324,6 +1419,7 @@ module Wx::GRID
1324
1419
 
1325
1420
  # Return true if column edges inside the grid can be dragged to resize the rows.
1326
1421
  #
1422
+ #
1327
1423
  # @see Wx::GRID::Grid#can_drag_grid_size
1328
1424
  # @see Wx::GRID::Grid#can_drag_col_size
1329
1425
  # @return [Boolean]
@@ -1332,6 +1428,7 @@ module Wx::GRID
1332
1428
 
1333
1429
  # Return true if row edges inside the grid can be dragged to resize the rows.
1334
1430
  #
1431
+ #
1335
1432
  # @see Wx::GRID::Grid#can_drag_grid_size
1336
1433
  # @see Wx::GRID::Grid#can_drag_row_size
1337
1434
  # @return [Boolean]
@@ -1344,12 +1441,14 @@ module Wx::GRID
1344
1441
  alias_method :can_drag_grid_size?, :can_drag_grid_size
1345
1442
 
1346
1443
  # Returns true if rows can be moved by dragging with the mouse.
1444
+ #
1347
1445
  # Rows can be moved by dragging on their labels.
1348
1446
  # @return [Boolean]
1349
1447
  def can_drag_row_move; end
1350
1448
  alias_method :can_drag_row_move?, :can_drag_row_move
1351
1449
 
1352
1450
  # Returns true if the given row can be resized by dragging with the mouse.
1451
+ #
1353
1452
  # This is the same as {Wx::GRID::Grid#can_drag_col_size} but for rows.
1354
1453
  # @param row [Integer]
1355
1454
  # @return [Boolean]
@@ -1362,6 +1461,7 @@ module Wx::GRID
1362
1461
  alias_method :can_hide_columns?, :can_hide_columns
1363
1462
 
1364
1463
  # Disable interactive resizing of the specified column.
1464
+ #
1365
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).
1366
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.
1367
1467
  # Also notice that disabling interactive column resizing will not prevent the program from changing the column size.
@@ -1371,6 +1471,7 @@ module Wx::GRID
1371
1471
  def disable_col_resize(col) end
1372
1472
 
1373
1473
  # Disable interactive resizing of the specified row.
1474
+ #
1374
1475
  # This is the same as {Wx::GRID::Grid#disable_col_resize} but for rows.
1375
1476
  # @see Wx::GRID::Grid#enable_drag_row_size
1376
1477
  # @param row [Integer]
@@ -1378,31 +1479,37 @@ module Wx::GRID
1378
1479
  def disable_row_resize(row) end
1379
1480
 
1380
1481
  # Disables column moving by dragging with the mouse.
1482
+ #
1381
1483
  # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_col_move}.
1382
1484
  # @return [void]
1383
1485
  def disable_drag_col_move; end
1384
1486
 
1385
1487
  # Disables row moving by dragging with the mouse.
1488
+ #
1386
1489
  # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_row_move}.
1387
1490
  # @return [void]
1388
1491
  def disable_drag_row_move; end
1389
1492
 
1390
1493
  # Disables column sizing by dragging with the mouse.
1494
+ #
1391
1495
  # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_col_size}.
1392
1496
  # @return [void]
1393
1497
  def disable_drag_col_size; end
1394
1498
 
1395
1499
  # Disable mouse dragging of grid lines to resize rows and columns.
1500
+ #
1396
1501
  # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_grid_size}
1397
1502
  # @return [void]
1398
1503
  def disable_drag_grid_size; end
1399
1504
 
1400
1505
  # Disables row sizing by dragging with the mouse.
1506
+ #
1401
1507
  # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_row_size}.
1402
1508
  # @return [void]
1403
1509
  def disable_drag_row_size; end
1404
1510
 
1405
1511
  # Disables column hiding from the header popup menu.
1512
+ #
1406
1513
  # Equivalent to passing false to {Wx::GRID::Grid#enable_hiding_columns}.
1407
1514
  # @return [void]
1408
1515
  def disable_hiding_columns; end
@@ -1413,12 +1520,14 @@ module Wx::GRID
1413
1520
  def enable_drag_cell(enable=true) end
1414
1521
 
1415
1522
  # Enables or disables column moving by dragging with the mouse.
1523
+ #
1416
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.
1417
1525
  # @param enable [Boolean]
1418
1526
  # @return [Boolean]
1419
1527
  def enable_drag_col_move(enable=true) end
1420
1528
 
1421
1529
  # Enables or disables row moving by dragging with the mouse.
1530
+ #
1422
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.
1423
1532
  # @param enable [Boolean]
1424
1533
  # @return [Boolean]
@@ -1426,6 +1535,7 @@ module Wx::GRID
1426
1535
 
1427
1536
  # Enables or disables column sizing by dragging with the mouse.
1428
1537
  #
1538
+ #
1429
1539
  # @see Wx::GRID::Grid#disable_col_resize
1430
1540
  # @param enable [Boolean]
1431
1541
  # @return [void]
@@ -1438,12 +1548,14 @@ module Wx::GRID
1438
1548
 
1439
1549
  # Enables or disables row sizing by dragging with the mouse.
1440
1550
  #
1551
+ #
1441
1552
  # @see Wx::GRID::Grid#disable_row_resize
1442
1553
  # @param enable [Boolean]
1443
1554
  # @return [void]
1444
1555
  def enable_drag_row_size(enable=true) end
1445
1556
 
1446
1557
  # Enables or disables column hiding from the header popup menu.
1558
+ #
1447
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.
1448
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.
1449
1561
  # The main use case for this method is to disallow hiding the columns interactively when using the native header.
@@ -1471,6 +1583,7 @@ module Wx::GRID
1471
1583
  def set_col_pos(colID, newPos) end
1472
1584
 
1473
1585
  # Sets the positions of all columns at once.
1586
+ #
1474
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}.
1475
1588
  # @param order [Array<Integer>]
1476
1589
  # @return [void]
@@ -1500,6 +1613,7 @@ module Wx::GRID
1500
1613
  def set_row_pos(rowID, newPos) end
1501
1614
 
1502
1615
  # Sets the positions of all rows at once.
1616
+ #
1503
1617
  # This method takes an array containing the indices of the rows in their display order.
1504
1618
  # @param order [Array<Integer>]
1505
1619
  # @return [void]
@@ -1511,6 +1625,7 @@ module Wx::GRID
1511
1625
  def reset_row_pos; end
1512
1626
 
1513
1627
  # Returns the current grid cursor position.
1628
+ #
1514
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>.
1515
1630
  # @return [Array(Integer, Integer)]
1516
1631
  def get_grid_cursor_coords; end
@@ -1518,6 +1633,7 @@ module Wx::GRID
1518
1633
 
1519
1634
  # Returns the current grid cell column position.
1520
1635
  #
1636
+ #
1521
1637
  # @see Wx::GRID::Grid#get_grid_cursor_coords
1522
1638
  # @return [Integer]
1523
1639
  def get_grid_cursor_col; end
@@ -1525,6 +1641,7 @@ module Wx::GRID
1525
1641
 
1526
1642
  # Returns the current grid cell row position.
1527
1643
  #
1644
+ #
1528
1645
  # @see Wx::GRID::Grid#get_grid_cursor_coords
1529
1646
  # @return [Integer]
1530
1647
  def get_grid_cursor_row; end
@@ -1532,60 +1649,70 @@ module Wx::GRID
1532
1649
 
1533
1650
  # @overload go_to_cell(row, col)
1534
1651
  # Make the given cell current and ensure it is visible.
1652
+ #
1535
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.
1536
1654
  # @param row [Integer]
1537
1655
  # @param col [Integer]
1538
1656
  # @return [void]
1539
1657
  # @overload go_to_cell(coords)
1540
1658
  # Make the given cell current and ensure it is visible.
1659
+ #
1541
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.
1542
1661
  # @param coords [Array(Integer, Integer)]
1543
1662
  # @return [void]
1544
1663
  def go_to_cell(*args) end
1545
1664
 
1546
1665
  # Moves the grid cursor down by one row.
1666
+ #
1547
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.
1548
1668
  # @param expandSelection [Boolean]
1549
1669
  # @return [Boolean]
1550
1670
  def move_cursor_down(expandSelection) end
1551
1671
 
1552
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
+ #
1553
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.
1554
1675
  # @param expandSelection [Boolean]
1555
1676
  # @return [Boolean]
1556
1677
  def move_cursor_down_block(expandSelection) end
1557
1678
 
1558
1679
  # Moves the grid cursor left by one column.
1680
+ #
1559
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.
1560
1682
  # @param expandSelection [Boolean]
1561
1683
  # @return [Boolean]
1562
1684
  def move_cursor_left(expandSelection) end
1563
1685
 
1564
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
+ #
1565
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.
1566
1689
  # @param expandSelection [Boolean]
1567
1690
  # @return [Boolean]
1568
1691
  def move_cursor_left_block(expandSelection) end
1569
1692
 
1570
1693
  # Moves the grid cursor right by one column.
1694
+ #
1571
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.
1572
1696
  # @param expandSelection [Boolean]
1573
1697
  # @return [Boolean]
1574
1698
  def move_cursor_right(expandSelection) end
1575
1699
 
1576
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
+ #
1577
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.
1578
1703
  # @param expandSelection [Boolean]
1579
1704
  # @return [Boolean]
1580
1705
  def move_cursor_right_block(expandSelection) end
1581
1706
 
1582
1707
  # Moves the grid cursor up by one row.
1708
+ #
1583
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.
1584
1710
  # @param expandSelection [Boolean]
1585
1711
  # @return [Boolean]
1586
1712
  def move_cursor_up(expandSelection) end
1587
1713
 
1588
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
+ #
1589
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.
1590
1717
  # @param expandSelection [Boolean]
1591
1718
  # @return [Boolean]
@@ -1601,6 +1728,7 @@ module Wx::GRID
1601
1728
 
1602
1729
  # @overload set_grid_cursor(row, col)
1603
1730
  # Set the grid cursor to the specified cell.
1731
+ #
1604
1732
  # The grid cursor indicates the current cell and can be moved by the user using the arrow keys or the mouse.
1605
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.
1606
1734
  # This function doesn't make the target call visible, use {Wx::GRID::Grid#go_to_cell} to do this.
@@ -1609,6 +1737,7 @@ module Wx::GRID
1609
1737
  # @return [void]
1610
1738
  # @overload set_grid_cursor(coords)
1611
1739
  # Set the grid cursor to the specified cell.
1740
+ #
1612
1741
  # The grid cursor indicates the current cell and can be moved by the user using the arrow keys or the mouse.
1613
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.
1614
1743
  # This function doesn't make the target call visible, use {Wx::GRID::Grid#go_to_cell} to do this.
@@ -1618,10 +1747,11 @@ module Wx::GRID
1618
1747
  alias_method :grid_cursor=, :set_grid_cursor
1619
1748
 
1620
1749
  # Set the grid's behaviour when the user presses the TAB key.
1750
+ #
1621
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.
1622
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.
1623
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.
1624
- # @param behaviour [Wx::wxGrid::TabBehaviour]
1754
+ # @param behaviour [Wx::Grid::TabBehaviour]
1625
1755
  # @return [void]
1626
1756
  def set_tab_behaviour(behaviour) end
1627
1757
  alias_method :tab_behaviour=, :set_tab_behaviour
@@ -1647,6 +1777,7 @@ module Wx::GRID
1647
1777
  def deselect_cell(row, col) end
1648
1778
 
1649
1779
  # Returns a range of grid selection blocks.
1780
+ #
1650
1781
  # The returned range can be iterated over, e.g. with C++11 range-for loop:
1651
1782
  # ```
1652
1783
  # for ( const auto block: grid->GetSelectedBlocks() ) {
@@ -1661,6 +1792,7 @@ module Wx::GRID
1661
1792
  alias_method :selected_blocks, :get_selected_blocks
1662
1793
 
1663
1794
  # Returns an ordered range of non-overlapping selected rows.
1795
+ #
1664
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.
1665
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.
1666
1798
  # This method returns empty vector for the other selection modes.
@@ -1671,6 +1803,7 @@ module Wx::GRID
1671
1803
  alias_method :selected_row_blocks, :get_selected_row_blocks
1672
1804
 
1673
1805
  # Returns an ordered range of non-overlapping selected columns.
1806
+ #
1674
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.
1675
1808
  # @see Wx::GRID::Grid#get_selected_blocks
1676
1809
  # @return [Array<Wx::GRID::GridBlockCoords>]
@@ -1678,6 +1811,7 @@ module Wx::GRID
1678
1811
  alias_method :selected_col_blocks, :get_selected_col_blocks
1679
1812
 
1680
1813
  # Returns an array of individually selected cells.
1814
+ #
1681
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.
1682
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).
1683
1817
  # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
@@ -1686,6 +1820,7 @@ module Wx::GRID
1686
1820
  alias_method :selected_cells, :get_selected_cells
1687
1821
 
1688
1822
  # Returns an array of selected columns.
1823
+ #
1689
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.
1690
1825
  # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1691
1826
  # @return [Array<Integer>]
@@ -1693,6 +1828,7 @@ module Wx::GRID
1693
1828
  alias_method :selected_cols, :get_selected_cols
1694
1829
 
1695
1830
  # Returns an array of selected rows.
1831
+ #
1696
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.
1697
1833
  # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1698
1834
  # @return [Array<Integer>]
@@ -1705,6 +1841,7 @@ module Wx::GRID
1705
1841
  alias_method :selection_background, :get_selection_background
1706
1842
 
1707
1843
  # Returns an array of the bottom right corners of blocks of selected cells.
1844
+ #
1708
1845
  # Please see {Wx::GRID::Grid#get_selected_cells} for more information about the selection representation in {Wx::GRID::Grid}.
1709
1846
  # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1710
1847
  # @see Wx::GRID::Grid#get_selection_block_top_left
@@ -1713,6 +1850,7 @@ module Wx::GRID
1713
1850
  alias_method :selection_block_bottom_right, :get_selection_block_bottom_right
1714
1851
 
1715
1852
  # Returns an array of the top left corners of blocks of selected cells.
1853
+ #
1716
1854
  # Please see {Wx::GRID::Grid#get_selected_cells} for more information about the selection representation in {Wx::GRID::Grid}.
1717
1855
  # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1718
1856
  # @see Wx::GRID::Grid#get_selection_block_bottom_right
@@ -1727,8 +1865,9 @@ module Wx::GRID
1727
1865
 
1728
1866
  # Returns the current selection mode.
1729
1867
  #
1868
+ #
1730
1869
  # @see Wx::GRID::Grid#set_selection_mode.
1731
- # @return [Wx::wxGrid::GridSelectionModes]
1870
+ # @return [Wx::Grid::GridSelectionModes]
1732
1871
  def get_selection_mode; end
1733
1872
  alias_method :selection_mode, :get_selection_mode
1734
1873
 
@@ -1749,6 +1888,7 @@ module Wx::GRID
1749
1888
  def select_all; end
1750
1889
 
1751
1890
  # Selects a rectangular block of cells.
1891
+ #
1752
1892
  # If addToSelected is false then any existing selection will be deselected; if true the column will be added to the existing selection.
1753
1893
  # @param topRow [Integer]
1754
1894
  # @param leftCol [Integer]
@@ -1759,6 +1899,7 @@ module Wx::GRID
1759
1899
  def select_block(topRow, leftCol, bottomRow, rightCol, addToSelected=false) end
1760
1900
 
1761
1901
  # Selects the specified column.
1902
+ #
1762
1903
  # If addToSelected is false then any existing selection will be deselected; if true the column will be added to the existing selection.
1763
1904
  # This method won't select anything if the current selection mode is {Wx::GRID::Grid::GridSelectionModes::GridSelectRows}.
1764
1905
  # @param col [Integer]
@@ -1767,6 +1908,7 @@ module Wx::GRID
1767
1908
  def select_col(col, addToSelected=false) end
1768
1909
 
1769
1910
  # Selects the specified row.
1911
+ #
1770
1912
  # If addToSelected is false then any existing selection will be deselected; if true the row will be added to the existing selection.
1771
1913
  # This method won't select anything if the current selection mode is {Wx::GRID::Grid::GridSelectionModes::GridSelectColumns}.
1772
1914
  # @param row [Integer]
@@ -1787,13 +1929,15 @@ module Wx::GRID
1787
1929
  alias_method :selection_foreground=, :set_selection_foreground
1788
1930
 
1789
1931
  # Set the selection behaviour of the grid.
1932
+ #
1790
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).
1791
- # @param selmode [Wx::wxGrid::GridSelectionModes]
1934
+ # @param selmode [Wx::Grid::GridSelectionModes]
1792
1935
  # @return [void]
1793
1936
  def set_selection_mode(selmode) end
1794
1937
  alias_method :selection_mode=, :set_selection_mode
1795
1938
 
1796
1939
  # Returns the number of pixels per horizontal scroll increment.
1940
+ #
1797
1941
  # The default is 15.
1798
1942
  # @see Wx::GRID::Grid#get_scroll_line_y
1799
1943
  # @see Wx::GRID::Grid#set_scroll_line_x
@@ -1803,6 +1947,7 @@ module Wx::GRID
1803
1947
  alias_method :scroll_line_x, :get_scroll_line_x
1804
1948
 
1805
1949
  # Returns the number of pixels per vertical scroll increment.
1950
+ #
1806
1951
  # The default is 15.
1807
1952
  # @see Wx::GRID::Grid#get_scroll_line_x
1808
1953
  # @see Wx::GRID::Grid#set_scroll_line_x
@@ -1812,6 +1957,7 @@ module Wx::GRID
1812
1957
  alias_method :scroll_line_y, :get_scroll_line_y
1813
1958
 
1814
1959
  # Returns true if a cell is either entirely or at least partially visible in the grid window.
1960
+ #
1815
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.
1816
1962
  # @param row [Integer]
1817
1963
  # @param col [Integer]
@@ -1821,6 +1967,7 @@ module Wx::GRID
1821
1967
  alias_method :visible?, :is_visible
1822
1968
 
1823
1969
  # Brings the specified cell into the visible grid cell area with minimal scrolling.
1970
+ #
1824
1971
  # Does nothing if the cell is already visible.
1825
1972
  # @param row [Integer]
1826
1973
  # @param col [Integer]
@@ -1828,18 +1975,21 @@ module Wx::GRID
1828
1975
  def make_cell_visible(row, col) end
1829
1976
 
1830
1977
  # Returns the topmost row of the current visible area.
1978
+ #
1831
1979
  # Returns -1 if the grid doesn't have any rows.
1832
1980
  # @return [Integer]
1833
1981
  def get_first_fully_visible_row; end
1834
1982
  alias_method :first_fully_visible_row, :get_first_fully_visible_row
1835
1983
 
1836
1984
  # Returns the leftmost column of the current visible area.
1985
+ #
1837
1986
  # Returns -1 if the grid doesn't have any columns.
1838
1987
  # @return [Integer]
1839
1988
  def get_first_fully_visible_column; end
1840
1989
  alias_method :first_fully_visible_column, :get_first_fully_visible_column
1841
1990
 
1842
1991
  # Sets the number of pixels per horizontal scroll increment.
1992
+ #
1843
1993
  # The default is 15.
1844
1994
  # @see Wx::GRID::Grid#get_scroll_line_x
1845
1995
  # @see Wx::GRID::Grid#get_scroll_line_y
@@ -1850,6 +2000,7 @@ module Wx::GRID
1850
2000
  alias_method :scroll_line_x=, :set_scroll_line_x
1851
2001
 
1852
2002
  # Sets the number of pixels per vertical scroll increment.
2003
+ #
1853
2004
  # The default is 15.
1854
2005
  # @see Wx::GRID::Grid#get_scroll_line_x
1855
2006
  # @see Wx::GRID::Grid#get_scroll_line_y
@@ -1860,6 +2011,7 @@ module Wx::GRID
1860
2011
  alias_method :scroll_line_y=, :set_scroll_line_y
1861
2012
 
1862
2013
  # Convert grid cell coordinates to grid window pixel coordinates.
2014
+ #
1863
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.
1864
2016
  # @see Wx::GRID::Grid#cell_to_rect
1865
2017
  # @param topLeft [Array(Integer, Integer)]
@@ -1870,6 +2022,7 @@ module Wx::GRID
1870
2022
 
1871
2023
  # Return the rectangle corresponding to the grid cell's size and position in logical coordinates.
1872
2024
  #
2025
+ #
1873
2026
  # @see Wx::GRID::Grid#block_to_device_rect
1874
2027
  # @param row [Integer]
1875
2028
  # @param col [Integer]
@@ -1878,6 +2031,7 @@ module Wx::GRID
1878
2031
 
1879
2032
  # @overload cell_to_grid_window(row, col)
1880
2033
  # Returns the grid window that contains the cell.
2034
+ #
1881
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.
1882
2036
  # @param row [Integer]
1883
2037
  # @param col [Integer]
@@ -1918,6 +2072,7 @@ module Wx::GRID
1918
2072
  def calc_grid_window_scrolled_position(pt, gridWindow) end
1919
2073
 
1920
2074
  # Returns the column at the given pixel position depending on the window.
2075
+ #
1921
2076
  # The column index or {Wx::NOT_FOUND}.
1922
2077
  # @param x [Integer] The x position to evaluate.
1923
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.
@@ -1926,6 +2081,7 @@ module Wx::GRID
1926
2081
  def x_to_col(x, clipToMinMax=false, gridWindow=nil) end
1927
2082
 
1928
2083
  # Returns the column whose right hand edge is close to the given logical x position.
2084
+ #
1929
2085
  # If no column edge is near to this position {Wx::NOT_FOUND} is returned.
1930
2086
  # @param x [Integer]
1931
2087
  # @return [Integer]
@@ -1933,6 +2089,7 @@ module Wx::GRID
1933
2089
 
1934
2090
  # @overload xy_to_cell(x, y, gridWindow=nil)
1935
2091
  # Translates logical pixel coordinates to the grid cell coordinates.
2092
+ #
1936
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.
1937
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.
1938
2095
  # If gridWindow is NULL, coordinates are relative to the main grid window and all cells are considered.
@@ -1950,12 +2107,14 @@ module Wx::GRID
1950
2107
  def xy_to_cell(*args) end
1951
2108
 
1952
2109
  # Returns the row whose bottom edge is close to the given logical y position.
2110
+ #
1953
2111
  # If no row edge is near to this position {Wx::NOT_FOUND} is returned.
1954
2112
  # @param y [Integer]
1955
2113
  # @return [Integer]
1956
2114
  def y_to_edge_of_row(y) end
1957
2115
 
1958
2116
  # Returns the grid row that corresponds to the logical y coordinate.
2117
+ #
1959
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.
1960
2119
  # If gridWindow is NULL, the function returns {Wx::NOT_FOUND} only if there is no row at all at the y position.
1961
2120
  # @param y [Integer]
@@ -1965,6 +2124,7 @@ module Wx::GRID
1965
2124
  def y_to_row(y, clipToMinMax=false, gridWindow=nil) end
1966
2125
 
1967
2126
  # Appends one or more new columns to the right of the grid.
2127
+ #
1968
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.
1969
2129
  # true on success or false if appending columns failed.
1970
2130
  # @param numCols [Integer]
@@ -1973,6 +2133,7 @@ module Wx::GRID
1973
2133
  def append_cols(numCols=1, updateLabels=true) end
1974
2134
 
1975
2135
  # Appends one or more new rows to the bottom of the grid.
2136
+ #
1976
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.
1977
2138
  # true on success or false if appending rows failed.
1978
2139
  # @param numRows [Integer]
@@ -1981,6 +2142,7 @@ module Wx::GRID
1981
2142
  def append_rows(numRows=1, updateLabels=true) end
1982
2143
 
1983
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
+ #
1984
2146
  # The default is to clip grid lines.
1985
2147
  # @see Wx::GRID::Grid#clip_horz_grid_lines
1986
2148
  # @see Wx::GRID::Grid#are_vert_grid_lines_clipped
@@ -1988,6 +2150,7 @@ module Wx::GRID
1988
2150
  def are_horz_grid_lines_clipped; end
1989
2151
 
1990
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
+ #
1991
2154
  # The default is to clip grid lines.
1992
2155
  # @see Wx::GRID::Grid#clip_vert_grid_lines
1993
2156
  # @see Wx::GRID::Grid#are_horz_grid_lines_clipped
@@ -1995,17 +2158,20 @@ module Wx::GRID
1995
2158
  def are_vert_grid_lines_clipped; end
1996
2159
 
1997
2160
  # Increments the grid's batch count.
2161
+ #
1998
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.
1999
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.
2000
2164
  # @return [void]
2001
2165
  def begin_batch; end
2002
2166
 
2003
2167
  # Clears all data in the underlying grid table and repaints the grid.
2168
+ #
2004
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.
2005
2170
  # @return [void]
2006
2171
  def clear_grid; end
2007
2172
 
2008
2173
  # Change whether the horizontal grid lines are clipped by the end of the last column.
2174
+ #
2009
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.
2010
2176
  # @see Wx::GRID::Grid#are_horz_grid_lines_clipped
2011
2177
  # @see Wx::GRID::Grid#clip_vert_grid_lines
@@ -2014,6 +2180,7 @@ module Wx::GRID
2014
2180
  def clip_horz_grid_lines(clip) end
2015
2181
 
2016
2182
  # Change whether the vertical grid lines are clipped by the end of the last row.
2183
+ #
2017
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.
2018
2185
  # @see Wx::GRID::Grid#are_vert_grid_lines_clipped
2019
2186
  # @see Wx::GRID::Grid#clip_horz_grid_lines
@@ -2022,6 +2189,7 @@ module Wx::GRID
2022
2189
  def clip_vert_grid_lines(clip) end
2023
2190
 
2024
2191
  # Deletes one or more columns from a grid starting at the specified position.
2192
+ #
2025
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.
2026
2194
  # true on success or false if deleting columns failed.
2027
2195
  # @param pos [Integer]
@@ -2031,6 +2199,7 @@ module Wx::GRID
2031
2199
  def delete_cols(pos=0, numCols=1, updateLabels=true) end
2032
2200
 
2033
2201
  # Deletes one or more rows from a grid starting at the specified position.
2202
+ #
2034
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.
2035
2204
  # true on success or false if deleting rows failed.
2036
2205
  # @param pos [Integer]
@@ -2041,6 +2210,7 @@ module Wx::GRID
2041
2210
 
2042
2211
  # @overload freeze_to(row, col)
2043
2212
  # Sets or resets the frozen columns and rows.
2213
+ #
2044
2214
  # true on success or false if it failed.
2045
2215
  #
2046
2216
  # Note that this method doesn't do anything, and returns false, if any of the following conditions are true:
@@ -2061,6 +2231,7 @@ module Wx::GRID
2061
2231
  def freeze_to(*args) end
2062
2232
 
2063
2233
  # Decrements the grid's batch count.
2234
+ #
2064
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.
2065
2236
  # @see Wx::GridUpdateLocker
2066
2237
  # @return [void]
@@ -2071,29 +2242,34 @@ module Wx::GRID
2071
2242
  def fit; end
2072
2243
 
2073
2244
  # Causes immediate repainting of the grid.
2245
+ #
2074
2246
  # Use this instead of the usual {Wx::Window#refresh}.
2075
2247
  # @return [void]
2076
2248
  def force_refresh; end
2077
2249
 
2078
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
+ #
2079
2252
  # While the grid's batch count is greater than zero the display will not be updated.
2080
2253
  # @return [Integer]
2081
2254
  def get_batch_count; end
2082
2255
  alias_method :batch_count, :get_batch_count
2083
2256
 
2084
2257
  # Returns the total number of grid columns.
2258
+ #
2085
2259
  # This is the same as the number of columns in the underlying grid table.
2086
2260
  # @return [Integer]
2087
2261
  def get_number_cols; end
2088
2262
  alias_method :number_cols, :get_number_cols
2089
2263
 
2090
2264
  # Returns the total number of grid rows.
2265
+ #
2091
2266
  # This is the same as the number of rows in the underlying grid table.
2092
2267
  # @return [Integer]
2093
2268
  def get_number_rows; end
2094
2269
  alias_method :number_rows, :get_number_rows
2095
2270
 
2096
2271
  # Returns the number of frozen grid columns.
2272
+ #
2097
2273
  # If there are no frozen columns, returns 0.
2098
2274
  # @see Wx::GRID::Grid#freeze_to
2099
2275
  # @return [Integer]
@@ -2101,6 +2277,7 @@ module Wx::GRID
2101
2277
  alias_method :number_frozen_cols, :get_number_frozen_cols
2102
2278
 
2103
2279
  # Returns the number of frozen grid rows.
2280
+ #
2104
2281
  # If there are no frozen rows, returns 0.
2105
2282
  # @see Wx::GRID::Grid#freeze_to
2106
2283
  # @return [Integer]
@@ -2108,6 +2285,7 @@ module Wx::GRID
2108
2285
  alias_method :number_frozen_rows, :get_number_frozen_rows
2109
2286
 
2110
2287
  # Returns the attribute for the given cell creating one if necessary.
2288
+ #
2111
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.
2112
2290
  # Prefer to use {Wx::GRID::Grid#get_or_create_cell_attr_ptr} to avoid the need to call DecRef() on the returned pointer.
2113
2291
  # This function may only be called if {Wx::GRID::Grid#can_have_attributes} returns true.
@@ -2118,12 +2296,14 @@ module Wx::GRID
2118
2296
  alias_method :or_create_cell_attr, :get_or_create_cell_attr
2119
2297
 
2120
2298
  # Returns a base pointer to the current table object.
2299
+ #
2121
2300
  # The returned pointer is still owned by the grid.
2122
2301
  # @return [Wx::GRID::GridTableBase]
2123
2302
  def get_table; end
2124
2303
  alias_method :table, :get_table
2125
2304
 
2126
2305
  # Inserts one or more new columns into a grid with the first new column at the specified position.
2306
+ #
2127
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.
2128
2308
  #
2129
2309
  # true if the columns were successfully inserted, false if an error occurred (most likely the table couldn't be updated).
@@ -2134,6 +2314,7 @@ module Wx::GRID
2134
2314
  def insert_cols(pos=0, numCols=1, updateLabels=true) end
2135
2315
 
2136
2316
  # Inserts one or more new rows into a grid with the first new row at the specified position.
2317
+ #
2137
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.
2138
2319
  #
2139
2320
  # true if the rows were successfully inserted, false if an error occurred (most likely the table couldn't be updated).
@@ -2144,6 +2325,7 @@ module Wx::GRID
2144
2325
  def insert_rows(pos=0, numRows=1, updateLabels=true) end
2145
2326
 
2146
2327
  # Invalidates the cached attribute for the given cell.
2328
+ #
2147
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.
2148
2330
  # @param row [Integer] The row of the cell whose attribute needs to be queried again.
2149
2331
  # @param col [Integer] The column of the cell whose attribute needs to be queried again.
@@ -2152,6 +2334,7 @@ module Wx::GRID
2152
2334
 
2153
2335
  # @overload refresh_block(topLeft, bottomRight)
2154
2336
  # Redraw all the cells in the given block.
2337
+ #
2155
2338
  # Refresh the block of cells with the given corners.
2156
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.
2157
2340
  # @param topLeft [Array(Integer, Integer)]
@@ -2167,6 +2350,7 @@ module Wx::GRID
2167
2350
  def refresh_block(*args) end
2168
2351
 
2169
2352
  # Draws part or all of a {Wx::GRID::Grid} on a {Wx::DC} for printing or display.
2353
+ #
2170
2354
  # Pagination can be accomplished by using sequential {Wx::GRID::Grid#render} calls with appropriate values in {Wx::GridCellCoords} topLeft and bottomRight.
2171
2355
  # @param dc [Wx::DC] The {Wx::DC} to be drawn on.
2172
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().
@@ -2178,6 +2362,7 @@ module Wx::GRID
2178
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
2179
2363
 
2180
2364
  # Sets the cell attributes for the specified cell.
2365
+ #
2181
2366
  # The grid takes ownership of the attribute pointer.
2182
2367
  # See the {Wx::GRID::GridCellAttr} class for more information about controlling cell attributes.
2183
2368
  # @param row [Integer]
@@ -2187,6 +2372,7 @@ module Wx::GRID
2187
2372
  def set_attr(row, col, attr) end
2188
2373
 
2189
2374
  # Sets the cell attributes for all cells in the specified column.
2375
+ #
2190
2376
  # For more information about controlling grid cell attributes see the {Wx::GRID::GridCellAttr} cell attribute class and the wxGrid Overview.
2191
2377
  # @param col [Integer]
2192
2378
  # @param attr [Wx::GRID::GridCellAttr]
@@ -2194,6 +2380,7 @@ module Wx::GRID
2194
2380
  def set_col_attr(col, attr) end
2195
2381
 
2196
2382
  # Sets the extra margins used around the grid area.
2383
+ #
2197
2384
  # A grid may occupy more space than needed for its data display and this function allows setting how big this extra space is
2198
2385
  # @param extraWidth [Integer]
2199
2386
  # @param extraHeight [Integer]
@@ -2201,6 +2388,7 @@ module Wx::GRID
2201
2388
  def set_margins(extraWidth, extraHeight) end
2202
2389
 
2203
2390
  # Sets the cell attributes for all cells in the specified row.
2391
+ #
2204
2392
  # The grid takes ownership of the attribute pointer.
2205
2393
  # See the {Wx::GRID::GridCellAttr} class for more information about controlling cell attributes.
2206
2394
  # @param row [Integer]
@@ -2209,6 +2397,7 @@ module Wx::GRID
2209
2397
  def set_row_attr(row, attr) end
2210
2398
 
2211
2399
  # Appends one or more new columns to the right of the grid.
2400
+ #
2212
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.
2213
2402
  # true on success or false if appending columns failed.
2214
2403
  # @param reg [Wx::Region]
@@ -2217,6 +2406,7 @@ module Wx::GRID
2217
2406
  def calc_row_labels_exposed(reg, gridWindow=nil) end
2218
2407
 
2219
2408
  # Appends one or more new columns to the right of the grid.
2409
+ #
2220
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.
2221
2411
  # true on success or false if appending columns failed.
2222
2412
  # @param reg [Wx::Region]
@@ -2225,6 +2415,7 @@ module Wx::GRID
2225
2415
  def calc_col_labels_exposed(reg, gridWindow=nil) end
2226
2416
 
2227
2417
  # Appends one or more new columns to the right of the grid.
2418
+ #
2228
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.
2229
2420
  # true on success or false if appending columns failed.
2230
2421
  # @param reg [Wx::Region]
@@ -2233,6 +2424,7 @@ module Wx::GRID
2233
2424
  def calc_cells_exposed(reg, gridWindow=nil) end
2234
2425
 
2235
2426
  # Return the column in which the sorting indicator is currently displayed.
2427
+ #
2236
2428
  # Returns {Wx::NOT_FOUND} if sorting indicator is not currently displayed at all.
2237
2429
  # @see Wx::GRID::Grid#set_sorting_column
2238
2430
  # @return [Integer]
@@ -2241,6 +2433,7 @@ module Wx::GRID
2241
2433
 
2242
2434
  # Return true if this column is currently used for sorting.
2243
2435
  #
2436
+ #
2244
2437
  # @see Wx::GRID::Grid#get_sorting_column
2245
2438
  # @param col [Integer]
2246
2439
  # @return [Boolean]
@@ -2248,6 +2441,7 @@ module Wx::GRID
2248
2441
  alias_method :sorting_by?, :is_sorting_by
2249
2442
 
2250
2443
  # Return true if the current sorting order is ascending or false if it is descending.
2444
+ #
2251
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}.
2252
2446
  # @see Wx::GRID::Grid#set_sorting_column
2253
2447
  # @return [Boolean]
@@ -2256,6 +2450,7 @@ module Wx::GRID
2256
2450
 
2257
2451
  # Set the column to display the sorting indicator in and its direction.
2258
2452
  #
2453
+ #
2259
2454
  # @see Wx::GRID::Grid#get_sorting_column
2260
2455
  # @see Wx::GRID::Grid#is_sort_order_ascending
2261
2456
  # @param col [Integer] The column to display the sorting indicator in or {Wx::NOT_FOUND} to remove any currently displayed sorting indicator.
@@ -2265,41 +2460,48 @@ module Wx::GRID
2265
2460
  alias_method :sorting_column=, :set_sorting_column
2266
2461
 
2267
2462
  # Remove any currently shown sorting indicator.
2463
+ #
2268
2464
  # This is equivalent to calling {Wx::GRID::Grid#set_sorting_column} with {Wx::NOT_FOUND} first argument.
2269
2465
  # @return [void]
2270
2466
  def unset_sorting_column; end
2271
2467
 
2272
2468
  # Return the main grid window containing the grid cells.
2469
+ #
2273
2470
  # This window is always shown.
2274
2471
  # @return [Wx::Window]
2275
2472
  def get_grid_window; end
2276
2473
  alias_method :grid_window, :get_grid_window
2277
2474
 
2278
2475
  # Return the corner grid window containing frozen cells.
2476
+ #
2279
2477
  # This window is shown only when there are frozen rows and columns.
2280
2478
  # @return [Wx::Window]
2281
2479
  def get_frozen_corner_grid_window; end
2282
2480
  alias_method :frozen_corner_grid_window, :get_frozen_corner_grid_window
2283
2481
 
2284
2482
  # Return the rows grid window containing row frozen cells.
2483
+ #
2285
2484
  # This window is shown only when there are frozen rows.
2286
2485
  # @return [Wx::Window]
2287
2486
  def get_frozen_row_grid_window; end
2288
2487
  alias_method :frozen_row_grid_window, :get_frozen_row_grid_window
2289
2488
 
2290
2489
  # Return the columns grid window containing column frozen cells.
2490
+ #
2291
2491
  # This window is shown only when there are frozen columns.
2292
2492
  # @return [Wx::Window]
2293
2493
  def get_frozen_col_grid_window; end
2294
2494
  alias_method :frozen_col_grid_window, :get_frozen_col_grid_window
2295
2495
 
2296
2496
  # Return the row labels window.
2497
+ #
2297
2498
  # This window is not shown if the row labels were hidden using {Wx::GRID::Grid#hide_row_labels}.
2298
2499
  # @return [Wx::Window]
2299
2500
  def get_grid_row_label_window; end
2300
2501
  alias_method :grid_row_label_window, :get_grid_row_label_window
2301
2502
 
2302
2503
  # Return the column labels window.
2504
+ #
2303
2505
  # This window is not shown if the columns labels were hidden using {Wx::GRID::Grid#hide_col_labels}.
2304
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.
2305
2507
  # @return [Wx::Window]
@@ -2307,12 +2509,14 @@ module Wx::GRID
2307
2509
  alias_method :grid_col_label_window, :get_grid_col_label_window
2308
2510
 
2309
2511
  # Return the window in the top left grid corner.
2512
+ #
2310
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.
2311
2514
  # @return [Wx::Window]
2312
2515
  def get_grid_corner_label_window; end
2313
2516
  alias_method :grid_corner_label_window, :get_grid_corner_label_window
2314
2517
 
2315
2518
  # Return the header control used for column labels display.
2519
+ #
2316
2520
  # This function can only be called if {Wx::GRID::Grid#use_native_col_header} had been called.
2317
2521
  # @see Wx::GRID::Grid#is_using_native_header
2318
2522
  # @return [Wx::HeaderCtrl]
@@ -2411,6 +2615,7 @@ module Wx::GRID
2411
2615
  end # Grid
2412
2616
 
2413
2617
  # Represents coordinates of a block of cells in the grid.
2618
+ #
2414
2619
  # An object of this class contains coordinates of the left top and the bottom right corners of a block.
2415
2620
  #
2416
2621
  #
@@ -2420,6 +2625,7 @@ module Wx::GRID
2420
2625
 
2421
2626
  # @overload initialize()
2422
2627
  # Default constructor initializes the object to invalid state.
2628
+ #
2423
2629
  # Initially the coordinates are invalid (-1) and so {Wx::GRID::GridBlockCoords#!()} for an uninitialized {Wx::GRID::GridBlockCoords} returns true.
2424
2630
  # @return [Wx::GRID::GridBlockCoords]
2425
2631
  # @overload initialize(topRow, leftCol, bottomRow, rightCol)
@@ -2490,6 +2696,7 @@ module Wx::GRID
2490
2696
  def canonicalize; end
2491
2697
 
2492
2698
  # Whether the blocks intersect.
2699
+ #
2493
2700
  # true, if the block intersects with the other, false, otherwise.
2494
2701
  # @param other [Wx::GRID::GridBlockCoords]
2495
2702
  # @return [Boolean]
@@ -2497,17 +2704,20 @@ module Wx::GRID
2497
2704
 
2498
2705
  # @overload contains(cell)
2499
2706
  # Check whether this block contains the given cell.
2707
+ #
2500
2708
  # true, if the block contains the cell, false otherwise.
2501
2709
  # @param cell [Array(Integer, Integer)]
2502
2710
  # @return [Boolean]
2503
2711
  # @overload contains(other)
2504
2712
  # Check whether this block contains another one.
2713
+ #
2505
2714
  # true if other is entirely contained within this block.
2506
2715
  # @param other [Wx::GRID::GridBlockCoords]
2507
2716
  # @return [Boolean]
2508
2717
  def contains(*args) end
2509
2718
 
2510
2719
  # Calculates the result blocks by subtracting the other block from this block.
2720
+ #
2511
2721
  # Up to 4 blocks. If block doesn't exist in the result, it has value of {Wx::GridNoBlockCoords}.
2512
2722
  # @param other [Wx::GRID::GridBlockCoords] The block to subtract from this block.
2513
2723
  # @param splitOrientation [Integer] The block splitting orientation (either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}).
@@ -2515,6 +2725,7 @@ module Wx::GRID
2515
2725
  def difference(other, splitOrientation) end
2516
2726
 
2517
2727
  # Calculates the symmetric difference of the blocks.
2728
+ #
2518
2729
  # Up to 4 blocks. If block doesn't exist in the result, it has value of {Wx::GridNoBlockCoords}.
2519
2730
  # @param other [Wx::GRID::GridBlockCoords] The block to subtract from this block.
2520
2731
  # @return [Wx::GRID::GridBlockDiffResult]
@@ -2528,6 +2739,7 @@ module Wx::GRID
2528
2739
  end # GridBlockCoords
2529
2740
 
2530
2741
  # The helper struct uses as a result type for difference functions of {Wx::GRID::GridBlockCoords} class.
2742
+ #
2531
2743
  # Parts can be uninitialized (equals to {Wx::GridNoBlockCoords}), that means that the corresponding part doesn't exists in the result.
2532
2744
  #
2533
2745
  #
@@ -2538,6 +2750,7 @@ module Wx::GRID
2538
2750
  end # GridBlockDiffResult
2539
2751
 
2540
2752
  # {Wx::GRID::GridSizesInfo} stores information about sizes of all {Wx::GRID::Grid} rows or columns.
2753
+ #
2541
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.
2542
2755
  # This structure is particularly useful for serializing the sizes of all {Wx::GRID::Grid} elements at once.
2543
2756
  #
@@ -2574,10 +2787,12 @@ module Wx::GRID
2574
2787
 
2575
2788
  # @overload initialize()
2576
2789
  # Default constructor.
2790
+ #
2577
2791
  # m_sizeDefault and m_customSizes must be initialized later.
2578
2792
  # @return [Wx::GRID::GridSizesInfo]
2579
2793
  # @overload initialize(defSize, allSizes)
2580
2794
  # Constructor.
2795
+ #
2581
2796
  # This constructor is used by {Wx::GRID::Grid#get_row_sizes} and GetColSizes() methods. User code will usually use the default constructor instead.
2582
2797
  # @param defSize [Integer] The default element size.
2583
2798
  # @param allSizes [Array<Integer>] Array containing the sizes of all elements, including those which have the default size.
@@ -2585,6 +2800,7 @@ module Wx::GRID
2585
2800
  def initialize(*args) end
2586
2801
 
2587
2802
  # Get the element size.
2803
+ #
2588
2804
  # The size for this element, using m_customSizes if pos is in it or m_sizeDefault otherwise.
2589
2805
  # @param pos [unsigned] The index of the element.
2590
2806
  # @return [Integer]
@@ -2594,6 +2810,7 @@ module Wx::GRID
2594
2810
  end # GridSizesInfo
2595
2811
 
2596
2812
  # Allows to specify the behaviour when the cell contents doesn't fit into its allotted space.
2813
+ #
2597
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:
2598
2815
  #
2599
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.
@@ -2615,29 +2832,34 @@ module Wx::GRID
2615
2832
  class GridFitMode < ::Object
2616
2833
 
2617
2834
  # Default constructor creates an object not specifying any behaviour.
2835
+ #
2618
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.
2619
2837
  # @return [Wx::GRID::GridFitMode]
2620
2838
  def initialize; end
2621
2839
 
2622
2840
  # Return true if the object specifies some particular behaviour.
2841
+ #
2623
2842
  # This method returns false for default-constructed objects of this type only.
2624
2843
  # @return [Boolean]
2625
2844
  def is_specified; end
2626
2845
  alias_method :specified?, :is_specified
2627
2846
 
2628
2847
  # Return true if the object specifies clipping behaviour.
2848
+ #
2629
2849
  # This method returns true only for the objects returned by {Wx::GRID::GridFitMode.clip}.
2630
2850
  # @return [Boolean]
2631
2851
  def is_clip; end
2632
2852
  alias_method :clip?, :is_clip
2633
2853
 
2634
2854
  # Return true if the object specifies overflow behaviour.
2855
+ #
2635
2856
  # This method returns true only for the objects returned by {Wx::GRID::GridFitMode.overflow}.
2636
2857
  # @return [Boolean]
2637
2858
  def is_overflow; end
2638
2859
  alias_method :overflow?, :is_overflow
2639
2860
 
2640
2861
  # Return ellipsize mode, possibly {Wx::EllipsizeMode::ELLIPSIZE_NONE}.
2862
+ #
2641
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.
2642
2864
  # @return [Wx::EllipsizeMode]
2643
2865
  def get_ellipsize_mode; end