wxruby3 0.9.5-x64-mingw-ucrt → 0.9.7-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (386) hide show
  1. checksums.yaml +4 -4
  2. data/.wxconfig +9 -8
  3. data/INSTALL.md +315 -78
  4. data/README.md +31 -20
  5. data/ext/wxbase32u_gcc_custom.dll +0 -0
  6. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  7. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  19. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  20. data/lib/wx/core/ext.rb +22 -3
  21. data/lib/wx/doc/gen/about_dialog_info.rb +1 -1
  22. data/lib/wx/doc/gen/accelerator.rb +1 -1
  23. data/lib/wx/doc/gen/accessible.rb +1 -1
  24. data/lib/wx/doc/gen/activity_indicator.rb +1 -1
  25. data/lib/wx/doc/gen/animation.rb +1 -1
  26. data/lib/wx/doc/gen/animation_ctrl.rb +1 -1
  27. data/lib/wx/doc/gen/any_button.rb +1 -1
  28. data/lib/wx/doc/gen/app.rb +1 -1
  29. data/lib/wx/doc/gen/app_traits.rb +1 -1
  30. data/lib/wx/doc/gen/art_provider.rb +1 -1
  31. data/lib/wx/doc/gen/aui/aui_dock_art.rb +430 -426
  32. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +34 -30
  33. data/lib/wx/doc/gen/aui/aui_manager.rb +352 -348
  34. data/lib/wx/doc/gen/aui/aui_manager_event.rb +107 -103
  35. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +157 -153
  36. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +42 -38
  37. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +109 -105
  38. data/lib/wx/doc/gen/aui/aui_notebook.rb +438 -434
  39. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +145 -141
  40. data/lib/wx/doc/gen/aui/aui_pane_info.rb +689 -685
  41. data/lib/wx/doc/gen/aui/aui_tab_art.rb +369 -365
  42. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +100 -96
  43. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +445 -441
  44. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +268 -264
  45. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +179 -175
  46. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +219 -215
  47. data/lib/wx/doc/gen/banner_window.rb +1 -1
  48. data/lib/wx/doc/gen/bitmap.rb +1 -1
  49. data/lib/wx/doc/gen/bitmap_button.rb +1 -1
  50. data/lib/wx/doc/gen/bitmap_combo_box.rb +1 -1
  51. data/lib/wx/doc/gen/book_ctrl_base.rb +1 -1
  52. data/lib/wx/doc/gen/book_ctrl_event.rb +1 -1
  53. data/lib/wx/doc/gen/box_sizer.rb +1 -1
  54. data/lib/wx/doc/gen/brush.rb +1 -1
  55. data/lib/wx/doc/gen/busy_info.rb +1 -1
  56. data/lib/wx/doc/gen/button.rb +1 -1
  57. data/lib/wx/doc/gen/calculate_layout_event.rb +1 -1
  58. data/lib/wx/doc/gen/calendar_ctrl.rb +1 -1
  59. data/lib/wx/doc/gen/calendar_date_attr.rb +1 -1
  60. data/lib/wx/doc/gen/calendar_event.rb +1 -1
  61. data/lib/wx/doc/gen/caret.rb +1 -1
  62. data/lib/wx/doc/gen/check_box.rb +1 -1
  63. data/lib/wx/doc/gen/check_list_box.rb +1 -1
  64. data/lib/wx/doc/gen/choice.rb +1 -1
  65. data/lib/wx/doc/gen/choicebook.rb +1 -1
  66. data/lib/wx/doc/gen/client_dc.rb +1 -1
  67. data/lib/wx/doc/gen/clipboard.rb +1 -1
  68. data/lib/wx/doc/gen/collapsible_pane.rb +1 -1
  69. data/lib/wx/doc/gen/collapsible_pane_event.rb +1 -1
  70. data/lib/wx/doc/gen/colour.rb +1 -1
  71. data/lib/wx/doc/gen/colour_dialog.rb +1 -1
  72. data/lib/wx/doc/gen/colour_picker_ctrl.rb +1 -1
  73. data/lib/wx/doc/gen/colour_picker_event.rb +1 -1
  74. data/lib/wx/doc/gen/combo_box.rb +1 -1
  75. data/lib/wx/doc/gen/combo_ctrl.rb +1 -1
  76. data/lib/wx/doc/gen/command_link_button.rb +1 -1
  77. data/lib/wx/doc/gen/config_base.rb +1 -1
  78. data/lib/wx/doc/gen/context_help_button.rb +1 -1
  79. data/lib/wx/doc/gen/control.rb +1 -1
  80. data/lib/wx/doc/gen/control_with_items.rb +1 -1
  81. data/lib/wx/doc/gen/core.rb +5 -5
  82. data/lib/wx/doc/gen/cursor.rb +1 -1
  83. data/lib/wx/doc/gen/data_format.rb +1 -1
  84. data/lib/wx/doc/gen/data_object.rb +1 -1
  85. data/lib/wx/doc/gen/data_object_simple_base.rb +1 -1
  86. data/lib/wx/doc/gen/date_event.rb +1 -1
  87. data/lib/wx/doc/gen/date_picker_ctrl.rb +1 -1
  88. data/lib/wx/doc/gen/dc.rb +1 -1
  89. data/lib/wx/doc/gen/defs.rb +1 -1
  90. data/lib/wx/doc/gen/dial_up_event.rb +1 -1
  91. data/lib/wx/doc/gen/dial_up_manager.rb +1 -1
  92. data/lib/wx/doc/gen/dialog.rb +1 -1
  93. data/lib/wx/doc/gen/dir_dialog.rb +1 -1
  94. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -1
  95. data/lib/wx/doc/gen/dir_picker_ctrl.rb +1 -1
  96. data/lib/wx/doc/gen/drag_drop.rb +1 -1
  97. data/lib/wx/doc/gen/drag_image.rb +1 -1
  98. data/lib/wx/doc/gen/editable_list_box.rb +1 -1
  99. data/lib/wx/doc/gen/event.rb +1 -1
  100. data/lib/wx/doc/gen/event_blocker.rb +1 -1
  101. data/lib/wx/doc/gen/event_filter.rb +1 -1
  102. data/lib/wx/doc/gen/events.rb +1 -1
  103. data/lib/wx/doc/gen/evt_handler.rb +1 -1
  104. data/lib/wx/doc/gen/ext_help_controller.rb +1 -1
  105. data/lib/wx/doc/gen/file_ctrl.rb +1 -1
  106. data/lib/wx/doc/gen/file_ctrl_event.rb +1 -1
  107. data/lib/wx/doc/gen/file_dialog.rb +1 -1
  108. data/lib/wx/doc/gen/file_dialog_custom_control.rb +1 -1
  109. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +1 -1
  110. data/lib/wx/doc/gen/file_dir_picker_event.rb +1 -1
  111. data/lib/wx/doc/gen/file_picker_ctrl.rb +1 -1
  112. data/lib/wx/doc/gen/file_system.rb +1 -1
  113. data/lib/wx/doc/gen/find_dialog_event.rb +1 -1
  114. data/lib/wx/doc/gen/find_replace_data.rb +1 -1
  115. data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
  116. data/lib/wx/doc/gen/flex_grid_sizer.rb +1 -1
  117. data/lib/wx/doc/gen/font.rb +1 -1
  118. data/lib/wx/doc/gen/font_data.rb +1 -1
  119. data/lib/wx/doc/gen/font_dialog.rb +1 -1
  120. data/lib/wx/doc/gen/font_picker_ctrl.rb +1 -1
  121. data/lib/wx/doc/gen/font_picker_event.rb +1 -1
  122. data/lib/wx/doc/gen/frame.rb +1 -1
  123. data/lib/wx/doc/gen/fs_file.rb +1 -1
  124. data/lib/wx/doc/gen/functions.rb +1 -1
  125. data/lib/wx/doc/gen/gauge.rb +1 -1
  126. data/lib/wx/doc/gen/gb_sizer_item.rb +1 -1
  127. data/lib/wx/doc/gen/gcdc.rb +1 -1
  128. data/lib/wx/doc/gen/gdi_common.rb +3 -3
  129. data/lib/wx/doc/gen/gdi_object.rb +1 -1
  130. data/lib/wx/doc/gen/generic_dir_ctrl.rb +1 -1
  131. data/lib/wx/doc/gen/graphics_context.rb +1 -1
  132. data/lib/wx/doc/gen/graphics_object.rb +1 -1
  133. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +28 -24
  134. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +251 -247
  135. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +25 -21
  136. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +27 -23
  137. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +38 -34
  138. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +25 -21
  139. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +35 -31
  140. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +28 -24
  141. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +34 -30
  142. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +30 -26
  143. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +183 -179
  144. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +29 -25
  145. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +33 -29
  146. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +34 -30
  147. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +67 -63
  148. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +34 -30
  149. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +25 -21
  150. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +93 -89
  151. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +25 -21
  152. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +38 -34
  153. data/lib/wx/doc/gen/grid/grid_ctrl.rb +2722 -2718
  154. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +82 -78
  155. data/lib/wx/doc/gen/grid/grid_event.rb +106 -102
  156. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +93 -89
  157. data/lib/wx/doc/gen/grid/grid_size_event.rb +70 -66
  158. data/lib/wx/doc/gen/grid/grid_string_table.rb +130 -126
  159. data/lib/wx/doc/gen/grid/grid_table_base.rb +303 -299
  160. data/lib/wx/doc/gen/grid/grid_table_message.rb +70 -66
  161. data/lib/wx/doc/gen/grid_bag_sizer.rb +1 -1
  162. data/lib/wx/doc/gen/grid_sizer.rb +1 -1
  163. data/lib/wx/doc/gen/gui_event_loop.rb +1 -1
  164. data/lib/wx/doc/gen/header_ctrl.rb +1 -1
  165. data/lib/wx/doc/gen/header_ctrl_event.rb +1 -1
  166. data/lib/wx/doc/gen/help_controller.rb +1 -1
  167. data/lib/wx/doc/gen/help_provider.rb +1 -1
  168. data/lib/wx/doc/gen/html/html_cell.rb +515 -511
  169. data/lib/wx/doc/gen/html/html_cell_event.rb +58 -54
  170. data/lib/wx/doc/gen/html/html_easy_printing.rb +171 -167
  171. data/lib/wx/doc/gen/html/html_help_controller.rb +292 -288
  172. data/lib/wx/doc/gen/html/html_help_data.rb +147 -143
  173. data/lib/wx/doc/gen/html/html_help_window.rb +232 -228
  174. data/lib/wx/doc/gen/html/html_link_event.rb +30 -26
  175. data/lib/wx/doc/gen/html/html_list_box.rb +301 -297
  176. data/lib/wx/doc/gen/html/html_printout.rb +94 -90
  177. data/lib/wx/doc/gen/html/html_window.rb +406 -402
  178. data/lib/wx/doc/gen/hyperlink_ctrl.rb +1 -1
  179. data/lib/wx/doc/gen/hyperlink_event.rb +1 -1
  180. data/lib/wx/doc/gen/icon.rb +1 -1
  181. data/lib/wx/doc/gen/icon_location.rb +1 -1
  182. data/lib/wx/doc/gen/image.rb +1 -1
  183. data/lib/wx/doc/gen/image_list.rb +1 -1
  184. data/lib/wx/doc/gen/info_bar.rb +1 -1
  185. data/lib/wx/doc/gen/keyboard_state.rb +1 -1
  186. data/lib/wx/doc/gen/list_box.rb +1 -1
  187. data/lib/wx/doc/gen/list_ctrl.rb +1 -1
  188. data/lib/wx/doc/gen/list_event.rb +1 -1
  189. data/lib/wx/doc/gen/listbook.rb +1 -1
  190. data/lib/wx/doc/gen/locale.rb +1 -1
  191. data/lib/wx/doc/gen/log.rb +1 -1
  192. data/lib/wx/doc/gen/mdi_client_window.rb +1 -1
  193. data/lib/wx/doc/gen/mdi_frame.rb +1 -1
  194. data/lib/wx/doc/gen/media_ctrl.rb +1 -1
  195. data/lib/wx/doc/gen/media_event.rb +1 -1
  196. data/lib/wx/doc/gen/memory_dc.rb +1 -1
  197. data/lib/wx/doc/gen/menu.rb +1 -1
  198. data/lib/wx/doc/gen/menu_bar.rb +1 -1
  199. data/lib/wx/doc/gen/menu_item.rb +1 -1
  200. data/lib/wx/doc/gen/message_dialog.rb +1 -1
  201. data/lib/wx/doc/gen/mini_frame.rb +1 -1
  202. data/lib/wx/doc/gen/mirror_dc.rb +1 -1
  203. data/lib/wx/doc/gen/mouse_state.rb +1 -1
  204. data/lib/wx/doc/gen/multi_choice_dialog.rb +1 -1
  205. data/lib/wx/doc/gen/non_owned_window.rb +1 -1
  206. data/lib/wx/doc/gen/notebook.rb +1 -1
  207. data/lib/wx/doc/gen/num_validator.rb +1 -1
  208. data/lib/wx/doc/gen/number_entry_dialog.rb +1 -1
  209. data/lib/wx/doc/gen/object.rb +1 -1
  210. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +1 -1
  211. data/lib/wx/doc/gen/paint_dc.rb +1 -1
  212. data/lib/wx/doc/gen/palette.rb +1 -1
  213. data/lib/wx/doc/gen/panel.rb +1 -1
  214. data/lib/wx/doc/gen/pen.rb +1 -1
  215. data/lib/wx/doc/gen/persistence_manager.rb +1 -1
  216. data/lib/wx/doc/gen/persistent_object.rb +1 -1
  217. data/lib/wx/doc/gen/persistent_window.rb +1 -1
  218. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +33 -29
  219. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +299 -295
  220. data/lib/wx/doc/gen/pg/pg_cell.rb +162 -158
  221. data/lib/wx/doc/gen/pg/pg_editor.rb +693 -689
  222. data/lib/wx/doc/gen/pg/pg_multi_button.rb +133 -129
  223. data/lib/wx/doc/gen/pg/pg_properties.rb +2662 -2658
  224. data/lib/wx/doc/gen/pg/pg_property.rb +1929 -1925
  225. data/lib/wx/doc/gen/pg/pg_validation_info.rb +275 -271
  226. data/lib/wx/doc/gen/pg/property_grid.rb +708 -704
  227. data/lib/wx/doc/gen/pg/property_grid_event.rb +168 -164
  228. data/lib/wx/doc/gen/pg/property_grid_interface.rb +1071 -1067
  229. data/lib/wx/doc/gen/pg/property_grid_manager.rb +386 -382
  230. data/lib/wx/doc/gen/pg/property_grid_page.rb +267 -263
  231. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +147 -143
  232. data/lib/wx/doc/gen/picker_base.rb +1 -1
  233. data/lib/wx/doc/gen/platform_info.rb +1 -1
  234. data/lib/wx/doc/gen/popup_window.rb +1 -1
  235. data/lib/wx/doc/gen/progress_dialog.rb +1 -1
  236. data/lib/wx/doc/gen/property_sheet_dialog.rb +1 -1
  237. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +32 -28
  238. data/lib/wx/doc/gen/prt/post_script_dc.rb +21 -17
  239. data/lib/wx/doc/gen/prt/preview_frame.rb +49 -45
  240. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +126 -122
  241. data/lib/wx/doc/gen/prt/print_data.rb +637 -633
  242. data/lib/wx/doc/gen/prt/print_dialog.rb +43 -39
  243. data/lib/wx/doc/gen/prt/printer.rb +484 -480
  244. data/lib/wx/doc/gen/prt/printer_dc.rb +26 -22
  245. data/lib/wx/doc/gen/query_layout_info_event.rb +1 -1
  246. data/lib/wx/doc/gen/radio_box.rb +1 -1
  247. data/lib/wx/doc/gen/radio_button.rb +1 -1
  248. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +1716 -1712
  249. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +239 -235
  250. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +34 -30
  251. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +439 -435
  252. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +52 -48
  253. data/lib/wx/doc/gen/rbn/ribbon_control.rb +116 -112
  254. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +205 -201
  255. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +44 -40
  256. data/lib/wx/doc/gen/rbn/ribbon_page.rb +129 -125
  257. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +229 -225
  258. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +34 -30
  259. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +329 -325
  260. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +31 -27
  261. data/lib/wx/doc/gen/rearrange_ctrl.rb +1 -1
  262. data/lib/wx/doc/gen/rearrange_list.rb +1 -1
  263. data/lib/wx/doc/gen/region.rb +1 -1
  264. data/lib/wx/doc/gen/region_iterator.rb +1 -1
  265. data/lib/wx/doc/gen/rtc/rich_text_box.rb +424 -420
  266. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +1148 -1144
  267. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +30 -26
  268. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +516 -512
  269. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +1991 -1987
  270. data/lib/wx/doc/gen/rtc/rich_text_event.rb +159 -155
  271. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +167 -163
  272. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +271 -267
  273. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +171 -167
  274. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +88 -84
  275. data/lib/wx/doc/gen/rtc/rich_text_image.rb +323 -319
  276. data/lib/wx/doc/gen/rtc/rich_text_object.rb +2819 -2815
  277. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +1187 -1183
  278. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +242 -238
  279. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +286 -282
  280. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +181 -177
  281. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +47 -43
  282. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +145 -141
  283. data/lib/wx/doc/gen/sash_event.rb +1 -1
  284. data/lib/wx/doc/gen/sash_layout_window.rb +1 -1
  285. data/lib/wx/doc/gen/sash_window.rb +1 -1
  286. data/lib/wx/doc/gen/scaled_dc.rb +1 -1
  287. data/lib/wx/doc/gen/screen_dc.rb +1 -1
  288. data/lib/wx/doc/gen/scroll_bar.rb +1 -1
  289. data/lib/wx/doc/gen/scrolled_canvas.rb +1 -1
  290. data/lib/wx/doc/gen/scrolled_control.rb +1 -1
  291. data/lib/wx/doc/gen/scrolled_window.rb +1 -1
  292. data/lib/wx/doc/gen/search_ctrl.rb +1 -1
  293. data/lib/wx/doc/gen/simplebook.rb +1 -1
  294. data/lib/wx/doc/gen/single_choice_dialog.rb +1 -1
  295. data/lib/wx/doc/gen/sizer.rb +1 -1
  296. data/lib/wx/doc/gen/sizer_item.rb +1 -1
  297. data/lib/wx/doc/gen/slider.rb +1 -1
  298. data/lib/wx/doc/gen/spin_button.rb +1 -1
  299. data/lib/wx/doc/gen/spin_ctrl.rb +1 -1
  300. data/lib/wx/doc/gen/spin_ctrl_double.rb +1 -1
  301. data/lib/wx/doc/gen/spin_double_event.rb +1 -1
  302. data/lib/wx/doc/gen/spin_event.rb +1 -1
  303. data/lib/wx/doc/gen/splash_screen.rb +1 -1
  304. data/lib/wx/doc/gen/splitter_event.rb +1 -1
  305. data/lib/wx/doc/gen/splitter_window.rb +1 -1
  306. data/lib/wx/doc/gen/static_bitmap.rb +1 -1
  307. data/lib/wx/doc/gen/static_box.rb +1 -1
  308. data/lib/wx/doc/gen/static_box_sizer.rb +1 -1
  309. data/lib/wx/doc/gen/static_line.rb +1 -1
  310. data/lib/wx/doc/gen/static_text.rb +1 -1
  311. data/lib/wx/doc/gen/status_bar.rb +1 -1
  312. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +4202 -4198
  313. data/lib/wx/doc/gen/stc/styled_text_event.rb +7511 -7507
  314. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +1 -1
  315. data/lib/wx/doc/gen/svg_file_dc.rb +1 -1
  316. data/lib/wx/doc/gen/system_options.rb +1 -1
  317. data/lib/wx/doc/gen/system_settings.rb +1 -1
  318. data/lib/wx/doc/gen/task_bar_button.rb +1 -1
  319. data/lib/wx/doc/gen/task_bar_icon.rb +1 -1
  320. data/lib/wx/doc/gen/task_bar_icon_event.rb +1 -1
  321. data/lib/wx/doc/gen/text_attr.rb +1 -1
  322. data/lib/wx/doc/gen/text_ctrl.rb +1 -1
  323. data/lib/wx/doc/gen/text_entry.rb +1 -1
  324. data/lib/wx/doc/gen/text_entry_dialog.rb +1 -1
  325. data/lib/wx/doc/gen/text_validator.rb +1 -1
  326. data/lib/wx/doc/gen/time_picker_ctrl.rb +1 -1
  327. data/lib/wx/doc/gen/timer.rb +1 -1
  328. data/lib/wx/doc/gen/timer_event.rb +1 -1
  329. data/lib/wx/doc/gen/tip_provider.rb +1 -1
  330. data/lib/wx/doc/gen/toggle_button.rb +1 -1
  331. data/lib/wx/doc/gen/tool_bar.rb +1 -1
  332. data/lib/wx/doc/gen/tool_tip.rb +1 -1
  333. data/lib/wx/doc/gen/toolbook.rb +1 -1
  334. data/lib/wx/doc/gen/top_level_window.rb +1 -1
  335. data/lib/wx/doc/gen/tree_ctrl.rb +1 -1
  336. data/lib/wx/doc/gen/tree_event.rb +1 -1
  337. data/lib/wx/doc/gen/treebook.rb +1 -1
  338. data/lib/wx/doc/gen/ui_action_simulator.rb +1 -1
  339. data/lib/wx/doc/gen/utils.rb +1 -1
  340. data/lib/wx/doc/gen/v_list_box.rb +1 -1
  341. data/lib/wx/doc/gen/v_scrolled_window.rb +1 -1
  342. data/lib/wx/doc/gen/validator.rb +1 -1
  343. data/lib/wx/doc/gen/variant.rb +1 -1
  344. data/lib/wx/doc/gen/window.rb +1 -1
  345. data/lib/wx/doc/gen/window_dc.rb +1 -1
  346. data/lib/wx/doc/gen/window_disabler.rb +1 -1
  347. data/lib/wx/doc/gen/with_images.rb +1 -1
  348. data/lib/wx/doc/gen/wizard.rb +1 -1
  349. data/lib/wx/doc/gen/wizard_event.rb +1 -1
  350. data/lib/wx/doc/gen/wizard_page.rb +1 -1
  351. data/lib/wx/doc/gen/wizard_page_simple.rb +1 -1
  352. data/lib/wx/doc/gen/wrap_sizer.rb +1 -1
  353. data/lib/wx/doc/gen/xml_node.rb +1 -1
  354. data/lib/wx/doc/gen/xml_resource.rb +1 -1
  355. data/lib/wx/rtc/ext/rich_text_ctrl.rb +5 -5
  356. data/lib/wx/version.rb +1 -1
  357. data/lib/wx/wxruby/base.rb +6 -4
  358. data/lib/wx/wxruby/cmd/sampler.rb +39 -29
  359. data/lib/wx/wxruby/cmd/setup.rb +122 -0
  360. data/lib/wx/wxruby/cmd/test.rb +56 -6
  361. data/lib/wxruby_aui.so +0 -0
  362. data/lib/wxruby_core.so +0 -0
  363. data/lib/wxruby_grid.so +0 -0
  364. data/lib/wxruby_html.so +0 -0
  365. data/lib/wxruby_pg.so +0 -0
  366. data/lib/wxruby_prt.so +0 -0
  367. data/lib/wxruby_rbn.so +0 -0
  368. data/lib/wxruby_rtc.so +0 -0
  369. data/lib/wxruby_stc.so +0 -0
  370. data/rakelib/install.rb +2 -0
  371. data/rakelib/lib/config/linux.rb +24 -2
  372. data/rakelib/lib/config/macosx.rb +16 -0
  373. data/rakelib/lib/config/mingw.rb +133 -9
  374. data/rakelib/lib/config/pkgman/arch.rb +53 -0
  375. data/rakelib/lib/config/pkgman/base.rb +169 -0
  376. data/rakelib/lib/config/pkgman/debian.rb +66 -0
  377. data/rakelib/lib/config/pkgman/macosx.rb +183 -0
  378. data/rakelib/lib/config/pkgman/rhel.rb +54 -0
  379. data/rakelib/lib/config/pkgman/suse.rb +54 -0
  380. data/rakelib/lib/config/unixish.rb +36 -19
  381. data/rakelib/lib/config.rb +254 -61
  382. data/rakelib/prepost.rake +9 -4
  383. data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css +14 -0
  384. data/rakelib/yard/templates/default/fulldoc/html/setup.rb +5 -5
  385. data/rakelib/yard/yard/relative_markdown_links.rb +7 -1
  386. metadata +23 -4
