wxruby3 1.7.0 → 1.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (522) hide show
  1. checksums.yaml +4 -4
  2. data/INSTALL.md +27 -2
  3. data/README.md +15 -15
  4. data/ext/wxruby3/include/wxRubyApp.h +145 -46
  5. data/ext/wxruby3/include/wxruby-ComboPopup.h +25 -8
  6. data/ext/wxruby3/include/wxruby-GCTracking.h +262 -0
  7. data/ext/wxruby3/include/wxruby-MBConv.h +190 -0
  8. data/ext/wxruby3/include/wxruby-SharedEventHandler.h +183 -0
  9. data/ext/wxruby3/include/wxruby-SharedPtr.h +104 -0
  10. data/ext/wxruby3/include/wxruby-runtime.h +29 -0
  11. data/ext/wxruby3/swig/custom/rubytracking.swg +8 -22
  12. data/ext/wxruby3/swig/custom/wx_ruby_shared_ptr.i +434 -0
  13. data/ext/wxruby3/swig/custom/wx_shared_ptr.i +431 -0
  14. data/ext/wxruby3/swig/mark_free_impl.i +7 -132
  15. data/ext/wxruby3/swig/memory_management.i +8 -44
  16. data/ext/wxruby3/swig/wx.i +46 -73
  17. data/lib/wx/core/const.rb +0 -1
  18. data/lib/wx/core/context_help.rb +17 -0
  19. data/lib/wx/core/cursor.rb +1 -0
  20. data/lib/wx/core/helpcontrollerhelpprovider.rb +10 -2
  21. data/lib/wx/core/mbconv.rb +11 -0
  22. data/lib/wx/core/media_ctrl.rb +31 -0
  23. data/lib/wx/core/top_level_window.rb +7 -0
  24. data/lib/wx/core.rb +6 -0
  25. data/lib/wx/doc/art_provider.rb +17 -0
  26. data/lib/wx/doc/context_help.rb +42 -0
  27. data/lib/wx/doc/core.rb +0 -5
  28. data/lib/wx/doc/functions.rb +10 -0
  29. data/lib/wx/doc/html/html_help_controller.rb +23 -1
  30. data/lib/wx/doc/mbconv.rb +108 -0
  31. data/lib/wx/doc/rt/shared_event_handler.rb +49 -0
  32. data/lib/wx/doc/rt/thread_event.rb +28 -0
  33. data/lib/wx/doc/stream.rb +7 -3
  34. data/lib/wx/doc/webview.rb +40 -0
  35. data/lib/wx/helpers.rb +1 -1
  36. data/lib/wx/html/htmlhelpcontroller.rb +10 -0
  37. data/lib/wx/keyword_defs.rb +11 -0
  38. data/lib/wx/rt/require.rb +8 -0
  39. data/lib/wx/rt/thread_event.rb +14 -0
  40. data/lib/wx/rt.rb +16 -0
  41. data/lib/wx/version.rb +1 -1
  42. data/lib/wx/web/require.rb +8 -0
  43. data/lib/wx/web/webview.rb +106 -0
  44. data/lib/wx/web.rb +17 -0
  45. data/lib/wx/wxruby/cmd/setup.rb +15 -0
  46. data/lib/wx/wxruby/cmd/test.rb +8 -2
  47. data/lib/wx.rb +2 -0
  48. data/rakelib/configure.rb +24 -0
  49. data/rakelib/gem.rb +3 -2
  50. data/rakelib/install.rb +54 -27
  51. data/rakelib/lib/config/macosx.rb +7 -5
  52. data/rakelib/lib/config/mingw.rb +66 -5
  53. data/rakelib/lib/config/pkgman/linux.rb +4 -2
  54. data/rakelib/lib/config/pkgman/mingw.rb +1 -1
  55. data/rakelib/lib/config/unixish.rb +4 -2
  56. data/rakelib/lib/config.rb +37 -3
  57. data/rakelib/lib/core/include/client_data.inc +38 -17
  58. data/rakelib/lib/core/include/funcall.inc +1 -1
  59. data/rakelib/lib/core/include/swigdirector.inc +3 -3
  60. data/rakelib/lib/core/include/swigrubyrun.inc +14 -26
  61. data/rakelib/lib/core/package.rb +0 -2
  62. data/rakelib/lib/director/app.rb +1 -8
  63. data/rakelib/lib/director/art_provider.rb +7 -3
  64. data/rakelib/lib/director/comboctrl.rb +0 -7
  65. data/rakelib/lib/director/context_help_button.rb +35 -2
  66. data/rakelib/lib/director/derived_dc.rb +41 -32
  67. data/rakelib/lib/director/editable_listbox.rb +10 -8
  68. data/rakelib/lib/director/event_handler.rb +32 -28
  69. data/rakelib/lib/director/fs_file.rb +38 -10
  70. data/rakelib/lib/director/functions.rb +8 -0
  71. data/rakelib/lib/director/grid_cell_attr.rb +1 -3
  72. data/rakelib/lib/director/grid_cell_editor.rb +14 -12
  73. data/rakelib/lib/director/grid_cell_renderer.rb +11 -8
  74. data/rakelib/lib/director/grid_ctrl.rb +140 -121
  75. data/rakelib/lib/director/help_controller.rb +70 -2
  76. data/rakelib/lib/director/mb_conv.rb +30 -0
  77. data/rakelib/lib/director/menu.rb +92 -42
  78. data/rakelib/lib/director/menu_bar.rb +84 -45
  79. data/rakelib/lib/director/menu_item.rb +2 -2
  80. data/rakelib/lib/director/persistence_manager.rb +3 -2
  81. data/rakelib/lib/director/preview_frame.rb +2 -2
  82. data/rakelib/lib/director/ribbon_page.rb +11 -0
  83. data/rakelib/lib/director/richtext_buffer.rb +5 -2
  84. data/rakelib/lib/director/shared_evt_handler.rb +30 -0
  85. data/rakelib/lib/director/sizer.rb +8 -17
  86. data/rakelib/lib/director/sizer_item.rb +3 -4
  87. data/rakelib/lib/director/task_bar_icon.rb +7 -7
  88. data/rakelib/lib/director/thread_event.rb +33 -0
  89. data/rakelib/lib/director/top_level_window.rb +12 -4
  90. data/rakelib/lib/director/validator.rb +3 -1
  91. data/rakelib/lib/director/variant.rb +16 -12
  92. data/rakelib/lib/director/webview.rb +166 -0
  93. data/rakelib/lib/director/webview_event.rb +37 -0
  94. data/rakelib/lib/director/webview_handler.rb +63 -0
  95. data/rakelib/lib/generate/doc/thread_event.yaml +20 -0
  96. data/rakelib/lib/generate/doc/web_view.yaml +135 -0
  97. data/rakelib/lib/generate/doc/web_view_event.yaml +38 -0
  98. data/rakelib/lib/generate/doc/web_view_handler.yaml +58 -0
  99. data/rakelib/lib/specs/interfaces.rb +14 -2
  100. data/rakelib/lib/typemap/common.rb +34 -1
  101. data/rakelib/lib/typemap/mb_conv.rb +58 -0
  102. data/rakelib/prepost.rake +23 -31
  103. data/rakelib/prepost.rb +20 -0
  104. data/samples/event/threaded.rb +295 -42
  105. data/samples/event/tn_threaded.png +0 -0
  106. data/samples/help/doc/back.gif +0 -0
  107. data/samples/help/doc/contents.gif +0 -0
  108. data/samples/help/doc/cshelp.txt +9 -0
  109. data/samples/help/doc/doc.chm +0 -0
  110. data/samples/help/doc/doc.cnt +8 -0
  111. data/samples/help/doc/doc.h +7 -0
  112. data/samples/help/doc/doc.hhc +40 -0
  113. data/samples/help/doc/doc.hhk +31 -0
  114. data/samples/help/doc/doc.hhp +33 -0
  115. data/samples/help/doc/doc.hpj +21 -0
  116. data/samples/help/doc/doc.htm +27 -0
  117. data/samples/help/doc/doc1.htm +24 -0
  118. data/samples/help/doc/doc2.htm +12 -0
  119. data/samples/help/doc/doc3.htm +12 -0
  120. data/samples/help/doc/doc4.htm +12 -0
  121. data/samples/help/doc/doc5.htm +14 -0
  122. data/samples/help/doc/forward.gif +0 -0
  123. data/samples/help/doc/up.gif +0 -0
  124. data/samples/help/doc.chm +0 -0
  125. data/samples/help/doc.chw +0 -0
  126. data/samples/help/doc.zip +0 -0
  127. data/samples/help/help.rb +352 -0
  128. data/samples/help/tn_help.png +0 -0
  129. data/samples/webview/handler_advanced.html +55 -0
  130. data/samples/webview/tn_webview.png +0 -0
  131. data/samples/webview/webview.rb +1264 -0
  132. data/tests/assets/handler_advanced.html +55 -0
  133. data/tests/assets/test.zip +0 -0
  134. data/tests/lib/text_entry_tests.rb +2 -2
  135. data/tests/lib/wxapp_runner.rb +40 -0
  136. data/tests/lib/wxframe_runner.rb +17 -2
  137. data/tests/test_art.rb +8 -8
  138. data/tests/test_clipboard.rb +4 -4
  139. data/tests/test_config.rb +6 -6
  140. data/tests/test_exceptions.rb +8 -6
  141. data/tests/test_ext_controls.rb +3 -3
  142. data/tests/test_file_dialog.rb +5 -5
  143. data/tests/test_font.rb +7 -7
  144. data/tests/test_grid_ctrl.rb +133 -0
  145. data/tests/test_help.rb +88 -0
  146. data/tests/test_intl.rb +1 -1
  147. data/tests/test_media_ctrl.rb +14 -6
  148. data/tests/test_menu.rb +94 -86
  149. data/tests/test_persistence.rb +1 -1
  150. data/tests/test_proof_check.rb +5 -5
  151. data/tests/test_propgrid.rb +1 -1
  152. data/tests/test_shared_event_handler.rb +141 -0
  153. data/tests/test_std_controls.rb +5 -5
  154. data/tests/test_webview.rb +492 -0
  155. data/tests/test_window.rb +3 -3
  156. metadata +66 -368
  157. data/assets/repo-social-preview.odg +0 -0
  158. data/assets/repo-social-preview.xcf +0 -0
  159. data/lib/wx/aui/events/evt_list.rb +0 -148
  160. data/lib/wx/core/events/evt_list.rb +0 -1458
  161. data/lib/wx/core/font/encoding.rb +0 -113
  162. data/lib/wx/doc/gen/about_dialog_info.rb +0 -330
  163. data/lib/wx/doc/gen/accelerator.rb +0 -178
  164. data/lib/wx/doc/gen/activity_indicator.rb +0 -83
  165. data/lib/wx/doc/gen/affine_matrix2d.rb +0 -284
  166. data/lib/wx/doc/gen/animation.rb +0 -275
  167. data/lib/wx/doc/gen/animation_ctrl.rb +0 -300
  168. data/lib/wx/doc/gen/any_button.rb +0 -191
  169. data/lib/wx/doc/gen/app.rb +0 -463
  170. data/lib/wx/doc/gen/app_traits.rb +0 -396
  171. data/lib/wx/doc/gen/art_provider.rb +0 -605
  172. data/lib/wx/doc/gen/aui/aui_dock_art.rb +0 -455
  173. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +0 -54
  174. data/lib/wx/doc/gen/aui/aui_manager.rb +0 -847
  175. data/lib/wx/doc/gen/aui/aui_manager_event.rb +0 -131
  176. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +0 -180
  177. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +0 -59
  178. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +0 -130
  179. data/lib/wx/doc/gen/aui/aui_notebook.rb +0 -631
  180. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +0 -233
  181. data/lib/wx/doc/gen/aui/aui_pane_info.rb +0 -769
  182. data/lib/wx/doc/gen/aui/aui_tab_art.rb +0 -352
  183. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +0 -14
  184. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +0 -510
  185. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +0 -340
  186. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +0 -244
  187. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +0 -257
  188. data/lib/wx/doc/gen/aui/event_list.rb +0 -179
  189. data/lib/wx/doc/gen/banner_window.rb +0 -124
  190. data/lib/wx/doc/gen/bitmap.rb +0 -731
  191. data/lib/wx/doc/gen/bitmap_button.rb +0 -123
  192. data/lib/wx/doc/gen/bitmap_combo_box.rb +0 -221
  193. data/lib/wx/doc/gen/book_ctrl_base.rb +0 -273
  194. data/lib/wx/doc/gen/book_ctrl_event.rb +0 -66
  195. data/lib/wx/doc/gen/box_sizer.rb +0 -85
  196. data/lib/wx/doc/gen/brush.rb +0 -251
  197. data/lib/wx/doc/gen/busy_info.rb +0 -157
  198. data/lib/wx/doc/gen/button.rb +0 -182
  199. data/lib/wx/doc/gen/calculate_layout_event.rb +0 -62
  200. data/lib/wx/doc/gen/calendar_ctrl.rb +0 -505
  201. data/lib/wx/doc/gen/calendar_date_attr.rb +0 -138
  202. data/lib/wx/doc/gen/calendar_event.rb +0 -147
  203. data/lib/wx/doc/gen/caret.rb +0 -97
  204. data/lib/wx/doc/gen/check_box.rb +0 -175
  205. data/lib/wx/doc/gen/check_list_box.rb +0 -121
  206. data/lib/wx/doc/gen/choice.rb +0 -175
  207. data/lib/wx/doc/gen/choicebook.rb +0 -116
  208. data/lib/wx/doc/gen/client_dc.rb +0 -43
  209. data/lib/wx/doc/gen/clipboard.rb +0 -144
  210. data/lib/wx/doc/gen/collapsible_pane.rb +0 -138
  211. data/lib/wx/doc/gen/collapsible_pane_event.rb +0 -46
  212. data/lib/wx/doc/gen/colour.rb +0 -333
  213. data/lib/wx/doc/gen/colour_dialog.rb +0 -190
  214. data/lib/wx/doc/gen/colour_picker_ctrl.rb +0 -110
  215. data/lib/wx/doc/gen/colour_picker_event.rb +0 -77
  216. data/lib/wx/doc/gen/combo_box.rb +0 -292
  217. data/lib/wx/doc/gen/combo_ctrl.rb +0 -662
  218. data/lib/wx/doc/gen/command_link_button.rb +0 -134
  219. data/lib/wx/doc/gen/config_base.rb +0 -10
  220. data/lib/wx/doc/gen/context_help_button.rb +0 -109
  221. data/lib/wx/doc/gen/control.rb +0 -277
  222. data/lib/wx/doc/gen/control_with_items.rb +0 -253
  223. data/lib/wx/doc/gen/core.rb +0 -45
  224. data/lib/wx/doc/gen/credential_entry_dialog.rb +0 -137
  225. data/lib/wx/doc/gen/cursor.rb +0 -193
  226. data/lib/wx/doc/gen/data_format.rb +0 -85
  227. data/lib/wx/doc/gen/data_object.rb +0 -436
  228. data/lib/wx/doc/gen/data_object_simple_base.rb +0 -10
  229. data/lib/wx/doc/gen/date_event.rb +0 -49
  230. data/lib/wx/doc/gen/date_picker_ctrl.rb +0 -161
  231. data/lib/wx/doc/gen/dc.rb +0 -1631
  232. data/lib/wx/doc/gen/dc_overlay.rb +0 -102
  233. data/lib/wx/doc/gen/defs.rb +0 -2802
  234. data/lib/wx/doc/gen/dial_up_event.rb +0 -45
  235. data/lib/wx/doc/gen/dial_up_manager.rb +0 -149
  236. data/lib/wx/doc/gen/dialog.rb +0 -541
  237. data/lib/wx/doc/gen/dir_dialog.rb +0 -164
  238. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +0 -90
  239. data/lib/wx/doc/gen/dir_picker_ctrl.rb +0 -125
  240. data/lib/wx/doc/gen/display.rb +0 -238
  241. data/lib/wx/doc/gen/drag_drop.rb +0 -299
  242. data/lib/wx/doc/gen/drag_image.rb +0 -116
  243. data/lib/wx/doc/gen/editable_list_box.rb +0 -109
  244. data/lib/wx/doc/gen/event.rb +0 -990
  245. data/lib/wx/doc/gen/event_blocker.rb +0 -50
  246. data/lib/wx/doc/gen/event_filter.rb +0 -92
  247. data/lib/wx/doc/gen/event_list.rb +0 -1644
  248. data/lib/wx/doc/gen/events.rb +0 -2809
  249. data/lib/wx/doc/gen/evt_handler.rb +0 -229
  250. data/lib/wx/doc/gen/ext_help_controller.rb +0 -109
  251. data/lib/wx/doc/gen/file_ctrl.rb +0 -231
  252. data/lib/wx/doc/gen/file_ctrl_event.rb +0 -83
  253. data/lib/wx/doc/gen/file_dialog.rb +0 -353
  254. data/lib/wx/doc/gen/file_dialog_custom_control.rb +0 -165
  255. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +0 -158
  256. data/lib/wx/doc/gen/file_dir_picker_event.rb +0 -100
  257. data/lib/wx/doc/gen/file_picker_ctrl.rb +0 -132
  258. data/lib/wx/doc/gen/file_system.rb +0 -232
  259. data/lib/wx/doc/gen/find_dialog_event.rb +0 -126
  260. data/lib/wx/doc/gen/find_replace_data.rb +0 -60
  261. data/lib/wx/doc/gen/find_replace_dialog.rb +0 -58
  262. data/lib/wx/doc/gen/flex_grid_sizer.rb +0 -199
  263. data/lib/wx/doc/gen/font.rb +0 -1379
  264. data/lib/wx/doc/gen/font_data.rb +0 -151
  265. data/lib/wx/doc/gen/font_dialog.rb +0 -88
  266. data/lib/wx/doc/gen/font_picker_ctrl.rb +0 -143
  267. data/lib/wx/doc/gen/font_picker_event.rb +0 -65
  268. data/lib/wx/doc/gen/frame.rb +0 -352
  269. data/lib/wx/doc/gen/fs_file.rb +0 -337
  270. data/lib/wx/doc/gen/functions.rb +0 -10
  271. data/lib/wx/doc/gen/gauge.rb +0 -157
  272. data/lib/wx/doc/gen/gb_sizer_item.rb +0 -68
  273. data/lib/wx/doc/gen/gcdc.rb +0 -46
  274. data/lib/wx/doc/gen/gdi_common.rb +0 -1271
  275. data/lib/wx/doc/gen/gdi_object.rb +0 -31
  276. data/lib/wx/doc/gen/generic_about_dialog.rb +0 -140
  277. data/lib/wx/doc/gen/generic_dir_ctrl.rb +0 -223
  278. data/lib/wx/doc/gen/geometry.rb +0 -661
  279. data/lib/wx/doc/gen/graphics_context.rb +0 -1184
  280. data/lib/wx/doc/gen/graphics_object.rb +0 -750
  281. data/lib/wx/doc/gen/grid/event_list.rb +0 -191
  282. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +0 -40
  283. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +0 -280
  284. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +0 -35
  285. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +0 -37
  286. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +0 -49
  287. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +0 -35
  288. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +0 -46
  289. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +0 -38
  290. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +0 -45
  291. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +0 -40
  292. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +0 -197
  293. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +0 -39
  294. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +0 -44
  295. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +0 -45
  296. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +0 -79
  297. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +0 -46
  298. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +0 -35
  299. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +0 -108
  300. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +0 -35
  301. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +0 -49
  302. data/lib/wx/doc/gen/grid/grid_ctrl.rb +0 -3002
  303. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +0 -95
  304. data/lib/wx/doc/gen/grid/grid_event.rb +0 -129
  305. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +0 -104
  306. data/lib/wx/doc/gen/grid/grid_size_event.rb +0 -85
  307. data/lib/wx/doc/gen/grid/grid_string_table.rb +0 -142
  308. data/lib/wx/doc/gen/grid/grid_table_base.rb +0 -317
  309. data/lib/wx/doc/gen/grid/grid_table_message.rb +0 -81
  310. data/lib/wx/doc/gen/grid_bag_sizer.rb +0 -323
  311. data/lib/wx/doc/gen/grid_sizer.rb +0 -195
  312. data/lib/wx/doc/gen/gui_event_loop.rb +0 -159
  313. data/lib/wx/doc/gen/h_scrolled_window.rb +0 -562
  314. data/lib/wx/doc/gen/header_ctrl.rb +0 -880
  315. data/lib/wx/doc/gen/header_ctrl_event.rb +0 -133
  316. data/lib/wx/doc/gen/help_controller.rb +0 -195
  317. data/lib/wx/doc/gen/help_provider.rb +0 -98
  318. data/lib/wx/doc/gen/html/event_list.rb +0 -38
  319. data/lib/wx/doc/gen/html/html_cell.rb +0 -536
  320. data/lib/wx/doc/gen/html/html_cell_event.rb +0 -69
  321. data/lib/wx/doc/gen/html/html_data_object.rb +0 -42
  322. data/lib/wx/doc/gen/html/html_easy_printing.rb +0 -203
  323. data/lib/wx/doc/gen/html/html_help_controller.rb +0 -340
  324. data/lib/wx/doc/gen/html/html_help_data.rb +0 -159
  325. data/lib/wx/doc/gen/html/html_help_window.rb +0 -258
  326. data/lib/wx/doc/gen/html/html_link_event.rb +0 -41
  327. data/lib/wx/doc/gen/html/html_list_box.rb +0 -346
  328. data/lib/wx/doc/gen/html/html_printout.rb +0 -109
  329. data/lib/wx/doc/gen/html/html_window.rb +0 -461
  330. data/lib/wx/doc/gen/hyperlink_ctrl.rb +0 -311
  331. data/lib/wx/doc/gen/hyperlink_event.rb +0 -44
  332. data/lib/wx/doc/gen/icon.rb +0 -267
  333. data/lib/wx/doc/gen/icon_location.rb +0 -40
  334. data/lib/wx/doc/gen/image.rb +0 -1371
  335. data/lib/wx/doc/gen/image_list.rb +0 -168
  336. data/lib/wx/doc/gen/info_bar.rb +0 -195
  337. data/lib/wx/doc/gen/keyboard_state.rb +0 -140
  338. data/lib/wx/doc/gen/list_box.rb +0 -304
  339. data/lib/wx/doc/gen/list_ctrl.rb +0 -1774
  340. data/lib/wx/doc/gen/list_event.rb +0 -208
  341. data/lib/wx/doc/gen/listbook.rb +0 -116
  342. data/lib/wx/doc/gen/locale.rb +0 -4293
  343. data/lib/wx/doc/gen/log.rb +0 -603
  344. data/lib/wx/doc/gen/mdi_client_window.rb +0 -47
  345. data/lib/wx/doc/gen/mdi_frame.rb +0 -324
  346. data/lib/wx/doc/gen/media_ctrl.rb +0 -269
  347. data/lib/wx/doc/gen/media_event.rb +0 -117
  348. data/lib/wx/doc/gen/memory_dc.rb +0 -174
  349. data/lib/wx/doc/gen/menu.rb +0 -509
  350. data/lib/wx/doc/gen/menu_bar.rb +0 -287
  351. data/lib/wx/doc/gen/menu_item.rb +0 -362
  352. data/lib/wx/doc/gen/message_dialog.rb +0 -238
  353. data/lib/wx/doc/gen/mini_frame.rb +0 -108
  354. data/lib/wx/doc/gen/mirror_dc.rb +0 -22
  355. data/lib/wx/doc/gen/mouse_state.rb +0 -150
  356. data/lib/wx/doc/gen/multi_choice_dialog.rb +0 -80
  357. data/lib/wx/doc/gen/non_owned_window.rb +0 -49
  358. data/lib/wx/doc/gen/notebook.rb +0 -278
  359. data/lib/wx/doc/gen/num_validator.rb +0 -37
  360. data/lib/wx/doc/gen/number_entry_dialog.rb +0 -93
  361. data/lib/wx/doc/gen/object.rb +0 -59
  362. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +0 -395
  363. data/lib/wx/doc/gen/paint_dc.rb +0 -27
  364. data/lib/wx/doc/gen/palette.rb +0 -92
  365. data/lib/wx/doc/gen/panel.rb +0 -127
  366. data/lib/wx/doc/gen/pen.rb +0 -511
  367. data/lib/wx/doc/gen/persistence_manager.rb +0 -135
  368. data/lib/wx/doc/gen/persistent_object.rb +0 -52
  369. data/lib/wx/doc/gen/persistent_window.rb +0 -241
  370. data/lib/wx/doc/gen/pg/event_list.rb +0 -106
  371. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +0 -54
  372. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +0 -292
  373. data/lib/wx/doc/gen/pg/pg_cell.rb +0 -177
  374. data/lib/wx/doc/gen/pg/pg_editor.rb +0 -721
  375. data/lib/wx/doc/gen/pg/pg_multi_button.rb +0 -152
  376. data/lib/wx/doc/gen/pg/pg_properties.rb +0 -2829
  377. data/lib/wx/doc/gen/pg/pg_property.rb +0 -2078
  378. data/lib/wx/doc/gen/pg/pg_validation_info.rb +0 -344
  379. data/lib/wx/doc/gen/pg/property_grid.rb +0 -740
  380. data/lib/wx/doc/gen/pg/property_grid_event.rb +0 -184
  381. data/lib/wx/doc/gen/pg/property_grid_interface.rb +0 -1098
  382. data/lib/wx/doc/gen/pg/property_grid_manager.rb +0 -415
  383. data/lib/wx/doc/gen/pg/property_grid_page.rb +0 -354
  384. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +0 -165
  385. data/lib/wx/doc/gen/picker_base.rb +0 -152
  386. data/lib/wx/doc/gen/platform_info.rb +0 -622
  387. data/lib/wx/doc/gen/popup_window.rb +0 -107
  388. data/lib/wx/doc/gen/progress_dialog.rb +0 -100
  389. data/lib/wx/doc/gen/property_sheet_dialog.rb +0 -216
  390. data/lib/wx/doc/gen/prt/event_list.rb +0 -17
  391. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +0 -44
  392. data/lib/wx/doc/gen/prt/post_script_dc.rb +0 -30
  393. data/lib/wx/doc/gen/prt/preview_frame.rb +0 -78
  394. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +0 -151
  395. data/lib/wx/doc/gen/prt/print_data.rb +0 -804
  396. data/lib/wx/doc/gen/prt/print_dialog.rb +0 -55
  397. data/lib/wx/doc/gen/prt/printer.rb +0 -518
  398. data/lib/wx/doc/gen/prt/printer_dc.rb +0 -37
  399. data/lib/wx/doc/gen/query_layout_info_event.rb +0 -106
  400. data/lib/wx/doc/gen/radio_box.rb +0 -306
  401. data/lib/wx/doc/gen/radio_button.rb +0 -159
  402. data/lib/wx/doc/gen/rbn/event_list.rb +0 -136
  403. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +0 -1132
  404. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +0 -308
  405. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +0 -45
  406. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +0 -458
  407. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +0 -63
  408. data/lib/wx/doc/gen/rbn/ribbon_control.rb +0 -143
  409. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +0 -229
  410. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +0 -55
  411. data/lib/wx/doc/gen/rbn/ribbon_page.rb +0 -174
  412. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +0 -270
  413. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +0 -45
  414. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +0 -360
  415. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +0 -42
  416. data/lib/wx/doc/gen/rearrange_ctrl.rb +0 -78
  417. data/lib/wx/doc/gen/rearrange_list.rb +0 -123
  418. data/lib/wx/doc/gen/region.rb +0 -380
  419. data/lib/wx/doc/gen/region_iterator.rb +0 -76
  420. data/lib/wx/doc/gen/rich_tool_tip.rb +0 -154
  421. data/lib/wx/doc/gen/rtc/event_list.rb +0 -125
  422. data/lib/wx/doc/gen/rtc/rich_text_box.rb +0 -445
  423. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +0 -1188
  424. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +0 -41
  425. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +0 -538
  426. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +0 -2103
  427. data/lib/wx/doc/gen/rtc/rich_text_event.rb +0 -173
  428. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +0 -181
  429. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +0 -319
  430. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +0 -193
  431. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +0 -102
  432. data/lib/wx/doc/gen/rtc/rich_text_image.rb +0 -337
  433. data/lib/wx/doc/gen/rtc/rich_text_object.rb +0 -2922
  434. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +0 -1240
  435. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +0 -258
  436. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +0 -344
  437. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +0 -227
  438. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +0 -59
  439. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +0 -169
  440. data/lib/wx/doc/gen/sash_event.rb +0 -147
  441. data/lib/wx/doc/gen/sash_layout_window.rb +0 -232
  442. data/lib/wx/doc/gen/sash_window.rb +0 -171
  443. data/lib/wx/doc/gen/scaled_dc.rb +0 -10
  444. data/lib/wx/doc/gen/screen_dc.rb +0 -30
  445. data/lib/wx/doc/gen/scroll_bar.rb +0 -204
  446. data/lib/wx/doc/gen/scrolled_canvas.rb +0 -410
  447. data/lib/wx/doc/gen/scrolled_control.rb +0 -410
  448. data/lib/wx/doc/gen/scrolled_window.rb +0 -430
  449. data/lib/wx/doc/gen/search_ctrl.rb +0 -159
  450. data/lib/wx/doc/gen/secret_store.rb +0 -116
  451. data/lib/wx/doc/gen/simplebook.rb +0 -110
  452. data/lib/wx/doc/gen/single_choice_dialog.rb +0 -89
  453. data/lib/wx/doc/gen/sizer.rb +0 -945
  454. data/lib/wx/doc/gen/sizer_item.rb +0 -244
  455. data/lib/wx/doc/gen/slider.rb +0 -342
  456. data/lib/wx/doc/gen/spin_button.rb +0 -157
  457. data/lib/wx/doc/gen/spin_ctrl.rb +0 -231
  458. data/lib/wx/doc/gen/spin_ctrl_double.rb +0 -192
  459. data/lib/wx/doc/gen/spin_double_event.rb +0 -55
  460. data/lib/wx/doc/gen/spin_event.rb +0 -51
  461. data/lib/wx/doc/gen/splash_screen.rb +0 -113
  462. data/lib/wx/doc/gen/splitter_event.rb +0 -99
  463. data/lib/wx/doc/gen/splitter_window.rb +0 -498
  464. data/lib/wx/doc/gen/static_bitmap.rb +0 -256
  465. data/lib/wx/doc/gen/static_box.rb +0 -180
  466. data/lib/wx/doc/gen/static_box_sizer.rb +0 -85
  467. data/lib/wx/doc/gen/static_line.rb +0 -83
  468. data/lib/wx/doc/gen/static_text.rb +0 -127
  469. data/lib/wx/doc/gen/status_bar.rb +0 -290
  470. data/lib/wx/doc/gen/stc/event_list.rb +0 -221
  471. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +0 -4474
  472. data/lib/wx/doc/gen/stc/styled_text_event.rb +0 -8762
  473. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +0 -129
  474. data/lib/wx/doc/gen/svg_file_dc.rb +0 -164
  475. data/lib/wx/doc/gen/system_options.rb +0 -129
  476. data/lib/wx/doc/gen/system_settings.rb +0 -507
  477. data/lib/wx/doc/gen/task_bar_icon.rb +0 -127
  478. data/lib/wx/doc/gen/task_bar_icon_event.rb +0 -88
  479. data/lib/wx/doc/gen/text_attr.rb +0 -756
  480. data/lib/wx/doc/gen/text_ctrl.rb +0 -1033
  481. data/lib/wx/doc/gen/text_entry.rb +0 -441
  482. data/lib/wx/doc/gen/text_entry_dialog.rb +0 -220
  483. data/lib/wx/doc/gen/text_validator.rb +0 -245
  484. data/lib/wx/doc/gen/time_picker_ctrl.rb +0 -128
  485. data/lib/wx/doc/gen/timer.rb +0 -119
  486. data/lib/wx/doc/gen/timer_event.rb +0 -68
  487. data/lib/wx/doc/gen/tip_provider.rb +0 -63
  488. data/lib/wx/doc/gen/tip_window.rb +0 -51
  489. data/lib/wx/doc/gen/toggle_button.rb +0 -182
  490. data/lib/wx/doc/gen/tool_bar.rb +0 -890
  491. data/lib/wx/doc/gen/tool_tip.rb +0 -86
  492. data/lib/wx/doc/gen/toolbook.rb +0 -118
  493. data/lib/wx/doc/gen/top_level_window.rb +0 -497
  494. data/lib/wx/doc/gen/tree_ctrl.rb +0 -1052
  495. data/lib/wx/doc/gen/tree_event.rb +0 -127
  496. data/lib/wx/doc/gen/treebook.rb +0 -180
  497. data/lib/wx/doc/gen/ui_action_simulator.rb +0 -109
  498. data/lib/wx/doc/gen/utils.rb +0 -273
  499. data/lib/wx/doc/gen/v_list_box.rb +0 -272
  500. data/lib/wx/doc/gen/v_scrolled_canvas.rb +0 -195
  501. data/lib/wx/doc/gen/v_scrolled_window.rb +0 -191
  502. data/lib/wx/doc/gen/validator.rb +0 -68
  503. data/lib/wx/doc/gen/variant.rb +0 -294
  504. data/lib/wx/doc/gen/window.rb +0 -2917
  505. data/lib/wx/doc/gen/window_dc.rb +0 -38
  506. data/lib/wx/doc/gen/window_disabler.rb +0 -30
  507. data/lib/wx/doc/gen/with_images.rb +0 -84
  508. data/lib/wx/doc/gen/wizard.rb +0 -257
  509. data/lib/wx/doc/gen/wizard_event.rb +0 -113
  510. data/lib/wx/doc/gen/wizard_page.rb +0 -65
  511. data/lib/wx/doc/gen/wizard_page_simple.rb +0 -88
  512. data/lib/wx/doc/gen/wrap_sizer.rb +0 -79
  513. data/lib/wx/doc/gen/xml_node.rb +0 -316
  514. data/lib/wx/doc/gen/xml_resource.rb +0 -320
  515. data/lib/wx/grid/events/evt_list.rb +0 -166
  516. data/lib/wx/html/events/evt_list.rb +0 -27
  517. data/lib/wx/pg/events/evt_list.rb +0 -73
  518. data/lib/wx/rbn/events/evt_list.rb +0 -102
  519. data/lib/wx/rtc/events/evt_list.rb +0 -98
  520. data/lib/wx/rtc/ext/rich_text_ctrl.rb +0 -24
  521. data/lib/wx/stc/events/evt_list.rb +0 -178
  522. data/samples/art/wxruby-512x512.png +0 -0
