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,353 +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
- FD_DEFAULT_STYLE = 1
11
-
12
- #
13
- OSX_FILEDIALOG_ALWAYS_SHOW_TYPES = "osx.openfiledialog.always-show-types"
14
-
15
- #
16
- #
17
- FD_OPEN = 1
18
-
19
- #
20
- #
21
- FD_SAVE = 2
22
-
23
- #
24
- #
25
- FD_OVERWRITE_PROMPT = 4
26
-
27
- #
28
- #
29
- FD_NO_FOLLOW = 8
30
-
31
- #
32
- #
33
- FD_FILE_MUST_EXIST = 16
34
-
35
- #
36
- #
37
- FD_CHANGE_DIR = 128
38
-
39
- #
40
- #
41
- FD_PREVIEW = 256
42
-
43
- #
44
- #
45
- FD_MULTIPLE = 512
46
-
47
- #
48
- #
49
- FD_SHOW_HIDDEN = 1024
50
-
51
- # Default wildcard string used in {Wx::FileDialog} corresponding to all files.
52
- #
53
- FILE_SELECTOR_DEFAULT_WILDCARD_STR = "*"
54
-
55
- # This class represents the file chooser dialog.
56
- #
57
- # The path and filename are distinct elements of a full file pathname. If path is {Wx::EmptyString}, the current directory will be used. If filename is {Wx::EmptyString}, no default filename will be supplied. The wildcard determines what files are displayed in the file selector, and file extension supplies a type extension for the required filename.
58
- # The typical usage for the open file dialog is:
59
- # ```ruby
60
- # class MyFrame
61
- # ...
62
- # def on_open(event)
63
- # if (...current content has not been saved...)
64
- # if Wx.message_box('Current content has not been saved! Proceed?', 'Please confirm',
65
- # Wx::ICON_QUESTION | Wx::YES_NO, self) == Wx::NO
66
- # return
67
- # #else: proceed asking to the user the new file to open
68
- # end
69
- # end
70
- #
71
- # Wx::FileDialog(self, "Open XYZ file", "", "",
72
- # "XYZ files (*.xyz)|*.xyz", Wx::FD_OPEN|Wx::FD_FILE_MUST_EXIST) do |dlg|
73
- # return if dlg.show_modal == Wx::ID_CANCEL # the user changed idea...?
74
- #
75
- # # proceed loading the file chosen by the user
76
- # file = File.open(dlg.path, 'r') rescue nil
77
- # unless file
78
- # Wx.log_error("Cannot open file '#{dlg.path}'.")
79
- # return
80
- # end
81
- # ...
82
- # end
83
- # end
84
- #
85
- # end
86
- # ```
87
- #
88
- # The typical usage for the save file dialog is instead somewhat simpler:
89
- # ```ruby
90
- # class MyFrame
91
- # ...
92
- # def on_save_as(event)
93
- # Wx::FileDialog(self, "Save XYZ file", "", "",
94
- # "XYZ files (*.xyz)|*.xyz", Wx::FD_SAVE|Wx::FD_OVERWRITE_PROMPT) do |dlg|
95
- # return if dlg.show_modal == Wx::ID_CANCEL # the user changed idea...?
96
- #
97
- # # save the current contents in the file
98
- # begin
99
- # File.open(dlg.path, 'w+') do |f|
100
- # # save to file
101
- # end
102
- # rescue
103
- # Wx.log_error("Cannot save current contents in file '#{dlg.path}'.")
104
- # return
105
- # end
106
- # end
107
- # ...
108
- # end
109
- #
110
- # end
111
- # ```
112
- #
113
- # ## Wildcard Filters
114
- # All implementations of the {Wx::FileDialog} provide a wildcard filter. Typing a filename containing wildcards (*, ?) in the filename text item, and clicking on Ok, will result in only those files matching the pattern being displayed. The wildcard may be a specification for multiple types of file with a description for each, such as:
115
- # ```
116
- # "BMP and GIF files (*.bmp;*.gif)|*.bmp;*.gif|PNG files (*.png)|*.png"
117
- # ```
118
- #
119
- # On Mac macOS in the open file dialog the filter choice box is not shown by default. Instead all given wildcards are applied at the same time: So in the above example all bmp, gif and png files are displayed. To enforce the display of the filter choice set the corresponding {Wx::SystemOptions} before calling the file open dialog:
120
- # ```ruby
121
- # Wx::SystemOptions.set_option(Wx::OSX_FILEDIALOG_ALWAYS_SHOW_TYPES, 1)
122
- # ```
123
- # But in contrast to Windows and Unix, where the file type choice filters only the selected files, on Mac macOS even in this case the dialog shows all files matching all file types. The files which do not match the currently selected file type are greyed out and are not selectable.
124
- #
125
- # ## Dialog Customization
126
- # Uniquely among the other standard dialogs, {Wx::FileDialog} can be customized by adding extra controls to it. Moreover, there are two ways to do it: the first one is to define a callback function and use {Wx::FileDialog#set_extra_control_creator} to tell the dialog to call it, while the second one requires defining a class inheriting from {Wx::FileDialogCustomizeHook} and implementing its virtual functions, notably {Wx::FileDialogCustomizeHook#add_custom_controls} where the extra controls have to be created, and finally calling {Wx::FileDialog#set_customize_hook} with this custom hook object.
127
- # The first approach is somewhat simpler and more flexible, as it allows to create any kind of custom controls, but is not supported by the "new style" (where "new" means used since Windows Vista, i.e. circa 2007) file dialogs under MSW. Because of this, calling {Wx::FileDialog#set_extra_control_creator} in WXMSW forces the use of old style (Windows XP) dialogs, that may look out of place. The second approach is implemented by the MSW dialogs natively and doesn't suffer from this limitation, so its use is recommended, especially if the few simple control types supported by it (see {Wx::FileDialogCustomize} for more information about the supported controls) are sufficient for your needs.
128
- # Both of the approaches to the dialog customization are demonstrated in the page_samples_dialogs, please check it for more details.
129
- #
130
- # <div class="wxrb-note">
131
- # <b>Note:</b>
132
- # <p>New style file dialogs can only be used in WXMSW when the apartment, COM threading model is used. This is the case by default, but if the application initializes COM on its own using multi-threaded model, old style dialogs are used, at least when they must have a parent, as the new style dialog doesn't support this threading model.
133
- # </p>
134
- # </div>
135
- #
136
- # ### Styles
137
- #
138
- # This class supports the following styles:
139
- #
140
- # - {Wx::FD_DEFAULT_STYLE}: Equivalent to {Wx::FD_OPEN}.
141
- #
142
- # - {Wx::FD_OPEN}: This is an open dialog; usually this means that the default button's label of the dialog is "Open". Cannot be combined with {Wx::FD_SAVE}.
143
- #
144
- # - {Wx::FD_SAVE}: This is a save dialog; usually this means that the default button's label of the dialog is "Save". Cannot be combined with {Wx::FD_OPEN}.
145
- #
146
- # - {Wx::FD_OVERWRITE_PROMPT}: For save dialog only: prompt for a confirmation if a file will be overwritten. This style is always enabled on WXOSX and cannot be disabled.
147
- #
148
- # - {Wx::FD_NO_FOLLOW}: Directs the dialog to return the path and file name of the selected shortcut file, not its target as it does by default. Currently this flag is only implemented in WXMSW and WXOSX (where it prevents aliases from being resolved). The non-dereferenced link path is always returned, even without this flag, under Unix and so using it there doesn't do anything. This flag was added in wxWidgets 3.1.0.
149
- #
150
- # - {Wx::FD_FILE_MUST_EXIST}: For open dialog only: the user may only select files that actually exist. Notice that under macOS the file dialog with {Wx::FD_OPEN} style always behaves as if this style was specified, because it is impossible to choose a file that doesn't exist from a standard macOS file dialog.
151
- #
152
- # - {Wx::FD_MULTIPLE}: For open dialog only: allows selecting multiple files.
153
- #
154
- # - {Wx::FD_CHANGE_DIR}: Change the current working directory (when the dialog is dismissed) to the directory where the file(s) chosen by the user are.
155
- #
156
- # - {Wx::FD_PREVIEW}: Show the preview of the selected files (currently only supported by WXGTK).
157
- #
158
- # - {Wx::FD_SHOW_HIDDEN}: Show hidden files. This flag was added in wxWidgets 3.1.3
159
- #
160
- # Category: Common Dialogs
161
- # @see wxFileDialog Overview
162
- # @see file_selector
163
- #
164
- #
165
- # @wxrb_require USE_FILEDLG
166
- class FileDialog < Dialog
167
-
168
- # @overload initialize(parent, message=Wx::FILE_SELECTOR_PROMPT_STR, defaultDir=(''), defaultFile=(''), wildcard=Wx::FILE_SELECTOR_DEFAULT_WILDCARD_STR, style=Wx::FD_DEFAULT_STYLE, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, name=Wx::FILE_DIALOG_NAME_STR)
169
- # Constructor.
170
- #
171
- # Use {Wx::FileDialog#show_modal} to show the dialog.
172
- # @param parent [Wx::Window] Parent window.
173
- # @param message [String] Message to show on the dialog.
174
- # @param defaultDir [String] The default directory, or the empty string.
175
- # @param defaultFile [String] The default filename, or the empty string.
176
- # @param wildcard [String] A wildcard, such as "*.*" or "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".
177
- # @param style [Integer] A dialog style. See <code>wxFD_*</code> styles for more info.
178
- # @param pos [Array(Integer, Integer), Wx::Point] Dialog position. Not implemented.
179
- # @param size [Array(Integer, Integer), Wx::Size] Dialog size. Not implemented.
180
- # @param name [String] Dialog name. Not implemented.
181
- # @return [Wx::FileDialog]
182
- # @overload initialize(parent, message=Wx::FILE_SELECTOR_PROMPT_STR, defaultDir=(''), defaultFile=(''), wildcard=Wx::FILE_SELECTOR_DEFAULT_WILDCARD_STR, style=Wx::FD_DEFAULT_STYLE, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, name=Wx::FILE_DIALOG_NAME_STR, &block)
183
- # Constructor.
184
- #
185
- # Use {Wx::FileDialog#show_modal} to show the dialog.
186
- # @param parent [Wx::Window] Parent window.
187
- # @param message [String] Message to show on the dialog.
188
- # @param defaultDir [String] The default directory, or the empty string.
189
- # @param defaultFile [String] The default filename, or the empty string.
190
- # @param wildcard [String] A wildcard, such as "*.*" or "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".
191
- # @param style [Integer] A dialog style. See <code>wxFD_*</code> styles for more info.
192
- # @param pos [Array(Integer, Integer), Wx::Point] Dialog position. Not implemented.
193
- # @param size [Array(Integer, Integer), Wx::Size] Dialog size. Not implemented.
194
- # @param name [String] Dialog name. Not implemented.
195
- # @yieldparam [Wx::FileDialog] win new instance
196
- # @return [Wx::FileDialog]
197
- def initialize(*args) end
198
-
199
- # Returns the path of the file currently selected in dialog.
200
- #
201
- # Notice that this file is not necessarily going to be accepted by the user, so calling this function mostly makes sense from an update UI event handler of a custom file dialog extra control to update its state depending on the currently selected file.
202
- # Currently this function is fully implemented under GTK and MSW and always returns an empty string elsewhere.
203
- #
204
- # The path of the currently selected file or an empty string if nothing is selected.
205
- # @see Wx::FileDialog#set_extra_control_creator
206
- # @return [String]
207
- def get_currently_selected_filename; end
208
- alias_method :currently_selected_filename, :get_currently_selected_filename
209
-
210
- # Returns the file type filter index currently selected in dialog.
211
- #
212
- # Notice that this file type filter is not necessarily going to be the one finally accepted by the user, so calling this function mostly makes sense from an update UI event handler of a custom file dialog extra control to update its state depending on the currently selected file type filter.
213
- # Currently this function is fully implemented under macOS and MSW and always returns {Wx::NOT_FOUND} elsewhere.
214
- #
215
- # The 0-based index of the currently selected file type filter or {Wx::NOT_FOUND} if nothing is selected.
216
- # @see Wx::FileDialog#set_extra_control_creator
217
- #
218
- # @see Wx::FileDialog#get_filter_index
219
- #
220
- # @see Wx::FileDialog#set_filter_index
221
- # @return [Integer]
222
- def get_currently_selected_filter_index; end
223
- alias_method :currently_selected_filter_index, :get_currently_selected_filter_index
224
-
225
- # Returns the default directory.
226
- # @return [String]
227
- def get_directory; end
228
- alias_method :directory, :get_directory
229
-
230
- # If functions {Wx::FileDialog#set_extra_control_creator} and {Wx::FileDialog#show_modal} were called, returns the extra window.
231
- #
232
- # Otherwise returns nil.
233
- # @return [Wx::Window]
234
- def get_extra_control; end
235
- alias_method :extra_control, :get_extra_control
236
-
237
- # Returns the default filename.
238
- #
239
- # <div class="wxrb-note">
240
- # <b>Note:</b>
241
- # <p>This function can't be used with dialogs which have the {Wx::FD_MULTIPLE} style, use {Wx::FileDialog#get_filenames} instead.
242
- # </p>
243
- # </div>
244
- # @return [String]
245
- def get_filename; end
246
- alias_method :filename, :get_filename
247
-
248
- # Fills the array filenames with the names of the files chosen.
249
- #
250
- # This function should only be used with the dialogs which have {Wx::FD_MULTIPLE} style, use {Wx::FileDialog#get_filename} for the others.
251
- # Note that under Windows, if the user selects shortcuts, the filenames include paths, since the application cannot determine the full path of each referenced file by appending the directory containing the shortcuts to the filename.
252
- # @return [Array<String>]
253
- def get_filenames; end
254
- alias_method :filenames, :get_filenames
255
-
256
- # Returns the index into the list of filters supplied, optionally, in the wildcard parameter.
257
- #
258
- # Before the dialog is shown, this is the index which will be used when the dialog is first displayed.
259
- # After the dialog is shown, this is the index selected by the user.
260
- # @return [Integer]
261
- def get_filter_index; end
262
- alias_method :filter_index, :get_filter_index
263
-
264
- # Returns the message that will be displayed on the dialog.
265
- # @return [String]
266
- def get_message; end
267
- alias_method :message, :get_message
268
-
269
- # Returns the full path (directory and filename) of the selected file.
270
- #
271
- # <div class="wxrb-note">
272
- # <b>Note:</b>
273
- # <p>This function can't be used with dialogs which have the {Wx::FD_MULTIPLE} style, use {Wx::FileDialog#get_paths} instead.
274
- # </p>
275
- # </div>
276
- # @return [String]
277
- def get_path; end
278
- alias_method :path, :get_path
279
-
280
- # Fills the array paths with the full paths of the files chosen.
281
- #
282
- # This function should only be used with the dialogs which have {Wx::FD_MULTIPLE} style, use {Wx::FileDialog#get_path} for the others.
283
- # @return [Array<String>]
284
- def get_paths; end
285
- alias_method :paths, :get_paths
286
-
287
- # Returns the file dialog wildcard.
288
- # @return [String]
289
- def get_wildcard; end
290
- alias_method :wildcard, :get_wildcard
291
-
292
- # Set the hook to be used for customizing the dialog contents.
293
- #
294
- # This function can be called before calling {Wx::FileDialog#show_modal} to specify that the dialog contents should be customized using the provided hook. See {Wx::FileDialogCustomizeHook} documentation and page_samples_dialogs for the examples of using it.
295
- #
296
- # <div class="wxrb-note">
297
- # <b>Note:</b>
298
- # <p>In order to define a custom hook object, <code>Wx::/filedlgcustomize.h</code> must be included in addition to the usual <code>Wx::/filedlg.h</code> header.
299
- # </p>
300
- # </div>
301
- #
302
- # true if the hook was successfully set or false if customizing the file dialog is not supported by the current platform.
303
- # @param customizeHook [Wx::FileDialogCustomizeHook] The hook object that will be used by the dialog. This object must remain valid at least until {Wx::FileDialog#show_modal} returns.
304
- # @return [Boolean]
305
- def set_customize_hook(customizeHook) end
306
- alias_method :customize_hook=, :set_customize_hook
307
-
308
- # Sets the default directory.
309
- # @param directory [String]
310
- # @return [void]
311
- def set_directory(directory) end
312
- alias_method :directory=, :set_directory
313
-
314
- # Sets the default filename.
315
- #
316
- # In WXGTK this will have little effect unless a default directory has previously been set.
317
- # @param setfilename [String]
318
- # @return [void]
319
- def set_filename(setfilename) end
320
- alias_method :filename=, :set_filename
321
-
322
- # Sets the default filter index, starting from zero.
323
- # @param filterIndex [Integer]
324
- # @return [void]
325
- def set_filter_index(filterIndex) end
326
- alias_method :filter_index=, :set_filter_index
327
-
328
- # Sets the message that will be displayed on the dialog.
329
- # @param message [String]
330
- # @return [void]
331
- def set_message(message) end
332
- alias_method :message=, :set_message
333
-
334
- # Sets the path (the combined directory and filename that will be returned when the dialog is dismissed).
335
- # @param path [String]
336
- # @return [void]
337
- def set_path(path) end
338
- alias_method :path=, :set_path
339
-
340
- # Sets the wildcard, which can contain multiple file types, for example: "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".
341
- # @param wildCard [String]
342
- # @return [void]
343
- def set_wildcard(wildCard) end
344
- alias_method :wildcard=, :set_wildcard
345
-
346
- # Shows the dialog, returning {Wx::StandardID::ID_OK} if the user pressed OK, and {Wx::StandardID::ID_CANCEL} otherwise.
347
- # @return [Integer]
348
- def show_modal; end
349
-
350
- end # FileDialog
351
-
352
-
353
- end
@@ -1,165 +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
- # The base class for all {Wx::FileDialog} custom controls.
10
- #
11
- # Unlike normal controls, inheriting from {Wx::Window}, custom controls in {Wx::FileDialog} are not actual windows, but they do provide some window-like operations, and can be disabled or hidden, just as the windows are.
12
- # Also, similarly to the normal windows, objects of this and derived classes belong to wxWidgets and must not be deleted by the application code.
13
- # Unlike windows, custom controls cannot be created directly, but can only be returned from {Wx::FileDialogCustomize} functions that are specifically provided for creating them.
14
- #
15
- # @wxrb_require USE_FILEDLG
16
- class FileDialogCustomControl < EvtHandler
17
-
18
- # Show or hide this control.
19
- # @param show [Boolean]
20
- # @return [void]
21
- def show(show=true) end
22
-
23
- # Hide this control.
24
- #
25
- # This is equivalent to <code>Show(false)</code>.
26
- # @return [void]
27
- def hide; end
28
-
29
- # Enable or disable this control.
30
- # @param enable [Boolean]
31
- # @return [void]
32
- def enable(enable=true) end
33
-
34
- # Disable this control.
35
- #
36
- # This is equivalent to <code>Enable(false)</code>.
37
- # @return [void]
38
- def disable; end
39
-
40
- end # FileDialogCustomControl
41
-
42
- # Represents a custom button inside {Wx::FileDialog}.
43
- #
44
- # Objects of this class can only be created by {Wx::FileDialogCustomize#add_button}.
45
- # It is possible to bind to {Wx::EVT_BUTTON} events on this object, which will be generated when the button is clicked.
46
- # See {Wx::FileDialogCustomControl} for more information.
47
- #
48
- # @wxrb_require USE_FILEDLG
49
- class FileDialogButton < FileDialogCustomControl
50
-
51
- end # FileDialogButton
52
-
53
- # Represents a custom checkbox inside {Wx::FileDialog}.
54
- #
55
- # Objects of this class can only be created by {Wx::FileDialogCustomize#add_check_box}.
56
- # It is possible to bind to {Wx::EVT_CHECKBOX} events on this object, which will be generated when the checkbox is clicked.
57
- # See {Wx::FileDialogCustomControl} for more information.
58
- #
59
- # @wxrb_require USE_FILEDLG
60
- class FileDialogCheckBox < FileDialogCustomControl
61
-
62
- # Return true if the checkbox is checked.
63
- # @return [Boolean]
64
- def get_value; end
65
- alias_method :value, :get_value
66
-
67
- # Check or uncheck the checkbox.
68
- # @param value [Boolean]
69
- # @return [void]
70
- def set_value(value) end
71
- alias_method :value=, :set_value
72
-
73
- end # FileDialogCheckBox
74
-
75
- # Represents a custom radio button inside {Wx::FileDialog}.
76
- #
77
- # Objects of this class can only be created by {Wx::FileDialogCustomize#add_radio_button}.
78
- # It is possible to bind to {Wx::EVT_RADIOBUTTON} events on this object, which will be generated when the radio button is selected.
79
- # See {Wx::FileDialogCustomControl} for more information.
80
- #
81
- # @wxrb_require USE_FILEDLG
82
- class FileDialogRadioButton < FileDialogCustomControl
83
-
84
- # Return true if the radio button is selected.
85
- # @return [Boolean]
86
- def get_value; end
87
- alias_method :value, :get_value
88
-
89
- # Select the value of the radio button.
90
- #
91
- # Using false for value is not supported, this argument only exists for consistency with {Wx::RadioButton#set_value}.
92
- # @param value [Boolean]
93
- # @return [void]
94
- def set_value(value) end
95
- alias_method :value=, :set_value
96
-
97
- end # FileDialogRadioButton
98
-
99
- # Represents a custom read-only combobox inside {Wx::FileDialog}.
100
- #
101
- # Objects of this class can only be created by {Wx::FileDialogCustomize#add_choice}.
102
- # It is possible to bind to {Wx::EVT_CHOICE} events on this object, which will be generated when the selection in the combobox changes.
103
- # See {Wx::FileDialogCustomControl} for more information.
104
- #
105
- # @wxrb_require USE_FILEDLG
106
- class FileDialogChoice < FileDialogCustomControl
107
-
108
- # Return the index of the selected item, possibly {Wx::NOT_FOUND}.
109
- # @return [Integer]
110
- def get_selection; end
111
- alias_method :selection, :get_selection
112
-
113
- # Set the selection to the item with the given index.
114
- #
115
- # Using {Wx::NOT_FOUND} for n is not supported, once a selection is made it cannot be undone.
116
- # @param n [Integer]
117
- # @return [void]
118
- def set_selection(n) end
119
- alias_method :selection=, :set_selection
120
-
121
- end # FileDialogChoice
122
-
123
- # Represents a custom text control inside {Wx::FileDialog}.
124
- #
125
- # Objects of this class can only be created by {Wx::FileDialogCustomize#add_text_ctrl}.
126
- # Objects of this class don't generate any events currently.
127
- # See {Wx::FileDialogCustomControl} for more information.
128
- #
129
- # @wxrb_require USE_FILEDLG
130
- class FileDialogTextCtrl < FileDialogCustomControl
131
-
132
- # Get the current value entered into the control.
133
- # @return [String]
134
- def get_value; end
135
- alias_method :value, :get_value
136
-
137
- # Set the current control value.
138
- # @param text [String]
139
- # @return [void]
140
- def set_value(text) end
141
- alias_method :value=, :set_value
142
-
143
- end # FileDialogTextCtrl
144
-
145
- # Represents a custom static text inside {Wx::FileDialog}.
146
- #
147
- # Objects of this class can only be created by {Wx::FileDialogCustomize#add_static_text}.
148
- # Objects of this class don't generate any events.
149
- # See {Wx::FileDialogCustomControl} for more information.
150
- #
151
- # @wxrb_require USE_FILEDLG
152
- class FileDialogStaticText < FileDialogCustomControl
153
-
154
- # Set the text shown in the label.
155
- #
156
- # Any ampersands in the text will be escaped, there is no need to do it manually, e.g. using {Wx::Control.escape_mnemonics}.
157
- # @param text [String]
158
- # @return [void]
159
- def set_label_text(text) end
160
- alias_method :label_text=, :set_label_text
161
-
162
- end # FileDialogStaticText
163
-
164
-
165
- end
@@ -1,158 +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
- # Base class for customization hooks used with {Wx::FileDialog}.
10
- #
11
- # {Wx::FileDialogCustomizeHook} is an abstract base class, i.e. in order to use a concrete class inheriting from it and implementing its pure virtual {Wx::FileDialogCustomizeHook#add_custom_controls} function must be defined. Then an object of this class should be passed to {Wx::FileDialog#set_customize_hook}, which will result in its {Wx::FileDialogCustomizeHook#add_custom_controls} being called before the dialog is shown, {Wx::FileDialogCustomizeHook#update_custom_controls} being called whenever something changes in the dialog while it is shown and, finally, {Wx::FileDialogCustomizeHook#transfer_data_from_custom_controls} being called when the user accepts their choice in the dialog.
12
- # Putting all this together, here is an example of customizing the file dialog using this class:
13
- # ```ruby
14
- # class EncryptHook < Wx::FileDialogCustomizeHook
15
- #
16
- # attr_reader :encrypt
17
- #
18
- # # Override to add custom controls using the provided customizer object.
19
- # def add_custom_controls(customizer)
20
- # # Suppose we can encrypt files when saving them.
21
- # @checkbox = customizer.add_check_box('Encrypt')
22
- #
23
- # # While @checkbox is not a Wx::CheckBox, it looks almost like one
24
- # # and, in particular, we can bind to custom control events as usual.
25
- # @checkbox.evt_checkbox(Wx::ID_ANY) do |event|
26
- # # We can also call Wx::Window-like functions on them.
27
- # @button.enable(event.checked?)
28
- # end
29
- #
30
- # # The encryption parameters can be edited in a dedicated dialog.
31
- # @button = customizer.add_button('Parameters...')
32
- # @button.evt_button(Wx::ID_ANY) do |event|
33
- # # ... show the encryption parameters dialog here ...
34
- # end
35
- # end
36
- #
37
- # # Override to save the values of the custom controls.
38
- # def transfer_data_from_custom_controls
39
- # # Save the checkbox value, as we won't be able to use it any more
40
- # # once this function returns.
41
- # @encrypt = @checkbox.get_value
42
- # end
43
- #
44
- # end
45
- #
46
- # # ...
47
- #
48
- # def some_method
49
- # Wx.FileDialog(nil, 'Save document', '', 'file.my',
50
- # 'My files (*.my)|*.my',
51
- # Wx::FD_SAVE | Wx::FD_OVERWRITE_PROMPT) do |dialog|
52
- #
53
- # # This object may be destroyed before the dialog, but must remain
54
- # # alive until #show_modal returns.
55
- # customize_hook = EncryptHook.new
56
- # dialog.set_customize_hook(custom_hook)
57
- #
58
- # if dialog.show_modal == Wx::ID_OK
59
- # if customize_hook.encrypt
60
- # # ... save with encryption ...
61
- # else
62
- # # ... save without encryption ...
63
- # end
64
- # end
65
- # end
66
- # ```
67
- #
68
- # Category: Common Dialogs
69
- # @see Wx::FileDialog
70
- #
71
- #
72
- # @wxrb_require USE_FILEDLG
73
- class FileDialogCustomizeHook < ::Object
74
-
75
- # Must be overridden to add custom controls to the dialog using the provided customizer object.
76
- #
77
- # Call {Wx::FileDialogCustomize} functions to add controls and possibly bind to their events.
78
- # Note that there is no possibility to define the custom controls layout, they will appear more or less consecutively, but the exact layout is determined by the current platform.
79
- # @param customizer [Wx::FileDialogCustomize]
80
- # @return [void]
81
- def add_custom_controls(customizer) end
82
-
83
- # May be overridden to update the custom controls whenever something changes in the dialog.
84
- #
85
- # This function is called when the user selects a file, changes the directory or changes the current filter in the dialog, for example. It can be used to update the custom controls state depending on the currently selected file, for example.
86
- # Note that it is not necessarily called when the value of a custom control changes.
87
- # Base class version does nothing.
88
- # @return [void]
89
- def update_custom_controls; end
90
-
91
- # Should typically be overridden to save the values of the custom controls when the dialog is accepted.
92
- #
93
- # Custom controls are destroyed and cannot be used any longer once {Wx::FileDialog#show_modal} returns, so their values must be retrieved in this function, which is called just before this happens.
94
- # This function is not called if the user cancels the dialog.
95
- # Base class version does nothing.
96
- # @return [void]
97
- def transfer_data_from_custom_controls; end
98
-
99
- end # FileDialogCustomizeHook
100
-
101
- # Used with {Wx::FileDialogCustomizeHook} to add custom controls to {Wx::FileDialog}.
102
- #
103
- # An object of this class is passed to {Wx::FileDialogCustomizeHook#add_custom_controls} to allow it to actually add controls to the dialog.
104
- # The pointers returned by the functions of this class belong to wxWidgets and should not be deleted by the application, just as {Wx::Window}-derived objects (even if these controls do not inherit from {Wx::Window}). These pointers become invalid when {Wx::FileDialog#show_modal} returns, and the dialog containing them is destroyed, and the latest point at which they can be still used is when {Wx::FileDialogCustomizeHook#transfer_data_from_custom_controls} is called.
105
- #
106
- # Category: Common Dialogs
107
- # @see Wx::FileDialog
108
- #
109
- #
110
- #
111
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
112
- # @wxrb_require USE_FILEDLG
113
- class FileDialogCustomize < ::Object
114
-
115
- # Add a button with the specified label.
116
- # @param label [String]
117
- # @return [Wx::FileDialogButton]
118
- def add_button(label) end
119
-
120
- # Add a checkbox with the specified label.
121
- # @param label [String]
122
- # @return [Wx::FileDialogCheckBox]
123
- def add_check_box(label) end
124
-
125
- # Add a radio button with the specified label.
126
- #
127
- # The first radio button added will be initially checked. All the radio buttons added immediately after it will become part of the same radio group and will not be checked, but checking any one of them later will uncheck the first button and all the other ones.
128
- # If two consecutive but distinct radio groups are required, {Wx::FileDialogCustomize#add_static_text} with an empty label can be used to separate them.
129
- # @param label [String]
130
- # @return [Wx::FileDialogRadioButton]
131
- def add_radio_button(label) end
132
-
133
- # Add a read-only combobox with the specified contents.
134
- #
135
- # The combobox doesn't have any initial selection, i.e. {Wx::FileDialogChoice#get_selection} returns {Wx::NOT_FOUND}, if some item must be selected, use {Wx::FileDialogChoice#set_selection} explicitly to do it.
136
- # @param strings [Array<String>] A non-null pointer to an array of n strings.
137
- # @return [Wx::FileDialogChoice]
138
- def add_choice(strings) end
139
-
140
- # Add a text control with an optional label preceding it.
141
- #
142
- # Unlike all the other functions for adding controls, the label parameter here doesn't specify the contents of the text control itself, but rather the label appearing before it. Unlike static controls added by {Wx::FileDialogCustomize#add_static_text}, this label is guaranteed to be immediately adjacent to it.
143
- # If label is empty, no label is created.
144
- # @param label [String]
145
- # @return [Wx::FileDialogTextCtrl]
146
- def add_text_ctrl(label=('')) end
147
-
148
- # Add a static text with the given contents.
149
- #
150
- # The contents of the static text can be updated later, i.e. it doesn't need to be actually static.
151
- # @param label [String]
152
- # @return [Wx::FileDialogStaticText]
153
- def add_static_text(label) end
154
-
155
- end # FileDialogCustomize
156
-
157
-
158
- end