wxruby3 1.6.1 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (530) hide show
  1. checksums.yaml +4 -4
  2. data/CREDITS.md +32 -25
  3. data/INSTALL.md +19 -4
  4. data/README.md +5 -5
  5. data/assets/repo-social-preview.odg +0 -0
  6. data/assets/repo-social-preview.xcf +0 -0
  7. data/ext/wxruby3/include/wxRubyApp.h +58 -45
  8. data/ext/wxruby3/include/wxruby-runtime.h +78 -1
  9. data/ext/wxruby3/swig/common.i +2 -2
  10. data/ext/wxruby3/swig/custom/director.swg +2 -2
  11. data/ext/wxruby3/swig/custom/rubyprimtypes.swg +59 -15
  12. data/ext/wxruby3/swig/custom/rubyrun.swg +4 -0
  13. data/ext/wxruby3/swig/custom/rubytracking.swg +4 -0
  14. data/ext/wxruby3/swig/custom/swiglabels.swg +129 -0
  15. data/ext/wxruby3/swig/custom/swigrun.swg +15 -0
  16. data/ext/wxruby3/swig/custom/typemaps/swigtypemaps.swg +20 -0
  17. data/ext/wxruby3/swig/mark_free_impl.i +152 -88
  18. data/ext/wxruby3/swig/memory_management.i +1 -0
  19. data/ext/wxruby3/swig/wx.i +73 -44
  20. data/lib/wx/aui/events/evt_list.rb +148 -0
  21. data/lib/wx/aui/require.rb +0 -1
  22. data/lib/wx/core/calendar_ctrl.rb +15 -0
  23. data/lib/wx/core/clipboard.rb +9 -13
  24. data/lib/wx/core/config.rb +1 -1
  25. data/lib/wx/core/events/evt_list.rb +1458 -0
  26. data/lib/wx/core/font/encoding.rb +113 -0
  27. data/lib/wx/core/generic_validator.rb +83 -31
  28. data/lib/wx/core/tipwindow.rb +16 -0
  29. data/lib/wx/doc/aui/auitabctrl.rb +35 -0
  30. data/lib/wx/doc/config.rb +2 -2
  31. data/lib/wx/doc/functions.rb +1 -1
  32. data/lib/wx/doc/gen/about_dialog_info.rb +330 -0
  33. data/lib/wx/doc/gen/accelerator.rb +178 -0
  34. data/lib/wx/doc/gen/activity_indicator.rb +83 -0
  35. data/lib/wx/doc/gen/affine_matrix2d.rb +284 -0
  36. data/lib/wx/doc/gen/animation.rb +275 -0
  37. data/lib/wx/doc/gen/animation_ctrl.rb +300 -0
  38. data/lib/wx/doc/gen/any_button.rb +191 -0
  39. data/lib/wx/doc/gen/app.rb +463 -0
  40. data/lib/wx/doc/gen/app_traits.rb +396 -0
  41. data/lib/wx/doc/gen/art_provider.rb +605 -0
  42. data/lib/wx/doc/gen/aui/aui_dock_art.rb +455 -0
  43. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +54 -0
  44. data/lib/wx/doc/gen/aui/aui_manager.rb +847 -0
  45. data/lib/wx/doc/gen/aui/aui_manager_event.rb +131 -0
  46. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +180 -0
  47. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +59 -0
  48. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +130 -0
  49. data/lib/wx/doc/gen/aui/aui_notebook.rb +631 -0
  50. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +233 -0
  51. data/lib/wx/doc/gen/aui/aui_pane_info.rb +769 -0
  52. data/lib/wx/doc/gen/aui/aui_tab_art.rb +352 -0
  53. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +14 -0
  54. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +510 -0
  55. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +340 -0
  56. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +244 -0
  57. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +257 -0
  58. data/lib/wx/doc/gen/aui/event_list.rb +179 -0
  59. data/lib/wx/doc/gen/banner_window.rb +124 -0
  60. data/lib/wx/doc/gen/bitmap.rb +731 -0
  61. data/lib/wx/doc/gen/bitmap_button.rb +123 -0
  62. data/lib/wx/doc/gen/bitmap_combo_box.rb +221 -0
  63. data/lib/wx/doc/gen/book_ctrl_base.rb +273 -0
  64. data/lib/wx/doc/gen/book_ctrl_event.rb +66 -0
  65. data/lib/wx/doc/gen/box_sizer.rb +85 -0
  66. data/lib/wx/doc/gen/brush.rb +251 -0
  67. data/lib/wx/doc/gen/busy_info.rb +157 -0
  68. data/lib/wx/doc/gen/button.rb +182 -0
  69. data/lib/wx/doc/gen/calculate_layout_event.rb +62 -0
  70. data/lib/wx/doc/gen/calendar_ctrl.rb +505 -0
  71. data/lib/wx/doc/gen/calendar_date_attr.rb +138 -0
  72. data/lib/wx/doc/gen/calendar_event.rb +147 -0
  73. data/lib/wx/doc/gen/caret.rb +97 -0
  74. data/lib/wx/doc/gen/check_box.rb +175 -0
  75. data/lib/wx/doc/gen/check_list_box.rb +121 -0
  76. data/lib/wx/doc/gen/choice.rb +175 -0
  77. data/lib/wx/doc/gen/choicebook.rb +116 -0
  78. data/lib/wx/doc/gen/client_dc.rb +43 -0
  79. data/lib/wx/doc/gen/clipboard.rb +144 -0
  80. data/lib/wx/doc/gen/collapsible_pane.rb +138 -0
  81. data/lib/wx/doc/gen/collapsible_pane_event.rb +46 -0
  82. data/lib/wx/doc/gen/colour.rb +333 -0
  83. data/lib/wx/doc/gen/colour_dialog.rb +190 -0
  84. data/lib/wx/doc/gen/colour_picker_ctrl.rb +110 -0
  85. data/lib/wx/doc/gen/colour_picker_event.rb +77 -0
  86. data/lib/wx/doc/gen/combo_box.rb +292 -0
  87. data/lib/wx/doc/gen/combo_ctrl.rb +662 -0
  88. data/lib/wx/doc/gen/command_link_button.rb +134 -0
  89. data/lib/wx/doc/gen/config_base.rb +10 -0
  90. data/lib/wx/doc/gen/context_help_button.rb +109 -0
  91. data/lib/wx/doc/gen/control.rb +277 -0
  92. data/lib/wx/doc/gen/control_with_items.rb +253 -0
  93. data/lib/wx/doc/gen/core.rb +45 -0
  94. data/lib/wx/doc/gen/credential_entry_dialog.rb +137 -0
  95. data/lib/wx/doc/gen/cursor.rb +193 -0
  96. data/lib/wx/doc/gen/data_format.rb +85 -0
  97. data/lib/wx/doc/gen/data_object.rb +436 -0
  98. data/lib/wx/doc/gen/data_object_simple_base.rb +10 -0
  99. data/lib/wx/doc/gen/date_event.rb +49 -0
  100. data/lib/wx/doc/gen/date_picker_ctrl.rb +161 -0
  101. data/lib/wx/doc/gen/dc.rb +1631 -0
  102. data/lib/wx/doc/gen/dc_overlay.rb +102 -0
  103. data/lib/wx/doc/gen/defs.rb +2802 -0
  104. data/lib/wx/doc/gen/dial_up_event.rb +45 -0
  105. data/lib/wx/doc/gen/dial_up_manager.rb +149 -0
  106. data/lib/wx/doc/gen/dialog.rb +541 -0
  107. data/lib/wx/doc/gen/dir_dialog.rb +164 -0
  108. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +90 -0
  109. data/lib/wx/doc/gen/dir_picker_ctrl.rb +125 -0
  110. data/lib/wx/doc/gen/display.rb +238 -0
  111. data/lib/wx/doc/gen/drag_drop.rb +299 -0
  112. data/lib/wx/doc/gen/drag_image.rb +116 -0
  113. data/lib/wx/doc/gen/editable_list_box.rb +109 -0
  114. data/lib/wx/doc/gen/event.rb +990 -0
  115. data/lib/wx/doc/gen/event_blocker.rb +50 -0
  116. data/lib/wx/doc/gen/event_filter.rb +92 -0
  117. data/lib/wx/doc/gen/event_list.rb +1644 -0
  118. data/lib/wx/doc/gen/events.rb +2809 -0
  119. data/lib/wx/doc/gen/evt_handler.rb +229 -0
  120. data/lib/wx/doc/gen/ext_help_controller.rb +109 -0
  121. data/lib/wx/doc/gen/file_ctrl.rb +231 -0
  122. data/lib/wx/doc/gen/file_ctrl_event.rb +83 -0
  123. data/lib/wx/doc/gen/file_dialog.rb +353 -0
  124. data/lib/wx/doc/gen/file_dialog_custom_control.rb +165 -0
  125. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +158 -0
  126. data/lib/wx/doc/gen/file_dir_picker_event.rb +100 -0
  127. data/lib/wx/doc/gen/file_picker_ctrl.rb +132 -0
  128. data/lib/wx/doc/gen/file_system.rb +232 -0
  129. data/lib/wx/doc/gen/find_dialog_event.rb +126 -0
  130. data/lib/wx/doc/gen/find_replace_data.rb +60 -0
  131. data/lib/wx/doc/gen/find_replace_dialog.rb +58 -0
  132. data/lib/wx/doc/gen/flex_grid_sizer.rb +199 -0
  133. data/lib/wx/doc/gen/font.rb +1379 -0
  134. data/lib/wx/doc/gen/font_data.rb +151 -0
  135. data/lib/wx/doc/gen/font_dialog.rb +88 -0
  136. data/lib/wx/doc/gen/font_picker_ctrl.rb +143 -0
  137. data/lib/wx/doc/gen/font_picker_event.rb +65 -0
  138. data/lib/wx/doc/gen/frame.rb +352 -0
  139. data/lib/wx/doc/gen/fs_file.rb +337 -0
  140. data/lib/wx/doc/gen/functions.rb +10 -0
  141. data/lib/wx/doc/gen/gauge.rb +157 -0
  142. data/lib/wx/doc/gen/gb_sizer_item.rb +68 -0
  143. data/lib/wx/doc/gen/gcdc.rb +46 -0
  144. data/lib/wx/doc/gen/gdi_common.rb +1271 -0
  145. data/lib/wx/doc/gen/gdi_object.rb +31 -0
  146. data/lib/wx/doc/gen/generic_about_dialog.rb +140 -0
  147. data/lib/wx/doc/gen/generic_dir_ctrl.rb +223 -0
  148. data/lib/wx/doc/gen/geometry.rb +661 -0
  149. data/lib/wx/doc/gen/graphics_context.rb +1184 -0
  150. data/lib/wx/doc/gen/graphics_object.rb +750 -0
  151. data/lib/wx/doc/gen/grid/event_list.rb +191 -0
  152. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +40 -0
  153. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +280 -0
  154. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +35 -0
  155. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +37 -0
  156. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +49 -0
  157. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +35 -0
  158. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +46 -0
  159. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +38 -0
  160. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +45 -0
  161. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +40 -0
  162. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +197 -0
  163. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +39 -0
  164. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +44 -0
  165. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +45 -0
  166. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +79 -0
  167. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +46 -0
  168. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +35 -0
  169. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +108 -0
  170. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +35 -0
  171. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +49 -0
  172. data/lib/wx/doc/gen/grid/grid_ctrl.rb +3002 -0
  173. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +95 -0
  174. data/lib/wx/doc/gen/grid/grid_event.rb +129 -0
  175. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +104 -0
  176. data/lib/wx/doc/gen/grid/grid_size_event.rb +85 -0
  177. data/lib/wx/doc/gen/grid/grid_string_table.rb +142 -0
  178. data/lib/wx/doc/gen/grid/grid_table_base.rb +317 -0
  179. data/lib/wx/doc/gen/grid/grid_table_message.rb +81 -0
  180. data/lib/wx/doc/gen/grid_bag_sizer.rb +323 -0
  181. data/lib/wx/doc/gen/grid_sizer.rb +195 -0
  182. data/lib/wx/doc/gen/gui_event_loop.rb +159 -0
  183. data/lib/wx/doc/gen/h_scrolled_window.rb +562 -0
  184. data/lib/wx/doc/gen/header_ctrl.rb +880 -0
  185. data/lib/wx/doc/gen/header_ctrl_event.rb +133 -0
  186. data/lib/wx/doc/gen/help_controller.rb +195 -0
  187. data/lib/wx/doc/gen/help_provider.rb +98 -0
  188. data/lib/wx/doc/gen/html/event_list.rb +38 -0
  189. data/lib/wx/doc/gen/html/html_cell.rb +536 -0
  190. data/lib/wx/doc/gen/html/html_cell_event.rb +69 -0
  191. data/lib/wx/doc/gen/html/html_data_object.rb +42 -0
  192. data/lib/wx/doc/gen/html/html_easy_printing.rb +203 -0
  193. data/lib/wx/doc/gen/html/html_help_controller.rb +340 -0
  194. data/lib/wx/doc/gen/html/html_help_data.rb +159 -0
  195. data/lib/wx/doc/gen/html/html_help_window.rb +258 -0
  196. data/lib/wx/doc/gen/html/html_link_event.rb +41 -0
  197. data/lib/wx/doc/gen/html/html_list_box.rb +346 -0
  198. data/lib/wx/doc/gen/html/html_printout.rb +109 -0
  199. data/lib/wx/doc/gen/html/html_window.rb +461 -0
  200. data/lib/wx/doc/gen/hyperlink_ctrl.rb +311 -0
  201. data/lib/wx/doc/gen/hyperlink_event.rb +44 -0
  202. data/lib/wx/doc/gen/icon.rb +267 -0
  203. data/lib/wx/doc/gen/icon_location.rb +40 -0
  204. data/lib/wx/doc/gen/image.rb +1371 -0
  205. data/lib/wx/doc/gen/image_list.rb +168 -0
  206. data/lib/wx/doc/gen/info_bar.rb +195 -0
  207. data/lib/wx/doc/gen/keyboard_state.rb +140 -0
  208. data/lib/wx/doc/gen/list_box.rb +304 -0
  209. data/lib/wx/doc/gen/list_ctrl.rb +1774 -0
  210. data/lib/wx/doc/gen/list_event.rb +208 -0
  211. data/lib/wx/doc/gen/listbook.rb +116 -0
  212. data/lib/wx/doc/gen/locale.rb +4293 -0
  213. data/lib/wx/doc/gen/log.rb +603 -0
  214. data/lib/wx/doc/gen/mdi_client_window.rb +47 -0
  215. data/lib/wx/doc/gen/mdi_frame.rb +324 -0
  216. data/lib/wx/doc/gen/media_ctrl.rb +269 -0
  217. data/lib/wx/doc/gen/media_event.rb +117 -0
  218. data/lib/wx/doc/gen/memory_dc.rb +174 -0
  219. data/lib/wx/doc/gen/menu.rb +509 -0
  220. data/lib/wx/doc/gen/menu_bar.rb +287 -0
  221. data/lib/wx/doc/gen/menu_item.rb +362 -0
  222. data/lib/wx/doc/gen/message_dialog.rb +238 -0
  223. data/lib/wx/doc/gen/mini_frame.rb +108 -0
  224. data/lib/wx/doc/gen/mirror_dc.rb +22 -0
  225. data/lib/wx/doc/gen/mouse_state.rb +150 -0
  226. data/lib/wx/doc/gen/multi_choice_dialog.rb +80 -0
  227. data/lib/wx/doc/gen/non_owned_window.rb +49 -0
  228. data/lib/wx/doc/gen/notebook.rb +278 -0
  229. data/lib/wx/doc/gen/num_validator.rb +37 -0
  230. data/lib/wx/doc/gen/number_entry_dialog.rb +93 -0
  231. data/lib/wx/doc/gen/object.rb +59 -0
  232. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +395 -0
  233. data/lib/wx/doc/gen/paint_dc.rb +27 -0
  234. data/lib/wx/doc/gen/palette.rb +92 -0
  235. data/lib/wx/doc/gen/panel.rb +127 -0
  236. data/lib/wx/doc/gen/pen.rb +511 -0
  237. data/lib/wx/doc/gen/persistence_manager.rb +135 -0
  238. data/lib/wx/doc/gen/persistent_object.rb +52 -0
  239. data/lib/wx/doc/gen/persistent_window.rb +241 -0
  240. data/lib/wx/doc/gen/pg/event_list.rb +106 -0
  241. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +54 -0
  242. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +292 -0
  243. data/lib/wx/doc/gen/pg/pg_cell.rb +177 -0
  244. data/lib/wx/doc/gen/pg/pg_editor.rb +721 -0
  245. data/lib/wx/doc/gen/pg/pg_multi_button.rb +152 -0
  246. data/lib/wx/doc/gen/pg/pg_properties.rb +2829 -0
  247. data/lib/wx/doc/gen/pg/pg_property.rb +2078 -0
  248. data/lib/wx/doc/gen/pg/pg_validation_info.rb +344 -0
  249. data/lib/wx/doc/gen/pg/property_grid.rb +740 -0
  250. data/lib/wx/doc/gen/pg/property_grid_event.rb +184 -0
  251. data/lib/wx/doc/gen/pg/property_grid_interface.rb +1098 -0
  252. data/lib/wx/doc/gen/pg/property_grid_manager.rb +415 -0
  253. data/lib/wx/doc/gen/pg/property_grid_page.rb +354 -0
  254. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +165 -0
  255. data/lib/wx/doc/gen/picker_base.rb +152 -0
  256. data/lib/wx/doc/gen/platform_info.rb +622 -0
  257. data/lib/wx/doc/gen/popup_window.rb +107 -0
  258. data/lib/wx/doc/gen/progress_dialog.rb +100 -0
  259. data/lib/wx/doc/gen/property_sheet_dialog.rb +216 -0
  260. data/lib/wx/doc/gen/prt/event_list.rb +17 -0
  261. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +44 -0
  262. data/lib/wx/doc/gen/prt/post_script_dc.rb +30 -0
  263. data/lib/wx/doc/gen/prt/preview_frame.rb +78 -0
  264. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +151 -0
  265. data/lib/wx/doc/gen/prt/print_data.rb +804 -0
  266. data/lib/wx/doc/gen/prt/print_dialog.rb +55 -0
  267. data/lib/wx/doc/gen/prt/printer.rb +518 -0
  268. data/lib/wx/doc/gen/prt/printer_dc.rb +37 -0
  269. data/lib/wx/doc/gen/query_layout_info_event.rb +106 -0
  270. data/lib/wx/doc/gen/radio_box.rb +306 -0
  271. data/lib/wx/doc/gen/radio_button.rb +159 -0
  272. data/lib/wx/doc/gen/rbn/event_list.rb +136 -0
  273. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +1132 -0
  274. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +308 -0
  275. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +45 -0
  276. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +458 -0
  277. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +63 -0
  278. data/lib/wx/doc/gen/rbn/ribbon_control.rb +143 -0
  279. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +229 -0
  280. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +55 -0
  281. data/lib/wx/doc/gen/rbn/ribbon_page.rb +174 -0
  282. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +270 -0
  283. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +45 -0
  284. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +360 -0
  285. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +42 -0
  286. data/lib/wx/doc/gen/rearrange_ctrl.rb +78 -0
  287. data/lib/wx/doc/gen/rearrange_list.rb +123 -0
  288. data/lib/wx/doc/gen/region.rb +380 -0
  289. data/lib/wx/doc/gen/region_iterator.rb +76 -0
  290. data/lib/wx/doc/gen/rich_tool_tip.rb +154 -0
  291. data/lib/wx/doc/gen/rtc/event_list.rb +125 -0
  292. data/lib/wx/doc/gen/rtc/rich_text_box.rb +445 -0
  293. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +1188 -0
  294. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +41 -0
  295. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +538 -0
  296. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +2103 -0
  297. data/lib/wx/doc/gen/rtc/rich_text_event.rb +173 -0
  298. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +181 -0
  299. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +319 -0
  300. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +193 -0
  301. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +102 -0
  302. data/lib/wx/doc/gen/rtc/rich_text_image.rb +337 -0
  303. data/lib/wx/doc/gen/rtc/rich_text_object.rb +2922 -0
  304. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +1240 -0
  305. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +258 -0
  306. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +344 -0
  307. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +227 -0
  308. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +59 -0
  309. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +169 -0
  310. data/lib/wx/doc/gen/sash_event.rb +147 -0
  311. data/lib/wx/doc/gen/sash_layout_window.rb +232 -0
  312. data/lib/wx/doc/gen/sash_window.rb +171 -0
  313. data/lib/wx/doc/gen/scaled_dc.rb +10 -0
  314. data/lib/wx/doc/gen/screen_dc.rb +30 -0
  315. data/lib/wx/doc/gen/scroll_bar.rb +204 -0
  316. data/lib/wx/doc/gen/scrolled_canvas.rb +410 -0
  317. data/lib/wx/doc/gen/scrolled_control.rb +410 -0
  318. data/lib/wx/doc/gen/scrolled_window.rb +430 -0
  319. data/lib/wx/doc/gen/search_ctrl.rb +159 -0
  320. data/lib/wx/doc/gen/secret_store.rb +116 -0
  321. data/lib/wx/doc/gen/simplebook.rb +110 -0
  322. data/lib/wx/doc/gen/single_choice_dialog.rb +89 -0
  323. data/lib/wx/doc/gen/sizer.rb +945 -0
  324. data/lib/wx/doc/gen/sizer_item.rb +244 -0
  325. data/lib/wx/doc/gen/slider.rb +342 -0
  326. data/lib/wx/doc/gen/spin_button.rb +157 -0
  327. data/lib/wx/doc/gen/spin_ctrl.rb +231 -0
  328. data/lib/wx/doc/gen/spin_ctrl_double.rb +192 -0
  329. data/lib/wx/doc/gen/spin_double_event.rb +55 -0
  330. data/lib/wx/doc/gen/spin_event.rb +51 -0
  331. data/lib/wx/doc/gen/splash_screen.rb +113 -0
  332. data/lib/wx/doc/gen/splitter_event.rb +99 -0
  333. data/lib/wx/doc/gen/splitter_window.rb +498 -0
  334. data/lib/wx/doc/gen/static_bitmap.rb +256 -0
  335. data/lib/wx/doc/gen/static_box.rb +180 -0
  336. data/lib/wx/doc/gen/static_box_sizer.rb +85 -0
  337. data/lib/wx/doc/gen/static_line.rb +83 -0
  338. data/lib/wx/doc/gen/static_text.rb +127 -0
  339. data/lib/wx/doc/gen/status_bar.rb +290 -0
  340. data/lib/wx/doc/gen/stc/event_list.rb +221 -0
  341. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +4474 -0
  342. data/lib/wx/doc/gen/stc/styled_text_event.rb +8762 -0
  343. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +129 -0
  344. data/lib/wx/doc/gen/svg_file_dc.rb +164 -0
  345. data/lib/wx/doc/gen/system_options.rb +129 -0
  346. data/lib/wx/doc/gen/system_settings.rb +507 -0
  347. data/lib/wx/doc/gen/task_bar_icon.rb +127 -0
  348. data/lib/wx/doc/gen/task_bar_icon_event.rb +88 -0
  349. data/lib/wx/doc/gen/text_attr.rb +756 -0
  350. data/lib/wx/doc/gen/text_ctrl.rb +1033 -0
  351. data/lib/wx/doc/gen/text_entry.rb +441 -0
  352. data/lib/wx/doc/gen/text_entry_dialog.rb +220 -0
  353. data/lib/wx/doc/gen/text_validator.rb +245 -0
  354. data/lib/wx/doc/gen/time_picker_ctrl.rb +128 -0
  355. data/lib/wx/doc/gen/timer.rb +119 -0
  356. data/lib/wx/doc/gen/timer_event.rb +68 -0
  357. data/lib/wx/doc/gen/tip_provider.rb +63 -0
  358. data/lib/wx/doc/gen/tip_window.rb +51 -0
  359. data/lib/wx/doc/gen/toggle_button.rb +182 -0
  360. data/lib/wx/doc/gen/tool_bar.rb +890 -0
  361. data/lib/wx/doc/gen/tool_tip.rb +86 -0
  362. data/lib/wx/doc/gen/toolbook.rb +118 -0
  363. data/lib/wx/doc/gen/top_level_window.rb +497 -0
  364. data/lib/wx/doc/gen/tree_ctrl.rb +1052 -0
  365. data/lib/wx/doc/gen/tree_event.rb +127 -0
  366. data/lib/wx/doc/gen/treebook.rb +180 -0
  367. data/lib/wx/doc/gen/ui_action_simulator.rb +109 -0
  368. data/lib/wx/doc/gen/utils.rb +273 -0
  369. data/lib/wx/doc/gen/v_list_box.rb +272 -0
  370. data/lib/wx/doc/gen/v_scrolled_canvas.rb +195 -0
  371. data/lib/wx/doc/gen/v_scrolled_window.rb +191 -0
  372. data/lib/wx/doc/gen/validator.rb +68 -0
  373. data/lib/wx/doc/gen/variant.rb +294 -0
  374. data/lib/wx/doc/gen/window.rb +2917 -0
  375. data/lib/wx/doc/gen/window_dc.rb +38 -0
  376. data/lib/wx/doc/gen/window_disabler.rb +30 -0
  377. data/lib/wx/doc/gen/with_images.rb +84 -0
  378. data/lib/wx/doc/gen/wizard.rb +257 -0
  379. data/lib/wx/doc/gen/wizard_event.rb +113 -0
  380. data/lib/wx/doc/gen/wizard_page.rb +65 -0
  381. data/lib/wx/doc/gen/wizard_page_simple.rb +88 -0
  382. data/lib/wx/doc/gen/wrap_sizer.rb +79 -0
  383. data/lib/wx/doc/gen/xml_node.rb +316 -0
  384. data/lib/wx/doc/gen/xml_resource.rb +320 -0
  385. data/lib/wx/doc/generic_validator.rb +5 -0
  386. data/lib/wx/doc/tip_window.rb +18 -6
  387. data/lib/wx/grid/events/evt_list.rb +166 -0
  388. data/lib/wx/html/events/evt_list.rb +27 -0
  389. data/lib/wx/html/simple_html_listbox.rb +46 -33
  390. data/lib/wx/keyword_defs.rb +9 -0
  391. data/lib/wx/pg/events/evt_list.rb +73 -0
  392. data/lib/wx/pg/pg_property.rb +26 -0
  393. data/lib/wx/pg/property_grid_interface.rb +2 -2
  394. data/lib/wx/rbn/events/evt_list.rb +102 -0
  395. data/lib/wx/rtc/events/evt_list.rb +98 -0
  396. data/lib/wx/rtc/ext/rich_text_ctrl.rb +24 -0
  397. data/lib/wx/stc/events/evt_list.rb +178 -0
  398. data/lib/wx/version.rb +1 -1
  399. data/lib/wx/wxruby/cmd/setup.rb +6 -0
  400. data/rakelib/configure.rb +9 -0
  401. data/rakelib/gem.rake +3 -2
  402. data/rakelib/lib/config/linux.rb +1 -1
  403. data/rakelib/lib/config/macosx.rb +15 -1
  404. data/rakelib/lib/config/pkgman/linux.rb +7 -2
  405. data/rakelib/lib/config/unixish.rb +3 -3
  406. data/rakelib/lib/config.rb +16 -5
  407. data/rakelib/lib/core/include/swigdirector.inc +3 -3
  408. data/rakelib/lib/core/include/swigrubyerrors.inc +4 -8
  409. data/rakelib/lib/core/include/swigrubyrun.inc +20 -4
  410. data/rakelib/lib/core/include/swigrun.inc +189 -0
  411. data/rakelib/lib/core/package.rb +3 -1
  412. data/rakelib/lib/director/accelerator.rb +1 -1
  413. data/rakelib/lib/director/animation.rb +1 -0
  414. data/rakelib/lib/director/app_traits.rb +1 -1
  415. data/rakelib/lib/director/aui_manager.rb +21 -14
  416. data/rakelib/lib/director/aui_mdi_child_frame.rb +2 -0
  417. data/rakelib/lib/director/aui_mdi_parent_frame.rb +4 -0
  418. data/rakelib/lib/director/aui_notebook.rb +20 -3
  419. data/rakelib/lib/director/aui_tab_ctrl.rb +64 -106
  420. data/rakelib/lib/director/calendar_ctrl.rb +72 -14
  421. data/rakelib/lib/director/clipboard.rb +2 -0
  422. data/rakelib/lib/director/data_object.rb +15 -7
  423. data/rakelib/lib/director/date_picker_ctrl.rb +4 -1
  424. data/rakelib/lib/director/display.rb +81 -0
  425. data/rakelib/lib/director/event.rb +33 -16
  426. data/rakelib/lib/director/event_handler.rb +27 -2
  427. data/rakelib/lib/director/functions.rb +9 -0
  428. data/rakelib/lib/director/geometry.rb +5 -0
  429. data/rakelib/lib/director/grid_ctrl.rb +123 -28
  430. data/rakelib/lib/director/help_provider.rb +1 -1
  431. data/rakelib/lib/director/html_listbox.rb +16 -3
  432. data/rakelib/lib/director/hvscrolled.rb +7 -106
  433. data/rakelib/lib/director/image_list.rb +1 -0
  434. data/rakelib/lib/director/mdi_frame.rb +4 -0
  435. data/rakelib/lib/director/menu.rb +56 -15
  436. data/rakelib/lib/director/menu_bar.rb +62 -0
  437. data/rakelib/lib/director/menu_item.rb +7 -1
  438. data/rakelib/lib/director/num_validator.rb +27 -0
  439. data/rakelib/lib/director/numeric_property_validator.rb +9 -0
  440. data/rakelib/lib/director/popup_window.rb +2 -0
  441. data/rakelib/lib/director/preview_frame.rb +29 -6
  442. data/rakelib/lib/director/printer.rb +59 -5
  443. data/rakelib/lib/director/property_grid.rb +37 -18
  444. data/rakelib/lib/director/property_grid_interface.rb +10 -8
  445. data/rakelib/lib/director/property_grid_manager.rb +99 -39
  446. data/rakelib/lib/director/property_grid_page.rb +60 -0
  447. data/rakelib/lib/director/rich_tooltip.rb +22 -0
  448. data/rakelib/lib/director/richtext_ctrl.rb +5 -0
  449. data/rakelib/lib/director/richtext_object.rb +13 -4
  450. data/rakelib/lib/director/richtext_style_listbox.rb +4 -1
  451. data/rakelib/lib/director/scrolled_t.rb +3 -0
  452. data/rakelib/lib/director/searchctrl.rb +1 -0
  453. data/rakelib/lib/director/task_bar_icon.rb +14 -8
  454. data/rakelib/lib/director/text_validator.rb +9 -0
  455. data/rakelib/lib/director/tip_window.rb +117 -6
  456. data/rakelib/lib/director/tool_bar.rb +6 -0
  457. data/rakelib/lib/director/validator.rb +12 -0
  458. data/rakelib/lib/director/variant.rb +36 -20
  459. data/rakelib/lib/director/vlistbox.rb +25 -22
  460. data/rakelib/lib/director/window.rb +10 -1
  461. data/rakelib/lib/director/xml_resource.rb +6 -0
  462. data/rakelib/lib/generate/doc/aui_manager.yaml +1 -1
  463. data/rakelib/lib/generate/doc/rich_tool_tip.yaml +26 -0
  464. data/rakelib/lib/generate/doc.rb +12 -7
  465. data/rakelib/lib/generate/interface.rb +16 -1
  466. data/rakelib/lib/specs/interfaces.rb +3 -1
  467. data/rakelib/lib/swig_runner.rb +10 -10
  468. data/rakelib/lib/typemap/aui_tabctrl.rb +46 -0
  469. data/rakelib/lib/typemap/common.rb +3 -3
  470. data/rakelib/lib/typemap/print_page_range.rb +32 -8
  471. data/samples/art/wxruby-512x512.png +0 -0
  472. data/samples/calendar/calendar.rb +64 -1
  473. data/samples/dialogs/dialogs.rb +172 -0
  474. data/samples/dialogs/tip.xpm +157 -0
  475. data/samples/drawing/maths_images.rb +1 -1
  476. data/samples/event/event.rb +1 -1
  477. data/samples/printing/printing2.rb +1 -1
  478. data/samples/sampler.rb +26 -8
  479. data/samples/text/textctrl.rb +2 -2
  480. data/samples/treectrl/treectrl.rb +2 -2
  481. data/tests/lib/leaked_process_event_exception_test.rb +1 -1
  482. data/tests/lib/leaked_queued_event_exception_test.rb +1 -1
  483. data/tests/lib/wxapp_runner.rb +31 -41
  484. data/tests/lib/wxframe_runner.rb +23 -11
  485. data/tests/lib/wxrb_test.rb +58 -0
  486. data/tests/test_app_event_filter.rb +1 -1
  487. data/tests/test_app_exit_exception.rb +3 -3
  488. data/tests/test_app_init_exception.rb +3 -3
  489. data/tests/test_app_traits.rb +24 -21
  490. data/tests/test_art.rb +7 -7
  491. data/tests/test_art_provider.rb +1 -1
  492. data/tests/test_basic.rb +2 -2
  493. data/tests/test_book_controls.rb +1 -1
  494. data/tests/test_box_sizer.rb +1 -1
  495. data/tests/test_clipboard.rb +5 -5
  496. data/tests/test_combo_ctrl.rb +2 -2
  497. data/tests/test_config.rb +11 -1
  498. data/tests/test_dc.rb +1 -1
  499. data/tests/test_dialog.rb +1 -1
  500. data/tests/test_event_handling.rb +1 -1
  501. data/tests/test_events.rb +1 -1
  502. data/tests/test_exceptions.rb +2 -2
  503. data/tests/test_ext_controls.rb +10 -10
  504. data/tests/test_file_dialog.rb +1 -1
  505. data/tests/test_font.rb +1 -1
  506. data/tests/test_gdi_object.rb +1 -1
  507. data/tests/test_geometry.rb +2 -2
  508. data/tests/test_grid_sizer.rb +2 -2
  509. data/tests/test_intl.rb +1 -1
  510. data/tests/test_item_data.rb +12 -12
  511. data/tests/test_list_ctrl.rb +1 -1
  512. data/tests/test_log.rb +2 -2
  513. data/tests/test_media_ctrl.rb +1 -1
  514. data/tests/test_menu.rb +114 -43
  515. data/tests/test_proof_check.rb +1 -1
  516. data/tests/test_propgrid.rb +31 -31
  517. data/tests/test_richtext.rb +10 -24
  518. data/tests/test_secret_store.rb +1 -1
  519. data/tests/test_sizer.rb +1 -1
  520. data/tests/test_std_controls.rb +8 -8
  521. data/tests/test_styled_text_ctrl.rb +1 -1
  522. data/tests/test_timer.rb +1 -1
  523. data/tests/test_tree_ctrl.rb +1 -1
  524. data/tests/test_validators.rb +79 -36
  525. data/tests/test_variant.rb +1 -1
  526. data/tests/test_window.rb +11 -11
  527. data/tests/testapp.rb +2 -2
  528. data/tests/testapp_noframe.rb +2 -2
  529. metadata +400 -11
  530. data/lib/wx/aui/aui_tab_ctrl.rb +0 -18
