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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (646) hide show
  1. checksums.yaml +4 -4
  2. data/INSTALL.md +35 -29
  3. data/README.md +24 -15
  4. data/ext/wxbase32u_gcc_custom.dll +0 -0
  5. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  6. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  7. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  19. data/lib/wx/core/bitmap_combobox.rb +17 -21
  20. data/lib/wx/core/combobox.rb +13 -3
  21. data/lib/wx/core/controlwithitems.rb +40 -130
  22. data/lib/wx/core/enum.rb +17 -1
  23. data/lib/wx/core/event.rb +6 -1
  24. data/lib/wx/core/events/evt_list.rb +5 -4
  25. data/lib/wx/core/evthandler.rb +8 -2
  26. data/lib/wx/core/generic_validator.rb +312 -0
  27. data/lib/wx/core/listbox.rb +2 -2
  28. data/lib/wx/core/log.rb +1 -1
  29. data/lib/wx/core/owner_drawn_combobox.rb +45 -0
  30. data/lib/wx/core/size.rb +4 -0
  31. data/lib/wx/core/sizer.rb +1 -2
  32. data/lib/wx/core/standard_paths.rb +22 -0
  33. data/lib/wx/core/text_entry.rb +4 -1
  34. data/lib/wx/core/validator.rb +70 -5
  35. data/lib/wx/core/window.rb +3 -7
  36. data/lib/wx/doc/art_locator.rb +1 -0
  37. data/lib/wx/doc/comboctrl.rb +18 -0
  38. data/lib/wx/doc/controlwithitems.rb +16 -0
  39. data/lib/wx/doc/date_picker_ctrl.rb +23 -0
  40. data/lib/wx/doc/editable_listbox.rb +44 -0
  41. data/lib/wx/doc/enum.rb +15 -0
  42. data/lib/wx/doc/event.rb +12 -0
  43. data/lib/wx/doc/extra/12_client_data.md +89 -0
  44. data/lib/wx/doc/extra/13_validators.md +139 -0
  45. data/lib/wx/doc/gdi_common.rb +4 -0
  46. data/lib/wx/doc/gen/about_dialog_info.rb +25 -0
  47. data/lib/wx/doc/gen/accelerator.rb +7 -1
  48. data/lib/wx/doc/gen/accessible.rb +13 -0
  49. data/lib/wx/doc/gen/activity_indicator.rb +7 -0
  50. data/lib/wx/doc/gen/animation.rb +12 -0
  51. data/lib/wx/doc/gen/animation_ctrl.rb +10 -0
  52. data/lib/wx/doc/gen/any_button.rb +17 -1
  53. data/lib/wx/doc/gen/app.rb +35 -1
  54. data/lib/wx/doc/gen/app_traits.rb +38 -5
  55. data/lib/wx/doc/gen/art_provider.rb +14 -0
  56. data/lib/wx/doc/gen/aui/aui_dock_art.rb +12 -0
  57. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +1 -0
  58. data/lib/wx/doc/gen/aui/aui_manager.rb +24 -1
  59. data/lib/wx/doc/gen/aui/aui_manager_event.rb +9 -1
  60. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +3 -0
  61. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +2 -0
  62. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +3 -1
  63. data/lib/wx/doc/gen/aui/aui_notebook.rb +20 -2
  64. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +2 -1
  65. data/lib/wx/doc/gen/aui/aui_pane_info.rb +30 -1
  66. data/lib/wx/doc/gen/aui/aui_tab_art.rb +6 -0
  67. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +1 -0
  68. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +11 -0
  69. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +2 -0
  70. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +2 -1
  71. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +4 -0
  72. data/lib/wx/doc/gen/banner_window.rb +7 -0
  73. data/lib/wx/doc/gen/bitmap.rb +64 -3
  74. data/lib/wx/doc/gen/bitmap_button.rb +6 -1
  75. data/lib/wx/doc/gen/bitmap_combo_box.rb +9 -3
  76. data/lib/wx/doc/gen/book_ctrl_base.rb +17 -2
  77. data/lib/wx/doc/gen/book_ctrl_event.rb +3 -1
  78. data/lib/wx/doc/gen/box_sizer.rb +5 -0
  79. data/lib/wx/doc/gen/brush.rb +16 -1
  80. data/lib/wx/doc/gen/busy_info.rb +8 -0
  81. data/lib/wx/doc/gen/button.rb +11 -3
  82. data/lib/wx/doc/gen/calculate_layout_event.rb +4 -0
  83. data/lib/wx/doc/gen/calendar_ctrl.rb +22 -0
  84. data/lib/wx/doc/gen/calendar_date_attr.rb +1 -0
  85. data/lib/wx/doc/gen/calendar_event.rb +3 -1
  86. data/lib/wx/doc/gen/caret.rb +3 -0
  87. data/lib/wx/doc/gen/check_box.rb +10 -0
  88. data/lib/wx/doc/gen/check_list_box.rb +3 -0
  89. data/lib/wx/doc/gen/choice.rb +14 -2
  90. data/lib/wx/doc/gen/choicebook.rb +1 -0
  91. data/lib/wx/doc/gen/client_dc.rb +1 -0
  92. data/lib/wx/doc/gen/clipboard.rb +9 -0
  93. data/lib/wx/doc/gen/collapsible_pane.rb +3 -0
  94. data/lib/wx/doc/gen/collapsible_pane_event.rb +1 -0
  95. data/lib/wx/doc/gen/colour.rb +20 -0
  96. data/lib/wx/doc/gen/colour_dialog.rb +10 -0
  97. data/lib/wx/doc/gen/colour_picker_ctrl.rb +4 -0
  98. data/lib/wx/doc/gen/colour_picker_event.rb +1 -0
  99. data/lib/wx/doc/gen/combo_box.rb +20 -1
  100. data/lib/wx/doc/gen/combo_ctrl.rb +54 -295
  101. data/lib/wx/doc/gen/command_link_button.rb +8 -0
  102. data/lib/wx/doc/gen/context_help_button.rb +7 -1
  103. data/lib/wx/doc/gen/control.rb +12 -0
  104. data/lib/wx/doc/gen/control_with_items.rb +45 -9
  105. data/lib/wx/doc/gen/core.rb +2 -2
  106. data/lib/wx/doc/gen/cursor.rb +4 -0
  107. data/lib/wx/doc/gen/data_format.rb +1 -0
  108. data/lib/wx/doc/gen/data_object.rb +27 -5
  109. data/lib/wx/doc/gen/date_event.rb +2 -1
  110. data/lib/wx/doc/gen/date_picker_ctrl.rb +7 -1
  111. data/lib/wx/doc/gen/dc.rb +87 -3
  112. data/lib/wx/doc/gen/dial_up_event.rb +2 -0
  113. data/lib/wx/doc/gen/dial_up_manager.rb +12 -0
  114. data/lib/wx/doc/gen/dialog.rb +42 -3
  115. data/lib/wx/doc/gen/dir_dialog.rb +6 -1
  116. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -0
  117. data/lib/wx/doc/gen/dir_picker_ctrl.rb +5 -0
  118. data/lib/wx/doc/gen/drag_drop.rb +20 -0
  119. data/lib/wx/doc/gen/drag_image.rb +7 -0
  120. data/lib/wx/doc/gen/editable_list_box.rb +5 -3
  121. data/lib/wx/doc/gen/event.rb +26 -11
  122. data/lib/wx/doc/gen/event_blocker.rb +2 -1
  123. data/lib/wx/doc/gen/event_filter.rb +3 -0
  124. data/lib/wx/doc/gen/event_list.rb +4 -4
  125. data/lib/wx/doc/gen/events.rb +165 -26
  126. data/lib/wx/doc/gen/evt_handler.rb +40 -2
  127. data/lib/wx/doc/gen/ext_help_controller.rb +9 -0
  128. data/lib/wx/doc/gen/file_ctrl.rb +11 -2
  129. data/lib/wx/doc/gen/file_ctrl_event.rb +5 -1
  130. data/lib/wx/doc/gen/file_dialog.rb +13 -0
  131. data/lib/wx/doc/gen/file_dialog_custom_control.rb +12 -0
  132. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +9 -0
  133. data/lib/wx/doc/gen/file_dir_picker_event.rb +2 -1
  134. data/lib/wx/doc/gen/file_picker_ctrl.rb +4 -0
  135. data/lib/wx/doc/gen/file_system.rb +17 -1
  136. data/lib/wx/doc/gen/find_dialog_event.rb +2 -1
  137. data/lib/wx/doc/gen/find_replace_data.rb +1 -0
  138. data/lib/wx/doc/gen/find_replace_dialog.rb +3 -0
  139. data/lib/wx/doc/gen/flex_grid_sizer.rb +13 -0
  140. data/lib/wx/doc/gen/font.rb +75 -3
  141. data/lib/wx/doc/gen/font_data.rb +14 -0
  142. data/lib/wx/doc/gen/font_dialog.rb +6 -0
  143. data/lib/wx/doc/gen/font_picker_ctrl.rb +8 -0
  144. data/lib/wx/doc/gen/font_picker_event.rb +1 -0
  145. data/lib/wx/doc/gen/frame.rb +24 -7
  146. data/lib/wx/doc/gen/fs_file.rb +22 -0
  147. data/lib/wx/doc/gen/gauge.rb +8 -0
  148. data/lib/wx/doc/gen/gb_sizer_item.rb +5 -0
  149. data/lib/wx/doc/gen/gcdc.rb +2 -0
  150. data/lib/wx/doc/gen/gdi_common.rb +50 -0
  151. data/lib/wx/doc/gen/gdi_object.rb +1 -0
  152. data/lib/wx/doc/gen/generic_dir_ctrl.rb +7 -0
  153. data/lib/wx/doc/gen/graphics_context.rb +36 -7
  154. data/lib/wx/doc/gen/graphics_object.rb +24 -0
  155. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +2 -0
  156. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +14 -2
  157. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -0
  158. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +1 -0
  159. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +2 -0
  160. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -0
  161. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +2 -0
  162. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +1 -0
  163. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +1 -0
  164. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +1 -0
  165. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +9 -0
  166. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +1 -0
  167. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +1 -0
  168. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -0
  169. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +2 -0
  170. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +2 -0
  171. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -0
  172. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +6 -0
  173. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -0
  174. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -0
  175. data/lib/wx/doc/gen/grid/grid_ctrl.rb +229 -7
  176. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +4 -1
  177. data/lib/wx/doc/gen/grid/grid_event.rb +4 -1
  178. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +2 -1
  179. data/lib/wx/doc/gen/grid/grid_size_event.rb +2 -1
  180. data/lib/wx/doc/gen/grid/grid_string_table.rb +7 -0
  181. data/lib/wx/doc/gen/grid/grid_table_base.rb +27 -1
  182. data/lib/wx/doc/gen/grid/grid_table_message.rb +1 -0
  183. data/lib/wx/doc/gen/grid_bag_sizer.rb +24 -4
  184. data/lib/wx/doc/gen/grid_sizer.rb +11 -0
  185. data/lib/wx/doc/gen/gui_event_loop.rb +12 -0
  186. data/lib/wx/doc/gen/header_ctrl.rb +106 -0
  187. data/lib/wx/doc/gen/header_ctrl_event.rb +5 -1
  188. data/lib/wx/doc/gen/help_controller.rb +11 -0
  189. data/lib/wx/doc/gen/help_provider.rb +12 -3
  190. data/lib/wx/doc/gen/html/html_cell.rb +25 -0
  191. data/lib/wx/doc/gen/html/html_cell_event.rb +3 -1
  192. data/lib/wx/doc/gen/html/html_easy_printing.rb +13 -1
  193. data/lib/wx/doc/gen/html/html_help_controller.rb +18 -0
  194. data/lib/wx/doc/gen/html/html_help_data.rb +5 -0
  195. data/lib/wx/doc/gen/html/html_help_window.rb +8 -0
  196. data/lib/wx/doc/gen/html/html_link_event.rb +1 -0
  197. data/lib/wx/doc/gen/html/html_list_box.rb +49 -9
  198. data/lib/wx/doc/gen/html/html_printout.rb +7 -0
  199. data/lib/wx/doc/gen/html/html_window.rb +31 -0
  200. data/lib/wx/doc/gen/hyperlink_ctrl.rb +2 -1
  201. data/lib/wx/doc/gen/hyperlink_event.rb +1 -0
  202. data/lib/wx/doc/gen/icon.rb +19 -1
  203. data/lib/wx/doc/gen/icon_location.rb +1 -0
  204. data/lib/wx/doc/gen/image.rb +67 -10
  205. data/lib/wx/doc/gen/image_list.rb +12 -2
  206. data/lib/wx/doc/gen/info_bar.rb +12 -0
  207. data/lib/wx/doc/gen/keyboard_state.rb +11 -0
  208. data/lib/wx/doc/gen/list_box.rb +20 -3
  209. data/lib/wx/doc/gen/list_ctrl.rb +89 -0
  210. data/lib/wx/doc/gen/list_event.rb +11 -1
  211. data/lib/wx/doc/gen/listbook.rb +1 -0
  212. data/lib/wx/doc/gen/locale.rb +22 -0
  213. data/lib/wx/doc/gen/log.rb +42 -0
  214. data/lib/wx/doc/gen/mdi_client_window.rb +4 -1
  215. data/lib/wx/doc/gen/mdi_frame.rb +27 -4
  216. data/lib/wx/doc/gen/media_ctrl.rb +17 -0
  217. data/lib/wx/doc/gen/media_event.rb +2 -1
  218. data/lib/wx/doc/gen/memory_dc.rb +10 -0
  219. data/lib/wx/doc/gen/menu.rb +48 -7
  220. data/lib/wx/doc/gen/menu_bar.rb +32 -13
  221. data/lib/wx/doc/gen/menu_item.rb +26 -0
  222. data/lib/wx/doc/gen/message_dialog.rb +10 -0
  223. data/lib/wx/doc/gen/mini_frame.rb +5 -2
  224. data/lib/wx/doc/gen/mirror_dc.rb +1 -0
  225. data/lib/wx/doc/gen/mouse_state.rb +1 -0
  226. data/lib/wx/doc/gen/multi_choice_dialog.rb +3 -1
  227. data/lib/wx/doc/gen/non_owned_window.rb +3 -0
  228. data/lib/wx/doc/gen/notebook.rb +11 -1
  229. data/lib/wx/doc/gen/num_validator.rb +37 -0
  230. data/lib/wx/doc/gen/number_entry_dialog.rb +4 -0
  231. data/lib/wx/doc/gen/object.rb +3 -0
  232. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +340 -0
  233. data/lib/wx/doc/gen/paint_dc.rb +1 -0
  234. data/lib/wx/doc/gen/palette.rb +5 -0
  235. data/lib/wx/doc/gen/panel.rb +10 -2
  236. data/lib/wx/doc/gen/pen.rb +30 -1
  237. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +2 -1
  238. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +4 -1
  239. data/lib/wx/doc/gen/pg/pg_cell.rb +6 -1
  240. data/lib/wx/doc/gen/pg/pg_editor.rb +61 -15
  241. data/lib/wx/doc/gen/pg/pg_multi_button.rb +2 -0
  242. data/lib/wx/doc/gen/pg/pg_properties.rb +198 -81
  243. data/lib/wx/doc/gen/pg/pg_property.rb +129 -52
  244. data/lib/wx/doc/gen/pg/pg_validation_info.rb +2 -0
  245. data/lib/wx/doc/gen/pg/property_grid.rb +56 -14
  246. data/lib/wx/doc/gen/pg/property_grid_event.rb +16 -6
  247. data/lib/wx/doc/gen/pg/property_grid_interface.rb +98 -37
  248. data/lib/wx/doc/gen/pg/property_grid_manager.rb +29 -7
  249. data/lib/wx/doc/gen/pg/property_grid_page.rb +11 -4
  250. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +7 -2
  251. data/lib/wx/doc/gen/picker_base.rb +11 -1
  252. data/lib/wx/doc/gen/platform_info.rb +31 -0
  253. data/lib/wx/doc/gen/popup_window.rb +5 -0
  254. data/lib/wx/doc/gen/progress_dialog.rb +4 -0
  255. data/lib/wx/doc/gen/property_sheet_dialog.rb +7 -1
  256. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +2 -0
  257. data/lib/wx/doc/gen/prt/post_script_dc.rb +1 -0
  258. data/lib/wx/doc/gen/prt/preview_frame.rb +4 -0
  259. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +1 -0
  260. data/lib/wx/doc/gen/prt/print_data.rb +27 -0
  261. data/lib/wx/doc/gen/prt/print_dialog.rb +4 -0
  262. data/lib/wx/doc/gen/prt/printer.rb +42 -5
  263. data/lib/wx/doc/gen/prt/printer_dc.rb +2 -0
  264. data/lib/wx/doc/gen/query_layout_info_event.rb +9 -0
  265. data/lib/wx/doc/gen/radio_box.rb +19 -0
  266. data/lib/wx/doc/gen/radio_button.rb +9 -0
  267. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +63 -0
  268. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +23 -0
  269. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +2 -1
  270. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +35 -9
  271. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +2 -1
  272. data/lib/wx/doc/gen/rbn/ribbon_control.rb +10 -0
  273. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +17 -7
  274. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -1
  275. data/lib/wx/doc/gen/rbn/ribbon_page.rb +12 -0
  276. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +11 -0
  277. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +2 -1
  278. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +25 -0
  279. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +2 -1
  280. data/lib/wx/doc/gen/rearrange_ctrl.rb +4 -0
  281. data/lib/wx/doc/gen/rearrange_list.rb +9 -0
  282. data/lib/wx/doc/gen/region.rb +42 -13
  283. data/lib/wx/doc/gen/region_iterator.rb +1 -0
  284. data/lib/wx/doc/gen/rtc/rich_text_box.rb +25 -8
  285. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +41 -4
  286. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -0
  287. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +23 -11
  288. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +74 -0
  289. data/lib/wx/doc/gen/rtc/rich_text_event.rb +6 -1
  290. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +8 -0
  291. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +6 -0
  292. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +1 -0
  293. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +4 -0
  294. data/lib/wx/doc/gen/rtc/rich_text_image.rb +7 -0
  295. data/lib/wx/doc/gen/rtc/rich_text_object.rb +64 -4
  296. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +51 -4
  297. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +13 -0
  298. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +9 -4
  299. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +3 -0
  300. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +2 -0
  301. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +1 -0
  302. data/lib/wx/doc/gen/sash_event.rb +5 -1
  303. data/lib/wx/doc/gen/sash_layout_window.rb +10 -0
  304. data/lib/wx/doc/gen/sash_window.rb +3 -0
  305. data/lib/wx/doc/gen/screen_dc.rb +1 -0
  306. data/lib/wx/doc/gen/scroll_bar.rb +11 -2
  307. data/lib/wx/doc/gen/scrolled_canvas.rb +20 -4
  308. data/lib/wx/doc/gen/scrolled_control.rb +20 -4
  309. data/lib/wx/doc/gen/scrolled_window.rb +20 -4
  310. data/lib/wx/doc/gen/search_ctrl.rb +6 -0
  311. data/lib/wx/doc/gen/simplebook.rb +7 -0
  312. data/lib/wx/doc/gen/single_choice_dialog.rb +3 -1
  313. data/lib/wx/doc/gen/sizer.rb +79 -9
  314. data/lib/wx/doc/gen/sizer_item.rb +16 -2
  315. data/lib/wx/doc/gen/slider.rb +23 -0
  316. data/lib/wx/doc/gen/spin_button.rb +9 -0
  317. data/lib/wx/doc/gen/spin_ctrl.rb +11 -0
  318. data/lib/wx/doc/gen/spin_ctrl_double.rb +7 -0
  319. data/lib/wx/doc/gen/spin_double_event.rb +4 -1
  320. data/lib/wx/doc/gen/spin_event.rb +2 -1
  321. data/lib/wx/doc/gen/splash_screen.rb +2 -0
  322. data/lib/wx/doc/gen/splitter_event.rb +10 -1
  323. data/lib/wx/doc/gen/splitter_window.rb +38 -14
  324. data/lib/wx/doc/gen/static_bitmap.rb +99 -2
  325. data/lib/wx/doc/gen/static_box.rb +6 -0
  326. data/lib/wx/doc/gen/static_box_sizer.rb +3 -0
  327. data/lib/wx/doc/gen/static_line.rb +4 -0
  328. data/lib/wx/doc/gen/static_text.rb +5 -0
  329. data/lib/wx/doc/gen/status_bar.rb +17 -3
  330. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +174 -6
  331. data/lib/wx/doc/gen/stc/styled_text_event.rb +27 -1
  332. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +7 -0
  333. data/lib/wx/doc/gen/svg_file_dc.rb +9 -0
  334. data/lib/wx/doc/gen/system_options.rb +8 -0
  335. data/lib/wx/doc/gen/system_settings.rb +7 -0
  336. data/lib/wx/doc/gen/task_bar_button.rb +12 -0
  337. data/lib/wx/doc/gen/task_bar_icon.rb +5 -0
  338. data/lib/wx/doc/gen/task_bar_icon_event.rb +2 -1
  339. data/lib/wx/doc/gen/text_attr.rb +27 -0
  340. data/lib/wx/doc/gen/text_ctrl.rb +27 -3
  341. data/lib/wx/doc/gen/text_entry.rb +43 -5
  342. data/lib/wx/doc/gen/text_entry_dialog.rb +12 -0
  343. data/lib/wx/doc/gen/text_validator.rb +16 -0
  344. data/lib/wx/doc/gen/time_picker_ctrl.rb +6 -0
  345. data/lib/wx/doc/gen/timer.rb +8 -0
  346. data/lib/wx/doc/gen/timer_event.rb +1 -0
  347. data/lib/wx/doc/gen/tip_provider.rb +5 -0
  348. data/lib/wx/doc/gen/toggle_button.rb +68 -0
  349. data/lib/wx/doc/gen/tool_bar.rb +57 -14
  350. data/lib/wx/doc/gen/tool_tip.rb +6 -0
  351. data/lib/wx/doc/gen/toolbook.rb +3 -0
  352. data/lib/wx/doc/gen/top_level_window.rb +34 -3
  353. data/lib/wx/doc/gen/tree_ctrl.rb +49 -0
  354. data/lib/wx/doc/gen/tree_event.rb +7 -1
  355. data/lib/wx/doc/gen/treebook.rb +9 -0
  356. data/lib/wx/doc/gen/ui_action_simulator.rb +4 -0
  357. data/lib/wx/doc/gen/utils.rb +55 -0
  358. data/lib/wx/doc/gen/v_list_box.rb +21 -0
  359. data/lib/wx/doc/gen/v_scrolled_window.rb +15 -0
  360. data/lib/wx/doc/gen/validator.rb +9 -13
  361. data/lib/wx/doc/gen/variant.rb +6 -0
  362. data/lib/wx/doc/gen/window.rb +260 -52
  363. data/lib/wx/doc/gen/window_dc.rb +2 -0
  364. data/lib/wx/doc/gen/window_disabler.rb +1 -0
  365. data/lib/wx/doc/gen/with_images.rb +7 -1
  366. data/lib/wx/doc/gen/wizard.rb +18 -0
  367. data/lib/wx/doc/gen/wizard_event.rb +3 -1
  368. data/lib/wx/doc/gen/wizard_page.rb +5 -0
  369. data/lib/wx/doc/gen/wizard_page_simple.rb +4 -0
  370. data/lib/wx/doc/gen/wrap_sizer.rb +5 -0
  371. data/lib/wx/doc/gen/xml_node.rb +14 -0
  372. data/lib/wx/doc/gen/xml_resource.rb +22 -0
  373. data/lib/wx/doc/generic_validator.rb +95 -0
  374. data/lib/wx/doc/html/simple_html_listbox.rb +22 -0
  375. data/lib/wx/doc/num_validator.rb +387 -0
  376. data/lib/wx/doc/owner_drawn_combobox.rb +96 -0
  377. data/lib/wx/doc/pg/numeric_property_validator.rb +33 -0
  378. data/lib/wx/doc/static_bitmap.rb +25 -0
  379. data/lib/wx/doc/text_validator.rb +10 -0
  380. data/lib/wx/doc/validator.rb +113 -0
  381. data/lib/wx/doc/window.rb +30 -0
  382. data/lib/wx/html/events/evt_list.rb +0 -10
  383. data/lib/wx/html/simple_html_listbox.rb +24 -91
  384. data/lib/wx/keyword_defs.rb +34 -2
  385. data/lib/wx/rbn/ribbon_gallery.rb +0 -21
  386. data/lib/wx/version.rb +1 -1
  387. data/lib/wxruby_aui.so +0 -0
  388. data/lib/wxruby_core.so +0 -0
  389. data/lib/wxruby_grid.so +0 -0
  390. data/lib/wxruby_html.so +0 -0
  391. data/lib/wxruby_pg.so +0 -0
  392. data/lib/wxruby_prt.so +0 -0
  393. data/lib/wxruby_rbn.so +0 -0
  394. data/lib/wxruby_rtc.so +0 -0
  395. data/lib/wxruby_stc.so +0 -0
  396. data/rakelib/lib/config/mingw.rb +12 -0
  397. data/samples/aui/aui.rb +1237 -1233
  398. data/samples/calendar/calendar.rb +293 -289
  399. data/samples/controls/get_item_sample.rb +83 -79
  400. data/samples/controls/htlbox.rb +331 -327
  401. data/samples/dialogs/dialogs.rb +682 -694
  402. data/samples/dialogs/wizard.rb +52 -55
  403. data/samples/dragdrop/dragdrop.rb +146 -142
  404. data/samples/drawing/bitmap.rb +29 -26
  405. data/samples/drawing/bitmap_image.rb +84 -80
  406. data/samples/drawing/graphics_drawing.rb +209 -205
  407. data/samples/drawing/image_prt.rb +344 -340
  408. data/samples/drawing/maths_images.rb +18 -1
  409. data/samples/drawing/rmagic_bitmap_image.rb +88 -84
  410. data/samples/etc/caret.rb +306 -0
  411. data/samples/etc/miniframe.rb +65 -60
  412. data/samples/etc/sash.rb +109 -105
  413. data/samples/etc/scrollwin.rb +86 -80
  414. data/samples/etc/system_settings.rb +216 -209
  415. data/samples/event/activation.rb +72 -67
  416. data/samples/event/event.rb +160 -153
  417. data/samples/event/threaded.rb +8 -1
  418. data/samples/event/update_ui_event.rb +67 -60
  419. data/samples/grid/grid.rb +188 -181
  420. data/samples/grid/gridtablebase.rb +136 -129
  421. data/samples/html/html.rb +208 -204
  422. data/samples/mdi/mdi.rb +59 -54
  423. data/samples/minimal/minimal.rb +54 -51
  424. data/samples/minimal/nothing.rb +1 -0
  425. data/samples/printing/printing.rb +367 -377
  426. data/samples/printing/printing2.rb +203 -198
  427. data/samples/propgrid/propgrid.rb +2312 -2308
  428. data/samples/propgrid/propgrid_minimal.rb +57 -50
  429. data/samples/ribbon/ribbon.rb +780 -774
  430. data/samples/sampler/ext.rb +0 -33
  431. data/samples/sampler/sample.rb +4 -9
  432. data/samples/sampler.rb +1 -1
  433. data/samples/splash/splash.rb +118 -116
  434. data/samples/text/rich_textctrl.rb +207 -201
  435. data/samples/text/richtext.rb +1409 -1405
  436. data/samples/text/scintilla.rb +137 -128
  437. data/samples/text/textctrl.rb +89 -83
  438. data/samples/text/unicode.rb +175 -168
  439. data/samples/treectrl/treectrl.rb +1430 -1426
  440. data/samples/widgets/activityindicator.rb +95 -0
  441. data/samples/widgets/art/widgets/activityindicator.xpm +278 -0
  442. data/samples/widgets/art/widgets/bmpbtn.xpm +37 -0
  443. data/samples/widgets/art/widgets/bmpcombobox.xpm +54 -0
  444. data/samples/widgets/art/widgets/button.xpm +54 -0
  445. data/samples/widgets/art/widgets/checkbox.xpm +54 -0
  446. data/samples/{bigdemo/icons → widgets/art/widgets}/choice.xpm +1 -1
  447. data/samples/widgets/art/widgets/choicebk.xpm +54 -0
  448. data/samples/widgets/art/widgets/clrpicker.xpm +193 -0
  449. data/samples/widgets/art/widgets/combobox.xpm +54 -0
  450. data/samples/widgets/art/widgets/datepick.xpm +200 -0
  451. data/samples/widgets/art/widgets/dirctrl.xpm +54 -0
  452. data/samples/widgets/art/widgets/dirpicker.xpm +213 -0
  453. data/samples/widgets/art/widgets/filepicker.xpm +214 -0
  454. data/samples/widgets/art/widgets/fontpicker.xpm +185 -0
  455. data/samples/widgets/art/widgets/gauge.xpm +54 -0
  456. data/samples/widgets/art/widgets/header.xpm +54 -0
  457. data/samples/widgets/art/widgets/hyperlnk.xpm +54 -0
  458. data/samples/widgets/art/widgets/listbook.xpm +54 -0
  459. data/samples/widgets/art/widgets/listbox.xpm +54 -0
  460. data/samples/widgets/art/widgets/native.xpm +81 -0
  461. data/samples/widgets/art/widgets/notebook.xpm +54 -0
  462. data/samples/widgets/art/widgets/odcombobox.xpm +54 -0
  463. data/samples/widgets/art/widgets/radiobox.xpm +54 -0
  464. data/samples/widgets/art/widgets/scrolbar.xpm +54 -0
  465. data/samples/widgets/art/widgets/slider.xpm +54 -0
  466. data/samples/widgets/art/widgets/spinbtn.xpm +40 -0
  467. data/samples/widgets/art/widgets/statbmp.xpm +40 -0
  468. data/samples/widgets/art/widgets/statbox.xpm +54 -0
  469. data/samples/widgets/art/widgets/stattext.xpm +54 -0
  470. data/samples/widgets/art/widgets/text.xpm +54 -0
  471. data/samples/widgets/art/widgets/timepick.xpm +207 -0
  472. data/samples/widgets/art/widgets/toggle.xpm +54 -0
  473. data/samples/widgets/art/widgets/toucan.png +0 -0
  474. data/samples/widgets/bmpcombobox.rb +651 -0
  475. data/samples/widgets/button.rb +462 -0
  476. data/samples/widgets/checkbox.rb +211 -0
  477. data/samples/widgets/choice.rb +287 -0
  478. data/samples/widgets/clrpicker.rb +156 -0
  479. data/samples/widgets/combobox.rb +516 -0
  480. data/samples/widgets/datepick.rb +215 -0
  481. data/samples/widgets/dirctrl.rb +265 -0
  482. data/samples/widgets/dirpicker.rb +158 -0
  483. data/samples/widgets/editlbox.rb +122 -0
  484. data/samples/widgets/filectrl.rb +216 -0
  485. data/samples/widgets/filepicker.rb +214 -0
  486. data/samples/widgets/fontpicker.rb +135 -0
  487. data/samples/widgets/gauge.rb +311 -0
  488. data/samples/widgets/headerctrl.rb +236 -0
  489. data/samples/widgets/hyperlink.rb +203 -0
  490. data/samples/widgets/itemcontainer.rb +185 -0
  491. data/samples/widgets/listbox.rb +473 -0
  492. data/samples/widgets/notebook.rb +488 -0
  493. data/samples/widgets/odcombobox.rb +608 -0
  494. data/samples/widgets/radiobox.rb +328 -0
  495. data/samples/widgets/searchctrl.rb +159 -0
  496. data/samples/widgets/slider.rb +594 -0
  497. data/samples/widgets/spinbtn.rb +443 -0
  498. data/samples/widgets/statbmp.rb +130 -0
  499. data/samples/widgets/static.rb +436 -0
  500. data/samples/widgets/textctrl.rb +700 -0
  501. data/samples/widgets/timepick.rb +148 -0
  502. data/samples/widgets/tn_widgets.png +0 -0
  503. data/samples/widgets/toggle.rb +385 -0
  504. data/samples/widgets/widgets.rb +1233 -0
  505. data/samples/xrc/custom_xrc_sample.rb +47 -41
  506. data/samples/xrc/xrc_sample.rb +53 -47
  507. data/tests/test_event_handling.rb +52 -34
  508. data/tests/test_events.rb +7 -0
  509. data/tests/test_item_data.rb +24 -0
  510. data/tests/test_sizer.rb +44 -1
  511. data/tests/test_validators.rb +805 -0
  512. metadata +87 -137
  513. data/lib/wx/core/choice.rb +0 -14
  514. data/lib/wx/core/combo_ctrl.rb +0 -110
  515. data/samples/bigdemo/About.rbw +0 -39
  516. data/samples/bigdemo/ColorPanel.rbw +0 -23
  517. data/samples/bigdemo/GridSimple.rbw +0 -78
  518. data/samples/bigdemo/MDIDemo.rbw +0 -57
  519. data/samples/bigdemo/PopupMenu.rbw +0 -146
  520. data/samples/bigdemo/ShapedWindow.rbw +0 -128
  521. data/samples/bigdemo/Sizers.rbw +0 -541
  522. data/samples/bigdemo/bigdemo.rb +0 -817
  523. data/samples/bigdemo/demoTemplate.rbw +0 -33
  524. data/samples/bigdemo/helpfile.htb +0 -0
  525. data/samples/bigdemo/icons/Test 015.jpg +0 -0
  526. data/samples/bigdemo/icons/Test 015.png +0 -0
  527. data/samples/bigdemo/icons/choice.bmp +0 -0
  528. data/samples/bigdemo/icons/combo.bmp +0 -0
  529. data/samples/bigdemo/icons/combo.xpm +0 -27
  530. data/samples/bigdemo/icons/copy.xpm +0 -25
  531. data/samples/bigdemo/icons/cut.xpm +0 -24
  532. data/samples/bigdemo/icons/gauge.bmp +0 -0
  533. data/samples/bigdemo/icons/gauge.xpm +0 -27
  534. data/samples/bigdemo/icons/help.xpm +0 -25
  535. data/samples/bigdemo/icons/list.bmp +0 -0
  536. data/samples/bigdemo/icons/list.xpm +0 -27
  537. data/samples/bigdemo/icons/mondrian.ico +0 -0
  538. data/samples/bigdemo/icons/mondrian.xpm +0 -44
  539. data/samples/bigdemo/icons/new.xpm +0 -24
  540. data/samples/bigdemo/icons/ogl.ico +0 -0
  541. data/samples/bigdemo/icons/ogl.xpm +0 -45
  542. data/samples/bigdemo/icons/open.xpm +0 -26
  543. data/samples/bigdemo/icons/paste.bmp +0 -0
  544. data/samples/bigdemo/icons/paste.xpm +0 -38
  545. data/samples/bigdemo/icons/pointy.png +0 -0
  546. data/samples/bigdemo/icons/preview.xpm +0 -26
  547. data/samples/bigdemo/icons/print.xpm +0 -26
  548. data/samples/bigdemo/icons/radio.bmp +0 -0
  549. data/samples/bigdemo/icons/radio.xpm +0 -27
  550. data/samples/bigdemo/icons/robert.xpm +0 -415
  551. data/samples/bigdemo/icons/sashtest.ico +0 -0
  552. data/samples/bigdemo/icons/save.xpm +0 -25
  553. data/samples/bigdemo/icons/smiles.bmp +0 -0
  554. data/samples/bigdemo/icons/smiles.xpm +0 -39
  555. data/samples/bigdemo/icons/smiley.ico +0 -0
  556. data/samples/bigdemo/icons/smiley.xpm +0 -42
  557. data/samples/bigdemo/icons/stattext.xpm +0 -24
  558. data/samples/bigdemo/icons/test2.bmp +0 -0
  559. data/samples/bigdemo/icons/test2.png +0 -0
  560. data/samples/bigdemo/icons/test2.xpm +0 -79
  561. data/samples/bigdemo/icons/text.bmp +0 -0
  562. data/samples/bigdemo/icons/text.xpm +0 -27
  563. data/samples/bigdemo/icons/tog1.bmp +0 -0
  564. data/samples/bigdemo/icons/tog1.xpm +0 -38
  565. data/samples/bigdemo/icons/tog2.bmp +0 -0
  566. data/samples/bigdemo/icons/tog2.xpm +0 -38
  567. data/samples/bigdemo/icons/wxruby-128x128.png +0 -0
  568. data/samples/bigdemo/icons/wxwin.ico +0 -0
  569. data/samples/bigdemo/icons/wxwin16x16.png +0 -0
  570. data/samples/bigdemo/icons/wxwin16x16.xpm +0 -25
  571. data/samples/bigdemo/icons/wxwin32x32.png +0 -0
  572. data/samples/bigdemo/icons/wxwin48x48.png +0 -0
  573. data/samples/bigdemo/run.rb +0 -98
  574. data/samples/bigdemo/tips.txt +0 -7
  575. data/samples/bigdemo/utils.rb +0 -20
  576. data/samples/bigdemo/wxArtProvider.rbw +0 -282
  577. data/samples/bigdemo/wxBitmapButton.rbw +0 -65
  578. data/samples/bigdemo/wxButton.rbw +0 -64
  579. data/samples/bigdemo/wxCalendarCtrl.rbw +0 -59
  580. data/samples/bigdemo/wxCheckBox.rbw +0 -50
  581. data/samples/bigdemo/wxCheckListBox.rbw +0 -65
  582. data/samples/bigdemo/wxChoice.rbw +0 -47
  583. data/samples/bigdemo/wxChoicebook.rbw +0 -78
  584. data/samples/bigdemo/wxColourDialog.rbw +0 -33
  585. data/samples/bigdemo/wxComboBox.rbw +0 -77
  586. data/samples/bigdemo/wxCursor.rbw +0 -136
  587. data/samples/bigdemo/wxDialog.rbw +0 -74
  588. data/samples/bigdemo/wxDirDialog.rbw +0 -29
  589. data/samples/bigdemo/wxDragImage.rbw +0 -70
  590. data/samples/bigdemo/wxFileDialog.rbw +0 -37
  591. data/samples/bigdemo/wxFileDialog_Save.rbw +0 -35
  592. data/samples/bigdemo/wxFindReplaceDialog.rbw +0 -82
  593. data/samples/bigdemo/wxFontDialog.rbw +0 -200
  594. data/samples/bigdemo/wxFrame.rbw +0 -53
  595. data/samples/bigdemo/wxGauge.rbw +0 -65
  596. data/samples/bigdemo/wxGenericDirCtrl.rbw +0 -74
  597. data/samples/bigdemo/wxGrid.rbw +0 -66
  598. data/samples/bigdemo/wxHtmlHelpController.rbw +0 -52
  599. data/samples/bigdemo/wxListBox.rbw +0 -140
  600. data/samples/bigdemo/wxListCtrl_virtual.rbw +0 -112
  601. data/samples/bigdemo/wxMDIWindows.rbw +0 -50
  602. data/samples/bigdemo/wxMenu.rbw +0 -247
  603. data/samples/bigdemo/wxMessageDialog.rbw +0 -27
  604. data/samples/bigdemo/wxMiniFrame.rbw +0 -70
  605. data/samples/bigdemo/wxMultipleChoiceDialog.rbw +0 -29
  606. data/samples/bigdemo/wxNotebook.rbw +0 -136
  607. data/samples/bigdemo/wxProgressDialog.rbw +0 -43
  608. data/samples/bigdemo/wxRadioBox.rbw +0 -72
  609. data/samples/bigdemo/wxRadioButton.rbw +0 -125
  610. data/samples/bigdemo/wxSashWindow.rbw +0 -141
  611. data/samples/bigdemo/wxScrolledMessageDialog.rbw +0 -57
  612. data/samples/bigdemo/wxScrolledWindow.rbw +0 -199
  613. data/samples/bigdemo/wxSingleChoiceDialog.rbw +0 -33
  614. data/samples/bigdemo/wxSlider.rbw +0 -42
  615. data/samples/bigdemo/wxSpinButton.rbw +0 -50
  616. data/samples/bigdemo/wxSpinCtrl.rbw +0 -51
  617. data/samples/bigdemo/wxSplitterWindow.rbw +0 -63
  618. data/samples/bigdemo/wxStaticBitmap.rbw +0 -47
  619. data/samples/bigdemo/wxStaticText.rbw +0 -55
  620. data/samples/bigdemo/wxStatusBar.rbw +0 -126
  621. data/samples/bigdemo/wxTextCtrl.rbw +0 -149
  622. data/samples/bigdemo/wxTextEntryDialog.rbw +0 -31
  623. data/samples/bigdemo/wxToggleButton.rbw +0 -49
  624. data/samples/bigdemo/wxToolBar.rbw +0 -131
  625. data/samples/bigdemo/wxTreeCtrl.rbw +0 -191
  626. data/samples/caret/caret.rb +0 -298
  627. data/samples/caret/mondrian.xpm +0 -44
  628. data/samples/controls/books.rb +0 -189
  629. data/samples/controls/choice.xpm +0 -27
  630. data/samples/controls/combo.xpm +0 -27
  631. data/samples/controls/controls.rb +0 -1099
  632. data/samples/controls/gauge.xpm +0 -27
  633. data/samples/controls/list.xpm +0 -27
  634. data/samples/controls/mondrian.ico +0 -0
  635. data/samples/controls/mondrian.xpm +0 -44
  636. data/samples/controls/radio.xpm +0 -27
  637. data/samples/controls/stattext.xpm +0 -24
  638. data/samples/controls/test2.bmp +0 -0
  639. data/samples/controls/text.xpm +0 -27
  640. data/samples/controls/tn_books.png +0 -0
  641. data/samples/controls/tn_controls.png +0 -0
  642. data/samples/etc/choice.rb +0 -87
  643. data/samples/etc/tn_choice.png +0 -0
  644. data/samples/text/mondrian.ico +0 -0
  645. data/samples/text/mondrian.xpm +0 -44
  646. /data/samples/{caret → etc}/tn_caret.png +0 -0