@@ -6,491 +6,495 @@
6
6
 
7
7
  module Wx::PRT
8
8
 
9
- # This class represents the Windows or PostScript printer, and is the vehicle through which printing may be launched by an application.
10
- #
11
- # Printing can also be achieved through using of lower functions and classes, but this and associated classes provide a more convenient and general method of printing.
12
- #
13
- # Category: Printing Framework
14
- # @see Printing Framework Overview
15
- # @see Wx::PRT::PrinterDC
16
- # @see Wx::PRT::PrintDialog
17
- # @see Wx::PRT::Printout
18
- # @see Wx::PRT::PrintPreview
19
- #
20
- #
21
- # @wxrb_require USE_PRINTING_ARCHITECTURE
22
- class Printer < Object
23
-
24
- # Constructor.
25
- #
26
- # Pass an optional pointer to a block of print dialog data, which will be copied to the printer object's local data.
27
- # @see Wx::PRT::PrintDialogData
28
- # @see Wx::PRT::PrintData
29
- # @param data [Wx::PRT::PrintDialogData]
30
- # @return [Wx::PRT::Printer]
31
- def initialize(data=nil) end
32
-
33
- # Creates the default printing abort window, with a cancel button.
34
- # @param parent [Wx::Window]
35
- # @param printout [Wx::PRT::Printout]
36
- # @return [Wx::PRT::PrintAbortDialog]
37
- def create_abort_window(parent, printout) end
38
-
39
- # Returns true if the user has aborted the print job.
40
- # @return [Boolean]
41
- def get_abort; end
42
- alias_method :abort, :get_abort
43
-
44
- # Starts the printing process.
45
- #
46
- # Provide a parent window, a user-defined {Wx::PRT::Printout} object which controls the printing of a document, and whether the print dialog should be invoked first.
47
- # {Wx::PRT::Printer#print} could return false if there was a problem initializing the printer device context (current printer not set, for example) or the user cancelled printing. Call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
48
- # @param parent [Wx::Window]
49
- # @param printout [Wx::PRT::Printout]
50
- # @param prompt [Boolean]
51
- # @return [Boolean]
52
- def print(parent, printout, prompt=true) end
53
-
54
- # Invokes the print dialog.
55
- #
56
- # If successful (the user did not press Cancel and no error occurred), a suitable device context will be returned; otherwise NULL is returned; call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
57
- #
58
- # <div class="wxrb-remark">
59
- # <b>Remark:</b>
60
- # <p>The application must delete this device context to avoid a memory leak.
61
- # </p>
62
- # </div>
63
- # @param parent [Wx::Window]
64
- # @return [Wx::DC]
65
- def print_dialog(parent) end
66
-
67
- # Default error-reporting function.
68
- # @param parent [Wx::Window]
69
- # @param printout [Wx::PRT::Printout]
70
- # @param message [String]
71
- # @return [void]
72
- def report_error(parent, printout, message) end
73
-
74
- # Return last error.
75
- #
76
- # Valid after calling {Wx::PRT::Printer#print}, {Wx::PRT::Printer#print_dialog} or {Wx::PRT::PrintPreview#print}.
77
- # These functions set last error to {Wx::PRT::PrinterError::PRINTER_NO_ERROR} if no error happened.
78
- # Returned value is one of the following:
79
- #
80
- # {Wx::PRT::PrinterError::PRINTER_NO_ERROR}
81
- # No error happened.
82
- #
83
- # {Wx::PRT::PrinterError::PRINTER_CANCELLED}
84
- # The user cancelled printing.
85
- #
86
- # {Wx::PRT::PrinterError::PRINTER_ERROR}
87
- # There was an error during printing.
88
- # @return [Wx::PrinterError]
89
- def self.get_last_error; end
90
-
91
- end # Printer
92
-
93
- # This class encapsulates the functionality of printing out an application document.
94
- #
95
- # A new class must be derived and members overridden to respond to calls such as {Wx::PRT::Printout#on_print_page} and {Wx::PRT::Printout#has_page} and to render the print image onto an associated {Wx::DC}. Instances of this class are passed to {Wx::PRT::Printer#print} or to a {Wx::PRT::PrintPreview} object to initiate printing or previewing.
96
- # Your derived {Wx::PRT::Printout} is responsible for drawing both the preview image and the printed page. If your windows' drawing routines accept an arbitrary DC as an argument, you can re-use those routines within your {Wx::PRT::Printout} subclass to draw the printout image. You may also add additional drawing elements within your {Wx::PRT::Printout} subclass, like headers, footers, and/or page numbers. However, the image on the printed page will often differ from the image drawn on the screen, as will the print preview image not just in the presence of headers and footers, but typically in scale. A high-resolution printer presents a much larger drawing surface (i.e., a higher-resolution DC); a zoomed-out preview image presents a much smaller drawing surface (lower-resolution DC). By using the routines FitThisSizeToXXX() and/or MapScreenSizeToXXX() within your {Wx::PRT::Printout} subclass to set the user scale and origin of the associated DC, you can easily use a single drawing routine to draw on your application's windows, to create the print preview image, and to create the printed paper image, and achieve a common appearance to the preview image and the printed page.
97
- #
98
- # Category: Printing Framework
99
- # @see Printing Framework Overview
100
- # @see Wx::PRT::PrinterDC
101
- # @see Wx::PRT::PrintDialog
102
- # @see Wx::PRT::PageSetupDialog
103
- # @see Wx::PRT::Printer
104
- # @see Wx::PRT::PrintPreview
105
- #
106
- #
107
- # @wxrb_require USE_PRINTING_ARCHITECTURE
108
- class Printout < Object
109
-
110
- # Constructor.
111
- #
112
- # Pass an optional title argument - the current filename would be a good idea. This will appear in the printing list (at least in MSW)
113
- # @param title [String]
114
- # @return [Wx::PRT::Printout]
115
- def initialize(title=("Wx::PRT::Printout")) end
116
-
117
- # Set the user scale and device origin of the {Wx::DC} associated with this {Wx::PRT::Printout} so that the given image size fits entirely within the page rectangle and the origin is at the top left corner of the page rectangle.
118
- #
119
- # On MSW and Mac, the page rectangle is the printable area of the page. On other platforms and PostScript printing, the page rectangle is the entire paper.
120
- # Use this if you want your printed image as large as possible, but with the caveat that on some platforms, portions of the image might be cut off at the edges.
121
- # @param imageSize [Array(Integer, Integer), Wx::Size]
122
- # @return [void]
123
- def fit_this_size_to_page(imageSize) end
124
-
125
- # Set the user scale and device origin of the {Wx::DC} associated with this {Wx::PRT::Printout} so that the given image size fits entirely within the page margins set in the given {Wx::PRT::PageSetupDialogData} object.
126
- #
127
- # This function provides the greatest consistency across all platforms because it does not depend on having access to the printable area of the paper.
128
- #
129
- # <div class="wxrb-remark">
130
- # <b>Remark:</b>
131
- # <p>On Mac, the native {Wx::PRT::PageSetupDialog} does not let you set the page margins; you'll have to provide your own mechanism, or you can use the Mac-only class WXOSX.
132
- # </p>
133
- # </div>
134
- # @param imageSize [Array(Integer, Integer), Wx::Size]
135
- # @param pageSetupData [Wx::PRT::PageSetupDialogData]
136
- # @return [void]
137
- def fit_this_size_to_page_margins(imageSize, pageSetupData) end
138
-
139
- # Set the user scale and device origin of the {Wx::DC} associated with this {Wx::PRT::Printout} so that the given image size fits entirely within the paper and the origin is at the top left corner of the paper.
140
- #
141
- # Use this if you're managing your own page margins.
142
- #
143
- # <div class="wxrb-note">
144
- # <b>Note:</b>
145
- # <p>With most printers, the region around the edges of the paper are not printable so that the edges of the image could be cut off.
146
- # </p>
147
- # </div>
148
- # @param imageSize [Array(Integer, Integer), Wx::Size]
149
- # @return [void]
150
- def fit_this_size_to_paper(imageSize) end
151
-
152
- # Returns the device context associated with the printout (given to the printout at start of printing or previewing).
153
- #
154
- # The application can use {Wx::PRT::Printout#get_dc} to obtain a device context to draw on.
155
- # This will be a {Wx::PRT::PrinterDC} if printing under Windows or Mac, a {Wx::PRT::PostScriptDC} if printing on other platforms, and a {Wx::MemoryDC} if previewing.
156
- # @return [Wx::DC]
157
- def get_dc; end
158
- alias_method :dc, :get_dc
159
-
160
- # Return the rectangle corresponding to the page margins specified by the given {Wx::PRT::PageSetupDialogData} object in the associated {Wx::DC}'s logical coordinates for the current user scale and device origin.
161
- #
162
- # The page margins are specified with respect to the edges of the paper on all platforms.
163
- # @param pageSetupData [Wx::PRT::PageSetupDialogData]
164
- # @return [Wx::Rect]
165
- def get_logical_page_margins_rect(pageSetupData) end
166
- alias_method :logical_page_margins_rect, :get_logical_page_margins_rect
167
-
168
- # Return the rectangle corresponding to the page in the associated {Wx::DC} 's logical coordinates for the current user scale and device origin.
169
- #
170
- # On MSW and Mac, this will be the printable area of the paper. On other platforms and PostScript printing, this will be the full paper rectangle.
171
- # @return [Wx::Rect]
172
- def get_logical_page_rect; end
173
- alias_method :logical_page_rect, :get_logical_page_rect
174
-
175
- # Return the rectangle corresponding to the paper in the associated {Wx::DC} 's logical coordinates for the current user scale and device origin.
176
- # @return [Wx::Rect]
177
- def get_logical_paper_rect; end
178
- alias_method :logical_paper_rect, :get_logical_paper_rect
179
-
180
- # Returns the number of pixels per logical inch of the printer device context.
181
- #
182
- # Dividing the printer PPI by the screen PPI can give a suitable scaling factor for drawing text onto the printer.
183
- # Remember to multiply this by a scaling factor to take the preview DC size into account. Or you can just use the FitThisSizeToXXX() and MapScreenSizeToXXX routines below, which do most of the scaling calculations for you.
184
- # @return [Array(Integer,Integer)]
185
- def get_ppi_printer; end
186
- alias_method :ppi_printer, :get_ppi_printer
187
-
188
- # Returns the number of pixels per logical inch of the screen device context.
189
- #
190
- # Dividing the printer PPI by the screen PPI can give a suitable scaling factor for drawing text onto the printer.
191
- # If you are doing your own scaling, remember to multiply this by a scaling factor to take the preview DC size into account.
192
- # @return [Array(Integer,Integer)]
193
- def get_ppi_screen; end
194
- alias_method :ppi_screen, :get_ppi_screen
195
-
196
- # Called by the framework to obtain information from the application about minimum and maximum page values that the user can select, and the required page range to be printed.
197
- #
198
- # By default this returns (1, 32000) for the page minimum and maximum values, and (1, 1) for the required page range.
199
- # minPage must be greater than zero and maxPage must be greater than minPage.
200
- # @return [Array(Integer,Integer,Integer,Integer)]
201
- def get_page_info; end
202
- alias_method :page_info, :get_page_info
203
-
204
- # Returns the size of the printer page in millimetres.
205
- # @return [Array(Integer,Integer)]
206
- def get_page_size_mm; end
207
- alias_method :page_size_mm, :get_page_size_mm
208
-
209
- # Returns the size of the printer page in pixels, called the page rectangle.
210
- #
211
- # The page rectangle has a top left corner at (0,0) and a bottom right corner at (w,h). These values may not be the same as the values returned from {Wx::DC#get_size}; if the printout is being used for previewing, a memory device context is used, which uses a bitmap size reflecting the current preview zoom. The application must take this discrepancy into account if previewing is to be supported.
212
- # @return [Array(Integer,Integer)]
213
- def get_page_size_pixels; end
214
- alias_method :page_size_pixels, :get_page_size_pixels
215
-
216
- # Returns the rectangle that corresponds to the entire paper in pixels, called the paper rectangle.
217
- #
218
- # This distinction between paper rectangle and page rectangle reflects the fact that most printers cannot print all the way to the edge of the paper. The page rectangle is a rectangle whose top left corner is at (0,0) and whose width and height are given by {Wx::DC#get_page_size_pixels}.
219
- # On MSW and Mac, the page rectangle gives the printable area of the paper, while the paper rectangle represents the entire paper, including non-printable borders. Thus, the rectangle returned by {Wx::DC#get_paper_rect_pixels}.
220
- # On other platforms and for PostScript printing, the paper is treated as if its entire area were printable, so this function will return the same rectangle as the page rectangle.
221
- # @return [Wx::Rect]
222
- def get_paper_rect_pixels; end
223
- alias_method :paper_rect_pixels, :get_paper_rect_pixels
224
-
225
- # Returns the title of the printout.
226
- #
227
- # Todothe python note here was wrong
228
- # @return [String]
229
- def get_title; end
230
- alias_method :title, :get_title
231
-
232
- # Should be overridden to return true if the document has this page, or false if not.
233
- #
234
- # Returning false signifies the end of the document. By default, HasPage behaves as if the document has only one page.
235
- # @param pageNum [Integer]
236
- # @return [Boolean]
237
- def has_page(pageNum) end
238
- alias_method :has_page?, :has_page
239
-
240
- # Returns true if the printout is currently being used for previewing.
241
- #
242
- #
243
- # @see Wx::PRT::Printout#get_preview
244
- # @return [Boolean]
245
- def is_preview; end
246
- alias_method :preview?, :is_preview
247
-
248
- # Returns the associated preview object if any.
249
- #
250
- # If this printout object is used for previewing, returns the associated {Wx::PRT::PrintPreview}. Otherwise returns NULL.
251
- # The returned pointer is not owned by the printout and must not be deleted.
252
- # @see Wx::PRT::Printout#is_preview
253
- # @return [Wx::PRT::PrintPreview]
254
- def get_preview; end
255
- alias_method :preview, :get_preview
256
-
257
- # Set the user scale and device origin of the {Wx::DC} associated with this {Wx::PRT::Printout} so that one screen pixel maps to one device pixel on the DC.
258
- #
259
- # That is, the user scale is set to (1,1) and the device origin is set to (0,0).
260
- # Use this if you want to do your own scaling prior to calling {Wx::DC} drawing calls, for example, if your underlying model is floating-point and you want to achieve maximum drawing precision on high-resolution printers.
261
- # You can use the GetLogicalXXXRect() routines below to obtain the paper rectangle, page rectangle, or page margins rectangle to perform your own scaling.
9
+ module Wx::PRT
10
+
11
+ # This class represents the Windows or PostScript printer, and is the vehicle through which printing may be launched by an application.
12
+ #
13
+ # Printing can also be achieved through using of lower functions and classes, but this and associated classes provide a more convenient and general method of printing.
14
+ #
15
+ # Category: Printing Framework
16
+ # @see Printing Framework Overview
17
+ # @see Wx::PRT::PrinterDC
18
+ # @see Wx::PRT::PrintDialog
19
+ # @see Wx::PRT::Printout
20
+ # @see Wx::PRT::PrintPreview
21
+ #
22
+ #
23
+ # @wxrb_require USE_PRINTING_ARCHITECTURE
24
+ class Printer < Object
25
+
26
+ # Constructor.
27
+ #
28
+ # Pass an optional pointer to a block of print dialog data, which will be copied to the printer object's local data.
29
+ # @see Wx::PRT::PrintDialogData
30
+ # @see Wx::PRT::PrintData
31
+ # @param data [Wx::PRT::PrintDialogData]
32
+ # @return [Wx::PRT::Printer]
33
+ def initialize(data=nil) end
34
+
35
+ # Creates the default printing abort window, with a cancel button.
36
+ # @param parent [Wx::Window]
37
+ # @param printout [Wx::PRT::Printout]
38
+ # @return [Wx::PRT::PrintAbortDialog]
39
+ def create_abort_window(parent, printout) end
40
+
41
+ # Returns true if the user has aborted the print job.
42
+ # @return [Boolean]
43
+ def get_abort; end
44
+ alias_method :abort, :get_abort
45
+
46
+ # Starts the printing process.
47
+ #
48
+ # Provide a parent window, a user-defined {Wx::PRT::Printout} object which controls the printing of a document, and whether the print dialog should be invoked first.
49
+ # {Wx::PRT::Printer#print} could return false if there was a problem initializing the printer device context (current printer not set, for example) or the user cancelled printing. Call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
50
+ # @param parent [Wx::Window]
51
+ # @param printout [Wx::PRT::Printout]
52
+ # @param prompt [Boolean]
53
+ # @return [Boolean]
54
+ def print(parent, printout, prompt=true) end
55
+
56
+ # Invokes the print dialog.
57
+ #
58
+ # If successful (the user did not press Cancel and no error occurred), a suitable device context will be returned; otherwise NULL is returned; call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
59
+ #
60
+ # <div class="wxrb-remark">
61
+ # <b>Remark:</b>
62
+ # <p>The application must delete this device context to avoid a memory leak.
63
+ # </p>
64
+ # </div>
65
+ # @param parent [Wx::Window]
66
+ # @return [Wx::DC]
67
+ def print_dialog(parent) end
68
+
69
+ # Default error-reporting function.
70
+ # @param parent [Wx::Window]
71
+ # @param printout [Wx::PRT::Printout]
72
+ # @param message [String]
73
+ # @return [void]
74
+ def report_error(parent, printout, message) end
75
+
76
+ # Return last error.
77
+ #
78
+ # Valid after calling {Wx::PRT::Printer#print}, {Wx::PRT::Printer#print_dialog} or {Wx::PRT::PrintPreview#print}.
79
+ # These functions set last error to {Wx::PRT::PrinterError::PRINTER_NO_ERROR} if no error happened.
80
+ # Returned value is one of the following:
81
+ #
82
+ # {Wx::PRT::PrinterError::PRINTER_NO_ERROR}
83
+ # No error happened.
84
+ #
85
+ # {Wx::PRT::PrinterError::PRINTER_CANCELLED}
86
+ # The user cancelled printing.
87
+ #
88
+ # {Wx::PRT::PrinterError::PRINTER_ERROR}
89
+ # There was an error during printing.
90
+ # @return [Wx::PrinterError]
91
+ def self.get_last_error; end
92
+
93
+ end # Printer
94
+
95
+ # This class encapsulates the functionality of printing out an application document.
96
+ #
97
+ # A new class must be derived and members overridden to respond to calls such as {Wx::PRT::Printout#on_print_page} and {Wx::PRT::Printout#has_page} and to render the print image onto an associated {Wx::DC}. Instances of this class are passed to {Wx::PRT::Printer#print} or to a {Wx::PRT::PrintPreview} object to initiate printing or previewing.
98
+ # Your derived {Wx::PRT::Printout} is responsible for drawing both the preview image and the printed page. If your windows' drawing routines accept an arbitrary DC as an argument, you can re-use those routines within your {Wx::PRT::Printout} subclass to draw the printout image. You may also add additional drawing elements within your {Wx::PRT::Printout} subclass, like headers, footers, and/or page numbers. However, the image on the printed page will often differ from the image drawn on the screen, as will the print preview image not just in the presence of headers and footers, but typically in scale. A high-resolution printer presents a much larger drawing surface (i.e., a higher-resolution DC); a zoomed-out preview image presents a much smaller drawing surface (lower-resolution DC). By using the routines FitThisSizeToXXX() and/or MapScreenSizeToXXX() within your {Wx::PRT::Printout} subclass to set the user scale and origin of the associated DC, you can easily use a single drawing routine to draw on your application's windows, to create the print preview image, and to create the printed paper image, and achieve a common appearance to the preview image and the printed page.
99
+ #
100
+ # Category: Printing Framework
101
+ # @see Printing Framework Overview
102
+ # @see Wx::PRT::PrinterDC
103
+ # @see Wx::PRT::PrintDialog
104
+ # @see Wx::PRT::PageSetupDialog
105
+ # @see Wx::PRT::Printer
106
+ # @see Wx::PRT::PrintPreview
107
+ #
108
+ #
109
+ # @wxrb_require USE_PRINTING_ARCHITECTURE
110
+ class Printout < Object
111
+
112
+ # Constructor.
113
+ #
114
+ # Pass an optional title argument - the current filename would be a good idea. This will appear in the printing list (at least in MSW)
115
+ # @param title [String]
116
+ # @return [Wx::PRT::Printout]
117
+ def initialize(title=("Wx::PRT::Printout")) end
118
+
119
+ # Set the user scale and device origin of the {Wx::DC} associated with this {Wx::PRT::Printout} so that the given image size fits entirely within the page rectangle and the origin is at the top left corner of the page rectangle.
120
+ #
121
+ # On MSW and Mac, the page rectangle is the printable area of the page. On other platforms and PostScript printing, the page rectangle is the entire paper.
122
+ # Use this if you want your printed image as large as possible, but with the caveat that on some platforms, portions of the image might be cut off at the edges.
123
+ # @param imageSize [Array(Integer, Integer), Wx::Size]
124
+ # @return [void]
125
+ def fit_this_size_to_page(imageSize) end
126
+
127
+ # Set the user scale and device origin of the {Wx::DC} associated with this {Wx::PRT::Printout} so that the given image size fits entirely within the page margins set in the given {Wx::PRT::PageSetupDialogData} object.
128
+ #
129
+ # This function provides the greatest consistency across all platforms because it does not depend on having access to the printable area of the paper.
130
+ #
131
+ # <div class="wxrb-remark">
132
+ # <b>Remark:</b>
133
+ # <p>On Mac, the native {Wx::PRT::PageSetupDialog} does not let you set the page margins; you'll have to provide your own mechanism, or you can use the Mac-only class WXOSX.
134
+ # </p>
135
+ # </div>
136
+ # @param imageSize [Array(Integer, Integer), Wx::Size]
137
+ # @param pageSetupData [Wx::PRT::PageSetupDialogData]
138
+ # @return [void]
139
+ def fit_this_size_to_page_margins(imageSize, pageSetupData) end
140
+
141
+ # Set the user scale and device origin of the {Wx::DC} associated with this {Wx::PRT::Printout} so that the given image size fits entirely within the paper and the origin is at the top left corner of the paper.
142
+ #
143
+ # Use this if you're managing your own page margins.
144
+ #
145
+ # <div class="wxrb-note">
146
+ # <b>Note:</b>
147
+ # <p>With most printers, the region around the edges of the paper are not printable so that the edges of the image could be cut off.
148
+ # </p>
149
+ # </div>
150
+ # @param imageSize [Array(Integer, Integer), Wx::Size]
151
+ # @return [void]
152
+ def fit_this_size_to_paper(imageSize) end
153
+
154
+ # Returns the device context associated with the printout (given to the printout at start of printing or previewing).
155
+ #
156
+ # The application can use {Wx::PRT::Printout#get_dc} to obtain a device context to draw on.
157
+ # This will be a {Wx::PRT::PrinterDC} if printing under Windows or Mac, a {Wx::PRT::PostScriptDC} if printing on other platforms, and a {Wx::MemoryDC} if previewing.
158
+ # @return [Wx::DC]
159
+ def get_dc; end
160
+ alias_method :dc, :get_dc
161
+
162
+ # Return the rectangle corresponding to the page margins specified by the given {Wx::PRT::PageSetupDialogData} object in the associated {Wx::DC}'s logical coordinates for the current user scale and device origin.
163
+ #
164
+ # The page margins are specified with respect to the edges of the paper on all platforms.
165
+ # @param pageSetupData [Wx::PRT::PageSetupDialogData]
166
+ # @return [Wx::Rect]
167
+ def get_logical_page_margins_rect(pageSetupData) end
168
+ alias_method :logical_page_margins_rect, :get_logical_page_margins_rect
169
+
170
+ # Return the rectangle corresponding to the page in the associated {Wx::DC} 's logical coordinates for the current user scale and device origin.
171
+ #
172
+ # On MSW and Mac, this will be the printable area of the paper. On other platforms and PostScript printing, this will be the full paper rectangle.
173
+ # @return [Wx::Rect]
174
+ def get_logical_page_rect; end
175
+ alias_method :logical_page_rect, :get_logical_page_rect
176
+
177
+ # Return the rectangle corresponding to the paper in the associated {Wx::DC} 's logical coordinates for the current user scale and device origin.
178
+ # @return [Wx::Rect]
179
+ def get_logical_paper_rect; end
180
+ alias_method :logical_paper_rect, :get_logical_paper_rect
181
+
182
+ # Returns the number of pixels per logical inch of the printer device context.
183
+ #
184
+ # Dividing the printer PPI by the screen PPI can give a suitable scaling factor for drawing text onto the printer.
185
+ # Remember to multiply this by a scaling factor to take the preview DC size into account. Or you can just use the FitThisSizeToXXX() and MapScreenSizeToXXX routines below, which do most of the scaling calculations for you.
186
+ # @return [Array(Integer,Integer)]
187
+ def get_ppi_printer; end
188
+ alias_method :ppi_printer, :get_ppi_printer
189
+
190
+ # Returns the number of pixels per logical inch of the screen device context.
191
+ #
192
+ # Dividing the printer PPI by the screen PPI can give a suitable scaling factor for drawing text onto the printer.
193
+ # If you are doing your own scaling, remember to multiply this by a scaling factor to take the preview DC size into account.
194
+ # @return [Array(Integer,Integer)]
195
+ def get_ppi_screen; end
196
+ alias_method :ppi_screen, :get_ppi_screen
197
+
198
+ # Called by the framework to obtain information from the application about minimum and maximum page values that the user can select, and the required page range to be printed.
199
+ #
200
+ # By default this returns (1, 32000) for the page minimum and maximum values, and (1, 1) for the required page range.
201
+ # minPage must be greater than zero and maxPage must be greater than minPage.
202
+ # @return [Array(Integer,Integer,Integer,Integer)]
203
+ def get_page_info; end
204
+ alias_method :page_info, :get_page_info
205
+
206
+ # Returns the size of the printer page in millimetres.
207
+ # @return [Array(Integer,Integer)]
208
+ def get_page_size_mm; end
209
+ alias_method :page_size_mm, :get_page_size_mm
210
+
211
+ # Returns the size of the printer page in pixels, called the page rectangle.
212
+ #
213
+ # The page rectangle has a top left corner at (0,0) and a bottom right corner at (w,h). These values may not be the same as the values returned from {Wx::DC#get_size}; if the printout is being used for previewing, a memory device context is used, which uses a bitmap size reflecting the current preview zoom. The application must take this discrepancy into account if previewing is to be supported.
214
+ # @return [Array(Integer,Integer)]
215
+ def get_page_size_pixels; end
216
+ alias_method :page_size_pixels, :get_page_size_pixels
217
+
218
+ # Returns the rectangle that corresponds to the entire paper in pixels, called the paper rectangle.
219
+ #
220
+ # This distinction between paper rectangle and page rectangle reflects the fact that most printers cannot print all the way to the edge of the paper. The page rectangle is a rectangle whose top left corner is at (0,0) and whose width and height are given by {Wx::DC#get_page_size_pixels}.
221
+ # On MSW and Mac, the page rectangle gives the printable area of the paper, while the paper rectangle represents the entire paper, including non-printable borders. Thus, the rectangle returned by {Wx::DC#get_paper_rect_pixels}.
222
+ # On other platforms and for PostScript printing, the paper is treated as if its entire area were printable, so this function will return the same rectangle as the page rectangle.
223
+ # @return [Wx::Rect]
224
+ def get_paper_rect_pixels; end
225
+ alias_method :paper_rect_pixels, :get_paper_rect_pixels
226
+
227
+ # Returns the title of the printout.
228
+ #
229
+ # Todothe python note here was wrong
230
+ # @return [String]
231
+ def get_title; end
232
+ alias_method :title, :get_title
233
+
234
+ # Should be overridden to return true if the document has this page, or false if not.
235
+ #
236
+ # Returning false signifies the end of the document. By default, HasPage behaves as if the document has only one page.
237
+ # @param pageNum [Integer]
238
+ # @return [Boolean]
239
+ def has_page(pageNum) end
240
+ alias_method :has_page?, :has_page
241
+
242
+ # Returns true if the printout is currently being used for previewing.
243
+ #
244
+ #
245
+ # @see Wx::PRT::Printout#get_preview
246
+ # @return [Boolean]
247
+ def is_preview; end
248
+ alias_method :preview?, :is_preview
249
+
250
+ # Returns the associated preview object if any.
251
+ #
252
+ # If this printout object is used for previewing, returns the associated {Wx::PRT::PrintPreview}. Otherwise returns NULL.
253
+ # The returned pointer is not owned by the printout and must not be deleted.
254
+ # @see Wx::PRT::Printout#is_preview
255
+ # @return [Wx::PRT::PrintPreview]
256
+ def get_preview; end
257
+ alias_method :preview, :get_preview
258
+
259
+ # Set the user scale and device origin of the {Wx::DC} associated with this {Wx::PRT::Printout} so that one screen pixel maps to one device pixel on the DC.
260
+ #
261
+ # That is, the user scale is set to (1,1) and the device origin is set to (0,0).
262
+ # Use this if you want to do your own scaling prior to calling {Wx::DC} drawing calls, for example, if your underlying model is floating-point and you want to achieve maximum drawing precision on high-resolution printers.
263
+ # You can use the GetLogicalXXXRect() routines below to obtain the paper rectangle, page rectangle, or page margins rectangle to perform your own scaling.
264
+ #
265
+ # <div class="wxrb-note">
266
+ # <b>Note:</b>
267
+ # <p>While the underlying drawing model of macOS is floating-point, wxWidgets's drawing model scales from integer coordinates.
268
+ # </p>
269
+ # </div>
270
+ # @return [void]
271
+ def map_screen_size_to_device; end
272
+
273
+ # This sets the user scale of the {Wx::DC} associated with this {Wx::PRT::Printout} to the same scale as {Wx::PRT::Printout#map_screen_size_to_paper} but sets the logical origin to the top left corner of the page rectangle.
274
+ # @return [void]
275
+ def map_screen_size_to_page; end
276
+
277
+ # This sets the user scale of the {Wx::DC} associated with this {Wx::PRT::Printout} to the same scale as {Wx::PRT::Printout#map_screen_size_to_page_margins} but sets the logical origin to the top left corner of the page margins specified by the given {Wx::PRT::PageSetupDialogData} object.
278
+ # @param pageSetupData [Wx::PRT::PageSetupDialogData]
279
+ # @return [void]
280
+ def map_screen_size_to_page_margins(pageSetupData) end
281
+
282
+ # Set the user scale and device origin of the {Wx::DC} associated with this {Wx::PRT::Printout} so that the printed page matches the screen size as closely as possible and the logical origin is in the top left corner of the paper rectangle.
283
+ #
284
+ # That is, a 100-pixel object on screen should appear at the same size on the printed page. (It will, of course, be larger or smaller in the preview image, depending on the zoom factor.)
285
+ # Use this if you want WYSIWYG behaviour, e.g., in a text editor.
286
+ # @return [void]
287
+ def map_screen_size_to_paper; end
288
+
289
+ # Shift the device origin by an amount specified in logical coordinates.
290
+ # @param xoff [Integer]
291
+ # @param yoff [Integer]
292
+ # @return [void]
293
+ def offset_logical_origin(xoff, yoff) end
294
+
295
+ # Called by the framework at the start of document printing.
296
+ #
297
+ # Return false from this function cancels the print job.
298
+ # {Wx::PRT::Printout#on_begin_document} is called once for every copy printed.
299
+ #
300
+ # <div class="wxrb-remark">
301
+ # <b>Remark:</b>
302
+ # <p>The base {Wx::PRT::Printout#on_begin_document} must be called (and the return value checked) from within the overridden function, since it calls {Wx::DC#start_doc}.
303
+ # </p>
304
+ # </div>
305
+ # @param startPage [Integer]
306
+ # @param endPage [Integer]
307
+ # @return [Boolean]
308
+ def on_begin_document(startPage, endPage) end
309
+
310
+ # Called by the framework at the start of printing.
311
+ #
312
+ # {Wx::PRT::Printout#on_begin_printing} is called once for every print job (regardless of how many copies are being printed).
313
+ # @return [void]
314
+ def on_begin_printing; end
315
+
316
+ # Called by the framework at the end of document printing.
317
+ #
318
+ # {Wx::PRT::Printout#on_end_document} is called once for every copy printed.
319
+ #
320
+ # <div class="wxrb-remark">
321
+ # <b>Remark:</b>
322
+ # <p>The base {Wx::PRT::Printout#on_end_document} must be called from within the overridden function, since it calls {Wx::DC#end_doc}.
323
+ # </p>
324
+ # </div>
325
+ # @return [void]
326
+ def on_end_document; end
327
+
328
+ # Called by the framework at the end of printing.
329
+ #
330
+ # OnEndPrinting is called once for every print job (regardless of how many copies are being printed).
331
+ # @return [void]
332
+ def on_end_printing; end
333
+
334
+ # Called once by the framework before any other demands are made of the {Wx::PRT::Printout} object.
335
+ #
336
+ # This gives the object an opportunity to calculate the number of pages in the document, for example.
337
+ # @return [void]
338
+ def on_prepare_printing; end
339
+
340
+ # Called by the framework when a page should be printed.
341
+ #
342
+ # Returning false cancels the print job.
343
+ # @param pageNum [Integer]
344
+ # @return [Boolean]
345
+ def on_print_page(pageNum) end
346
+
347
+ # Set the device origin of the associated {Wx::DC} so that the current logical point becomes the new logical origin.
348
+ # @param x [Integer]
349
+ # @param y [Integer]
350
+ # @return [void]
351
+ def set_logical_origin(x, y) end
352
+
353
+ end # Printout
354
+
355
+ # Objects of this class manage the print preview process.
356
+ #
357
+ # The object is passed a {Wx::PRT::Printout} object, and the {Wx::PRT::PrintPreview} object itself is passed to a {Wx::PRT::PreviewFrame} object. Previewing is started by initializing and showing the preview frame. Unlike {Wx::PRT::Printer#print}, flow of control returns to the application immediately after the frame is shown.
262
358
  #
