wxruby3 1.8.0 → 2.0.0

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 (499) hide show
  1. checksums.yaml +4 -4
  2. data/INSTALL.md +20 -10
  3. data/README.md +3 -3
  4. data/ext/wxruby3/include/wxRubyApp.h +49 -3
  5. data/ext/wxruby3/include/wxruby-ComboPopup.h +17 -32
  6. data/ext/wxruby3/include/wxruby-Config.h +34 -11
  7. data/ext/wxruby3/include/wxruby-GCTracking.h +23 -5
  8. data/ext/wxruby3/include/wxruby-SharedEventHandler.h +7 -7
  9. data/ext/wxruby3/include/wxruby-runtime.h +65 -0
  10. data/ext/wxruby3/swig/common.i +6 -0
  11. data/ext/wxruby3/swig/custom/typed_data/rubyhead.swg +220 -0
  12. data/ext/wxruby3/swig/custom/typed_data/rubyprimtypes.swg +265 -0
  13. data/ext/wxruby3/swig/custom/typed_data/rubyrun.swg +243 -0
  14. data/ext/wxruby3/swig/custom/typed_data/swigrun.swg +689 -0
  15. data/ext/wxruby3/swig/custom/{rubyprimtypes.swg → untyped_data/rubyprimtypes.swg} +8 -0
  16. data/ext/wxruby3/swig/mark_free_impl.i +2 -2
  17. data/ext/wxruby3/swig/memory_management.i +1 -0
  18. data/ext/wxruby3/swig/wx.i +19 -6
  19. data/lib/wx/core/file_dialog.rb +3 -10
  20. data/lib/wx/doc/rbn/events.rb +32 -0
  21. data/lib/wx/doc/rbn/ribbon_backstage_mrulist.rb +25 -0
  22. data/lib/wx/doc/stream.rb +7 -3
  23. data/lib/wx/keyword_ctors.rb +3 -13
  24. data/lib/wx/rbn/events.rb +18 -0
  25. data/lib/wx/rbn/require.rb +1 -0
  26. data/lib/wx/rbn/ribbon_backstage_mrulist.rb +39 -0
  27. data/lib/wx/version.rb +1 -1
  28. data/lib/wx/wxruby/cmd/test.rb +8 -2
  29. data/rakelib/lib/config/pkgman/linux.rb +4 -2
  30. data/rakelib/lib/config.rb +3 -3
  31. data/rakelib/lib/core/include/typed_data/swigrubyrun.inc +629 -0
  32. data/rakelib/lib/core/include/typed_data/swigrun.inc +870 -0
  33. data/rakelib/lib/core/package.rb +2 -2
  34. data/rakelib/lib/director/app.rb +16 -0
  35. data/rakelib/lib/director/art_provider.rb +3 -3
  36. data/rakelib/lib/director/aui_mdi_child_frame.rb +24 -0
  37. data/rakelib/lib/director/aui_mdi_parent_frame.rb +0 -2
  38. data/rakelib/lib/director/aui_tab_ctrl.rb +3 -3
  39. data/rakelib/lib/director/comboctrl.rb +35 -2
  40. data/rakelib/lib/director/config_base.rb +79 -33
  41. data/rakelib/lib/director/data_object.rb +1 -1
  42. data/rakelib/lib/director/date_event.rb +10 -3
  43. data/rakelib/lib/director/derived_dc.rb +41 -32
  44. data/rakelib/lib/director/editable_listbox.rb +10 -8
  45. data/rakelib/lib/director/event.rb +16 -7
  46. data/rakelib/lib/director/event_handler.rb +48 -10
  47. data/rakelib/lib/director/events.rb +4 -2
  48. data/rakelib/lib/director/file_history.rb +46 -0
  49. data/rakelib/lib/director/frame.rb +29 -0
  50. data/rakelib/lib/director/fs_file.rb +25 -4
  51. data/rakelib/lib/director/functions.rb +2 -2
  52. data/rakelib/lib/director/graphics_context.rb +6 -6
  53. data/rakelib/lib/director/grid_cell_editor.rb +1 -1
  54. data/rakelib/lib/director/grid_cell_renderer.rb +1 -1
  55. data/rakelib/lib/director/grid_ctrl.rb +39 -12
  56. data/rakelib/lib/director/help_controller.rb +17 -0
  57. data/rakelib/lib/director/html_help_data.rb +20 -2
  58. data/rakelib/lib/director/icon.rb +3 -0
  59. data/rakelib/lib/director/log.rb +25 -1
  60. data/rakelib/lib/director/menu.rb +38 -106
  61. data/rakelib/lib/director/menu_bar.rb +36 -70
  62. data/rakelib/lib/director/num_validator.rb +3 -3
  63. data/rakelib/lib/director/numeric_property_validator.rb +1 -1
  64. data/rakelib/lib/director/page_setup_dialog.rb +18 -1
  65. data/rakelib/lib/director/pgeditor.rb +1 -1
  66. data/rakelib/lib/director/pgvalidation_info.rb +1 -0
  67. data/rakelib/lib/director/popup_window.rb +7 -0
  68. data/rakelib/lib/director/preview_frame.rb +8 -1
  69. data/rakelib/lib/director/print_dialog.rb +17 -0
  70. data/rakelib/lib/director/printer.rb +1 -1
  71. data/rakelib/lib/director/property_grid_page.rb +2 -0
  72. data/rakelib/lib/director/region_iterator.rb +1 -1
  73. data/rakelib/lib/director/ribbon_backstage.rb +28 -0
  74. data/rakelib/lib/director/ribbon_backstage_button.rb +25 -0
  75. data/rakelib/lib/director/ribbon_backstage_callout.rb +26 -0
  76. data/rakelib/lib/director/ribbon_backstage_heading.rb +26 -0
  77. data/rakelib/lib/director/ribbon_backstage_itemlist.rb +27 -0
  78. data/rakelib/lib/director/ribbon_backstage_mrulist.rb +112 -0
  79. data/rakelib/lib/director/ribbon_bar.rb +14 -0
  80. data/rakelib/lib/director/ribbon_gallery.rb +6 -2
  81. data/rakelib/lib/director/ribbon_page.rb +11 -0
  82. data/rakelib/lib/director/ribbon_tool_bar.rb +6 -4
  83. data/rakelib/lib/director/richtext_composite_object.rb +4 -4
  84. data/rakelib/lib/director/richtext_paragraph_layout_box.rb +1 -1
  85. data/rakelib/lib/director/scrolled_t.rb +1 -1
  86. data/rakelib/lib/director/sizer.rb +7 -0
  87. data/rakelib/lib/director/sizer_item.rb +4 -1
  88. data/rakelib/lib/director/splitter_event.rb +2 -2
  89. data/rakelib/lib/director/task_bar_icon.rb +4 -1
  90. data/rakelib/lib/director/text_validator.rb +1 -1
  91. data/rakelib/lib/director/top_level_window.rb +12 -4
  92. data/rakelib/lib/director/tree_event.rb +3 -3
  93. data/rakelib/lib/director/validator.rb +1 -1
  94. data/rakelib/lib/director/variant.rb +2 -2
  95. data/rakelib/lib/director/window.rb +27 -5
  96. data/rakelib/lib/director/window_disabler.rb +1 -1
  97. data/rakelib/lib/director/xml_resource.rb +33 -8
  98. data/rakelib/lib/extractor/class.rb +2 -1
  99. data/rakelib/lib/extractor.rb +3 -2
  100. data/rakelib/lib/generate/interface.rb +2 -3
  101. data/rakelib/lib/specs/interfaces.rb +9 -2
  102. data/rakelib/lib/swig_runner.rb +14 -3
  103. data/rakelib/lib/typemap/common.rb +2 -36
  104. data/rakelib/lib/typemap/config.rb +22 -0
  105. data/samples/ribbon/ribbon.rb +277 -20
  106. data/tests/test_shared_event_handler.rb +3 -3
  107. data/tests/test_webview.rb +5 -5
  108. metadata +32 -394
  109. data/assets/repo-social-preview.odg +0 -0
  110. data/assets/repo-social-preview.xcf +0 -0
  111. data/lib/wx/aui/events/evt_list.rb +0 -148
  112. data/lib/wx/core/events/evt_list.rb +0 -1458
  113. data/lib/wx/core/font/encoding.rb +0 -113
  114. data/lib/wx/doc/gen/about_dialog_info.rb +0 -330
  115. data/lib/wx/doc/gen/accelerator.rb +0 -178
  116. data/lib/wx/doc/gen/activity_indicator.rb +0 -83
  117. data/lib/wx/doc/gen/affine_matrix2d.rb +0 -286
  118. data/lib/wx/doc/gen/animation.rb +0 -275
  119. data/lib/wx/doc/gen/animation_ctrl.rb +0 -300
  120. data/lib/wx/doc/gen/any_button.rb +0 -191
  121. data/lib/wx/doc/gen/app.rb +0 -463
  122. data/lib/wx/doc/gen/app_traits.rb +0 -396
  123. data/lib/wx/doc/gen/art_provider.rb +0 -617
  124. data/lib/wx/doc/gen/aui/aui_dock_art.rb +0 -455
  125. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +0 -54
  126. data/lib/wx/doc/gen/aui/aui_manager.rb +0 -847
  127. data/lib/wx/doc/gen/aui/aui_manager_event.rb +0 -131
  128. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +0 -180
  129. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +0 -59
  130. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +0 -130
  131. data/lib/wx/doc/gen/aui/aui_notebook.rb +0 -631
  132. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +0 -233
  133. data/lib/wx/doc/gen/aui/aui_pane_info.rb +0 -769
  134. data/lib/wx/doc/gen/aui/aui_tab_art.rb +0 -352
  135. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +0 -14
  136. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +0 -510
  137. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +0 -340
  138. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +0 -244
  139. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +0 -257
  140. data/lib/wx/doc/gen/aui/event_list.rb +0 -179
  141. data/lib/wx/doc/gen/banner_window.rb +0 -124
  142. data/lib/wx/doc/gen/bitmap.rb +0 -731
  143. data/lib/wx/doc/gen/bitmap_button.rb +0 -123
  144. data/lib/wx/doc/gen/bitmap_combo_box.rb +0 -221
  145. data/lib/wx/doc/gen/book_ctrl_base.rb +0 -274
  146. data/lib/wx/doc/gen/book_ctrl_event.rb +0 -66
  147. data/lib/wx/doc/gen/box_sizer.rb +0 -85
  148. data/lib/wx/doc/gen/brush.rb +0 -251
  149. data/lib/wx/doc/gen/busy_info.rb +0 -157
  150. data/lib/wx/doc/gen/button.rb +0 -182
  151. data/lib/wx/doc/gen/calculate_layout_event.rb +0 -62
  152. data/lib/wx/doc/gen/calendar_ctrl.rb +0 -505
  153. data/lib/wx/doc/gen/calendar_date_attr.rb +0 -138
  154. data/lib/wx/doc/gen/calendar_event.rb +0 -147
  155. data/lib/wx/doc/gen/caret.rb +0 -97
  156. data/lib/wx/doc/gen/check_box.rb +0 -175
  157. data/lib/wx/doc/gen/check_list_box.rb +0 -121
  158. data/lib/wx/doc/gen/choice.rb +0 -175
  159. data/lib/wx/doc/gen/choicebook.rb +0 -116
  160. data/lib/wx/doc/gen/client_dc.rb +0 -43
  161. data/lib/wx/doc/gen/clipboard.rb +0 -144
  162. data/lib/wx/doc/gen/collapsible_pane.rb +0 -138
  163. data/lib/wx/doc/gen/collapsible_pane_event.rb +0 -46
  164. data/lib/wx/doc/gen/colour.rb +0 -333
  165. data/lib/wx/doc/gen/colour_dialog.rb +0 -190
  166. data/lib/wx/doc/gen/colour_picker_ctrl.rb +0 -110
  167. data/lib/wx/doc/gen/colour_picker_event.rb +0 -77
  168. data/lib/wx/doc/gen/combo_box.rb +0 -292
  169. data/lib/wx/doc/gen/combo_ctrl.rb +0 -662
  170. data/lib/wx/doc/gen/command_link_button.rb +0 -134
  171. data/lib/wx/doc/gen/config_base.rb +0 -10
  172. data/lib/wx/doc/gen/context_help_button.rb +0 -56
  173. data/lib/wx/doc/gen/control.rb +0 -277
  174. data/lib/wx/doc/gen/control_with_items.rb +0 -253
  175. data/lib/wx/doc/gen/core.rb +0 -45
  176. data/lib/wx/doc/gen/credential_entry_dialog.rb +0 -137
  177. data/lib/wx/doc/gen/cursor.rb +0 -193
  178. data/lib/wx/doc/gen/data_format.rb +0 -85
  179. data/lib/wx/doc/gen/data_object.rb +0 -436
  180. data/lib/wx/doc/gen/data_object_simple_base.rb +0 -10
  181. data/lib/wx/doc/gen/date_event.rb +0 -49
  182. data/lib/wx/doc/gen/date_picker_ctrl.rb +0 -161
  183. data/lib/wx/doc/gen/dc.rb +0 -1631
  184. data/lib/wx/doc/gen/dc_overlay.rb +0 -102
  185. data/lib/wx/doc/gen/defs.rb +0 -2802
  186. data/lib/wx/doc/gen/dial_up_event.rb +0 -45
  187. data/lib/wx/doc/gen/dial_up_manager.rb +0 -149
  188. data/lib/wx/doc/gen/dialog.rb +0 -541
  189. data/lib/wx/doc/gen/dir_dialog.rb +0 -164
  190. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +0 -90
  191. data/lib/wx/doc/gen/dir_picker_ctrl.rb +0 -125
  192. data/lib/wx/doc/gen/display.rb +0 -238
  193. data/lib/wx/doc/gen/drag_drop.rb +0 -299
  194. data/lib/wx/doc/gen/drag_image.rb +0 -116
  195. data/lib/wx/doc/gen/editable_list_box.rb +0 -109
  196. data/lib/wx/doc/gen/event.rb +0 -990
  197. data/lib/wx/doc/gen/event_blocker.rb +0 -50
  198. data/lib/wx/doc/gen/event_filter.rb +0 -92
  199. data/lib/wx/doc/gen/event_list.rb +0 -1644
  200. data/lib/wx/doc/gen/events.rb +0 -2809
  201. data/lib/wx/doc/gen/evt_handler.rb +0 -229
  202. data/lib/wx/doc/gen/ext_help_controller.rb +0 -155
  203. data/lib/wx/doc/gen/file_ctrl.rb +0 -231
  204. data/lib/wx/doc/gen/file_ctrl_event.rb +0 -83
  205. data/lib/wx/doc/gen/file_dialog.rb +0 -353
  206. data/lib/wx/doc/gen/file_dialog_custom_control.rb +0 -165
  207. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +0 -158
  208. data/lib/wx/doc/gen/file_dir_picker_event.rb +0 -100
  209. data/lib/wx/doc/gen/file_picker_ctrl.rb +0 -132
  210. data/lib/wx/doc/gen/file_system.rb +0 -232
  211. data/lib/wx/doc/gen/find_dialog_event.rb +0 -126
  212. data/lib/wx/doc/gen/find_replace_data.rb +0 -60
  213. data/lib/wx/doc/gen/find_replace_dialog.rb +0 -58
  214. data/lib/wx/doc/gen/flex_grid_sizer.rb +0 -199
  215. data/lib/wx/doc/gen/font.rb +0 -1379
  216. data/lib/wx/doc/gen/font_data.rb +0 -151
  217. data/lib/wx/doc/gen/font_dialog.rb +0 -88
  218. data/lib/wx/doc/gen/font_picker_ctrl.rb +0 -143
  219. data/lib/wx/doc/gen/font_picker_event.rb +0 -65
  220. data/lib/wx/doc/gen/frame.rb +0 -352
  221. data/lib/wx/doc/gen/fs_file.rb +0 -337
  222. data/lib/wx/doc/gen/functions.rb +0 -10
  223. data/lib/wx/doc/gen/gauge.rb +0 -157
  224. data/lib/wx/doc/gen/gb_sizer_item.rb +0 -68
  225. data/lib/wx/doc/gen/gcdc.rb +0 -46
  226. data/lib/wx/doc/gen/gdi_common.rb +0 -1271
  227. data/lib/wx/doc/gen/gdi_object.rb +0 -31
  228. data/lib/wx/doc/gen/generic_about_dialog.rb +0 -140
  229. data/lib/wx/doc/gen/generic_dir_ctrl.rb +0 -223
  230. data/lib/wx/doc/gen/geometry.rb +0 -661
  231. data/lib/wx/doc/gen/graphics_context.rb +0 -1184
  232. data/lib/wx/doc/gen/graphics_object.rb +0 -750
  233. data/lib/wx/doc/gen/grid/event_list.rb +0 -191
  234. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +0 -40
  235. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +0 -280
  236. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +0 -35
  237. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +0 -37
  238. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +0 -49
  239. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +0 -35
  240. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +0 -46
  241. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +0 -38
  242. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +0 -45
  243. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +0 -40
  244. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +0 -197
  245. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +0 -39
  246. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +0 -44
  247. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +0 -45
  248. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +0 -79
  249. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +0 -46
  250. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +0 -35
  251. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +0 -108
  252. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +0 -35
  253. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +0 -49
  254. data/lib/wx/doc/gen/grid/grid_ctrl.rb +0 -3037
  255. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +0 -95
  256. data/lib/wx/doc/gen/grid/grid_event.rb +0 -129
  257. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +0 -104
  258. data/lib/wx/doc/gen/grid/grid_size_event.rb +0 -85
  259. data/lib/wx/doc/gen/grid/grid_string_table.rb +0 -142
  260. data/lib/wx/doc/gen/grid/grid_table_base.rb +0 -317
  261. data/lib/wx/doc/gen/grid/grid_table_message.rb +0 -81
  262. data/lib/wx/doc/gen/grid_bag_sizer.rb +0 -323
  263. data/lib/wx/doc/gen/grid_sizer.rb +0 -195
  264. data/lib/wx/doc/gen/gui_event_loop.rb +0 -159
  265. data/lib/wx/doc/gen/h_scrolled_window.rb +0 -562
  266. data/lib/wx/doc/gen/header_ctrl.rb +0 -880
  267. data/lib/wx/doc/gen/header_ctrl_event.rb +0 -133
  268. data/lib/wx/doc/gen/help_controller.rb +0 -238
  269. data/lib/wx/doc/gen/help_provider.rb +0 -98
  270. data/lib/wx/doc/gen/html/event_list.rb +0 -38
  271. data/lib/wx/doc/gen/html/html_cell.rb +0 -536
  272. data/lib/wx/doc/gen/html/html_cell_event.rb +0 -69
  273. data/lib/wx/doc/gen/html/html_data_object.rb +0 -42
  274. data/lib/wx/doc/gen/html/html_easy_printing.rb +0 -203
  275. data/lib/wx/doc/gen/html/html_help_controller.rb +0 -382
  276. data/lib/wx/doc/gen/html/html_help_data.rb +0 -159
  277. data/lib/wx/doc/gen/html/html_help_window.rb +0 -258
  278. data/lib/wx/doc/gen/html/html_link_event.rb +0 -41
  279. data/lib/wx/doc/gen/html/html_list_box.rb +0 -346
  280. data/lib/wx/doc/gen/html/html_printout.rb +0 -109
  281. data/lib/wx/doc/gen/html/html_window.rb +0 -461
  282. data/lib/wx/doc/gen/hyperlink_ctrl.rb +0 -311
  283. data/lib/wx/doc/gen/hyperlink_event.rb +0 -44
  284. data/lib/wx/doc/gen/icon.rb +0 -267
  285. data/lib/wx/doc/gen/icon_location.rb +0 -40
  286. data/lib/wx/doc/gen/image.rb +0 -1371
  287. data/lib/wx/doc/gen/image_list.rb +0 -168
  288. data/lib/wx/doc/gen/info_bar.rb +0 -195
  289. data/lib/wx/doc/gen/keyboard_state.rb +0 -140
  290. data/lib/wx/doc/gen/list_box.rb +0 -304
  291. data/lib/wx/doc/gen/list_ctrl.rb +0 -1774
  292. data/lib/wx/doc/gen/list_event.rb +0 -208
  293. data/lib/wx/doc/gen/listbook.rb +0 -116
  294. data/lib/wx/doc/gen/locale.rb +0 -4293
  295. data/lib/wx/doc/gen/log.rb +0 -603
  296. data/lib/wx/doc/gen/mb_conv.rb +0 -10
  297. data/lib/wx/doc/gen/mdi_client_window.rb +0 -47
  298. data/lib/wx/doc/gen/mdi_frame.rb +0 -324
  299. data/lib/wx/doc/gen/media_ctrl.rb +0 -269
  300. data/lib/wx/doc/gen/media_event.rb +0 -117
  301. data/lib/wx/doc/gen/memory_dc.rb +0 -174
  302. data/lib/wx/doc/gen/menu.rb +0 -509
  303. data/lib/wx/doc/gen/menu_bar.rb +0 -287
  304. data/lib/wx/doc/gen/menu_item.rb +0 -362
  305. data/lib/wx/doc/gen/message_dialog.rb +0 -238
  306. data/lib/wx/doc/gen/mini_frame.rb +0 -108
  307. data/lib/wx/doc/gen/mirror_dc.rb +0 -22
  308. data/lib/wx/doc/gen/mouse_state.rb +0 -150
  309. data/lib/wx/doc/gen/multi_choice_dialog.rb +0 -80
  310. data/lib/wx/doc/gen/non_owned_window.rb +0 -49
  311. data/lib/wx/doc/gen/notebook.rb +0 -278
  312. data/lib/wx/doc/gen/num_validator.rb +0 -37
  313. data/lib/wx/doc/gen/number_entry_dialog.rb +0 -93
  314. data/lib/wx/doc/gen/object.rb +0 -59
  315. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +0 -395
  316. data/lib/wx/doc/gen/paint_dc.rb +0 -27
  317. data/lib/wx/doc/gen/palette.rb +0 -92
  318. data/lib/wx/doc/gen/panel.rb +0 -127
  319. data/lib/wx/doc/gen/pen.rb +0 -511
  320. data/lib/wx/doc/gen/persistence_manager.rb +0 -135
  321. data/lib/wx/doc/gen/persistent_object.rb +0 -52
  322. data/lib/wx/doc/gen/persistent_window.rb +0 -241
  323. data/lib/wx/doc/gen/pg/event_list.rb +0 -106
  324. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +0 -54
  325. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +0 -292
  326. data/lib/wx/doc/gen/pg/pg_cell.rb +0 -177
  327. data/lib/wx/doc/gen/pg/pg_editor.rb +0 -721
  328. data/lib/wx/doc/gen/pg/pg_multi_button.rb +0 -152
  329. data/lib/wx/doc/gen/pg/pg_properties.rb +0 -2829
  330. data/lib/wx/doc/gen/pg/pg_property.rb +0 -2078
  331. data/lib/wx/doc/gen/pg/pg_validation_info.rb +0 -344
  332. data/lib/wx/doc/gen/pg/property_grid.rb +0 -740
  333. data/lib/wx/doc/gen/pg/property_grid_event.rb +0 -184
  334. data/lib/wx/doc/gen/pg/property_grid_interface.rb +0 -1098
  335. data/lib/wx/doc/gen/pg/property_grid_manager.rb +0 -415
  336. data/lib/wx/doc/gen/pg/property_grid_page.rb +0 -354
  337. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +0 -165
  338. data/lib/wx/doc/gen/picker_base.rb +0 -152
  339. data/lib/wx/doc/gen/platform_info.rb +0 -622
  340. data/lib/wx/doc/gen/popup_window.rb +0 -107
  341. data/lib/wx/doc/gen/progress_dialog.rb +0 -100
  342. data/lib/wx/doc/gen/property_sheet_dialog.rb +0 -216
  343. data/lib/wx/doc/gen/prt/event_list.rb +0 -17
  344. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +0 -44
  345. data/lib/wx/doc/gen/prt/post_script_dc.rb +0 -30
  346. data/lib/wx/doc/gen/prt/preview_frame.rb +0 -78
  347. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +0 -151
  348. data/lib/wx/doc/gen/prt/print_data.rb +0 -804
  349. data/lib/wx/doc/gen/prt/print_dialog.rb +0 -55
  350. data/lib/wx/doc/gen/prt/printer.rb +0 -518
  351. data/lib/wx/doc/gen/prt/printer_dc.rb +0 -37
  352. data/lib/wx/doc/gen/query_layout_info_event.rb +0 -106
  353. data/lib/wx/doc/gen/radio_box.rb +0 -306
  354. data/lib/wx/doc/gen/radio_button.rb +0 -159
  355. data/lib/wx/doc/gen/rbn/event_list.rb +0 -136
  356. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +0 -1142
  357. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +0 -308
  358. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +0 -45
  359. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +0 -458
  360. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +0 -63
  361. data/lib/wx/doc/gen/rbn/ribbon_control.rb +0 -143
  362. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +0 -229
  363. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +0 -55
  364. data/lib/wx/doc/gen/rbn/ribbon_page.rb +0 -174
  365. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +0 -270
  366. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +0 -45
  367. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +0 -360
  368. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +0 -42
  369. data/lib/wx/doc/gen/rearrange_ctrl.rb +0 -78
  370. data/lib/wx/doc/gen/rearrange_list.rb +0 -123
  371. data/lib/wx/doc/gen/region.rb +0 -380
  372. data/lib/wx/doc/gen/region_iterator.rb +0 -76
  373. data/lib/wx/doc/gen/rich_tool_tip.rb +0 -154
  374. data/lib/wx/doc/gen/rt/event_list.rb +0 -17
  375. data/lib/wx/doc/gen/rt/shared_evt_handler.rb +0 -14
  376. data/lib/wx/doc/gen/rt/thread_event.rb +0 -71
  377. data/lib/wx/doc/gen/rtc/event_list.rb +0 -125
  378. data/lib/wx/doc/gen/rtc/rich_text_box.rb +0 -445
  379. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +0 -1188
  380. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +0 -41
  381. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +0 -538
  382. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +0 -2103
  383. data/lib/wx/doc/gen/rtc/rich_text_event.rb +0 -173
  384. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +0 -181
  385. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +0 -319
  386. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +0 -193
  387. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +0 -102
  388. data/lib/wx/doc/gen/rtc/rich_text_image.rb +0 -337
  389. data/lib/wx/doc/gen/rtc/rich_text_object.rb +0 -2922
  390. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +0 -1240
  391. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +0 -258
  392. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +0 -344
  393. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +0 -227
  394. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +0 -59
  395. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +0 -169
  396. data/lib/wx/doc/gen/sash_event.rb +0 -147
  397. data/lib/wx/doc/gen/sash_layout_window.rb +0 -232
  398. data/lib/wx/doc/gen/sash_window.rb +0 -171
  399. data/lib/wx/doc/gen/scaled_dc.rb +0 -10
  400. data/lib/wx/doc/gen/screen_dc.rb +0 -30
  401. data/lib/wx/doc/gen/scroll_bar.rb +0 -204
  402. data/lib/wx/doc/gen/scrolled_canvas.rb +0 -410
  403. data/lib/wx/doc/gen/scrolled_control.rb +0 -410
  404. data/lib/wx/doc/gen/scrolled_window.rb +0 -430
  405. data/lib/wx/doc/gen/search_ctrl.rb +0 -159
  406. data/lib/wx/doc/gen/secret_store.rb +0 -116
  407. data/lib/wx/doc/gen/simplebook.rb +0 -110
  408. data/lib/wx/doc/gen/single_choice_dialog.rb +0 -89
  409. data/lib/wx/doc/gen/sizer.rb +0 -945
  410. data/lib/wx/doc/gen/sizer_item.rb +0 -244
  411. data/lib/wx/doc/gen/slider.rb +0 -342
  412. data/lib/wx/doc/gen/spin_button.rb +0 -157
  413. data/lib/wx/doc/gen/spin_ctrl.rb +0 -231
  414. data/lib/wx/doc/gen/spin_ctrl_double.rb +0 -192
  415. data/lib/wx/doc/gen/spin_double_event.rb +0 -55
  416. data/lib/wx/doc/gen/spin_event.rb +0 -51
  417. data/lib/wx/doc/gen/splash_screen.rb +0 -113
  418. data/lib/wx/doc/gen/splitter_event.rb +0 -99
  419. data/lib/wx/doc/gen/splitter_window.rb +0 -498
  420. data/lib/wx/doc/gen/static_bitmap.rb +0 -256
  421. data/lib/wx/doc/gen/static_box.rb +0 -180
  422. data/lib/wx/doc/gen/static_box_sizer.rb +0 -85
  423. data/lib/wx/doc/gen/static_line.rb +0 -83
  424. data/lib/wx/doc/gen/static_text.rb +0 -127
  425. data/lib/wx/doc/gen/status_bar.rb +0 -290
  426. data/lib/wx/doc/gen/stc/event_list.rb +0 -221
  427. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +0 -4474
  428. data/lib/wx/doc/gen/stc/styled_text_event.rb +0 -8762
  429. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +0 -129
  430. data/lib/wx/doc/gen/svg_file_dc.rb +0 -164
  431. data/lib/wx/doc/gen/system_options.rb +0 -129
  432. data/lib/wx/doc/gen/system_settings.rb +0 -507
  433. data/lib/wx/doc/gen/task_bar_icon.rb +0 -127
  434. data/lib/wx/doc/gen/task_bar_icon_event.rb +0 -88
  435. data/lib/wx/doc/gen/text_attr.rb +0 -756
  436. data/lib/wx/doc/gen/text_ctrl.rb +0 -1033
  437. data/lib/wx/doc/gen/text_entry.rb +0 -441
  438. data/lib/wx/doc/gen/text_entry_dialog.rb +0 -220
  439. data/lib/wx/doc/gen/text_validator.rb +0 -245
  440. data/lib/wx/doc/gen/time_picker_ctrl.rb +0 -128
  441. data/lib/wx/doc/gen/timer.rb +0 -119
  442. data/lib/wx/doc/gen/timer_event.rb +0 -68
  443. data/lib/wx/doc/gen/tip_provider.rb +0 -63
  444. data/lib/wx/doc/gen/tip_window.rb +0 -51
  445. data/lib/wx/doc/gen/toggle_button.rb +0 -182
  446. data/lib/wx/doc/gen/tool_bar.rb +0 -890
  447. data/lib/wx/doc/gen/tool_tip.rb +0 -86
  448. data/lib/wx/doc/gen/toolbook.rb +0 -118
  449. data/lib/wx/doc/gen/top_level_window.rb +0 -516
  450. data/lib/wx/doc/gen/tree_ctrl.rb +0 -1052
  451. data/lib/wx/doc/gen/tree_event.rb +0 -127
  452. data/lib/wx/doc/gen/treebook.rb +0 -180
  453. data/lib/wx/doc/gen/ui_action_simulator.rb +0 -109
  454. data/lib/wx/doc/gen/utils.rb +0 -273
  455. data/lib/wx/doc/gen/v_list_box.rb +0 -272
  456. data/lib/wx/doc/gen/v_scrolled_canvas.rb +0 -195
  457. data/lib/wx/doc/gen/v_scrolled_window.rb +0 -191
  458. data/lib/wx/doc/gen/validator.rb +0 -68
  459. data/lib/wx/doc/gen/variant.rb +0 -294
  460. data/lib/wx/doc/gen/web/event_list.rb +0 -95
  461. data/lib/wx/doc/gen/web/web_view.rb +0 -1136
  462. data/lib/wx/doc/gen/web/web_view_event.rb +0 -210
  463. data/lib/wx/doc/gen/web/web_view_handler.rb +0 -318
  464. data/lib/wx/doc/gen/window.rb +0 -2917
  465. data/lib/wx/doc/gen/window_dc.rb +0 -38
  466. data/lib/wx/doc/gen/window_disabler.rb +0 -30
  467. data/lib/wx/doc/gen/with_images.rb +0 -84
  468. data/lib/wx/doc/gen/wizard.rb +0 -257
  469. data/lib/wx/doc/gen/wizard_event.rb +0 -113
  470. data/lib/wx/doc/gen/wizard_page.rb +0 -65
  471. data/lib/wx/doc/gen/wizard_page_simple.rb +0 -88
  472. data/lib/wx/doc/gen/wrap_sizer.rb +0 -79
  473. data/lib/wx/doc/gen/xml_node.rb +0 -316
  474. data/lib/wx/doc/gen/xml_resource.rb +0 -320
  475. data/lib/wx/grid/events/evt_list.rb +0 -166
  476. data/lib/wx/html/events/evt_list.rb +0 -27
  477. data/lib/wx/pg/events/evt_list.rb +0 -73
  478. data/lib/wx/rbn/events/evt_list.rb +0 -102
  479. data/lib/wx/rt/events/evt_list.rb +0 -8
  480. data/lib/wx/rtc/events/evt_list.rb +0 -98
  481. data/lib/wx/rtc/ext/rich_text_ctrl.rb +0 -24
  482. data/lib/wx/stc/events/evt_list.rb +0 -178
  483. data/lib/wx/web/events/evt_list.rb +0 -74
  484. data/samples/art/wxruby-512x512.png +0 -0
  485. data/tests/assets/test.css +0 -1
  486. data/tests/assets/test.html +0 -9
  487. /data/ext/wxruby3/swig/custom/{director.swg → common/director.swg} +0 -0
  488. /data/ext/wxruby3/swig/custom/{rubyapi.swg → common/rubyapi.swg} +0 -0
  489. /data/ext/wxruby3/swig/custom/{rubyerrors.swg → common/rubyerrors.swg} +0 -0
  490. /data/ext/wxruby3/swig/custom/{rubytracking.swg → common/rubytracking.swg} +0 -0
  491. /data/ext/wxruby3/swig/custom/{swiglabels.swg → common/swiglabels.swg} +0 -0
  492. /data/ext/wxruby3/swig/custom/{typemaps → common/typemaps}/swigtypemaps.swg +0 -0
  493. /data/ext/wxruby3/swig/custom/{wx_ruby_shared_ptr.i → common/wx_ruby_shared_ptr.i} +0 -0
  494. /data/ext/wxruby3/swig/custom/{wx_shared_ptr.i → common/wx_shared_ptr.i} +0 -0
  495. /data/ext/wxruby3/swig/custom/{rubyhead.swg → untyped_data/rubyhead.swg} +0 -0
  496. /data/ext/wxruby3/swig/custom/{rubyrun.swg → untyped_data/rubyrun.swg} +0 -0
  497. /data/ext/wxruby3/swig/custom/{swigrun.swg → untyped_data/swigrun.swg} +0 -0
  498. /data/rakelib/lib/core/include/{swigrubyrun.inc → untyped_data/swigrubyrun.inc} +0 -0
  499. /data/rakelib/lib/core/include/{swigrun.inc → untyped_data/swigrun.inc} +0 -0