@@ -0,0 +1,3002 @@
1
+ # :stopdoc:
2
+ # This file is automatically generated by the WXRuby3 documentation
3
+ # generator. Do not alter this file.
4
+ # :startdoc:
5
+
6
+
7
+ module Wx
8
+
9
+ module GRID
10
+
11
+ #
12
+ GRID_AUTOSIZE = -1
13
+
14
+ # Specifier used to format the data to string for the numbers handled by {Wx::GRID::GridCellFloatRenderer} and {Wx::GRID::GridCellFloatEditor}.
15
+ #
16
+ #
17
+ #
18
+ # @wxrb_require USE_GRID
19
+ class GridCellFloatFormat < Wx::Enum
20
+
21
+ # Decimal floating point (f).
22
+ #
23
+ GRID_FLOAT_FORMAT_FIXED = Wx::GRID::GridCellFloatFormat.new(16)
24
+
25
+ # Scientific notation (mantissa/exponent) using e character (e).
26
+ #
27
+ GRID_FLOAT_FORMAT_SCIENTIFIC = Wx::GRID::GridCellFloatFormat.new(32)
28
+
29
+ # Use the shorter of e or f (g).
30
+ #
31
+ GRID_FLOAT_FORMAT_COMPACT = Wx::GRID::GridCellFloatFormat.new(64)
32
+
33
+ # To use in combination with one of the above formats for the upper case version (F/E/G).
34
+ #
35
+ GRID_FLOAT_FORMAT_UPPER = Wx::GRID::GridCellFloatFormat.new(128)
36
+
37
+ # The format used by default ({Wx::GRID::GridCellFloatFormat::GRID_FLOAT_FORMAT_FIXED}).
38
+ #
39
+ GRID_FLOAT_FORMAT_DEFAULT = Wx::GRID::GridCellFloatFormat.new(16)
40
+
41
+ end # GridCellFloatFormat
42
+
43
+ # Possible types for grid table notifications.
44
+ #
45
+ #
46
+ #
47
+ # @wxrb_require USE_GRID
48
+ class GridTableRequest < Wx::Enum
49
+
50
+ # New rows have been inserted into the table.
51
+ #
52
+ GRIDTABLE_NOTIFY_ROWS_INSERTED = Wx::GRID::GridTableRequest.new(2002)
53
+
54
+ # New rows have been append to the table.
55
+ #
56
+ GRIDTABLE_NOTIFY_ROWS_APPENDED = Wx::GRID::GridTableRequest.new(2003)
57
+
58
+ # Rows have been deleted from the table.
59
+ #
60
+ GRIDTABLE_NOTIFY_ROWS_DELETED = Wx::GRID::GridTableRequest.new(2004)
61
+
62
+ # New columns have been inserted into the table.
63
+ #
64
+ GRIDTABLE_NOTIFY_COLS_INSERTED = Wx::GRID::GridTableRequest.new(2005)
65
+
66
+ # New columns have been append to the table.
67
+ #
68
+ GRIDTABLE_NOTIFY_COLS_APPENDED = Wx::GRID::GridTableRequest.new(2006)
69
+
70
+ # Columns have been deleted from the table.
71
+ #
72
+ GRIDTABLE_NOTIFY_COLS_DELETED = Wx::GRID::GridTableRequest.new(2007)
73
+
74
+ end # GridTableRequest
75
+
76
+ # Rendering styles supported by {Wx::GRID::Grid#render} method.
77
+ #
78
+ #
79
+ #
80
+ # @wxrb_require USE_GRID
81
+ class GridRenderStyle < Wx::Enum
82
+
83
+ # Draw grid row header labels.
84
+ #
85
+ GRID_DRAW_ROWS_HEADER = Wx::GRID::GridRenderStyle.new(1)
86
+
87
+ # Draw grid column header labels.
88
+ #
89
+ GRID_DRAW_COLS_HEADER = Wx::GRID::GridRenderStyle.new(2)
90
+
91
+ # Draw grid cell border lines.
92
+ #
93
+ GRID_DRAW_CELL_LINES = Wx::GRID::GridRenderStyle.new(4)
94
+
95
+ # Draw a bounding rectangle around the rendered cell area.
96
+ #
97
+ GRID_DRAW_BOX_RECT = Wx::GRID::GridRenderStyle.new(8)
98
+
99
+ # Draw the grid cell selection highlight if a selection is present.
100
+ #
101
+ GRID_DRAW_SELECTION = Wx::GRID::GridRenderStyle.new(16)
102
+
103
+ # The default render style.
104
+ #
105
+ GRID_DRAW_DEFAULT = Wx::GRID::GridRenderStyle.new(15)
106
+
107
+ end # GridRenderStyle
108
+
109
+ #
110
+ #
111
+ EVT_GRID_CELL_LEFT_CLICK = 10259
112
+
113
+ #
114
+ #
115
+ EVT_GRID_CELL_RIGHT_CLICK = 10260
116
+
117
+ #
118
+ #
119
+ EVT_GRID_CELL_LEFT_DCLICK = 10261
120
+
121
+ #
122
+ #
123
+ EVT_GRID_CELL_RIGHT_DCLICK = 10262
124
+
125
+ #
126
+ #
127
+ EVT_GRID_LABEL_LEFT_CLICK = 10264
128
+
129
+ #
130
+ #
131
+ EVT_GRID_LABEL_RIGHT_CLICK = 10265
132
+
133
+ #
134
+ #
135
+ EVT_GRID_LABEL_LEFT_DCLICK = 10266
136
+
137
+ #
138
+ #
139
+ EVT_GRID_LABEL_RIGHT_DCLICK = 10267
140
+
141
+ #
142
+ #
143
+ EVT_GRID_ROW_SIZE = 10268
144
+
145
+ #
146
+ #
147
+ EVT_GRID_ROW_AUTO_SIZE = 10269
148
+
149
+ #
150
+ #
151
+ EVT_GRID_COL_SIZE = 10270
152
+
153
+ #
154
+ #
155
+ EVT_GRID_COL_AUTO_SIZE = 10271
156
+
157
+ #
158
+ #
159
+ EVT_GRID_ROW_LABEL_SIZE = 10272
160
+
161
+ #
162
+ #
163
+ EVT_GRID_COL_LABEL_SIZE = 10273
164
+
165
+ #
166
+ #
167
+ EVT_GRID_RANGE_SELECTING = 10277
168
+
169
+ #
170
+ #
171
+ EVT_GRID_RANGE_SELECTED = 10278
172
+
173
+ #
174
+ #
175
+ EVT_GRID_CELL_CHANGING = 10279
176
+
177
+ #
178
+ #
179
+ EVT_GRID_CELL_CHANGED = 10280
180
+
181
+ #
182
+ #
183
+ EVT_GRID_SELECT_CELL = 10281
184
+
185
+ #
186
+ #
187
+ EVT_GRID_EDITOR_SHOWN = 10282
188
+
189
+ #
190
+ #
191
+ EVT_GRID_EDITOR_HIDDEN = 10283
192
+
193
+ #
194
+ #
195
+ EVT_GRID_EDITOR_CREATED = 10284
196
+
197
+ #
198
+ #
199
+ EVT_GRID_CELL_BEGIN_DRAG = 10263
200
+
201
+ #
202
+ #
203
+ EVT_GRID_ROW_MOVE = 10274
204
+
205
+ #
206
+ #
207
+ EVT_GRID_COL_MOVE = 10275
208
+
209
+ #
210
+ #
211
+ EVT_GRID_COL_SORT = 10276
212
+
213
+ #
214
+ #
215
+ EVT_GRID_TABBING = 10285
216
+
217
+ # wxRuby specific alias for Wx::EVT_GRID_COL_SIZE
218
+ EVT_GRID_CMD_COL_SIZE = 10270
219
+
220
+ # wxRuby specific alias for Wx::EVT_GRID_ROW_SIZE
221
+ EVT_GRID_CMD_ROW_SIZE = 10268
222
+
223
+ # wxRuby specific alias for Wx::EVT_GRID_EDITOR_CREATED
224
+ EVT_GRID_CMD_EDITOR_CREATED = 10284
225
+
226
+ # wxRuby specific alias for Wx::wxEVT_GRID_RANGE_SELECTING
227
+ EVT_GRID_CMD_RANGE_SELECTING = 10277
228
+
229
+ # wxRuby specific alias for Wx::wxEVT_GRID_RANGE_SELECTED
230
+ EVT_GRID_CMD_RANGE_SELECTED = 10278
231
+
232
+ # {Wx::GRID::Grid} and its related classes are used for displaying and editing tabular data.
233
+ #
234
+ # 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}.
235
+ # 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}.
236
+ # {Wx::GRID::GridCellRenderer} is the abstract base class for rendering contents in a cell. The following renderers are predefined:
237
+ #
238
+ # - {Wx::GRID::GridCellBoolRenderer}
239
+ # - {Wx::GRID::GridCellFloatRenderer}
240
+ # - {Wx::GRID::GridCellNumberRenderer}
241
+ # - {Wx::GRID::GridCellStringRenderer}
242
+ # - {Wx::GRID::GridCellDateRenderer}
243
+ # - {Wx::GRID::GridCellDateTimeRenderer}
244
+ #
245
+ # The look of a cell can be further defined using {Wx::GRID::GridCellAttr}. An object of this type may be returned by {Wx::GRID::GridTableBase#get_attr}.
246
+ # {Wx::GRID::GridCellEditor} is the abstract base class for editing the value of a cell. The following editors are predefined:
247
+ #
248
+ # - {Wx::GRID::GridCellBoolEditor}
249
+ # - {Wx::GRID::GridCellChoiceEditor}
250
+ # - {Wx::GRID::GridCellFloatEditor}
251
+ # - {Wx::GRID::GridCellNumberEditor}
252
+ # - {Wx::GRID::GridCellTextEditor}
253
+ # - {Wx::GRID::GridCellDateEditor}
254
+ #
255
+ # Please see {Wx::GRID::GridEvent}, {Wx::GRID::GridSizeEvent}, {Wx::GRID::GridRangeSelectEvent}, and {Wx::GRID::GridEditorCreatedEvent} for the documentation of all event types you can use with {Wx::GRID::Grid}.
256
+ #
257
+ # Category: Grid Related Classes
258
+ # @see wxGrid Overview
259
+ # @see Wx::GridUpdateLocker
260
+ #
261
+ #
262
+ # @wxrb_require USE_GRID
263
+ class Grid < ScrolledCanvas
264
+
265
+ # Different selection modes supported by the grid.
266
+ #
267
+ #
268
+ #
269
+ # @wxrb_require USE_GRID
270
+ class GridSelectionModes < Wx::Enum
271
+
272
+ # The default selection mode allowing selection of the individual cells as well as of the entire rows and columns.
273
+ #
274
+ GridSelectCells = Wx::GRID::Grid::GridSelectionModes.new(0)
275
+
276
+ # The selection mode allowing the selection of the entire rows only.
277
+ #
278
+ GridSelectRows = Wx::GRID::Grid::GridSelectionModes.new(1)
279
+
280
+ # The selection mode allowing the selection of the entire columns only.
281
+ #
282
+ GridSelectColumns = Wx::GRID::Grid::GridSelectionModes.new(2)
283
+
284
+ # The selection mode allowing the user to select either the entire columns or the entire rows but not individual cells nor blocks.
285
+ #
286
+ GridSelectRowsOrColumns = Wx::GRID::Grid::GridSelectionModes.new(3)
287
+
288
+ # The selection mode allowing no selections to be made at all.
289
+ #
290
+ GridSelectNone = Wx::GRID::Grid::GridSelectionModes.new(4)
291
+
292
+ end # GridSelectionModes
293
+
294
+ # Return values for {Wx::GRID::Grid#get_cell_size}.
295
+ #
296
+ #
297
+ #
298
+ # @wxrb_require USE_GRID
299
+ class CellSpan < Wx::Enum
300
+
301
+ end # CellSpan
302
+
303
+ # Constants defining different support built-in TAB handling behaviours.
304
+ #
305
+ # The elements of this enum determine what happens when TAB is pressed when the cursor is in the rightmost column (or Shift-TAB is pressed when the cursor is in the leftmost one).
306
+ # @see Wx::GRID::Grid#set_tab_behaviour
307
+ # @see Wx::GRID::EVT_GRID_TABBING
308
+ #
309
+ #
310
+ # @wxrb_require USE_GRID
311
+ class TabBehaviour < Wx::Enum
312
+
313
+ # Do nothing, this is default.
314
+ #
315
+ Tab_Stop = Wx::GRID::Grid::TabBehaviour.new(0)
316
+
317
+ # Move to the beginning of the next (or the end of the previous) row.
318
+ #
319
+ Tab_Wrap = Wx::GRID::Grid::TabBehaviour.new(1)
320
+
321
+ # Move to the next (or the previous) control after the grid.
322
+ #
323
+ Tab_Leave = Wx::GRID::Grid::TabBehaviour.new(2)
324
+
325
+ end # TabBehaviour
326
+
327
+ # @overload initialize()
328
+ # Default constructor.
329
+ #
330
+ # 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.
331
+ # @return [Wx::GRID::Grid]
332
+ # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::WANTS_CHARS, name=Wx::GRID_NAME_STR)
333
+ # Constructor creating the grid window.
334
+ #
335
+ # 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.
336
+ # @param parent [Wx::Window]
337
+ # @param id [Integer]
338
+ # @param pos [Array(Integer, Integer), Wx::Point]
339
+ # @param size [Array(Integer, Integer), Wx::Size]
340
+ # @param style [Integer]
341
+ # @param name [String]
342
+ # @return [Wx::GRID::Grid]
343
+ # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::WANTS_CHARS, name=Wx::GRID_NAME_STR, &block)
344
+ # Constructor creating the grid window.
345
+ #
346
+ # 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.
347
+ # @param parent [Wx::Window]
348
+ # @param id [Integer]
349
+ # @param pos [Array(Integer, Integer), Wx::Point]
350
+ # @param size [Array(Integer, Integer), Wx::Size]
351
+ # @param style [Integer]
352
+ # @param name [String]
353
+ # @yieldparam [Wx::GRID::Grid] win new instance
354
+ # @return [Wx::GRID::Grid]
355
+ def initialize(*args) end
356
+
357
+ # Creates the grid window for an object initialized using the default constructor.
358
+ #
359
+ # 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.
360
+ # @param parent [Wx::Window]
361
+ # @param id [Integer]
362
+ # @param pos [Array(Integer, Integer), Wx::Point]
363
+ # @param size [Array(Integer, Integer), Wx::Size]
364
+ # @param style [Integer]
365
+ # @param name [String]
366
+ # @return [Boolean]
367
+ def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::WANTS_CHARS, name=Wx::GRID_NAME_STR) end
368
+
369
+ # Creates a grid with the specified initial number of rows and columns.
370
+ #
371
+ # 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.
372
+ # 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}.
373
+ # @param numRows [Integer]
374
+ # @param numCols [Integer]
375
+ # @param selmode [Wx::Grid::GridSelectionModes]
376
+ # @return [Boolean]
377
+ def create_grid(numRows, numCols, selmode=Wx::GRID::Grid::GridSelectionModes::GridSelectCells) end
378
+
379
+ # Assigns a pointer to a custom grid table to be used by the grid.
380
+ #
381
+ # 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.
382
+ # 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.
383
+ # @param table [Wx::GRID::GridTableBase] The heap-allocated pointer to the table.
384
+ # @param selmode [Wx::Grid::GridSelectionModes] Selection mode to use.
385
+ # @return [void]
386
+ def assign_table(table, selmode=Wx::GRID::Grid::GridSelectionModes::GridSelectCells) end
387
+
388
+ # @overload process_table_message(msg)
389
+ # Reacts to a message notifying about a change to the grid shape.
390
+ #
391
+ # This function should be called by the {Wx::GRID::GridTableBase}-derived class to notify the grid about any changes to its rows or columns.
392
+ # @param msg [Wx::GRID::GridTableMessage]
393
+ # @return [Boolean]
394
+ # @overload process_table_message(table, id, comInt1=-1, comInt2=-1)
395
+ # Convenient overload for notifying the grid about changes to its shape.
396
+ #
397
+ # This is identical to the overload taking {Wx::GRID::GridTableMessage} and simply constructs the message object from the function arguments and then calls the other overload with this object.
398
+ # @param table [Wx::GRID::GridTableBase]
399
+ # @param id [Integer]
400
+ # @param comInt1 [Integer]
401
+ # @param comInt2 [Integer]
402
+ # @return [Boolean]
403
+ def process_table_message(*args) end
404
+
405
+ # Turns the drawing of grid lines on or off.
406
+ # @param enable [Boolean]
407
+ # @return [void]
408
+ def enable_grid_lines(enable=true) end
409
+
410
+ # Returns the pen used for vertical grid lines.
411
+ #
412
+ # This virtual function may be overridden in derived classes in order to change the appearance of individual grid lines for the given column col.
413
+ # See {Wx::GRID::Grid#get_row_grid_line_pen} for an example.
414
+ # @param col [Integer]
415
+ # @return [Wx::Pen]
416
+ def get_col_grid_line_pen(col) end
417
+ alias_method :col_grid_line_pen, :get_col_grid_line_pen
418
+
419
+ # Returns the pen used for grid lines.
420
+ #
421
+ # 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.
422
+ # @see Wx::GRID::Grid#get_col_grid_line_pen
423
+ # @see Wx::GRID::Grid#get_row_grid_line_pen
424
+ # @return [Wx::Pen]
425
+ def get_default_grid_line_pen; end
426
+ alias_method :default_grid_line_pen, :get_default_grid_line_pen
427
+
428
+ # Returns the colour used for grid lines.
429
+ #
430
+ #
431
+ # @see Wx::GRID::Grid#get_default_grid_line_pen
432
+ # @return [Wx::Colour]
433
+ def get_grid_line_colour; end
434
+ alias_method :grid_line_colour, :get_grid_line_colour
435
+
436
+ # Returns the pen used for horizontal grid lines.
437
+ #
438
+ # This virtual function may be overridden in derived classes in order to change the appearance of individual grid line for the given row.
439
+ # Example:
440
+ # ```ruby
441
+ # class MidiGrid < Wx::GRID::Grid
442
+ #
443
+ # # ...
444
+ #
445
+ # # in a grid displaying music notation, use a solid black pen between
446
+ # # octaves (C0=row 127, C1=row 115 etc.)
447
+ # def get_row_grid_line_pen(row)
448
+ # if row % 12 == 7
449
+ # Wx::Pen.new(Wx::BLACK, 1, Wx::PENSTYLE_SOLID)
450
+ # else
451
+ # get_default_grid_line_pen
452
+ # end
453
+ # end
454
+ #
455
+ # end
456
+ # ```
457
+ # @param row [Integer]
458
+ # @return [Wx::Pen]
459
+ def get_row_grid_line_pen(row) end
460
+ alias_method :row_grid_line_pen, :get_row_grid_line_pen
461
+
462
+ # Returns true if drawing of grid lines is turned on, false otherwise.
463
+ # @return [Boolean]
464
+ def grid_lines_enabled; end
465
+
466
+ # Sets the colour used to draw grid lines.
467
+ # @param colour [Wx::Colour,String,Symbol]
468
+ # @return [void]
469
+ def set_grid_line_colour(colour) end
470
+ alias_method :grid_line_colour=, :set_grid_line_colour
471
+
472
+ # Sets the arguments to the current column label alignment values.
473
+ #
474
+ # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
475
+ # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
476
+ # @return [Array(Integer,Integer)]
477
+ def get_col_label_alignment; end
478
+ alias_method :col_label_alignment, :get_col_label_alignment
479
+
480
+ # Returns the orientation of the column labels (either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}).
481
+ # @return [Integer]
482
+ def get_col_label_text_orientation; end
483
+ alias_method :col_label_text_orientation, :get_col_label_text_orientation
484
+
485
+ # Returns the specified column label.
486
+ #
487
+ # 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.
488
+ # @param col [Integer]
489
+ # @return [String]
490
+ def get_col_label_value(col) end
491
+ alias_method :col_label_value, :get_col_label_value
492
+
493
+ # Sets the arguments to the current corner label alignment values.
494
+ #
495
+ # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
496
+ # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
497
+ # @return [Array(Integer,Integer)]
498
+ def get_corner_label_alignment; end
499
+ alias_method :corner_label_alignment, :get_corner_label_alignment
500
+
501
+ # Returns the orientation of the corner label (either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}).
502
+ # @return [Integer]
503
+ def get_corner_label_text_orientation; end
504
+ alias_method :corner_label_text_orientation, :get_corner_label_text_orientation
505
+
506
+ # Returns the (top-left) corner label.
507
+ # @return [String]
508
+ def get_corner_label_value; end
509
+ alias_method :corner_label_value, :get_corner_label_value
510
+
511
+ # Returns the colour used for the background of row and column labels.
512
+ # @return [Wx::Colour]
513
+ def get_label_background_colour; end
514
+ alias_method :label_background_colour, :get_label_background_colour
515
+
516
+ # Returns the font used for row and column labels.
517
+ # @return [Wx::Font]
518
+ def get_label_font; end
519
+ alias_method :label_font, :get_label_font
520
+
521
+ # Returns the colour used for row and column label text.
522
+ # @return [Wx::Colour]
523
+ def get_label_text_colour; end
524
+ alias_method :label_text_colour, :get_label_text_colour
525
+
526
+ # Returns the alignment used for row labels.
527
+ #
528
+ # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
529
+ # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
530
+ # @return [Array(Integer,Integer)]
531
+ def get_row_label_alignment; end
532
+ alias_method :row_label_alignment, :get_row_label_alignment
533
+
534
+ # Returns the specified row label.
535
+ #
536
+ # 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.
537
+ # @param row [Integer]
538
+ # @return [String]
539
+ def get_row_label_value(row) end
540
+ alias_method :row_label_value, :get_row_label_value
541
+
542
+ # Hides the column labels by calling {Wx::GRID::Grid#set_col_label_size} with a size of 0.
543
+ #
544
+ # The labels can be shown again by calling {Wx::GRID::Grid#set_col_label_size} with a height greater than 0.
545
+ # 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.
546
+ # @see Wx::GRID::Grid#hide_row_labels
547
+ # @return [void]
548
+ def hide_col_labels; end
549
+
550
+ # Hides the row labels by calling {Wx::GRID::Grid#set_row_label_size} with a size of 0.
551
+ #
552
+ # The labels can be shown again by calling {Wx::GRID::Grid#set_row_label_size} with a width greater than 0.
553
+ # 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.
554
+ # @return [void]
555
+ def hide_row_labels; end
556
+
557
+ # Sets the horizontal and vertical alignment of column label text.
558
+ #
559
+ # 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}.
560
+ # @param horiz [Integer]
561
+ # @param vert [Integer]
562
+ # @return [void]
563
+ def set_col_label_alignment(horiz, vert) end
564
+
565
+ # Sets the orientation of the column labels (either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}).
566
+ # @param textOrientation [Integer]
567
+ # @return [void]
568
+ def set_col_label_text_orientation(textOrientation) end
569
+ alias_method :col_label_text_orientation=, :set_col_label_text_orientation
570
+
571
+ # Set the value for the given column label.
572
+ #
573
+ # If you are using a custom grid table you must override {Wx::GRID::GridTableBase#set_col_label_value} for this to have any effect.
574
+ # @param col [Integer]
575
+ # @param value [String]
576
+ # @return [void]
577
+ def set_col_label_value(col, value) end
578
+
579
+ # Sets the horizontal and vertical alignment of the (top-left) corner label text.
580
+ #
581
+ # 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}.
582
+ # @param horiz [Integer]
583
+ # @param vert [Integer]
584
+ # @return [void]
585
+ def set_corner_label_alignment(horiz, vert) end
586
+
587
+ # Sets the orientation of the (top-left) corner label (either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}).
588
+ # @param textOrientation [Integer]
589
+ # @return [void]
590
+ def set_corner_label_text_orientation(textOrientation) end
591
+ alias_method :corner_label_text_orientation=, :set_corner_label_text_orientation
592
+
593
+ # Set the value for the (top-left) corner label.
594
+ #
595
+ # If you are using a custom grid table you must override {Wx::GRID::GridTableBase#set_corner_label_value} for this to have any effect.
596
+ # @param arg [String]
597
+ # @return [void]
598
+ def set_corner_label_value(arg) end
599
+ alias_method :corner_label_value=, :set_corner_label_value
600
+
601
+ # Sets the background colour for row and column labels.
602
+ # @param colour [Wx::Colour,String,Symbol]
603
+ # @return [void]
604
+ def set_label_background_colour(colour) end
605
+ alias_method :label_background_colour=, :set_label_background_colour
606
+
607
+ # Sets the font for row and column labels.
608
+ # @param font [Wx::Font,Wx::FontInfo]
609
+ # @return [void]
610
+ def set_label_font(font) end
611
+ alias_method :label_font=, :set_label_font
612
+
613
+ # Sets the colour for row and column label text.
614
+ # @param colour [Wx::Colour,String,Symbol]
615
+ # @return [void]
616
+ def set_label_text_colour(colour) end
617
+ alias_method :label_text_colour=, :set_label_text_colour
618
+
619
+ # Sets the horizontal and vertical alignment of row label text.
620
+ #
621
+ # 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}.
622
+ # @param horiz [Integer]
623
+ # @param vert [Integer]
624
+ # @return [void]
625
+ def set_row_label_alignment(horiz, vert) end
626
+
627
+ # Sets the value for the given row label.
628
+ #
629
+ # If you are using a derived grid table you must override {Wx::GRID::GridTableBase#set_row_label_value} for this to have any effect.
630
+ # @param row [Integer]
631
+ # @param value [String]
632
+ # @return [void]
633
+ def set_row_label_value(row, value) end
634
+
635
+ # Call this in order to make the column labels use a native look by using Wx::RendererNative#draw_header_button internally.
636
+ #
637
+ # 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.
638
+ # @see Wx::GRID::Grid#use_native_col_header
639
+ # @param native [Boolean]
640
+ # @return [void]
641
+ def set_use_native_col_labels(native=true) end
642
+ alias_method :use_native_col_labels=, :set_use_native_col_labels
643
+
644
+ # Enable the use of native header window for column labels.
645
+ #
646
+ # 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.
647
+ # 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.
648
+ # 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).
649
+ # Finally, please note that using the native control is currently incompatible with freezing columns in the grid (see {Wx::GRID::Grid#freeze_to}) and this function will return false, without doing anything, if it's called on a grid in which any columns are frozen.
650
+ # @param native [Boolean]
651
+ # @return [Boolean]
652
+ def use_native_col_header(native=true) end
653
+
654
+ # Sets the arguments to the horizontal and vertical text alignment values for the grid cell at the specified location.
655
+ #
656
+ # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
657
+ # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
658
+ # @param row [Integer]
659
+ # @param col [Integer]
660
+ # @return [Array(Integer,Integer)]
661
+ def get_cell_alignment(row, col) end
662
+ alias_method :cell_alignment, :get_cell_alignment
663
+
664
+ # Returns the background colour of the cell at the specified location.
665
+ # @param row [Integer]
666
+ # @param col [Integer]
667
+ # @return [Wx::Colour]
668
+ def get_cell_background_colour(row, col) end
669
+ alias_method :cell_background_colour, :get_cell_background_colour
670
+
671
+ # Returns the font for text in the grid cell at the specified location.
672
+ # @param row [Integer]
673
+ # @param col [Integer]
674
+ # @return [Wx::Font]
675
+ def get_cell_font(row, col) end
676
+ alias_method :cell_font, :get_cell_font
677
+
678
+ # Returns the text colour for the grid cell at the specified location.
679
+ # @param row [Integer]
680
+ # @param col [Integer]
681
+ # @return [Wx::Colour]
682
+ def get_cell_text_colour(row, col) end
683
+ alias_method :cell_text_colour, :get_cell_text_colour
684
+
685
+ # Returns the default cell alignment.
686
+ #
687
+ # Horizontal alignment will be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
688
+ # Vertical alignment will be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
689
+ # @see Wx::GRID::Grid#set_default_cell_alignment
690
+ # @return [Array(Integer,Integer)]
691
+ def get_default_cell_alignment; end
692
+ alias_method :default_cell_alignment, :get_default_cell_alignment
693
+
694
+ # Returns the current default background colour for grid cells.
695
+ # @return [Wx::Colour]
696
+ def get_default_cell_background_colour; end
697
+ alias_method :default_cell_background_colour, :get_default_cell_background_colour
698
+
699
+ # Returns the current default font for grid cell text.
700
+ # @return [Wx::Font]
701
+ def get_default_cell_font; end
702
+ alias_method :default_cell_font, :get_default_cell_font
703
+
704
+ # Returns the current default colour for grid cell text.
705
+ # @return [Wx::Colour]
706
+ def get_default_cell_text_colour; end
707
+ alias_method :default_cell_text_colour, :get_default_cell_text_colour
708
+
709
+ # Sets the horizontal and vertical alignment for grid cell text at the specified location.
710
+ #
711
+ # Horizontal alignment should be one of {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_RIGHT}.
712
+ # Vertical alignment should be one of {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_BOTTOM}.
713
+ # @param row [Integer]
714
+ # @param col [Integer]
715
+ # @param horiz [Integer]
716
+ # @param vert [Integer]
717
+ # @return [void]
718
+ def set_cell_alignment(row, col, horiz, vert) end
719
+
720
+ # Set the background colour for the given cell or all cells by default.
721
+ # @param row [Integer]
722
+ # @param col [Integer]
723
+ # @param colour [Wx::Colour,String,Symbol]
724
+ # @return [void]
725
+ def set_cell_background_colour(row, col, colour) end
726
+
727
+ # Sets the font for text in the grid cell at the specified location.
728
+ # @param row [Integer]
729
+ # @param col [Integer]
730
+ # @param font [Wx::Font,Wx::FontInfo]
731
+ # @return [void]
732
+ def set_cell_font(row, col, font) end
733
+
734
+ # Sets the text colour for the given cell.
735
+ # @param row [Integer]
736
+ # @param col [Integer]
737
+ # @param colour [Wx::Colour,String,Symbol]
738
+ # @return [void]
739
+ def set_cell_text_colour(row, col, colour) end
740
+
741
+ # Sets the default horizontal and vertical alignment for grid cell text.
742
+ #
743
+ # 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}.
744
+ # @param horiz [Integer]
745
+ # @param vert [Integer]
746
+ # @return [void]
747
+ def set_default_cell_alignment(horiz, vert) end
748
+
749
+ # Sets the default background colour for grid cells.
750
+ # @param colour [Wx::Colour,String,Symbol]
751
+ # @return [void]
752
+ def set_default_cell_background_colour(colour) end
753
+ alias_method :default_cell_background_colour=, :set_default_cell_background_colour
754
+
755
+ # Sets the default font to be used for grid cell text.
756
+ # @param font [Wx::Font,Wx::FontInfo]
757
+ # @return [void]
758
+ def set_default_cell_font(font) end
759
+ alias_method :default_cell_font=, :set_default_cell_font
760
+
761
+ # Sets the current default colour for grid cell text.
762
+ # @param colour [Wx::Colour,String,Symbol]
763
+ # @return [void]
764
+ def set_default_cell_text_colour(colour) end
765
+ alias_method :default_cell_text_colour=, :set_default_cell_text_colour
766
+
767
+ # Returns true if the in-place edit control for the current grid cell can be used and false otherwise.
768
+ #
769
+ # This function always returns false for the read-only cells.
770
+ # @return [Boolean]
771
+ def can_enable_cell_control; end
772
+ alias_method :can_enable_cell_control?, :can_enable_cell_control
773
+
774
+ # Disables in-place editing of grid cells.
775
+ #
776
+ # Equivalent to calling EnableCellEditControl(false).
777
+ # @return [void]
778
+ def disable_cell_edit_control; end
779
+
780
+ # Enables or disables in-place editing of grid cell data.
781
+ #
782
+ # 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.
783
+ # 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.
784
+ # 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.
785
+ # @param enable [Boolean]
786
+ # @return [void]
787
+ def enable_cell_edit_control(enable=true) end
788
+
789
+ # Makes the grid globally editable or read-only.
790
+ #
791
+ # 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}.
792
+ # For more information about controlling grid cell attributes see the {Wx::GRID::GridCellAttr} class and the wxGrid Overview.
793
+ # @param edit [Boolean]
794
+ # @return [void]
795
+ def enable_editing(edit) end
796
+
797
+ # Returns a pointer to the editor for the cell at the specified location.
798
+ #
799
+ # See {Wx::GRID::GridCellEditor} and the wxGrid Overview for more information about cell editors and renderers.
800
+ # The caller must call DecRef() on the returned pointer.
801
+ # @param row [Integer]
802
+ # @param col [Integer]
803
+ # @return [Wx::GRID::GridCellEditor]
804
+ def get_cell_editor(row, col) end
805
+ alias_method :cell_editor, :get_cell_editor
806
+
807
+ # Returns a pointer to the renderer for the grid cell at the specified location.
808
+ #
809
+ # See {Wx::GRID::GridCellRenderer} and the wxGrid Overview for more information about cell editors and renderers.
810
+ # The caller must call DecRef() on the returned pointer.
811
+ # @param row [Integer]
812
+ # @param col [Integer]
813
+ # @return [Wx::GRID::GridCellRenderer]
814
+ def get_cell_renderer(row, col) end
815
+ alias_method :cell_renderer, :get_cell_renderer
816
+
817
+ # Returns the string contained in the cell at the specified location.
818
+ #
819
+ # 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.
820
+ # See {Wx::GRID::GridTableBase#can_get_value_as} and the wxGrid Overview for more information.
821
+ # @param row [Integer]
822
+ # @param col [Integer]
823
+ # @return [String]
824
+ def get_cell_value(row, col) end
825
+ alias_method :cell_value, :get_cell_value
826
+
827
+ # Returns a pointer to the current default grid cell editor.
828
+ #
829
+ # See {Wx::GRID::GridCellEditor} and the wxGrid Overview for more information about cell editors and renderers.
830
+ # @return [Wx::GRID::GridCellEditor]
831
+ def get_default_editor; end
832
+ alias_method :default_editor, :get_default_editor
833
+
834
+ # Returns the default editor for the specified cell.
835
+ #
836
+ # 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.
837
+ # Notice that the same may be achieved in a usually simpler way by associating a custom editor with the given cell or cells.
838
+ # The caller must call DecRef() on the returned pointer.
839
+ # @param row [Integer]
840
+ # @param col [Integer]
841
+ # @return [Wx::GRID::GridCellEditor]
842
+ def get_default_editor_for_cell(row, col) end
843
+ alias_method :default_editor_for_cell, :get_default_editor_for_cell
844
+
845
+ # Returns the default editor for the cells containing values of the given type.
846
+ #
847
+ # 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.
848
+ # The caller must call DecRef() on the returned pointer.
849
+ # @param typeName [String]
850
+ # @return [Wx::GRID::GridCellEditor]
851
+ def get_default_editor_for_type(typeName) end
852
+ alias_method :default_editor_for_type, :get_default_editor_for_type
853
+
854
+ # Returns a pointer to the current default grid cell renderer.
855
+ #
856
+ # See {Wx::GRID::GridCellRenderer} and the wxGrid Overview for more information about cell editors and renderers.
857
+ # The caller must call DecRef() on the returned pointer.
858
+ # @return [Wx::GRID::GridCellRenderer]
859
+ def get_default_renderer; end
860
+ alias_method :default_renderer, :get_default_renderer
861
+
862
+ # Returns the default renderer for the given cell.
863
+ #
864
+ # 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.
865
+ # The caller must call DecRef() on the returned pointer.
866
+ # @param row [Integer]
867
+ # @param col [Integer]
868
+ # @return [Wx::GRID::GridCellRenderer]
869
+ def get_default_renderer_for_cell(row, col) end
870
+ alias_method :default_renderer_for_cell, :get_default_renderer_for_cell
871
+
872
+ # Returns the default renderer for the cell containing values of the given type.
873
+ #
874
+ #
875
+ # @see Wx::GRID::Grid#get_default_editor_for_type
876
+ # @param typeName [String]
877
+ # @return [Wx::GRID::GridCellRenderer]
878
+ def get_default_renderer_for_type(typeName) end
879
+ alias_method :default_renderer_for_type, :get_default_renderer_for_type
880
+
881
+ # Hides the in-place cell edit control.
882
+ # @return [void]
883
+ def hide_cell_edit_control; end
884
+
885
+ # Returns true if the in-place edit control is currently enabled.
886
+ # @return [Boolean]
887
+ def is_cell_edit_control_enabled; end
888
+ alias_method :cell_edit_control_enabled?, :is_cell_edit_control_enabled
889
+
890
+ # Returns true if the in-place edit control is currently shown.
891
+ #
892
+ #
893
+ # @see Wx::GRID::Grid#hide_cell_edit_control
894
+ # @return [Boolean]
895
+ def is_cell_edit_control_shown; end
896
+ alias_method :cell_edit_control_shown?, :is_cell_edit_control_shown
897
+
898
+ # Returns true if the current cell is read-only.
899
+ #
900
+ #
901
+ # @see Wx::GRID::Grid#set_read_only
902
+ # @see Wx::GRID::Grid#is_read_only
903
+ # @return [Boolean]
904
+ def is_current_cell_read_only; end
905
+ alias_method :current_cell_read_only?, :is_current_cell_read_only
906
+
907
+ # Returns false if the whole grid has been set as read-only or true otherwise.
908
+ #
909
+ # See {Wx::GRID::Grid#enable_editing} for more information about controlling the editing status of grid cells.
910
+ # @return [Boolean]
911
+ def is_editable; end
912
+ alias_method :editable?, :is_editable
913
+
914
+ # Returns true if the cell at the specified location can't be edited.
915
+ #
916
+ #
917
+ # @see Wx::GRID::Grid#set_read_only
918
+ # @see Wx::GRID::Grid#is_current_cell_read_only
919
+ # @param row [Integer]
920
+ # @param col [Integer]
921
+ # @return [Boolean]
922
+ def is_read_only(row, col) end
923
+ alias_method :read_only?, :is_read_only
924
+
925
+ # Register a new data type.
926
+ #
927
+ # 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.
928
+ # 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.
929
+ # 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.
930
+ # @param typeName [String] Name of the new type. May be any string, but if the type name is the same as the name of an already registered type, including one of the standard ones (which are {Wx::GRID::GRID_VALUE_STRING}, {Wx::GRID::GRID_VALUE_BOOL}, {Wx::GRID::GRID_VALUE_NUMBER}, {Wx::GRID::GRID_VALUE_FLOAT}, {Wx::GRID::GRID_VALUE_CHOICE} and {Wx::GRID::GRID_VALUE_DATE}), then the new registration information replaces the previously used renderer and editor.
931
+ # @param renderer [Wx::GRID::GridCellRenderer] The renderer to use for the cells of this type. Its ownership is taken by the grid, i.e. it will call DecRef() on this pointer when it doesn't need it any longer.
932
+ # @param editor [Wx::GRID::GridCellEditor] The editor to use for the cells of this type. Its ownership is also taken by the grid.
933
+ # @return [void]
934
+ def register_data_type(typeName, renderer, editor) end
935
+
936
+ # Sets the value of the current grid cell to the current in-place edit control value.
937
+ #
938
+ # 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.
939
+ # @return [void]
940
+ def save_edit_control_value; end
941
+
942
+ # Sets the editor for the grid cell at the specified location.
943
+ #
944
+ # The grid will take ownership of the pointer.
945
+ # See {Wx::GRID::GridCellEditor} and the wxGrid Overview for more information about cell editors and renderers.
946
+ # @param row [Integer]
947
+ # @param col [Integer]
948
+ # @param editor [Wx::GRID::GridCellEditor]
949
+ # @return [void]
950
+ def set_cell_editor(row, col, editor) end
951
+
952
+ # Sets the renderer for the grid cell at the specified location.
953
+ #
954
+ # The grid will take ownership of the pointer.
955
+ # See {Wx::GRID::GridCellRenderer} and the wxGrid Overview for more information about cell editors and renderers.
956
+ # @param row [Integer]
957
+ # @param col [Integer]
958
+ # @param renderer [Wx::GRID::GridCellRenderer]
959
+ # @return [void]
960
+ def set_cell_renderer(row, col, renderer) end
961
+
962
+ # Sets the string value for the cell at the specified location.
963
+ #
964
+ # 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.
965
+ # See {Wx::GRID::GridTableBase#can_set_value_as} and the wxGrid Overview for more information.
966
+ # @param row [Integer]
967
+ # @param col [Integer]
968
+ # @param s [String]
969
+ # @return [void]
970
+ def set_cell_value(row, col, s) end
971
+
972
+ # Sets the specified column to display boolean values.
973
+ #
974
+ #
975
+ # @see Wx::GRID::Grid#set_col_format_custom
976
+ # @param col [Integer]
977
+ # @return [void]
978
+ def set_col_format_bool(col) end
979
+ alias_method :col_format_bool=, :set_col_format_bool
980
+
981
+ # Sets the specified column to display data in a custom format.
982
+ #
983
+ # 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.
984
+ # See the wxGrid Overview for more information on working with custom data types.
985
+ # @param col [Integer]
986
+ # @param typeName [String]
987
+ # @return [void]
988
+ def set_col_format_custom(col, typeName) end
989
+
990
+ # Sets the specified column to display floating point values with the given width and precision.
991
+ #
992
+ #
993
+ # @see Wx::GRID::Grid#set_col_format_custom
994
+ # @param col [Integer]
995
+ # @param width [Integer]
996
+ # @param precision [Integer]
997
+ # @return [void]
998
+ def set_col_format_float(col, width=-1, precision=-1) end
999
+ alias_method :col_format_float=, :set_col_format_float
1000
+
1001
+ # Sets the specified column to display integer values.
1002
+ #
1003
+ #
1004
+ # @see Wx::GRID::Grid#set_col_format_custom
1005
+ # @param col [Integer]
1006
+ # @return [void]
1007
+ def set_col_format_number(col) end
1008
+ alias_method :col_format_number=, :set_col_format_number
1009
+
1010
+ # Sets the specified column to display date values.
1011
+ #
1012
+ # 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.
1013
+ # @see Wx::GRID::Grid#set_col_format_custom
1014
+ # @param col [Integer]
1015
+ # @param format [String]
1016
+ # @return [void]
1017
+ def set_col_format_date(col, format=('')) end
1018
+ alias_method :col_format_date=, :set_col_format_date
1019
+
1020
+ # Sets the default editor for grid cells.
1021
+ #
1022
+ # The grid will take ownership of the pointer.
1023
+ # See {Wx::GRID::GridCellEditor} and the wxGrid Overview for more information about cell editors and renderers.
1024
+ # @param editor [Wx::GRID::GridCellEditor]
1025
+ # @return [void]
1026
+ def set_default_editor(editor) end
1027
+ alias_method :default_editor=, :set_default_editor
1028
+
1029
+ # Sets the default renderer for grid cells.
1030
+ #
1031
+ # The grid will take ownership of the pointer.
1032
+ # See {Wx::GRID::GridCellRenderer} and the wxGrid Overview for more information about cell editors and renderers.
1033
+ # @param renderer [Wx::GRID::GridCellRenderer]
1034
+ # @return [void]
1035
+ def set_default_renderer(renderer) end
1036
+ alias_method :default_renderer=, :set_default_renderer
1037
+
1038
+ # Makes the cell at the specified location read-only or editable.
1039
+ #
1040
+ #
1041
+ # @see Wx::GRID::Grid#is_read_only
1042
+ # @param row [Integer]
1043
+ # @param col [Integer]
1044
+ # @param isReadOnly [Boolean]
1045
+ # @return [void]
1046
+ def set_read_only(row, col, isReadOnly=true) end
1047
+
1048
+ # Displays the active in-place cell edit control for the current cell after it was hidden.
1049
+ #
1050
+ # 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.
1051
+ # @return [void]
1052
+ def show_cell_edit_control; end
1053
+
1054
+ # Automatically sets the height and width of all rows and columns to fit their contents.
1055
+ # @return [void]
1056
+ def auto_size; end
1057
+
1058
+ # Automatically adjusts width of the column to fit its label.
1059
+ # @param col [Integer]
1060
+ # @return [void]
1061
+ def auto_size_col_label_size(col) end
1062
+
1063
+ # Automatically sizes the column to fit its contents.
1064
+ #
1065
+ # If setAsMin is true the calculated width will also be set as the minimal width for the column.
1066
+ # @param col [Integer]
1067
+ # @param setAsMin [Boolean]
1068
+ # @return [void]
1069
+ def auto_size_column(col, setAsMin=true) end
1070
+
1071
+ # Automatically sizes all columns to fit their contents.
1072
+ #
1073
+ # If setAsMin is true the calculated widths will also be set as the minimal widths for the columns.
1074
+ # @param setAsMin [Boolean]
1075
+ # @return [void]
1076
+ def auto_size_columns(setAsMin=true) end
1077
+
1078
+ # Automatically sizes the row to fit its contents.
1079
+ #
1080
+ # If setAsMin is true the calculated height will also be set as the minimal height for the row.
1081
+ # @param row [Integer]
1082
+ # @param setAsMin [Boolean]
1083
+ # @return [void]
1084
+ def auto_size_row(row, setAsMin=true) end
1085
+
1086
+ # Automatically adjusts height of the row to fit its label.
1087
+ # @param col [Integer]
1088
+ # @return [void]
1089
+ def auto_size_row_label_size(col) end
1090
+
1091
+ # Automatically sizes all rows to fit their contents.
1092
+ #
1093
+ # If setAsMin is true the calculated heights will also be set as the minimal heights for the rows.
1094
+ # @param setAsMin [Boolean]
1095
+ # @return [void]
1096
+ def auto_size_rows(setAsMin=true) end
1097
+
1098
+ # Returns the cell fitting mode.
1099
+ #
1100
+ #
1101
+ # @see Wx::GRID::GridFitMode
1102
+ # @param row [Integer]
1103
+ # @param col [Integer]
1104
+ # @return [Wx::GRID::GridFitMode]
1105
+ def get_cell_fit_mode(row, col) end
1106
+ alias_method :cell_fit_mode, :get_cell_fit_mode
1107
+
1108
+ # Returns true if the cell value can overflow.
1109
+ #
1110
+ # This is identical to calling {Wx::GRID::Grid#get_cell_fit_mode} and using {Wx::GRID::GridFitMode#is_overflow} on the returned value.
1111
+ # Prefer using {Wx::GRID::Grid#get_cell_fit_mode} directly in the new code.
1112
+ # @param row [Integer]
1113
+ # @param col [Integer]
1114
+ # @return [Boolean]
1115
+ def get_cell_overflow(row, col) end
1116
+ alias_method :cell_overflow, :get_cell_overflow
1117
+
1118
+ # Returns the current height of the column labels.
1119
+ # @return [Integer]
1120
+ def get_col_label_size; end
1121
+ alias_method :col_label_size, :get_col_label_size
1122
+
1123
+ # Returns the minimal width to which a column may be resized.
1124
+ #
1125
+ # 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.
1126
+ # @see Wx::GRID::Grid#get_row_minimal_acceptable_height
1127
+ # @return [Integer]
1128
+ def get_col_minimal_acceptable_width; end
1129
+ alias_method :col_minimal_acceptable_width, :get_col_minimal_acceptable_width
1130
+
1131
+ # Returns the width of the specified column.
1132
+ # @param col [Integer]
1133
+ # @return [Integer]
1134
+ def get_col_size(col) end
1135
+ alias_method :col_size, :get_col_size
1136
+
1137
+ # Returns true if the specified column is not currently hidden.
1138
+ # @param col [Integer]
1139
+ # @return [Boolean]
1140
+ def is_col_shown(col) end
1141
+ alias_method :col_shown?, :is_col_shown
1142
+
1143
+ # Returns the default cell fitting mode.
1144
+ #
1145
+ # The default mode is "overflow", but can be modified using {Wx::GRID::Grid#set_default_cell_fit_mode}.
1146
+ # @see Wx::GRID::GridFitMode
1147
+ # @return [Wx::GRID::GridFitMode]
1148
+ def get_default_cell_fit_mode; end
1149
+ alias_method :default_cell_fit_mode, :get_default_cell_fit_mode
1150
+
1151
+ # Returns true if the cells can overflow by default.
1152
+ #
1153
+ # This is identical to calling {Wx::GRID::Grid#get_default_cell_fit_mode} and using {Wx::GRID::GridFitMode#is_overflow} on the returned value.
1154
+ # Prefer using {Wx::GRID::Grid#get_default_cell_fit_mode} directly in the new code.
1155
+ # @return [Boolean]
1156
+ def get_default_cell_overflow; end
1157
+ alias_method :default_cell_overflow, :get_default_cell_overflow
1158
+
1159
+ # Returns the default height for column labels.
1160
+ # @return [Integer]
1161
+ def get_default_col_label_size; end
1162
+ alias_method :default_col_label_size, :get_default_col_label_size
1163
+
1164
+ # Returns the current default width for grid columns.
1165
+ # @return [Integer]
1166
+ def get_default_col_size; end
1167
+ alias_method :default_col_size, :get_default_col_size
1168
+
1169
+ # Returns the default width for the row labels.
1170
+ # @return [Integer]
1171
+ def get_default_row_label_size; end
1172
+ alias_method :default_row_label_size, :get_default_row_label_size
1173
+
1174
+ # Returns the current default height for grid rows.
1175
+ # @return [Integer]
1176
+ def get_default_row_size; end
1177
+ alias_method :default_row_size, :get_default_row_size
1178
+
1179
+ # Returns the minimal size to which rows can be resized.
1180
+ #
1181
+ # 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.
1182
+ # @see Wx::GRID::Grid#get_col_minimal_acceptable_width
1183
+ # @return [Integer]
1184
+ def get_row_minimal_acceptable_height; end
1185
+ alias_method :row_minimal_acceptable_height, :get_row_minimal_acceptable_height
1186
+
1187
+ # Returns the current width of the row labels.
1188
+ # @return [Integer]
1189
+ def get_row_label_size; end
1190
+ alias_method :row_label_size, :get_row_label_size
1191
+
1192
+ # Returns the height of the specified row.
1193
+ # @param row [Integer]
1194
+ # @return [Integer]
1195
+ def get_row_size(row) end
1196
+ alias_method :row_size, :get_row_size
1197
+
1198
+ # Returns true if the specified row is not currently hidden.
1199
+ # @param row [Integer]
1200
+ # @return [Boolean]
1201
+ def is_row_shown(row) end
1202
+ alias_method :row_shown?, :is_row_shown
1203
+
1204
+ # Specifies the behaviour of the cell contents if it doesn't fit into the available space.
1205
+ #
1206
+ #
1207
+ # @see Wx::GRID::GridFitMode
1208
+ # @param row [Integer]
1209
+ # @param col [Integer]
1210
+ # @param fitMode [Wx::GRID::GridFitMode]
1211
+ # @return [void]
1212
+ def set_cell_fit_mode(row, col, fitMode) end
1213
+
1214
+ # Sets the overflow permission of the cell.
1215
+ #
1216
+ # Prefer using {Wx::GRID::Grid#set_cell_fit_mode} in the new code.
1217
+ # @param row [Integer]
1218
+ # @param col [Integer]
1219
+ # @param allow [Boolean]
1220
+ # @return [void]
1221
+ def set_cell_overflow(row, col, allow) end
1222
+
1223
+ # Sets the height of the column labels.
1224
+ #
1225
+ # 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.
1226
+ # @param height [Integer]
1227
+ # @return [void]
1228
+ def set_col_label_size(height) end
1229
+ alias_method :col_label_size=, :set_col_label_size
1230
+
1231
+ # Sets the minimal width to which the user can resize columns.
1232
+ #
1233
+ #
1234
+ # @see Wx::GRID::Grid#get_col_minimal_acceptable_width
1235
+ # @param width [Integer]
1236
+ # @return [void]
1237
+ def set_col_minimal_acceptable_width(width) end
1238
+ alias_method :col_minimal_acceptable_width=, :set_col_minimal_acceptable_width
1239
+
1240
+ # Sets the minimal width for the specified column col.
1241
+ #
1242
+ # 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.
1243
+ # width must be greater than the minimal acceptable column width as returned by {Wx::GRID::Grid#get_col_minimal_acceptable_width}.
1244
+ # @param col [Integer]
1245
+ # @param width [Integer]
1246
+ # @return [void]
1247
+ def set_col_minimal_width(col, width) end
1248
+
1249
+ # Sets the width of the specified column.
1250
+ # @param col [Integer] The column index.
1251
+ # @param width [Integer] The new column width in pixels, 0 to hide the column or -1 to fit the column width to its label width.
1252
+ # @return [void]
1253
+ def set_col_size(col, width) end
1254
+
1255
+ # Hides the specified column.
1256
+ #
1257
+ # 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.
1258
+ # If the column is already hidden, this method doesn't do anything.
1259
+ # @param col [Integer] The column index.
1260
+ # @return [void]
1261
+ def hide_col(col) end
1262
+
1263
+ # Shows the previously hidden column by resizing it to non-0 size.
1264
+ #
1265
+ # The column is shown again with the same width that it had before {Wx::GRID::Grid#hide_col} call.
1266
+ # If the column is currently shown, this method doesn't do anything.
1267
+ # @see Wx::GRID::Grid#hide_col
1268
+ # @see Wx::GRID::Grid#set_col_size
1269
+ # @param col [Integer]
1270
+ # @return [void]
1271
+ def show_col(col) end
1272
+
1273
+ # Specifies the default behaviour of the cell contents if it doesn't fit into the available space.
1274
+ #
1275
+ #
1276
+ # @see Wx::GRID::GridFitMode
1277
+ # @param fitMode [Wx::GRID::GridFitMode]
1278
+ # @return [void]
1279
+ def set_default_cell_fit_mode(fitMode) end
1280
+ alias_method :default_cell_fit_mode=, :set_default_cell_fit_mode
1281
+
1282
+ # Sets the default overflow permission of the cells.
1283
+ #
1284
+ # Prefer using {Wx::GRID::Grid#set_default_cell_fit_mode} in the new code.
1285
+ # @param allow [Boolean]
1286
+ # @return [void]
1287
+ def set_default_cell_overflow(allow) end
1288
+ alias_method :default_cell_overflow=, :set_default_cell_overflow
1289
+
1290
+ # Sets the default width for columns in the grid.
1291
+ #
1292
+ # This will only affect columns subsequently added to the grid unless resizeExistingCols is true.
1293
+ # If width is less than {Wx::GRID::Grid#get_col_minimal_acceptable_width}, then the minimal acceptable width is used instead of it.
1294
+ # @param width [Integer]
1295
+ # @param resizeExistingCols [Boolean]
1296
+ # @return [void]
1297
+ def set_default_col_size(width, resizeExistingCols=false) end
1298
+ alias_method :default_col_size=, :set_default_col_size
1299
+
1300
+ # Sets the default height for rows in the grid.
1301
+ #
1302
+ # This will only affect rows subsequently added to the grid unless resizeExistingRows is true.
1303
+ # If height is less than {Wx::GRID::Grid#get_row_minimal_acceptable_height}, then the minimal acceptable height is used instead of it.
1304
+ # @param height [Integer]
1305
+ # @param resizeExistingRows [Boolean]
1306
+ # @return [void]
1307
+ def set_default_row_size(height, resizeExistingRows=false) end
1308
+ alias_method :default_row_size=, :set_default_row_size
1309
+
1310
+ # Sets the width of the row labels.
1311
+ #
1312
+ # 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.
1313
+ # @param width [Integer]
1314
+ # @return [void]
1315
+ def set_row_label_size(width) end
1316
+ alias_method :row_label_size=, :set_row_label_size
1317
+
1318
+ # Sets the minimal row height used by default.
1319
+ #
1320
+ # See {Wx::GRID::Grid#set_col_minimal_acceptable_width} for more information.
1321
+ # @param height [Integer]
1322
+ # @return [void]
1323
+ def set_row_minimal_acceptable_height(height) end
1324
+ alias_method :row_minimal_acceptable_height=, :set_row_minimal_acceptable_height
1325
+
1326
+ # Sets the minimal height for the specified row.
1327
+ #
1328
+ # See {Wx::GRID::Grid#set_col_minimal_width} for more information.
1329
+ # @param row [Integer]
1330
+ # @param height [Integer]
1331
+ # @return [void]
1332
+ def set_row_minimal_height(row, height) end
1333
+
1334
+ # Sets the height of the specified row.
1335
+ #
1336
+ # See {Wx::GRID::Grid#set_col_size} for more information.
1337
+ # @param row [Integer]
1338
+ # @param height [Integer]
1339
+ # @return [void]
1340
+ def set_row_size(row, height) end
1341
+
1342
+ # Hides the specified row.
1343
+ #
1344
+ # 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.
1345
+ # If the row is already hidden, this method doesn't do anything.
1346
+ # @param col [Integer] The row index.
1347
+ # @return [void]
1348
+ def hide_row(col) end
1349
+
1350
+ # Shows the previously hidden row.
1351
+ #
1352
+ # The row is shown again with the same height that it had before {Wx::GRID::Grid#hide_row} call.
1353
+ # If the row is currently shown, this method doesn't do anything.
1354
+ # @see Wx::GRID::Grid#hide_row
1355
+ # @see Wx::GRID::Grid#set_row_size
1356
+ # @param col [Integer]
1357
+ # @return [void]
1358
+ def show_row(col) end
1359
+
1360
+ # Get size information for all columns at once.
1361
+ #
1362
+ # 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}.
1363
+ # @see Wx::GRID::GridSizesInfo
1364
+ # @see Wx::GRID::Grid#get_row_sizes
1365
+ # @return [Wx::GRID::GridSizesInfo]
1366
+ def get_col_sizes; end
1367
+ alias_method :col_sizes, :get_col_sizes
1368
+
1369
+ # Get size information for all row at once.
1370
+ #
1371
+ #
1372
+ # @see Wx::GRID::GridSizesInfo
1373
+ # @see Wx::GRID::Grid#get_col_sizes
1374
+ # @return [Wx::GRID::GridSizesInfo]
1375
+ def get_row_sizes; end
1376
+ alias_method :row_sizes, :get_row_sizes
1377
+
1378
+ # Restore all columns sizes.
1379
+ #
1380
+ # This is usually called with {Wx::GRID::GridSizesInfo} object previously returned by {Wx::GRID::Grid#get_col_sizes}.
1381
+ # @see Wx::GRID::Grid#set_row_sizes
1382
+ # @param sizeInfo [Wx::GRID::GridSizesInfo]
1383
+ # @return [void]
1384
+ def set_col_sizes(sizeInfo) end
1385
+ alias_method :col_sizes=, :set_col_sizes
1386
+
1387
+ # Restore all rows sizes.
1388
+ #
1389
+ #
1390
+ # @see Wx::GRID::Grid#set_col_sizes
1391
+ # @param sizeInfo [Wx::GRID::GridSizesInfo]
1392
+ # @return [void]
1393
+ def set_row_sizes(sizeInfo) end
1394
+ alias_method :row_sizes=, :set_row_sizes
1395
+
1396
+ # Set the size of the cell.
1397
+ #
1398
+ # 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.
1399
+ # @see Wx::GRID::Grid#get_cell_size
1400
+ # @param row [Integer] The row of the cell.
1401
+ # @param col [Integer] The column of the cell.
1402
+ # @param num_rows [Integer] Number of rows to be occupied by this cell, must be >= 1.
1403
+ # @param num_cols [Integer] Number of columns to be occupied by this cell, must be >= 1.
1404
+ # @return [void]
1405
+ def set_cell_size(row, col, num_rows, num_cols) end
1406
+
1407
+ # @overload get_cell_size(row, col)
1408
+ # Get the size of the cell in number of cells covered by it.
1409
+ #
1410
+ # 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.
1411
+ # 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.
1412
+ # 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
1413
+ # ```
1414
+ # +----+----+----+
1415
+ # | | | |
1416
+ # +----+----+----+
1417
+ # | | |
1418
+ # +----+ |
1419
+ # | | |
1420
+ # +----+----+----+
1421
+ # ```
1422
+ # Then the function returns 2 and 2 in num_rows and num_cols for the cell (1, 1) itself and -1 and -1 for the cell (2, 2) as well as -1 and 0 for the cell (2, 1).
1423
+ #
1424
+ # The kind of this cell span (the return value is new in wxWidgets 2.9.1, this function was void in previous wxWidgets versions).
1425
+ # @param row [Integer] The row of the cell.
1426
+ # @param col [Integer] The column of the cell.
1427
+ # @return [Array(Wx::Grid::CellSpan,Integer,Integer)]
1428
+ # @overload get_cell_size(coords)
1429
+ # Get the number of rows and columns allocated for this cell.
1430
+ #
1431
+ # This overload doesn't return a {Wx::GRID::Grid::CellSpan} value but the values returned may still be negative, see GetCellSize(int, int, int *, int *) for details.
1432
+ # @param coords [Array(Integer, Integer)]
1433
+ # @return [Wx::Size]
1434
+ def get_cell_size(*args) end
1435
+ alias_method :cell_size, :get_cell_size
1436
+
1437
+ # Return true if the dragging of cells is enabled or false otherwise.
1438
+ # @return [Boolean]
1439
+ def can_drag_cell; end
1440
+ alias_method :can_drag_cell?, :can_drag_cell
1441
+
1442
+ # Returns true if columns can be moved by dragging with the mouse.
1443
+ #
1444
+ # Columns can be moved by dragging on their labels.
1445
+ # @return [Boolean]
1446
+ def can_drag_col_move; end
1447
+ alias_method :can_drag_col_move?, :can_drag_col_move
1448
+
1449
+ # Returns true if the given column can be resized by dragging with the mouse.
1450
+ #
1451
+ # 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}.
1452
+ # @param col [Integer]
1453
+ # @return [Boolean]
1454
+ def can_drag_col_size(col) end
1455
+ alias_method :can_drag_col_size?, :can_drag_col_size
1456
+
1457
+ # Return true if column edges inside the grid can be dragged to resize the rows.
1458
+ #
1459
+ #
1460
+ # @see Wx::GRID::Grid#can_drag_grid_size
1461
+ # @see Wx::GRID::Grid#can_drag_col_size
1462
+ # @return [Boolean]
1463
+ def can_drag_grid_col_edges; end
1464
+ alias_method :can_drag_grid_col_edges?, :can_drag_grid_col_edges
1465
+
1466
+ # Return true if row edges inside the grid can be dragged to resize the rows.
1467
+ #
1468
+ #
1469
+ # @see Wx::GRID::Grid#can_drag_grid_size
1470
+ # @see Wx::GRID::Grid#can_drag_row_size
1471
+ # @return [Boolean]
1472
+ def can_drag_grid_row_edges; end
1473
+ alias_method :can_drag_grid_row_edges?, :can_drag_grid_row_edges
1474
+
1475
+ # Return true if the dragging of grid lines to resize rows and columns is enabled or false otherwise.
1476
+ # @return [Boolean]
1477
+ def can_drag_grid_size; end
1478
+ alias_method :can_drag_grid_size?, :can_drag_grid_size
1479
+
1480
+ # Returns true if rows can be moved by dragging with the mouse.
1481
+ #
1482
+ # Rows can be moved by dragging on their labels.
1483
+ # @return [Boolean]
1484
+ def can_drag_row_move; end
1485
+ alias_method :can_drag_row_move?, :can_drag_row_move
1486
+
1487
+ # Returns true if the given row can be resized by dragging with the mouse.
1488
+ #
1489
+ # This is the same as {Wx::GRID::Grid#can_drag_col_size} but for rows.
1490
+ # @param row [Integer]
1491
+ # @return [Boolean]
1492
+ def can_drag_row_size(row) end
1493
+ alias_method :can_drag_row_size?, :can_drag_row_size
1494
+
1495
+ # Returns true if the row labels can be resized by dragging with the mouse.
1496
+ # @return [Boolean]
1497
+ def can_drag_row_label_size; end
1498
+ alias_method :can_drag_row_label_size?, :can_drag_row_label_size
1499
+
1500
+ # Returns true if the column labels can be resized by dragging with the mouse.
1501
+ #
1502
+ # This is the same as {Wx::GRID::Grid#can_drag_row_label_size} but for column labels.
1503
+ # @return [Boolean]
1504
+ def can_drag_col_label_size; end
1505
+ alias_method :can_drag_col_label_size?, :can_drag_col_label_size
1506
+
1507
+ # Returns true if columns can be hidden from the popup menu of the native header.
1508
+ # @return [Boolean]
1509
+ def can_hide_columns; end
1510
+ alias_method :can_hide_columns?, :can_hide_columns
1511
+
1512
+ # Disable interactive resizing of the specified column.
1513
+ #
1514
+ # 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).
1515
+ # 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.
1516
+ # Also notice that disabling interactive column resizing will not prevent the program from changing the column size.
1517
+ # @see Wx::GRID::Grid#enable_drag_col_size
1518
+ # @param col [Integer]
1519
+ # @return [void]
1520
+ def disable_col_resize(col) end
1521
+
1522
+ # Disable interactive resizing of the specified row.
1523
+ #
1524
+ # This is the same as {Wx::GRID::Grid#disable_col_resize} but for rows.
1525
+ # @see Wx::GRID::Grid#enable_drag_row_size
1526
+ # @param row [Integer]
1527
+ # @return [void]
1528
+ def disable_row_resize(row) end
1529
+
1530
+ # Disables column moving by dragging with the mouse.
1531
+ #
1532
+ # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_col_move}.
1533
+ # @return [void]
1534
+ def disable_drag_col_move; end
1535
+
1536
+ # Disables row moving by dragging with the mouse.
1537
+ #
1538
+ # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_row_move}.
1539
+ # @return [void]
1540
+ def disable_drag_row_move; end
1541
+
1542
+ # Disables column sizing by dragging with the mouse.
1543
+ #
1544
+ # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_col_size}.
1545
+ # @return [void]
1546
+ def disable_drag_col_size; end
1547
+
1548
+ # Disable mouse dragging of grid lines to resize rows and columns.
1549
+ #
1550
+ # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_grid_size}
1551
+ # @return [void]
1552
+ def disable_drag_grid_size; end
1553
+
1554
+ # Disables row sizing by dragging with the mouse.
1555
+ #
1556
+ # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_row_size}.
1557
+ # @return [void]
1558
+ def disable_drag_row_size; end
1559
+
1560
+ # Disables row label sizing by dragging with the mouse.
1561
+ #
1562
+ # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_row_label_size}.
1563
+ # @return [void]
1564
+ def disable_drag_row_label_size; end
1565
+
1566
+ # Disables column label sizing by dragging with the mouse.
1567
+ #
1568
+ # Equivalent to passing false to {Wx::GRID::Grid#enable_drag_col_label_size}.
1569
+ # @return [void]
1570
+ def disable_drag_col_label_size; end
1571
+
1572
+ # Disables column hiding from the header popup menu.
1573
+ #
1574
+ # Equivalent to passing false to {Wx::GRID::Grid#enable_hiding_columns}.
1575
+ # @return [void]
1576
+ def disable_hiding_columns; end
1577
+
1578
+ # Enable interactively resizing a column if it was previously forbidden.
1579
+ #
1580
+ # Calling this function only makes sense if the row resizing had been previously forbidden using {Wx::GRID::Grid#disable_col_resize}, as it simply undoes its effect.
1581
+ # @param col [Integer]
1582
+ # @return [void]
1583
+ def enable_col_resize(col) end
1584
+
1585
+ # Enables or disables cell dragging with the mouse.
1586
+ # @param enable [Boolean]
1587
+ # @return [void]
1588
+ def enable_drag_cell(enable=true) end
1589
+
1590
+ # Enables or disables column moving by dragging with the mouse.
1591
+ #
1592
+ # 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.
1593
+ # @param enable [Boolean]
1594
+ # @return [Boolean]
1595
+ def enable_drag_col_move(enable=true) end
1596
+
1597
+ # Enables or disables row moving by dragging with the mouse.
1598
+ #
1599
+ # 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.
1600
+ # @param enable [Boolean]
1601
+ # @return [Boolean]
1602
+ def enable_drag_row_move(enable=true) end
1603
+
1604
+ # Enables or disables column sizing by dragging with the mouse.
1605
+ #
1606
+ #
1607
+ # @see Wx::GRID::Grid#disable_col_resize
1608
+ # @param enable [Boolean]
1609
+ # @return [void]
1610
+ def enable_drag_col_size(enable=true) end
1611
+
1612
+ # Enables or disables row and column resizing by dragging gridlines with the mouse.
1613
+ # @param enable [Boolean]
1614
+ # @return [void]
1615
+ def enable_drag_grid_size(enable=true) end
1616
+
1617
+ # Enables or disables row sizing by dragging with the mouse.
1618
+ #
1619
+ #
1620
+ # @see Wx::GRID::Grid#disable_row_resize
1621
+ # @param enable [Boolean]
1622
+ # @return [void]
1623
+ def enable_drag_row_size(enable=true) end
1624
+
1625
+ # Enables or disables row label sizing by dragging with the mouse.
1626
+ #
1627
+ #
1628
+ # @see Wx::GRID::Grid#disable_drag_row_label_size
1629
+ # @param enable [Boolean]
1630
+ # @return [void]
1631
+ def enable_drag_row_label_size(enable=true) end
1632
+
1633
+ # Enables or disables col label sizing by dragging with the mouse.
1634
+ #
1635
+ #
1636
+ # @see Wx::GRID::Grid#disable_drag_col_label_size
1637
+ # @param enable [Boolean]
1638
+ # @return [void]
1639
+ def enable_drag_col_label_size(enable=true) end
1640
+
1641
+ # Enables or disables column hiding from the header popup menu.
1642
+ #
1643
+ # 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.
1644
+ # 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.
1645
+ # The main use case for this method is to disallow hiding the columns interactively when using the native header.
1646
+ # @see Wx::GRID::Grid#disable_hiding_columns
1647
+ # @param enable [Boolean]
1648
+ # @return [Boolean]
1649
+ def enable_hiding_columns(enable=true) end
1650
+
1651
+ # Enable interactively resizing a row if it was previously forbidden.
1652
+ #
1653
+ # Calling this function only makes sense if the row resizing had been previously forbidden using {Wx::GRID::Grid#disable_row_resize}, as it simply undoes its effect.
1654
+ # @param row [Integer]
1655
+ # @return [void]
1656
+ def enable_row_resize(row) end
1657
+
1658
+ # Returns the column ID of the specified column position.
1659
+ # @param colPos [Integer]
1660
+ # @return [Integer]
1661
+ def get_col_at(colPos) end
1662
+ alias_method :col_at, :get_col_at
1663
+
1664
+ # Returns the position of the specified column.
1665
+ # @param colID [Integer]
1666
+ # @return [Integer]
1667
+ def get_col_pos(colID) end
1668
+ alias_method :col_pos, :get_col_pos
1669
+
1670
+ # Sets the position of the specified column.
1671
+ # @param colID [Integer]
1672
+ # @param newPos [Integer]
1673
+ # @return [void]
1674
+ def set_col_pos(colID, newPos) end
1675
+
1676
+ # Sets the positions of all columns at once.
1677
+ #
1678
+ # 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}.
1679
+ # @param order [Array<Integer>]
1680
+ # @return [void]
1681
+ def set_columns_order(order) end
1682
+ alias_method :columns_order=, :set_columns_order
1683
+
1684
+ # Resets the position of the columns to the default.
1685
+ # @return [void]
1686
+ def reset_col_pos; end
1687
+
1688
+ # Returns the row ID of the specified row position.
1689
+ # @param rowPos [Integer]
1690
+ # @return [Integer]
1691
+ def get_row_at(rowPos) end
1692
+ alias_method :row_at, :get_row_at
1693
+
1694
+ # Returns the position of the specified row.
1695
+ # @param rowID [Integer]
1696
+ # @return [Integer]
1697
+ def get_row_pos(rowID) end
1698
+ alias_method :row_pos, :get_row_pos
1699
+
1700
+ # Sets the position of the specified row.
1701
+ # @param rowID [Integer]
1702
+ # @param newPos [Integer]
1703
+ # @return [void]
1704
+ def set_row_pos(rowID, newPos) end
1705
+
1706
+ # Sets the positions of all rows at once.
1707
+ #
1708
+ # This method takes an array containing the indices of the rows in their display order.
1709
+ # @param order [Array<Integer>]
1710
+ # @return [void]
1711
+ def set_rows_order(order) end
1712
+ alias_method :rows_order=, :set_rows_order
1713
+
1714
+ # Resets the position of the rows to the default.
1715
+ # @return [void]
1716
+ def reset_row_pos; end
1717
+
1718
+ # Returns the current grid cursor position.
1719
+ #
1720
+ # 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>.
1721
+ # @return [Array(Integer, Integer)]
1722
+ def get_grid_cursor_coords; end
1723
+ alias_method :grid_cursor_coords, :get_grid_cursor_coords
1724
+
1725
+ # Returns the current grid cell column position.
1726
+ #
1727
+ #
1728
+ # @see Wx::GRID::Grid#get_grid_cursor_coords
1729
+ # @return [Integer]
1730
+ def get_grid_cursor_col; end
1731
+ alias_method :grid_cursor_col, :get_grid_cursor_col
1732
+
1733
+ # Returns the current grid cell row position.
1734
+ #
1735
+ #
1736
+ # @see Wx::GRID::Grid#get_grid_cursor_coords
1737
+ # @return [Integer]
1738
+ def get_grid_cursor_row; end
1739
+ alias_method :grid_cursor_row, :get_grid_cursor_row
1740
+
1741
+ # @overload go_to_cell(row, col)
1742
+ # Make the given cell current and ensure it is visible.
1743
+ #
1744
+ # 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.
1745
+ # @param row [Integer]
1746
+ # @param col [Integer]
1747
+ # @return [void]
1748
+ # @overload go_to_cell(coords)
1749
+ # Make the given cell current and ensure it is visible.
1750
+ #
1751
+ # 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.
1752
+ # @param coords [Array(Integer, Integer)]
1753
+ # @return [void]
1754
+ def go_to_cell(*args) end
1755
+
1756
+ # Moves the grid cursor down by one row.
1757
+ #
1758
+ # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1759
+ # @param expandSelection [Boolean]
1760
+ # @return [Boolean]
1761
+ def move_cursor_down(expandSelection) end
1762
+
1763
+ # 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.
1764
+ #
1765
+ # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1766
+ # @param expandSelection [Boolean]
1767
+ # @return [Boolean]
1768
+ def move_cursor_down_block(expandSelection) end
1769
+
1770
+ # Moves the grid cursor left by one column.
1771
+ #
1772
+ # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1773
+ # @param expandSelection [Boolean]
1774
+ # @return [Boolean]
1775
+ def move_cursor_left(expandSelection) end
1776
+
1777
+ # 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.
1778
+ #
1779
+ # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1780
+ # @param expandSelection [Boolean]
1781
+ # @return [Boolean]
1782
+ def move_cursor_left_block(expandSelection) end
1783
+
1784
+ # Moves the grid cursor right by one column.
1785
+ #
1786
+ # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1787
+ # @param expandSelection [Boolean]
1788
+ # @return [Boolean]
1789
+ def move_cursor_right(expandSelection) end
1790
+
1791
+ # 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.
1792
+ #
1793
+ # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1794
+ # @param expandSelection [Boolean]
1795
+ # @return [Boolean]
1796
+ def move_cursor_right_block(expandSelection) end
1797
+
1798
+ # Moves the grid cursor up by one row.
1799
+ #
1800
+ # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1801
+ # @param expandSelection [Boolean]
1802
+ # @return [Boolean]
1803
+ def move_cursor_up(expandSelection) end
1804
+
1805
+ # 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.
1806
+ #
1807
+ # If a block of cells was previously selected it will expand if the argument is true or be cleared if the argument is false.
1808
+ # @param expandSelection [Boolean]
1809
+ # @return [Boolean]
1810
+ def move_cursor_up_block(expandSelection) end
1811
+
1812
+ # Moves the grid cursor down by some number of rows so that the previous bottom visible row becomes the top visible row.
1813
+ # @return [Boolean]
1814
+ def move_page_down; end
1815
+
1816
+ # Moves the grid cursor up by some number of rows so that the previous top visible row becomes the bottom visible row.
1817
+ # @return [Boolean]
1818
+ def move_page_up; end
1819
+
1820
+ # @overload set_grid_cursor(row, col)
1821
+ # Set the grid cursor to the specified cell.
1822
+ #
1823
+ # The grid cursor indicates the current cell and can be moved by the user using the arrow keys or the mouse.
1824
+ # 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.
1825
+ # This function doesn't make the target call visible, use {Wx::GRID::Grid#go_to_cell} to do this.
1826
+ # @param row [Integer]
1827
+ # @param col [Integer]
1828
+ # @return [void]
1829
+ # @overload set_grid_cursor(coords)
1830
+ # Set the grid cursor to the specified cell.
1831
+ #
1832
+ # The grid cursor indicates the current cell and can be moved by the user using the arrow keys or the mouse.
1833
+ # 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.
1834
+ # This function doesn't make the target call visible, use {Wx::GRID::Grid#go_to_cell} to do this.
1835
+ # @param coords [Array(Integer, Integer)]
1836
+ # @return [void]
1837
+ def set_grid_cursor(*args) end
1838
+ alias_method :grid_cursor=, :set_grid_cursor
1839
+
1840
+ # Set the grid's behaviour when the user presses the TAB key.
1841
+ #
1842
+ # 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.
1843
+ # 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.
1844
+ # 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.
1845
+ # @param behaviour [Wx::Grid::TabBehaviour]
1846
+ # @return [void]
1847
+ def set_tab_behaviour(behaviour) end
1848
+ alias_method :tab_behaviour=, :set_tab_behaviour
1849
+
1850
+ # Deselects all cells that are currently selected.
1851
+ # @return [void]
1852
+ def clear_selection; end
1853
+
1854
+ # Copies all cells that are currently selected.
1855
+ #
1856
+ # Note that the cells must be contiguously selected; otherwise, nothing will be copied.
1857
+ # Returns true if content is successfully copied, false otherwise. false will be returned if nothing was selected, the selected cells weren't contiguous, or a clipboard error occurred.
1858
+ # @return [Boolean]
1859
+ def copy_selection; end
1860
+
1861
+ # Deselects a row of cells.
1862
+ # @param row [Integer]
1863
+ # @return [void]
1864
+ def deselect_row(row) end
1865
+
1866
+ # Deselects a column of cells.
1867
+ # @param col [Integer]
1868
+ # @return [void]
1869
+ def deselect_col(col) end
1870
+
1871
+ # Deselects a cell.
1872
+ # @param row [Integer]
1873
+ # @param col [Integer]
1874
+ # @return [void]
1875
+ def deselect_cell(row, col) end
1876
+
1877
+ # Returns a range of grid selection blocks.
1878
+ #
1879
+ # The returned range can be iterated over:
1880
+ # ```ruby
1881
+ # grid.get_selected_blocks.each do |gbc|
1882
+ # break if gbc.intersects(my_block)
1883
+ # end
1884
+ # ```
1885
+ #
1886
+ # Notice that the blocks returned by this method are not ordered in any particular way and may overlap. For grids using rows or columns-only selection modes, {Wx::GRID::Grid#get_selected_row_blocks} or {Wx::GRID::Grid#get_selected_col_blocks} can be more convenient, as they return ordered and non-overlapping blocks.
1887
+ # @return [Array<Wx::GRID::GridBlockCoords>]
1888
+ def get_selected_blocks; end
1889
+ alias_method :selected_blocks, :get_selected_blocks
1890
+
1891
+ # Returns an ordered range of non-overlapping selected rows.
1892
+ #
1893
+ # 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.
1894
+ # 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.
1895
+ # This method returns empty vector for the other selection modes.
1896
+ # @see Wx::GRID::Grid#get_selected_blocks
1897
+ # @see Wx::GRID::Grid#get_selected_col_blocks
1898
+ # @return [Array<Wx::GRID::GridBlockCoords>]
1899
+ def get_selected_row_blocks; end
1900
+ alias_method :selected_row_blocks, :get_selected_row_blocks
1901
+
1902
+ # Returns an ordered range of non-overlapping selected columns.
1903
+ #
1904
+ # This method is symmetric to {Wx::GRID::Grid#get_selected_row_blocks}, but is useful only in {Wx::GRID::Grid::GridSelectionModes::GridSelectColumns} selection mode.
1905
+ # @see Wx::GRID::Grid#get_selected_blocks
1906
+ # @return [Array<Wx::GRID::GridBlockCoords>]
1907
+ def get_selected_col_blocks; end
1908
+ alias_method :selected_col_blocks, :get_selected_col_blocks
1909
+
1910
+ # Returns an array of individually selected cells.
1911
+ #
1912
+ # 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.
1913
+ # 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).
1914
+ # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1915
+ # @return [Array<Array(Integer, Integer)>]
1916
+ def get_selected_cells; end
1917
+ alias_method :selected_cells, :get_selected_cells
1918
+
1919
+ # Returns an array of selected columns.
1920
+ #
1921
+ # 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.
1922
+ # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1923
+ # @return [Array<Integer>]
1924
+ def get_selected_cols; end
1925
+ alias_method :selected_cols, :get_selected_cols
1926
+
1927
+ # Returns an array of selected rows.
1928
+ #
1929
+ # 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.
1930
+ # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1931
+ # @return [Array<Integer>]
1932
+ def get_selected_rows; end
1933
+ alias_method :selected_rows, :get_selected_rows
1934
+
1935
+ # Returns the colour used for drawing the selection background.
1936
+ # @return [Wx::Colour]
1937
+ def get_selection_background; end
1938
+ alias_method :selection_background, :get_selection_background
1939
+
1940
+ # Returns an array of the bottom right corners of blocks of selected cells.
1941
+ #
1942
+ # Please see {Wx::GRID::Grid#get_selected_cells} for more information about the selection representation in {Wx::GRID::Grid}.
1943
+ # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1944
+ # @see Wx::GRID::Grid#get_selection_block_top_left
1945
+ # @return [Array<Array(Integer, Integer)>]
1946
+ def get_selection_block_bottom_right; end
1947
+ alias_method :selection_block_bottom_right, :get_selection_block_bottom_right
1948
+
1949
+ # Returns an array of the top left corners of blocks of selected cells.
1950
+ #
1951
+ # Please see {Wx::GRID::Grid#get_selected_cells} for more information about the selection representation in {Wx::GRID::Grid}.
1952
+ # The function can be slow for the big grids, use {Wx::GRID::Grid#get_selected_blocks} in the new code.
1953
+ # @see Wx::GRID::Grid#get_selection_block_bottom_right
1954
+ # @return [Array<Array(Integer, Integer)>]
1955
+ def get_selection_block_top_left; end
1956
+ alias_method :selection_block_top_left, :get_selection_block_top_left
1957
+
1958
+ # Returns the colour used for drawing the selection foreground.
1959
+ # @return [Wx::Colour]
1960
+ def get_selection_foreground; end
1961
+ alias_method :selection_foreground, :get_selection_foreground
1962
+
1963
+ # Returns the current selection mode.
1964
+ #
1965
+ #
1966
+ # @see Wx::GRID::Grid#set_selection_mode.
1967
+ # @return [Wx::Grid::GridSelectionModes]
1968
+ def get_selection_mode; end
1969
+ alias_method :selection_mode, :get_selection_mode
1970
+
1971
+ # Returns true if the given cell is selected.
1972
+ # @param row [Integer]
1973
+ # @param col [Integer]
1974
+ # @return [Boolean]
1975
+ def is_in_selection(row, col) end
1976
+ alias_method :in_selection?, :is_in_selection
1977
+
1978
+ # Returns true if there are currently any selected cells, rows, columns or blocks.
1979
+ # @return [Boolean]
1980
+ def is_selection; end
1981
+ alias_method :selection?, :is_selection
1982
+
1983
+ # Selects all cells in the grid.
1984
+ # @return [void]
1985
+ def select_all; end
1986
+
1987
+ # Selects a rectangular block of cells.
1988
+ #
1989
+ # If addToSelected is false then any existing selection will be deselected; if true the column will be added to the existing selection.
1990
+ # @param topRow [Integer]
1991
+ # @param leftCol [Integer]
1992
+ # @param bottomRow [Integer]
1993
+ # @param rightCol [Integer]
1994
+ # @param addToSelected [Boolean]
1995
+ # @return [void]
1996
+ def select_block(topRow, leftCol, bottomRow, rightCol, addToSelected=false) end
1997
+
1998
+ # Selects the specified column.
1999
+ #
2000
+ # If addToSelected is false then any existing selection will be deselected; if true the column will be added to the existing selection.
2001
+ # This method won't select anything if the current selection mode is {Wx::GRID::Grid::GridSelectionModes::GridSelectRows}.
2002
+ # @param col [Integer]
2003
+ # @param addToSelected [Boolean]
2004
+ # @return [void]
2005
+ def select_col(col, addToSelected=false) end
2006
+
2007
+ # Selects the specified row.
2008
+ #
2009
+ # If addToSelected is false then any existing selection will be deselected; if true the row will be added to the existing selection.
2010
+ # This method won't select anything if the current selection mode is {Wx::GRID::Grid::GridSelectionModes::GridSelectColumns}.
2011
+ # @param row [Integer]
2012
+ # @param addToSelected [Boolean]
2013
+ # @return [void]
2014
+ def select_row(row, addToSelected=false) end
2015
+
2016
+ # Set the colour to be used for drawing the selection background.
2017
+ # @param c [Wx::Colour,String,Symbol]
2018
+ # @return [void]
2019
+ def set_selection_background(c) end
2020
+ alias_method :selection_background=, :set_selection_background
2021
+
2022
+ # Set the colour to be used for drawing the selection foreground.
2023
+ # @param c [Wx::Colour,String,Symbol]
2024
+ # @return [void]
2025
+ def set_selection_foreground(c) end
2026
+ alias_method :selection_foreground=, :set_selection_foreground
2027
+
2028
+ # Set the selection behaviour of the grid.
2029
+ #
2030
+ # 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).
2031
+ # @param selmode [Wx::Grid::GridSelectionModes]
2032
+ # @return [void]
2033
+ def set_selection_mode(selmode) end
2034
+ alias_method :selection_mode=, :set_selection_mode
2035
+
2036
+ # Return true if overlay selection can be used ({Wx::Setup::USE_GRAPHICS_CONTEXT}=1) and {Wx::GRID::Grid#disable_overlay_selection} hadn't been called, false otherwise.
2037
+ #
2038
+ #
2039
+ # @see Wx::GRID::Grid#disable_overlay_selection
2040
+ # @return [Boolean]
2041
+ def uses_overlay_selection; end
2042
+
2043
+ # Disable overlay selection if it is enabled.
2044
+ #
2045
+ # Starting from wxWidgets 3.3.0, the {Wx::GRID::Grid} selection appearance is changed from using a solid and opaque colour to denote selection to using a semi- transparent area overlaid on the selected cells. Notice that the old behaviour is still supported and can be reverted to by calling this function.
2046
+ # @see Wx::GRID::Grid#uses_overlay_selection
2047
+ # @return [void]
2048
+ def disable_overlay_selection; end
2049
+
2050
+ # Returns the number of pixels per horizontal scroll increment.
2051
+ #
2052
+ # The default is 15.
2053
+ # @see Wx::GRID::Grid#get_scroll_line_y
2054
+ # @see Wx::GRID::Grid#set_scroll_line_x
2055
+ # @see Wx::GRID::Grid#set_scroll_line_y
2056
+ # @return [Integer]
2057
+ def get_scroll_line_x; end
2058
+ alias_method :scroll_line_x, :get_scroll_line_x
2059
+
2060
+ # Returns the number of pixels per vertical scroll increment.
2061
+ #
2062
+ # The default is 15.
2063
+ # @see Wx::GRID::Grid#get_scroll_line_x
2064
+ # @see Wx::GRID::Grid#set_scroll_line_x
2065
+ # @see Wx::GRID::Grid#set_scroll_line_y
2066
+ # @return [Integer]
2067
+ def get_scroll_line_y; end
2068
+ alias_method :scroll_line_y, :get_scroll_line_y
2069
+
2070
+ # Returns true if a cell is either entirely or at least partially visible in the grid window.
2071
+ #
2072
+ # 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.
2073
+ # @param row [Integer]
2074
+ # @param col [Integer]
2075
+ # @param wholeCellVisible [Boolean]
2076
+ # @return [Boolean]
2077
+ def is_visible(row, col, wholeCellVisible=true) end
2078
+ alias_method :visible?, :is_visible
2079
+
2080
+ # Brings the specified cell into the visible grid cell area with minimal scrolling.
2081
+ #
2082
+ # Does nothing if the cell is already visible.
2083
+ # @param row [Integer]
2084
+ # @param col [Integer]
2085
+ # @return [void]
2086
+ def make_cell_visible(row, col) end
2087
+
2088
+ # Returns the topmost row of the current visible area.
2089
+ #
2090
+ # Returns -1 if the grid doesn't have any rows.
2091
+ # @return [Integer]
2092
+ def get_first_fully_visible_row; end
2093
+ alias_method :first_fully_visible_row, :get_first_fully_visible_row
2094
+
2095
+ # Returns the leftmost column of the current visible area.
2096
+ #
2097
+ # Returns -1 if the grid doesn't have any columns.
2098
+ # @return [Integer]
2099
+ def get_first_fully_visible_column; end
2100
+ alias_method :first_fully_visible_column, :get_first_fully_visible_column
2101
+
2102
+ # Sets the number of pixels per horizontal scroll increment.
2103
+ #
2104
+ # The default is 15.
2105
+ # @see Wx::GRID::Grid#get_scroll_line_x
2106
+ # @see Wx::GRID::Grid#get_scroll_line_y
2107
+ # @see Wx::GRID::Grid#set_scroll_line_y
2108
+ # @param x [Integer]
2109
+ # @return [void]
2110
+ def set_scroll_line_x(x) end
2111
+ alias_method :scroll_line_x=, :set_scroll_line_x
2112
+
2113
+ # Sets the number of pixels per vertical scroll increment.
2114
+ #
2115
+ # The default is 15.
2116
+ # @see Wx::GRID::Grid#get_scroll_line_x
2117
+ # @see Wx::GRID::Grid#get_scroll_line_y
2118
+ # @see Wx::GRID::Grid#set_scroll_line_x
2119
+ # @param y [Integer]
2120
+ # @return [void]
2121
+ def set_scroll_line_y(y) end
2122
+ alias_method :scroll_line_y=, :set_scroll_line_y
2123
+
2124
+ # Convert grid cell coordinates to grid window pixel coordinates.
2125
+ #
2126
+ # 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.
2127
+ # @see Wx::GRID::Grid#cell_to_rect
2128
+ # @param topLeft [Array(Integer, Integer)]
2129
+ # @param bottomRight [Array(Integer, Integer)]
2130
+ # @param gridWindow [Wx::GRID::GridWindow]
2131
+ # @return [Wx::Rect]
2132
+ def block_to_device_rect(topLeft, bottomRight, gridWindow=nil) end
2133
+
2134
+ # Return the rectangle corresponding to the grid cell's size and position in logical coordinates.
2135
+ #
2136
+ #
2137
+ # @see Wx::GRID::Grid#block_to_device_rect
2138
+ # @param row [Integer]
2139
+ # @param col [Integer]
2140
+ # @return [Wx::Rect]
2141
+ def cell_to_rect(row, col) end
2142
+
2143
+ # @overload cell_to_grid_window(row, col)
2144
+ # Returns the grid window that contains the cell.
2145
+ #
2146
+ # 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.
2147
+ # @param row [Integer]
2148
+ # @param col [Integer]
2149
+ # @return [Wx::GRID::GridWindow]
2150
+ # @overload cell_to_grid_window(coords)
2151
+ # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
2152
+ # @param coords [Array(Integer, Integer)]
2153
+ # @return [Wx::GRID::GridWindow]
2154
+ def cell_to_grid_window(*args) end
2155
+
2156
+ # @overload device_pos_to_grid_window(pos)
2157
+ # Returns the grid window that includes the input coordinates.
2158
+ # @param pos [Wx::Point]
2159
+ # @return [Wx::GRID::GridWindow]
2160
+ # @overload device_pos_to_grid_window(x, y)
2161
+ # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
2162
+ # @param x [Integer]
2163
+ # @param y [Integer]
2164
+ # @return [Wx::GRID::GridWindow]
2165
+ def device_pos_to_grid_window(*args) end
2166
+
2167
+ # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
2168
+ # @param gridWindow [Wx::GRID::GridWindow]
2169
+ # @return [Wx::Point]
2170
+ def get_grid_window_offset(gridWindow) end
2171
+ alias_method :grid_window_offset, :get_grid_window_offset
2172
+
2173
+ # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
2174
+ # @param pt [Array(Integer, Integer), Wx::Point]
2175
+ # @param gridWindow [Wx::GRID::GridWindow]
2176
+ # @return [Wx::Point]
2177
+ def calc_grid_window_unscrolled_position(pt, gridWindow) end
2178
+
2179
+ # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
2180
+ # @param pt [Array(Integer, Integer), Wx::Point]
2181
+ # @param gridWindow [Wx::GRID::GridWindow]
2182
+ # @return [Wx::Point]
2183
+ def calc_grid_window_scrolled_position(pt, gridWindow) end
2184
+
2185
+ # Returns the column at the given pixel position depending on the window.
2186
+ #
2187
+ # The column index or {Wx::NOT_FOUND}.
2188
+ # @param x [Integer] The x position to evaluate.
2189
+ # @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.
2190
+ # @param gridWindow [Wx::GRID::GridWindow] The associated grid window that limits the search (note that this parameter is only available since wxWidgets 3.1.3). If gridWindow is nil, it will consider all the cells, no matter which grid they belong to.
2191
+ # @return [Integer]
2192
+ def x_to_col(x, clipToMinMax=false, gridWindow=nil) end
2193
+
2194
+ # Returns the column whose right hand edge is close to the given logical x position.
2195
+ #
2196
+ # If no column edge is near to this position {Wx::NOT_FOUND} is returned.
2197
+ # @param x [Integer]
2198
+ # @return [Integer]
2199
+ def x_to_edge_of_col(x) end
2200
+
2201
+ # @overload xy_to_cell(x, y, gridWindow=nil)
2202
+ # Translates logical pixel coordinates to the grid cell coordinates.
2203
+ #
2204
+ # 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.
2205
+ # 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.
2206
+ # If gridWindow is nil, coordinates are relative to the main grid window and all cells are considered.
2207
+ # @see Wx::GRID::Grid#x_to_col
2208
+ # @see Wx::GRID::Grid#y_to_row
2209
+ # @param x [Integer]
2210
+ # @param y [Integer]
2211
+ # @param gridWindow [Wx::GRID::GridWindow]
2212
+ # @return [Array(Integer, Integer)]
2213
+ # @overload xy_to_cell(pos, gridWindow=nil)
2214
+ # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
2215
+ # @param pos [Array(Integer, Integer), Wx::Point]
2216
+ # @param gridWindow [Wx::GRID::GridWindow]
2217
+ # @return [Array(Integer, Integer)]
2218
+ def xy_to_cell(*args) end
2219
+
2220
+ # Returns the row whose bottom edge is close to the given logical y position.
2221
+ #
2222
+ # If no row edge is near to this position {Wx::NOT_FOUND} is returned.
2223
+ # @param y [Integer]
2224
+ # @return [Integer]
2225
+ def y_to_edge_of_row(y) end
2226
+
2227
+ # Returns the grid row that corresponds to the logical y coordinate.
2228
+ #
2229
+ # 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.
2230
+ # If gridWindow is nil, the function returns {Wx::NOT_FOUND} only if there is no row at all at the y position.
2231
+ # @param y [Integer]
2232
+ # @param clipToMinMax [Boolean]
2233
+ # @param gridWindow [Wx::GRID::GridWindow]
2234
+ # @return [Integer]
2235
+ def y_to_row(y, clipToMinMax=false, gridWindow=nil) end
2236
+
2237
+ # Appends one or more new columns to the right of the grid.
2238
+ #
2239
+ # 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.
2240
+ # true on success or false if appending columns failed.
2241
+ # @param numCols [Integer]
2242
+ # @param updateLabels [Boolean]
2243
+ # @return [Boolean]
2244
+ def append_cols(numCols=1, updateLabels=true) end
2245
+
2246
+ # Appends one or more new rows to the bottom of the grid.
2247
+ #
2248
+ # 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.
2249
+ # true on success or false if appending rows failed.
2250
+ # @param numRows [Integer]
2251
+ # @param updateLabels [Boolean]
2252
+ # @return [Boolean]
2253
+ def append_rows(numRows=1, updateLabels=true) end
2254
+
2255
+ # Return true if the horizontal grid lines stop at the last column boundary or false if they continue to the end of the window.
2256
+ #
2257
+ # The default is to clip grid lines.
2258
+ # @see Wx::GRID::Grid#clip_horz_grid_lines
2259
+ # @see Wx::GRID::Grid#are_vert_grid_lines_clipped
2260
+ # @return [Boolean]
2261
+ def are_horz_grid_lines_clipped; end
2262
+
2263
+ # Return true if the vertical grid lines stop at the last row boundary or false if they continue to the end of the window.
2264
+ #
2265
+ # The default is to clip grid lines.
2266
+ # @see Wx::GRID::Grid#clip_vert_grid_lines
2267
+ # @see Wx::GRID::Grid#are_horz_grid_lines_clipped
2268
+ # @return [Boolean]
2269
+ def are_vert_grid_lines_clipped; end
2270
+
2271
+ # Increments the grid's batch count.
2272
+ #
2273
+ # 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.
2274
+ # 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.
2275
+ # @return [void]
2276
+ def begin_batch; end
2277
+
2278
+ # Clears all data in the underlying grid table and repaints the grid.
2279
+ #
2280
+ # 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.
2281
+ # @return [void]
2282
+ def clear_grid; end
2283
+
2284
+ # Change whether the horizontal grid lines are clipped by the end of the last column.
2285
+ #
2286
+ # 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.
2287
+ # @see Wx::GRID::Grid#are_horz_grid_lines_clipped
2288
+ # @see Wx::GRID::Grid#clip_vert_grid_lines
2289
+ # @param clip [Boolean]
2290
+ # @return [void]
2291
+ def clip_horz_grid_lines(clip) end
2292
+
2293
+ # Change whether the vertical grid lines are clipped by the end of the last row.
2294
+ #
2295
+ # 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.
2296
+ # @see Wx::GRID::Grid#are_vert_grid_lines_clipped
2297
+ # @see Wx::GRID::Grid#clip_horz_grid_lines
2298
+ # @param clip [Boolean]
2299
+ # @return [void]
2300
+ def clip_vert_grid_lines(clip) end
2301
+
2302
+ # Deletes one or more columns from a grid starting at the specified position.
2303
+ #
2304
+ # 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.
2305
+ # true on success or false if deleting columns failed.
2306
+ # @param pos [Integer]
2307
+ # @param numCols [Integer]
2308
+ # @param updateLabels [Boolean]
2309
+ # @return [Boolean]
2310
+ def delete_cols(pos=0, numCols=1, updateLabels=true) end
2311
+
2312
+ # Deletes one or more rows from a grid starting at the specified position.
2313
+ #
2314
+ # 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.
2315
+ # true on success or false if deleting rows failed.
2316
+ # @param pos [Integer]
2317
+ # @param numRows [Integer]
2318
+ # @param updateLabels [Boolean]
2319
+ # @return [Boolean]
2320
+ def delete_rows(pos=0, numRows=1, updateLabels=true) end
2321
+
2322
+ # @overload freeze_to(row, col)
2323
+ # Sets or resets the frozen columns and rows.
2324
+ #
2325
+ # true on success or false if it failed.
2326
+ #
2327
+ # Note that this method doesn't do anything, and returns false, if any of the following conditions are true:
2328
+ #
2329
+ # - There are any merged cells in the area to be frozen
2330
+ # - Grid uses a native header control (see {Wx::GRID::Grid#use_native_col_header})
2331
+ #
2332
+ # (some of these limitations could be lifted in the future).
2333
+ # Additionally, the function also returns false if either row or col are out of range, i.e. negative or strictly greater than the total number of grid rows or columns and also generates an assert failure in this case, as this indicates a programming error and not a limitation of the current implementation, unlike the conditions above.
2334
+ # @param row [Integer] The number of rows to freeze, 0 means to unfreeze all rows.
2335
+ # @param col [Integer] The number of columns to freeze, 0 means to unfreeze all columns.
2336
+ # @return [Boolean]
2337
+ # @overload freeze_to(coords)
2338
+ # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
2339
+ # @param coords [Array(Integer, Integer)]
2340
+ # @return [Boolean]
2341
+ def freeze_to(*args) end
2342
+
2343
+ # Decrements the grid's batch count.
2344
+ #
2345
+ # 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.
2346
+ # @see Wx::GridUpdateLocker
2347
+ # @return [void]
2348
+ def end_batch; end
2349
+
2350
+ # Overridden {Wx::Window} method.
2351
+ # @return [void]
2352
+ def fit; end
2353
+
2354
+ # Causes immediate repainting of the grid.
2355
+ #
2356
+ # Use this instead of the usual {Wx::Window#refresh}.
2357
+ # @return [void]
2358
+ def force_refresh; end
2359
+
2360
+ # Returns the number of times that {Wx::GRID::Grid#begin_batch} has been called without (yet) matching calls to {Wx::GRID::Grid#end_batch}.
2361
+ #
2362
+ # While the grid's batch count is greater than zero the display will not be updated.
2363
+ # @return [Integer]
2364
+ def get_batch_count; end
2365
+ alias_method :batch_count, :get_batch_count
2366
+
2367
+ # Returns the total number of grid columns.
2368
+ #
2369
+ # This is the same as the number of columns in the underlying grid table.
2370
+ # @return [Integer]
2371
+ def get_number_cols; end
2372
+ alias_method :number_cols, :get_number_cols
2373
+
2374
+ # Returns the total number of grid rows.
2375
+ #
2376
+ # This is the same as the number of rows in the underlying grid table.
2377
+ # @return [Integer]
2378
+ def get_number_rows; end
2379
+ alias_method :number_rows, :get_number_rows
2380
+
2381
+ # Returns the number of frozen grid columns.
2382
+ #
2383
+ # If there are no frozen columns, returns 0.
2384
+ # @see Wx::GRID::Grid#freeze_to
2385
+ # @return [Integer]
2386
+ def get_number_frozen_cols; end
2387
+ alias_method :number_frozen_cols, :get_number_frozen_cols
2388
+
2389
+ # Returns the number of frozen grid rows.
2390
+ #
2391
+ # If there are no frozen rows, returns 0.
2392
+ # @see Wx::GRID::Grid#freeze_to
2393
+ # @return [Integer]
2394
+ def get_number_frozen_rows; end
2395
+ alias_method :number_frozen_rows, :get_number_frozen_rows
2396
+
2397
+ # Returns the attribute for the given cell creating one if necessary.
2398
+ #
2399
+ # 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.
2400
+ # Prefer to use {Wx::GRID::Grid#get_or_create_cell_attr_ptr} to avoid the need to call DecRef() on the returned pointer.
2401
+ # This function may only be called if {Wx::GRID::Grid#can_have_attributes} returns true.
2402
+ # @param row [Integer]
2403
+ # @param col [Integer]
2404
+ # @return [Wx::GRID::GridCellAttr]
2405
+ def get_or_create_cell_attr(row, col) end
2406
+ alias_method :or_create_cell_attr, :get_or_create_cell_attr
2407
+
2408
+ # Returns a base pointer to the current table object.
2409
+ #
2410
+ # The returned pointer is still owned by the grid.
2411
+ # @return [Wx::GRID::GridTableBase]
2412
+ def get_table; end
2413
+ alias_method :table, :get_table
2414
+
2415
+ # Inserts one or more new columns into a grid with the first new column at the specified position.
2416
+ #
2417
+ # 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.
2418
+ #
2419
+ # true if the columns were successfully inserted, false if an error occurred (most likely the table couldn't be updated).
2420
+ # @param pos [Integer] The position which the first newly inserted column will have.
2421
+ # @param numCols [Integer] The number of columns to insert.
2422
+ # @param updateLabels [Boolean] Currently not used.
2423
+ # @return [Boolean]
2424
+ def insert_cols(pos=0, numCols=1, updateLabels=true) end
2425
+
2426
+ # Inserts one or more new rows into a grid with the first new row at the specified position.
2427
+ #
2428
+ # 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.
2429
+ #
2430
+ # true if the rows were successfully inserted, false if an error occurred (most likely the table couldn't be updated).
2431
+ # @param pos [Integer] The position which the first newly inserted row will have.
2432
+ # @param numRows [Integer] The number of rows to insert.
2433
+ # @param updateLabels [Boolean] Currently not used.
2434
+ # @return [Boolean]
2435
+ def insert_rows(pos=0, numRows=1, updateLabels=true) end
2436
+
2437
+ # Invalidates the cached attribute for the given cell.
2438
+ #
2439
+ # 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.
2440
+ # @param row [Integer] The row of the cell whose attribute needs to be queried again.
2441
+ # @param col [Integer] The column of the cell whose attribute needs to be queried again.
2442
+ # @return [void]
2443
+ def refresh_attr(row, col) end
2444
+
2445
+ # @overload refresh_block(topLeft, bottomRight)
2446
+ # Redraw all the cells in the given block.
2447
+ #
2448
+ # Refresh the block of cells with the given corners.
2449
+ # 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.
2450
+ # @param topLeft [Array(Integer, Integer)]
2451
+ # @param bottomRight [Array(Integer, Integer)]
2452
+ # @return [void]
2453
+ # @overload refresh_block(topRow, leftCol, bottomRow, rightCol)
2454
+ # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
2455
+ # @param topRow [Integer]
2456
+ # @param leftCol [Integer]
2457
+ # @param bottomRow [Integer]
2458
+ # @param rightCol [Integer]
2459
+ # @return [void]
2460
+ def refresh_block(*args) end
2461
+
2462
+ # Draws part or all of a {Wx::GRID::Grid} on a {Wx::DC} for printing or display.
2463
+ #
2464
+ # Pagination can be accomplished by using sequential {Wx::GRID::Grid#render} calls with appropriate values in {Wx::GridCellCoords} topLeft and bottomRight.
2465
+ # @param dc [Wx::DC] The {Wx::DC} to be drawn on.
2466
+ # @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().
2467
+ # @param size [Array(Integer, Integer), Wx::Size] The size of the area on the {Wx::DC} that the rendered {Wx::GRID::Grid} should occupy. If not specified the drawing will be scaled to fit the available dc width or height. The {Wx::GRID::Grid}'s aspect ratio is maintained whether or not size is specified.
2468
+ # @param topLeft [Array(Integer, Integer)] The top left cell of the block to be drawn. Defaults to ( 0, 0 ).
2469
+ # @param bottomRight [Array(Integer, Integer)] The bottom right cell of the block to be drawn. Defaults to row and column counts.
2470
+ # @param style [Integer] A combination of values from {Wx::GRID::GridRenderStyle}.
2471
+ # @return [void]
2472
+ 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
2473
+
2474
+ # Sets the cell attributes for the specified cell.
2475
+ #
2476
+ # The grid takes ownership of the attribute pointer.
2477
+ # See the {Wx::GRID::GridCellAttr} class for more information about controlling cell attributes.
2478
+ # @param row [Integer]
2479
+ # @param col [Integer]
2480
+ # @param attr [Wx::GRID::GridCellAttr]
2481
+ # @return [void]
2482
+ def set_attr(row, col, attr) end
2483
+
2484
+ # Sets the cell attributes for all cells in the specified column.
2485
+ #
2486
+ # For more information about controlling grid cell attributes see the {Wx::GRID::GridCellAttr} cell attribute class and the wxGrid Overview.
2487
+ # @param col [Integer]
2488
+ # @param attr [Wx::GRID::GridCellAttr]
2489
+ # @return [void]
2490
+ def set_col_attr(col, attr) end
2491
+
2492
+ # Sets the extra margins used around the grid area.
2493
+ #
2494
+ # A grid may occupy more space than needed for its data display and this function allows setting how big this extra space is
2495
+ # @param extraWidth [Integer]
2496
+ # @param extraHeight [Integer]
2497
+ # @return [void]
2498
+ def set_margins(extraWidth, extraHeight) end
2499
+
2500
+ # Sets the cell attributes for all cells in the specified row.
2501
+ #
2502
+ # The grid takes ownership of the attribute pointer.
2503
+ # See the {Wx::GRID::GridCellAttr} class for more information about controlling cell attributes.
2504
+ # @param row [Integer]
2505
+ # @param attr [Wx::GRID::GridCellAttr]
2506
+ # @return [void]
2507
+ def set_row_attr(row, attr) end
2508
+
2509
+ # Returns an array of row labels within the given region.
2510
+ # @param reg [Wx::Region]
2511
+ # @param gridWindow [Wx::GRID::GridWindow]
2512
+ # @return [Array<Integer>]
2513
+ def calc_row_labels_exposed(reg, gridWindow=nil) end
2514
+
2515
+ # Returns an array of column labels within the given region.
2516
+ # @param reg [Wx::Region]
2517
+ # @param gridWindow [Wx::GRID::GridWindow]
2518
+ # @return [Array<Integer>]
2519
+ def calc_col_labels_exposed(reg, gridWindow=nil) end
2520
+
2521
+ # Returns an array of (visible) cells within the given region.
2522
+ # @param reg [Wx::Region]
2523
+ # @param gridWindow [Wx::GRID::GridWindow]
2524
+ # @return [Array<Array(Integer, Integer)>]
2525
+ def calc_cells_exposed(reg, gridWindow=nil) end
2526
+
2527
+ # Return the column in which the sorting indicator is currently displayed.
2528
+ #
2529
+ # Returns {Wx::NOT_FOUND} if sorting indicator is not currently displayed at all.
2530
+ # @see Wx::GRID::Grid#set_sorting_column
2531
+ # @return [Integer]
2532
+ def get_sorting_column; end
2533
+ alias_method :sorting_column, :get_sorting_column
2534
+
2535
+ # Return true if this column is currently used for sorting.
2536
+ #
2537
+ #
2538
+ # @see Wx::GRID::Grid#get_sorting_column
2539
+ # @param col [Integer]
2540
+ # @return [Boolean]
2541
+ def is_sorting_by(col) end
2542
+ alias_method :sorting_by?, :is_sorting_by
2543
+
2544
+ # Return true if the current sorting order is ascending or false if it is descending.
2545
+ #
2546
+ # 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}.
2547
+ # @see Wx::GRID::Grid#set_sorting_column
2548
+ # @return [Boolean]
2549
+ def is_sort_order_ascending; end
2550
+ alias_method :sort_order_ascending?, :is_sort_order_ascending
2551
+
2552
+ # Set the column to display the sorting indicator in and its direction.
2553
+ #
2554
+ #
2555
+ # @see Wx::GRID::Grid#get_sorting_column
2556
+ # @see Wx::GRID::Grid#is_sort_order_ascending
2557
+ # @param col [Integer] The column to display the sorting indicator in or {Wx::NOT_FOUND} to remove any currently displayed sorting indicator.
2558
+ # @param ascending [Boolean] If true, display the ascending sort indicator, otherwise display the descending sort indicator.
2559
+ # @return [void]
2560
+ def set_sorting_column(col, ascending=true) end
2561
+ alias_method :sorting_column=, :set_sorting_column
2562
+
2563
+ # Remove any currently shown sorting indicator.
2564
+ #
2565
+ # This is equivalent to calling {Wx::GRID::Grid#set_sorting_column} with {Wx::NOT_FOUND} first argument.
2566
+ # @return [void]
2567
+ def unset_sorting_column; end
2568
+
2569
+ # Return the main grid window containing the grid cells.
2570
+ #
2571
+ # This window is always shown.
2572
+ # @return [Wx::Window]
2573
+ def get_grid_window; end
2574
+ alias_method :grid_window, :get_grid_window
2575
+
2576
+ # Return the corner grid window containing frozen cells.
2577
+ #
2578
+ # This window is shown only when there are frozen rows and columns.
2579
+ # @return [Wx::Window]
2580
+ def get_frozen_corner_grid_window; end
2581
+ alias_method :frozen_corner_grid_window, :get_frozen_corner_grid_window
2582
+
2583
+ # Return the rows grid window containing row frozen cells.
2584
+ #
2585
+ # This window is shown only when there are frozen rows.
2586
+ # @return [Wx::Window]
2587
+ def get_frozen_row_grid_window; end
2588
+ alias_method :frozen_row_grid_window, :get_frozen_row_grid_window
2589
+
2590
+ # Return the columns grid window containing column frozen cells.
2591
+ #
2592
+ # This window is shown only when there are frozen columns.
2593
+ # @return [Wx::Window]
2594
+ def get_frozen_col_grid_window; end
2595
+ alias_method :frozen_col_grid_window, :get_frozen_col_grid_window
2596
+
2597
+ # Return the row labels window.
2598
+ #
2599
+ # This window is not shown if the row labels were hidden using {Wx::GRID::Grid#hide_row_labels}.
2600
+ # @return [Wx::Window]
2601
+ def get_grid_row_label_window; end
2602
+ alias_method :grid_row_label_window, :get_grid_row_label_window
2603
+
2604
+ # Return the column labels window.
2605
+ #
2606
+ # This window is not shown if the columns labels were hidden using {Wx::GRID::Grid#hide_col_labels}.
2607
+ # 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.
2608
+ # @return [Wx::Window]
2609
+ def get_grid_col_label_window; end
2610
+ alias_method :grid_col_label_window, :get_grid_col_label_window
2611
+
2612
+ # Return the window in the top left grid corner.
2613
+ #
2614
+ # 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.
2615
+ # @return [Wx::Window]
2616
+ def get_grid_corner_label_window; end
2617
+ alias_method :grid_corner_label_window, :get_grid_corner_label_window
2618
+
2619
+ # Return the header control used for column labels display.
2620
+ #
2621
+ # This function can only be called if {Wx::GRID::Grid#use_native_col_header} had been called.
2622
+ # @see Wx::GRID::Grid#is_using_native_header
2623
+ # @return [Wx::HeaderCtrl]
2624
+ def get_grid_col_header; end
2625
+ alias_method :grid_col_header, :get_grid_col_header
2626
+
2627
+ # Return true if native header control is currently being used.
2628
+ # @return [Boolean]
2629
+ def is_using_native_header; end
2630
+ alias_method :using_native_header?, :is_using_native_header
2631
+
2632
+ # @param dc [Wx::DC]
2633
+ # @param attr [Wx::GRID::GridCellAttr]
2634
+ # @return [void]
2635
+ def draw_cell_highlight(dc, attr) end
2636
+
2637
+ # @param dc [Wx::DC]
2638
+ # @param rows [Array<Integer>]
2639
+ # @return [void]
2640
+ def draw_row_labels(dc, rows) end
2641
+
2642
+ # @param dc [Wx::DC]
2643
+ # @param row [Integer]
2644
+ # @return [void]
2645
+ def draw_row_label(dc, row) end
2646
+
2647
+ # @param dc [Wx::DC]
2648
+ # @param cols [Array<Integer>]
2649
+ # @return [void]
2650
+ def draw_col_labels(dc, cols) end
2651
+
2652
+ # @param dc [Wx::DC]
2653
+ # @param col [Integer]
2654
+ # @return [void]
2655
+ def draw_col_label(dc, col) end
2656
+
2657
+ # @param dc [Wx::DC]
2658
+ # @return [void]
2659
+ def draw_corner_label(dc) end
2660
+
2661
+ # @overload draw_text_rectangle(dc, text, rect, horizontalAlignment=Wx::Alignment::ALIGN_LEFT, verticalAlignment=Wx::Alignment::ALIGN_TOP, textOrientation=Wx::Orientation::HORIZONTAL)
2662
+ # Draw the given text inside the specified rectangle.
2663
+ #
2664
+ # The overload taking a single string splits it into an array of lines (possibly consisting of just a single element if the string doesn't contain any new line characters).
2665
+ # The alignment parameters may be {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_RIGHT} and either {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_CENTER_HORIZONTAL} for horizontal alignment and {Wx::Alignment::ALIGN_TOP}, {Wx::Alignment::ALIGN_BOTTOM} and either {Wx::Alignment::ALIGN_CENTRE} or {Wx::Alignment::ALIGN_CENTER_VERTICAL} for vertical one.
2666
+ # For the overload taking default alignment parameters, they are used only if the provided {Wx::GRID::GridCellAttr} doesn't specify any alignment in the corresponding direction.
2667
+ # @param dc [Wx::DC]
2668
+ # @param text [String]
2669
+ # @param rect [Wx::Rect]
2670
+ # @param horizontalAlignment [Integer]
2671
+ # @param verticalAlignment [Integer]
2672
+ # @param textOrientation [Integer]
2673
+ # @return [void]
2674
+ # @overload draw_text_rectangle(dc, lines, rect, horizontalAlignment=Wx::Alignment::ALIGN_LEFT, verticalAlignment=Wx::Alignment::ALIGN_TOP, textOrientation=Wx::Orientation::HORIZONTAL)
2675
+ # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
2676
+ # @param dc [Wx::DC]
2677
+ # @param lines [Array<String>]
2678
+ # @param rect [Wx::Rect]
2679
+ # @param horizontalAlignment [Integer]
2680
+ # @param verticalAlignment [Integer]
2681
+ # @param textOrientation [Integer]
2682
+ # @return [void]
2683
+ # @overload draw_text_rectangle(dc, text, rect, attr, defaultHAlign=Wx::Alignment::ALIGN_INVALID, defaultVAlign=Wx::Alignment::ALIGN_INVALID)
2684
+ # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
2685
+ # @param dc [Wx::DC]
2686
+ # @param text [String]
2687
+ # @param rect [Wx::Rect]
2688
+ # @param attr [Wx::GRID::GridCellAttr]
2689
+ # @param defaultHAlign [Integer]
2690
+ # @param defaultVAlign [Integer]
2691
+ # @return [void]
2692
+ def draw_text_rectangle(*args) end
2693
+
2694
+ # @return [Wx::Colour]
2695
+ def get_cell_highlight_colour; end
2696
+ alias_method :cell_highlight_colour, :get_cell_highlight_colour
2697
+
2698
+ # @return [Integer]
2699
+ def get_cell_highlight_pen_width; end
2700
+ alias_method :cell_highlight_pen_width, :get_cell_highlight_pen_width
2701
+
2702
+ # @return [Integer]
2703
+ def get_cell_highlight_ro_pen_width; end
2704
+ alias_method :cell_highlight_ro_pen_width, :get_cell_highlight_ro_pen_width
2705
+
2706
+ # @param arg [Wx::Colour,String,Symbol]
2707
+ # @return [void]
2708
+ def set_cell_highlight_colour(arg) end
2709
+ alias_method :cell_highlight_colour=, :set_cell_highlight_colour
2710
+
2711
+ # @param width [Integer]
2712
+ # @return [void]
2713
+ def set_cell_highlight_pen_width(width) end
2714
+ alias_method :cell_highlight_pen_width=, :set_cell_highlight_pen_width
2715
+
2716
+ # @param width [Integer]
2717
+ # @return [void]
2718
+ def set_cell_highlight_ro_pen_width(width) end
2719
+ alias_method :cell_highlight_ro_pen_width=, :set_cell_highlight_ro_pen_width
2720
+
2721
+ # @param arg [Wx::Colour,String,Symbol]
2722
+ # @return [void]
2723
+ def set_grid_frozen_border_colour(arg) end
2724
+ alias_method :grid_frozen_border_colour=, :set_grid_frozen_border_colour
2725
+
2726
+ # @param width [Integer]
2727
+ # @return [void]
2728
+ def set_grid_frozen_border_pen_width(width) end
2729
+ alias_method :grid_frozen_border_pen_width=, :set_grid_frozen_border_pen_width
2730
+
2731
+ end # Grid
2732
+
2733
+ # Represents coordinates of a block of cells in the grid.
2734
+ #
2735
+ # An object of this class contains coordinates of the left top and the bottom right corners of a block.
2736
+ #
2737
+ #
2738
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2739
+ # @wxrb_require USE_GRID
2740
+ class GridBlockCoords < ::Object
2741
+
2742
+ # @overload initialize()
2743
+ # Default constructor initializes the object to invalid state.
2744
+ #
2745
+ # Initially the coordinates are invalid (-1) and so {Wx::GRID::GridBlockCoords#!()} for an uninitialized {Wx::GRID::GridBlockCoords} returns true.
2746
+ # @return [Wx::GRID::GridBlockCoords]
2747
+ # @overload initialize(topRow, leftCol, bottomRow, rightCol)
2748
+ # Constructor taking a coordinates of the left top and the bottom right corners.
2749
+ # @param topRow [Integer]
2750
+ # @param leftCol [Integer]
2751
+ # @param bottomRow [Integer]
2752
+ # @param rightCol [Integer]
2753
+ # @return [Wx::GRID::GridBlockCoords]
2754
+ def initialize(*args) end
2755
+
2756
+ # Return the row of the left top corner.
2757
+ # @return [Integer]
2758
+ def get_top_row; end
2759
+ alias_method :top_row, :get_top_row
2760
+
2761
+ # Set the row of the left top corner.
2762
+ # @param row [Integer]
2763
+ # @return [void]
2764
+ def set_top_row(row) end
2765
+ alias_method :top_row=, :set_top_row
2766
+
2767
+ # Return the column of the left top corner.
2768
+ # @return [Integer]
2769
+ def get_left_col; end
2770
+ alias_method :left_col, :get_left_col
2771
+
2772
+ # Set the column of the left top corner.
2773
+ # @param col [Integer]
2774
+ # @return [void]
2775
+ def set_left_col(col) end
2776
+ alias_method :left_col=, :set_left_col
2777
+
2778
+ # Return the row of the bottom right corner.
2779
+ # @return [Integer]
2780
+ def get_bottom_row; end
2781
+ alias_method :bottom_row, :get_bottom_row
2782
+
2783
+ # Set the row of the bottom right corner.
2784
+ # @param row [Integer]
2785
+ # @return [void]
2786
+ def set_bottom_row(row) end
2787
+ alias_method :bottom_row=, :set_bottom_row
2788
+
2789
+ # Return the column of the bottom right corner.
2790
+ # @return [Integer]
2791
+ def get_right_col; end
2792
+ alias_method :right_col, :get_right_col
2793
+
2794
+ # Set the column of the bottom right corner.
2795
+ # @param col [Integer]
2796
+ # @return [void]
2797
+ def set_right_col(col) end
2798
+ alias_method :right_col=, :set_right_col
2799
+
2800
+ # Return the coordinates of the top left corner.
2801
+ # @return [Array(Integer, Integer)]
2802
+ def get_top_left; end
2803
+ alias_method :top_left, :get_top_left
2804
+
2805
+ # Return the coordinates of the bottom right corner.
2806
+ # @return [Array(Integer, Integer)]
2807
+ def get_bottom_right; end
2808
+ alias_method :bottom_right, :get_bottom_right
2809
+
2810
+ # Return the canonicalized block where top left coordinates is less than bottom right coordinates.
2811
+ # @return [Wx::GRID::GridBlockCoords]
2812
+ def canonicalize; end
2813
+
2814
+ # Whether the blocks intersect.
2815
+ #
2816
+ # true, if the block intersects with the other, false, otherwise.
2817
+ # @param other [Wx::GRID::GridBlockCoords]
2818
+ # @return [Boolean]
2819
+ def intersects(other) end
2820
+
2821
+ # @overload contains(cell)
2822
+ # Check whether this block contains the given cell.
2823
+ #
2824
+ # true, if the block contains the cell, false otherwise.
2825
+ # @param cell [Array(Integer, Integer)]
2826
+ # @return [Boolean]
2827
+ # @overload contains(other)
2828
+ # Check whether this block contains another one.
2829
+ #
2830
+ # true if other is entirely contained within this block.
2831
+ # @param other [Wx::GRID::GridBlockCoords]
2832
+ # @return [Boolean]
2833
+ def contains(*args) end
2834
+
2835
+ # Calculates the result blocks by subtracting the other block from this block.
2836
+ #
2837
+ # Up to 4 blocks. If block doesn't exist in the result, it has value of {Wx::GridNoBlockCoords}.
2838
+ # @param other [Wx::GRID::GridBlockCoords] The block to subtract from this block.
2839
+ # @param splitOrientation [Integer] The block splitting orientation (either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}).
2840
+ # @return [Wx::GRID::GridBlockDiffResult]
2841
+ def difference(other, splitOrientation) end
2842
+
2843
+ # Calculates the symmetric difference of the blocks.
2844
+ #
2845
+ # Up to 4 blocks. If block doesn't exist in the result, it has value of {Wx::GridNoBlockCoords}.
2846
+ # @param other [Wx::GRID::GridBlockCoords] The block to subtract from this block.
2847
+ # @return [Wx::GRID::GridBlockDiffResult]
2848
+ def sym_difference(other) end
2849
+
2850
+ # Equality operator.
2851
+ # @param other [Wx::GRID::GridBlockCoords]
2852
+ # @return [Boolean]
2853
+ def ==(other) end
2854
+
2855
+ end # GridBlockCoords
2856
+
2857
+ # The helper struct uses as a result type for difference functions of {Wx::GRID::GridBlockCoords} class.
2858
+ #
2859
+ # Parts can be uninitialized (equals to {Wx::GridNoBlockCoords}), that means that the corresponding part doesn't exists in the result.
2860
+ #
2861
+ #
2862
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2863
+ # @wxrb_require USE_GRID
2864
+ class GridBlockDiffResult < ::Object
2865
+
2866
+ end # GridBlockDiffResult
2867
+
2868
+ # {Wx::GRID::GridSizesInfo} stores information about sizes of all {Wx::GRID::Grid} rows or columns.
2869
+ #
2870
+ # 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.
2871
+ # This structure is particularly useful for serializing the sizes of all {Wx::GRID::Grid} elements at once.
2872
+ #
2873
+ # Category: Grid Related Classes
2874
+ #
2875
+ #
2876
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2877
+ # @wxrb_require USE_GRID
2878
+ class GridSizesInfo < ::Object
2879
+
2880
+ # Default size.
2881
+ #
2882
+ #
2883
+ # @return [Integer]
2884
+ def size_default; end
2885
+ # Default size.
2886
+ #
2887
+ #
2888
+ # @param val [Integer]
2889
+ # @return [void]
2890
+ def size_default=(val); end
2891
+
2892
+ # Map with element indices as keys and their sizes as values.
2893
+ # This map only contains the elements with non-default size.
2894
+ #
2895
+ # @return [Hash]
2896
+ def custom_sizes; end
2897
+ # Map with element indices as keys and their sizes as values.
2898
+ # This map only contains the elements with non-default size.
2899
+ #
2900
+ # @param val [Hash]
2901
+ # @return [void]
2902
+ def custom_sizes=(val); end
2903
+
2904
+ # @overload initialize()
2905
+ # Default constructor.
2906
+ #
2907
+ # m_sizeDefault and m_customSizes must be initialized later.
2908
+ # @return [Wx::GRID::GridSizesInfo]
2909
+ # @overload initialize(defSize, allSizes)
2910
+ # Constructor.
2911
+ #
2912
+ # This constructor is used by {Wx::GRID::Grid#get_row_sizes} and GetColSizes() methods. User code will usually use the default constructor instead.
2913
+ # @param defSize [Integer] The default element size.
2914
+ # @param allSizes [Array<Integer>] Array containing the sizes of all elements, including those which have the default size.
2915
+ # @return [Wx::GRID::GridSizesInfo]
2916
+ def initialize(*args) end
2917
+
2918
+ # Get the element size.
2919
+ #
2920
+ # The size for this element, using m_customSizes if pos is in it or m_sizeDefault otherwise.
2921
+ # @param pos [unsigned] The index of the element.
2922
+ # @return [Integer]
2923
+ def get_size(pos) end
2924
+ alias_method :size, :get_size
2925
+
2926
+ end # GridSizesInfo
2927
+
2928
+ # Allows to specify the behaviour when the cell contents doesn't fit into its allotted space.
2929
+ #
2930
+ # 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:
2931
+ #
2932
+ # - 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.
2933
+ # - Clip the cell contents, discarding the part which doesn't fit.
2934
+ # - Ellipsize the cell contents, i.e. replace the non-fitting part with ellipsis (<code></code>...), putting the ellipsis at the end by default, but possibly at the beginning or in the middle.
2935
+ #
2936
+ # The default behaviour is to overflow, use {Wx::GRID::Grid#set_default_cell_fit_mode} to change this, for example:
2937
+ # ```ruby
2938
+ # grid.set_default_cell_fit_mode(Wx::GRID::GridFitMode.clip)
2939
+ # ```
2940
+ #
2941
+ # Objects of this class are created using static functions instead of constructors for better readability and can't be changed after creating them except by using the assignment operator.
2942
+ #
2943
+ # Category: Grid Related Classes
2944
+ #
2945
+ #
2946
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2947
+ # @wxrb_require USE_GRID
2948
+ class GridFitMode < ::Object
2949
+
2950
+ # Default constructor creates an object not specifying any behaviour.
2951
+ #
2952
+ # 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.
2953
+ # @return [Wx::GRID::GridFitMode]
2954
+ def initialize; end
2955
+
2956
+ # Return true if the object specifies some particular behaviour.
2957
+ #
2958
+ # This method returns false for default-constructed objects of this type only.
2959
+ # @return [Boolean]
2960
+ def is_specified; end
2961
+ alias_method :specified?, :is_specified
2962
+
2963
+ # Return true if the object specifies clipping behaviour.
2964
+ #
2965
+ # This method returns true only for the objects returned by {Wx::GRID::GridFitMode.clip}.
2966
+ # @return [Boolean]
2967
+ def is_clip; end
2968
+ alias_method :clip?, :is_clip
2969
+
2970
+ # Return true if the object specifies overflow behaviour.
2971
+ #
2972
+ # This method returns true only for the objects returned by {Wx::GRID::GridFitMode.overflow}.
2973
+ # @return [Boolean]
2974
+ def is_overflow; end
2975
+ alias_method :overflow?, :is_overflow
2976
+
2977
+ # Return ellipsize mode, possibly {Wx::EllipsizeMode::ELLIPSIZE_NONE}.
2978
+ #
2979
+ # 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.
2980
+ # @return [Wx::EllipsizeMode]
2981
+ def get_ellipsize_mode; end
2982
+ alias_method :ellipsize_mode, :get_ellipsize_mode
2983
+
2984
+ # Pseudo-constructor for object specifying clipping behaviour.
2985
+ # @return [Wx::GRID::GridFitMode]
2986
+ def self.clip; end
2987
+
2988
+ # Pseudo-constructor for object specifying overflow behaviour.
2989
+ # @return [Wx::GRID::GridFitMode]
2990
+ def self.overflow; end
2991
+
2992
+ # Pseudo-constructor for object specifying ellipsize behaviour.
2993
+ # @param ellipsize [Wx::EllipsizeMode]
2994
+ # @return [Wx::GRID::GridFitMode]
2995
+ def self.ellipsize(ellipsize=Wx::EllipsizeMode::ELLIPSIZE_END) end
2996
+
2997
+ end # GridFitMode
2998
+
2999
+
3000
+ end
3001
+
3002
+ end