263
359
  # <div class="wxrb-note">
264
360
  # <b>Note:</b>
265
- # <p>While the underlying drawing model of macOS is floating-point, wxWidgets's drawing model scales from integer coordinates.
361
+ # <p>The preview shown is only exact on Windows. On other platforms, the {Wx::DC} used for preview is different from what is used for printing and the results may be significantly different, depending on how is the output created. In particular, printing code relying on {Wx::DC#get_text_extent} heavily (for example, {Wx::HTML::HtmlEasyPrinting} and other {Wx::HTML} classes do) is affected. It is recommended to use native preview functionality on platforms that offer it (macOS, GTK+).
266
362
  # </p>
267
363
  # </div>
268
- # @return [void]
269
- def map_screen_size_to_device; end
270
-
271
- # This sets the user scale of the {Wx::DC} associated with this {Wx::PRT::Printout} to the same scale as {Wx::PRT::Printout#map_screen_size_to_paper} but sets the logical origin to the top left corner of the page rectangle.
272
- # @return [void]
273
- def map_screen_size_to_page; end
274
-
275
- # This sets the user scale of the {Wx::DC} associated with this {Wx::PRT::Printout} to the same scale as {Wx::PRT::Printout#map_screen_size_to_page_margins} but sets the logical origin to the top left corner of the page margins specified by the given {Wx::PRT::PageSetupDialogData} object.
276
- # @param pageSetupData [Wx::PRT::PageSetupDialogData]
277
- # @return [void]
278
- def map_screen_size_to_page_margins(pageSetupData) end
279
-
280
- # Set the user scale and device origin of the {Wx::DC} associated with this {Wx::PRT::Printout} so that the printed page matches the screen size as closely as possible and the logical origin is in the top left corner of the paper rectangle.
281
- #
282
- # That is, a 100-pixel object on screen should appear at the same size on the printed page. (It will, of course, be larger or smaller in the preview image, depending on the zoom factor.)
283
- # Use this if you want WYSIWYG behaviour, e.g., in a text editor.
284
- # @return [void]
285
- def map_screen_size_to_paper; end
286
-
287
- # Shift the device origin by an amount specified in logical coordinates.
288
- # @param xoff [Integer]
289
- # @param yoff [Integer]
290
- # @return [void]
291
- def offset_logical_origin(xoff, yoff) end
292
-
293
- # Called by the framework at the start of document printing.
294
- #
295
- # Return false from this function cancels the print job.
296
- # {Wx::PRT::Printout#on_begin_document} is called once for every copy printed.
297
- #
298
- # <div class="wxrb-remark">
299
- # <b>Remark:</b>
300
- # <p>The base {Wx::PRT::Printout#on_begin_document} must be called (and the return value checked) from within the overridden function, since it calls {Wx::DC#start_doc}.
301
- # </p>
302
- # </div>
303
- # @param startPage [Integer]
304
- # @param endPage [Integer]
305
- # @return [Boolean]
306
- def on_begin_document(startPage, endPage) end
307
-
308
- # Called by the framework at the start of printing.
309
- #
310
- # {Wx::PRT::Printout#on_begin_printing} is called once for every print job (regardless of how many copies are being printed).
311
- # @return [void]
312
- def on_begin_printing; end
313
-
314
- # Called by the framework at the end of document printing.
315
- #
316
- # {Wx::PRT::Printout#on_end_document} is called once for every copy printed.
317
- #
318
- # <div class="wxrb-remark">
319
- # <b>Remark:</b>
320
- # <p>The base {Wx::PRT::Printout#on_end_document} must be called from within the overridden function, since it calls {Wx::DC#end_doc}.
321
- # </p>
322
- # </div>
323
- # @return [void]
324
- def on_end_document; end
325
-
326
- # Called by the framework at the end of printing.
327
- #
328
- # OnEndPrinting is called once for every print job (regardless of how many copies are being printed).
329
- # @return [void]
330
- def on_end_printing; end
331
-
332
- # Called once by the framework before any other demands are made of the {Wx::PRT::Printout} object.
333
364
  #