@@ -315,6 +315,7 @@ module Wx
315
315
  EVT_LIST_ITEM_UNCHECKED = 10155
316
316
 
317
317
  # A list control presents lists in a number of formats: list view, report view, icon view and small icon view.
318
+ #
318
319
  # In any case, elements are numbered from zero. For all these modes, the items are stored in the control and must be added to it using {Wx::ListCtrl#insert_item} method.
319
320
  # A special case of report view quite different from the other modes of the list control is a virtual control in which the items data (including text, images and attributes) is managed by the main program and is requested by the control itself only when needed which allows having controls with millions of items without consuming much memory. To use virtual list control you must use {Wx::ListCtrl#set_item_count} first and override at least {Wx::ListCtrl#on_get_item_text} (and optionally {Wx::ListCtrl#on_get_item_image} or {Wx::ListCtrl#on_get_item_column_image} and {Wx::ListCtrl#on_get_item_attr}) to return the information about the items when the control requests it.
320
321
  # Virtual list control can be used as a normal one except that no operations which can take time proportional to the number of items in the control happen this is required to allow having a practically infinite number of items. For example, in a multiple selection virtual list control, the selections won't be sent when many items are selected at once because this could mean iterating over all the items.
@@ -464,6 +465,7 @@ module Wx
464
465
  # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::LC_ICON, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_CTRL_NAME_STR)