@@ -1,203 +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
- module HTML
10
-
11
- #
12
- #
13
- PAGE_ODD = 0
14
-
15
- #
16
- #
17
- PAGE_EVEN = 1
18
-
19
- #
20
- #
21
- PAGE_ALL = 2
22
-
23
- # This class provides very simple interface to printing architecture.
24
- #
25
- # It allows you to print HTML documents using only a few commands.
26
- #
27
- # <div class="wxrb-note">
28
- # <b>Note:</b>
29
- # <p>Do not create this class on the stack only. You should create an instance on app startup and use this instance for all printing operations. The reason is that this class stores various settings in it.
30
- # </p>
31
- # </div>
32
- #
33
- # Category: {Wx::HTML}, Printing Framework
34
- #
35
- # @wxrb_require USE_PRINTING_ARCHITECTURE,USE_HTML
36
- class HtmlEasyPrinting < Object
37
-
38
- # Controls when the print dialog should be shown.
39
- #
40
- #
41
- # @see Wx::HTML::HtmlEasyPrinting#set_prompt_mode
42
- #
43
- #
44
- # @wxrb_require USE_PRINTING_ARCHITECTURE,USE_HTML
45
- class PromptMode < Wx::Enum
46
-
47
- # Do not show the print dialog.
48
- #
49
- Prompt_Never = Wx::HTML::HtmlEasyPrinting::PromptMode.new(0)
50
-
51
- # Show the print dialog only the first time.
52
- #
53
- Prompt_Once = Wx::HTML::HtmlEasyPrinting::PromptMode.new(1)
54
-
55
- # Show the print dialog every time (default value).
56
- #
57
- Prompt_Always = Wx::HTML::HtmlEasyPrinting::PromptMode.new(2)
58
-
59
- end # PromptMode
60
-
61
- # Constructor.
62
- # @param name [String] Name of the printing object. Used by preview frames and setup dialogs.
63
- # @param parentWindow [Wx::Window] pointer to the window that will own the preview frame and setup dialogs. May be nil.
64
- # @return [Wx::HTML::HtmlEasyPrinting]
65
- def initialize(name=("PRINTING"), parentWindow=nil) end
66
-
67
- # Returns the current name being used for preview frames and setup dialogs.
68
- # @return [Wx::String]
69
- def get_name; end
70
- alias_method :name, :get_name
71
-
72
- # Returns a pointer to {Wx::PRT::PageSetupDialogData} instance used by this class.
73
- #
74
- # You can set its parameters (via SetXXXX methods).
75
- # @return [Wx::PRT::PageSetupDialogData]
76
- def get_page_setup_data; end
77
- alias_method :page_setup_data, :get_page_setup_data
78
-
79
- # Gets the parent window for dialogs.
80
- # @return [Wx::Window]
81
- def get_parent_window; end
82
- alias_method :parent_window, :get_parent_window
83
-
84
- # Returns pointer to {Wx::PRT::PrintData} instance used by this class.
85
- #
86
- # You can set its parameters (via SetXXXX methods).
87
- # @return [Wx::PRT::PrintData]
88
- def get_print_data; end
89
- alias_method :print_data, :get_print_data
90
-
91
- # Display page setup dialog and allows the user to modify settings.
92
- # @return [void]
93
- def page_setup; end
94
-
95
- # Preview HTML file.
96
- #
97
- # Returns false in case of error call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
98
- # @param htmlfile [String]
99
- # @return [Boolean]
100
- def preview_file(htmlfile) end
101
-
102
- # Preview HTML text (not file!).
103
- #
104
- # Returns false in case of error call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
105
- # @param htmltext [String] HTML text.
106
- # @param basepath [String] base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.
107
- # @return [Boolean]
108
- def preview_text(htmltext, basepath=('')) end
109
-
110
- # Print HTML file.
111
- #
112
- # Returns false in case of error call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
113
- # @param htmlfile [String]
114
- # @return [Boolean]
115
- def print_file(htmlfile) end
116
-
117
- # Print HTML text (not file!).
118
- #
119
- # Returns false in case of error call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
120
- # @param htmltext [String] HTML text.
121
- # @param basepath [String] base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.
122
- # @return [Boolean]
123
- def print_text(htmltext, basepath=('')) end
124
-
125
- # Sets fonts.
126
- #
127
- # See Wx::HtmlDCRenderer::SetFonts for detailed description.
128
- # @param normal_face [String]
129
- # @param fixed_face [String]
130
- # @param sizes [Array(Integer,Integer,Integer,Integer,Integer,Integer,Integer), nil]
131
- # @return [void]
132
- def set_fonts(normal_face, fixed_face, sizes=nil) end
133
-
134
- # Sets the name used for preview frames and setup dialogs.
135
- # @param name [String]
136
- # @return [void]
137
- def set_name(name) end
138
- alias_method :name=, :set_name
139
-
140
- # Sets default font sizes and/or default font size.
141
- #
142
- # See Wx::HtmlDCRenderer::SetStandardFonts for detailed description.
143
- # @see Wx::HTML::HtmlEasyPrinting#set_fonts
144
- # @param size [Integer]
145
- # @param normal_face [String]
146
- # @param fixed_face [String]
147
- # @return [void]
148
- def set_standard_fonts(size=-1, normal_face=(''), fixed_face=('')) end
149
- alias_method :standard_fonts=, :set_standard_fonts
150
-
151
- # Set page footer.
152
- #
153
- # The following macros can be used inside it:
154
- #
155
- # - @DATE@ is replaced by the current date in default format
156
- # - @PAGENUM@ is replaced by page number
157
- # - @PAGESCNT@ is replaced by total number of pages
158
- # - @TIME@ is replaced by the current time in default format
159
- # - @TITLE@ is replaced with the title of the document
160
- # - @USER@ is replaced with the user's name (support for this macro was added in wxWidgets 3.2.8)
161
- # @param footer [String] HTML text to be used as footer.
162
- # @param pg [Integer] one of {Wx::HTML::PAGE_ODD}, {Wx::HTML::PAGE_EVEN} and {Wx::HTML::PAGE_ALL} constants.
163
- # @return [void]
164
- def set_footer(footer, pg=Wx::HTML::PAGE_ALL) end
165
- alias_method :footer=, :set_footer
166
-
167
- # Set page header.
168
- #
169
- # The following macros can be used inside it:
170
- #
171
- # - @DATE@ is replaced by the current date in default format
172
- # - @PAGENUM@ is replaced by page number
173
- # - @PAGESCNT@ is replaced by total number of pages
174
- # - @TIME@ is replaced by the current time in default format
175
- # - @TITLE@ is replaced with the title of the document
176
- # - @USER@ is replaced with the user's name (support for this macro was added in wxWidgets 3.2.8)
177
- # @param header [String] HTML text to be used as header.
178
- # @param pg [Integer] one of {Wx::HTML::PAGE_ODD}, {Wx::HTML::PAGE_EVEN} and {Wx::HTML::PAGE_ALL} constants.
179
- # @return [void]
180
- def set_header(header, pg=Wx::HTML::PAGE_ALL) end
181
- alias_method :header=, :set_header
182
-
183
- # Sets the parent window for dialogs.
184
- # @param window [Wx::Window]
185
- # @return [void]
186
- def set_parent_window(window) end
187
- alias_method :parent_window=, :set_parent_window
188
-
189
- # Enable or disable showing the dialog before printing.
190
- #
191
- # The prompt mode determines the value of the prompt parameter passed to {Wx::PRT::Printer#print} when it is called by this class.
192
- # Default prompt mode value is Prompt_Always.
193
- # @param promptMode [Wx::HtmlEasyPrinting::PromptMode]
194
- # @return [void]
195
- def set_prompt_mode(promptMode) end
196
- alias_method :prompt_mode=, :set_prompt_mode
197
-
198
- end # HtmlEasyPrinting
199
-
200
-
201
- end
202
-
203
- end
@@ -1,382 +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
- module HTML
10
-
11
- #
12
- HF_TOOLBAR = 1
13
-
14
- #
15
- HF_CONTENTS = 2
16
-
17
- #
18
- HF_INDEX = 4
19
-
20
- #
21
- HF_SEARCH = 8
22
-
23
- #
24
- HF_BOOKMARKS = 16
25
-
26
- #
27
- HF_OPEN_FILES = 32
28
-
29
- #
30
- HF_PRINT = 64
31
-
32
- #
33
- HF_FLAT_TOOLBAR = 128
34
-
35
- #
36
- HF_MERGE_BOOKS = 256
37
-
38
- #
39
- HF_ICONS_BOOK = 512
40
-
41
- #
42
- HF_ICONS_BOOK_CHAPTER = 1024
43
-
44
- #
45
- HF_ICONS_FOLDER = 0
46
-
47
- #
48
- HF_DEFAULT_STYLE = 95
49
-
50
- #
51
- ID_HTML_HELPFRAME = 6001
52
-
53
- #
54
- HF_EMBEDDED = 32768
55
-
56
- #
57
- HF_DIALOG = 65536
58
-
59
- #
60
- HF_FRAME = 131072
61
-
62
- #
63
- HF_MODAL = 262144
64
-
65
- #
66
- HELP_NETSCAPE = 1
67
-
68
- # Help search modes for {Wx::HelpController#keyword_search}.
69
- #
70
- #
71
- #
72
- # @wxrb_require USE_HELP,USE_HTML
73
- class HelpSearchMode < Wx::Enum
74
-
75
- # Search the index only.
76
- #
77
- HELP_SEARCH_INDEX = Wx::HTML::HelpSearchMode.new(0)
78
-
79
- # Search all entries.
80
- #
81
- HELP_SEARCH_ALL = Wx::HTML::HelpSearchMode.new(1)
82
-
83
- end # HelpSearchMode
84
-
85
- # This help controller provides an easy way of displaying HTML help in your application (see page_samples_html, test example).
86
- #
87
- # The help system is based on <b>books</b> (see {Wx::HTML::HtmlHelpController#add_book}). A book is a logical section of documentation (for example "User's Guide" or "Programmer's Guide" or "C++ Reference" or "wxWidgets Reference"). The help controller can handle as many books as you want.
88
- # Although this class has an API compatible with other wxWidgets help controllers as documented by {Wx::HelpController}, it is recommended that you use the enhanced capabilities of {Wx::HTML::HtmlHelpController}'s API.
89
- # {Wx::HTML} uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as its native format. The file format is described in Help Files Format. The directory helpfiles in the page_samples_html contains sample project files.
90
- # Note that the Microsoft's HTML Help Workshop (http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc) also runs on other platforms using WINE (http://www.winehq.org/) and it can be used to create the .hpp, .hhk and .hhc files through a friendly GUI. The commercial tool HelpBlocks (http://www.helpblocks.com) can also create these files.
91
- #
92
- # Category: {Wx::HELP}, {Wx::HTML}
93
- # @see wxBestHelpController
94
- # @see Wx::HtmlHelpFrame
95
- # @see Wx::HtmlHelpDialog
96
- # @see Wx::HTML::HtmlHelpWindow
97
- # @see Wx::HtmlModalHelp
98
- #
99
- #
100
- # @wxrb_require USE_HELP,USE_HTML
101
- class HtmlHelpController < Object
102
-
103
- # @overload initialize(style=Wx::HTML::HF_DEFAULT_STYLE, parentWindow=nil)
104
- # Constructor.
105
- # @param style [Integer] This is a combination of these flags:
106
- #
107
- # - {Wx::HF_TOOLBAR}: The help window has a toolbar.
108
- # - {Wx::HTML::HF_FLAT_TOOLBAR}: The help window has a toolbar with flat buttons (aka coolbar).
109
- # - {Wx::HF_CONTENTS}: The help window has a contents panel.
110
- # - {Wx::HF_INDEX}: The help window has an index panel.
111
- # - {Wx::HTML::HF_SEARCH}: The help window has a search panel.
112
- # - {Wx::HTML::HF_BOOKMARKS}: The help window has bookmarks controls.
113
- # - {Wx::HTML::HF_OPEN_FILES}: Allows user to open arbitrary HTML document.
114
- # - {Wx::HTML::HF_PRINT}: The toolbar contains "print" button.
115
- # - {Wx::HTML::HF_MERGE_BOOKS}: The contents pane does not show book nodes. All books are merged together and appear as single book to the user.
116
- # - {Wx::HTML::HF_ICONS_BOOK}: All nodes in contents pane have a book icon. This is how Microsoft's HTML help viewer behaves.
117
- # - {Wx::HTML::HF_ICONS_FOLDER}: Book nodes in contents pane have a book icon, book's sections have a folder icon. This is the default.
118
- # - {Wx::HTML::HF_ICONS_BOOK_CHAPTER}: Both book nodes and nodes of top-level sections of a book (i.e. chapters) have a book icon, all other sections (sections, subsections, ...) have a folder icon.
119
- # - {Wx::HTML::HF_EMBEDDED}: Specifies that the help controller controls an embedded window of class {Wx::HTML::HtmlHelpWindow} that should not be destroyed when the controller is destroyed.
120
- # - {Wx::HTML::HF_DIALOG}: Specifies that the help controller should create a dialog containing the help window.
121
- # - {Wx::HTML::HF_FRAME}: Specifies that the help controller should create a frame containing the help window. This is the default if neither {Wx::HTML::HF_DIALOG} nor {Wx::HTML::HF_EMBEDDED} is specified.
122
- # - {Wx::HTML::HF_MODAL}: Specifies that the help controller should create a modal dialog containing the help window (used with the {Wx::HTML::HF_DIALOG} style).
123
- # - {Wx::HTML::HF_DEFAULT_STYLE}: {Wx::HF_TOOLBAR} | {Wx::HF_CONTENTS} | {Wx::HF_INDEX} | {Wx::HTML::HF_SEARCH} | {Wx::HTML::HF_BOOKMARKS} | {Wx::HTML::HF_PRINT}
124
- # @param parentWindow [Wx::Window] This is an optional window to be used as the parent for the help window.
125
- # @return [Wx::HTML::HtmlHelpController]
126
- # @overload initialize(parentWindow, style=Wx::HTML::HF_DEFAULT_STYLE)
127
- # @param parentWindow [Wx::Window]
128
- # @param style [Integer]
129
- # @return [Wx::HTML::HtmlHelpController]
130
- def initialize(*args) end
131
-
132
- # @overload add_book(bookFile, showWaitMsg=false)
133
- # Adds a book (i.e.
134
- #
135
- # a .hhp file; an HTML Help Workshop project file) into the list of loaded books.
136
- # This must be called at least once before displaying any help. bookFile or bookUrl may be either <code>".hhp"</code> file or a ZIP archive that contains an arbitrary number of <code>".hhp"</code> files in its top-level directory. This ZIP archive must have <code>".zip"</code> or <code>".htb"</code> extension (the latter stands for "HTML book"). In other words,
137
- # ```ruby
138
- # add_book('help.zip')
139
- # ```
140
- # is possible and is the recommended way.
141
- # @param bookFile [String] Help book filename. It is recommended to use this prototype instead of the one taking URL, because it is less error-prone.
142
- # @param showWaitMsg [Boolean] If true then a decoration-less window with progress message is displayed.
143
- # @return [Boolean]
144
- # @overload add_book(bookUrl, showWaitMsg=false)
145
- # Adds a book (i.e.
146
- #
147
- # a .hhp file; an HTML Help Workshop project file) into the list of loaded books.
148
- # See the other overload for additional info.
149
- # @param bookUrl [String] Help book URL (note that syntax of filename and URL is different on most platforms).
150
- # @param showWaitMsg [Boolean] If true then a decoration-less window with progress message is displayed.
151
- # @return [Boolean]
152
- def add_book(*args) end
153
-
154
- # @overload display(x)
155
- # Displays page x.
156
- #
157
- # This is THE important function - it is used to display the help in application. You can specify the page in many ways:
158
- #
159
- # - as direct filename of HTML document
160
- # - as chapter name (from contents) or as a book name
161
- # - as some word from index
162
- # - even as any word (will be searched)
163
- #
164
- # Looking for the page runs in these steps:
165
- #
166
- # - try to locate file named x (if x is for example "doc/howto.htm")
167
- # - try to open starting page of book named x
168
- # - try to find x in contents (if x is for example "How To ...")
169
- # - try to find x in index (if x is for example "How To ...")
170
- # - switch to Search panel and start searching
171
- # @param x [String]
172
- # @return [Boolean]
173
- # @overload display(id)
174
- # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
175
- # This alternative form is used to search help contents by numeric IDs.
176
- # @param id [Integer]
177
- # @return [Boolean]
178
- def display(*args) end
179
-
180
- # Displays help window and focuses index panel.
181
- # @return [Boolean]
182
- def display_index; end
183
-
184
- # Reads the controller's setting (position of window, etc.).
185
- # @param cfg [Wx::ConfigBase]
186
- # @param path [String]
187
- # @return [void]
188
- def read_customization(cfg, path=('')) end
189
-
190
- # Sets whether the help frame should prevent application from exiting if it's the only remaining top level window.
191
- #
192
- #
193
- # @see Wx::App#set_exit_on_frame_delete
194
- # @param enable [Boolean] If true, the application will not quit unless the help frame is closed. Default is false, i.e. the application does exit if only the help window remains opened.
195
- # @return [void]
196
- def set_should_prevent_app_exit(enable) end
197
- alias_method :should_prevent_app_exit=, :set_should_prevent_app_exit
198
-
199
- # Sets the path for storing temporary files - cached binary versions of index and contents files.
200
- #
201
- # These binary forms are much faster to read. Default value is empty string (empty string means that no cached data are stored). Note that these files are not deleted when program exits.
202
- # Once created these cached files will be used in all subsequent executions of your application. If cached files become older than corresponding <code>".hhp"</code> file (e.g. if you regenerate documentation) it will be refreshed.
203
- # @param path [String]
204
- # @return [void]
205
- def set_temp_dir(path) end
206
- alias_method :temp_dir=, :set_temp_dir
207
-
208
- # Sets format of title of the frame.
209
- #
210
- # Must contain exactly one "%s" (for title of displayed HTML page).
211
- # @param format [String]
212
- # @return [void]
213
- def set_title_format(format) end
214
- alias_method :title_format=, :set_title_format
215
-
216
- # Associates the config object with the controller.
217
- #
218
- # If there is associated config object, {Wx::HTML::HtmlHelpController} automatically reads and writes settings (including {Wx::HTML::HtmlWindow}'s settings) when needed. The only thing you must do is create {Wx::Config} object and call {Wx::HTML::HtmlHelpController#use_config}.
219
- # If you do not use {Wx::HTML::HtmlHelpController#use_config}, {Wx::HTML::HtmlHelpController} will use the default {Wx::Config} object if available (for details see {Wx::ConfigBase::Get} and {Wx::ConfigBase::Set}).
220
- # @param config [Wx::ConfigBase]
221
- # @param rootpath [String]
222
- # @return [void]
223
- def use_config(config, rootpath=('')) end
224
-
225
- # Stores controllers setting (position of window etc.).
226
- # @param cfg [Wx::ConfigBase]
227
- # @param path [String]
228
- # @return [void]
229
- def write_customization(cfg, path=('')) end
230
-
231
- # Get the current help window.
232
- # @return [Wx::HTML::HtmlHelpWindow]
233
- def get_help_window; end
234
- alias_method :help_window, :get_help_window
235
-
236
- # Set the help window to be managed by this controller.
237
- #
238
- # This makes it possible to have a help window that might not be in a {Wx::HtmlHelpFrame} or dialog but is embedded in some other window in the application. Be sure to use the {Wx::HTML::HF_EMBEDDED} style in this case.
239
- # @param helpWindow [Wx::HTML::HtmlHelpWindow]
240
- # @return [void]
241
- def set_help_window(helpWindow) end
242
- alias_method :help_window=, :set_help_window
243
-
244
- # If the help viewer is not running, runs it and displays the file at the given block number.
245
- #
246
- # - WinHelp: Refers to the context number.
247
- # - MS HTML Help: Refers to the context number.
248
- # - External HTML help: the same as for {Wx::HTML::HtmlHelpController#display_section}.
249
- # - {Wx::HTML::HtmlHelpController}: sectionNo is an identifier as specified in the <code></code>.hhc file. See Help Files Format.
250
- # DeprecatedThis function is for backward compatibility only, and applications should use {Wx::HTML::HtmlHelpController#display_section} instead.
251
- # @param blockNo [Integer]
252
- # @return [Boolean]
253
- def display_block(blockNo) end
254
-
255
- # If the help viewer is not running, runs it and displays the contents.
256
- # @return [Boolean]
257
- def display_contents; end
258
-
259
- # Displays the section as a popup window using a context id.
260
- #
261
- # Returns false if unsuccessful or not implemented.
262
- # @param contextId [Integer]
263
- # @return [Boolean]
264
- def display_context_popup(contextId) end
265
-
266
- # @overload display_section(section)
267
- # If the help viewer is not running, runs it and displays the given section.
268
- #
269
- # The interpretation of section differs between help viewers. For most viewers, this call is equivalent to KeywordSearch. For MS HTML Help, {Wx::HTML} help and external HTML help, if section has a .htm or .html extension, that HTML file will be displayed; otherwise a keyword search is done.
270
- # @param section [String]
271
- # @return [Boolean]
272
- # @overload display_section(sectionNo)
273
- # If the help viewer is not running, runs it and displays the given section.
274
- #
275
- # - WinHelp, MS HTML Help sectionNo is a context id.
276
- # - MS HTML Help: Pass -1 in sectionNo to display the index.
277
- # - External HTML help: {Wx::ExtHelpController} implements sectionNo as an id in a map file, which is of the form:
278
- # - {Wx::HTML::HtmlHelpController}: sectionNo is an identifier as specified in the <code></code>.hhc file. See Help Files Format. See also the help sample for notes on how to specify section numbers for various help file formats.
279
- # @param sectionNo [Integer]
280
- # @return [Boolean]
281
- def display_section(*args) end
282
-
283
- # Displays the text in a popup window, if possible.
284
- #
285
- # Returns false if unsuccessful or not implemented.
286
- # @param text [String]
287
- # @param pos [Array(Integer, Integer), Wx::Point]
288
- # @return [Boolean]
289
- def display_text_popup(text, pos) end
290
-
291
- # Returns the window to be used as the parent for the help window.
292
- #
293
- # This window is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
294
- # @return [Wx::Window]
295
- def get_parent_window; end
296
- alias_method :parent_window, :get_parent_window
297
-
298
- # Initializes the help instance with a help filename.
299
- #
300
- # Does not invoke the help viewer. This must be called directly after the help instance object is created and before any attempts to communicate with the viewer.
301
- # You may omit the file extension and a suitable one will be chosen. For {Wx::HTML::HtmlHelpController}, the extensions zip, htb and hhp will be appended while searching for a suitable file. For WinHelp, the hlp extension is appended.
302
- # @param file [String]
303
- # @return [Boolean]
304
- def init(file) end
305
-
306
- # If the help viewer is not running, runs it, and searches for sections matching the given keyword.
307
- #
308
- # If one match is found, the file is displayed at this section. The optional parameter allows searching the index ({Wx::HelpSearchMode::HELP_SEARCH_INDEX}) but this currently is only supported by the {Wx::HTML::HtmlHelpController}.
309
- #
310
- # - WinHelp, MS HTML Help: If more than one match is found, the first topic is displayed.
311
- # - MS HTML Help: Pass an empty string to display the search page.
312
- # - External HTML help, simple {Wx::HTML} help: If more than one match is found, a choice of topics is displayed.
313
- # - {Wx::HTML::HtmlHelpController}: see {Wx::HTML::HtmlHelpController#keyword_search}.
314
- # @param keyWord [String]
315
- # @param mode [Wx::HelpSearchMode]
316
- # @return [Boolean]
317
- def keyword_search(keyWord, mode=Wx::HelpSearchMode::HELP_SEARCH_ALL) end
318
-
319
- # If the help viewer is not running, runs it and loads the given file.
320
- #
321
- # If the filename is not supplied or is empty, the file specified in {Wx::HTML::HtmlHelpController#initialize} is used.
322
- # If the viewer is already displaying the specified file, it will not be reloaded. This member function may be used before each display call in case the user has opened another file.
323
- # {Wx::HTML::HtmlHelpController} ignores this call.
324
- # @param file [String]
325
- # @return [Boolean]
326
- def load_file(file=('')) end
327
-
328
- # Overridable member called when this application's viewer is quit by the user.
329
- #
330
- # This does not work for all help controllers.
331
- # @return [void]
332
- def on_quit; end
333
-
334
- # If the viewer is running, quits it by disconnecting.
335
- #
336
- # For Windows Help, the viewer will only close if no other application is using it.
337
- # @return [Boolean]
338
- def quit; end
339
-
340
- # Set the parameters of the frame window.
341
- #
342
- # For {Wx::HTML::HtmlHelpController}, titleFormat specifies the title string format (with s being replaced by the actual page title) and size and position specify the geometry of the frame.
343
- # For all other help controllers this function has no effect.
344
- # Finally, newFrameEachTime is always ignored currently.
345
- # @param titleFormat [String]
346
- # @param size [Array(Integer, Integer), Wx::Size]
347
- # @param pos [Array(Integer, Integer), Wx::Point]
348
- # @param newFrameEachTime [Boolean]
349
- # @return [void]
350
- def set_frame_parameters(titleFormat, size, pos=Wx::DEFAULT_POSITION, newFrameEachTime=false) end
351
-
352
- # Sets the window to be used as the parent for the help window.
353
- #
354
- # This is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
355
- # @param parentWindow [Wx::Window]
356
- # @return [void]
357
- def set_parent_window(parentWindow) end
358
- alias_method :parent_window=, :set_parent_window
359
-
360
- # Sets detailed viewer information.
361
- #
362
- # So far this is only relevant to {Wx::ExtHelpController}. Some examples of usage:
363
- #
364
- # ```ruby
365
- # @help.set_viewer('kdehelp')
366
- # @help.set_viewer('gnome-help-browser')
367
- # @help.set_viewer('netscape', Wx::HELP_NETSCAPE)
368
- # ```
369
- #
370
- # Todomodernize this function with {Wx::LaunchDefaultBrowser}
371
- # @param viewer [String] This defaults to "netscape" for {Wx::ExtHelpController}.
372
- # @param flags [Integer] This defaults to {Wx::HTML::HELP_NETSCAPE} for {Wx::ExtHelpController}, indicating that the viewer is a variant of Netscape Navigator.
373
- # @return [void]
374
- def set_viewer(viewer, flags=Wx::HTML::HELP_NETSCAPE) end
375
- alias_method :viewer=, :set_viewer
376
-
377
- end # HtmlHelpController
378
-
379
-
380
- end
381
-
382
- end