wxruby3 0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (837) hide show
  1. checksums.yaml +7 -0
  2. data/.wxconfig +17 -0
  3. data/.yardopts +13 -0
  4. data/CREDITS.md +52 -0
  5. data/LICENSE +21 -0
  6. data/README.md +139 -0
  7. data/bin/wxruby +9 -0
  8. data/bin/wxruby.bat +20 -0
  9. data/ext/mkrf_conf_bingem.rb +18 -0
  10. data/ext/wxbase32u_gcc_custom.dll +0 -0
  11. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  12. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  19. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  20. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  21. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  22. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  23. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  24. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  25. data/lib/wx/accessors.rb +63 -0
  26. data/lib/wx/aui/auimanager.rb +17 -0
  27. data/lib/wx/aui/auinotebook.rb +9 -0
  28. data/lib/wx/aui/events/evt_list.rb +143 -0
  29. data/lib/wx/aui/require.rb +9 -0
  30. data/lib/wx/aui.rb +14 -0
  31. data/lib/wx/core/acceleratortable.rb +28 -0
  32. data/lib/wx/core/animation.rb +18 -0
  33. data/lib/wx/core/app.rb +89 -0
  34. data/lib/wx/core/artprovider.rb +31 -0
  35. data/lib/wx/core/bitmap.rb +59 -0
  36. data/lib/wx/core/busycursor.rb +12 -0
  37. data/lib/wx/core/choice.rb +4 -0
  38. data/lib/wx/core/choicedlg.rb +54 -0
  39. data/lib/wx/core/clientdc.rb +13 -0
  40. data/lib/wx/core/clipboard.rb +56 -0
  41. data/lib/wx/core/collapsible_pane.rb +12 -0
  42. data/lib/wx/core/colour.rb +34 -0
  43. data/lib/wx/core/combobox.rb +4 -0
  44. data/lib/wx/core/controlwithitems.rb +10 -0
  45. data/lib/wx/core/data_object.rb +10 -0
  46. data/lib/wx/core/dataformat.rb +26 -0
  47. data/lib/wx/core/dc.rb +68 -0
  48. data/lib/wx/core/dialog.rb +50 -0
  49. data/lib/wx/core/event.rb +16 -0
  50. data/lib/wx/core/events/evt_list.rb +1378 -0
  51. data/lib/wx/core/evthandler.rb +240 -0
  52. data/lib/wx/core/ext.rb +58 -0
  53. data/lib/wx/core/font/encoding.rb +113 -0
  54. data/lib/wx/core/font.rb +22 -0
  55. data/lib/wx/core/functions.rb +44 -0
  56. data/lib/wx/core/gauge.rb +12 -0
  57. data/lib/wx/core/genericdirctrl.rb +36 -0
  58. data/lib/wx/core/hboxsizer.rb +6 -0
  59. data/lib/wx/core/helpcontroller.rb +5 -0
  60. data/lib/wx/core/helpcontrollerhelpprovider.rb +24 -0
  61. data/lib/wx/core/helpprovider.rb +15 -0
  62. data/lib/wx/core/icon.rb +40 -0
  63. data/lib/wx/core/image.rb +68 -0
  64. data/lib/wx/core/imagelist.rb +3 -0
  65. data/lib/wx/core/listbox.rb +4 -0
  66. data/lib/wx/core/listctrl.rb +33 -0
  67. data/lib/wx/core/locale.rb +73 -0
  68. data/lib/wx/core/log.rb +20 -0
  69. data/lib/wx/core/menu.rb +78 -0
  70. data/lib/wx/core/menu_bar.rb +20 -0
  71. data/lib/wx/core/menuitem.rb +7 -0
  72. data/lib/wx/core/notebook.rb +9 -0
  73. data/lib/wx/core/object.rb +14 -0
  74. data/lib/wx/core/pen_info.rb +11 -0
  75. data/lib/wx/core/platform_info.rb +13 -0
  76. data/lib/wx/core/point.rb +92 -0
  77. data/lib/wx/core/real_point.rb +92 -0
  78. data/lib/wx/core/rect.rb +57 -0
  79. data/lib/wx/core/simplehelpprovider.rb +38 -0
  80. data/lib/wx/core/size.rb +86 -0
  81. data/lib/wx/core/sizer.rb +43 -0
  82. data/lib/wx/core/splash_screen.rb +44 -0
  83. data/lib/wx/core/textctrl.rb +8 -0
  84. data/lib/wx/core/timer.rb +105 -0
  85. data/lib/wx/core/toolbar.rb +37 -0
  86. data/lib/wx/core/toolbartool.rb +4 -0
  87. data/lib/wx/core/treectrl.rb +46 -0
  88. data/lib/wx/core/validator.rb +8 -0
  89. data/lib/wx/core/variant.rb +62 -0
  90. data/lib/wx/core/vboxsizer.rb +6 -0
  91. data/lib/wx/core/window.rb +95 -0
  92. data/lib/wx/core/window_update_locker.rb +12 -0
  93. data/lib/wx/core/xmlresource.rb +56 -0
  94. data/lib/wx/core.rb +61 -0
  95. data/lib/wx/doc/aui/auimanager.rb +12 -0
  96. data/lib/wx/doc/aui/auinotebook.rb +9 -0
  97. data/lib/wx/doc/colour_dialog.rb +15 -0
  98. data/lib/wx/doc/dc.rb +49 -0
  99. data/lib/wx/doc/enum.rb +66 -0
  100. data/lib/wx/doc/evthandler.rb +84 -0
  101. data/lib/wx/doc/extra/00_starting.md +154 -0
  102. data/lib/wx/doc/extra/01_packages.md +179 -0
  103. data/lib/wx/doc/extra/02_lifecycles.md +116 -0
  104. data/lib/wx/doc/extra/03_dialogs.md +57 -0
  105. data/lib/wx/doc/extra/04_enums.md +143 -0
  106. data/lib/wx/doc/extra/05_event-handling.md +166 -0
  107. data/lib/wx/doc/extra/06_geometry.md +56 -0
  108. data/lib/wx/doc/extra/07_colour_and_font.md +52 -0
  109. data/lib/wx/doc/extra/08_extensions.md +144 -0
  110. data/lib/wx/doc/extra/09_exceptions.md +54 -0
  111. data/lib/wx/doc/functions.rb +221 -0
  112. data/lib/wx/doc/gdi_common.rb +181 -0
  113. data/lib/wx/doc/gen/about_dialog_info.rb +315 -0
  114. data/lib/wx/doc/gen/accelerator.rb +172 -0
  115. data/lib/wx/doc/gen/accessible.rb +817 -0
  116. data/lib/wx/doc/gen/animation.rb +253 -0
  117. data/lib/wx/doc/gen/animation_ctrl.rb +129 -0
  118. data/lib/wx/doc/gen/any_button.rb +170 -0
  119. data/lib/wx/doc/gen/app.rb +363 -0
  120. data/lib/wx/doc/gen/art_provider.rb +497 -0
  121. data/lib/wx/doc/gen/aui/aui_dock_art.rb +421 -0
  122. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +39 -0
  123. data/lib/wx/doc/gen/aui/aui_manager.rb +323 -0
  124. data/lib/wx/doc/gen/aui/aui_manager_event.rb +112 -0
  125. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +163 -0
  126. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +46 -0
  127. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +109 -0
  128. data/lib/wx/doc/gen/aui/aui_notebook.rb +329 -0
  129. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +179 -0
  130. data/lib/wx/doc/gen/aui/aui_pane_info.rb +665 -0
  131. data/lib/wx/doc/gen/aui/aui_tab_art.rb +372 -0
  132. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +147 -0
  133. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +437 -0
  134. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +272 -0
  135. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +195 -0
  136. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +224 -0
  137. data/lib/wx/doc/gen/aui/event_list.rb +162 -0
  138. data/lib/wx/doc/gen/auto_buffered_paint_dc.rb +47 -0
  139. data/lib/wx/doc/gen/bitmap.rb +638 -0
  140. data/lib/wx/doc/gen/bitmap_button.rb +91 -0
  141. data/lib/wx/doc/gen/book_ctrl_base.rb +240 -0
  142. data/lib/wx/doc/gen/book_ctrl_event.rb +60 -0
  143. data/lib/wx/doc/gen/box_sizer.rb +66 -0
  144. data/lib/wx/doc/gen/brush.rb +219 -0
  145. data/lib/wx/doc/gen/buffered_dc.rb +95 -0
  146. data/lib/wx/doc/gen/buffered_paint_dc.rb +55 -0
  147. data/lib/wx/doc/gen/busy_info.rb +141 -0
  148. data/lib/wx/doc/gen/button.rb +133 -0
  149. data/lib/wx/doc/gen/calculate_layout_event.rb +59 -0
  150. data/lib/wx/doc/gen/calendar_ctrl.rb +236 -0
  151. data/lib/wx/doc/gen/calendar_date_attr.rb +137 -0
  152. data/lib/wx/doc/gen/calendar_event.rb +150 -0
  153. data/lib/wx/doc/gen/caret.rb +99 -0
  154. data/lib/wx/doc/gen/check_box.rb +145 -0
  155. data/lib/wx/doc/gen/check_list_box.rb +96 -0
  156. data/lib/wx/doc/gen/choice.rb +143 -0
  157. data/lib/wx/doc/gen/choicebook.rb +100 -0
  158. data/lib/wx/doc/gen/client_dc.rb +49 -0
  159. data/lib/wx/doc/gen/clipboard.rb +128 -0
  160. data/lib/wx/doc/gen/collapsible_pane.rb +120 -0
  161. data/lib/wx/doc/gen/collapsible_pane_event.rb +45 -0
  162. data/lib/wx/doc/gen/colour.rb +289 -0
  163. data/lib/wx/doc/gen/colour_data.rb +96 -0
  164. data/lib/wx/doc/gen/colour_dialog.rb +84 -0
  165. data/lib/wx/doc/gen/colour_picker_ctrl.rb +89 -0
  166. data/lib/wx/doc/gen/colour_picker_event.rb +74 -0
  167. data/lib/wx/doc/gen/combo_box.rb +228 -0
  168. data/lib/wx/doc/gen/context_help_button.rb +34 -0
  169. data/lib/wx/doc/gen/control.rb +245 -0
  170. data/lib/wx/doc/gen/control_with_items.rb +339 -0
  171. data/lib/wx/doc/gen/core.rb +42 -0
  172. data/lib/wx/doc/gen/cursor.rb +127 -0
  173. data/lib/wx/doc/gen/data_format.rb +94 -0
  174. data/lib/wx/doc/gen/data_object.rb +439 -0
  175. data/lib/wx/doc/gen/date_event.rb +48 -0
  176. data/lib/wx/doc/gen/date_picker_ctrl.rb +127 -0
  177. data/lib/wx/doc/gen/dc.rb +1278 -0
  178. data/lib/wx/doc/gen/defs.rb +2832 -0
  179. data/lib/wx/doc/gen/dialog.rb +426 -0
  180. data/lib/wx/doc/gen/dir_dialog.rb +134 -0
  181. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +80 -0
  182. data/lib/wx/doc/gen/dir_picker_ctrl.rb +103 -0
  183. data/lib/wx/doc/gen/drag_drop.rb +292 -0
  184. data/lib/wx/doc/gen/drag_image.rb +123 -0
  185. data/lib/wx/doc/gen/editable_list_box.rb +89 -0
  186. data/lib/wx/doc/gen/event.rb +911 -0
  187. data/lib/wx/doc/gen/event_list.rb +1512 -0
  188. data/lib/wx/doc/gen/events.rb +2499 -0
  189. data/lib/wx/doc/gen/evt_handler.rb +224 -0
  190. data/lib/wx/doc/gen/ext_help_controller.rb +100 -0
  191. data/lib/wx/doc/gen/file_dialog.rb +294 -0
  192. data/lib/wx/doc/gen/file_dir_picker_event.rb +98 -0
  193. data/lib/wx/doc/gen/file_picker_ctrl.rb +107 -0
  194. data/lib/wx/doc/gen/find_dialog_event.rb +119 -0
  195. data/lib/wx/doc/gen/find_replace_data.rb +59 -0
  196. data/lib/wx/doc/gen/find_replace_dialog.rb +44 -0
  197. data/lib/wx/doc/gen/flex_grid_sizer.rb +145 -0
  198. data/lib/wx/doc/gen/font.rb +1282 -0
  199. data/lib/wx/doc/gen/font_data.rb +132 -0
  200. data/lib/wx/doc/gen/font_dialog.rb +71 -0
  201. data/lib/wx/doc/gen/font_picker_ctrl.rb +120 -0
  202. data/lib/wx/doc/gen/font_picker_event.rb +64 -0
  203. data/lib/wx/doc/gen/frame.rb +276 -0
  204. data/lib/wx/doc/gen/fs_file.rb +269 -0
  205. data/lib/wx/doc/gen/functions.rb +10 -0
  206. data/lib/wx/doc/gen/gauge.rb +127 -0
  207. data/lib/wx/doc/gen/gb_sizer_item.rb +78 -0
  208. data/lib/wx/doc/gen/gcdc.rb +61 -0
  209. data/lib/wx/doc/gen/gdi_common.rb +1108 -0
  210. data/lib/wx/doc/gen/gdi_object.rb +29 -0
  211. data/lib/wx/doc/gen/generic_dir_ctrl.rb +198 -0
  212. data/lib/wx/doc/gen/graphics_context.rb +764 -0
  213. data/lib/wx/doc/gen/graphics_object.rb +494 -0
  214. data/lib/wx/doc/gen/grid/event_list.rb +173 -0
  215. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +33 -0
  216. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +279 -0
  217. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +31 -0
  218. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +32 -0
  219. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +44 -0
  220. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +31 -0
  221. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +48 -0
  222. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +33 -0
  223. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +40 -0
  224. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +35 -0
  225. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +181 -0
  226. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +34 -0
  227. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +39 -0
  228. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +41 -0
  229. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +74 -0
  230. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +41 -0
  231. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +31 -0
  232. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +98 -0
  233. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +31 -0
  234. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +45 -0
  235. data/lib/wx/doc/gen/grid/grid_ctrl.rb +2381 -0
  236. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +87 -0
  237. data/lib/wx/doc/gen/grid/grid_event.rb +96 -0
  238. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +96 -0
  239. data/lib/wx/doc/gen/grid/grid_size_event.rb +71 -0
  240. data/lib/wx/doc/gen/grid/grid_string_table.rb +130 -0
  241. data/lib/wx/doc/gen/grid/grid_table_base.rb +288 -0
  242. data/lib/wx/doc/gen/grid/grid_table_message.rb +73 -0
  243. data/lib/wx/doc/gen/grid_bag_sizer.rb +298 -0
  244. data/lib/wx/doc/gen/grid_sizer.rb +135 -0
  245. data/lib/wx/doc/gen/help_controller.rb +136 -0
  246. data/lib/wx/doc/gen/help_provider.rb +80 -0
  247. data/lib/wx/doc/gen/html/event_list.rb +46 -0
  248. data/lib/wx/doc/gen/html/html_cell.rb +441 -0
  249. data/lib/wx/doc/gen/html/html_cell_event.rb +62 -0
  250. data/lib/wx/doc/gen/html/html_easy_printing.rb +169 -0
  251. data/lib/wx/doc/gen/html/html_help_controller.rb +256 -0
  252. data/lib/wx/doc/gen/html/html_help_data.rb +144 -0
  253. data/lib/wx/doc/gen/html/html_help_frame.rb +112 -0
  254. data/lib/wx/doc/gen/html/html_help_window.rb +230 -0
  255. data/lib/wx/doc/gen/html/html_link_event.rb +36 -0
  256. data/lib/wx/doc/gen/html/html_list_box.rb +150 -0
  257. data/lib/wx/doc/gen/html/html_printout.rb +87 -0
  258. data/lib/wx/doc/gen/html/html_window.rb +386 -0
  259. data/lib/wx/doc/gen/icon.rb +267 -0
  260. data/lib/wx/doc/gen/icon_location.rb +38 -0
  261. data/lib/wx/doc/gen/image.rb +1144 -0
  262. data/lib/wx/doc/gen/image_list.rb +181 -0
  263. data/lib/wx/doc/gen/keyboard_state.rb +124 -0
  264. data/lib/wx/doc/gen/list_box.rb +260 -0
  265. data/lib/wx/doc/gen/list_ctrl.rb +1542 -0
  266. data/lib/wx/doc/gen/list_event.rb +177 -0
  267. data/lib/wx/doc/gen/listbook.rb +100 -0
  268. data/lib/wx/doc/gen/locale.rb +4143 -0
  269. data/lib/wx/doc/gen/log.rb +505 -0
  270. data/lib/wx/doc/gen/mdi_client_window.rb +38 -0
  271. data/lib/wx/doc/gen/mdi_frame.rb +235 -0
  272. data/lib/wx/doc/gen/media_ctrl.rb +225 -0
  273. data/lib/wx/doc/gen/media_event.rb +109 -0
  274. data/lib/wx/doc/gen/memory_dc.rb +95 -0
  275. data/lib/wx/doc/gen/menu.rb +493 -0
  276. data/lib/wx/doc/gen/menu_bar.rb +247 -0
  277. data/lib/wx/doc/gen/menu_item.rb +333 -0
  278. data/lib/wx/doc/gen/message_dialog.rb +195 -0
  279. data/lib/wx/doc/gen/mini_frame.rb +72 -0
  280. data/lib/wx/doc/gen/mirror_dc.rb +29 -0
  281. data/lib/wx/doc/gen/mouse_state.rb +108 -0
  282. data/lib/wx/doc/gen/multi_choice_dialog.rb +58 -0
  283. data/lib/wx/doc/gen/non_owned_window.rb +46 -0
  284. data/lib/wx/doc/gen/notebook.rb +220 -0
  285. data/lib/wx/doc/gen/number_entry_dialog.rb +75 -0
  286. data/lib/wx/doc/gen/object.rb +69 -0
  287. data/lib/wx/doc/gen/paint_dc.rb +34 -0
  288. data/lib/wx/doc/gen/palette.rb +90 -0
  289. data/lib/wx/doc/gen/panel.rb +96 -0
  290. data/lib/wx/doc/gen/pen.rb +484 -0
  291. data/lib/wx/doc/gen/pg/event_list.rb +102 -0
  292. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +47 -0
  293. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +295 -0
  294. data/lib/wx/doc/gen/pg/pg_cell.rb +166 -0
  295. data/lib/wx/doc/gen/pg/pg_editor.rb +569 -0
  296. data/lib/wx/doc/gen/pg/pg_multi_button.rb +161 -0
  297. data/lib/wx/doc/gen/pg/pg_properties.rb +2193 -0
  298. data/lib/wx/doc/gen/pg/pg_property.rb +1852 -0
  299. data/lib/wx/doc/gen/pg/pg_validation_info.rb +327 -0
  300. data/lib/wx/doc/gen/pg/property_grid.rb +619 -0
  301. data/lib/wx/doc/gen/pg/property_grid_event.rb +135 -0
  302. data/lib/wx/doc/gen/pg/property_grid_interface.rb +847 -0
  303. data/lib/wx/doc/gen/pg/property_grid_manager.rb +349 -0
  304. data/lib/wx/doc/gen/pg/property_grid_page.rb +265 -0
  305. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +155 -0
  306. data/lib/wx/doc/gen/picker_base.rb +143 -0
  307. data/lib/wx/doc/gen/platform_info.rb +379 -0
  308. data/lib/wx/doc/gen/popup_window.rb +93 -0
  309. data/lib/wx/doc/gen/progress_dialog.rb +106 -0
  310. data/lib/wx/doc/gen/property_sheet_dialog.rb +185 -0
  311. data/lib/wx/doc/gen/prt/event_list.rb +13 -0
  312. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +38 -0
  313. data/lib/wx/doc/gen/prt/post_script_dc.rb +32 -0
  314. data/lib/wx/doc/gen/prt/preview_frame.rb +39 -0
  315. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +127 -0
  316. data/lib/wx/doc/gen/prt/print_data.rb +598 -0
  317. data/lib/wx/doc/gen/prt/print_dialog.rb +47 -0
  318. data/lib/wx/doc/gen/prt/printer.rb +428 -0
  319. data/lib/wx/doc/gen/prt/printer_dc.rb +35 -0
  320. data/lib/wx/doc/gen/query_layout_info_event.rb +98 -0
  321. data/lib/wx/doc/gen/radio_box.rb +258 -0
  322. data/lib/wx/doc/gen/radio_button.rb +128 -0
  323. data/lib/wx/doc/gen/rbn/event_list.rb +132 -0
  324. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +1652 -0
  325. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +227 -0
  326. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +40 -0
  327. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +400 -0
  328. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +58 -0
  329. data/lib/wx/doc/gen/rbn/ribbon_control.rb +116 -0
  330. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +208 -0
  331. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +51 -0
  332. data/lib/wx/doc/gen/rbn/ribbon_page.rb +129 -0
  333. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +232 -0
  334. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +41 -0
  335. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +321 -0
  336. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +36 -0
  337. data/lib/wx/doc/gen/region.rb +299 -0
  338. data/lib/wx/doc/gen/rtc/event_list.rb +121 -0
  339. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +2052 -0
  340. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +2031 -0
  341. data/lib/wx/doc/gen/rtc/rich_text_event.rb +146 -0
  342. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +171 -0
  343. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +180 -0
  344. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +104 -0
  345. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +241 -0
  346. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +55 -0
  347. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +153 -0
  348. data/lib/wx/doc/gen/sash_event.rb +133 -0
  349. data/lib/wx/doc/gen/sash_layout_window.rb +203 -0
  350. data/lib/wx/doc/gen/sash_window.rb +154 -0
  351. data/lib/wx/doc/gen/screen_dc.rb +27 -0
  352. data/lib/wx/doc/gen/scrolled_canvas.rb +317 -0
  353. data/lib/wx/doc/gen/scrolled_control.rb +317 -0
  354. data/lib/wx/doc/gen/scrolled_window.rb +337 -0
  355. data/lib/wx/doc/gen/simplebook.rb +93 -0
  356. data/lib/wx/doc/gen/single_choice_dialog.rb +74 -0
  357. data/lib/wx/doc/gen/sizer.rb +847 -0
  358. data/lib/wx/doc/gen/sizer_item.rb +227 -0
  359. data/lib/wx/doc/gen/slider.rb +316 -0
  360. data/lib/wx/doc/gen/spin_button.rb +124 -0
  361. data/lib/wx/doc/gen/spin_ctrl.rb +170 -0
  362. data/lib/wx/doc/gen/spin_event.rb +47 -0
  363. data/lib/wx/doc/gen/splash_screen.rb +83 -0
  364. data/lib/wx/doc/gen/splitter_event.rb +87 -0
  365. data/lib/wx/doc/gen/splitter_window.rb +357 -0
  366. data/lib/wx/doc/gen/static_bitmap.rb +126 -0
  367. data/lib/wx/doc/gen/static_box.rb +123 -0
  368. data/lib/wx/doc/gen/static_box_sizer.rb +67 -0
  369. data/lib/wx/doc/gen/static_line.rb +66 -0
  370. data/lib/wx/doc/gen/static_text.rb +98 -0
  371. data/lib/wx/doc/gen/status_bar.rb +203 -0
  372. data/lib/wx/doc/gen/stc/event_list.rb +217 -0
  373. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +4000 -0
  374. data/lib/wx/doc/gen/stc/styled_text_event.rb +7319 -0
  375. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +74 -0
  376. data/lib/wx/doc/gen/svg_file_dc.rb +153 -0
  377. data/lib/wx/doc/gen/system_options.rb +109 -0
  378. data/lib/wx/doc/gen/system_settings.rb +481 -0
  379. data/lib/wx/doc/gen/task_bar_icon.rb +94 -0
  380. data/lib/wx/doc/gen/task_bar_icon_event.rb +86 -0
  381. data/lib/wx/doc/gen/text_attr.rb +645 -0
  382. data/lib/wx/doc/gen/text_ctrl.rb +841 -0
  383. data/lib/wx/doc/gen/text_entry.rb +389 -0
  384. data/lib/wx/doc/gen/text_entry_dialog.rb +170 -0
  385. data/lib/wx/doc/gen/text_validator.rb +212 -0
  386. data/lib/wx/doc/gen/time_picker_ctrl.rb +103 -0
  387. data/lib/wx/doc/gen/timer.rb +103 -0
  388. data/lib/wx/doc/gen/timer_event.rb +73 -0
  389. data/lib/wx/doc/gen/tip_provider.rb +60 -0
  390. data/lib/wx/doc/gen/toggle_button.rb +84 -0
  391. data/lib/wx/doc/gen/tool_bar.rb +744 -0
  392. data/lib/wx/doc/gen/tool_tip.rb +73 -0
  393. data/lib/wx/doc/gen/toolbook.rb +103 -0
  394. data/lib/wx/doc/gen/top_level_window.rb +462 -0
  395. data/lib/wx/doc/gen/tree_ctrl.rb +863 -0
  396. data/lib/wx/doc/gen/tree_event.rb +101 -0
  397. data/lib/wx/doc/gen/treebook.rb +154 -0
  398. data/lib/wx/doc/gen/utils.rb +257 -0
  399. data/lib/wx/doc/gen/v_list_box.rb +224 -0
  400. data/lib/wx/doc/gen/v_scrolled_window.rb +224 -0
  401. data/lib/wx/doc/gen/validator.rb +73 -0
  402. data/lib/wx/doc/gen/variant.rb +340 -0
  403. data/lib/wx/doc/gen/window.rb +2414 -0
  404. data/lib/wx/doc/gen/window_dc.rb +35 -0
  405. data/lib/wx/doc/gen/window_disabler.rb +24 -0
  406. data/lib/wx/doc/gen/with_images.rb +73 -0
  407. data/lib/wx/doc/gen/wizard.rb +197 -0
  408. data/lib/wx/doc/gen/wizard_event.rb +105 -0
  409. data/lib/wx/doc/gen/wizard_page.rb +61 -0
  410. data/lib/wx/doc/gen/wizard_page_simple.rb +72 -0
  411. data/lib/wx/doc/gen/xml_node.rb +282 -0
  412. data/lib/wx/doc/gen/xml_resource.rb +304 -0
  413. data/lib/wx/doc/grid/grid.rb +20 -0
  414. data/lib/wx/doc/help_controller.rb +14 -0
  415. data/lib/wx/doc/html/html_help_controller.rb +8 -0
  416. data/lib/wx/doc/pg/events.rb +15 -0
  417. data/lib/wx/doc/pg/pg_property.rb +8 -0
  418. data/lib/wx/doc/pg/pgeditor.rb +21 -0
  419. data/lib/wx/doc/pg/property_grid.rb +48 -0
  420. data/lib/wx/doc/pg/property_grid_interface.rb +64 -0
  421. data/lib/wx/doc/prt/page_setup_dialog.rb +15 -0
  422. data/lib/wx/doc/prt/print_data.rb +9 -0
  423. data/lib/wx/doc/prt/print_dialog.rb +26 -0
  424. data/lib/wx/doc/prt/printer.rb +15 -0
  425. data/lib/wx/doc/rbn/ribbon_bar.rb +9 -0
  426. data/lib/wx/doc/rbn/ribbon_button_bar.rb +9 -0
  427. data/lib/wx/doc/rbn/ribbon_gallery.rb +9 -0
  428. data/lib/wx/doc/rbn/ribbon_tool_bar.rb +9 -0
  429. data/lib/wx/doc/rtc/richtext_printing.rb +14 -0
  430. data/lib/wx/doc/screen_dc.rb +10 -0
  431. data/lib/wx/doc/stock_objects.rb +98 -0
  432. data/lib/wx/doc/stream.rb +38 -0
  433. data/lib/wx/doc/system_settings.rb +29 -0
  434. data/lib/wx/doc/treebook.rb +9 -0
  435. data/lib/wx/doc/variant.rb +163 -0
  436. data/lib/wx/doc/xml_resource.rb +19 -0
  437. data/lib/wx/global_const.rb +84 -0
  438. data/lib/wx/grid/events/evt_list.rb +156 -0
  439. data/lib/wx/grid/grid.rb +7 -0
  440. data/lib/wx/grid/keyword_defs.rb +10 -0
  441. data/lib/wx/grid/require.rb +9 -0
  442. data/lib/wx/grid.rb +14 -0
  443. data/lib/wx/helpers.rb +65 -0
  444. data/lib/wx/html/events/evt_list.rb +37 -0
  445. data/lib/wx/html/htmlhelpcontroller.rb +6 -0
  446. data/lib/wx/html/htmlwindow.rb +19 -0
  447. data/lib/wx/html/keyword_defs.rb +22 -0
  448. data/lib/wx/html/require.rb +10 -0
  449. data/lib/wx/html.rb +15 -0
  450. data/lib/wx/keyword_ctors.rb +226 -0
  451. data/lib/wx/keyword_defs.rb +487 -0
  452. data/lib/wx/pg/events/evt_list.rb +73 -0
  453. data/lib/wx/pg/events.rb +14 -0
  454. data/lib/wx/pg/keyword_defs.rb +15 -0
  455. data/lib/wx/pg/pg_editor.rb +13 -0
  456. data/lib/wx/pg/pg_properties.rb +24 -0
  457. data/lib/wx/pg/pg_property.rb +26 -0
  458. data/lib/wx/pg/property_grid.rb +56 -0
  459. data/lib/wx/pg/property_grid_interface.rb +33 -0
  460. data/lib/wx/pg/require.rb +12 -0
  461. data/lib/wx/pg.rb +14 -0
  462. data/lib/wx/prt/keyword_defs.rb +8 -0
  463. data/lib/wx/prt/page_setup_dialog.rb +15 -0
  464. data/lib/wx/prt/previewframe.rb +13 -0
  465. data/lib/wx/prt/require.rb +8 -0
  466. data/lib/wx/prt.rb +14 -0
  467. data/lib/wx/rbn/events/evt_list.rb +102 -0
  468. data/lib/wx/rbn/events.rb +4 -0
  469. data/lib/wx/rbn/keyword_defs.rb +43 -0
  470. data/lib/wx/rbn/require.rb +12 -0
  471. data/lib/wx/rbn/ribbon_art_provider.rb +10 -0
  472. data/lib/wx/rbn/ribbon_bar.rb +12 -0
  473. data/lib/wx/rbn/ribbon_button_bar.rb +26 -0
  474. data/lib/wx/rbn/ribbon_control.rb +25 -0
  475. data/lib/wx/rbn/ribbon_gallery.rb +26 -0
  476. data/lib/wx/rbn/ribbon_page.rb +15 -0
  477. data/lib/wx/rbn/ribbon_panel.rb +15 -0
  478. data/lib/wx/rbn/ribbon_tool_bar.rb +26 -0
  479. data/lib/wx/rbn.rb +14 -0
  480. data/lib/wx/rtc/events/evt_list.rb +98 -0
  481. data/lib/wx/rtc/ext/rich_text_ctrl.rb +24 -0
  482. data/lib/wx/rtc/ext.rb +15 -0
  483. data/lib/wx/rtc/keyword_defs.rb +17 -0
  484. data/lib/wx/rtc/require.rb +8 -0
  485. data/lib/wx/rtc.rb +15 -0
  486. data/lib/wx/stc/events/evt_list.rb +178 -0
  487. data/lib/wx/stc/keyword_defs.rb +8 -0
  488. data/lib/wx/stc/require.rb +7 -0
  489. data/lib/wx/stc.rb +14 -0
  490. data/lib/wx/version.rb +3 -0
  491. data/lib/wx/wxruby/base.rb +87 -0
  492. data/lib/wx/wxruby/cmd/sampler.rb +68 -0
  493. data/lib/wx/wxruby/cmd/test.rb +27 -0
  494. data/lib/wx.rb +14 -0
  495. data/lib/wxruby_aui.so +0 -0
  496. data/lib/wxruby_core.so +0 -0
  497. data/lib/wxruby_grid.so +0 -0
  498. data/lib/wxruby_html.so +0 -0
  499. data/lib/wxruby_pg.so +0 -0
  500. data/lib/wxruby_prt.so +0 -0
  501. data/lib/wxruby_rbn.so +0 -0
  502. data/lib/wxruby_rtc.so +0 -0
  503. data/lib/wxruby_stc.so +0 -0
  504. data/rakelib/install.rb +220 -0
  505. data/rakelib/lib/config/cygwin.rb +6 -0
  506. data/rakelib/lib/config/linux.rb +78 -0
  507. data/rakelib/lib/config/macosx.rb +6 -0
  508. data/rakelib/lib/config/mingw.rb +133 -0
  509. data/rakelib/lib/config/netbsd.rb +6 -0
  510. data/rakelib/lib/config/unixish.rb +187 -0
  511. data/rakelib/lib/config.rb +673 -0
  512. data/rakelib/lib/ext/enum_chain.rb +22 -0
  513. data/rakelib/prepost.rake +91 -0
  514. data/rakelib/prepost.rb +26 -0
  515. data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css +7 -0
  516. data/rakelib/yard/templates/default/layout/html/setup.rb +5 -0
  517. data/rakelib/yard/yard/relative_markdown_links/version.rb +8 -0
  518. data/rakelib/yard/yard/relative_markdown_links.rb +39 -0
  519. data/rakelib/yard/yard-custom-templates.rb +2 -0
  520. data/rakelib/yard/yard-relative_markdown_links.rb +4 -0
  521. data/samples/art/wxruby-128x128.png +0 -0
  522. data/samples/art/wxruby-256x256.png +0 -0
  523. data/samples/art/wxruby-64x64.png +0 -0
  524. data/samples/art/wxruby.ico +0 -0
  525. data/samples/art/wxruby.png +0 -0
  526. data/samples/aui/aui.rb +1321 -0
  527. data/samples/aui/tn_aui.png +0 -0
  528. data/samples/bigdemo/About.rbw +39 -0
  529. data/samples/bigdemo/ColorPanel.rbw +23 -0
  530. data/samples/bigdemo/GridSimple.rbw +78 -0
  531. data/samples/bigdemo/MDIDemo.rbw +57 -0
  532. data/samples/bigdemo/PopupMenu.rbw +146 -0
  533. data/samples/bigdemo/ShapedWindow.rbw +128 -0
  534. data/samples/bigdemo/Sizers.rbw +541 -0
  535. data/samples/bigdemo/bigdemo.rb +810 -0
  536. data/samples/bigdemo/demoTemplate.rbw +33 -0
  537. data/samples/bigdemo/helpfile.htb +0 -0
  538. data/samples/bigdemo/icons/Test 015.jpg +0 -0
  539. data/samples/bigdemo/icons/Test 015.png +0 -0
  540. data/samples/bigdemo/icons/choice.bmp +0 -0
  541. data/samples/bigdemo/icons/choice.xpm +27 -0
  542. data/samples/bigdemo/icons/combo.bmp +0 -0
  543. data/samples/bigdemo/icons/combo.xpm +27 -0
  544. data/samples/bigdemo/icons/copy.xpm +25 -0
  545. data/samples/bigdemo/icons/cut.xpm +24 -0
  546. data/samples/bigdemo/icons/gauge.bmp +0 -0
  547. data/samples/bigdemo/icons/gauge.xpm +27 -0
  548. data/samples/bigdemo/icons/help.xpm +25 -0
  549. data/samples/bigdemo/icons/list.bmp +0 -0
  550. data/samples/bigdemo/icons/list.xpm +27 -0
  551. data/samples/bigdemo/icons/mondrian.ico +0 -0
  552. data/samples/bigdemo/icons/mondrian.xpm +44 -0
  553. data/samples/bigdemo/icons/new.xpm +24 -0
  554. data/samples/bigdemo/icons/ogl.ico +0 -0
  555. data/samples/bigdemo/icons/ogl.xpm +45 -0
  556. data/samples/bigdemo/icons/open.xpm +26 -0
  557. data/samples/bigdemo/icons/paste.bmp +0 -0
  558. data/samples/bigdemo/icons/paste.xpm +38 -0
  559. data/samples/bigdemo/icons/pointy.png +0 -0
  560. data/samples/bigdemo/icons/preview.xpm +26 -0
  561. data/samples/bigdemo/icons/print.xpm +26 -0
  562. data/samples/bigdemo/icons/radio.bmp +0 -0
  563. data/samples/bigdemo/icons/radio.xpm +27 -0
  564. data/samples/bigdemo/icons/robert.xpm +415 -0
  565. data/samples/bigdemo/icons/sashtest.ico +0 -0
  566. data/samples/bigdemo/icons/save.xpm +25 -0
  567. data/samples/bigdemo/icons/smiles.bmp +0 -0
  568. data/samples/bigdemo/icons/smiles.xpm +39 -0
  569. data/samples/bigdemo/icons/smiley.ico +0 -0
  570. data/samples/bigdemo/icons/smiley.xpm +42 -0
  571. data/samples/bigdemo/icons/stattext.xpm +24 -0
  572. data/samples/bigdemo/icons/test2.bmp +0 -0
  573. data/samples/bigdemo/icons/test2.png +0 -0
  574. data/samples/bigdemo/icons/test2.xpm +79 -0
  575. data/samples/bigdemo/icons/text.bmp +0 -0
  576. data/samples/bigdemo/icons/text.xpm +27 -0
  577. data/samples/bigdemo/icons/tog1.bmp +0 -0
  578. data/samples/bigdemo/icons/tog1.xpm +38 -0
  579. data/samples/bigdemo/icons/tog2.bmp +0 -0
  580. data/samples/bigdemo/icons/tog2.xpm +38 -0
  581. data/samples/bigdemo/icons/wxruby-128x128.png +0 -0
  582. data/samples/bigdemo/icons/wxwin.ico +0 -0
  583. data/samples/bigdemo/icons/wxwin16x16.png +0 -0
  584. data/samples/bigdemo/icons/wxwin16x16.xpm +25 -0
  585. data/samples/bigdemo/icons/wxwin32x32.png +0 -0
  586. data/samples/bigdemo/icons/wxwin48x48.png +0 -0
  587. data/samples/bigdemo/run.rb +91 -0
  588. data/samples/bigdemo/tips.txt +7 -0
  589. data/samples/bigdemo/utils.rb +12 -0
  590. data/samples/bigdemo/wxArtProvider.rbw +281 -0
  591. data/samples/bigdemo/wxBitmapButton.rbw +65 -0
  592. data/samples/bigdemo/wxButton.rbw +64 -0
  593. data/samples/bigdemo/wxCalendarCtrl.rbw +59 -0
  594. data/samples/bigdemo/wxCheckBox.rbw +50 -0
  595. data/samples/bigdemo/wxCheckListBox.rbw +65 -0
  596. data/samples/bigdemo/wxChoice.rbw +47 -0
  597. data/samples/bigdemo/wxChoicebook.rbw +78 -0
  598. data/samples/bigdemo/wxColourDialog.rbw +33 -0
  599. data/samples/bigdemo/wxComboBox.rbw +77 -0
  600. data/samples/bigdemo/wxCursor.rbw +136 -0
  601. data/samples/bigdemo/wxDialog.rbw +74 -0
  602. data/samples/bigdemo/wxDirDialog.rbw +29 -0
  603. data/samples/bigdemo/wxDragImage.rbw +70 -0
  604. data/samples/bigdemo/wxFileDialog.rbw +37 -0
  605. data/samples/bigdemo/wxFileDialog_Save.rbw +35 -0
  606. data/samples/bigdemo/wxFindReplaceDialog.rbw +82 -0
  607. data/samples/bigdemo/wxFontDialog.rbw +200 -0
  608. data/samples/bigdemo/wxFrame.rbw +53 -0
  609. data/samples/bigdemo/wxGauge.rbw +65 -0
  610. data/samples/bigdemo/wxGenericDirCtrl.rbw +74 -0
  611. data/samples/bigdemo/wxGrid.rbw +66 -0
  612. data/samples/bigdemo/wxHtmlHelpController.rbw +52 -0
  613. data/samples/bigdemo/wxListBox.rbw +140 -0
  614. data/samples/bigdemo/wxListCtrl_virtual.rbw +112 -0
  615. data/samples/bigdemo/wxMDIWindows.rbw +50 -0
  616. data/samples/bigdemo/wxMenu.rbw +247 -0
  617. data/samples/bigdemo/wxMessageDialog.rbw +27 -0
  618. data/samples/bigdemo/wxMiniFrame.rbw +70 -0
  619. data/samples/bigdemo/wxMultipleChoiceDialog.rbw +29 -0
  620. data/samples/bigdemo/wxNotebook.rbw +136 -0
  621. data/samples/bigdemo/wxProgressDialog.rbw +43 -0
  622. data/samples/bigdemo/wxRadioBox.rbw +72 -0
  623. data/samples/bigdemo/wxRadioButton.rbw +125 -0
  624. data/samples/bigdemo/wxSashWindow.rbw +141 -0
  625. data/samples/bigdemo/wxScrolledMessageDialog.rbw +57 -0
  626. data/samples/bigdemo/wxScrolledWindow.rbw +199 -0
  627. data/samples/bigdemo/wxSingleChoiceDialog.rbw +33 -0
  628. data/samples/bigdemo/wxSlider.rbw +42 -0
  629. data/samples/bigdemo/wxSpinButton.rbw +50 -0
  630. data/samples/bigdemo/wxSpinCtrl.rbw +51 -0
  631. data/samples/bigdemo/wxSplitterWindow.rbw +63 -0
  632. data/samples/bigdemo/wxStaticBitmap.rbw +47 -0
  633. data/samples/bigdemo/wxStaticText.rbw +55 -0
  634. data/samples/bigdemo/wxStatusBar.rbw +126 -0
  635. data/samples/bigdemo/wxTextCtrl.rbw +149 -0
  636. data/samples/bigdemo/wxTextEntryDialog.rbw +31 -0
  637. data/samples/bigdemo/wxToggleButton.rbw +49 -0
  638. data/samples/bigdemo/wxToolBar.rbw +131 -0
  639. data/samples/bigdemo/wxTreeCtrl.rbw +191 -0
  640. data/samples/calendar/calendar.rb +363 -0
  641. data/samples/calendar/tn_calendar.png +0 -0
  642. data/samples/caret/caret.rb +293 -0
  643. data/samples/caret/mondrian.xpm +44 -0
  644. data/samples/caret/tn_caret.png +0 -0
  645. data/samples/controls/books.rb +183 -0
  646. data/samples/controls/controls.rb +1143 -0
  647. data/samples/controls/get_item_sample.rb +117 -0
  648. data/samples/controls/icons/choice.xpm +27 -0
  649. data/samples/controls/icons/combo.xpm +27 -0
  650. data/samples/controls/icons/gauge.xpm +27 -0
  651. data/samples/controls/icons/list.xpm +27 -0
  652. data/samples/controls/icons/radio.xpm +27 -0
  653. data/samples/controls/icons/stattext.xpm +24 -0
  654. data/samples/controls/icons/text.xpm +27 -0
  655. data/samples/controls/mondrian.ico +0 -0
  656. data/samples/controls/mondrian.xpm +44 -0
  657. data/samples/controls/test2.bmp +0 -0
  658. data/samples/controls/tn_books.png +0 -0
  659. data/samples/controls/tn_controls.png +0 -0
  660. data/samples/controls/tn_get_item_sample.png +0 -0
  661. data/samples/dialogs/dialogs.rb +879 -0
  662. data/samples/dialogs/tips.txt +18 -0
  663. data/samples/dialogs/tn_dialogs.png +0 -0
  664. data/samples/dialogs/tn_wizard.png +0 -0
  665. data/samples/dialogs/wizard.rb +89 -0
  666. data/samples/dragdrop/dragdrop.rb +200 -0
  667. data/samples/dragdrop/tn_dragdrop.png +0 -0
  668. data/samples/drawing/SVGlogo24.xpm +310 -0
  669. data/samples/drawing/bitmap.rb +76 -0
  670. data/samples/drawing/bitmap_image.rb +131 -0
  671. data/samples/drawing/graphics_drawing.rb +257 -0
  672. data/samples/drawing/maths_images.rb +327 -0
  673. data/samples/drawing/rmagic_bitmap_image.rb +139 -0
  674. data/samples/drawing/ruby-logo.jpg +0 -0
  675. data/samples/drawing/svgtest.rb +373 -0
  676. data/samples/drawing/tn_bitmap.png +0 -0
  677. data/samples/drawing/tn_bitmap_image.png +0 -0
  678. data/samples/drawing/tn_graphics_drawing.png +0 -0
  679. data/samples/drawing/tn_maths_images.png +0 -0
  680. data/samples/drawing/tn_rmagic_bitmap_image.png +0 -0
  681. data/samples/drawing/tn_svgtest.png +0 -0
  682. data/samples/etc/choice.rb +82 -0
  683. data/samples/etc/miniframe.rb +92 -0
  684. data/samples/etc/sash.rb +140 -0
  685. data/samples/etc/scrollwin.rb +120 -0
  686. data/samples/etc/system_settings.rb +263 -0
  687. data/samples/etc/tn_choice.png +0 -0
  688. data/samples/etc/tn_miniframe.png +0 -0
  689. data/samples/etc/tn_sash.png +0 -0
  690. data/samples/etc/tn_scrollwin.png +0 -0
  691. data/samples/etc/tn_system_settings.png +0 -0
  692. data/samples/event/activation.rb +129 -0
  693. data/samples/event/event.rb +220 -0
  694. data/samples/event/threaded.rb +141 -0
  695. data/samples/event/tn_activation.png +0 -0
  696. data/samples/event/tn_event.png +0 -0
  697. data/samples/event/tn_threaded.png +0 -0
  698. data/samples/event/tn_update_ui_event.png +0 -0
  699. data/samples/event/update_ui_event.rb +91 -0
  700. data/samples/grid/grid.rb +224 -0
  701. data/samples/grid/gridtablebase.rb +178 -0
  702. data/samples/grid/tn_grid.png +0 -0
  703. data/samples/grid/tn_gridtablebase.png +0 -0
  704. data/samples/html/8859_2.htm +14 -0
  705. data/samples/html/cp1250.htm +19 -0
  706. data/samples/html/foo.png +0 -0
  707. data/samples/html/html.rb +278 -0
  708. data/samples/html/i18n.gif +0 -0
  709. data/samples/html/imagemap.htm +20 -0
  710. data/samples/html/imagemap.png +0 -0
  711. data/samples/html/listtest.htm +28 -0
  712. data/samples/html/pic.png +0 -0
  713. data/samples/html/pic2.bmp +0 -0
  714. data/samples/html/regres.htm +20 -0
  715. data/samples/html/subsup.html +42 -0
  716. data/samples/html/tables.htm +255 -0
  717. data/samples/html/test.htm +375 -0
  718. data/samples/html/tn_html.png +0 -0
  719. data/samples/mdi/mdi.rb +118 -0
  720. data/samples/mdi/tn_mdi.png +0 -0
  721. data/samples/minimal/minimal.rb +95 -0
  722. data/samples/minimal/mondrian.ico +0 -0
  723. data/samples/minimal/mondrian.png +0 -0
  724. data/samples/minimal/nothing.rb +38 -0
  725. data/samples/minimal/tn_minimal.png +0 -0
  726. data/samples/minimal/tn_nothing.png +0 -0
  727. data/samples/printing/mondrian.ico +0 -0
  728. data/samples/printing/mondrian.xpm +44 -0
  729. data/samples/printing/printing.rb +499 -0
  730. data/samples/printing/printing2.rb +251 -0
  731. data/samples/printing/sample-text.txt +213 -0
  732. data/samples/printing/tn_printing.png +0 -0
  733. data/samples/printing/tn_printing2.png +0 -0
  734. data/samples/propgrid/propgrid.rb +2707 -0
  735. data/samples/propgrid/propgrid_minimal.rb +106 -0
  736. data/samples/propgrid/sample_props.rb +434 -0
  737. data/samples/propgrid/tn_propgrid.png +0 -0
  738. data/samples/propgrid/tn_propgrid_minimal.png +0 -0
  739. data/samples/ribbon/align_center.xpm +21 -0
  740. data/samples/ribbon/align_left.xpm +21 -0
  741. data/samples/ribbon/align_right.xpm +21 -0
  742. data/samples/ribbon/aui_style.xpm +53 -0
  743. data/samples/ribbon/auto_crop_selection.xpm +55 -0
  744. data/samples/ribbon/auto_crop_selection_small.xpm +33 -0
  745. data/samples/ribbon/circle.xpm +38 -0
  746. data/samples/ribbon/circle_small.xpm +22 -0
  747. data/samples/ribbon/colours.xpm +25 -0
  748. data/samples/ribbon/cross.xpm +38 -0
  749. data/samples/ribbon/empty.xpm +23 -0
  750. data/samples/ribbon/expand_selection_h.xpm +46 -0
  751. data/samples/ribbon/expand_selection_v.xpm +46 -0
  752. data/samples/ribbon/eye.xpm +26 -0
  753. data/samples/ribbon/hexagon.xpm +38 -0
  754. data/samples/ribbon/msw_style.xpm +65 -0
  755. data/samples/ribbon/position_left.xpm +22 -0
  756. data/samples/ribbon/position_top.xpm +22 -0
  757. data/samples/ribbon/ribbon.rb +900 -0
  758. data/samples/ribbon/ribbon.xpm +54 -0
  759. data/samples/ribbon/selection_panel.xpm +23 -0
  760. data/samples/ribbon/square.xpm +38 -0
  761. data/samples/ribbon/tn_ribbon.png +0 -0
  762. data/samples/ribbon/triangle.xpm +38 -0
  763. data/samples/sample.xpm +475 -0
  764. data/samples/sampler/back.xpm +21 -0
  765. data/samples/sampler/copy.xpm +44 -0
  766. data/samples/sampler/cut.xpm +46 -0
  767. data/samples/sampler/editor.rb +534 -0
  768. data/samples/sampler/ext.rb +51 -0
  769. data/samples/sampler/filesave.xpm +42 -0
  770. data/samples/sampler/find.xpm +62 -0
  771. data/samples/sampler/findrepl.xpm +63 -0
  772. data/samples/sampler/forward.xpm +21 -0
  773. data/samples/sampler/paste.xpm +46 -0
  774. data/samples/sampler/play.xpm +24 -0
  775. data/samples/sampler/redo.xpm +58 -0
  776. data/samples/sampler/sample.rb +337 -0
  777. data/samples/sampler/stc_editor.rb +326 -0
  778. data/samples/sampler/txt_editor.rb +135 -0
  779. data/samples/sampler/undo.xpm +58 -0
  780. data/samples/sampler.rb +401 -0
  781. data/samples/splash/mobile.xpm +1835 -0
  782. data/samples/splash/splash.png +0 -0
  783. data/samples/splash/splash.rb +164 -0
  784. data/samples/splash/tn_splash.png +0 -0
  785. data/samples/text/document-open.png +0 -0
  786. data/samples/text/document-save.png +0 -0
  787. data/samples/text/edit-copy.png +0 -0
  788. data/samples/text/edit-cut.png +0 -0
  789. data/samples/text/edit-paste.png +0 -0
  790. data/samples/text/edit-redo.png +0 -0
  791. data/samples/text/edit-undo.png +0 -0
  792. data/samples/text/format-text-bold.png +0 -0
  793. data/samples/text/format-text-italic.png +0 -0
  794. data/samples/text/format-text-underline.png +0 -0
  795. data/samples/text/mondrian.ico +0 -0
  796. data/samples/text/mondrian.xpm +44 -0
  797. data/samples/text/preferences-desktop-font.png +0 -0
  798. data/samples/text/rich_textctrl.rb +326 -0
  799. data/samples/text/scintilla.rb +179 -0
  800. data/samples/text/textctrl.rb +124 -0
  801. data/samples/text/tn_rich_textctrl.png +0 -0
  802. data/samples/text/tn_scintilla.png +0 -0
  803. data/samples/text/tn_textctrl.png +0 -0
  804. data/samples/text/tn_unicode.png +0 -0
  805. data/samples/text/unicode.rb +238 -0
  806. data/samples/text/utf8.txt +15 -0
  807. data/samples/treectrl/checked.xpm +54 -0
  808. data/samples/treectrl/icon1.xpm +79 -0
  809. data/samples/treectrl/icon2.xpm +53 -0
  810. data/samples/treectrl/icon3.xpm +79 -0
  811. data/samples/treectrl/icon4.xpm +43 -0
  812. data/samples/treectrl/icon5.xpm +79 -0
  813. data/samples/treectrl/state1.xpm +145 -0
  814. data/samples/treectrl/state2.xpm +144 -0
  815. data/samples/treectrl/state3.xpm +142 -0
  816. data/samples/treectrl/state4.xpm +145 -0
  817. data/samples/treectrl/state5.xpm +85 -0
  818. data/samples/treectrl/tn_treectrl.png +0 -0
  819. data/samples/treectrl/treectrl.rb +1720 -0
  820. data/samples/treectrl/unchecked.xpm +30 -0
  821. data/samples/xrc/custom_dialog.xrc +46 -0
  822. data/samples/xrc/custom_xrc_sample.rb +84 -0
  823. data/samples/xrc/samples.xrc +46 -0
  824. data/samples/xrc/tn_xrc_sample.png +0 -0
  825. data/samples/xrc/xrc_sample.rb +86 -0
  826. data/tests/test_basic.rb +20 -0
  827. data/tests/test_clipboard.rb +241 -0
  828. data/tests/test_dialog.rb +28 -0
  829. data/tests/test_event_handling.rb +103 -0
  830. data/tests/test_events.rb +45 -0
  831. data/tests/test_geometry.rb +141 -0
  832. data/tests/test_intl.rb +107 -0
  833. data/tests/test_item_data.rb +120 -0
  834. data/tests/test_variant.rb +151 -0
  835. data/tests/testapp.rb +40 -0
  836. data/tests/testapp_noframe.rb +28 -0
  837. metadata +928 -0
