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,300 +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
- # This is a static control which displays an animation.
10
- #
11
- # {Wx::AnimationCtrl} API is as simple as possible and won't give you full control on the animation; if you need it then use {Wx::MediaCtrl}.
12
- # This control is useful to display a (small) animation while doing a long task (e.g. a "throbber").
13
- # It is only available if {Wx::Setup::USE_ANIMATIONCTRL} is set to 1 (the default).
14
- # For the platforms where this control has a native implementation, it may have only limited support for the animation types, see {Wx::GenericAnimationCtrl} if you need to support all of them.
15
- # ### Styles
16
- #
17
- # This class supports the following styles:
18
- #
19
- # - {Wx::AC_DEFAULT_STYLE}: The default style: {Wx::Border::BORDER_NONE}.
20
- #
21
- # - {Wx::AC_NO_AUTORESIZE}: By default, the control will adjust its size to exactly fit to the size of the animation when SetAnimation is called. If this style flag is given, the control will not change its size
22
- #
23
- # Category: {Wx::Controls}
24
- # Implementations: native under WXGTK, WXMSW ports; a generic implementation is used elsewhere.
25
- # <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
26
- # </td><td> WXGTK Appearance
27
- # </td><td> WXOSX Appearance
28
- # </td></tr></table></div>
29
- # @see Wx::Animation
30
- # @see page_samples_animate
31
- #
32
- #
33
- # @wxrb_require USE_ANIMATIONCTRL
34
- class AnimationCtrl < Control
35
-
36
- # @overload initialize(parent, id, anim=Wx::NULL_ANIMATION, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AC_DEFAULT_STYLE, name=Wx::ANIMATION_CTRL_NAME_STR)
37
- # Initializes the object and calls {Wx::AnimationCtrl#create} with all the parameters.
38
- # @param parent [Wx::Window]
39
- # @param id [Integer]
40
- # @param anim [Wx::Animation]
41
- # @param pos [Array(Integer, Integer), Wx::Point]
42
- # @param size [Array(Integer, Integer), Wx::Size]
43
- # @param style [Integer]
44
- # @param name [String]
45
- # @return [Wx::AnimationCtrl]
46
- # @overload initialize(parent, id, anim=Wx::NULL_ANIMATION, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AC_DEFAULT_STYLE, name=Wx::ANIMATION_CTRL_NAME_STR, &block)
47
- # Initializes the object and calls {Wx::AnimationCtrl#create} with all the parameters.
48
- # @param parent [Wx::Window]
49
- # @param id [Integer]
50
- # @param anim [Wx::Animation]
51
- # @param pos [Array(Integer, Integer), Wx::Point]
52
- # @param size [Array(Integer, Integer), Wx::Size]
53
- # @param style [Integer]
54
- # @param name [String]
55
- # @yieldparam [Wx::AnimationCtrl] win new instance
56
- # @return [Wx::AnimationCtrl]
57
- def initialize(*args) end
58
-
59
- # Creates the control with the given anim animation.
60
- #
61
- # After control creation you must explicitly call {Wx::AnimationCtrl#play} to start to play the animation. Until that function won't be called, the first frame of the animation is displayed.
62
- #
63
- # true if the control was successfully created or false if creation failed.
64
- # @param parent [Wx::Window] Parent window, must be non-null.
65
- # @param id [Integer] The identifier for the control.
66
- # @param anim [Wx::Animation] The initial animation shown in the control.
67
- # @param pos [Array(Integer, Integer), Wx::Point] Initial position.
68
- # @param size [Array(Integer, Integer), Wx::Size] Initial size.
69
- # @param style [Integer] The window style, see {Wx::AC_}* flags.
70
- # @param name [String] Control name.
71
- # @return [Boolean]
72
- def create(parent, id, anim=Wx::NULL_ANIMATION, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AC_DEFAULT_STYLE, name=Wx::ANIMATION_CTRL_NAME_STR) end
73
-
74
- # Create a new animation object compatible with this control.
75
- #
76
- # A {Wx::Animation} object created using this function is always compatible with controls of this type, see {Wx::Animation#is_compatible_with}.
77
- # @see Wx::AnimationCtrl.create_compatible_animation
78
- # @return [Wx::Animation]
79
- def create_animation; end
80
-
81
- # Returns the animation associated with this control.
82
- # @return [Wx::Animation]
83
- def get_animation; end
84
- alias_method :animation, :get_animation
85
-
86
- # Returns the inactive bitmap shown in this control when the; see {Wx::AnimationCtrl#set_inactive_bitmap} for more info.
87
- # @return [Wx::Bitmap]
88
- def get_inactive_bitmap; end
89
- alias_method :inactive_bitmap, :get_inactive_bitmap
90
-
91
- # Returns true if the animation is being played.
92
- # @return [Boolean]
93
- def is_playing; end
94
- alias_method :playing?, :is_playing
95
-
96
- # Loads the animation from the given file and calls {Wx::AnimationCtrl#set_animation}.
97
- #
98
- # See {Wx::Animation#load_file} for more info.
99
- # @param file [String]
100
- # @param animType [Wx::AnimationType]
101
- # @return [Boolean]
102
- def load_file(file, animType=Wx::AnimationType::ANIMATION_TYPE_ANY) end
103
-
104
- # Loads the animation from the given stream and calls {Wx::AnimationCtrl#set_animation}.
105
- #
106
- # See {Wx::Animation#load} for more info.
107
- # @param file [IO,Wx::InputStream]
108
- # @param animType [Wx::AnimationType]
109
- # @return [Boolean]
110
- def load(file, animType=Wx::AnimationType::ANIMATION_TYPE_ANY) end
111
-
112
- # Starts playing the animation.
113
- #
114
- # The animation is always played in loop mode (unless the last frame of the animation has an infinite delay time) and always start from the first frame even if you {Wx::stopped} it while some other frame was displayed.
115
- # @return [Boolean]
116
- def play; end
117
-
118
- # Sets the animation to play in this control.
119
- #
120
- # If the previous animation is being played, it's {Wx::AnimationCtrl#stop} stopped. Until {Wx::AnimationCtrl#play} isn't called, a static image, the first frame of the given animation or the background colour will be shown (see {Wx::AnimationCtrl#set_inactive_bitmap} for more info).
121
- # Note that while this function takes {Wx::AnimationBundle} parameter, it is possible to pass just a single {Wx::Animation} to it too, as it is implicitly converted to a bundle. Moreover, is it also possible to call this function with just the name of the animation file, e.g.
122
- #
123
- # ```ruby
124
- # animationCtrl.set_animation(Wx::AnimationBundle.new('progress.gif'))
125
- # ```
126
- #
127
- # due to the existence of another implicit constructor, however this doesn't allow to check for errors when creating the animation and is not recommended.
128
- # If the animation bundle contains more than one animation, the one appropriate for the current display resolution is chosen.
129
- # @param animations [Wx::AnimationBundle,Wx::Animation]
130
- # @return [void]
131
- def set_animation(animations) end
132
- alias_method :animation=, :set_animation
133
-
134
- # Sets the bitmap to show on the control when it's not playing an animation.
135
- #
136
- # If you set as inactive bitmap {Wx::NULL_BITMAP} (which is the default), then the first frame of the animation is instead shown when the control is inactive; in this case, if there's no valid animation associated with the control (see {Wx::AnimationCtrl#set_animation}), then the background colour of the window is shown.
137
- # If the control is not playing the animation, the given bitmap will be immediately shown, otherwise it will be shown as soon as {Wx::AnimationCtrl#stop} is called.
138
- # Note that the inactive bitmap, if smaller than the control's size, will be centered in the control; if bigger, it will be stretched to fit it.
139
- # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
140
- # @return [void]
141
- def set_inactive_bitmap(bmp) end
142
- alias_method :inactive_bitmap=, :set_inactive_bitmap
143
-
144
- # Stops playing the animation.
145
- #
146
- # The control will show the first frame of the animation, a custom static image or the window's background colour as specified by the last {Wx::AnimationCtrl#set_inactive_bitmap} call.
147
- # @return [void]
148
- def stop; end
149
-
150
- # Create a new animation object compatible with this control.
151
- #
152
- # This method does the same thing as {Wx::AnimationCtrl#create_animation} but is static, i.e. can be called without creating any {Wx::AnimationCtrl} objects.
153
- # @return [Wx::Animation]
154
- def self.create_compatible_animation; end
155
-
156
- end # AnimationCtrl
157
-
158
- # Generic implementation of {Wx::AnimationCtrl} interface.
159
- #
160
- # If the platform supports a native animation control (currently just WXGTK) then this class implements the same interface internally in wxWidgets. One advantage of using this class instead of the native version is that this version of the control is capable of using animations in other formats than the ones supported by the <code>gdk-pixbuf</code> library used by WXGTK, which typically only supports {Wx::AnimationType::ANIMATION_TYPE_GIF}.
161
- # Note that to use this class you need to explicitly include the generic header after including the main one before using it, i.e.
162
- # ```
163
- # \#include <wx/animate.h>
164
- # \#include <wx/generic/animate.h>
165
- # ```
166
- #
167
- # Category: Graphics Device Interface (GDI)
168
- #
169
- # @wxrb_require USE_ANIMATIONCTRL
170
- class GenericAnimationCtrl < AnimationCtrl
171
-
172
- # @overload initialize(parent, id, anim=Wx::NULL_ANIMATION, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AC_DEFAULT_STYLE, name=Wx::ANIMATION_CTRL_NAME_STR)
173
- # Initializes the object and calls {Wx::GenericAnimationCtrl#create} with all the parameters.
174
- # @param parent [Wx::Window]
175
- # @param id [Integer]
176
- # @param anim [Wx::Animation]
177
- # @param pos [Array(Integer, Integer), Wx::Point]
178
- # @param size [Array(Integer, Integer), Wx::Size]
179
- # @param style [Integer]
180
- # @param name [String]
181
- # @return [Wx::GenericAnimationCtrl]
182
- # @overload initialize(parent, id, anim=Wx::NULL_ANIMATION, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AC_DEFAULT_STYLE, name=Wx::ANIMATION_CTRL_NAME_STR, &block)
183
- # Initializes the object and calls {Wx::GenericAnimationCtrl#create} with all the parameters.
184
- # @param parent [Wx::Window]
185
- # @param id [Integer]
186
- # @param anim [Wx::Animation]
187
- # @param pos [Array(Integer, Integer), Wx::Point]
188
- # @param size [Array(Integer, Integer), Wx::Size]
189
- # @param style [Integer]
190
- # @param name [String]
191
- # @yieldparam [Wx::GenericAnimationCtrl] win new instance
192
- # @return [Wx::GenericAnimationCtrl]
193
- def initialize(*args) end
194
-
195
- # Creates the control with the given anim animation.
196
- #
197
- # After control creation you must explicitly call {Wx::GenericAnimationCtrl#play} to start to play the animation. Until that function won't be called, the first frame of the animation is displayed.
198
- #
199
- # true if the control was successfully created or false if creation failed.
200
- # @param parent [Wx::Window] Parent window, must be non-null.
201
- # @param id [Integer] The identifier for the control.
202
- # @param anim [Wx::Animation] The initial animation shown in the control.
203
- # @param pos [Array(Integer, Integer), Wx::Point] Initial position.
204
- # @param size [Array(Integer, Integer), Wx::Size] Initial size.
205
- # @param style [Integer] The window style, see {Wx::AC_}* flags.
206
- # @param name [String] Control name.
207
- # @return [Boolean]
208
- def create(parent, id, anim=Wx::NULL_ANIMATION, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AC_DEFAULT_STYLE, name=Wx::ANIMATION_CTRL_NAME_STR) end
209
-
210
- # Draw the current frame of the animation into given DC.
211
- #
212
- # This is fast as current frame is always cached.
213
- # @param dc [Wx::DC]
214
- # @return [void]
215
- def draw_current_frame(dc) end
216
-
217
- # Returns a {Wx::Bitmap} with the current frame drawn in it.
218
- # @return [Wx::Bitmap]
219
- def get_backing_store; end
220
- alias_method :backing_store, :get_backing_store
221
-
222
- # Specify whether the animation's background colour is to be shown (the default), or whether the window background should show through.
223
- # @param useWinBackground [Boolean]
224
- # @return [void]
225
- def set_use_window_background_colour(useWinBackground=true) end
226
- alias_method :use_window_background_colour=, :set_use_window_background_colour
227
-
228
- # Returns true if the window's background colour is being used.
229
- # @return [Boolean]
230
- def is_using_window_background_colour; end
231
- alias_method :using_window_background_colour?, :is_using_window_background_colour
232
-
233
- end # GenericAnimationCtrl
234
-
235
- # Container for possible multiple versions of the same animation in different resolutions.
236
- #
237
- # This class is used to pass either one or multiple animations to use in {Wx::AnimationCtrl}. If it contains multiple elements, they must be added to it using its {Wx::AnimationBundle#add} function in ascending size order and, in particular, the first element defines the size of the animation in standard DPI, with the other elements containing versions of the animation to use in higher DPI.
238
- # Example of using this class to pass a normal and high DPI version of a "throbbing" animation to the control and let it choose the one most appropriate to the current resolution automatically:
239
- #
240
- # ```ruby
241
- # animationCtrl = Wx::AnimationCtrl.new(parent, Wx::ID_ANY)
242
- # animations = Wx::AnimationBundle.new
243
- # animations.add("throbber.gif")
244
- # animations.add("throbber_2x.gif")
245
- # animationCtrl.play if animationCtrl.set_animation(animations)
246
- # ```
247
- #
248
- #
249
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
250
- # @wxrb_require USE_ANIMATIONCTRL
251
- class AnimationBundle < ::Object
252
-
253
- # @overload initialize()
254
- # Default constructor creates an empty bundle.
255
- #
256
- # Call {Wx::AnimationBundle#add} later.
257
- # @return [Wx::AnimationBundle]
258
- # @overload initialize(anim)
259
- # Implicit ctor from {Wx::Animation} for backwards compatibility.
260
- # @param anim [Wx::Animation]
261
- # @return [Wx::AnimationBundle]
262
- # @overload initialize(filename, type=Wx::AnimationType::ANIMATION_TYPE_ANY)
263
- # Implicit ctor from animation file name for backwards compatibility.
264
- # @param filename [String]
265
- # @param type [Wx::AnimationType]
266
- # @return [Wx::AnimationBundle]
267
- # @overload initialize(arg)
268
- # @param arg [Wx::AnimationBundle]
269
- # @return [Wx::AnimationBundle]
270
- def initialize(*args) end
271
-
272
- # @overload add(anim)
273
- # Add an animation in another, bigger, size.
274
- # @param anim [Wx::Animation]
275
- # @return [void]
276
- # @overload add(filename, type=Wx::AnimationType::ANIMATION_TYPE_ANY)
277
- # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
278
- # @param filename [String]
279
- # @param type [Wx::AnimationType]
280
- # @return [void]
281
- def add(*args) end
282
-
283
- # Get vector containing all animations in this bundle.
284
- #
285
- # The vector can be empty.
286
- # @return [Array<Wx::Animation>]
287
- def get_all; end
288
- alias_method :all, :get_all
289
-
290
- # Return true if this animation bundle is not empty.
291
- #
292
- # Notice that any elements of the bundle are always valid animations.
293
- # @return [Boolean]
294
- def is_ok; end
295
- alias_method :ok?, :is_ok
296
-
297
- end # AnimationBundle
298
-
299
-
300
- 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
- #
10
- BU_LEFT = 64
11
-
12
- #
13
- BU_TOP = 128
14
-
15
- #
16
- BU_RIGHT = 256
17
-
18
- #
19
- BU_BOTTOM = 512
20
-
21
- #
22
- BU_ALIGN_MASK = 960
23
-
24
- #
25
- BU_EXACTFIT = 1
26
-
27
- #
28
- BU_NOTEXT = 2
29
-
30
- #
31
- BU_AUTODRAW = 4
32
-
33
- # A class for common button functionality used as the base for the various button classes.
34
- #
35
- #
36
- #
37
- # @wxrb_require USE_BUTTON|USE_TOGGLEBTN
38
- class AnyButton < Control
39
-
40
- # @overload set_bitmap_margins(x, y)
41
- # Set the margins between the bitmap and the text of the button.
42
- #
43
- # This method is currently only implemented under MSW. If it is not called, default margin is used around the bitmap.
44
- # @see Wx::AnyButton#set_bitmap
45
- # @see Wx::AnyButton#set_bitmap_position
46
- # @param x [Integer]
47
- # @param y [Integer]
48
- # @return [void]
49
- # @overload set_bitmap_margins(sz)
50
- # Set the margins between the bitmap and the text of the button.
51
- #
52
- # This method is currently only implemented under MSW. If it is not called, default margin is used around the bitmap.
53
- # @see Wx::AnyButton#set_bitmap
54
- # @see Wx::AnyButton#set_bitmap_position
55
- # @param sz [Array(Integer, Integer), Wx::Size]
56
- # @return [void]
57
- def set_bitmap_margins(*args) end
58
- alias_method :bitmap_margins=, :set_bitmap_margins
59
-
60
- # @return [Wx::AnyButton]
61
- def initialize; end
62
-
63
- # Return the bitmap shown by the button.
64
- #
65
- # The returned bitmap may be invalid only if the button doesn't show any images.
66
- # @see Wx::AnyButton#set_bitmap
67
- # @return [Wx::Bitmap]
68
- def get_bitmap; end
69
- alias_method :bitmap, :get_bitmap
70
-
71
- # Returns the bitmap used when the mouse is over the button.
72
- #
73
- # The returned bitmap is only valid if {Wx::AnyButton#set_bitmap_current} had been previously called.
74
- # @return [Wx::Bitmap]
75
- def get_bitmap_current; end
76
- alias_method :bitmap_current, :get_bitmap_current
77
-
78
- # Returns the bitmap used for the disabled state.
79
- #
80
- # The returned bitmap is only valid if {Wx::AnyButton#set_bitmap_disabled} had been previously called.
81
- # @return [Wx::Bitmap]
82
- def get_bitmap_disabled; end
83
- alias_method :bitmap_disabled, :get_bitmap_disabled
84
-
85
- # Returns the bitmap used for the focused state.
86
- #
87
- # The returned bitmap is only valid if {Wx::AnyButton#set_bitmap_focus} had been previously called.
88
- # @return [Wx::Bitmap]
89
- def get_bitmap_focus; end
90
- alias_method :bitmap_focus, :get_bitmap_focus
91
-
92
- # Returns the bitmap for the normal state.
93
- #
94
- # This is exactly the same as {Wx::AnyButton#get_bitmap} but uses a name backwards-compatible with {Wx::BitmapButton}.
95
- # @see Wx::AnyButton#set_bitmap
96
- # @see Wx::AnyButton#set_bitmap_label
97
- # @return [Wx::Bitmap]
98
- def get_bitmap_label; end
99
- alias_method :bitmap_label, :get_bitmap_label
100
-
101
- # Returns the bitmap used when the button is pressed.
102
- #
103
- # The returned bitmap is only valid if {Wx::AnyButton#set_bitmap_pressed} had been previously called.
104
- # @return [Wx::Bitmap]
105
- def get_bitmap_pressed; end
106
- alias_method :bitmap_pressed, :get_bitmap_pressed
107
-
108
- # Sets the bitmap to display in the button.
109
- #
110
- # The bitmap is displayed together with the button label. This method sets up a single bitmap which is used in all button states, use {Wx::AnyButton#set_bitmap_disabled}, {Wx::AnyButton#set_bitmap_pressed}, {Wx::AnyButton#set_bitmap_current} or {Wx::AnyButton#set_bitmap_focus} to change the individual images used in different states.
111
- # @see Wx::AnyButton#set_bitmap_position
112
- # @see Wx::AnyButton#set_bitmap_margins
113
- # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] The bitmap bundle containing the resolution-dependent bitmaps to display in the button. At default DPI, the size of the bitmap is determined by the default bundle size, i.e. the value returned from {Wx::BitmapBundle#get_default_size}. If the bitmap bundle is invalid, any currently shown bitmaps are removed from the button.
114
- # @param dir [Wx::Direction] The position of the bitmap inside the button. By default it is positioned to the left of the text, near to the left button border. Other possible values include {Wx::Direction::RIGHT}, {Wx::Direction::TOP} and {Wx::Direction::BOTTOM}.
115
- # @return [void]
116
- def set_bitmap(bitmap, dir=Wx::Direction::LEFT) end
117
- alias_method :bitmap=, :set_bitmap
118
-
119
- # Sets the bitmap to be shown when the mouse is over the button.
120
- #
121
- # If bitmap is invalid, the normal bitmap will be used in the current state.
122
- # @see Wx::AnyButton#get_bitmap_current
123
- # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
124
- # @return [void]
125
- def set_bitmap_current(bitmap) end
126
- alias_method :bitmap_current=, :set_bitmap_current
127
-
128
- # Sets the bitmap for the disabled button appearance.
129
- #
130
- # If bitmap is invalid, the disabled bitmap is set to the automatically generated greyed out version of the normal bitmap, i.e. the same bitmap as is used by default if this method is not called at all. Use {Wx::AnyButton#set_bitmap} with an invalid bitmap to remove the bitmap completely (for all states).
131
- # @see Wx::AnyButton#get_bitmap_disabled
132
- # @see Wx::AnyButton#set_bitmap_label
133
- # @see Wx::AnyButton#set_bitmap_pressed
134
- # @see Wx::AnyButton#set_bitmap_focus
135
- # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
136
- # @return [void]
137
- def set_bitmap_disabled(bitmap) end
138
- alias_method :bitmap_disabled=, :set_bitmap_disabled
139
-
140
- # Sets the bitmap for the button appearance when it has the keyboard focus.
141
- #
142
- # If bitmap is invalid, the normal bitmap will be used in the focused state.
143
- # @see Wx::AnyButton#get_bitmap_focus
144
- # @see Wx::AnyButton#set_bitmap_label
145
- # @see Wx::AnyButton#set_bitmap_pressed
146
- # @see Wx::AnyButton#set_bitmap_disabled
147
- # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
148
- # @return [void]
149
- def set_bitmap_focus(bitmap) end
150
- alias_method :bitmap_focus=, :set_bitmap_focus
151
-
152
- # Sets the bitmap label for the button.
153
- #
154
- # <div class="wxrb-remark">
155
- # <b>Remark:</b>
156
- # <p>This is the bitmap used for the unselected state, and for all other states if no other bitmaps are provided.
157
- # </p>
158
- # </div>
159
- # @see Wx::AnyButton#set_bitmap
160
- # @see Wx::AnyButton#get_bitmap_label
161
- # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
162
- # @return [void]
163
- def set_bitmap_label(bitmap) end
164
- alias_method :bitmap_label=, :set_bitmap_label
165
-
166
- # Sets the bitmap for the selected (depressed) button appearance.
167
- # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
168
- # @return [void]
169
- def set_bitmap_pressed(bitmap) end
170
- alias_method :bitmap_pressed=, :set_bitmap_pressed
171
-
172
- # Get the margins between the bitmap and the text of the button.
173
- #
174
- #
175
- # @see Wx::AnyButton#set_bitmap_margins
176
- # @return [Wx::Size]
177
- def get_bitmap_margins; end
178
- alias_method :bitmap_margins, :get_bitmap_margins
179
-
180
- # Set the position at which the bitmap is displayed.
181
- #
182
- # This method should only be called if the button does have an associated bitmap.
183
- # @param dir [Wx::Direction] Direction in which the bitmap should be positioned, one of {Wx::Direction::LEFT}, {Wx::Direction::RIGHT}, {Wx::Direction::TOP} or {Wx::Direction::BOTTOM}.
184
- # @return [void]
185
- def set_bitmap_position(dir) end
186
- alias_method :bitmap_position=, :set_bitmap_position
187
-
188
- end # AnyButton
189
-
190
-
191
- end