465
466
  # Constructor, creating and showing a list control.
466
467
  #
468
+ #
467
469
  # @see Wx::ListCtrl#create
468
470
  # @see Wx::Validator
469
471
  # @param parent [Wx::Window] Parent window. Must not be NULL.
@@ -477,6 +479,7 @@ module Wx
477
479
  def initialize(*args) end
478
480
 
479
481
  # Adds a new column to the list control in report view mode.
482
+ #
480
483
  # This is just a convenient wrapper for {Wx::ListCtrl#insert_column} which adds the new column after all the existing ones without having to specify its position explicitly.
481
484
  # @param heading [String]
482
485
  # @param format [Wx::ListColumnFormat]
@@ -485,6 +488,7 @@ module Wx
485
488
  def append_column(heading, format=Wx::ListColumnFormat::LIST_FORMAT_LEFT, width=-1) end
486
489
 
487
490
  # Arranges the items in icon or small icon view.
491
+ #
488
492
  # This only has effect on Win32. flag is one of:
489
493
  #
490
494
  # - {Wx::LIST_ALIGN_DEFAULT}: Default alignment.
@@ -496,6 +500,7 @@ module Wx
496
500
  def arrange(flag=Wx::LIST_ALIGN_DEFAULT) end
497
501
 
498
502
  # Deletes all items and all columns.