@@ -0,0 +1,1542 @@
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
+ #
10
+ LC_VRULES = 1
11
+
12
+ #
13
+ LC_HRULES = 2
14
+
15
+ #
16
+ LC_ICON = 4
17
+
18
+ #
19
+ LC_SMALL_ICON = 8
20
+
21
+ #
22
+ LC_LIST = 16
23
+
24
+ #
25
+ LC_REPORT = 32
26
+
27
+ #
28
+ LC_ALIGN_TOP = 64
29
+
30
+ #
31
+ LC_ALIGN_LEFT = 128
32
+
33
+ #
34
+ LC_AUTOARRANGE = 256
35
+
36
+ #
37
+ LC_VIRTUAL = 512
38
+
39
+ #
40
+ LC_EDIT_LABELS = 1024
41
+
42
+ #
43
+ LC_NO_HEADER = 2048
44
+
45
+ #
46
+ LC_NO_SORT_HEADER = 4096
47
+
48
+ #
49
+ LC_SINGLE_SEL = 8192
50
+
51
+ #
52
+ LC_SORT_ASCENDING = 16384
53
+
54
+ #
55
+ LC_SORT_DESCENDING = 32768
56
+
57
+ #
58
+ LC_MASK_TYPE = 60
59
+
60
+ #
61
+ LC_MASK_ALIGN = 192
62
+
63
+ #
64
+ LC_MASK_SORT = 49152
65
+
66
+ #
67
+ LIST_MASK_STATE = 1
68
+
69
+ #
70
+ LIST_MASK_TEXT = 2
71
+
72
+ #
73
+ LIST_MASK_IMAGE = 4
74
+
75
+ #
76
+ LIST_MASK_DATA = 8
77
+
78
+ #
79
+ LIST_SET_ITEM = 16
80
+
81
+ #
82
+ LIST_MASK_WIDTH = 32
83
+
84
+ #
85
+ LIST_MASK_FORMAT = 64
86
+
87
+ #
88
+ LIST_STATE_DONTCARE = 0
89
+
90
+ #
91
+ LIST_STATE_DROPHILITED = 1
92
+
93
+ #
94
+ LIST_STATE_FOCUSED = 2
95
+
96
+ #
97
+ LIST_STATE_SELECTED = 4
98
+
99
+ #
100
+ LIST_STATE_CUT = 8
101
+
102
+ #
103
+ LIST_HITTEST_ABOVE = 1
104
+
105
+ #
106
+ LIST_HITTEST_BELOW = 2
107
+
108
+ #
109
+ LIST_HITTEST_NOWHERE = 4
110
+
111
+ #
112
+ LIST_HITTEST_ONITEMICON = 32
113
+
114
+ #
115
+ LIST_HITTEST_ONITEMLABEL = 128
116
+
117
+ #
118
+ LIST_HITTEST_ONITEMSTATEICON = 512
119
+
120
+ #
121
+ LIST_HITTEST_TOLEFT = 1024
122
+
123
+ #
124
+ LIST_HITTEST_TORIGHT = 2048
125
+
126
+ #
127
+ LIST_HITTEST_ONITEM = 672
128
+
129
+ #
130
+ LIST_GETSUBITEMRECT_WHOLEITEM = -1
131
+
132
+ #
133
+ #
134
+ LIST_NEXT_ABOVE = 0
135
+
136
+ #
137
+ #
138
+ LIST_NEXT_ALL = 1
139
+
140
+ #
141
+ #
142
+ LIST_NEXT_BELOW = 2
143
+
144
+ #
145
+ #
146
+ LIST_NEXT_LEFT = 3
147
+
148
+ #
149
+ #
150
+ LIST_NEXT_RIGHT = 4
151
+
152
+ #
153
+ #
154
+ LIST_ALIGN_DEFAULT = 0
155
+
156
+ #
157
+ #
158
+ LIST_ALIGN_LEFT = 1
159
+
160
+ #
161
+ #
162
+ LIST_ALIGN_TOP = 2
163
+
164
+ #
165
+ #
166
+ LIST_ALIGN_SNAP_TO_GRID = 3
167
+
168
+ # Column format (MSW only except {Wx::ListColumnFormat::LIST_FORMAT_LEFT})
169
+ #
170
+ #
171
+ #
172
+ class ListColumnFormat < Wx::Enum
173
+
174
+ #
175
+ #
176
+ LIST_FORMAT_LEFT = Wx::ListColumnFormat.new(0)
177
+
178
+ #
179
+ #
180
+ LIST_FORMAT_RIGHT = Wx::ListColumnFormat.new(1)
181
+
182
+ #
183
+ #
184
+ LIST_FORMAT_CENTRE = Wx::ListColumnFormat.new(2)
185
+
186
+ #
187
+ #
188
+ LIST_FORMAT_CENTER = Wx::ListColumnFormat.new(2)
189
+
190
+ end # ListColumnFormat
191
+
192
+ #
193
+ #
194
+ LIST_AUTOSIZE = -1
195
+
196
+ #
197
+ #
198
+ LIST_AUTOSIZE_USEHEADER = -2
199
+
200
+ #
201
+ #
202
+ LIST_RECT_BOUNDS = 0
203
+
204
+ #
205
+ #
206
+ LIST_RECT_ICON = 1
207
+
208
+ #
209
+ #
210
+ LIST_RECT_LABEL = 2
211
+
212
+ #
213
+ #
214
+ LIST_FIND_UP = 0
215
+
216
+ #
217
+ #
218
+ LIST_FIND_DOWN = 1
219
+
220
+ #
221
+ #
222
+ LIST_FIND_LEFT = 2
223
+
224
+ #
225
+ #
226
+ LIST_FIND_RIGHT = 3
227
+
228
+ #
229
+ #
230
+ EVT_LIST_BEGIN_DRAG = 10135
231
+
232
+ #
233
+ #
234
+ EVT_LIST_BEGIN_RDRAG = 10136
235
+
236
+ #
237
+ #
238
+ EVT_LIST_BEGIN_LABEL_EDIT = 10137
239
+
240
+ #
241
+ #
242
+ EVT_LIST_END_LABEL_EDIT = 10138
243
+
244
+ #
245
+ #
246
+ EVT_LIST_DELETE_ITEM = 10139
247
+
248
+ #
249
+ #
250
+ EVT_LIST_DELETE_ALL_ITEMS = 10140
251
+
252
+ #
253
+ #
254
+ EVT_LIST_ITEM_SELECTED = 10141
255
+
256
+ #
257
+ #
258
+ EVT_LIST_ITEM_DESELECTED = 10142
259
+
260
+ #
261
+ #
262
+ EVT_LIST_KEY_DOWN = 10143
263
+
264
+ #
265
+ #
266
+ EVT_LIST_INSERT_ITEM = 10144
267
+
268
+ #
269
+ #
270
+ EVT_LIST_COL_CLICK = 10145
271
+
272
+ #
273
+ #
274
+ EVT_LIST_ITEM_RIGHT_CLICK = 10150
275
+
276
+ #
277
+ #
278
+ EVT_LIST_ITEM_MIDDLE_CLICK = 10151
279
+
280
+ #
281
+ #
282
+ EVT_LIST_ITEM_ACTIVATED = 10152
283
+
284
+ #
285
+ #
286
+ EVT_LIST_CACHE_HINT = 10156
287
+
288
+ #
289
+ #
290
+ EVT_LIST_COL_RIGHT_CLICK = 10146
291
+
292
+ #
293
+ #
294
+ EVT_LIST_COL_BEGIN_DRAG = 10147
295
+
296
+ #
297
+ #
298
+ EVT_LIST_COL_DRAGGING = 10148
299
+
300
+ #
301
+ #
302
+ EVT_LIST_COL_END_DRAG = 10149
303
+
304
+ #
305
+ #
306
+ EVT_LIST_ITEM_FOCUSED = 10153
307
+
308
+ #
309
+ #
310
+ EVT_LIST_ITEM_CHECKED = 10154
311
+
312
+ #
313
+ #
314
+ EVT_LIST_ITEM_UNCHECKED = 10155
315
+
316
+ # A list control presents lists in a number of formats: list view, report view, icon view and small icon view.
317
+ # 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.
318
+ # 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.
319
+ # 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.
320
+ # Using many of {Wx::ListCtrl} features is shown in the corresponding sample.
321
+ # To intercept events from a list control, use the event table macros described in {Wx::ListEvent}.
322
+ # The native {Wx::OSX} implementation for report mode that was added in wxWidgets 2.8 was removed in wxWidgets 3.1, meaning for wxWidgets 3.1+ {Wx::OSX} uses the generic implementation for all modes.
323
+ #
324
+ # == Column Ordering
325
+ #
326
+ # By default, the columns of a list control appear on the screen in order of their indices, i.e. column 0 appears first, then column 1 next, and so on. However this can be changed by using the {Wx::ListCtrl#set_columns_order} function to arbitrarily reorder the columns visual order.
327
+ # The user can also rearrange the columns interactively by dragging them. In this case, the index of the column is not the same as its order and the functions {Wx::ListCtrl#get_column_order} and {Wx::ListCtrl#get_column_index_from_order} should be used to translate between them.
328
+ # All the other functions still work with the column indices, i.e. the visual positioning of the columns on screen doesn't affect the code setting or getting their values for example.
329
+ #
330
+ # Example of reordering columns:
331
+ #
332
+ # wxListCtrl *list = new wxListCtrl(...);
333
+ # for ( int i = 0; i < 3; i++ )
334
+ # list->InsertColumn(i, wxString::Format("Column %d", i));
335
+ #
336
+ # wxArrayInt order(3);
337
+ # order[0] = 2;
338
+ # order[1] = 0;
339
+ # order[2] = 1;
340
+ # list->SetColumnsOrder(order);
341
+ #
342
+ # // now list->GetColumnsOrder() will return order and
343
+ # // list->GetColumnIndexFromOrder(n) will return order[n] and
344
+ # // list->GetColumnOrder() will return 1, 2 and 0 for the column 0,
345
+ # // 1 and 2 respectively
346
+ #
347
+ # === Styles
348
+ #
349
+ # This class supports the following styles:
350
+ #
351
+ # - {Wx::LC_LIST}: Multicolumn list view, with optional small icons. Columns are computed automatically, i.e. you don't set columns as in {Wx::LC_REPORT}. In other words, the list wraps, unlike a {Wx::ListBox}.
352
+ # - {Wx::LC_REPORT}: Single or multicolumn report view, with optional header.
353
+ # - {Wx::LC_VIRTUAL}: The application provides items text on demand. May only be used with {Wx::LC_REPORT}.
354
+ # - {Wx::LC_ICON}: Large icon view, with optional labels.
355
+ # - {Wx::LC_SMALL_ICON}: Small icon view, with optional labels.
356
+ # - {Wx::LC_ALIGN_TOP}: Icons align to the top. Win32 default, Win32 only.
357
+ # - {Wx::LC_ALIGN_LEFT}: Icons align to the left.
358
+ # - {Wx::LC_AUTOARRANGE}: Icons arrange themselves. Win32 only.
359
+ # - {Wx::LC_EDIT_LABELS}: Labels are editable: the application will be notified when editing starts.
360
+ # - {Wx::LC_NO_HEADER}: No header in report mode.
361
+ # - {Wx::LC_SINGLE_SEL}: Single selection (default is multiple).
362
+ # - {Wx::LC_SORT_ASCENDING}: Sort in ascending order. (You must still supply a comparison callback in {Wx::ListCtrl#sort_items}.)
363
+ # - {Wx::LC_SORT_DESCENDING}: Sort in descending order. (You must still supply a comparison callback in {Wx::ListCtrl#sort_items}.)
364
+ # - {Wx::LC_HRULES}: Draws light horizontal rules between rows in report mode.
365
+ # - {Wx::LC_VRULES}: Draws light vertical rules between columns in report mode.
366
+ #
367
+ # === Events emitted by this class
368
+ #
369
+ # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ListEvent} events.
370
+ # Event handler methods for events emitted by this class:
371
+ # - {Wx::EvtHandler#evt_list_begin_drag}(id, meth = nil, &block): Begin dragging with the left mouse button. Processes a {Wx::EVT_LIST_BEGIN_DRAG} event type.
372
+ # - {Wx::EvtHandler#evt_list_begin_rdrag}(id, meth = nil, &block): Begin dragging with the right mouse button. Processes a {Wx::EVT_LIST_BEGIN_RDRAG} event type.
373
+ # - {Wx::EvtHandler#evt_list_begin_label_edit}(id, meth = nil, &block): Begin editing a label. This can be prevented by calling Veto(). Processes a {Wx::EVT_LIST_BEGIN_LABEL_EDIT} event type.
374
+ # - {Wx::EvtHandler#evt_list_end_label_edit}(id, meth = nil, &block): Finish editing a label. This can be prevented by calling Veto(). Processes a {Wx::EVT_LIST_END_LABEL_EDIT} event type.
375
+ # - {Wx::EvtHandler#evt_list_delete_item}(id, meth = nil, &block): An item was deleted. Processes a {Wx::EVT_LIST_DELETE_ITEM} event type.
376
+ # - {Wx::EvtHandler#evt_list_delete_all_items}(id, meth = nil, &block): All items were deleted. Processes a {Wx::EVT_LIST_DELETE_ALL_ITEMS} event type.
377
+ # - {Wx::EvtHandler#evt_list_item_selected}(id, meth = nil, &block): The item has been selected. Notice that the mouse is captured by the control itself when this event is generated, see event handling overview. Processes a {Wx::EVT_LIST_ITEM_SELECTED} event type.
378
+ # - {Wx::EvtHandler#evt_list_item_deselected}(id, meth = nil, &block): The item has been deselected. Processes a {Wx::EVT_LIST_ITEM_DESELECTED} event type.
379
+ # - {Wx::EvtHandler#evt_list_item_activated}(id, meth = nil, &block): The item has been activated (ENTER or double click). Processes a {Wx::EVT_LIST_ITEM_ACTIVATED} event type.
380
+ # - {Wx::EvtHandler#evt_list_item_focused}(id, meth = nil, &block): The currently focused item has changed. Processes a {Wx::EVT_LIST_ITEM_FOCUSED} event type.
381
+ # - {Wx::EvtHandler#evt_list_item_middle_click}(id, meth = nil, &block): The middle mouse button has been clicked on an item. This is only supported by the generic control. Processes a {Wx::EVT_LIST_ITEM_MIDDLE_CLICK} event type.
382
+ # - {Wx::EvtHandler#evt_list_item_right_click}(id, meth = nil, &block): The right mouse button has been clicked on an item. Processes a {Wx::EVT_LIST_ITEM_RIGHT_CLICK} event type.
383
+ # - {Wx::EvtHandler#evt_list_key_down}(id, meth = nil, &block): A key has been pressed. Processes a {Wx::EVT_LIST_KEY_DOWN} event type.
384
+ # - {Wx::EvtHandler#evt_list_insert_item}(id, meth = nil, &block): An item has been inserted. Processes a {Wx::EVT_LIST_INSERT_ITEM} event type.
385
+ # - {Wx::EvtHandler#evt_list_col_click}(id, meth = nil, &block): A column (m_col) has been left-clicked. Processes a {Wx::EVT_LIST_COL_CLICK} event type.
386
+ # - {Wx::EvtHandler#evt_list_col_right_click}(id, meth = nil, &block): A column (m_col) has been right-clicked. Processes a {Wx::EVT_LIST_COL_RIGHT_CLICK} event type.
387
+ # - {Wx::EvtHandler#evt_list_col_begin_drag}(id, meth = nil, &block): The user started resizing a column - can be vetoed. Processes a {Wx::EVT_LIST_COL_BEGIN_DRAG} event type.
388
+ # - {Wx::EvtHandler#evt_list_col_dragging}(id, meth = nil, &block): The divider between columns is being dragged. Processes a {Wx::EVT_LIST_COL_DRAGGING} event type.
389
+ # - {Wx::EvtHandler#evt_list_col_end_drag}(id, meth = nil, &block): A column has been resized by the user. Processes a {Wx::EVT_LIST_COL_END_DRAG} event type.
390
+ # - {Wx::EvtHandler#evt_list_cache_hint}(id, meth = nil, &block): Prepare cache for a virtual list control. Processes a {Wx::EVT_LIST_CACHE_HINT} event type.
391
+ # - {Wx::EvtHandler#evt_list_item_checked}(id, meth = nil, &block): The item has been checked. Processes a {Wx::EVT_LIST_ITEM_CHECKED} event type (new since wxWidgets 3.1.0).
392
+ # - {Wx::EvtHandler#evt_list_item_unchecked}(id, meth = nil, &block): The item has been unchecked. Processes a {Wx::EVT_LIST_ITEM_UNCHECKED} event type (new since wxWidgets 3.1.0).
393
+ #
394
+ # Under {Wx::MSW} this control uses {Wx::SystemThemedControl} for an explorer style appearance by default since wxWidgets 3.1.0. If this is not desired, you can call Wx::SystemThemedControl::EnableSystemTheme with false argument to disable this.
395
+ #
396
+ # ===
397
+ #
398
+ # Category: {Wx::Controls} <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
399
+ # </td><td> {Wx::GTK} Appearance
400
+ # </td><td> {Wx::OSX} Appearance
401
+ # </td></tr></table></div>
402
+ # @see wxListCtrl Overview
403
+ # @see Wx::ListView
404
+ # @see Wx::ListBox
405
+ # @see Wx::TreeCtrl
406
+ # @see Wx::ImageList
407
+ # @see Wx::ListEvent
408
+ # @see Wx::ListItem
409
+ # @see Wx::EditableListBox
410
+ #
411
+ #
412
+ class ListCtrl < Control
413
+
414
+ # @overload initialize()
415
+ # Default constructor.
416
+ # @return [ListCtrl]
417
+ # @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)
418
+ # Constructor, creating and showing a list control.
419
+ #
420
+ # @see Wx::ListCtrl#create
421
+ # @see Wx::Validator
422
+ # @param parent [Wx::Window] Parent window. Must not be NULL.
423
+ # @param id [Integer] Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
424
+ # @param pos [Array(Integer, Integer), Wx::Point] Window position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
425
+ # @param size [Array(Integer, Integer), Wx::Size] Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
426
+ # @param style [Integer] Window style. See {Wx::ListCtrl}.
427
+ # @param validator [Wx::Validator] Window validator.
428
+ # @param name [String] Window name.
429
+ # @return [ListCtrl]
430
+ def initialize(*args) end
431
+
432
+ # Adds a new column to the list control in report view mode.
433
+ # 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.
434
+ # @param heading [String]
435
+ # @param format [ListColumnFormat]
436
+ # @param width [Integer]
437
+ # @return [Integer]
438
+ def append_column(heading, format=Wx::LIST_FORMAT_LEFT, width=-1) end
439
+
440
+ # Arranges the items in icon or small icon view.
441
+ # This only has effect on Win32. flag is one of:
442
+ # - {Wx::LIST_ALIGN_DEFAULT}: Default alignment.- {Wx::LIST_ALIGN_LEFT}: Align to the left side of the control.- {Wx::LIST_ALIGN_TOP}: Align to the top side of the control.- {Wx::LIST_ALIGN_SNAP_TO_GRID}: Snap to grid.
443
+ # @param flag [Integer]
444
+ # @return [true,false]
445
+ def arrange(flag=Wx::LIST_ALIGN_DEFAULT) end
446
+
447
+ # Deletes all items and all columns.
448
+ # This sends an event of type {Wx::EVT_LIST_DELETE_ALL_ITEMS} under all platforms.
449
+ # @return [void]
450
+ def clear_all; end
451
+
452
+ # Creates the list control.
453
+ # See {Wx::ListCtrl#list_ctrl} for further details.
454
+ # @param parent [Wx::Window]
455
+ # @param id [Integer]
456
+ # @param pos [Array(Integer, Integer), Wx::Point]
457
+ # @param size [Array(Integer, Integer), Wx::Size]
458
+ # @param style [Integer]
459
+ # @param validator [Wx::Validator]
460
+ # @param name [String]
461
+ # @return [true,false]
462
+ 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
463
+
464
+ # Delete all columns in the list control.
465
+ # true if all columns were successfully deleted, false otherwise.
466
+ # @return [true,false]
467
+ def delete_all_columns; end
468
+
469
+ # Deletes all items in the list control.
470
+ # 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.
471
+ # true if the items were successfully deleted or if the control was already empty, false if an error occurred while deleting the items.
472
+ # @return [true,false]
473
+ def delete_all_items; end
474
+
475
+ # Deletes a column.
476
+ # @param col [Integer]
477
+ # @return [true,false]
478
+ def delete_column(col) end
479
+
480
+ # Deletes the specified item.
481
+ # This function sends the {Wx::EVT_LIST_DELETE_ITEM} event for the item being deleted.
482
+ # @see Wx::ListCtrl#delete_all_items
483
+ # @param item [Integer]
484
+ # @return [true,false]
485
+ def delete_item(item) end
486
+
487
+ # Enable alternating row background colours (also called zebra striping).
488
+ # This method can only be called for the control in virtual report mode, i.e. having {Wx::LC_REPORT} and {Wx::LC_VIRTUAL} styles.
489
+ # 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.
490
+ # @see Wx::ListCtrl#set_alternate_row_colour
491
+ # @param enable [true,false] If true, enable alternating row background colours, i.e. different colours for the odd and even rows. If false, disable this feature and use the same background colour for all rows.
492
+ # @return [void]
493
+ def enable_alternate_row_colours(enable=true) end
494
+
495
+ # Enable or disable a beep if there is no match for the currently entered text when searching for the item from keyboard.
496
+ # The default is to not beep in this case except in {Wx::MSW} where the beep is always generated by the native control and cannot be disabled, i.e. calls to this function do nothing there.
497
+ # @param on [true,false]
498
+ # @return [void]
499
+ def enable_bell_on_no_match(on=true) end
500
+
501
+ # Finish editing the label.
502
+ # 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.
503
+ # Notice that calling this method will result in EVT_LIST_END_LABEL_EDIT event being generated.
504
+ # Currently only implemented in {Wx::MSW}.
505
+ #
506
+ # true if item editing was finished or false if no item as being edited.
507
+ # @param cancel [true,false] If true, discard the changes made by user, as if Escape key was pressed. Otherwise, accept the changes as if Return was pressed.
508
+ # @return [true,false]
509
+ def end_edit_label(cancel) end
510
+
511
+ # Ensures this item is visible.
512
+ # @param item [Integer]
513
+ # @return [true,false]
514
+ def ensure_visible(item) end
515
+
516
+ # @overload find_item(start, str, partial=false)
517
+ # Find an item whose label matches this string, starting from start or the beginning if start is <code>-1</code>.
518
+ # The string comparison is case insensitive.
519
+ # If partial is true then this method will look for items which begin with str.
520
+ # The next matching item if any or <code>-1</code> ({Wx::NOT_FOUND}) otherwise.
521
+ # @param start [Integer]
522
+ # @param str [String]
523
+ # @param partial [true,false]
524
+ # @return [Integer]
525
+ # @overload find_item(start, data)
526
+ # Find an item whose data matches this data, starting from start or the beginning if 'start' is <code>-1</code>.
527
+ # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method is implemented as FindItemData(start, data).
528
+ # The next matching item if any or <code>-1</code> ({Wx::NOT_FOUND}) otherwise.
529
+ # @param start [Integer]
530
+ # @param data [Integer]
531
+ # @return [Integer]
532
+ # @overload find_item(start, pt, direction)
533
+ # Find an item nearest this position in the specified direction, starting from start or the beginning if start is -1.
534
+ # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method is implemented as FindItemAtPos(start, pt, direction).
535
+ # The next matching item if any or <code>-1</code> ({Wx::NOT_FOUND}) otherwise.
536
+ # @param start [Integer]
537
+ # @param pt [Array(Integer, Integer), Wx::Point]
538
+ # @param direction [Integer]
539
+ # @return [Integer]
540
+ def find_item(*args) end
541
+
542
+ # Gets information about this column.
543
+ # See {Wx::ListCtrl#set_item} for more information.
544
+ # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes only the col parameter and returns a Wx::ListItem (or undef).
545
+ # @param col [Integer]
546
+ # @param item [Wx::ListItem]
547
+ # @return [true,false]
548
+ def get_column(col, item) end
549
+ alias_method :column, :get_column
550
+
551
+ # Returns the number of columns.
552
+ # 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.
553
+ # @return [Integer]
554
+ def get_column_count; end
555
+ alias_method :column_count, :get_column_count
556
+
557
+ # Gets the column index from its position in visual order.
558
+ # After calling {Wx::ListCtrl#set_columns_order}, the index returned by this function corresponds to the value of the element number pos in the array returned by {Wx::ListCtrl#get_columns_order}.
559
+ # This function makes sense for report view only and currently is only implemented in the {Wx::MSW} port. Use {Wx::HAS_LISTCTRL_COLUMN_ORDER} to guard uses of this function so that they will start working under the other platforms when support for the column reordering is added there.
560
+ # @see Wx::ListCtrl#get_column_order
561
+ # @param pos [Integer]
562
+ # @return [Integer]
563
+ def get_column_index_from_order(pos) end
564
+ alias_method :column_index_from_order, :get_column_index_from_order
565
+
566
+ # Gets the column visual order position.
567
+ # This function returns the index of the column which appears at the given visual position, e.g. calling it with col equal to 0 returns the index of the first shown column.
568
+ # This function makes sense for report view only and currently is only implemented in the {Wx::MSW} port. Use {Wx::HAS_LISTCTRL_COLUMN_ORDER} to guard uses of this function so that they will start working under the other platforms when support for the column reordering is added there.
569
+ # @see Wx::ListCtrl#get_columns_order
570
+ # @see Wx::ListCtrl#get_column_index_from_order
571
+ # @param col [Integer]
572
+ # @return [Integer]
573
+ def get_column_order(col) end
574
+ alias_method :column_order, :get_column_order
575
+
576
+ # Gets the column width (report view only).
577
+ # @param col [Integer]
578
+ # @return [Integer]
579
+ def get_column_width(col) end
580
+ alias_method :column_width, :get_column_width
581
+
582
+ # Returns the array containing the orders of all columns.
583
+ # On error, an empty array is returned.
584
+ # This function makes sense for report view only and currently is only implemented in the {Wx::MSW} port. Use {Wx::HAS_LISTCTRL_COLUMN_ORDER} to guard uses of this function so that they will start working under the other platforms when support for the column reordering is added there.
585
+ # @see Wx::ListCtrl#get_column_order
586
+ # @see Wx::ListCtrl#get_column_index_from_order
587
+ # @return [Array<Integer>]
588
+ def get_columns_order; end
589
+ alias_method :columns_order, :get_columns_order
590
+
591
+ # Gets the number of items that can fit vertically in the visible area of the list control (list or report view) or the total number of items in the list control (icon or small icon view).
592
+ # @return [Integer]
593
+ def get_count_per_page; end
594
+ alias_method :count_per_page, :get_count_per_page
595
+
596
+ # Returns the edit control being currently used to edit a label.
597
+ # Returns NULL if no label is being edited.
598
+ # It is currently only implemented for {Wx::MSW} and the generic version, not for the native macOS version.
599
+ # @return [Wx::TextCtrl]
600
+ def get_edit_control; end
601
+ alias_method :edit_control, :get_edit_control
602
+
603
+ # Returns the specified image list.
604
+ # which may be one of:
605
+ # - {Wx::IMAGE_LIST_NORMAL}: The normal (large icon) image list.- {Wx::IMAGE_LIST_SMALL}: The small icon image list.- {Wx::IMAGE_LIST_STATE}: The user-defined state image list (unimplemented).
606
+ # @param which [Integer]
607
+ # @return [Wx::ImageList]
608
+ def get_image_list(which) end
609
+ alias_method :image_list, :get_image_list
610
+
611
+ # Returns the colour for this item.
612
+ # If the item has no specific colour, returns an invalid colour (and not the default background colour of the control itself).
613
+ # @see Wx::ListCtrl#get_item_text_colour
614
+ # @param item [Integer]
615
+ # @return [Wx::Colour]
616
+ def get_item_background_colour(item) end
617
+ alias_method :item_background_colour, :get_item_background_colour
618
+
619
+ # Returns the number of items in the list control.
620
+ # @return [Integer]
621
+ def get_item_count; end
622
+ alias_method :item_count, :get_item_count
623
+
624
+ # Returns the item's font.
625
+ # @param item [Integer]
626
+ # @return [Wx::Font]
627
+ def get_item_font(item) end
628
+ alias_method :item_font, :get_item_font
629
+
630
+ # Returns the position of the item, in icon or small icon view.
631
+ # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes only the item parameter and returns a Wx::Point (or undef).
632
+ # @param item [Integer]
633
+ # @param pos [Array(Integer, Integer), Wx::Point]
634
+ # @return [true,false]
635
+ def get_item_position(item, pos) end
636
+ alias_method :item_position, :get_item_position
637
+
638
+ # Returns the rectangle representing the item's size and position, in physical coordinates.
639
+ # code is one of {Wx::LIST_RECT_BOUNDS}, {Wx::LIST_RECT_ICON}, {Wx::LIST_RECT_LABEL}.
640
+ # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes only the item and code parameters and returns a Wx::Rect (or undef).
641
+ # @param item [Integer]
642
+ # @param code [Integer]
643
+ # @return [Array(true,false,Wx::Rect)]
644
+ def get_item_rect(item, code=Wx::LIST_RECT_BOUNDS) end
645
+ alias_method :item_rect, :get_item_rect
646
+
647
+ # Retrieves the spacing between icons in pixels: horizontal spacing is returned as x component of the {Wx::Size} object and the vertical spacing as its y component.
648
+ # @return [Wx::Size]
649
+ def get_item_spacing; end
650
+ alias_method :item_spacing, :get_item_spacing
651
+
652
+ # Gets the item state.
653
+ # For a list of state flags, see {Wx::ListCtrl#set_item}. The stateMask indicates which state flags are of interest.
654
+ # @param item [Integer]
655
+ # @param stateMask [Integer]
656
+ # @return [Integer]
657
+ def get_item_state(item, stateMask) end
658
+ alias_method :item_state, :get_item_state
659
+
660
+ # Gets the item text for this item.
661
+ # @param item [Integer] Item (zero-based) index.
662
+ # @param col [Integer] Item column (zero-based) index. Column 0 is the default. This parameter is new in wxWidgets 2.9.1.
663
+ # @return [String]
664
+ def get_item_text(item, col=0) end
665
+ alias_method :item_text, :get_item_text
666
+
667
+ # Returns the colour for this item.
668
+ # 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).
669
+ # @param item [Integer]
670
+ # @return [Wx::Colour]
671
+ def get_item_text_colour(item) end
672
+ alias_method :item_text_colour, :get_item_text_colour
673
+
674
+ # Searches for an item with the given geometry or state, starting from item but excluding the item itself.
675
+ # 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:
676
+ #
677
+ # long item = -1;
678
+ # for ( ;; )
679
+ # {
680
+ # item = listctrl->GetNextItem(item,
681
+ # wxLIST_NEXT_ALL,
682
+ # wxLIST_STATE_SELECTED);
683
+ # if ( item == -1 )
684
+ # break;
685
+ #
686
+ # // this item is selected - do whatever is needed with it
687
+ # wxLogMessage("Item %ld is selected.", item);
688
+ # }
689
+ #
690
+ # geometry can be one of:
691
+ # - {Wx::LIST_NEXT_ABOVE}: Searches for an item above the specified item.- {Wx::LIST_NEXT_ALL}: Searches for subsequent item by index.- {Wx::LIST_NEXT_BELOW}: Searches for an item below the specified item.- {Wx::LIST_NEXT_LEFT}: Searches for an item to the left of the specified item.- {Wx::LIST_NEXT_RIGHT}: Searches for an item to the right of the specified item.
692
+ #
693
+ # this parameter is only supported by {Wx::MSW} currently and ignored on other platforms.
694
+ #
695
+ # state can be a bitlist of the following:
696
+ # - {Wx::LIST_STATE_DONTCARE}: Don't care what the state is.- {Wx::LIST_STATE_DROPHILITED}: The item indicates it is a drop target.- {Wx::LIST_STATE_FOCUSED}: The item has the focus.- {Wx::LIST_STATE_SELECTED}: The item is selected.- {Wx::LIST_STATE_CUT}: The item is selected as part of a cut and paste operation.
697
+ # @param item [Integer]
698
+ # @param geometry [Integer]
699
+ # @param state [Integer]
700
+ # @return [Integer]
701
+ def get_next_item(item, geometry=Wx::LIST_NEXT_ALL, state=Wx::LIST_STATE_DONTCARE) end
702
+ alias_method :next_item, :get_next_item
703
+
704
+ # Returns the number of selected items in the list control.
705
+ # @return [Integer]
706
+ def get_selected_item_count; end
707
+ alias_method :selected_item_count, :get_selected_item_count
708
+
709
+ # Returns the rectangle representing the size and position, in physical coordinates, of the given subitem, i.e.
710
+ # the part of the row item in the column subItem.
711
+ # 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}.
712
+ # code can be one of {Wx::LIST_RECT_BOUNDS}, {Wx::LIST_RECT_ICON} or {Wx::LIST_RECT_LABEL}.
713
+ # Note that using {Wx::LIST_RECT_ICON} with any sub-item but the first one isn't very useful as only the first sub-item can have an icon in {Wx::ListCtrl}. In this case, i.e. for subItem > 0, this function simply returns an empty rectangle in rect.
714
+ # @param item [Integer]
715
+ # @param subItem [Integer]
716
+ # @param code [Integer]
717
+ # @return [Array(true,false,Wx::Rect)]
718
+ def get_sub_item_rect(item, subItem, code=Wx::LIST_RECT_BOUNDS) end
719
+ alias_method :sub_item_rect, :get_sub_item_rect
720
+
721
+ # Gets the text colour of the list control.
722
+ # @return [Wx::Colour]
723
+ def get_text_colour; end
724
+ alias_method :text_colour, :get_text_colour
725
+
726
+ # Gets the index of the topmost visible item when in list or report view.
727
+ # @return [Integer]
728
+ def get_top_item; end
729
+ alias_method :top_item, :get_top_item
730
+
731
+ # Returns the rectangle taken by all items in the control.
732
+ # 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.
733
+ # 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).
734
+ # @return [Wx::Rect]
735
+ def get_view_rect; end
736
+ alias_method :view_rect, :get_view_rect
737
+
738
+ # Set the alternative row background colour to a specific colour.
739
+ # 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.
740
+ # As {Wx::ListCtrl#enable_alternate_row_colours}, this method can only be used with controls having {Wx::LC_REPORT} and {Wx::LC_VIRTUAL} styles.
741
+ # @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.
742
+ # @return [void]
743
+ def set_alternate_row_colour(colour) end
744
+ alias_method :alternate_row_colour=, :set_alternate_row_colour
745
+
746
+ # Get the alternative row background colour.
747
+ #
748
+ # @see Wx::ListCtrl#set_alternate_row_colour
749
+ # @return [Wx::Colour]
750
+ def get_alternate_row_colour; end
751
+ alias_method :alternate_row_colour, :get_alternate_row_colour
752
+
753
+ # Determines which item (if any) is at the specified point, giving details in flags.
754
+ # Returns index of the item or {Wx::NOT_FOUND} if no item is at the specified point.
755
+ # flags will be a combination of the following flags:
756
+ # - {Wx::LIST_HITTEST_ABOVE}: Above the control's client area.- {Wx::LIST_HITTEST_BELOW}: Below the control's client area.- {Wx::LIST_HITTEST_TOLEFT}: To the left of the control's client area.- {Wx::LIST_HITTEST_TORIGHT}: To the right of the control's client area.- {Wx::LIST_HITTEST_NOWHERE}: Inside the control's client area but not over an item.- {Wx::LIST_HITTEST_ONITEMICON}: Over an item's icon.- {Wx::LIST_HITTEST_ONITEMLABEL}: Over an item's text.- {Wx::LIST_HITTEST_ONITEMSTATEICON}: Over the checkbox of an item.- {Wx::LIST_HITTEST_ONITEM}: Combination of {Wx::LIST_HITTEST_ONITEMICON}, {Wx::LIST_HITTEST_ONITEMLABEL}, {Wx::LIST_HITTEST_ONITEMSTATEICON}.
757
+ #
758
+ # If ptrSubItem is not NULL and the {Wx::ListCtrl} is in the report mode the subitem (or column) number will also be provided. This feature is only available in version 2.7.0 or higher and is currently only implemented under {Wx::MSW} and requires at least comctl32.dll of version 4.70 on the host system or the value stored in ptrSubItem will be always -1. To compile this feature into wxWidgets library you need to have access to commctrl.h of version 4.70 that is provided by Microsoft.
759
+ # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method only takes the point parameter and returns a 2-element list (item, flags).
760
+ # @param point [Array(Integer, Integer), Wx::Point]
761
+ # @return [Array(Integer,Integer)]
762
+ def hit_test(point) end
763
+
764
+ # Returns true if the control is currently using {Wx::LC_REPORT} style.
765
+ # @return [true,false]
766
+ def in_report_view; end
767
+
768
+ # @overload insert_column(col, info)
769
+ # For report view mode (only), inserts a column.
770
+ # 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.
771
+ # @param col [Integer]
772
+ # @param info [Wx::ListItem]
773
+ # @return [Integer]
774
+ # @overload insert_column(col, heading, format=Wx::LIST_FORMAT_LEFT, width=Wx::LIST_AUTOSIZE)
775
+ # For report view mode (only), inserts a column.
776
+ # Insert a new column in the list control in report view mode at the given position specifying its most common attributes.
777
+ # 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.
778
+ #
779
+ # The index of the inserted column or -1 if adding it failed.
780
+ # @param col [Integer] The index where the column should be inserted. Valid indices are from 0 up to {Wx::ListCtrl#get_column_count} inclusive and the latter can be used to append the new column after the last existing one.
781
+ # @param heading [String] The string specifying the column heading.
782
+ # @param format [Integer] The flags specifying the control heading text alignment.
783
+ # @param width [Integer] If positive, the width of the column in pixels. Otherwise it can be {Wx::LIST_AUTOSIZE} to choose the default size for the column or {Wx::LIST_AUTOSIZE_USEHEADER} to fit the column width to heading or to extend to fill all the remaining space for the last column. Notice that in case of {Wx::LIST_AUTOSIZE} fixed width is used as there are no items in this column to use for determining its best size yet. If you want to fit the column to its contents, use {Wx::ListCtrl#set_column_width} after adding the items with values in this column.
784
+ # @return [Integer]
785
+ def insert_column(*args) end
786
+
787
+ # @overload insert_item(info)
788
+ # Inserts an item, returning the index of the new item if successful, -1 otherwise.
789
+ # @param info [Wx::ListItem] {Wx::ListItem} object
790
+ # @return [Integer]
791
+ # @overload insert_item(index, label)
792
+ # Insert a string item.
793
+ # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method is implemented as InsertStringItem(index, label).
794
+ # @param index [Integer] Index of the new item, supplied by the application
795
+ # @param label [String] String label
796
+ # @return [Integer]
797
+ # @overload insert_item(index, imageIndex)
798
+ # Insert an image item.
799
+ # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method is implemented as InsertImageItem(index, imageIndex).
800
+ # @param index [Integer] Index of the new item, supplied by the application
801
+ # @param imageIndex [Integer] Index into the image list associated with this control and view style
802
+ # @return [Integer]
803
+ # @overload insert_item(index, label, imageIndex)
804
+ # Insert an image/string item.
805
+ # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method is implemented as InsertImageStringItem(index, label, imageIndex).
806
+ # @param index [Integer] Index of the new item, supplied by the application
807
+ # @param label [String] String label
808
+ # @param imageIndex [Integer] Index into the image list associated with this control and view style
809
+ # @return [Integer]
810
+ def insert_item(*args) end
811
+
812
+ # Returns true if the control doesn't currently contain any items.
813
+ # Note that the control with some columns is still considered to be empty if it has no rows.
814
+ # @return [true,false]
815
+ def is_empty; end
816
+ alias_method :empty?, :is_empty
817
+
818
+ # Returns true if the control is currently in virtual report view.
819
+ # @return [true,false]
820
+ def is_virtual; end
821
+ alias_method :virtual?, :is_virtual
822
+
823
+ # Redraws the given item.
824
+ # 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.
825
+ # @see Wx::ListCtrl#refresh_items
826
+ # @param item [Integer]
827
+ # @return [void]
828
+ def refresh_item(item) end
829
+
830
+ # Redraws the items between itemFrom and itemTo.
831
+ # The starting item must be less than or equal to the ending one.
832
+ # Just as {Wx::ListCtrl#refresh_item} this is only useful for virtual list controls.
833
+ # @param itemFrom [Integer]
834
+ # @param itemTo [Integer]
835
+ # @return [void]
836
+ def refresh_items(itemFrom, itemTo) end
837
+
838
+ # Scrolls the list control.
839
+ # 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.
840
+ # This method is currently only implemented in the Windows version.
841
+ # @param dx [Integer]
842
+ # @param dy [Integer]
843
+ # @return [true,false]
844
+ def scroll_list(dx, dy) end
845
+
846
+ # Sets the background colour.
847
+ # Note that the {Wx::Window#get_background_colour} function of {Wx::Window} base class can be used to retrieve the current background colour.
848
+ # If alternate row colouring is enabled, then call {Wx::ListCtrl#enable_alternate_row_colours} again after changing the background colour. This will update the alternate row color to match the new background colour.
849
+ # @param col [Wx::Colour,String,Symbol]
850
+ # @return [true,false]
851
+ def set_background_colour(col) end
852
+ alias_method :background_colour=, :set_background_colour
853
+
854
+ # Sets information about this column.
855
+ # See {Wx::ListCtrl#set_item} for more information.
856
+ # @param col [Integer]
857
+ # @param item [Wx::ListItem]
858
+ # @return [true,false]
859
+ def set_column(col, item) end
860
+
861
+ # Sets the column width.
862
+ # width can be a width in pixels or {Wx::LIST_AUTOSIZE} (-1) or {Wx::LIST_AUTOSIZE_USEHEADER} (-2).
863
+ # {Wx::LIST_AUTOSIZE} will resize the column to the length of its longest item.
864
+ # {Wx::LIST_AUTOSIZE_USEHEADER} will resize the column to the length of the header (Win32) or 80 pixels (other platforms).
865
+ # In small or normal icon view, col must be -1, and the column width is set for all columns.
866
+ # @param col [Integer]
867
+ # @param width [Integer]
868
+ # @return [true,false]
869
+ def set_column_width(col, width) end
870
+
871
+ # Changes the order in which the columns are shown.
872
+ # The orders array must have the same number elements as the number of columns and contain each position exactly once. Its n-th element contains the index of the column to be shown in n-th position, so for a control with three columns passing an array with elements 2, 0 and 1 results in the third column being displayed first, the first one next and the second one last.
873
+ # This function makes sense for report view only and currently is only implemented in the {Wx::MSW} port. Use {Wx::HAS_LISTCTRL_COLUMN_ORDER} to guard uses of this function so that they will start working under the other platforms when support for the column reordering is added there.
874
+ # @see Wx::ListCtrl#get_columns_order
875
+ # @param orders [Array<Integer>]
876
+ # @return [true,false]
877
+ def set_columns_order(orders) end
878
+ alias_method :columns_order=, :set_columns_order
879
+
880
+ # Change the font and the colours used for the list control header.
881
+ # 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).
882
+ # Currently it is implemented only for {Wx::MSW} and does nothing in the other ports.
883
+ #
884
+ # true if the attributes have been updated or false if this is not supported by the current platform.
885
+ # @param attr [Wx::ItemAttr] The object containing the font and text and background colours to use. It may be default, i.e. not specify any custom font nor colours, to reset any previously set custom attribute.
886
+ # @return [true,false]
887
+ def set_header_attr(attr) end
888
+ alias_method :header_attr=, :set_header_attr
889
+
890
+ # Sets the image list associated with the control.
891
+ # 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.
892
+ # which must be one of {Wx::IMAGE_LIST_NORMAL}, {Wx::IMAGE_LIST_SMALL}, {Wx::IMAGE_LIST_STATE} (support for the last one is unimplemented).
893
+ # This method does not take ownership of the image list, you have to delete it yourself.
894
+ # Note that, unlike for most of the other methods of this class, it is possible to call this function before the corresponding window is created, i.e. do it in a constructor of a class derived from {Wx::ListCtrl} before calling {Wx::ListCtrl#create}.
895
+ # @see Wx::ListCtrl#assign_image_list
896
+ # @param imageList [Wx::ImageList]
897
+ # @param which [Integer]
898
+ # @return [void]
899
+ def set_image_list(imageList, which) end
900
+
901
+ # Sets the images to use when showing large, normal icons in this control.
902
+ # 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.
903
+ # 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.
904
+ # @param images [Wx::Vector< wxBitmapBundle >]
905
+ # @return [void]
906
+ def set_normal_images(images) end
907
+ alias_method :normal_images=, :set_normal_images
908
+
909
+ # Sets the images to use when showing small icons in this control.
910
+ # 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.
911
+ # 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.
912
+ # @param images [Wx::Vector< wxBitmapBundle >]
913
+ # @return [void]
914
+ def set_small_images(images) end
915
+ alias_method :small_images=, :set_small_images
916
+
917
+ # Check if the item is visible.
918
+ # An item is considered visible if at least one pixel of it is present on the screen.
919
+ # @param item [Integer]
920
+ # @return [true,false]
921
+ def is_visible(item) end
922
+ alias_method :visible?, :is_visible
923
+
924
+ # @overload set_item(info)
925
+ # Sets the data of an item.
926
+ # Using the {Wx::ListItem}'s mask and state mask, you can change only selected attributes of a {Wx::ListCtrl} item.
927
+ # true if the item was successfully updated or false if the update failed for some reason (e.g. an invalid item index).
928
+ # @param info [Wx::ListItem]
929
+ # @return [true,false]
930
+ # @overload set_item(index, column, label, imageId=-1)
931
+ # Sets an item string field at a particular column.
932
+ # true if the item was successfully updated or false if the update failed for some reason (e.g. an invalid item index).
933
+ # @param index [Integer]
934
+ # @param column [Integer]
935
+ # @param label [String]
936
+ # @param imageId [Integer]
937
+ # @return [true,false]
938
+ def set_item(*args) end
939
+ alias_method :item=, :set_item
940
+
941
+ # Sets the background colour for this item.
942
+ # This function only works in report view mode. The colour can be retrieved using {Wx::ListCtrl#get_item_background_colour}.
943
+ # @param item [Integer]
944
+ # @param col [Wx::Colour,String,Symbol]
945
+ # @return [void]
946
+ def set_item_background_colour(item, col) end
947
+
948
+ # Sets the image associated with the item.
949
+ # In report view, you can specify the column. The image is an index into the image list associated with the list control.
950
+ # @param item [Integer]
951
+ # @param column [Integer]
952
+ # @param image [Integer]
953
+ # @return [true,false]
954
+ def set_item_column_image(item, column, image) end
955
+
956
+ # This method can only be used with virtual list controls.
957
+ # 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.
958
+ # 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.
959
+ # @param count [Integer]
960
+ # @return [void]
961
+ def set_item_count(count) end
962
+ alias_method :item_count=, :set_item_count
963
+
964
+ # Sets the item's font.
965
+ # @param item [Integer]
966
+ # @param font [Wx::Font,Wx::FontInfo]
967
+ # @return [void]
968
+ def set_item_font(item, font) end
969
+
970
+ # Sets the unselected and selected images associated with the item.
971
+ # The images are indices into the image list associated with the list control.
972
+ # @param item [Integer]
973
+ # @param image [Integer]
974
+ # @param selImage [Integer]
975
+ # @return [true,false]
976
+ def set_item_image(item, image, selImage=-1) end
977
+
978
+ # Sets the position of the item, in icon or small icon view.
979
+ # Windows only.
980
+ # @param item [Integer]
981
+ # @param pos [Array(Integer, Integer), Wx::Point]
982
+ # @return [true,false]
983
+ def set_item_position(item, pos) end
984
+
985
+ # Sets the item state.
986
+ # 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.
987
+ # So to select an item you can use
988
+ #
989
+ # list->SetItemState(item, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
990
+ # while to deselect it you should use
991
+ #
992
+ # list->SetItemState(item, 0, wxLIST_STATE_SELECTED);
993
+ #
994
+ # Consider using {Wx::ListView} if possible to avoid dealing with this error-prone and confusing method.
995
+ # Also notice that contrary to the usual rule that only user actions generate events, this method does generate {Wx::EVT_LIST_ITEM_SELECTED} event when it is used to select an item.
996
+ # @param item [Integer]
997
+ # @param state [Integer]
998
+ # @param stateMask [Integer]
999
+ # @return [true,false]
1000
+ def set_item_state(item, state, stateMask) end
1001
+
1002
+ # Sets the item text for this item.
1003
+ # @param item [Integer]
1004
+ # @param text [String]
1005
+ # @return [void]
1006
+ def set_item_text(item, text) end
1007
+
1008
+ # Sets the colour for this item.
1009
+ # This function only works in report view. The colour can be retrieved using {Wx::ListCtrl#get_item_text_colour}.
1010
+ # @param item [Integer]
1011
+ # @param col [Wx::Colour,String,Symbol]
1012
+ # @return [void]
1013
+ def set_item_text_colour(item, col) end
1014
+
1015
+ # Adds or removes a single window style.
1016
+ # @param style [Integer]
1017
+ # @param add [true,false]
1018
+ # @return [void]
1019
+ def set_single_style(style, add=true) end
1020
+ alias_method :single_style=, :set_single_style
1021
+
1022
+ # Sets the text colour of the list control.
1023
+ # @param col [Wx::Colour,String,Symbol]
1024
+ # @return [void]
1025
+ def set_text_colour(col) end
1026
+ alias_method :text_colour=, :set_text_colour
1027
+
1028
+ # Sets the whole window style, deleting all items.
1029
+ # @param style [Integer]
1030
+ # @return [void]
1031
+ def set_window_style_flag(style) end
1032
+ alias_method :window_style_flag=, :set_window_style_flag
1033
+
1034
+ # Returns true if checkboxes are enabled for list items.
1035
+ #
1036
+ # @see Wx::ListCtrl#enable_check_boxes
1037
+ # @return [true,false]
1038
+ def has_check_boxes; end
1039
+ alias_method :has_check_boxes?, :has_check_boxes
1040
+
1041
+ # Enable or disable checkboxes for list items.
1042
+ # true if checkboxes are supported, false otherwise.
1043
+ #
1044
+ # 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.
1045
+ # @see Wx::ListCtrl#on_get_item_is_checked Wx::ListCtrl#refresh_item
1046
+ # @param enable [true,false] If true, enable checkboxes, otherwise disable checkboxes.
1047
+ # @return [true,false]
1048
+ def enable_check_boxes(enable=true) end
1049
+
1050
+ # Return true if the checkbox for the given {Wx::ListItem} is checked.
1051
+ # Always returns false if checkboxes support hadn't been enabled.
1052
+ # @param item [Integer] Item (zero-based) index.
1053
+ # @return [true,false]
1054
+ def is_item_checked(item) end
1055
+ alias_method :item_checked?, :is_item_checked
1056
+
1057
+ # Check or uncheck a {Wx::ListItem} in a control using checkboxes.
1058
+ # This method only works if checkboxes support had been successfully enabled using {Wx::ListCtrl#enable_check_boxes}.
1059
+ # @param item [Integer] Item (zero-based) index.
1060
+ # @param check [true,false] If true, check the item, otherwise uncheck.
1061
+ # @return [void]
1062
+ def check_item(item, check) end
1063
+
1064
+ # Extend rules and alternate rows background to the entire client area.
1065
+ # 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.
1066
+ # Calling this function extends the display of the rules and alternate background rows to the entire client area.
1067
+ # 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.
1068
+ # Note that this method is currently not implemented in the native MSW version and does nothing there.
1069
+ # @param extend [true,false] if true, draws horizontal rules and vertical rules on empty rows and uses the colour parameter to paint the background of alternate rows when those rows are blank, empty, with no data.
1070
+ # @return [void]
1071
+ def extend_rules_and_alternate_colour(extend=true) end
1072
+
1073
+ # Show the sort indicator of a specific column in a specific direction.
1074
+ # Sort indicators are only shown in report view and in the native {Wx::MSW} version override any column icon, i.e. if the sort indicator is shown for a column, no (other) icon is shown.
1075
+ # This function should typically be called from EVT_LIST_COL_CLICK handler.
1076
+ # This does not actually sort the list, use {Wx::ListCtrl#sort_items} for this.
1077
+ # @param col [Integer] The column to set the sort indicator for. If <code>-1</code> is given, then the currently shown sort indicator will be removed.
1078
+ # @param ascending [true,false] If true or false show the sort indicator corresponding to ascending or descending sort order respectively.
1079
+ # @return [void]
1080
+ def show_sort_indicator(col, ascending=true) end
1081
+
1082
+ # Remove the sort indicator from the column being used as sort key.
1083
+ # @return [void]
1084
+ def remove_sort_indicator; end
1085
+
1086
+ # Returns the column that shows the sort indicator.
1087
+ # Can return <code>-1</code> if there is no sort indicator currently shown.
1088
+ # @return [Integer]
1089
+ def get_sort_indicator; end
1090
+ alias_method :sort_indicator, :get_sort_indicator
1091
+
1092
+ # Returns the new value to use for sort indicator after clicking a column.
1093
+ # 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.
1094
+ # For example:
1095
+ #
1096
+ # void MyListCtrl::OnColClick(wxListEvent& event)
1097
+ # {
1098
+ # int col = event.GetColumn();
1099
+ # if ( col == -1 )
1100
+ # return; // clicked outside any column.
1101
+ #
1102
+ # const bool ascending = GetUpdatedAscendingSortIndicator(col);
1103
+ # SortItems(MyCompareFunction, ascending);
1104
+ # ShowSortIndicator(col, ascending);
1105
+ # }
1106
+ # @param col [Integer]
1107
+ # @return [true,false]
1108
+ def get_updated_ascending_sort_indicator(col) end
1109
+ alias_method :updated_ascending_sort_indicator, :get_updated_ascending_sort_indicator
1110
+
1111
+ # Returns true if the sort indicator direction is ascending, false when the direction is descending.
1112
+ # @return [true,false]
1113
+ def is_ascending_sort_indicator; end
1114
+ alias_method :ascending_sort_indicator?, :is_ascending_sort_indicator
1115
+
1116
+
1117
+ protected
1118
+
1119
+ # This function may be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style.
1120
+ # It should return the attribute for the specified item or NULL to use the default appearance parameters.
1121
+ # {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.
1122
+ # The base class version always returns NULL.
1123
+ # @see Wx::ListCtrl#on_get_item_image
1124
+ # @see Wx::ListCtrl#on_get_item_column_image
1125
+ # @see Wx::ListCtrl#on_get_item_text
1126
+ # @see Wx::ListCtrl#on_get_item_column_attr
1127
+ # @see Wx::ListCtrl#on_get_item_is_checked
1128
+ # @param item [Integer]
1129
+ # @return [Wx::ItemAttr]
1130
+ def on_get_item_attr(item) end
1131
+
1132
+ # This function may be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style.
1133
+ # It should return the attribute for the for the specified item and column or NULL to use the default appearance parameters.
1134
+ # The base class version returns <code>OnGetItemAttr(item)</code>.
1135
+ # Currently this function is only called under {Wx::MSW}, the other ports only support {Wx::ListCtrl#on_get_item_attr}
1136
+ # @see Wx::ListCtrl#on_get_item_attr
1137
+ # @see Wx::ListCtrl#on_get_item_text
1138
+ # @see Wx::ListCtrl#on_get_item_image
1139
+ # @see Wx::ListCtrl#on_get_item_column_image
1140
+ # @see
1141
+ # @param item [Integer]
1142
+ # @param column [Integer]
1143
+ # @return [Wx::ItemAttr]
1144
+ def on_get_item_column_attr(item, column) end
1145
+
1146
+ # 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.
1147
+ # The base class version always calls {Wx::ListCtrl#on_get_item_image} for the first column, else it returns -1.
1148
+ # @see Wx::ListCtrl#on_get_item_text
1149
+ # @see Wx::ListCtrl#on_get_item_image
1150
+ # @see Wx::ListCtrl#on_get_item_attr
1151
+ # @see Wx::ListCtrl#on_get_item_column_attr
1152
+ # @param item [Integer]
1153
+ # @param column [Integer]
1154
+ # @return [Integer]
1155
+ def on_get_item_column_image(item, column) end
1156
+
1157
+ # This function must be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style using images.
1158
+ # 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.
1159
+ # It should return the index of the items image in the controls image list or -1 for no image.
1160
+ # In a control with {Wx::LC_REPORT} style, {Wx::ListCtrl#on_get_item_image} only gets called for the first column of each line.
1161
+ # The base class version always returns -1.
1162
+ # @see Wx::ListCtrl#on_get_item_text
1163
+ # @see Wx::ListCtrl#on_get_item_column_image
1164
+ # @see Wx::ListCtrl#on_get_item_attr
1165
+ # @param item [Integer]
1166
+ # @return [Integer]
1167
+ def on_get_item_image(item) end
1168
+
1169
+ # This function <b>must</b> be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style.
1170
+ # It should return the string containing the text of the given column for the specified item.
1171
+ # @see Wx::ListCtrl#set_item_count
1172
+ # @see Wx::ListCtrl#on_get_item_image
1173
+ # @see Wx::ListCtrl#on_get_item_column_image
1174
+ # @see Wx::ListCtrl#on_get_item_attr
1175
+ # @param item [Integer]
1176
+ # @param column [Integer]
1177
+ # @return [String]
1178
+ def on_get_item_text(item, column) end
1179
+
1180
+ # This function <b>must</b> be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style that uses checkboxes.
1181
+ # It should return whether the checkbox of the specified item is checked.
1182
+ # @see Wx::ListCtrl#enable_check_boxes
1183
+ # @see Wx::ListCtrl#on_get_item_text
1184
+ # @param item [Integer]
1185
+ # @return [true,false]
1186
+ def on_get_item_is_checked(item) end
1187
+
1188
+ end # ListCtrl
1189
+
1190
+ # This class stores information about a {Wx::ListCtrl} item or column.
1191
+ # {Wx::ListItem} is a class which contains information about:
1192
+ # - Zero based item position; see {Wx::ListItem#set_id} and {Wx::ListItem#get_id}.- Zero based column index; see {Wx::ListItem#set_column} and {Wx::ListItem#get_column}.- The label (or header for columns); see {Wx::ListItem#set_text} and {Wx::ListItem#get_text}.- The zero based index into an image list; see {Wx::ListItem#get_image} and {Wx::ListItem#set_image}.- Application defined data; see {Wx::ListItem#set_data} and {Wx::ListItem#get_data}.- For columns only: the width of the column; see {Wx::ListItem#set_width} and {Wx::ListItem#get_width}.- For columns only: the format of the column; one of {Wx::ListColumnFormat::LIST_FORMAT_LEFT}, {Wx::ListColumnFormat::LIST_FORMAT_RIGHT}, {Wx::ListColumnFormat::LIST_FORMAT_CENTRE}. See {Wx::ListItem#set_align} and {Wx::ListItem#get_align}.- The state of the item; see {Wx::ListItem#set_state} and {Wx::ListItem#get_state}. This is a bitlist of the following flags:
1193
+ # - {Wx::LIST_STATE_FOCUSED}: The item has the focus.- {Wx::LIST_STATE_SELECTED}: The item is selected.- {Wx::LIST_STATE_DONTCARE}: No special flags (the value of this constant is 0).- {Wx::LIST_STATE_DROPHILITED}: The item is highlighted to receive a drop event. Win32 only.- {Wx::LIST_STATE_CUT}: The item is in the cut state. Win32 only.- A mask indicating which state flags are valid; this is a bitlist of the flags reported above for the item state. See {Wx::ListItem#set_state_mask} and GetStateMask().- A mask indicating which fields of this class are valid; see {Wx::ListItem#set_mask} and {Wx::ListItem#get_mask}. This is a bitlist of the following flags:
1194
+ # - {Wx::LIST_MASK_STATE}: The state field is valid.- {Wx::LIST_MASK_TEXT}: The label field is valid.- {Wx::LIST_MASK_IMAGE}: The image field is valid.- {Wx::LIST_MASK_DATA}: The application-defined data field is valid.- {Wx::LIST_MASK_WIDTH}: The column width field is valid.- {Wx::LIST_MASK_FORMAT}: The column format field is valid.
1195
+ #
1196
+ # The {Wx::ListItem} object can also contain item-specific colour and font information: for this you need to call one of {Wx::ListItem#set_text_colour}, {Wx::ListItem#set_background_colour} or {Wx::ListItem#set_font} functions on it passing it the colour/font to use. If the colour/font is not specified, the default list control colour/font is used.
1197
+ # ===
1198
+ #
1199
+ # Category: Data Structures
1200
+ # @see Wx::ListCtrl
1201
+ #
1202
+ #
1203
+ class ListItem < Object
1204
+
1205
+ # Sets client data for the item.
1206
+ # Please note that client data is associated with the item and not with subitems.
1207
+ # @param data [Object]
1208
+ # @return [void]
1209
+ def set_data(data) end
1210
+ alias_method :data=, :set_data
1211
+
1212
+ # Constructor.
1213
+ # @return [ListItem]
1214
+ def initialize; end
1215
+
1216
+ # Resets the item state to the default.
1217
+ # @return [void]
1218
+ def clear; end
1219
+
1220
+ # Returns the alignment for this item.
1221
+ # Can be one of {Wx::ListColumnFormat::LIST_FORMAT_LEFT}, {Wx::ListColumnFormat::LIST_FORMAT_RIGHT} or {Wx::ListColumnFormat::LIST_FORMAT_CENTRE}.
1222
+ # @return [ListColumnFormat]
1223
+ def get_align; end
1224
+ alias_method :align, :get_align
1225
+
1226
+ # Returns the background colour for this item.
1227
+ # @return [Wx::Colour]
1228
+ def get_background_colour; end
1229
+ alias_method :background_colour, :get_background_colour
1230
+
1231
+ # Returns the zero-based column; meaningful only in report mode.
1232
+ # @return [Integer]
1233
+ def get_column; end
1234
+ alias_method :column, :get_column
1235
+
1236
+ # Returns the font used to display the item.
1237
+ # @return [Wx::Font]
1238
+ def get_font; end
1239
+ alias_method :font, :get_font
1240
+
1241
+ # Returns the zero-based item position.
1242
+ # @return [Integer]
1243
+ def get_id; end
1244
+ alias_method :id, :get_id
1245
+
1246
+ # Returns the zero-based index of the image associated with the item into the image list.
1247
+ # @return [Integer]
1248
+ def get_image; end
1249
+ alias_method :image, :get_image
1250
+
1251
+ # Returns a bit mask indicating which fields of the structure are valid.
1252
+ # Can be any combination of the following values:
1253
+ # - {Wx::LIST_MASK_STATE}: <b>GetState</b> is valid.- {Wx::LIST_MASK_TEXT}: <b>GetText</b> is valid.- {Wx::LIST_MASK_IMAGE}: <b>GetImage</b> is valid.- {Wx::LIST_MASK_DATA}: <b>GetData</b> is valid.- {Wx::LIST_MASK_WIDTH}: <b>GetWidth</b> is valid.- {Wx::LIST_MASK_FORMAT}: <b>GetFormat</b> is valid.
1254
+ # @return [Integer]
1255
+ def get_mask; end
1256
+ alias_method :mask, :get_mask
1257
+
1258
+ # Returns a bit field representing the state of the item.
1259
+ # Can be any combination of:
1260
+ # - {Wx::LIST_STATE_DONTCARE}: No special flags (the values of this constant is 0).- {Wx::LIST_STATE_DROPHILITED}: The item is highlighted to receive a drop event. Win32 only.- {Wx::LIST_STATE_FOCUSED}: The item has the focus.- {Wx::LIST_STATE_SELECTED}: The item is selected.- {Wx::LIST_STATE_CUT}: The item is in the cut state. Win32 only.
1261
+ # @return [Integer]
1262
+ def get_state; end
1263
+ alias_method :state, :get_state
1264
+
1265
+ # Returns the label/header text.
1266
+ # @return [Wx::String]
1267
+ def get_text; end
1268
+ alias_method :text, :get_text
1269
+
1270
+ # Returns the text colour.
1271
+ # @return [Wx::Colour]
1272
+ def get_text_colour; end
1273
+ alias_method :text_colour, :get_text_colour
1274
+
1275
+ # Meaningful only for column headers in report mode.
1276
+ # Returns the column width.
1277
+ # @return [Integer]
1278
+ def get_width; end
1279
+ alias_method :width, :get_width
1280
+
1281
+ # Sets the alignment for the item.
1282
+ # See also {Wx::ListItem#get_align}
1283
+ # @param align [ListColumnFormat]
1284
+ # @return [void]
1285
+ def set_align(align) end
1286
+ alias_method :align=, :set_align
1287
+
1288
+ # Sets the background colour for the item.
1289
+ # @param colBack [Wx::Colour,String,Symbol]
1290
+ # @return [void]
1291
+ def set_background_colour(colBack) end
1292
+ alias_method :background_colour=, :set_background_colour
1293
+
1294
+ # Sets the zero-based column.
1295
+ # Meaningful only in report mode.
1296
+ # @param col [Integer]
1297
+ # @return [void]
1298
+ def set_column(col) end
1299
+ alias_method :column=, :set_column
1300
+
1301
+ # Sets the font for the item.
1302
+ # @param font [Wx::Font,Wx::FontInfo]
1303
+ # @return [void]
1304
+ def set_font(font) end
1305
+ alias_method :font=, :set_font
1306
+
1307
+ # Sets the zero-based item position.
1308
+ # @param id [Integer]
1309
+ # @return [void]
1310
+ def set_id(id) end
1311
+ alias_method :id=, :set_id
1312
+
1313
+ # Sets the zero-based index of the image associated with the item into the image list.
1314
+ # @param image [Integer]
1315
+ # @return [void]
1316
+ def set_image(image) end
1317
+ alias_method :image=, :set_image
1318
+
1319
+ # Sets the mask of valid fields.
1320
+ # See {Wx::ListItem#get_mask}.
1321
+ # @param mask [Integer]
1322
+ # @return [void]
1323
+ def set_mask(mask) end
1324
+ alias_method :mask=, :set_mask
1325
+
1326
+ # 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}).
1327
+ # See {Wx::ListItem#get_state} for valid flag values.
1328
+ # @param state [Integer]
1329
+ # @return [void]
1330
+ def set_state(state) end
1331
+ alias_method :state=, :set_state
1332
+
1333
+ # Sets the bitmask that is used to determine which of the state flags are to be set.
1334
+ # See also {Wx::ListItem#set_state}.
1335
+ # @param stateMask [Integer]
1336
+ # @return [void]
1337
+ def set_state_mask(stateMask) end
1338
+ alias_method :state_mask=, :set_state_mask
1339
+
1340
+ # Sets the text label for the item.
1341
+ # @param text [String]
1342
+ # @return [void]
1343
+ def set_text(text) end
1344
+ alias_method :text=, :set_text
1345
+
1346
+ # Sets the text colour for the item.
1347
+ # @param colText [Wx::Colour,String,Symbol]
1348
+ # @return [void]
1349
+ def set_text_colour(colText) end
1350
+ alias_method :text_colour=, :set_text_colour
1351
+
1352
+ # Meaningful only for column headers in report mode.
1353
+ # Sets the column width.
1354
+ # @param width [Integer]
1355
+ # @return [void]
1356
+ def set_width(width) end
1357
+ alias_method :width=, :set_width
1358
+
1359
+ end # ListItem
1360
+
1361
+ # Represents the attributes (colour, font, ...) of an item of a control with multiple items such as e.g.
1362
+ # {Wx::ListCtrl}.
1363
+ # ===
1364
+ #
1365
+ # Category: Data Structures
1366
+ # @see wxListCtrl Overview
1367
+ #
1368
+ #
1369
+ class ItemAttr < ::Object
1370
+
1371
+ # @overload initialize()
1372
+ # Default Constructor.
1373
+ # @return [ItemAttr]
1374
+ # @overload initialize(colText, colBack, font)
1375
+ # Construct a {Wx::ItemAttr} with the specified foreground and background colours and font.
1376
+ # @param colText [Wx::Colour,String,Symbol]
1377
+ # @param colBack [Wx::Colour,String,Symbol]
1378
+ # @param font [Wx::Font,Wx::FontInfo]
1379
+ # @return [ItemAttr]
1380
+ def initialize(*args) end
1381
+
1382
+ # Compare two item attributes for equality.
1383
+ # @param other [Wx::ItemAttr]
1384
+ # @return [true,false]
1385
+ def ==(other) end
1386
+
1387
+ # Returns the currently set background colour.
1388
+ # @return [Wx::Colour,String,Symbol]
1389
+ def get_background_colour; end
1390
+ alias_method :background_colour, :get_background_colour
1391
+
1392
+ # Returns the currently set font.
1393
+ # @return [Wx::Font,Wx::FontInfo]
1394
+ def get_font; end
1395
+ alias_method :font, :get_font
1396
+
1397
+ # Returns the currently set text colour.
1398
+ # @return [Wx::Colour,String,Symbol]
1399
+ def get_text_colour; end
1400
+ alias_method :text_colour, :get_text_colour
1401
+
1402
+ # Returns true if the currently set background colour is valid.
1403
+ # @return [true,false]
1404
+ def has_background_colour; end
1405
+ alias_method :has_background_colour?, :has_background_colour
1406
+
1407
+ # Returns true if either text or background colour is set.
1408
+ #
1409
+ # @see Wx::ItemAttr#has_background_colour
1410
+ # @see Wx::ItemAttr#has_text_colour
1411
+ # @return [true,false]
1412
+ def has_colours; end
1413
+ alias_method :has_colours?, :has_colours
1414
+
1415
+ # Returns true if the currently set font is valid.
1416
+ # @return [true,false]
1417
+ def has_font; end
1418
+ alias_method :has_font?, :has_font
1419
+
1420
+ # Returns true if the currently set text colour is valid.
1421
+ # @return [true,false]
1422
+ def has_text_colour; end
1423
+ alias_method :has_text_colour?, :has_text_colour
1424
+
1425
+ # Returns true if this object has no custom attributes set.
1426
+ # @return [true,false]
1427
+ def is_default; end
1428
+ alias_method :default?, :is_default
1429
+
1430
+ # Sets a new background colour.
1431
+ # @param colour [Wx::Colour,String,Symbol]
1432
+ # @return [void]
1433
+ def set_background_colour(colour) end
1434
+ alias_method :background_colour=, :set_background_colour
1435
+
1436
+ # Sets a new font.
1437
+ # @param font [Wx::Font,Wx::FontInfo]
1438
+ # @return [void]
1439
+ def set_font(font) end
1440
+ alias_method :font=, :set_font
1441
+
1442
+ # Sets a new text colour.
1443
+ # @param colour [Wx::Colour,String,Symbol]
1444
+ # @return [void]
1445
+ def set_text_colour(colour) end
1446
+ alias_method :text_colour=, :set_text_colour
1447
+
1448
+ end # ItemAttr
1449
+
1450
+ # 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.
1451
+ # 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.
1452
+ # Other than different interface, this class is identical to {Wx::ListCtrl}. In particular, it uses the same events, same window styles and so on.
1453
+ # ===
1454
+ #
1455
+ # Category: {Wx::Controls} <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
1456
+ # </td><td> {Wx::GTK} Appearance
1457
+ # </td><td> {Wx::OSX} Appearance
1458
+ # </td></tr></table></div>
1459
+ # @see Wx::ListView#set_column_image
1460
+ #
1461
+ #
1462
+ class ListView < ListCtrl
1463
+
1464
+ # @overload initialize()
1465
+ # Default constructor.
1466
+ # @return [ListView]
1467
+ # @overload initialize(parent, winid=Wx::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::LC_REPORT, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_CTRL_NAME_STR)
1468
+ # Constructor, creating and showing a listview control.
1469
+ #
1470
+ # @see Wx::ListView#create
1471
+ # @see Wx::Validator
1472
+ # @param parent [Wx::Window] Parent window. Must not be NULL.
1473
+ # @param winid [Integer] Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
1474
+ # @param pos [Array(Integer, Integer), Wx::Point] Window position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
1475
+ # @param size [Array(Integer, Integer), Wx::Size] Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
1476
+ # @param style [Integer] Window style. See {Wx::ListCtrl}.
1477
+ # @param validator [Wx::Validator] Window validator.
1478
+ # @param name [String] Window name.
1479
+ # @return [ListView]
1480
+ def initialize(*args) end
1481
+
1482
+ # Resets the column image after calling this function, no image will be shown.
1483
+ #
1484
+ # @see Wx::ListView#set_column_image
1485
+ # @param col [Integer] the column to clear image for
1486
+ # @return [void]
1487
+ def clear_column_image(col) end
1488
+
1489
+ # Sets focus to the item with the given index.
1490
+ # @param index [Integer]
1491
+ # @return [void]
1492
+ def focus(index) end
1493
+
1494
+ # Returns the first selected item in a (presumably) multiple selection control.
1495
+ # Together with {Wx::ListView#get_next_selected} it can be used to iterate over all selected items in the control.
1496
+ # The first selected item, if any, -1 otherwise.
1497
+ # @return [Integer]
1498
+ def get_first_selected; end
1499
+ alias_method :first_selected, :get_first_selected
1500
+
1501
+ # Returns the currently focused item or -1 if none.
1502
+ #
1503
+ # @see Wx::ListView#is_selected
1504
+ # @see Wx::ListView#focus
1505
+ # @return [Integer]
1506
+ def get_focused_item; end
1507
+ alias_method :focused_item, :get_focused_item
1508
+
1509
+ # Used together with {Wx::ListView#get_first_selected} to iterate over all selected items in the control.
1510
+ # Returns the next selected item or -1 if there are no more of them.
1511
+ # @param item [Integer]
1512
+ # @return [Integer]
1513
+ def get_next_selected(item) end
1514
+ alias_method :next_selected, :get_next_selected
1515
+
1516
+ # Returns true if the item with the given index is selected, false otherwise.
1517
+ #
1518
+ # @see Wx::ListView#get_first_selected
1519
+ # @see Wx::ListView#get_next_selected
1520
+ # @param index [Integer]
1521
+ # @return [true,false]
1522
+ def is_selected(index) end
1523
+ alias_method :selected?, :is_selected
1524
+
1525
+ # Selects or unselects the given item.
1526
+ # 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.
1527
+ # @param n [Integer] the item to select or unselect
1528
+ # @param on [true,false] if true (default), selects the item, otherwise unselects it
1529
+ # @return [void]
1530
+ def select(n, on=true) end
1531
+
1532
+ # Sets the column image for the specified column.
1533
+ # To use the column images, the control must have a valid image list with at least one image.
1534
+ # @param col [Integer] the column to set image for
1535
+ # @param image [Integer] the index of the column image in the controls image list
1536
+ # @return [void]
1537
+ def set_column_image(col, image) end
1538
+
1539
+ end # ListView
1540
+
1541
+
1542
+ end