334
- # This gives the object an opportunity to calculate the number of pages in the document, for example.
335
- # @return [void]
336
- def on_prepare_printing; end
365
+ # Category: Printing Framework
366
+ # @see Printing Framework Overview
367
+ # @see Wx::PRT::PrinterDC
368
+ # @see Wx::PRT::PrintDialog
369
+ # @see Wx::PRT::Printout
370
+ # @see Wx::PRT::Printer
371
+ # @see Wx::PreviewCanvas
372
+ # @see Wx::PreviewControlBar
373
+ # @see Wx::PRT::PreviewFrame
374
+ #
375
+ #
376
+ # @wxrb_require USE_PRINTING_ARCHITECTURE
377
+ class PrintPreview < Object
378
+
379
+ # @overload initialize(printout, printoutForPrinting=nil, data=nil)
380
+ # Constructor.
381
+ #
382
+ # Pass a printout object, an optional printout object to be used for actual printing, and the address of an optional block of printer data, which will be copied to the print preview object's print data.
383
+ # If printoutForPrinting is non-NULL, a <b>"Print..."</b> button will be placed on the preview frame so that the user can print directly from the preview interface.
384
+ #
385
+ # <div class="wxrb-remark">
386
+ # <b>Remark:</b>
387
+ # <p>Do not explicitly delete the printout objects once this constructor has been called, since they will be deleted in the {Wx::PRT::PrintPreview} destructor. The same does not apply to the data argument.
388
+ # </p>
389
+ # </div>
390
+ #
391
+ # Use {Wx::PRT::PrintPreview#is_ok} to check whether the {Wx::PRT::PrintPreview} object was created correctly.
392
+ # @param printout [Wx::PRT::Printout]
393
+ # @param printoutForPrinting [Wx::PRT::Printout]
394
+ # @param data [Wx::PRT::PrintDialogData]
395
+ # @return [Wx::PRT::PrintPreview]
396
+ # @overload initialize(printout, printoutForPrinting, data)
397
+ # @param printout [Wx::PRT::Printout]
398
+ # @param printoutForPrinting [Wx::PRT::Printout]
399
+ # @param data [Wx::PRT::PrintData]
400
+ # @return [Wx::PRT::PrintPreview]
401
+ def initialize(*args) end
402
+
403
+ # Gets the preview window used for displaying the print preview image.
404
+ # @return [wxScrolledWindow]
405
+ def get_canvas; end
406
+ alias_method :canvas, :get_canvas
407
+
408
+ # Gets the page currently being previewed.
409
+ # @return [Integer]
410
+ def get_current_page; end
411
+ alias_method :current_page, :get_current_page
412
+
413
+ # Gets the frame used for displaying the print preview canvas and control bar.
414
+ # @return [Wx::Frame]
415
+ def get_frame; end
416
+ alias_method :frame, :get_frame
417
+
418
+ # Returns the maximum page number.
419
+ # @return [Integer]
420
+ def get_max_page; end
421
+ alias_method :max_page, :get_max_page
422
+
423
+ # Returns the minimum page number.
424
+ # @return [Integer]
425
+ def get_min_page; end
426
+ alias_method :min_page, :get_min_page
427
+
428
+ # Gets the preview printout object associated with the {Wx::PRT::PrintPreview} object.
429
+ # @return [Wx::PRT::Printout]
430
+ def get_printout; end
431
+ alias_method :printout, :get_printout
432
+
433
+ # Gets the printout object to be used for printing from within the preview interface, or NULL if none exists.
434
+ # @return [Wx::PRT::Printout]
435
+ def get_printout_for_printing; end
436
+ alias_method :printout_for_printing, :get_printout_for_printing
437
+
438
+ # Gets the current percentage zoom level of the preview canvas.
439
+ #
440
+ #
441
+ # @see Wx::PRT::PrintPreview#set_zoom
442
+ # @return [Integer]
443
+ def get_zoom; end
444
+ alias_method :zoom, :get_zoom
445
+
446
+ # Returns true if the {Wx::PRT::PrintPreview} is valid, false otherwise.
447
+ #
448
+ # It could return false if there was a problem initializing the printer device context (current printer not set, for example).
449
+ # @return [Boolean]
450
+ def is_ok; end
451
+ alias_method :ok?, :is_ok
452
+
453
+ # Invokes the print process using the second {Wx::PRT::Printout} object supplied in the {Wx::PRT::PrintPreview} constructor.
454
+ #
455
+ # Will normally be called by the <b>Print</b>... panel item on the preview frame's control bar.
456
+ # Returns false in case of error call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
457
+ # @param prompt [Boolean]
458
+ # @return [Boolean]
459
+ def print(prompt) end
460
+
461
+ # Renders a page into a {Wx::MemoryDC}.
462
+ #
463
+ # Used internally by {Wx::PRT::PrintPreview}.
464
+ # @param pageNum [Integer]
465
+ # @return [Boolean]
466
+ def render_page(pageNum) end
467
+
468
+ # Sets the current page to be previewed.
469
+ # @param pageNum [Integer]
470
+ # @return [Boolean]
471
+ def set_current_page(pageNum) end
472
+ alias_method :current_page=, :set_current_page
473
+
474
+ # Sets the frame to be used for displaying the print preview canvas and control bar.
475
+ # @param frame [Wx::Frame]
476
+ # @return [void]
477
+ def set_frame(frame) end
478
+ alias_method :frame=, :set_frame
479
+
480
+ # Associates a printout object with the {Wx::PRT::PrintPreview} object.
481
+ # @param printout [Wx::PRT::Printout]
482
+ # @return [void]
483
+ def set_printout(printout) end
484
+ alias_method :printout=, :set_printout
485
+
486
+ # Sets the percentage preview zoom, and refreshes the preview canvas accordingly.
487
+ #
488
+ #
489
+ # @see Wx::PRT::PrintPreview#get_zoom
490
+ # @param percent [Integer]
491
+ # @return [void]
492
+ def set_zoom(percent) end
493
+ alias_method :zoom=, :set_zoom
494
+
495
+ end # PrintPreview
337
496
 