@@ -1,272 +0,0 @@
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
- # {Wx::VListBox} is a {Wx::ListBox}-like control with the following two main differences from a regular {Wx::ListBox}: it can have an arbitrarily huge number of items because it doesn't store them itself but uses the {Wx::VListBox#on_draw_item} callback to draw them (so it is a virtual listbox) and its items can have variable height as determined by {Wx::VListBox#on_measure_item} (so it is also a listbox with the lines of variable height).
10
- #
11
- # Also, as a consequence of its virtual nature, it doesn't have any methods to append or insert items in it as it isn't necessary to do it: you just have to call {Wx::VListBox#set_item_count} to tell the control how many items it should display. Of course, this also means that you will never use this class directly because it has pure virtual functions, but will need to derive your own class from it (for example, {Wx::HTML::HtmlListBox}).
12
- # However it emits the same events as {Wx::ListBox} and the same event macros may be used with it. Since {Wx::VListBox} does not store its items itself, the events will only contain the index, not any contents such as the string of an item.
13
- #
14
- # Category: {Wx::Controls}
15
- # @see Wx::HTML::SimpleHtmlListBox
16
- # @see Wx::HTML::HtmlListBox
17
- #
18
- #
19
- class VListBox < VScrolledCanvas
20
-
21
- # @overload set_margins(pt)
22
- # Set the margins: horizontal margin is the distance between the window border and the item contents while vertical margin is half of the distance between items.
23
- #
24
- # By default both margins are 0.
25
- # @param pt [Array(Integer, Integer), Wx::Point]
26
- # @return [void]
27
- # @overload set_margins(x, y)
28
- # Set the margins: horizontal margin is the distance between the window border and the item contents while vertical margin is half of the distance between items.
29
- #
30
- # By default both margins are 0.
31
- # @param x [Integer]
32
- # @param y [Integer]
33
- # @return [void]
34
- def set_margins(*args) end
35
- alias_method :margins=, :set_margins
36
-
37
- # @overload initialize()
38
- # Default constructor, you must call {Wx::VListBox#create} later.
39
- # @return [Wx::VListBox]
40
- # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::V_LIST_BOX_NAME_STR)
41
- # Normal constructor which calls {Wx::VListBox#create} internally.
42
- # @param parent [Wx::Window]
43
- # @param id [Integer]
44
- # @param pos [Array(Integer, Integer), Wx::Point]
45
- # @param size [Array(Integer, Integer), Wx::Size]
46
- # @param style [Integer]
47
- # @param name [String]
48
- # @return [Wx::VListBox]
49
- def initialize(*args) end
50
-
51
- # Deletes all items from the control.
52
- # @return [void]
53
- def clear; end
54
-
55
- # Creates the control.
56
- #
57
- # To finish creating it you also should call {Wx::VListBox#set_item_count} to let it know about the number of items it contains.
58
- # The only special style which may be used with {Wx::VListBox} is {Wx::LB_MULTIPLE} which indicates that the listbox should support multiple selection.
59
- # true on success or false if the control couldn't be created.
60
- # @param parent [Wx::Window]
61
- # @param id [Integer]
62
- # @param pos [Array(Integer, Integer), Wx::Point]
63
- # @param size [Array(Integer, Integer), Wx::Size]
64
- # @param style [Integer]
65
- # @param name [String]
66
- # @return [Boolean]
67
- def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::V_LIST_BOX_NAME_STR) end
68
-
69
- # Deselects all the items in the listbox.
70
- #
71
- # This method is only valid for multi selection listboxes.
72
- # true if any items were changed, i.e. if there had been any selected items before, or false if all the items were already deselected.
73
- # @see Wx::VListBox#select_all
74
- # @see Wx::VListBox#select
75
- # @return [Boolean]
76
- def deselect_all; end
77
-
78
- # Get the number of items in the control.
79
- #
80
- #
81
- # @see Wx::VListBox#set_item_count
82
- # @return [Integer]
83
- def get_item_count; end
84
- alias_method :item_count, :get_item_count
85
-
86
- # Returns the margins used by the control.
87
- #
88
- # The x field of the returned point is the horizontal margin and the y field is the vertical one.
89
- # @see Wx::VListBox#set_margins
90
- # @return [Wx::Point]
91
- def get_margins; end
92
- alias_method :margins, :get_margins
93
-
94
- # Returns the rectangle occupied by this item in physical coordinates.
95
- #
96
- # If the item is not currently visible, returns an empty rectangle.
97
- # @param item [Integer]
98
- # @return [Wx::Rect]
99
- def get_item_rect(item) end
100
- alias_method :item_rect, :get_item_rect
101
-
102
- # Returns the number of the items currently selected.
103
- #
104
- # It is valid for both single and multi selection controls. In the former case it may only return 0 or 1 however.
105
- # @see Wx::VListBox#is_selected
106
- # @see Wx::VListBox#get_first_selected
107
- # @see Wx::VListBox#get_next_selected
108
- # @return [Integer]
109
- def get_selected_count; end
110
- alias_method :selected_count, :get_selected_count
111
-
112
- # Get the currently selected item or {Wx::NOT_FOUND} if there is no selection.
113
- # @return [Integer]
114
- def get_selection; end
115
- alias_method :selection, :get_selection
116
-
117
- # Returns the background colour used for the selected cells.
118
- #
119
- # By default the standard system colour is used.
120
- # @see Wx::SystemSettings.get_colour
121
- # @see Wx::VListBox#set_selection_background
122
- # @return [Wx::Colour,String,Symbol]
123
- def get_selection_background; end
124
- alias_method :selection_background, :get_selection_background
125
-
126
- # Returns true if the listbox was created with {Wx::LB_MULTIPLE} style and so supports multiple selection or false if it is a single selection listbox.
127
- # @return [Boolean]
128
- def has_multiple_selection; end
129
- alias_method :has_multiple_selection?, :has_multiple_selection
130
-
131
- # Returns true if this item is the current one, false otherwise.
132
- #
133
- # The current item is always the same as selected one for the single selection listbox and in this case this method is equivalent to {Wx::VListBox#is_selected} but they are different for multi selection listboxes where many items may be selected but only one (at most) is current.
134
- # @param item [Integer]
135
- # @return [Boolean]
136
- def is_current(item) end
137
- alias_method :current?, :is_current
138
-
139
- # Get the current item or {Wx::NOT_FOUND} if there is no current item.
140
- # @return [Integer]
141
- def get_current; end
142
- alias_method :current, :get_current
143
-
144
- # Set the specified item as the current item, if it is {Wx::NOT_FOUND} the current item is unset.
145
- #
146
- # The current item will be automatically scrolled into view if it isn't currently visible.
147
- # @param current [Integer]
148
- # @return [void]
149
- def set_current(current) end
150
- alias_method :current=, :set_current
151
-
152
- # Returns true if this item is selected, false otherwise.
153
- # @param item [Integer]
154
- # @return [Boolean]
155
- def is_selected(item) end
156
- alias_method :selected?, :is_selected
157
-
158
- # Selects or deselects the specified item which must be valid (i.e. not equal to {Wx::NOT_FOUND}).
159
- #
160
- # true if the items selection status has changed or false otherwise.
161
- #
162
- # This function is only valid for the multiple selection listboxes, use {Wx::VListBox#set_selection} for the single selection ones.
163
- # @param item [Integer]
164
- # @param select [Boolean]
165
- # @return [Boolean]
166
- def select(item, select=true) end
167
-
168
- # Selects all the items in the listbox.
169
- #
170
- # true if any items were changed, i.e. if there had been any unselected items before, or false if all the items were already selected.
171
- #
172
- # This method is only valid for multi selection listboxes.
173
- # @see Wx::VListBox#deselect_all
174
- # @see Wx::VListBox#select
175
- # @return [Boolean]
176
- def select_all; end
177
-
178
- # Selects all items in the specified range which may be given in any order.
179
- #
180
- # true if the items selection status has changed or false otherwise.
181
- #
182
- # This method is only valid for multi selection listboxes.
183
- # @see Wx::VListBox#select_all
184
- # @see Wx::VListBox#select
185
- # @param from [Integer]
186
- # @param to [Integer]
187
- # @return [Boolean]
188
- def select_range(from, to) end
189
-
190
- # Set the number of items to be shown in the control.
191
- #
192
- # This is just a synonym for {Wx::VScrolledWindow#set_row_count}.
193
- # @param count [Integer]
194
- # @return [void]
195
- def set_item_count(count) end
196
- alias_method :item_count=, :set_item_count
197
-
198
- # Set the selection to the specified item, if it is -1 the selection is unset.
199
- #
200
- # The selected item will be automatically scrolled into view if it isn't currently visible.
201
- # This method may be used both with single and multiple selection listboxes.
202
- # @param selection [Integer]
203
- # @return [void]
204
- def set_selection(selection) end
205
- alias_method :selection=, :set_selection
206
-
207
- # Sets the colour to be used for the selected cells background.
208
- #
209
- # The background of the standard cells may be changed by simply calling {Wx::Window#set_background_colour}.
210
- #
211
- # <div class="wxrb-note">
212
- # <b>Note:</b>
213
- # <p>Using a non-default background colour may result in control having an appearance different from the similar native controls and should be avoided in general.
214
- # </p>
215
- # </div>
216
- # @see Wx::VListBox#get_selection_background
217
- # @param col [Wx::Colour,String,Symbol]
218
- # @return [void]
219
- def set_selection_background(col) end
220
- alias_method :selection_background=, :set_selection_background
221
-
222
- # Toggles the state of the specified item, i.e. selects it if it was unselected and deselects it if it was selected.
223
- #
224
- # This method is only valid for multi selection listboxes.
225
- # @see Wx::VListBox#select
226
- # @param item [Integer]
227
- # @return [void]
228
- def toggle(item) end
229
-
230
-
231
- protected
232
-
233
- # The derived class must implement this function to actually draw the item with the given index on the provided DC.
234
- #
235
- # TodoChange this function signature to non-const.
236
- # @param dc [Wx::DC] The device context to use for drawing.
237
- # @param rect [Wx::Rect] The bounding rectangle for the item being drawn (DC clipping region is set to this rectangle before calling this function).
238
- # @param n [Integer] The index of the item to be drawn.
239
- # @return [void]
240
- def on_draw_item(dc, rect, n) end
241
-
242
- # This method is used to draw the item's background and, maybe, a border around it.
243
- #
244
- # The base class version implements a reasonable default behaviour which consists in drawing the selected item with the standard background colour and drawing a border around the item if it is either selected or current.
245
- # TodoChange this function signature to non-const.
246
- # @param dc [Wx::DC]
247
- # @param rect [Wx::Rect]
248
- # @param n [Integer]
249
- # @return [void]
250
- def on_draw_background(dc, rect, n) end
251
-
252
- # This method may be used to draw separators between the lines.
253
- #
254
- # The rectangle passed to it may be modified, typically to deflate it a bit before passing to {Wx::VListBox#on_draw_item}.
255
- # The base class version of this method doesn't do anything.
256
- #
257
- # TodoChange this function signature to non-const.
258
- # @param dc [Wx::DC] The device context to use for drawing.
259
- # @param rect [Wx::Rect] The bounding rectangle for the item.
260
- # @param n [Integer] The index of the item.
261
- # @return [void]
262
- def on_draw_separator(dc, rect, n) end
263
-
264
- # The derived class must implement this method to return the height of the specified item (in pixels).
265
- # @param n [Integer]
266
- # @return [Integer]
267
- def on_measure_item(n) end
268
-
269
- end # VListBox
270
-
271
-
272
- end
@@ -1,195 +0,0 @@
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
- # In the name of this class, "V" may stand for "variable" because it can be used for scrolling rows of variable heights; "virtual", because it is not necessary to know the heights of all rows in advance only those which are shown on the screen need to be measured; or even "vertical", because this class only supports scrolling vertically.
10
- #
11
- # In any case, this is a generalization of {Wx::Scrolled} which can be only used when all rows have the same heights. It lacks some other {Wx::Scrolled} features however, notably it can't scroll specific pixel sizes of the window or its exact client area size.
12
- # To use this class, you need to derive from it and implement the Wx::VScrolled#on_get_row_height pure virtual method. You also must call Wx::VScrolled#set_row_count to let the base class know how many rows it should display, but from that moment on the scrolling is handled entirely by {Wx::VScrolled}. You only need to draw the visible part of contents in your <code>OnPaint()</code> method as usual. You should use Wx::VScrolled#get_visible_rows_begin and Wx::VScrolled#get_visible_rows_end to select the lines to display. Note that the device context origin is not shifted so the first visible row always appears at the point (0, 0) in physical as well as logical coordinates.
13
- # Note that this template class is available since wxWidgets 3.3.1, only {Wx::VScrolledWindow} was available in the earlier versions.
14
- #
15
- # Category: Miscellaneous Windows
16
- # @see Wx::VScrolledWindow
17
- # @see Wx::VScrolledCanvas
18
- #
19
- # @see Wx::HScrolledWindow
20
- # @see Wx::HVScrolledWindow
21
- #
22
- #
23
- class VScrolledCanvas < Window
24
-
25
- # @overload initialize()
26
- # Default constructor, you must call Wx::VScrolled#create later.
27
- # @return [Wx::VScrolledCanvas]
28
- # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR)
29
- # This is the normal constructor, no need to call Wx::VScrolled#create after using this constructor.
30
- #
31
- # <div class="wxrb-note">
32
- # <b>Note:</b>
33
- # <p>{Wx::VSCROLL} is always automatically added to the style, there is no need to specify it explicitly.
34
- # </p>
35
- # </div>
36
- # @param parent [Wx::Window] The parent window, must not be nil.
37
- # @param id [Integer] The identifier of this window, {Wx::StandardID::ID_ANY} by default.
38
- # @param pos [Array(Integer, Integer), Wx::Point] The initial window position.
39
- # @param size [Array(Integer, Integer), Wx::Size] The initial window size.
40
- # @param style [Integer] The window style. There are no special style bits defined for this class.
41
- # @param name [String] The name for this window; usually not used.
42
- # @return [Wx::VScrolledCanvas]
43
- # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR, &block)
44
- # This is the normal constructor, no need to call Wx::VScrolled#create after using this constructor.
45
- #
46
- # <div class="wxrb-note">
47
- # <b>Note:</b>
48
- # <p>{Wx::VSCROLL} is always automatically added to the style, there is no need to specify it explicitly.
49
- # </p>
50
- # </div>
51
- # @param parent [Wx::Window] The parent window, must not be nil.
52
- # @param id [Integer] The identifier of this window, {Wx::StandardID::ID_ANY} by default.
53
- # @param pos [Array(Integer, Integer), Wx::Point] The initial window position.
54
- # @param size [Array(Integer, Integer), Wx::Size] The initial window size.
55
- # @param style [Integer] The window style. There are no special style bits defined for this class.
56
- # @param name [String] The name for this window; usually not used.
57
- # @yieldparam [Wx::VScrolledCanvas] win new instance
58
- # @return [Wx::VScrolledCanvas]
59
- def initialize(*args) end
60
-
61
- # Same as the non-default constructor, but returns a status code: true if ok, false if the window couldn't be created.
62
- #
63
- # Just as with the constructor, the {Wx::VSCROLL} style is always used, there is no need to specify it explicitly.
64
- # @param parent [Wx::Window]
65
- # @param id [Integer]
66
- # @param pos [Array(Integer, Integer), Wx::Point]
67
- # @param size [Array(Integer, Integer), Wx::Size]
68
- # @param style [Integer]
69
- # @param name [String]
70
- # @return [Boolean]
71
- def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR) end
72
-
73
- # Returns the number of rows the target window contains.
74
- #
75
- #
76
- # @see Wx::VScrolled#set_row_count
77
- # @return [Integer]
78
- def get_row_count; end
79
- alias_method :row_count, :get_row_count
80
-
81
- # Returns the index of the first visible row based on the scroll position.
82
- # @return [Integer]
83
- def get_visible_rows_begin; end
84
- alias_method :visible_rows_begin, :get_visible_rows_begin
85
-
86
- # Returns the index of the last visible row based on the scroll position.
87
- #
88
- # This includes the last row even if it is only partially visible.
89
- # @return [Integer]
90
- def get_visible_rows_end; end
91
- alias_method :visible_rows_end, :get_visible_rows_end
92
-
93
- # Returns true if the given row is currently visible (even if only partially visible) or false otherwise.
94
- # @param row [Integer]
95
- # @return [Boolean]
96
- def is_row_visible(row) end
97
- alias_method :row_visible?, :is_row_visible
98
-
99
- # Triggers a refresh for just the given row's area of the window if it's visible.
100
- # @param row [Integer]
101
- # @return [void]
102
- def refresh_row(row) end
103
-
104
- # Triggers a refresh for the area between the specified range of rows given (inclusively).
105
- # @param from [Integer]
106
- # @param to [Integer]
107
- # @return [void]
108
- def refresh_rows(from, to) end
109
-
110
- # Scroll by the specified number of pages which may be positive (to scroll down) or negative (to scroll up).
111
- # @param pages [Integer]
112
- # @return [Boolean]
113
- def scroll_row_pages(pages) end
114
-
115
- # Scroll by the specified number of rows which may be positive (to scroll down) or negative (to scroll up).
116
- #
117
- # true if the window was scrolled, false otherwise (for example, if we're trying to scroll down but we are already showing the last row).
118
- # @param rows [Integer]
119
- # @return [Boolean]
120
- def scroll_rows(rows) end
121
-
122
- # Scroll to the specified row.
123
- #
124
- # It will become the first visible row in the window.
125
- # true if we scrolled the window, false if nothing was done.
126
- # @param row [Integer]
127
- # @return [Boolean]
128
- def scroll_to_row(row) end
129
-
130
- # Set the number of rows the window contains.
131
- #
132
- # The derived class must provide the heights for all rows with indices up to the one given here in it's Wx::VScrolled#on_get_row_height implementation.
133
- # @see Wx::VScrolled#get_row_count
134
- # @param rowCount [Integer]
135
- # @return [void]
136
- def set_row_count(rowCount) end
137
- alias_method :row_count=, :set_row_count
138
-
139
- # With physical scrolling on (when this is true), the device origin is changed properly when a {Wx::PaintDC} is prepared, children are actually moved and laid out properly, and the contents of the window (pixels) are actually moved.
140
- #
141
- # When this is false, you are responsible for repainting any invalidated areas of the window yourself to account for the new scroll position.
142
- # @param scrolling [Boolean]
143
- # @return [void]
144
- def enable_physical_scrolling(scrolling=true) end
145
-
146
- # Returns the index of the first visible unit based on the scroll position.
147
- # @return [Integer]
148
- def get_visible_begin; end
149
- alias_method :visible_begin, :get_visible_begin
150
-
151
- # Returns the index of the last visible unit based on the scroll position.
152
- #
153
- # This includes the last unit even if it is only partially visible.
154
- # @return [Integer]
155
- def get_visible_end; end
156
- alias_method :visible_end, :get_visible_end
157
-
158
- # Returns true if the given scroll unit is currently visible (even if only partially visible) or false otherwise.
159
- # @param unit [Integer]
160
- # @return [Boolean]
161
- def is_visible(unit) end
162
- alias_method :visible?, :is_visible
163
-
164
- # Recalculate all parameters and repaint all units.
165
- # @return [void]
166
- def refresh_all; end
167
-
168
- # Returns the virtual scroll unit under the device unit given accounting for scroll position or {Wx::NOT_FOUND} if none (i.e.
169
- #
170
- # if it is below the last item).
171
- # @param coord [Integer]
172
- # @return [Integer]
173
- def virtual_hit_test(coord) end
174
-
175
-
176
- protected
177
-
178
- # This function doesn't have to be overridden but it may be useful to do so if calculating the rows' sizes is a relatively expensive operation as it gives your code a chance to calculate several of them at once and cache the result if necessary.
179
- #
180
- # Wx::VScrolled#on_get_rows_height_hint is normally called just before Wx::VScrolled#on_get_row_height but you shouldn't rely on the latter being called for all rows in the interval specified here. It is also possible that Wx::VScrolled#on_get_row_height will be called for units outside of this interval, so this is really just a hint, not a promise.
181
- # Finally, note that rowMin is inclusive, while rowMax is exclusive.
182
- # @param rowMin [Integer]
183
- # @param rowMax [Integer]
184
- # @return [void]
185
- def on_get_rows_height_hint(rowMin, rowMax) end
186
-
187
- # This function must be overridden in the derived class, and should return the height of the given row in pixels.
188
- # @param row [Integer]
189
- # @return [Integer]
190
- def on_get_row_height(row) end
191
-
192
- end # VScrolledCanvas
193
-
194
-
195
- end
@@ -1,191 +0,0 @@
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
- # In the name of this class, "V" may stand for "variable" because it can be used for scrolling rows of variable heights; "virtual", because it is not necessary to know the heights of all rows in advance only those which are shown on the screen need to be measured; or even "vertical", because this class only supports scrolling vertically.
10
- #
11
- # In any case, this is a generalization of {Wx::Scrolled} which can be only used when all rows have the same heights. It lacks some other {Wx::Scrolled} features however, notably it can't scroll specific pixel sizes of the window or its exact client area size.
12
- # To use this class, you need to derive from it and implement the Wx::VScrolled#on_get_row_height pure virtual method. You also must call Wx::VScrolled#set_row_count to let the base class know how many rows it should display, but from that moment on the scrolling is handled entirely by {Wx::VScrolled}. You only need to draw the visible part of contents in your <code>OnPaint()</code> method as usual. You should use Wx::VScrolled#get_visible_rows_begin and Wx::VScrolled#get_visible_rows_end to select the lines to display. Note that the device context origin is not shifted so the first visible row always appears at the point (0, 0) in physical as well as logical coordinates.
13
- # Note that this template class is available since wxWidgets 3.3.1, only {Wx::VScrolledWindow} was available in the earlier versions.
14
- #
15
- # Category: Miscellaneous Windows
16
- # @see Wx::VScrolledWindow
17
- # @see Wx::VScrolledCanvas
18
- #
19
- # @see Wx::HScrolledWindow
20
- # @see Wx::HVScrolledWindow
21
- #
22
- #
23
- class VScrolledWindow < Panel
24
-
25
- # @overload initialize()
26
- # Default constructor, you must call Wx::VScrolled#create later.
27
- # @return [Wx::VScrolledWindow]
28
- # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR)
29
- # This is the normal constructor, no need to call Wx::VScrolled#create after using this constructor.
30
- #
31
- # <div class="wxrb-note">
32
- # <b>Note:</b>
33
- # <p>{Wx::VSCROLL} is always automatically added to the style, there is no need to specify it explicitly.
34
- # </p>
35
- # </div>
36
- # @param parent [Wx::Window] The parent window, must not be nil.
37
- # @param id [Integer] The identifier of this window, {Wx::StandardID::ID_ANY} by default.
38
- # @param pos [Array(Integer, Integer), Wx::Point] The initial window position.
39
- # @param size [Array(Integer, Integer), Wx::Size] The initial window size.
40
- # @param style [Integer] The window style. There are no special style bits defined for this class.
41
- # @param name [String] The name for this window; usually not used.
42
- # @return [Wx::VScrolledWindow]
43
- # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR, &block)
44
- # This is the normal constructor, no need to call Wx::VScrolled#create after using this constructor.
45
- #
46
- # <div class="wxrb-note">
47
- # <b>Note:</b>
48
- # <p>{Wx::VSCROLL} is always automatically added to the style, there is no need to specify it explicitly.
49
- # </p>
50
- # </div>
51
- # @param parent [Wx::Window] The parent window, must not be nil.
52
- # @param id [Integer] The identifier of this window, {Wx::StandardID::ID_ANY} by default.
53
- # @param pos [Array(Integer, Integer), Wx::Point] The initial window position.
54
- # @param size [Array(Integer, Integer), Wx::Size] The initial window size.
55
- # @param style [Integer] The window style. There are no special style bits defined for this class.
56
- # @param name [String] The name for this window; usually not used.
57
- # @yieldparam [Wx::VScrolledWindow] win new instance
58
- # @return [Wx::VScrolledWindow]
59
- def initialize(*args) end
60
-
61
- # Same as the non-default constructor, but returns a status code: true if ok, false if the window couldn't be created.
62
- #
63
- # Just as with the constructor, the {Wx::VSCROLL} style is always used, there is no need to specify it explicitly.
64
- # @param parent [Wx::Window]
65
- # @param id [Integer]
66
- # @param pos [Array(Integer, Integer), Wx::Point]
67
- # @param size [Array(Integer, Integer), Wx::Size]
68
- # @param style [Integer]
69
- # @param name [String]
70
- # @return [Boolean]
71
- def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR) end
72
-
73
- # Returns the number of rows the target window contains.
74
- #
75
- #
76
- # @see Wx::VScrolled#set_row_count
77
- # @return [Integer]
78
- def get_row_count; end
79
- alias_method :row_count, :get_row_count
80
-
81
- # Returns the index of the first visible row based on the scroll position.
82
- # @return [Integer]
83
- def get_visible_rows_begin; end
84
- alias_method :visible_rows_begin, :get_visible_rows_begin
85
-
86
- # Returns the index of the last visible row based on the scroll position.
87
- #
88
- # This includes the last row even if it is only partially visible.
89
- # @return [Integer]
90
- def get_visible_rows_end; end
91
- alias_method :visible_rows_end, :get_visible_rows_end
92
-
93
- # Returns true if the given row is currently visible (even if only partially visible) or false otherwise.
94
- # @param row [Integer]
95
- # @return [Boolean]
96
- def is_row_visible(row) end
97
- alias_method :row_visible?, :is_row_visible
98
-
99
- # Triggers a refresh for just the given row's area of the window if it's visible.
100
- # @param row [Integer]
101
- # @return [void]
102
- def refresh_row(row) end
103
-
104
- # Triggers a refresh for the area between the specified range of rows given (inclusively).
105
- # @param from [Integer]
106
- # @param to [Integer]
107
- # @return [void]
108
- def refresh_rows(from, to) end
109
-
110
- # Scroll by the specified number of pages which may be positive (to scroll down) or negative (to scroll up).
111
- # @param pages [Integer]
112
- # @return [Boolean]
113
- def scroll_row_pages(pages) end
114
-
115
- # Scroll by the specified number of rows which may be positive (to scroll down) or negative (to scroll up).
116
- #
117
- # true if the window was scrolled, false otherwise (for example, if we're trying to scroll down but we are already showing the last row).
118
- # @param rows [Integer]
119
- # @return [Boolean]
120
- def scroll_rows(rows) end
121
-
122
- # Scroll to the specified row.
123
- #
124
- # It will become the first visible row in the window.
125
- # true if we scrolled the window, false if nothing was done.
126
- # @param row [Integer]
127
- # @return [Boolean]
128
- def scroll_to_row(row) end
129
-
130
- # Set the number of rows the window contains.
131
- #
132
- # The derived class must provide the heights for all rows with indices up to the one given here in it's Wx::VScrolled#on_get_row_height implementation.
133
- # @see Wx::VScrolled#get_row_count
134
- # @param rowCount [Integer]
135
- # @return [void]
136
- def set_row_count(rowCount) end
137
- alias_method :row_count=, :set_row_count
138
-
139
- # With physical scrolling on (when this is true), the device origin is changed properly when a {Wx::PaintDC} is prepared, children are actually moved and laid out properly, and the contents of the window (pixels) are actually moved.
140
- #
141
- # When this is false, you are responsible for repainting any invalidated areas of the window yourself to account for the new scroll position.
142
- # @param scrolling [Boolean]
143
- # @return [void]
144
- def enable_physical_scrolling(scrolling=true) end
145
-
146
- # Returns the index of the first visible unit based on the scroll position.
147
- # @return [Integer]
148
- def get_visible_begin; end
149
- alias_method :visible_begin, :get_visible_begin
150
-
151
- # Returns the index of the last visible unit based on the scroll position.
152
- #
153
- # This includes the last unit even if it is only partially visible.
154
- # @return [Integer]
155
- def get_visible_end; end
156
- alias_method :visible_end, :get_visible_end
157
-
158
- # Returns true if the given scroll unit is currently visible (even if only partially visible) or false otherwise.
159
- # @param unit [Integer]
160
- # @return [Boolean]
161
- def is_visible(unit) end
162
- alias_method :visible?, :is_visible
163
-
164
- # Returns the virtual scroll unit under the device unit given accounting for scroll position or {Wx::NOT_FOUND} if none (i.e.
165
- #
166
- # if it is below the last item).
167
- # @param coord [Integer]
168
- # @return [Integer]
169
- def virtual_hit_test(coord) end
170
-
171
-
172
- protected
173
-
174
- # This function doesn't have to be overridden but it may be useful to do so if calculating the rows' sizes is a relatively expensive operation as it gives your code a chance to calculate several of them at once and cache the result if necessary.
175
- #
176
- # Wx::VScrolled#on_get_rows_height_hint is normally called just before Wx::VScrolled#on_get_row_height but you shouldn't rely on the latter being called for all rows in the interval specified here. It is also possible that Wx::VScrolled#on_get_row_height will be called for units outside of this interval, so this is really just a hint, not a promise.
177
- # Finally, note that rowMin is inclusive, while rowMax is exclusive.
178
- # @param rowMin [Integer]
179
- # @param rowMax [Integer]
180
- # @return [void]
181
- def on_get_rows_height_hint(rowMin, rowMax) end
182
-
183
- # This function must be overridden in the derived class, and should return the height of the given row in pixels.
184
- # @param row [Integer]
185
- # @return [Integer]
186
- def on_get_row_height(row) end
187
-
188
- end # VScrolledWindow
189
-
190
-
191
- end