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,168 +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
- #
10
- IMAGELIST_DRAW_NORMAL = 1
11
-
12
- #
13
- IMAGELIST_DRAW_TRANSPARENT = 2
14
-
15
- #
16
- IMAGELIST_DRAW_SELECTED = 4
17
-
18
- #
19
- IMAGELIST_DRAW_FOCUSED = 8
20
-
21
- #
22
- #
23
- IMAGE_LIST_NORMAL = 0
24
-
25
- #
26
- #
27
- IMAGE_LIST_SMALL = 1
28
-
29
- #
30
- #
31
- IMAGE_LIST_STATE = 2
32
-
33
- # A {Wx::ImageList} contains a list of images, which are stored in an unspecified form.
34
- #
35
- # Images can use alpha channel or masks for transparent drawing, and can be made from a variety of sources including bitmaps and icons.
36
- # {Wx::ImageList} is used principally in conjunction with {Wx::TreeCtrl} and {Wx::ListCtrl} classes.
37
- # Use of this class is not recommended in the new code as it doesn't support showing DPI-dependent bitmaps. Please use {Wx::WithImages#set_images} instead of {Wx::WithImages#set_image_list}.
38
- #
39
- # Category: Graphics Device Interface (GDI)
40
- # @see Wx::TreeCtrl
41
- # @see Wx::ListCtrl
42
- #
43
- #
44
- # @wxrb_require USE_IMAGLIST
45
- class ImageList < Object
46
-
47
- # @overload initialize()
48
- # Default ctor.
49
- #
50
- # Note that the object created using the default ctor is invalid and calling any methods other than {Wx::ImageList#create} on it will result in an assertion failure.
51
- # @return [Wx::ImageList]
52
- # @overload initialize(width, height, mask=true, initialCount=1)
53
- # Constructor specifying the image size, whether image masks should be created, and the initial size of the list.
54
- #
55
- # Note that the size is specified in physical pixels and must correspond to the size of bitmaps, in pixels, that will be added to this list.
56
- # @see Wx::ImageList#create
57
- # @param width [Integer] Width of the images in the list.
58
- # @param height [Integer] Height of the images in the list.
59
- # @param mask [Boolean] If true, all images will have masks, with the mask being created from the light grey pixels if not specified otherwise, i.e. if the image doesn't have neither alpha channel nor mask and no mask is explicitly specified when adding it. Note that if an image does have alpha channel or mask, it will always be used, whether this parameter is true or false.
60
- # @param initialCount [Integer] The initial size of the list.
61
- # @return [Wx::ImageList]
62
- def initialize(*args) end
63
-
64
- # @overload add(bitmap, mask=Wx::NULL_BITMAP)
65
- # Adds a new image or images using a bitmap and optional mask bitmap.
66
- #
67
- # The physical size of the bitmap should be the same as the size specified when constructing {Wx::ImageList}. If the width of the bitmap is greater than the image list width, bitmap is split into smaller images of the required width, allowing to add multiple images from a single bitmap.
68
- #
69
- # The new zero-based image index.
70
- # @param bitmap [Wx::Bitmap] Bitmap representing the opaque areas of the image.
71
- # @param mask [Wx::Bitmap] Monochrome mask bitmap, representing the transparent areas of the image.
72
- # @return [Integer]
73
- # @overload add(bitmap, maskColour)
74
- # Adds a new image or images using a bitmap and mask colour.
75
- #
76
- # The physical size of the bitmap should be the same as the size specified when constructing {Wx::ImageList}. If the width of the bitmap is greater than the image list width, bitmap is split into smaller images of the required width, allowing to add multiple images from a single bitmap.
77
- #
78
- # The new zero-based image index.
79
- # @param bitmap [Wx::Bitmap] Bitmap representing the opaque areas of the image.
80
- # @param maskColour [Wx::Colour,String,Symbol] Colour indicating which parts of the image are transparent.
81
- # @return [Integer]
82
- def add(*args) end
83
-
84
- # Initializes the list.
85
- #
86
- # See {Wx::ImageList#initialize} for details.
87
- # This function can be called only once after creating the object using its default ctor or after calling {Wx::ImageList#destroy}.
88
- # @param width [Integer]
89
- # @param height [Integer]
90
- # @param mask [Boolean]
91
- # @param initialCount [Integer]
92
- # @return [Boolean]
93
- def create(width, height, mask=true, initialCount=1) end
94
-
95
- # Destroys the current list.
96
- #
97
- # This function resets the object to its initial state and does more than just {Wx::ImageList#remove_all} in the native WXMSW version.
98
- # After calling it, {Wx::ImageList#create} may be called again to recreate the image list, e.g. using a different size.
99
- # @return [void]
100
- def destroy; end
101
-
102
- # Draws a specified image onto a device context.
103
- # @param index [Integer] Image index, starting from zero.
104
- # @param dc [Wx::DC] Device context to draw on.
105
- # @param x [Integer] X position on the device context.
106
- # @param y [Integer] Y position on the device context.
107
- # @param flags [Integer] How to draw the image. A bitlist of a selection of the following:
108
- #
109
- # - {Wx::IMAGELIST_DRAW_NORMAL}: Draw the image normally.
110
- # - {Wx::IMAGELIST_DRAW_TRANSPARENT}: Draw the image with transparency.
111
- # - {Wx::IMAGELIST_DRAW_SELECTED}: Draw the image in selected state.
112
- # - {Wx::IMAGELIST_DRAW_FOCUSED}: Draw the image in a focused state.
113
- # @param solidBackground [Boolean] For optimisation - drawing can be faster if the function is told that the background is solid.
114
- # @return [Boolean]
115
- def draw(index, dc, x, y, flags=Wx::IMAGELIST_DRAW_NORMAL, solidBackground=false) end
116
-
117
- # Returns the bitmap corresponding to the given index.
118
- # @param index [Integer]
119
- # @return [Wx::Bitmap]
120
- def get_bitmap(index) end
121
- alias_method :bitmap, :get_bitmap
122
-
123
- # Returns the icon corresponding to the given index.
124
- # @param index [Integer]
125
- # @return [Wx::Icon]
126
- def get_icon(index) end
127
- alias_method :icon, :get_icon
128
-
129
- # Returns the number of images in the list.
130
- # @return [Integer]
131
- def get_image_count; end
132
- alias_method :image_count, :get_image_count
133
-
134
- # Retrieves the size of the image list as passed to {Wx::ImageList#create}.
135
- #
136
- # the size of the image list, which may be zero if the image list was not yet initialised.
137
- # @return [Wx::Size]
138
- def get_size; end
139
- alias_method :size, :get_size
140
-
141
- # Removes the image at the given position.
142
- # @param index [Integer]
143
- # @return [Boolean]
144
- def remove(index) end
145
-
146
- # Removes all the images in the list.
147
- # @return [Boolean]
148
- def remove_all; end
149
-
150
- # Replaces the existing image with the new image.
151
- #
152
- # true if the replacement was successful, false otherwise.
153
- #
154
- # <div class="wxrb-remark">
155
- # <b>Remark:</b>
156
- # <p>The original bitmap or icon is not affected by the {Wx::ImageList#replace} operation, and can be deleted afterwards.
157
- # </p>
158
- # </div>
159
- # @param index [Integer] The index of the bitmap to be replaced.
160
- # @param bitmap [Wx::Bitmap] Bitmap representing the opaque areas of the image.
161
- # @param mask [Wx::Bitmap] Monochrome mask bitmap, representing the transparent areas of the image.
162
- # @return [Boolean]
163
- def replace(index, bitmap, mask=Wx::NULL_BITMAP) end
164
-
165
- end # ImageList
166
-
167
-
168
- 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
- # Include support for showing a customizable checkbox() at the bottom of a {Wx::InfoBar}.
10
- #
11
- INFOBAR_CHECKBOX = 16
12
-
13
- # An info bar is a transient window shown at top or bottom of its parent window to display non-critical information to the user.
14
- #
15
- # This class provides another way to show messages to the user, intermediate between message boxes and status bar messages. The message boxes are modal and thus interrupt the users work flow and should be used sparingly for this reason. However status bar messages are often too easy not to notice at all. An info bar provides a way to present the messages which has a much higher chance to be noticed by the user but without being annoying.
16
- # Info bar may show an icon (on the left), text message and, optionally, buttons allowing the user to react to the information presented. Unless a custom button was added to the info bar, it also has a close button at the right allowing the user to dismiss it so it isn't necessary to provide a button just to close it.
17
- # {Wx::InfoBar} calls its parent {Wx::Window#layout} method and assumes that it will change the parent layout appropriately depending on whether the info bar itself is shown or hidden. Usually this is achieved by simply using a sizer for the parent window layout and adding {Wx::InfoBar} to this sizer as one of the items. Considering the usual placement of the info bars, normally this sizer should be a vertical {Wx::BoxSizer} and the bar its first or last element so the simplest possible example of using this class would be:
18
- # ```ruby
19
- # class MyFrame < Wx::Frame
20
- #
21
- # def initialize()
22
- # # ...
23
- # @infoBar = Wx::InfoBar.new(self)
24
- #
25
- # sizer = Wx::VBoxSizer.new
26
- # sizer.add(@infoBar, Wx::SizerFlags.new.expand)
27
- # # ... add other frame controls to the sizer ...
28
- # set_sizer(sizer)
29
- # end
30
- #
31
- # def some_method
32
- # @infoBar.show_message('Something happened', Wx::ICON_INFORMATION)
33
- # end
34
- #
35
- # end
36
- # ```
37
- #
38
- # See the dialogs sample for more sophisticated examples.
39
- # Currently this class is implemented generically (i.e. in the same platform-independent way for all ports) and also natively in WXGTK but the native implementation requires GTK+ 2.18 version or later (this requirement should be satisfied by any desktop systems currently in use).
40
- #
41
- # Category: Miscellaneous Windows
42
- # @see Wx::StatusBar
43
- # @see Wx::MessageDialog
44
- #
45
- #
46
- # @wxrb_require USE_INFOBAR
47
- class InfoBar < Control
48
-
49
- # Set the effects to use when showing and hiding the bar.
50
- #
51
- # Either or both of the parameters can be set to {Wx::ShowEffect::SHOW_EFFECT_NONE} to disable using effects entirely.
52
- # By default, the info bar uses {Wx::ShowEffect::SHOW_EFFECT_SLIDE_TO_BOTTOM} effect for showing itself and {Wx::ShowEffect::SHOW_EFFECT_SLIDE_TO_TOP} for hiding if it is the first element of the containing sizer and reverse effects if it's the last one. If it is neither the first nor the last element, no effect is used to avoid the use of an inappropriate one and this function must be called if an effect is desired.
53
- # @param showEffect [Wx::ShowEffect] The effect to use when showing the bar.
54
- # @param hideEffect [Wx::ShowEffect] The effect to use when hiding the bar.
55
- # @return [void]
56
- def set_show_hide_effects(showEffect, hideEffect) end
57
-
58
- # Return the effect currently used for showing the bar.
59
- # @return [Wx::ShowEffect]
60
- def get_show_effect; end
61
- alias_method :show_effect, :get_show_effect
62
-
63
- # Return the effect currently used for hiding the bar.
64
- # @return [Wx::ShowEffect]
65
- def get_hide_effect; end
66
- alias_method :hide_effect, :get_hide_effect
67
-
68
- # Set the duration of the animation used when showing or hiding the bar.
69
- #
70
- # By default, 500ms duration is used.
71
- # @param duration [Integer] Duration of the animation, in milliseconds.
72
- # @return [void]
73
- def set_effect_duration(duration) end
74
- alias_method :effect_duration=, :set_effect_duration
75
-
76
- # Return the effect animation duration currently used.
77
- # @return [Integer]
78
- def get_effect_duration; end
79
- alias_method :effect_duration, :get_effect_duration
80
-
81
- # Return whether the checkbox was checked at the time of the window being closed.
82
- #
83
- # This function is typically used in the button handler for the {Wx::EVT_BUTTON} message for {Wx::StandardID::ID_CLOSE}, which would typically call {Wx::InfoBar#dismiss} to hide the info bar and then call this function to see if the checkbox was checked and save its value to reuse it the next time (e.g. to avoid showing the same message again in a common use case).
84
- # See the dialogs sample for an example.
85
- # @return [Boolean]
86
- def is_check_box_checked; end
87
- alias_method :check_box_checked?, :is_check_box_checked
88
-
89
- # Sets whether the checkbox should be shown, its label, and whether it is checked by default.
90
- #
91
- # <div class="wxrb-note">
92
- # <b>Note:</b>
93
- # <p>The {Wx::INFOBAR_CHECKBOX} style must be used for this control if calling this function.
94
- # </p>
95
- # </div>
96
- # @param checkBoxText [String]
97
- # @param checked [Boolean]
98
- # @return [void]
99
- def show_check_box(checkBoxText, checked) end
100
-
101
- # @overload initialize()
102
- # Default constructor.
103
- #
104
- # Use {Wx::InfoBar#create} for the objects created using this constructor.
105
- # @return [Wx::InfoBar]
106
- # @overload initialize(parent, winid=Wx::StandardID::ID_ANY, style=0)
107
- # Constructor creating the info bar window.
108
- #
109
- #
110
- # @see Wx::InfoBar#create
111
- # @param parent [Wx::Window]
112
- # @param winid [Integer]
113
- # @param style [Integer]
114
- # @return [Wx::InfoBar]
115
- # @overload initialize(parent, winid=Wx::StandardID::ID_ANY, style=0, &block)
116
- # Constructor creating the info bar window.
117
- #
118
- #
119
- # @see Wx::InfoBar#create
120
- # @param parent [Wx::Window]
121
- # @param winid [Integer]
122
- # @param style [Integer]
123
- # @yieldparam [Wx::InfoBar] win new instance
124
- # @return [Wx::InfoBar]
125
- def initialize(*args) end
126
-
127
- # Create the info bar window.
128
- #
129
- # Notice that unlike most of the other {Wx::Window}-derived classes, {Wx::InfoBar} is created hidden and is only shown when {Wx::InfoBar#show_message} is called. This is more convenient as usually the info bar is created to be shown at some later time and not immediately and so creating it hidden avoids the need to call {Wx::InfoBar#hide} explicitly from the code using it.
130
- # This should be only called if the object was created using its default constructor.
131
- # @param parent [Wx::Window] A valid parent window pointer.
132
- # @param winid [Integer] The id of the info bar window, usually unused as currently no events are generated by this class.
133
- # @param style [Integer] Optional styles to apply to the control.
134
- # @return [Boolean]
135
- def create(parent, winid=Wx::StandardID::ID_ANY, style=0) end
136
-
137
- # Add a button to be shown in the info bar.
138
- #
139
- # The button added by this method will be shown to the right of the text (in LTR layout), with each successive button being added to the right of the previous one. If any buttons are added to the info bar using this method, the default "Close" button is not shown as it is assumed that the extra buttons already allow the user to close it.
140
- # Clicking the button will generate a normal EVT_COMMAND_BUTTON_CLICKED event which can be handled as usual. The default handler in {Wx::InfoBar} itself closes the window whenever a button in it is clicked so if you wish the info bar to be hidden when the button is clicked, simply call <code>event.Skip()</code> in the button handler to let the base class handler do it (calling {Wx::InfoBar#dismiss} explicitly works too, of course). On the other hand, if you don't skip the event, the info bar will remain opened so make sure to do it for at least some buttons to allow the user to close it.
141
- # Notice that the generic {Wx::InfoBar} implementation handles the button events itself and so they are not propagated to the info bar parent and you need to either inherit from {Wx::InfoBar} and handle them in your derived class or use {Wx::EvtHandler#bind}, as is done in the dialogs sample, to handle the button events in the parent frame.
142
- # @param btnid [Integer] Id of the button. It will be used in the button message clicking this button will generate.
143
- # @param label [String] The label of the button. It may only be empty if btnid is one of the stock ids in which case the corresponding stock label (see {get_stock_label}) will be used.
144
- # @return [void]
145
- def add_button(btnid, label=('')) end
146
-
147
- # Hide the info bar window.
148
- #
149
- # This method hides the window and lays out the parent window to account for its disappearance (unlike a simple {Wx::InfoBar#hide}).
150
- # @return [void]
151
- def dismiss; end
152
-
153
- # Remove a button previously added by {Wx::InfoBar#add_button}.
154
- # @param btnid [Integer] Id of the button to remove. If more than one button with the same id is used in the info bar (which is in any case not recommended), the last, i.e. most recently added, button with this id is removed.
155
- # @return [void]
156
- def remove_button(btnid) end
157
-
158
- # Show a message in the bar.
159
- #
160
- # If the bar is currently hidden, it will be shown. Otherwise its message will be updated in place.
161
- # @param msg [String] The text of the message.
162
- # @param flags [Integer] One of {Wx::ICON_NONE}, {Wx::ICON_INFORMATION} (default), {Wx::ICON_QUESTION}, {Wx::ICON_WARNING} or {Wx::ICON_ERROR} values. These flags have the same meaning as in {Wx::MessageDialog} for the generic version, i.e. show (or not, in case of {Wx::ICON_NONE}) the corresponding icon in the bar but can be interpreted by the native versions. For example, the GTK+ native implementation doesn't show icons at all but uses this parameter to select the appropriate background colour for the notification.
163
- # @return [void]
164
- def show_message(msg, flags=Wx::ICON_INFORMATION) end
165
-
166
- # Returns the number of currently shown buttons.
167
- #
168
- # This is simply the number of calls to {Wx::InfoBar#add_button} minus the number of calls to {Wx::InfoBar#remove_button} so far.
169
- # The number of currently shown buttons, possibly 0.
170
- # @return [Integer]
171
- def get_button_count; end
172
- alias_method :button_count, :get_button_count
173
-
174
- # Returns the ID of the button at the given position.
175
- #
176
- # The positions of the buttons are counted in order of their addition.
177
- #
178
- # The ID of the button at the given position or {Wx::StandardID::ID_NONE} if it is out of range (this also results in an assertion failure).
179
- # @param idx [Integer] The position of the button in 0 to {Wx::InfoBar#get_button_count} range.
180
- # @return [Integer]
181
- def get_button_id(idx) end
182
- alias_method :button_id, :get_button_id
183
-
184
- # Returns whether a button with the given ID is currently shown.
185
- #
186
- # true if the button with this ID is currently shown.
187
- # @param btnid [Integer] ID of the button to check for.
188
- # @return [Boolean]
189
- def has_button_id(btnid) end
190
- alias_method :has_button_id?, :has_button_id
191
-
192
- end # InfoBar
193
-
194
-
195
- end
@@ -1,140 +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
- # Provides methods for testing the state of the keyboard modifier keys.
10
- #
11
- # This class is used as a base class of {Wx::KeyEvent} and {Wx::MouseState} and, hence, indirectly, of {Wx::MouseEvent}, so its methods may be used to get information about the modifier keys which were pressed when the event occurred.
12
- # This class is implemented entirely inline in <{Wx::/kbdstate.h}> and thus has no linking requirements.
13
- #
14
- # Category: {Wx::Events}
15
- # @see Wx::KeyEvent
16
- # @see Wx::MouseState
17
- #
18
- #
19
- #
20
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
21
- class KeyboardState < ::Object
22
-
23
- # Constructor initializes the modifier key settings.
24
- #
25
- # By default, no modifiers are active.
26
- # @param controlDown [Boolean]
27
- # @param shiftDown [Boolean]
28
- # @param altDown [Boolean]
29
- # @param metaDown [Boolean]
30
- # @return [Wx::KeyboardState]
31
- def initialize(controlDown=false, shiftDown=false, altDown=false, metaDown=false) end
32
-
33
- # Return the bit mask of all pressed modifier keys.
34
- #
35
- # The return value is a combination of {Wx::KeyModifier::MOD_ALT}, {Wx::KeyModifier::MOD_CONTROL}, {Wx::KeyModifier::MOD_SHIFT} and {Wx::KeyModifier::MOD_META} bit masks. Additionally, {Wx::KeyModifier::MOD_NONE} is defined as 0, i.e. corresponds to no modifiers (see {Wx::KeyboardState#has_any_modifiers}) and {Wx::KeyModifier::MOD_CMD} is either {Wx::KeyModifier::MOD_CONTROL} (MSW and Unix) or {Wx::KeyModifier::MOD_META} (Mac), see {Wx::KeyboardState#cmd_down}. See {Wx::KeyModifier} for the full list of modifiers.
36
- # Notice that this function is easier to use correctly than, for example, {Wx::KeyboardState#control_down} because when using the latter you also have to remember to test that none of the other modifiers is pressed:
37
- #
38
- # ```ruby
39
- # if control_down && !alt_down && !shift_down && !meta_down
40
- # ... handle Ctrl-XXX ...
41
- # ```
42
- #
43
- # and forgetting to do it can result in serious program bugs (e.g. program not working with European keyboard layout where AltGr key which is seen by the program as combination of CTRL and ALT is used). On the other hand, you can simply write:
44
- #
45
- # ```ruby
46
- # if get_modifiers == Wx::MOD_CONTROL
47
- # ... handle Ctrl-XXX ...
48
- # ```
49
- #
50
- # with this function.
51
- # @return [Integer]
52
- def get_modifiers; end
53
- alias_method :modifiers, :get_modifiers
54
-
55
- # Returns true if any modifiers at all are pressed.
56
- #
57
- # This is equivalent to <code>Wx::KeyboardState#get_modifiers</code> <code>!=</code> {Wx::KeyModifier::MOD_NONE}.
58
- # Notice that this is different from {Wx::KeyboardState#has_modifiers} method which doesn't take e.g. Shift modifier into account. This method is most suitable for mouse events when any modifier, including Shift, can change the interpretation of the event.
59
- # @return [Boolean]
60
- def has_any_modifiers; end
61
- alias_method :has_any_modifiers?, :has_any_modifiers
62
-
63
- # Returns true if Control or Alt are pressed.
64
- #
65
- # Checks if Control, Alt or, under macOS only, Command key are pressed (notice that the real Control key is still taken into account under OS X too).
66
- # This method returns false if only Shift is pressed for compatibility reasons and also because pressing Shift usually doesn't change the interpretation of key events, see {Wx::KeyboardState#has_any_modifiers} if you want to take Shift into account as well.
67
- # @return [Boolean]
68
- def has_modifiers; end
69
- alias_method :has_modifiers?, :has_modifiers
70
-
71
- # Returns true if the Control key or Apple/Command key under macOS is pressed.
72
- #
73
- # This function doesn't distinguish between right and left control keys.
74
- # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
75
- # @return [Boolean]
76
- def control_down; end
77
-
78
- # Returns true if the Control key (also under macOS).
79
- #
80
- # This function doesn't distinguish between right and left control keys.
81
- # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
82
- # @return [Boolean]
83
- def raw_control_down; end
84
-
85
- # Returns true if the Shift key is pressed.
86
- #
87
- # This function doesn't distinguish between right and left shift keys.
88
- # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
89
- # @return [Boolean]
90
- def shift_down; end
91
-
92
- # Returns true if the Meta/Windows/Apple key is pressed.
93
- #
94
- # This function tests the state of the key traditionally called Meta under Unix systems, Windows keys under MSW Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
95
- # @see Wx::KeyboardState#cmd_down
96
- # @return [Boolean]
97
- def meta_down; end
98
-
99
- # Returns true if the Alt key is pressed.
100
- #
101
- # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
102
- # @return [Boolean]
103
- def alt_down; end
104
-
105
- # Returns true if the key used for command accelerators is pressed.
106
- #
107
- # Same as {Wx::KeyboardState#control_down}. Deprecated.
108
- # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
109
- # @return [Boolean]
110
- def cmd_down; end
111
-
112
- # @param down [Boolean]
113
- # @return [void]
114
- def set_control_down(down) end
115
- alias_method :control_down=, :set_control_down
116
-
117
- # @param down [Boolean]
118
- # @return [void]
119
- def set_raw_control_down(down) end
120
- alias_method :raw_control_down=, :set_raw_control_down
121
-
122
- # @param down [Boolean]
123
- # @return [void]
124
- def set_shift_down(down) end
125
- alias_method :shift_down=, :set_shift_down
126
-
127
- # @param down [Boolean]
128
- # @return [void]
129
- def set_alt_down(down) end
130
- alias_method :alt_down=, :set_alt_down
131
-
132
- # @param down [Boolean]
133
- # @return [void]
134
- def set_meta_down(down) end
135
- alias_method :meta_down=, :set_meta_down
136
-
137
- end # KeyboardState
138
-
139
-
140
- end