503
+ #
499
504
  # <div class="wxrb-note">
500
505
  # <b>Note:</b>
501
506
  # <p>This sends an event of type {Wx::EVT_LIST_DELETE_ALL_ITEMS} under all platforms.
@@ -505,6 +510,7 @@ module Wx
505
510
  def clear_all; end
506
511
 
507
512
  # Creates the list control.
513
+ #
508
514
  # See {Wx::ListCtrl#initialize} for further details.
509
515
  # @param parent [Wx::Window]
510
516
  # @param id [Integer]
@@ -517,11 +523,13 @@ module Wx
517
523
  def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::LC_ICON, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_CTRL_NAME_STR) end
518
524
 
519
525
  # Delete all columns in the list control.
526
+ #
520
527
  # true if all columns were successfully deleted, false otherwise.
521
528
  # @return [Boolean]
522
529
  def delete_all_columns; end
523
530
 
524
531
  # Deletes all items in the list control.
532
+ #
525
533
  # This function does not send the {Wx::EVT_LIST_DELETE_ITEM} event because deleting many items from the control would be too slow then (unlike {Wx::ListCtrl#delete_item}) but it does send the special {Wx::EVT_LIST_DELETE_ALL_ITEMS} event if the control was not empty. If it was already empty, nothing is done and no event is sent.