338
- # Called by the framework when a page should be printed.
339
- #
340
- # Returning false cancels the print job.
341
- # @param pageNum [Integer]
342
- # @return [Boolean]
343
- def on_print_page(pageNum) end
344
-
345
- # Set the device origin of the associated {Wx::DC} so that the current logical point becomes the new logical origin.
346
- # @param x [Integer]
347
- # @param y [Integer]
348
- # @return [void]
349
- def set_logical_origin(x, y) end
350
-
351
- end # Printout
352
-
353
- # Objects of this class manage the print preview process.
354
- #
355
- # The object is passed a {Wx::PRT::Printout} object, and the {Wx::PRT::PrintPreview} object itself is passed to a {Wx::PRT::PreviewFrame} object. Previewing is started by initializing and showing the preview frame. Unlike {Wx::PRT::Printer#print}, flow of control returns to the application immediately after the frame is shown.
356
- #
357
- # <div class="wxrb-note">
358
- # <b>Note:</b>
359
- # <p>The preview shown is only exact on Windows. On other platforms, the {Wx::DC} used for preview is different from what is used for printing and the results may be significantly different, depending on how is the output created. In particular, printing code relying on {Wx::DC#get_text_extent} heavily (for example, {Wx::HTML::HtmlEasyPrinting} and other {Wx::HTML} classes do) is affected. It is recommended to use native preview functionality on platforms that offer it (macOS, GTK+).
360
- # </p>
361
- # </div>
362
- #
363
- # Category: Printing Framework
364
- # @see Printing Framework Overview
365
- # @see Wx::PRT::PrinterDC
366
- # @see Wx::PRT::PrintDialog
367
- # @see Wx::PRT::Printout
368
- # @see Wx::PRT::Printer
369
- # @see Wx::PreviewCanvas
370
- # @see Wx::PreviewControlBar
371
- # @see Wx::PRT::PreviewFrame
372
- #
373
- #
374
- # @wxrb_require USE_PRINTING_ARCHITECTURE
375
- class PrintPreview < Object
376
-
377
- # @overload initialize(printout, printoutForPrinting=nil, data=nil)
378
- # Constructor.
379
- #
380
- # Pass a printout object, an optional printout object to be used for actual printing, and the address of an optional block of printer data, which will be copied to the print preview object's print data.
381
- # If printoutForPrinting is non-NULL, a <b>"Print..."</b> button will be placed on the preview frame so that the user can print directly from the preview interface.
382
- #
383
- # <div class="wxrb-remark">
384
- # <b>Remark:</b>
385
- # <p>Do not explicitly delete the printout objects once this constructor has been called, since they will be deleted in the {Wx::PRT::PrintPreview} destructor. The same does not apply to the data argument.
386
- # </p>
387
- # </div>
388
- #
389
- # Use {Wx::PRT::PrintPreview#is_ok} to check whether the {Wx::PRT::PrintPreview} object was created correctly.
390
- # @param printout [Wx::PRT::Printout]
391
- # @param printoutForPrinting [Wx::PRT::Printout]
392
- # @param data [Wx::PRT::PrintDialogData]
393
- # @return [Wx::PRT::PrintPreview]
394
- # @overload initialize(printout, printoutForPrinting, data)
395
- # @param printout [Wx::PRT::Printout]
396
- # @param printoutForPrinting [Wx::PRT::Printout]
397
- # @param data [Wx::PRT::PrintData]
398
- # @return [Wx::PRT::PrintPreview]
399
- def initialize(*args) end
400
-
401
- # Gets the preview window used for displaying the print preview image.
402
- # @return [wxScrolledWindow]
403
- def get_canvas; end
404
- alias_method :canvas, :get_canvas
405
-
406
- # Gets the page currently being previewed.
407
- # @return [Integer]
408
- def get_current_page; end
409
- alias_method :current_page, :get_current_page
410
-
411
- # Gets the frame used for displaying the print preview canvas and control bar.
412
- # @return [Wx::Frame]
413
- def get_frame; end
414
- alias_method :frame, :get_frame
415
-
416
- # Returns the maximum page number.
417
- # @return [Integer]
418
- def get_max_page; end
419
- alias_method :max_page, :get_max_page
420
-
421
- # Returns the minimum page number.
422
- # @return [Integer]
423
- def get_min_page; end
424
- alias_method :min_page, :get_min_page
425
-
426
- # Gets the preview printout object associated with the {Wx::PRT::PrintPreview} object.
427
- # @return [Wx::PRT::Printout]
428
- def get_printout; end
429
- alias_method :printout, :get_printout
430
-
431
- # Gets the printout object to be used for printing from within the preview interface, or NULL if none exists.
432
- # @return [Wx::PRT::Printout]
433
- def get_printout_for_printing; end
434
- alias_method :printout_for_printing, :get_printout_for_printing
435
-
436
- # Gets the current percentage zoom level of the preview canvas.
437
- #
438
- #
439
- # @see Wx::PRT::PrintPreview#set_zoom
440
- # @return [Integer]
441
- def get_zoom; end
442
- alias_method :zoom, :get_zoom
443
-
444
- # Returns true if the {Wx::PRT::PrintPreview} is valid, false otherwise.
445
- #
446
- # It could return false if there was a problem initializing the printer device context (current printer not set, for example).
447
- # @return [Boolean]
448
- def is_ok; end
449
- alias_method :ok?, :is_ok
450
-
451
- # Invokes the print process using the second {Wx::PRT::Printout} object supplied in the {Wx::PRT::PrintPreview} constructor.
452
- #
453
- # Will normally be called by the <b>Print</b>... panel item on the preview frame's control bar.
454
- # Returns false in case of error call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
455
- # @param prompt [Boolean]
456
- # @return [Boolean]
457
- def print(prompt) end
458
-
459
- # Renders a page into a {Wx::MemoryDC}.
460
- #
461
- # Used internally by {Wx::PRT::PrintPreview}.
462
- # @param pageNum [Integer]
463
- # @return [Boolean]
464
- def render_page(pageNum) end
465
-
466
- # Sets the current page to be previewed.
467
- # @param pageNum [Integer]
468
- # @return [Boolean]
469
- def set_current_page(pageNum) end
470
- alias_method :current_page=, :set_current_page
471
-
472
- # Sets the frame to be used for displaying the print preview canvas and control bar.
473
- # @param frame [Wx::Frame]
474
- # @return [void]
475
- def set_frame(frame) end
476
- alias_method :frame=, :set_frame
477
-
478
- # Associates a printout object with the {Wx::PRT::PrintPreview} object.
479
- # @param printout [Wx::PRT::Printout]
480
- # @return [void]
481
- def set_printout(printout) end
482
- alias_method :printout=, :set_printout
483
-
484
- # Sets the percentage preview zoom, and refreshes the preview canvas accordingly.
485
- #
486
- #
487
- # @see Wx::PRT::PrintPreview#get_zoom
488
- # @param percent [Integer]
489
- # @return [void]
490
- def set_zoom(percent) end
491
- alias_method :zoom=, :set_zoom
492
-
493
- end # PrintPreview
494
-
495
497
 
496
- end
498
+ end
499
+
500
+ end