526
534
  # true if the items were successfully deleted or if the control was already empty, false if an error occurred while deleting the items.
527
535
  # @return [Boolean]
@@ -533,6 +541,7 @@ module Wx
533
541
  def delete_column(col) end
534
542
 
535
543
  # Deletes the specified item.
544
+ #
536
545
  # This function sends the {Wx::EVT_LIST_DELETE_ITEM} event for the item being deleted.
537
546
  # @see Wx::ListCtrl#delete_all_items
538
547
  # @param item [Integer]
@@ -540,6 +549,7 @@ module Wx
540
549
  def delete_item(item) end
541
550
 
542
551
  # Enable alternating row background colours (also called zebra striping).
552
+ #
543
553
  # This method can only be called for the control in virtual report mode, i.e. having {Wx::LC_REPORT} and {Wx::LC_VIRTUAL} styles.
544
554
  # When enabling alternating colours, the appropriate colour for the even rows is chosen automatically depending on the default foreground and background colours which are used for the odd rows.
545
555
  # @see Wx::ListCtrl#set_alternate_row_colour
@@ -548,12 +558,14 @@ module Wx
548
558
  def enable_alternate_row_colours(enable=true) end
549
559
 
550
560
  # Enable or disable a beep if there is no match for the currently entered text when searching for the item from keyboard.
561
+ #
551
562
  # The default is to not beep in this case except in WXMSW where the beep is always generated by the native control and cannot be disabled, i.e. calls to this function do nothing there.
552
563
  # @param on [Boolean]
553
564
  # @return [void]
554
565
  def enable_bell_on_no_match(on=true) end
555
566
 
556
567
  # Finish editing the label.
568
+ #
557
569
  # This method allows one to programmatically end editing a list control item in place. Usually it will only be called when editing is in progress, i.e. if {Wx::ListCtrl#get_edit_control} returns non-NULL. In particular, do not call it from EVT_LIST_BEGIN_LABEL_EDIT handler as the edit control is not yet fully created by then, just veto the event in this handler instead to prevent the editing from even starting.
558
570
  # Notice that calling this method will result in EVT_LIST_END_LABEL_EDIT event being generated.
559
571
  # Currently only implemented in WXMSW.
@@ -570,6 +582,7 @@ module Wx
570
582
 
571
583
  # @overload find_item(start, str, partial=false)
572
584
  # Find an item whose label matches this string, starting from start or the beginning if start is <code>-1</code>.
585
+ #
573
586
  # The string comparison is case insensitive.
574
587
  # If partial is true then this method will look for items which begin with str.
575
588
  # The next matching item if any or <code>-1</code> ({Wx::NOT_FOUND}) otherwise.
@@ -579,12 +592,14 @@ module Wx
579
592
  # @return [Integer]
580
593
  # @overload find_item(start, data)
581
594
  # Find an item whose data matches this data, starting from start or the beginning if 'start' is <code>-1</code>.
595
+ #
582
596
  # The next matching item if any or <code>-1</code> ({Wx::NOT_FOUND}) otherwise.
583
597
  # @param start [Integer]
584
598
  # @param data [Integer]
585
599
  # @return [Integer]
586
600
  # @overload find_item(start, pt, direction)
587
601
  # Find an item nearest this position in the specified direction, starting from start or the beginning if start is -1.
602
+ #
588
603
  # The next matching item if any or <code>-1</code> ({Wx::NOT_FOUND}) otherwise.
589
604
  # @param start [Integer]
590
605
  # @param pt [Array(Integer, Integer), Wx::Point]
@@ -593,6 +608,7 @@ module Wx
593
608
  def find_item(*args) end
594
609
 
595
610
  # Gets information about this column.
611
+ #
596
612
  # See {Wx::ListCtrl#set_item} for more information.
597
613
  # @param col [Integer]
598
614
  # @param item [Wx::ListItem]
@@ -601,6 +617,7 @@ module Wx
601
617
  alias_method :column, :get_column
602
618
 
603
619
  # Returns the number of columns.
620
+ #
604
621
  # The control can have multiple columns only in {Wx::LC_REPORT} mode. In {Wx::LC_LIST} mode this function returns 1, as a list is still considered to have a (single) column. In {Wx::LC_SMALL_ICON} and {Wx::LC_ICON} modes, it returns 0 as there are no columns at all.
605
622
  # @return [Integer]
606
623
  def get_column_count; end
@@ -618,6 +635,7 @@ module Wx
618
635
  alias_method :count_per_page, :get_count_per_page
619
636
 
620
637
  # Returns the edit control being currently used to edit a label.
638
+ #
621
639
  # Returns NULL if no label is being edited.
622
640
  #
623
641
  # <div class="wxrb-note">
@@ -630,6 +648,7 @@ module Wx
630
648
  alias_method :edit_control, :get_edit_control
631
649
 
632
650
  # Returns the specified image list.
651
+ #
633
652
  # which may be one of:
634
653
  #
635
654
  # - {Wx::IMAGE_LIST_NORMAL}: The normal (large icon) image list.
@@ -641,6 +660,7 @@ module Wx
641
660
  alias_method :image_list, :get_image_list
642
661
 
643
662
  # Returns the colour for this item.
663
+ #
644
664
  # If the item has no specific colour, returns an invalid colour (and not the default background colour of the control itself).
645
665
  # @see Wx::ListCtrl#get_item_text_colour
646
666
  # @param item [Integer]
@@ -667,6 +687,7 @@ module Wx
667
687
  alias_method :item_position, :get_item_position
668
688
 
669
689
  # Returns the rectangle representing the item's size and position, in physical coordinates.
690
+ #
670
691
  # code is one of {Wx::LIST_RECT_BOUNDS}, {Wx::LIST_RECT_ICON}, {Wx::LIST_RECT_LABEL}.
671
692
  # @param item [Integer]
672
693
  # @param code [Integer]
@@ -680,6 +701,7 @@ module Wx
680
701
  alias_method :item_spacing, :get_item_spacing
681
702
 
682
703
  # Gets the item state.
704
+ #
683
705
  # For a list of state flags, see {Wx::ListCtrl#set_item}. The stateMask indicates which state flags are of interest.
684
706
  # @param item [Integer]
685
707
  # @param stateMask [Integer]
@@ -695,6 +717,7 @@ module Wx
695
717
  alias_method :item_text, :get_item_text
696
718
 
697
719
  # Returns the colour for this item.
720
+ #
698
721
  # If the item has no specific colour, returns an invalid colour (and not the default foreground colour of the control itself as this wouldn't allow distinguishing between items having the same colour as the current control foreground and items with default colour which, hence, have always the same colour as the control).
699
722
  # @param item [Integer]
700
723
  # @return [Wx::Colour]
@@ -702,6 +725,7 @@ module Wx
702
725
  alias_method :item_text_colour, :get_item_text_colour
703
726
 
704
727
  # Searches for an item with the given geometry or state, starting from item but excluding the item itself.
728
+ #
705
729
  # If item is -1, the first item that matches the specified flags will be returned. Returns the first item with given state following item or -1 if no such item found. This function may be used to find all selected items in the control like this:
706
730
  #
707
731
  # ```ruby
@@ -751,6 +775,7 @@ module Wx
751
775
  alias_method :selected_item_count, :get_selected_item_count
752
776
 
753
777
  # Returns the rectangle representing the size and position, in physical coordinates, of the given subitem, i.e.
778
+ #
754
779
  # the part of the row item in the column subItem.
755
780
  # This method is only meaningful when the {Wx::ListCtrl} is in the report mode. If subItem parameter is equal to the special value {Wx::LIST_GETSUBITEMRECT_WHOLEITEM} the return value is the same as for {Wx::ListCtrl#get_item_rect}.
756
781
  # code can be one of {Wx::LIST_RECT_BOUNDS}, {Wx::LIST_RECT_ICON} or {Wx::LIST_RECT_LABEL}.
@@ -773,6 +798,7 @@ module Wx
773
798
  alias_method :top_item, :get_top_item
774
799
 
775
800
  # Returns the rectangle taken by all items in the control.
801
+ #
776
802
  # In other words, if the controls client size were equal to the size of this rectangle, no scrollbars would be needed and no free space would be left.
777
803
  # Note that this function only works in the icon and small icon views, not in list or report views (this is a limitation of the native Win32 control).
778
804
  # @return [Wx::Rect]
@@ -780,6 +806,7 @@ module Wx
780
806
  alias_method :view_rect, :get_view_rect
781
807
 
782
808
  # Set the alternative row background colour to a specific colour.
809
+ #
783
810
  # It is recommended to call {Wx::ListCtrl#enable_alternate_row_colours} instead of using these methods as native implementations of this control might support alternating row colours but not setting the exact colour to be used for them.
784
811
  # As {Wx::ListCtrl#enable_alternate_row_colours}, this method can only be used with controls having {Wx::LC_REPORT} and {Wx::LC_VIRTUAL} styles.
785
812
  # @param colour [Wx::Colour,String,Symbol] A valid alternative row background colour to enable alternating rows or invalid colour to disable them and use the same colour for all rows.
@@ -789,12 +816,14 @@ module Wx
789
816
 
790
817
  # Get the alternative row background colour.
791
818
  #
819
+ #
792
820
  # @see Wx::ListCtrl#set_alternate_row_colour
793
821
  # @return [Wx::Colour]
794
822
  def get_alternate_row_colour; end
795
823
  alias_method :alternate_row_colour, :get_alternate_row_colour
796
824
 
797
825
  # Determines which item (if any) is at the specified point, giving details in flags.
826
+ #
798
827
  # Returns index of the item or {Wx::NOT_FOUND} if no item is at the specified point.
799
828
  # flags will be a combination of the following flags:
800
829
  #
@@ -819,12 +848,14 @@ module Wx
819
848
 
820
849
  # @overload insert_column(col, info)
821
850
  # For report view mode (only), inserts a column.
851
+ #
822
852
  # For more details, see {Wx::ListCtrl#set_item}. Also see InsertColumn(long, const wxString&, int, int) overload for a usually more convenient alternative to this method and the description of how the item width is interpreted by this method.
823
853
  # @param col [Integer]
824
854
  # @param info [Wx::ListItem]
825
855
  # @return [Integer]
826
856
  # @overload insert_column(col, heading, format=Wx::ListColumnFormat::LIST_FORMAT_LEFT, width=Wx::LIST_AUTOSIZE)
827
857
  # For report view mode (only), inserts a column.
858
+ #
828
859
  # Insert a new column in the list control in report view mode at the given position specifying its most common attributes.
829
860
  # Notice that to set the image for the column you need to use InsertColumn(long, const wxListItem&) overload and specify {Wx::LIST_MASK_IMAGE} in the item mask.
830
861
  #
@@ -859,6 +890,7 @@ module Wx
859
890
  def insert_item(*args) end
860
891
 
861
892
  # Returns true if the control doesn't currently contain any items.
893
+ #
862
894
  # Note that the control with some columns is still considered to be empty if it has no rows.
863
895
  # @return [Boolean]
864
896
  def is_empty; end
@@ -870,6 +902,7 @@ module Wx
870
902
  alias_method :virtual?, :is_virtual
871
903
 
872
904
  # Redraws the given item.
905
+ #
873
906
  # This is only useful for the virtual list controls as without calling this function the displayed value of the item doesn't change even when the underlying data does change.
874
907
  # @see Wx::ListCtrl#refresh_items
875
908
  # @param item [Integer]
@@ -877,6 +910,7 @@ module Wx
877
910
  def refresh_item(item) end
878
911
 
879
912
  # Redraws the items between itemFrom and itemTo.
913
+ #
880
914
  # The starting item must be less than or equal to the ending one.
881
915
  # Just as {Wx::ListCtrl#refresh_item} this is only useful for virtual list controls.
882
916
  # @param itemFrom [Integer]
@@ -885,6 +919,7 @@ module Wx
885
919
  def refresh_items(itemFrom, itemTo) end
886
920
 
887
921
  # Scrolls the list control.
922
+ #
888
923
  # If in icon, small icon or report view mode, dx specifies the number of pixels to scroll. If in list view mode, dx specifies the number of columns to scroll. dy always specifies the number of pixels to scroll vertically.
889
924
  #
890
925
  # <div class="wxrb-note">
@@ -898,6 +933,7 @@ module Wx
898
933
  def scroll_list(dx, dy) end
899
934
 
900
935
  # Sets the background colour.
936
+ #
901
937
  # Note that the {Wx::Window#get_background_colour} function of {Wx::Window} base class can be used to retrieve the current background colour.
902
938
  #
903
939
  # <div class="wxrb-note">
@@ -911,6 +947,7 @@ module Wx
911
947
  alias_method :background_colour=, :set_background_colour
912
948
 
913
949
  # Sets information about this column.
950
+ #
914
951
  # See {Wx::ListCtrl#set_item} for more information.
915
952
  # @param col [Integer]
916
953
  # @param item [Wx::ListItem]
@@ -918,6 +955,7 @@ module Wx
918
955
  def set_column(col, item) end
919
956
 
920
957
  # Sets the column width.
958
+ #
921
959
  # width can be a width in pixels or {Wx::LIST_AUTOSIZE} (-1) or {Wx::LIST_AUTOSIZE_USEHEADER} (-2).
922
960
  # {Wx::LIST_AUTOSIZE} will resize the column to the length of its longest item.
923
961
  # {Wx::LIST_AUTOSIZE_USEHEADER} will resize the column to the length of the header (Win32) or 80 pixels (other platforms).
@@ -928,6 +966,7 @@ module Wx
928
966
  def set_column_width(col, width) end
929
967
 
930
968
  # Change the font and the colours used for the list control header.
969
+ #
931
970
  # This method can be used to change the appearance of the header shown by the control in report mode (unless {Wx::LC_NO_HEADER} style is used).
932
971
  # Currently it is implemented only for WXMSW and does nothing in the other ports.
933
972
  #
@@ -938,6 +977,7 @@ module Wx
938
977
  alias_method :header_attr=, :set_header_attr
939
978
 
940
979
  # Sets the image list associated with the control.
980
+ #
941
981
  # Not that it is recommended to use {Wx::ListCtrl#set_normal_images} or {Wx::ListCtrl#set_small_images} instead of this function in the new code.
942
982
  # which must be one of {Wx::IMAGE_LIST_NORMAL}, {Wx::IMAGE_LIST_SMALL}, {Wx::IMAGE_LIST_STATE} (support for the last one is unimplemented).
943
983
  # This method does not take ownership of the image list, you have to delete it yourself.
@@ -949,6 +989,7 @@ module Wx
949
989
  def set_image_list(imageList, which) end
950
990
 
951
991
  # Sets the images to use when showing large, normal icons in this control.
992
+ #
952
993
  # These images are used by the items when the list control is in {Wx::LC_ICON} mode, in all the other modes the images set by {Wx::ListCtrl#set_small_images} are used.
953
994
  # This function should be preferred to calling {Wx::ListCtrl#set_image_list} or {Wx::ListCtrl#assign_image_list} with {Wx::IMAGE_LIST_NORMAL} argument in the new code, as using {Wx::BitmapBundle} makes it possible to specify multiple versions of the icons, allowing the control to choose the right one for the current DPI scaling.
954
995
  # @param images [Array<Wx::ImageBundle>]
@@ -957,6 +998,7 @@ module Wx
957
998
  alias_method :normal_images=, :set_normal_images
958
999
 
959
1000
  # Sets the images to use when showing small icons in this control.
1001
+ #
960
1002
  # These images are used by the items when the list control is in {Wx::LC_SMALL_ICON} or {Wx::LC_REPORT} mode, use {Wx::ListCtrl#set_normal_images} for the icons used in {Wx::LC_ICON} mode.
961
1003
  # This function should be preferred to calling {Wx::ListCtrl#set_image_list} or {Wx::ListCtrl#assign_image_list} with {Wx::IMAGE_LIST_SMALL} argument in the new code, as using {Wx::BitmapBundle} makes it possible to specify multiple versions of the icons, allowing the control to choose the right one for the current DPI scaling.
962
1004
  # @param images [Array<Wx::ImageBundle>]
@@ -965,6 +1007,7 @@ module Wx
965
1007
  alias_method :small_images=, :set_small_images
966
1008
 
967
1009
  # Check if the item is visible.
1010
+ #
968
1011
  # An item is considered visible if at least one pixel of it is present on the screen.
969
1012
  # @param item [Integer]
970
1013
  # @return [Boolean]
@@ -973,12 +1016,14 @@ module Wx
973
1016
 
974
1017
  # @overload set_item(info)
975
1018
  # Sets the data of an item.
1019
+ #
976
1020
  # Using the {Wx::ListItem}'s mask and state mask, you can change only selected attributes of a {Wx::ListCtrl} item.
977
1021
  # true if the item was successfully updated or false if the update failed for some reason (e.g. an invalid item index).
978
1022
  # @param info [Wx::ListItem]
979
1023
  # @return [Boolean]
980
1024
  # @overload set_item(index, column, label, imageId=-1)
981
1025
  # Sets an item string field at a particular column.
1026
+ #
982
1027
  # true if the item was successfully updated or false if the update failed for some reason (e.g. an invalid item index).
983
1028
  # @param index [Integer]
984
1029
  # @param column [Integer]
@@ -989,6 +1034,7 @@ module Wx
989
1034
  alias_method :item=, :set_item
990
1035
 
991
1036
  # Sets the background colour for this item.
1037
+ #
992
1038
  # This function only works in report view mode. The colour can be retrieved using {Wx::ListCtrl#get_item_background_colour}.
993
1039
  # @param item [Integer]
994
1040
  # @param col [Wx::Colour,String,Symbol]
@@ -996,6 +1042,7 @@ module Wx
996
1042
  def set_item_background_colour(item, col) end
997
1043
 
998
1044
  # Sets the image associated with the item.
1045
+ #
999
1046
  # In report view, you can specify the column. The image is an index into the image list associated with the list control.
1000
1047
  # @param item [Integer]
1001
1048
  # @param column [Integer]
@@ -1004,6 +1051,7 @@ module Wx
1004
1051
  def set_item_column_image(item, column, image) end
1005
1052
 
1006
1053
  # This method can only be used with virtual list controls.
1054
+ #
1007
1055
  # It is used to indicate to the control the number of items it contains. After calling it, the main program should be ready to handle calls to various item callbacks (such as {Wx::ListCtrl#on_get_item_text}) for all items in the range from 0 to count.
1008
1056
  # Notice that the control is not necessarily redrawn after this call as it may be undesirable if an item which is not visible on the screen anyhow was added to or removed from a control displaying many items, if you do need to refresh the display you can just call {Wx::ListCtrl#refresh} manually.
1009
1057
  # @param count [Integer]
@@ -1018,6 +1066,7 @@ module Wx
1018
1066
  def set_item_font(item, font) end
1019
1067
 
1020
1068
  # Sets the unselected and selected images associated with the item.
1069
+ #
1021
1070
  # The images are indices into the image list associated with the list control.
1022
1071
  # @param item [Integer]
1023
1072
  # @param image [Integer]
@@ -1026,6 +1075,7 @@ module Wx
1026
1075
  def set_item_image(item, image, selImage=-1) end
1027
1076
 
1028
1077
  # Sets the position of the item, in icon or small icon view.
1078
+ #
1029
1079
  # Windows only.
1030
1080
  # @param item [Integer]
1031
1081
  # @param pos [Array(Integer, Integer), Wx::Point]
@@ -1033,6 +1083,7 @@ module Wx
1033
1083
  def set_item_position(item, pos) end
1034
1084
 
1035
1085
  # Sets the item state.
1086
+ #
1036
1087
  # The stateMask is a combination of {Wx::LIST_STATE_XXX} constants described in {Wx::ListItem} documentation. For each of the bits specified in stateMask, the corresponding state is set or cleared depending on whether state argument contains the same bit or not.
1037
1088
  # So to select an item you can use
1038
1089
  # ```ruby
@@ -1058,6 +1109,7 @@ module Wx
1058
1109
  def set_item_text(item, text) end
1059
1110
 
1060
1111
  # Sets the colour for this item.
1112
+ #
1061
1113
  # This function only works in report view. The colour can be retrieved using {Wx::ListCtrl#get_item_text_colour}.
1062
1114
  # @param item [Integer]
1063
1115
  # @param col [Wx::Colour,String,Symbol]
@@ -1085,12 +1137,14 @@ module Wx
1085
1137
 
1086
1138
  # Returns true if checkboxes are enabled for list items.
1087
1139
  #
1140
+ #
1088
1141
  # @see Wx::ListCtrl#enable_check_boxes
1089
1142
  # @return [Boolean]
1090
1143
  def has_check_boxes; end
1091
1144
  alias_method :has_check_boxes?, :has_check_boxes
1092
1145
 
1093
1146
  # Enable or disable checkboxes for list items.
1147
+ #
1094
1148
  # true if checkboxes are supported, false otherwise.
1095
1149
  #
1096
1150
  # In a list control with {Wx::LC_VIRTUAL} style you have to keep track of the checkbox state. When a checkbox is clicked (EVT_LIST_ITEM_CHECKED or EVT_LIST_ITEM_UNCHECKED) you have to update the state and refresh the item yourself.
@@ -1100,6 +1154,7 @@ module Wx
1100
1154
  def enable_check_boxes(enable=true) end
1101
1155
 
1102
1156
  # Return true if the checkbox for the given {Wx::ListItem} is checked.
1157
+ #
1103
1158
  # Always returns false if checkboxes support hadn't been enabled.
1104
1159
  # For a control with {Wx::LC_VIRTUAL} style, this uses {Wx::ListCtrl#on_get_item_is_checked}.
1105
1160
  # @param item [Integer] Item (zero-based) index.
@@ -1108,6 +1163,7 @@ module Wx
1108
1163
  alias_method :item_checked?, :is_item_checked
1109
1164
 
1110
1165
  # Check or uncheck a {Wx::ListItem} in a control using checkboxes.
1166
+ #
1111
1167
  # This method only works if checkboxes support had been successfully enabled using {Wx::ListCtrl#enable_check_boxes}.
1112
1168
  # For a control with {Wx::LC_VIRTUAL} style, this will only generate the EVT_LIST_ITEM_CHECKED and EVT_LIST_ITEM_UNCHECKED events. See {Wx::ListCtrl#on_get_item_is_checked} for information on how to update the checkbox state.
1113
1169
  # @param item [Integer] Item (zero-based) index.
@@ -1116,6 +1172,7 @@ module Wx
1116
1172
  def check_item(item, check) end
1117
1173
 
1118
1174
  # Extend rules and alternate rows background to the entire client area.
1175
+ #
1119
1176
  # By default, the rules (when enabled with {Wx::LC_HRULES} and {Wx::LC_VRULES}) and alternate row background (when {Wx::ListCtrl#enable_alternate_row_colours} was called) are only shown in the part of the control occupied by the items, which can be smaller than the entire window if there are few items in the control.
1120
1177
  # Calling this function extends the display of the rules and alternate background rows to the entire client area.
1121
1178
  # Similarly to {Wx::ListCtrl#enable_alternate_row_colours}, this method can only be used with controls having {Wx::LC_REPORT} and {Wx::LC_VIRTUAL} styles.
@@ -1125,6 +1182,7 @@ module Wx
1125
1182
  def extend_rules_and_alternate_colour(extend=true) end
1126
1183
 
1127
1184
  # Show the sort indicator of a specific column in a specific direction.
1185
+ #
1128
1186
  # Sort indicators are only shown in report view and in the native WXMSW version override any column icon, i.e. if the sort indicator is shown for a column, no (other) icon is shown.
1129
1187
  # This function should typically be called from EVT_LIST_COL_CLICK handler.
1130
1188
  #
@@ -1143,12 +1201,14 @@ module Wx
1143
1201
  def remove_sort_indicator; end
1144
1202
 
1145
1203
  # Returns the column that shows the sort indicator.
1204
+ #
1146
1205
  # Can return <code>-1</code> if there is no sort indicator currently shown.
1147
1206
  # @return [Integer]
1148
1207
  def get_sort_indicator; end
1149
1208
  alias_method :sort_indicator, :get_sort_indicator
1150
1209
 
1151
1210
  # Returns the new value to use for sort indicator after clicking a column.
1211
+ #
1152
1212
  # This helper function can be useful in the EVT_LIST_COL_CLICK handler when it updates the sort indicator after the user clicked on a column.
1153
1213
  # For example:
1154
1214
  # ```ruby
@@ -1180,6 +1240,7 @@ module Wx
1180
1240
  protected
1181
1241
 
1182
1242
  # This function may be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style.
1243
+ #
1183
1244
  # It should return the attribute for the specified item or NULL to use the default appearance parameters.
1184
1245
  # {Wx::ListCtrl} will not delete the pointer or keep a reference of it. You can return the same {Wx::ItemAttr} pointer for every {Wx::ListCtrl#on_get_item_attr} call.
1185
1246
  # The base class version always returns NULL.
@@ -1193,6 +1254,7 @@ module Wx
1193
1254
  def on_get_item_attr(item) end
1194
1255
 
1195
1256
  # This function may be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style.
1257
+ #
1196
1258
  # It should return the attribute for the for the specified item and column or NULL to use the default appearance parameters.
1197
1259
  # The base class version returns <code>OnGetItemAttr(item)</code>.
1198
1260
  #
@@ -1212,6 +1274,7 @@ module Wx
1212
1274
  def on_get_item_column_attr(item, column) end
1213
1275
 
1214
1276
  # Override this function in the derived class for a control with {Wx::LC_VIRTUAL} and {Wx::LC_REPORT} styles in order to specify the image index for the given line and column.
1277
+ #
1215
1278
  # The base class version always calls {Wx::ListCtrl#on_get_item_image} for the first column, else it returns -1.
1216
1279
  # @see Wx::ListCtrl#on_get_item_text
1217
1280
  # @see Wx::ListCtrl#on_get_item_image
@@ -1223,6 +1286,7 @@ module Wx
1223
1286
  def on_get_item_column_image(item, column) end
1224
1287
 
1225
1288
  # This function must be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style using images.
1289
+ #
1226
1290
  # If the control doesn't use images, i.e. {Wx::ListCtrl#set_normal_images} or {Wx::ListCtrl#set_small_images} hadn't been called, it is not necessary to override it.
1227
1291
  # It should return the index of the items image in the controls image list or -1 for no image.
1228
1292
  # In a control with {Wx::LC_REPORT} style, {Wx::ListCtrl#on_get_item_image} only gets called for the first column of each line.
@@ -1235,6 +1299,7 @@ module Wx
1235
1299
  def on_get_item_image(item) end
1236
1300
 
1237
1301
  # This function <b>must</b> be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style.
1302
+ #
1238
1303
  # It should return the string containing the text of the given column for the specified item.
1239
1304
  # @see Wx::ListCtrl#set_item_count
1240
1305
  # @see Wx::ListCtrl#on_get_item_image
@@ -1246,6 +1311,7 @@ module Wx
1246
1311
  def on_get_item_text(item, column) end
1247
1312
 
1248
1313
  # This function <b>must</b> be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style that uses checkboxes.
1314
+ #
1249
1315
  # It should return whether the checkbox of the specified item is checked.
1250
1316
  # @see Wx::ListCtrl#enable_check_boxes
1251
1317
  # @see Wx::ListCtrl#on_get_item_text
@@ -1256,6 +1322,7 @@ module Wx
1256
1322
  end # ListCtrl
1257
1323
 
1258
1324
  # This class stores information about a {Wx::ListCtrl} item or column.
1325
+ #
1259
1326
  # {Wx::ListItem} is a class which contains information about:
1260
1327
  #
1261
1328
  # - Zero based item position; see {Wx::ListItem#set_id} and {Wx::ListItem#get_id}.
@@ -1292,6 +1359,7 @@ module Wx
1292
1359
  class ListItem < Object
1293
1360
 
1294
1361
  # Sets client data for the item.
1362
+ #
1295
1363
  # Please note that client data is associated with the item and not with subitems.
1296
1364
  # @param data [Object]
1297
1365
  # @return [void]
@@ -1307,6 +1375,7 @@ module Wx
1307
1375
  def clear; end
1308
1376
 
1309
1377
  # Returns the alignment for this item.
1378
+ #
1310
1379
  # Can be one of {Wx::ListColumnFormat::LIST_FORMAT_LEFT}, {Wx::ListColumnFormat::LIST_FORMAT_RIGHT} or {Wx::ListColumnFormat::LIST_FORMAT_CENTRE}.
1311
1380
  # @return [Wx::ListColumnFormat]
1312
1381
  def get_align; end
@@ -1338,6 +1407,7 @@ module Wx
1338
1407
  alias_method :image, :get_image
1339
1408
 
1340
1409
  # Returns a bit mask indicating which fields of the structure are valid.
1410
+ #
1341
1411
  # Can be any combination of the following values:
1342
1412
  #
1343
1413
  # - {Wx::LIST_MASK_STATE}: <b>GetState</b> is valid.
@@ -1351,6 +1421,7 @@ module Wx
1351
1421
  alias_method :mask, :get_mask
1352
1422
 
1353
1423
  # Returns a bit field representing the state of the item.
1424
+ #
1354
1425
  # Can be any combination of:
1355
1426
  #
1356
1427
  # - {Wx::LIST_STATE_DONTCARE}: No special flags (the values of this constant is 0).
@@ -1373,12 +1444,14 @@ module Wx
1373
1444
  alias_method :text_colour, :get_text_colour
1374
1445
 
1375
1446
  # Meaningful only for column headers in report mode.
1447
+ #
1376
1448
  # Returns the column width.
1377
1449
  # @return [Integer]
1378
1450
  def get_width; end
1379
1451
  alias_method :width, :get_width
1380
1452
 
1381
1453
  # Sets the alignment for the item.
1454
+ #
1382
1455
  # See also {Wx::ListItem#get_align}
1383
1456
  # @param align [Wx::ListColumnFormat]
1384
1457
  # @return [void]
@@ -1392,6 +1465,7 @@ module Wx
1392
1465
  alias_method :background_colour=, :set_background_colour
1393
1466
 
1394
1467
  # Sets the zero-based column.
1468
+ #
1395
1469
  # Meaningful only in report mode.
1396
1470
  # @param col [Integer]
1397
1471
  # @return [void]
@@ -1417,6 +1491,7 @@ module Wx
1417
1491
  alias_method :image=, :set_image
1418
1492
 
1419
1493
  # Sets the mask of valid fields.
1494
+ #
1420
1495
  # See {Wx::ListItem#get_mask}.
1421
1496
  # @param mask [Integer]
1422
1497
  # @return [void]
@@ -1424,6 +1499,7 @@ module Wx
1424
1499
  alias_method :mask=, :set_mask
1425
1500
 
1426
1501
  # Sets the item state flags (note that the valid state flags are influenced by the value of the state mask, see {Wx::ListItem#set_state_mask}).
1502
+ #
1427
1503
  # See {Wx::ListItem#get_state} for valid flag values.
1428
1504
  # @param state [Integer]
1429
1505
  # @return [void]
@@ -1431,6 +1507,7 @@ module Wx
1431
1507
  alias_method :state=, :set_state
1432
1508
 
1433
1509
  # Sets the bitmask that is used to determine which of the state flags are to be set.
1510
+ #
1434
1511
  # See also {Wx::ListItem#set_state}.
1435
1512
  # @param stateMask [Integer]
1436
1513
  # @return [void]
@@ -1450,6 +1527,7 @@ module Wx
1450
1527
  alias_method :text_colour=, :set_text_colour
1451
1528
 
1452
1529
  # Meaningful only for column headers in report mode.
1530
+ #
1453
1531
  # Sets the column width.
1454
1532
  # @param width [Integer]
1455
1533
  # @return [void]
@@ -1459,6 +1537,7 @@ module Wx
1459
1537
  end # ListItem
1460
1538
 
1461
1539
  # Represents the attributes (colour, font, ...) of an item of a control with multiple items such as e.g.
1540
+ #
1462
1541
  # {Wx::ListCtrl}.
1463
1542
  #
1464
1543
  # Category: Data Structures
@@ -1506,6 +1585,7 @@ module Wx
1506
1585
 
1507
1586
  # Returns true if either text or background colour is set.
1508
1587
  #
1588
+ #
1509
1589
  # @see Wx::ItemAttr#has_background_colour
1510
1590
  # @see Wx::ItemAttr#has_text_colour
1511
1591
  # @return [Boolean]
@@ -1548,6 +1628,7 @@ module Wx
1548
1628
  end # ItemAttr
1549
1629
 
1550
1630
  # This class currently simply presents a simpler to use interface for the {Wx::ListCtrl} it can be thought of as a façade for that complicated class.
1631
+ #
1551
1632
  # Using it is preferable to using {Wx::ListCtrl} directly whenever possible because in the future some ports might implement {Wx::ListView} but not the full set of {Wx::ListCtrl} features.
1552
1633
  # Other than different interface, this class is identical to {Wx::ListCtrl}. In particular, it uses the same events, same window styles and so on.
1553
1634
  #
@@ -1567,6 +1648,7 @@ module Wx
1567
1648
  # @overload initialize(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::LC_REPORT, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_CTRL_NAME_STR)
1568
1649
  # Constructor, creating and showing a listview control.
1569
1650
  #
1651
+ #
1570
1652
  # @see Wx::ListView#create
1571
1653
  # @see Wx::Validator
1572
1654
  # @param parent [Wx::Window] Parent window. Must not be NULL.
@@ -1581,6 +1663,7 @@ module Wx
1581
1663
 
1582
1664
  # Resets the column image after calling this function, no image will be shown.
1583
1665
  #
1666
+ #
1584
1667
  # @see Wx::ListView#set_column_image
1585
1668
  # @param col [Integer] the column to clear image for
1586
1669
  # @return [void]
@@ -1592,6 +1675,7 @@ module Wx
1592
1675
  def focus(index) end
1593
1676
 
1594
1677
  # Returns the first selected item in a (presumably) multiple selection control.
1678
+ #
1595
1679
  # Together with {Wx::ListView#get_next_selected} it can be used to iterate over all selected items in the control.
1596
1680
  # The first selected item, if any, -1 otherwise.
1597
1681
  # @return [Integer]
@@ -1600,6 +1684,7 @@ module Wx
1600
1684
 
1601
1685
  # Returns the currently focused item or -1 if none.
1602
1686
  #
1687
+ #
1603
1688
  # @see Wx::ListView#is_selected
1604
1689
  # @see Wx::ListView#focus
1605
1690
  # @return [Integer]
@@ -1607,6 +1692,7 @@ module Wx
1607
1692
  alias_method :focused_item, :get_focused_item
1608
1693
 
1609
1694
  # Used together with {Wx::ListView#get_first_selected} to iterate over all selected items in the control.
1695
+ #
1610
1696
  # Returns the next selected item or -1 if there are no more of them.
1611
1697
  # @param item [Integer]
1612
1698
  # @return [Integer]
@@ -1615,6 +1701,7 @@ module Wx
1615
1701
 
1616
1702
  # Returns true if the item with the given index is selected, false otherwise.
1617
1703
  #
1704
+ #
1618
1705
  # @see Wx::ListView#get_first_selected
1619
1706
  # @see Wx::ListView#get_next_selected
1620
1707
  # @param index [Integer]
@@ -1623,6 +1710,7 @@ module Wx
1623
1710
  alias_method :selected?, :is_selected
1624
1711
 
1625
1712
  # Selects or unselects the given item.
1713
+ #
1626
1714
  # Notice that this method inherits the unusual behaviour of {Wx::ListCtrl#set_item_state} which sends a {Wx::EVT_LIST_ITEM_SELECTED} event when it is used to select an item, contrary to the usual rule that only the user actions result in selection.
1627
1715
  # @param n [Integer] the item to select or unselect
1628
1716
  # @param on [Boolean] if true (default), selects the item, otherwise unselects it
@@ -1630,6 +1718,7 @@ module Wx
1630
1718
  def select(n, on=true) end
1631
1719
 
1632
1720
  # Sets the column image for the specified column.
1721
+ #
1633
1722
  # To use the column images, the control must have a valid image list with at least one image.
1634
1723
  # @param col [Integer] the column to set image for
1635
1724
  # @param image [Integer] the index of the column image in the controls image list