wxruby3 0.9.2-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (646) hide show
  1. checksums.yaml +4 -4
  2. data/INSTALL.md +35 -29
  3. data/README.md +24 -15
  4. data/ext/wxbase32u_gcc_custom.dll +0 -0
  5. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  6. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  7. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  19. data/lib/wx/core/bitmap_combobox.rb +17 -21
  20. data/lib/wx/core/combobox.rb +13 -3
  21. data/lib/wx/core/controlwithitems.rb +40 -130
  22. data/lib/wx/core/enum.rb +17 -1
  23. data/lib/wx/core/event.rb +6 -1
  24. data/lib/wx/core/events/evt_list.rb +5 -4
  25. data/lib/wx/core/evthandler.rb +8 -2
  26. data/lib/wx/core/generic_validator.rb +312 -0
  27. data/lib/wx/core/listbox.rb +2 -2
  28. data/lib/wx/core/log.rb +1 -1
  29. data/lib/wx/core/owner_drawn_combobox.rb +45 -0
  30. data/lib/wx/core/size.rb +4 -0
  31. data/lib/wx/core/sizer.rb +1 -2
  32. data/lib/wx/core/standard_paths.rb +22 -0
  33. data/lib/wx/core/text_entry.rb +4 -1
  34. data/lib/wx/core/validator.rb +70 -5
  35. data/lib/wx/core/window.rb +3 -7
  36. data/lib/wx/doc/art_locator.rb +1 -0
  37. data/lib/wx/doc/comboctrl.rb +18 -0
  38. data/lib/wx/doc/controlwithitems.rb +16 -0
  39. data/lib/wx/doc/date_picker_ctrl.rb +23 -0
  40. data/lib/wx/doc/editable_listbox.rb +44 -0
  41. data/lib/wx/doc/enum.rb +15 -0
  42. data/lib/wx/doc/event.rb +12 -0
  43. data/lib/wx/doc/extra/12_client_data.md +89 -0
  44. data/lib/wx/doc/extra/13_validators.md +139 -0
  45. data/lib/wx/doc/gdi_common.rb +4 -0
  46. data/lib/wx/doc/gen/about_dialog_info.rb +25 -0
  47. data/lib/wx/doc/gen/accelerator.rb +7 -1
  48. data/lib/wx/doc/gen/accessible.rb +13 -0
  49. data/lib/wx/doc/gen/activity_indicator.rb +7 -0
  50. data/lib/wx/doc/gen/animation.rb +12 -0
  51. data/lib/wx/doc/gen/animation_ctrl.rb +10 -0
  52. data/lib/wx/doc/gen/any_button.rb +17 -1
  53. data/lib/wx/doc/gen/app.rb +35 -1
  54. data/lib/wx/doc/gen/app_traits.rb +38 -5
  55. data/lib/wx/doc/gen/art_provider.rb +14 -0
  56. data/lib/wx/doc/gen/aui/aui_dock_art.rb +12 -0
  57. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +1 -0
  58. data/lib/wx/doc/gen/aui/aui_manager.rb +24 -1
  59. data/lib/wx/doc/gen/aui/aui_manager_event.rb +9 -1
  60. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +3 -0
  61. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +2 -0
  62. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +3 -1
  63. data/lib/wx/doc/gen/aui/aui_notebook.rb +20 -2
  64. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +2 -1
  65. data/lib/wx/doc/gen/aui/aui_pane_info.rb +30 -1
  66. data/lib/wx/doc/gen/aui/aui_tab_art.rb +6 -0
  67. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +1 -0
  68. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +11 -0
  69. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +2 -0
  70. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +2 -1
  71. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +4 -0
  72. data/lib/wx/doc/gen/banner_window.rb +7 -0
  73. data/lib/wx/doc/gen/bitmap.rb +64 -3
  74. data/lib/wx/doc/gen/bitmap_button.rb +6 -1
  75. data/lib/wx/doc/gen/bitmap_combo_box.rb +9 -3
  76. data/lib/wx/doc/gen/book_ctrl_base.rb +17 -2
  77. data/lib/wx/doc/gen/book_ctrl_event.rb +3 -1
  78. data/lib/wx/doc/gen/box_sizer.rb +5 -0
  79. data/lib/wx/doc/gen/brush.rb +16 -1
  80. data/lib/wx/doc/gen/busy_info.rb +8 -0
  81. data/lib/wx/doc/gen/button.rb +11 -3
  82. data/lib/wx/doc/gen/calculate_layout_event.rb +4 -0
  83. data/lib/wx/doc/gen/calendar_ctrl.rb +22 -0
  84. data/lib/wx/doc/gen/calendar_date_attr.rb +1 -0
  85. data/lib/wx/doc/gen/calendar_event.rb +3 -1
  86. data/lib/wx/doc/gen/caret.rb +3 -0
  87. data/lib/wx/doc/gen/check_box.rb +10 -0
  88. data/lib/wx/doc/gen/check_list_box.rb +3 -0
  89. data/lib/wx/doc/gen/choice.rb +14 -2
  90. data/lib/wx/doc/gen/choicebook.rb +1 -0
  91. data/lib/wx/doc/gen/client_dc.rb +1 -0
  92. data/lib/wx/doc/gen/clipboard.rb +9 -0
  93. data/lib/wx/doc/gen/collapsible_pane.rb +3 -0
  94. data/lib/wx/doc/gen/collapsible_pane_event.rb +1 -0
  95. data/lib/wx/doc/gen/colour.rb +20 -0
  96. data/lib/wx/doc/gen/colour_dialog.rb +10 -0
  97. data/lib/wx/doc/gen/colour_picker_ctrl.rb +4 -0
  98. data/lib/wx/doc/gen/colour_picker_event.rb +1 -0
  99. data/lib/wx/doc/gen/combo_box.rb +20 -1
  100. data/lib/wx/doc/gen/combo_ctrl.rb +54 -295
  101. data/lib/wx/doc/gen/command_link_button.rb +8 -0
  102. data/lib/wx/doc/gen/context_help_button.rb +7 -1
  103. data/lib/wx/doc/gen/control.rb +12 -0
  104. data/lib/wx/doc/gen/control_with_items.rb +45 -9
  105. data/lib/wx/doc/gen/core.rb +2 -2
  106. data/lib/wx/doc/gen/cursor.rb +4 -0
  107. data/lib/wx/doc/gen/data_format.rb +1 -0
  108. data/lib/wx/doc/gen/data_object.rb +27 -5
  109. data/lib/wx/doc/gen/date_event.rb +2 -1
  110. data/lib/wx/doc/gen/date_picker_ctrl.rb +7 -1
  111. data/lib/wx/doc/gen/dc.rb +87 -3
  112. data/lib/wx/doc/gen/dial_up_event.rb +2 -0
  113. data/lib/wx/doc/gen/dial_up_manager.rb +12 -0
  114. data/lib/wx/doc/gen/dialog.rb +42 -3
  115. data/lib/wx/doc/gen/dir_dialog.rb +6 -1
  116. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -0
  117. data/lib/wx/doc/gen/dir_picker_ctrl.rb +5 -0
  118. data/lib/wx/doc/gen/drag_drop.rb +20 -0
  119. data/lib/wx/doc/gen/drag_image.rb +7 -0
  120. data/lib/wx/doc/gen/editable_list_box.rb +5 -3
  121. data/lib/wx/doc/gen/event.rb +26 -11
  122. data/lib/wx/doc/gen/event_blocker.rb +2 -1
  123. data/lib/wx/doc/gen/event_filter.rb +3 -0
  124. data/lib/wx/doc/gen/event_list.rb +4 -4
  125. data/lib/wx/doc/gen/events.rb +165 -26
  126. data/lib/wx/doc/gen/evt_handler.rb +40 -2
  127. data/lib/wx/doc/gen/ext_help_controller.rb +9 -0
  128. data/lib/wx/doc/gen/file_ctrl.rb +11 -2
  129. data/lib/wx/doc/gen/file_ctrl_event.rb +5 -1
  130. data/lib/wx/doc/gen/file_dialog.rb +13 -0
  131. data/lib/wx/doc/gen/file_dialog_custom_control.rb +12 -0
  132. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +9 -0
  133. data/lib/wx/doc/gen/file_dir_picker_event.rb +2 -1
  134. data/lib/wx/doc/gen/file_picker_ctrl.rb +4 -0
  135. data/lib/wx/doc/gen/file_system.rb +17 -1
  136. data/lib/wx/doc/gen/find_dialog_event.rb +2 -1
  137. data/lib/wx/doc/gen/find_replace_data.rb +1 -0
  138. data/lib/wx/doc/gen/find_replace_dialog.rb +3 -0
  139. data/lib/wx/doc/gen/flex_grid_sizer.rb +13 -0
  140. data/lib/wx/doc/gen/font.rb +75 -3
  141. data/lib/wx/doc/gen/font_data.rb +14 -0
  142. data/lib/wx/doc/gen/font_dialog.rb +6 -0
  143. data/lib/wx/doc/gen/font_picker_ctrl.rb +8 -0
  144. data/lib/wx/doc/gen/font_picker_event.rb +1 -0
  145. data/lib/wx/doc/gen/frame.rb +24 -7
  146. data/lib/wx/doc/gen/fs_file.rb +22 -0
  147. data/lib/wx/doc/gen/gauge.rb +8 -0
  148. data/lib/wx/doc/gen/gb_sizer_item.rb +5 -0
  149. data/lib/wx/doc/gen/gcdc.rb +2 -0
  150. data/lib/wx/doc/gen/gdi_common.rb +50 -0
  151. data/lib/wx/doc/gen/gdi_object.rb +1 -0
  152. data/lib/wx/doc/gen/generic_dir_ctrl.rb +7 -0
  153. data/lib/wx/doc/gen/graphics_context.rb +36 -7
  154. data/lib/wx/doc/gen/graphics_object.rb +24 -0
  155. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +2 -0
  156. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +14 -2
  157. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -0
  158. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +1 -0
  159. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +2 -0
  160. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -0
  161. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +2 -0
  162. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +1 -0
  163. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +1 -0
  164. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +1 -0
  165. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +9 -0
  166. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +1 -0
  167. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +1 -0
  168. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -0
  169. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +2 -0
  170. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +2 -0
  171. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -0
  172. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +6 -0
  173. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -0
  174. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -0
  175. data/lib/wx/doc/gen/grid/grid_ctrl.rb +229 -7
  176. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +4 -1
  177. data/lib/wx/doc/gen/grid/grid_event.rb +4 -1
  178. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +2 -1
  179. data/lib/wx/doc/gen/grid/grid_size_event.rb +2 -1
  180. data/lib/wx/doc/gen/grid/grid_string_table.rb +7 -0
  181. data/lib/wx/doc/gen/grid/grid_table_base.rb +27 -1
  182. data/lib/wx/doc/gen/grid/grid_table_message.rb +1 -0
  183. data/lib/wx/doc/gen/grid_bag_sizer.rb +24 -4
  184. data/lib/wx/doc/gen/grid_sizer.rb +11 -0
  185. data/lib/wx/doc/gen/gui_event_loop.rb +12 -0
  186. data/lib/wx/doc/gen/header_ctrl.rb +106 -0
  187. data/lib/wx/doc/gen/header_ctrl_event.rb +5 -1
  188. data/lib/wx/doc/gen/help_controller.rb +11 -0
  189. data/lib/wx/doc/gen/help_provider.rb +12 -3
  190. data/lib/wx/doc/gen/html/html_cell.rb +25 -0
  191. data/lib/wx/doc/gen/html/html_cell_event.rb +3 -1
  192. data/lib/wx/doc/gen/html/html_easy_printing.rb +13 -1
  193. data/lib/wx/doc/gen/html/html_help_controller.rb +18 -0
  194. data/lib/wx/doc/gen/html/html_help_data.rb +5 -0
  195. data/lib/wx/doc/gen/html/html_help_window.rb +8 -0
  196. data/lib/wx/doc/gen/html/html_link_event.rb +1 -0
  197. data/lib/wx/doc/gen/html/html_list_box.rb +49 -9
  198. data/lib/wx/doc/gen/html/html_printout.rb +7 -0
  199. data/lib/wx/doc/gen/html/html_window.rb +31 -0
  200. data/lib/wx/doc/gen/hyperlink_ctrl.rb +2 -1
  201. data/lib/wx/doc/gen/hyperlink_event.rb +1 -0
  202. data/lib/wx/doc/gen/icon.rb +19 -1
  203. data/lib/wx/doc/gen/icon_location.rb +1 -0
  204. data/lib/wx/doc/gen/image.rb +67 -10
  205. data/lib/wx/doc/gen/image_list.rb +12 -2
  206. data/lib/wx/doc/gen/info_bar.rb +12 -0
  207. data/lib/wx/doc/gen/keyboard_state.rb +11 -0
  208. data/lib/wx/doc/gen/list_box.rb +20 -3
  209. data/lib/wx/doc/gen/list_ctrl.rb +89 -0
  210. data/lib/wx/doc/gen/list_event.rb +11 -1
  211. data/lib/wx/doc/gen/listbook.rb +1 -0
  212. data/lib/wx/doc/gen/locale.rb +22 -0
  213. data/lib/wx/doc/gen/log.rb +42 -0
  214. data/lib/wx/doc/gen/mdi_client_window.rb +4 -1
  215. data/lib/wx/doc/gen/mdi_frame.rb +27 -4
  216. data/lib/wx/doc/gen/media_ctrl.rb +17 -0
  217. data/lib/wx/doc/gen/media_event.rb +2 -1
  218. data/lib/wx/doc/gen/memory_dc.rb +10 -0
  219. data/lib/wx/doc/gen/menu.rb +48 -7
  220. data/lib/wx/doc/gen/menu_bar.rb +32 -13
  221. data/lib/wx/doc/gen/menu_item.rb +26 -0
  222. data/lib/wx/doc/gen/message_dialog.rb +10 -0
  223. data/lib/wx/doc/gen/mini_frame.rb +5 -2
  224. data/lib/wx/doc/gen/mirror_dc.rb +1 -0
  225. data/lib/wx/doc/gen/mouse_state.rb +1 -0
  226. data/lib/wx/doc/gen/multi_choice_dialog.rb +3 -1
  227. data/lib/wx/doc/gen/non_owned_window.rb +3 -0
  228. data/lib/wx/doc/gen/notebook.rb +11 -1
  229. data/lib/wx/doc/gen/num_validator.rb +37 -0
  230. data/lib/wx/doc/gen/number_entry_dialog.rb +4 -0
  231. data/lib/wx/doc/gen/object.rb +3 -0
  232. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +340 -0
  233. data/lib/wx/doc/gen/paint_dc.rb +1 -0
  234. data/lib/wx/doc/gen/palette.rb +5 -0
  235. data/lib/wx/doc/gen/panel.rb +10 -2
  236. data/lib/wx/doc/gen/pen.rb +30 -1
  237. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +2 -1
  238. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +4 -1
  239. data/lib/wx/doc/gen/pg/pg_cell.rb +6 -1
  240. data/lib/wx/doc/gen/pg/pg_editor.rb +61 -15
  241. data/lib/wx/doc/gen/pg/pg_multi_button.rb +2 -0
  242. data/lib/wx/doc/gen/pg/pg_properties.rb +198 -81
  243. data/lib/wx/doc/gen/pg/pg_property.rb +129 -52
  244. data/lib/wx/doc/gen/pg/pg_validation_info.rb +2 -0
  245. data/lib/wx/doc/gen/pg/property_grid.rb +56 -14
  246. data/lib/wx/doc/gen/pg/property_grid_event.rb +16 -6
  247. data/lib/wx/doc/gen/pg/property_grid_interface.rb +98 -37
  248. data/lib/wx/doc/gen/pg/property_grid_manager.rb +29 -7
  249. data/lib/wx/doc/gen/pg/property_grid_page.rb +11 -4
  250. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +7 -2
  251. data/lib/wx/doc/gen/picker_base.rb +11 -1
  252. data/lib/wx/doc/gen/platform_info.rb +31 -0
  253. data/lib/wx/doc/gen/popup_window.rb +5 -0
  254. data/lib/wx/doc/gen/progress_dialog.rb +4 -0
  255. data/lib/wx/doc/gen/property_sheet_dialog.rb +7 -1
  256. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +2 -0
  257. data/lib/wx/doc/gen/prt/post_script_dc.rb +1 -0
  258. data/lib/wx/doc/gen/prt/preview_frame.rb +4 -0
  259. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +1 -0
  260. data/lib/wx/doc/gen/prt/print_data.rb +27 -0
  261. data/lib/wx/doc/gen/prt/print_dialog.rb +4 -0
  262. data/lib/wx/doc/gen/prt/printer.rb +42 -5
  263. data/lib/wx/doc/gen/prt/printer_dc.rb +2 -0
  264. data/lib/wx/doc/gen/query_layout_info_event.rb +9 -0
  265. data/lib/wx/doc/gen/radio_box.rb +19 -0
  266. data/lib/wx/doc/gen/radio_button.rb +9 -0
  267. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +63 -0
  268. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +23 -0
  269. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +2 -1
  270. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +35 -9
  271. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +2 -1
  272. data/lib/wx/doc/gen/rbn/ribbon_control.rb +10 -0
  273. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +17 -7
  274. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -1
  275. data/lib/wx/doc/gen/rbn/ribbon_page.rb +12 -0
  276. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +11 -0
  277. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +2 -1
  278. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +25 -0
  279. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +2 -1
  280. data/lib/wx/doc/gen/rearrange_ctrl.rb +4 -0
  281. data/lib/wx/doc/gen/rearrange_list.rb +9 -0
  282. data/lib/wx/doc/gen/region.rb +42 -13
  283. data/lib/wx/doc/gen/region_iterator.rb +1 -0
  284. data/lib/wx/doc/gen/rtc/rich_text_box.rb +25 -8
  285. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +41 -4
  286. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -0
  287. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +23 -11
  288. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +74 -0
  289. data/lib/wx/doc/gen/rtc/rich_text_event.rb +6 -1
  290. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +8 -0
  291. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +6 -0
  292. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +1 -0
  293. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +4 -0
  294. data/lib/wx/doc/gen/rtc/rich_text_image.rb +7 -0
  295. data/lib/wx/doc/gen/rtc/rich_text_object.rb +64 -4
  296. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +51 -4
  297. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +13 -0
  298. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +9 -4
  299. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +3 -0
  300. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +2 -0
  301. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +1 -0
  302. data/lib/wx/doc/gen/sash_event.rb +5 -1
  303. data/lib/wx/doc/gen/sash_layout_window.rb +10 -0
  304. data/lib/wx/doc/gen/sash_window.rb +3 -0
  305. data/lib/wx/doc/gen/screen_dc.rb +1 -0
  306. data/lib/wx/doc/gen/scroll_bar.rb +11 -2
  307. data/lib/wx/doc/gen/scrolled_canvas.rb +20 -4
  308. data/lib/wx/doc/gen/scrolled_control.rb +20 -4
  309. data/lib/wx/doc/gen/scrolled_window.rb +20 -4
  310. data/lib/wx/doc/gen/search_ctrl.rb +6 -0
  311. data/lib/wx/doc/gen/simplebook.rb +7 -0
  312. data/lib/wx/doc/gen/single_choice_dialog.rb +3 -1
  313. data/lib/wx/doc/gen/sizer.rb +79 -9
  314. data/lib/wx/doc/gen/sizer_item.rb +16 -2
  315. data/lib/wx/doc/gen/slider.rb +23 -0
  316. data/lib/wx/doc/gen/spin_button.rb +9 -0
  317. data/lib/wx/doc/gen/spin_ctrl.rb +11 -0
  318. data/lib/wx/doc/gen/spin_ctrl_double.rb +7 -0
  319. data/lib/wx/doc/gen/spin_double_event.rb +4 -1
  320. data/lib/wx/doc/gen/spin_event.rb +2 -1
  321. data/lib/wx/doc/gen/splash_screen.rb +2 -0
  322. data/lib/wx/doc/gen/splitter_event.rb +10 -1
  323. data/lib/wx/doc/gen/splitter_window.rb +38 -14
  324. data/lib/wx/doc/gen/static_bitmap.rb +99 -2
  325. data/lib/wx/doc/gen/static_box.rb +6 -0
  326. data/lib/wx/doc/gen/static_box_sizer.rb +3 -0
  327. data/lib/wx/doc/gen/static_line.rb +4 -0
  328. data/lib/wx/doc/gen/static_text.rb +5 -0
  329. data/lib/wx/doc/gen/status_bar.rb +17 -3
  330. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +174 -6
  331. data/lib/wx/doc/gen/stc/styled_text_event.rb +27 -1
  332. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +7 -0
  333. data/lib/wx/doc/gen/svg_file_dc.rb +9 -0
  334. data/lib/wx/doc/gen/system_options.rb +8 -0
  335. data/lib/wx/doc/gen/system_settings.rb +7 -0
  336. data/lib/wx/doc/gen/task_bar_button.rb +12 -0
  337. data/lib/wx/doc/gen/task_bar_icon.rb +5 -0
  338. data/lib/wx/doc/gen/task_bar_icon_event.rb +2 -1
  339. data/lib/wx/doc/gen/text_attr.rb +27 -0
  340. data/lib/wx/doc/gen/text_ctrl.rb +27 -3
  341. data/lib/wx/doc/gen/text_entry.rb +43 -5
  342. data/lib/wx/doc/gen/text_entry_dialog.rb +12 -0
  343. data/lib/wx/doc/gen/text_validator.rb +16 -0
  344. data/lib/wx/doc/gen/time_picker_ctrl.rb +6 -0
  345. data/lib/wx/doc/gen/timer.rb +8 -0
  346. data/lib/wx/doc/gen/timer_event.rb +1 -0
  347. data/lib/wx/doc/gen/tip_provider.rb +5 -0
  348. data/lib/wx/doc/gen/toggle_button.rb +68 -0
  349. data/lib/wx/doc/gen/tool_bar.rb +57 -14
  350. data/lib/wx/doc/gen/tool_tip.rb +6 -0
  351. data/lib/wx/doc/gen/toolbook.rb +3 -0
  352. data/lib/wx/doc/gen/top_level_window.rb +34 -3
  353. data/lib/wx/doc/gen/tree_ctrl.rb +49 -0
  354. data/lib/wx/doc/gen/tree_event.rb +7 -1
  355. data/lib/wx/doc/gen/treebook.rb +9 -0
  356. data/lib/wx/doc/gen/ui_action_simulator.rb +4 -0
  357. data/lib/wx/doc/gen/utils.rb +55 -0
  358. data/lib/wx/doc/gen/v_list_box.rb +21 -0
  359. data/lib/wx/doc/gen/v_scrolled_window.rb +15 -0
  360. data/lib/wx/doc/gen/validator.rb +9 -13
  361. data/lib/wx/doc/gen/variant.rb +6 -0
  362. data/lib/wx/doc/gen/window.rb +260 -52
  363. data/lib/wx/doc/gen/window_dc.rb +2 -0
  364. data/lib/wx/doc/gen/window_disabler.rb +1 -0
  365. data/lib/wx/doc/gen/with_images.rb +7 -1
  366. data/lib/wx/doc/gen/wizard.rb +18 -0
  367. data/lib/wx/doc/gen/wizard_event.rb +3 -1
  368. data/lib/wx/doc/gen/wizard_page.rb +5 -0
  369. data/lib/wx/doc/gen/wizard_page_simple.rb +4 -0
  370. data/lib/wx/doc/gen/wrap_sizer.rb +5 -0
  371. data/lib/wx/doc/gen/xml_node.rb +14 -0
  372. data/lib/wx/doc/gen/xml_resource.rb +22 -0
  373. data/lib/wx/doc/generic_validator.rb +95 -0
  374. data/lib/wx/doc/html/simple_html_listbox.rb +22 -0
  375. data/lib/wx/doc/num_validator.rb +387 -0
  376. data/lib/wx/doc/owner_drawn_combobox.rb +96 -0
  377. data/lib/wx/doc/pg/numeric_property_validator.rb +33 -0
  378. data/lib/wx/doc/static_bitmap.rb +25 -0
  379. data/lib/wx/doc/text_validator.rb +10 -0
  380. data/lib/wx/doc/validator.rb +113 -0
  381. data/lib/wx/doc/window.rb +30 -0
  382. data/lib/wx/html/events/evt_list.rb +0 -10
  383. data/lib/wx/html/simple_html_listbox.rb +24 -91
  384. data/lib/wx/keyword_defs.rb +34 -2
  385. data/lib/wx/rbn/ribbon_gallery.rb +0 -21
  386. data/lib/wx/version.rb +1 -1
  387. data/lib/wxruby_aui.so +0 -0
  388. data/lib/wxruby_core.so +0 -0
  389. data/lib/wxruby_grid.so +0 -0
  390. data/lib/wxruby_html.so +0 -0
  391. data/lib/wxruby_pg.so +0 -0
  392. data/lib/wxruby_prt.so +0 -0
  393. data/lib/wxruby_rbn.so +0 -0
  394. data/lib/wxruby_rtc.so +0 -0
  395. data/lib/wxruby_stc.so +0 -0
  396. data/rakelib/lib/config/mingw.rb +12 -0
  397. data/samples/aui/aui.rb +1237 -1233
  398. data/samples/calendar/calendar.rb +293 -289
  399. data/samples/controls/get_item_sample.rb +83 -79
  400. data/samples/controls/htlbox.rb +331 -327
  401. data/samples/dialogs/dialogs.rb +682 -694
  402. data/samples/dialogs/wizard.rb +52 -55
  403. data/samples/dragdrop/dragdrop.rb +146 -142
  404. data/samples/drawing/bitmap.rb +29 -26
  405. data/samples/drawing/bitmap_image.rb +84 -80
  406. data/samples/drawing/graphics_drawing.rb +209 -205
  407. data/samples/drawing/image_prt.rb +344 -340
  408. data/samples/drawing/maths_images.rb +18 -1
  409. data/samples/drawing/rmagic_bitmap_image.rb +88 -84
  410. data/samples/etc/caret.rb +306 -0
  411. data/samples/etc/miniframe.rb +65 -60
  412. data/samples/etc/sash.rb +109 -105
  413. data/samples/etc/scrollwin.rb +86 -80
  414. data/samples/etc/system_settings.rb +216 -209
  415. data/samples/event/activation.rb +72 -67
  416. data/samples/event/event.rb +160 -153
  417. data/samples/event/threaded.rb +8 -1
  418. data/samples/event/update_ui_event.rb +67 -60
  419. data/samples/grid/grid.rb +188 -181
  420. data/samples/grid/gridtablebase.rb +136 -129
  421. data/samples/html/html.rb +208 -204
  422. data/samples/mdi/mdi.rb +59 -54
  423. data/samples/minimal/minimal.rb +54 -51
  424. data/samples/minimal/nothing.rb +1 -0
  425. data/samples/printing/printing.rb +367 -377
  426. data/samples/printing/printing2.rb +203 -198
  427. data/samples/propgrid/propgrid.rb +2312 -2308
  428. data/samples/propgrid/propgrid_minimal.rb +57 -50
  429. data/samples/ribbon/ribbon.rb +780 -774
  430. data/samples/sampler/ext.rb +0 -33
  431. data/samples/sampler/sample.rb +4 -9
  432. data/samples/sampler.rb +1 -1
  433. data/samples/splash/splash.rb +118 -116
  434. data/samples/text/rich_textctrl.rb +207 -201
  435. data/samples/text/richtext.rb +1409 -1405
  436. data/samples/text/scintilla.rb +137 -128
  437. data/samples/text/textctrl.rb +89 -83
  438. data/samples/text/unicode.rb +175 -168
  439. data/samples/treectrl/treectrl.rb +1430 -1426
  440. data/samples/widgets/activityindicator.rb +95 -0
  441. data/samples/widgets/art/widgets/activityindicator.xpm +278 -0
  442. data/samples/widgets/art/widgets/bmpbtn.xpm +37 -0
  443. data/samples/widgets/art/widgets/bmpcombobox.xpm +54 -0
  444. data/samples/widgets/art/widgets/button.xpm +54 -0
  445. data/samples/widgets/art/widgets/checkbox.xpm +54 -0
  446. data/samples/{bigdemo/icons → widgets/art/widgets}/choice.xpm +1 -1
  447. data/samples/widgets/art/widgets/choicebk.xpm +54 -0
  448. data/samples/widgets/art/widgets/clrpicker.xpm +193 -0
  449. data/samples/widgets/art/widgets/combobox.xpm +54 -0
  450. data/samples/widgets/art/widgets/datepick.xpm +200 -0
  451. data/samples/widgets/art/widgets/dirctrl.xpm +54 -0
  452. data/samples/widgets/art/widgets/dirpicker.xpm +213 -0
  453. data/samples/widgets/art/widgets/filepicker.xpm +214 -0
  454. data/samples/widgets/art/widgets/fontpicker.xpm +185 -0
  455. data/samples/widgets/art/widgets/gauge.xpm +54 -0
  456. data/samples/widgets/art/widgets/header.xpm +54 -0
  457. data/samples/widgets/art/widgets/hyperlnk.xpm +54 -0
  458. data/samples/widgets/art/widgets/listbook.xpm +54 -0
  459. data/samples/widgets/art/widgets/listbox.xpm +54 -0
  460. data/samples/widgets/art/widgets/native.xpm +81 -0
  461. data/samples/widgets/art/widgets/notebook.xpm +54 -0
  462. data/samples/widgets/art/widgets/odcombobox.xpm +54 -0
  463. data/samples/widgets/art/widgets/radiobox.xpm +54 -0
  464. data/samples/widgets/art/widgets/scrolbar.xpm +54 -0
  465. data/samples/widgets/art/widgets/slider.xpm +54 -0
  466. data/samples/widgets/art/widgets/spinbtn.xpm +40 -0
  467. data/samples/widgets/art/widgets/statbmp.xpm +40 -0
  468. data/samples/widgets/art/widgets/statbox.xpm +54 -0
  469. data/samples/widgets/art/widgets/stattext.xpm +54 -0
  470. data/samples/widgets/art/widgets/text.xpm +54 -0
  471. data/samples/widgets/art/widgets/timepick.xpm +207 -0
  472. data/samples/widgets/art/widgets/toggle.xpm +54 -0
  473. data/samples/widgets/art/widgets/toucan.png +0 -0
  474. data/samples/widgets/bmpcombobox.rb +651 -0
  475. data/samples/widgets/button.rb +462 -0
  476. data/samples/widgets/checkbox.rb +211 -0
  477. data/samples/widgets/choice.rb +287 -0
  478. data/samples/widgets/clrpicker.rb +156 -0
  479. data/samples/widgets/combobox.rb +516 -0
  480. data/samples/widgets/datepick.rb +215 -0
  481. data/samples/widgets/dirctrl.rb +265 -0
  482. data/samples/widgets/dirpicker.rb +158 -0
  483. data/samples/widgets/editlbox.rb +122 -0
  484. data/samples/widgets/filectrl.rb +216 -0
  485. data/samples/widgets/filepicker.rb +214 -0
  486. data/samples/widgets/fontpicker.rb +135 -0
  487. data/samples/widgets/gauge.rb +311 -0
  488. data/samples/widgets/headerctrl.rb +236 -0
  489. data/samples/widgets/hyperlink.rb +203 -0
  490. data/samples/widgets/itemcontainer.rb +185 -0
  491. data/samples/widgets/listbox.rb +473 -0
  492. data/samples/widgets/notebook.rb +488 -0
  493. data/samples/widgets/odcombobox.rb +608 -0
  494. data/samples/widgets/radiobox.rb +328 -0
  495. data/samples/widgets/searchctrl.rb +159 -0
  496. data/samples/widgets/slider.rb +594 -0
  497. data/samples/widgets/spinbtn.rb +443 -0
  498. data/samples/widgets/statbmp.rb +130 -0
  499. data/samples/widgets/static.rb +436 -0
  500. data/samples/widgets/textctrl.rb +700 -0
  501. data/samples/widgets/timepick.rb +148 -0
  502. data/samples/widgets/tn_widgets.png +0 -0
  503. data/samples/widgets/toggle.rb +385 -0
  504. data/samples/widgets/widgets.rb +1233 -0
  505. data/samples/xrc/custom_xrc_sample.rb +47 -41
  506. data/samples/xrc/xrc_sample.rb +53 -47
  507. data/tests/test_event_handling.rb +52 -34
  508. data/tests/test_events.rb +7 -0
  509. data/tests/test_item_data.rb +24 -0
  510. data/tests/test_sizer.rb +44 -1
  511. data/tests/test_validators.rb +805 -0
  512. metadata +87 -137
  513. data/lib/wx/core/choice.rb +0 -14
  514. data/lib/wx/core/combo_ctrl.rb +0 -110
  515. data/samples/bigdemo/About.rbw +0 -39
  516. data/samples/bigdemo/ColorPanel.rbw +0 -23
  517. data/samples/bigdemo/GridSimple.rbw +0 -78
  518. data/samples/bigdemo/MDIDemo.rbw +0 -57
  519. data/samples/bigdemo/PopupMenu.rbw +0 -146
  520. data/samples/bigdemo/ShapedWindow.rbw +0 -128
  521. data/samples/bigdemo/Sizers.rbw +0 -541
  522. data/samples/bigdemo/bigdemo.rb +0 -817
  523. data/samples/bigdemo/demoTemplate.rbw +0 -33
  524. data/samples/bigdemo/helpfile.htb +0 -0
  525. data/samples/bigdemo/icons/Test 015.jpg +0 -0
  526. data/samples/bigdemo/icons/Test 015.png +0 -0
  527. data/samples/bigdemo/icons/choice.bmp +0 -0
  528. data/samples/bigdemo/icons/combo.bmp +0 -0
  529. data/samples/bigdemo/icons/combo.xpm +0 -27
  530. data/samples/bigdemo/icons/copy.xpm +0 -25
  531. data/samples/bigdemo/icons/cut.xpm +0 -24
  532. data/samples/bigdemo/icons/gauge.bmp +0 -0
  533. data/samples/bigdemo/icons/gauge.xpm +0 -27
  534. data/samples/bigdemo/icons/help.xpm +0 -25
  535. data/samples/bigdemo/icons/list.bmp +0 -0
  536. data/samples/bigdemo/icons/list.xpm +0 -27
  537. data/samples/bigdemo/icons/mondrian.ico +0 -0
  538. data/samples/bigdemo/icons/mondrian.xpm +0 -44
  539. data/samples/bigdemo/icons/new.xpm +0 -24
  540. data/samples/bigdemo/icons/ogl.ico +0 -0
  541. data/samples/bigdemo/icons/ogl.xpm +0 -45
  542. data/samples/bigdemo/icons/open.xpm +0 -26
  543. data/samples/bigdemo/icons/paste.bmp +0 -0
  544. data/samples/bigdemo/icons/paste.xpm +0 -38
  545. data/samples/bigdemo/icons/pointy.png +0 -0
  546. data/samples/bigdemo/icons/preview.xpm +0 -26
  547. data/samples/bigdemo/icons/print.xpm +0 -26
  548. data/samples/bigdemo/icons/radio.bmp +0 -0
  549. data/samples/bigdemo/icons/radio.xpm +0 -27
  550. data/samples/bigdemo/icons/robert.xpm +0 -415
  551. data/samples/bigdemo/icons/sashtest.ico +0 -0
  552. data/samples/bigdemo/icons/save.xpm +0 -25
  553. data/samples/bigdemo/icons/smiles.bmp +0 -0
  554. data/samples/bigdemo/icons/smiles.xpm +0 -39
  555. data/samples/bigdemo/icons/smiley.ico +0 -0
  556. data/samples/bigdemo/icons/smiley.xpm +0 -42
  557. data/samples/bigdemo/icons/stattext.xpm +0 -24
  558. data/samples/bigdemo/icons/test2.bmp +0 -0
  559. data/samples/bigdemo/icons/test2.png +0 -0
  560. data/samples/bigdemo/icons/test2.xpm +0 -79
  561. data/samples/bigdemo/icons/text.bmp +0 -0
  562. data/samples/bigdemo/icons/text.xpm +0 -27
  563. data/samples/bigdemo/icons/tog1.bmp +0 -0
  564. data/samples/bigdemo/icons/tog1.xpm +0 -38
  565. data/samples/bigdemo/icons/tog2.bmp +0 -0
  566. data/samples/bigdemo/icons/tog2.xpm +0 -38
  567. data/samples/bigdemo/icons/wxruby-128x128.png +0 -0
  568. data/samples/bigdemo/icons/wxwin.ico +0 -0
  569. data/samples/bigdemo/icons/wxwin16x16.png +0 -0
  570. data/samples/bigdemo/icons/wxwin16x16.xpm +0 -25
  571. data/samples/bigdemo/icons/wxwin32x32.png +0 -0
  572. data/samples/bigdemo/icons/wxwin48x48.png +0 -0
  573. data/samples/bigdemo/run.rb +0 -98
  574. data/samples/bigdemo/tips.txt +0 -7
  575. data/samples/bigdemo/utils.rb +0 -20
  576. data/samples/bigdemo/wxArtProvider.rbw +0 -282
  577. data/samples/bigdemo/wxBitmapButton.rbw +0 -65
  578. data/samples/bigdemo/wxButton.rbw +0 -64
  579. data/samples/bigdemo/wxCalendarCtrl.rbw +0 -59
  580. data/samples/bigdemo/wxCheckBox.rbw +0 -50
  581. data/samples/bigdemo/wxCheckListBox.rbw +0 -65
  582. data/samples/bigdemo/wxChoice.rbw +0 -47
  583. data/samples/bigdemo/wxChoicebook.rbw +0 -78
  584. data/samples/bigdemo/wxColourDialog.rbw +0 -33
  585. data/samples/bigdemo/wxComboBox.rbw +0 -77
  586. data/samples/bigdemo/wxCursor.rbw +0 -136
  587. data/samples/bigdemo/wxDialog.rbw +0 -74
  588. data/samples/bigdemo/wxDirDialog.rbw +0 -29
  589. data/samples/bigdemo/wxDragImage.rbw +0 -70
  590. data/samples/bigdemo/wxFileDialog.rbw +0 -37
  591. data/samples/bigdemo/wxFileDialog_Save.rbw +0 -35
  592. data/samples/bigdemo/wxFindReplaceDialog.rbw +0 -82
  593. data/samples/bigdemo/wxFontDialog.rbw +0 -200
  594. data/samples/bigdemo/wxFrame.rbw +0 -53
  595. data/samples/bigdemo/wxGauge.rbw +0 -65
  596. data/samples/bigdemo/wxGenericDirCtrl.rbw +0 -74
  597. data/samples/bigdemo/wxGrid.rbw +0 -66
  598. data/samples/bigdemo/wxHtmlHelpController.rbw +0 -52
  599. data/samples/bigdemo/wxListBox.rbw +0 -140
  600. data/samples/bigdemo/wxListCtrl_virtual.rbw +0 -112
  601. data/samples/bigdemo/wxMDIWindows.rbw +0 -50
  602. data/samples/bigdemo/wxMenu.rbw +0 -247
  603. data/samples/bigdemo/wxMessageDialog.rbw +0 -27
  604. data/samples/bigdemo/wxMiniFrame.rbw +0 -70
  605. data/samples/bigdemo/wxMultipleChoiceDialog.rbw +0 -29
  606. data/samples/bigdemo/wxNotebook.rbw +0 -136
  607. data/samples/bigdemo/wxProgressDialog.rbw +0 -43
  608. data/samples/bigdemo/wxRadioBox.rbw +0 -72
  609. data/samples/bigdemo/wxRadioButton.rbw +0 -125
  610. data/samples/bigdemo/wxSashWindow.rbw +0 -141
  611. data/samples/bigdemo/wxScrolledMessageDialog.rbw +0 -57
  612. data/samples/bigdemo/wxScrolledWindow.rbw +0 -199
  613. data/samples/bigdemo/wxSingleChoiceDialog.rbw +0 -33
  614. data/samples/bigdemo/wxSlider.rbw +0 -42
  615. data/samples/bigdemo/wxSpinButton.rbw +0 -50
  616. data/samples/bigdemo/wxSpinCtrl.rbw +0 -51
  617. data/samples/bigdemo/wxSplitterWindow.rbw +0 -63
  618. data/samples/bigdemo/wxStaticBitmap.rbw +0 -47
  619. data/samples/bigdemo/wxStaticText.rbw +0 -55
  620. data/samples/bigdemo/wxStatusBar.rbw +0 -126
  621. data/samples/bigdemo/wxTextCtrl.rbw +0 -149
  622. data/samples/bigdemo/wxTextEntryDialog.rbw +0 -31
  623. data/samples/bigdemo/wxToggleButton.rbw +0 -49
  624. data/samples/bigdemo/wxToolBar.rbw +0 -131
  625. data/samples/bigdemo/wxTreeCtrl.rbw +0 -191
  626. data/samples/caret/caret.rb +0 -298
  627. data/samples/caret/mondrian.xpm +0 -44
  628. data/samples/controls/books.rb +0 -189
  629. data/samples/controls/choice.xpm +0 -27
  630. data/samples/controls/combo.xpm +0 -27
  631. data/samples/controls/controls.rb +0 -1099
  632. data/samples/controls/gauge.xpm +0 -27
  633. data/samples/controls/list.xpm +0 -27
  634. data/samples/controls/mondrian.ico +0 -0
  635. data/samples/controls/mondrian.xpm +0 -44
  636. data/samples/controls/radio.xpm +0 -27
  637. data/samples/controls/stattext.xpm +0 -24
  638. data/samples/controls/test2.bmp +0 -0
  639. data/samples/controls/text.xpm +0 -27
  640. data/samples/controls/tn_books.png +0 -0
  641. data/samples/controls/tn_controls.png +0 -0
  642. data/samples/etc/choice.rb +0 -87
  643. data/samples/etc/tn_choice.png +0 -0
  644. data/samples/text/mondrian.ico +0 -0
  645. data/samples/text/mondrian.xpm +0 -44
  646. /data/samples/{caret → etc}/tn_caret.png +0 -0
@@ -7,6 +7,7 @@
7
7
  module Wx::PRT
8
8
 
9
9
  # This class represents the Windows or PostScript printer, and is the vehicle through which printing may be launched by an application.
10
+ #
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.
11
12
  #
12
13
  # Category: Printing Framework
@@ -21,6 +22,7 @@ module Wx::PRT
21
22
  class Printer < Object
22
23
 
23
24
  # Constructor.
25
+ #
24
26
  # Pass an optional pointer to a block of print dialog data, which will be copied to the printer object's local data.
25
27
  # @see Wx::PRT::PrintDialogData
26
28
  # @see Wx::PRT::PrintData
@@ -40,6 +42,7 @@ module Wx::PRT
40
42
  alias_method :abort, :get_abort
41
43
 
42
44
  # Starts the printing process.
45
+ #
43
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.
44
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.
45
48
  # @param parent [Wx::Window]
@@ -49,13 +52,14 @@ module Wx::PRT
49
52
  def print(parent, printout, prompt=true) end
50
53
 
51
54
  # Invokes the print dialog.
55
+ #
52
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.
53
57
  #
54
58
  # <div class="wxrb-remark">
55
59
  # <b>Remark:</b>
56
60
  # <p>The application must delete this device context to avoid a memory leak.
57
61
  # </p>
58
- # </div>>
62
+ # </div>
59
63
  # @param parent [Wx::Window]
60
64
  # @return [Wx::DC]
61
65
  def print_dialog(parent) end
@@ -68,6 +72,7 @@ module Wx::PRT
68
72
  def report_error(parent, printout, message) end
69
73
 
70
74
  # Return last error.
75
+ #
71
76
  # Valid after calling {Wx::PRT::Printer#print}, {Wx::PRT::Printer#print_dialog} or {Wx::PRT::PrintPreview#print}.
72
77
  # These functions set last error to {Wx::PRT::PrinterError::PRINTER_NO_ERROR} if no error happened.
73
78
  # Returned value is one of the following:
@@ -86,6 +91,7 @@ module Wx::PRT
86
91
  end # Printer
87
92
 
88
93
  # This class encapsulates the functionality of printing out an application document.
94
+ #
89
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.
90
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.
91
97
  #
@@ -102,12 +108,14 @@ module Wx::PRT
102
108
  class Printout < Object
103
109
 
104
110
  # Constructor.
111
+ #
105
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)
106
113
  # @param title [String]
107
114
  # @return [Wx::PRT::Printout]
108
115
  def initialize(title=("Wx::PRT::Printout")) end
109
116
 
110
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
+ #
111
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.
112
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.
113
121
  # @param imageSize [Array(Integer, Integer), Wx::Size]
@@ -115,19 +123,21 @@ module Wx::PRT
115
123
  def fit_this_size_to_page(imageSize) end
116
124
 
117
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
+ #
118
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.
119
128
  #
120
129
  # <div class="wxrb-remark">
121
130
  # <b>Remark:</b>
122
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.
123
132
  # </p>
124
- # </div>>
133
+ # </div>
125
134
  # @param imageSize [Array(Integer, Integer), Wx::Size]
126
135
  # @param pageSetupData [Wx::PRT::PageSetupDialogData]
127
136
  # @return [void]
128
137
  def fit_this_size_to_page_margins(imageSize, pageSetupData) end
129
138
 
130
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
+ #
131
141
  # Use this if you're managing your own page margins.
132
142
  #
133
143
  # <div class="wxrb-note">
@@ -140,6 +150,7 @@ module Wx::PRT
140
150
  def fit_this_size_to_paper(imageSize) end
141
151
 
142
152
  # Returns the device context associated with the printout (given to the printout at start of printing or previewing).
153
+ #
143
154
  # The application can use {Wx::PRT::Printout#get_dc} to obtain a device context to draw on.
144
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.
145
156
  # @return [Wx::DC]
@@ -147,6 +158,7 @@ module Wx::PRT
147
158
  alias_method :dc, :get_dc
148
159
 
149
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
+ #
150
162
  # The page margins are specified with respect to the edges of the paper on all platforms.
151
163
  # @param pageSetupData [Wx::PRT::PageSetupDialogData]
152
164
  # @return [Wx::Rect]
@@ -154,6 +166,7 @@ module Wx::PRT
154
166
  alias_method :logical_page_margins_rect, :get_logical_page_margins_rect
155
167
 
156
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
+ #
157
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.
158
171
  # @return [Wx::Rect]
159
172
  def get_logical_page_rect; end
@@ -165,6 +178,7 @@ module Wx::PRT
165
178
  alias_method :logical_paper_rect, :get_logical_paper_rect
166
179
 
167
180
  # Returns the number of pixels per logical inch of the printer device context.
181
+ #
168
182
  # Dividing the printer PPI by the screen PPI can give a suitable scaling factor for drawing text onto the printer.
169
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.
170
184
  # @return [Array(Integer,Integer)]
@@ -172,6 +186,7 @@ module Wx::PRT
172
186
  alias_method :ppi_printer, :get_ppi_printer
173
187
 
174
188
  # Returns the number of pixels per logical inch of the screen device context.
189
+ #
175
190
  # Dividing the printer PPI by the screen PPI can give a suitable scaling factor for drawing text onto the printer.
176
191
  # If you are doing your own scaling, remember to multiply this by a scaling factor to take the preview DC size into account.
177
192
  # @return [Array(Integer,Integer)]
@@ -179,6 +194,7 @@ module Wx::PRT
179
194
  alias_method :ppi_screen, :get_ppi_screen
180
195
 
181
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
+ #
182
198
  # By default this returns (1, 32000) for the page minimum and maximum values, and (1, 1) for the required page range.
183
199
  # minPage must be greater than zero and maxPage must be greater than minPage.
184
200
  # @return [Array(Integer,Integer,Integer,Integer)]
@@ -191,12 +207,14 @@ module Wx::PRT
191
207
  alias_method :page_size_mm, :get_page_size_mm
192
208
 
193
209
  # Returns the size of the printer page in pixels, called the page rectangle.
210
+ #
194
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.
195
212
  # @return [Array(Integer,Integer)]
196
213
  def get_page_size_pixels; end
197
214
  alias_method :page_size_pixels, :get_page_size_pixels
198
215
 
199
216
  # Returns the rectangle that corresponds to the entire paper in pixels, called the paper rectangle.
217
+ #
200
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}.
201
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}.
202
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.
@@ -205,12 +223,14 @@ module Wx::PRT
205
223
  alias_method :paper_rect_pixels, :get_paper_rect_pixels
206
224
 
207
225
  # Returns the title of the printout.
226
+ #
208
227
  # Todothe python note here was wrong
209
228
  # @return [String]
210
229
  def get_title; end
211
230
  alias_method :title, :get_title
212
231
 
213
232
  # Should be overridden to return true if the document has this page, or false if not.
233
+ #
214
234
  # Returning false signifies the end of the document. By default, HasPage behaves as if the document has only one page.
215
235
  # @param pageNum [Integer]
216
236
  # @return [Boolean]
@@ -219,12 +239,14 @@ module Wx::PRT
219
239
 
220
240
  # Returns true if the printout is currently being used for previewing.
221
241
  #
242
+ #
222
243
  # @see Wx::PRT::Printout#get_preview
223
244
  # @return [Boolean]
224
245
  def is_preview; end
225
246
  alias_method :preview?, :is_preview
226
247
 
227
248
  # Returns the associated preview object if any.
249
+ #
228
250
  # If this printout object is used for previewing, returns the associated {Wx::PRT::PrintPreview}. Otherwise returns NULL.
229
251
  # The returned pointer is not owned by the printout and must not be deleted.
230
252
  # @see Wx::PRT::Printout#is_preview
@@ -233,6 +255,7 @@ module Wx::PRT
233
255
  alias_method :preview, :get_preview
234
256
 
235
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
+ #
236
259
  # That is, the user scale is set to (1,1) and the device origin is set to (0,0).
237
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.
238
261
  # You can use the GetLogicalXXXRect() routines below to obtain the paper rectangle, page rectangle, or page margins rectangle to perform your own scaling.
@@ -255,6 +278,7 @@ module Wx::PRT
255
278
  def map_screen_size_to_page_margins(pageSetupData) end
256
279
 
257
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
+ #
258
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.)
259
283
  # Use this if you want WYSIWYG behaviour, e.g., in a text editor.
260
284
  # @return [void]
@@ -267,6 +291,7 @@ module Wx::PRT
267
291
  def offset_logical_origin(xoff, yoff) end
268
292
 
269
293
  # Called by the framework at the start of document printing.
294
+ #
270
295
  # Return false from this function cancels the print job.
271
296
  # {Wx::PRT::Printout#on_begin_document} is called once for every copy printed.
272
297
  #
@@ -274,39 +299,44 @@ module Wx::PRT
274
299
  # <b>Remark:</b>
275
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}.
276
301
  # </p>
277
- # </div>>
302
+ # </div>
278
303
  # @param startPage [Integer]
279
304
  # @param endPage [Integer]
280
305
  # @return [Boolean]
281
306
  def on_begin_document(startPage, endPage) end
282
307
 
283
308
  # Called by the framework at the start of printing.
309
+ #
284
310
  # {Wx::PRT::Printout#on_begin_printing} is called once for every print job (regardless of how many copies are being printed).
285
311
  # @return [void]
286
312
  def on_begin_printing; end
287
313
 
288
314
  # Called by the framework at the end of document printing.
315
+ #
289
316
  # {Wx::PRT::Printout#on_end_document} is called once for every copy printed.
290
317
  #
291
318
  # <div class="wxrb-remark">
292
319
  # <b>Remark:</b>
293
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}.
294
321
  # </p>
295
- # </div>>
322
+ # </div>
296
323
  # @return [void]
297
324
  def on_end_document; end
298
325
 
299
326
  # Called by the framework at the end of printing.
327
+ #
300
328
  # OnEndPrinting is called once for every print job (regardless of how many copies are being printed).
301
329
  # @return [void]
302
330
  def on_end_printing; end
303
331
 
304
332
  # Called once by the framework before any other demands are made of the {Wx::PRT::Printout} object.
333
+ #
305
334
  # This gives the object an opportunity to calculate the number of pages in the document, for example.
306
335
  # @return [void]
307
336
  def on_prepare_printing; end
308
337
 
309
338
  # Called by the framework when a page should be printed.
339
+ #
310
340
  # Returning false cancels the print job.
311
341
  # @param pageNum [Integer]
312
342
  # @return [Boolean]
@@ -321,6 +351,7 @@ module Wx::PRT
321
351
  end # Printout
322
352
 
323
353
  # Objects of this class manage the print preview process.
354
+ #
324
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.
325
356
  #
326
357
  # <div class="wxrb-note">
@@ -345,6 +376,7 @@ module Wx::PRT
345
376
 
346
377
  # @overload initialize(printout, printoutForPrinting=nil, data=nil)
347
378
  # Constructor.
379
+ #
348
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.
349
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.
350
382
  #
@@ -352,7 +384,7 @@ module Wx::PRT
352
384
  # <b>Remark:</b>
353
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.
354
386
  # </p>
355
- # </div>>
387
+ # </div>
356
388
  #
357
389
  # Use {Wx::PRT::PrintPreview#is_ok} to check whether the {Wx::PRT::PrintPreview} object was created correctly.
358
390
  # @param printout [Wx::PRT::Printout]
@@ -403,18 +435,21 @@ module Wx::PRT
403
435
 
404
436
  # Gets the current percentage zoom level of the preview canvas.
405
437
  #
438
+ #
406
439
  # @see Wx::PRT::PrintPreview#set_zoom
407
440
  # @return [Integer]
408
441
  def get_zoom; end
409
442
  alias_method :zoom, :get_zoom
410
443
 
411
444
  # Returns true if the {Wx::PRT::PrintPreview} is valid, false otherwise.
445
+ #
412
446
  # It could return false if there was a problem initializing the printer device context (current printer not set, for example).
413
447
  # @return [Boolean]
414
448
  def is_ok; end
415
449
  alias_method :ok?, :is_ok
416
450
 
417
451
  # Invokes the print process using the second {Wx::PRT::Printout} object supplied in the {Wx::PRT::PrintPreview} constructor.
452
+ #
418
453
  # Will normally be called by the <b>Print</b>... panel item on the preview frame's control bar.
419
454
  # Returns false in case of error call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
420
455
  # @param prompt [Boolean]
@@ -422,6 +457,7 @@ module Wx::PRT
422
457
  def print(prompt) end
423
458
 
424
459
  # Renders a page into a {Wx::MemoryDC}.
460
+ #
425
461
  # Used internally by {Wx::PRT::PrintPreview}.
426
462
  # @param pageNum [Integer]
427
463
  # @return [Boolean]
@@ -447,6 +483,7 @@ module Wx::PRT
447
483
 
448
484
  # Sets the percentage preview zoom, and refreshes the preview canvas accordingly.
449
485
  #
486
+ #
450
487
  # @see Wx::PRT::PrintPreview#get_zoom
451
488
  # @param percent [Integer]
452
489
  # @return [void]
@@ -7,6 +7,7 @@
7
7
  module Wx::PRT
8
8
 
9
9
  # A printer device context is specific to MSW and Mac, and allows access to any printer with a Windows or Macintosh driver.
10
+ #
10
11
  # See {Wx::DC} for further information on device contexts, and {Wx::DC#get_size} for advice on achieving the correct scaling for the page.
11
12
  #
12
13
  # Category: Printing Framework
@@ -20,6 +21,7 @@ module Wx::PRT
20
21
  class PrinterDC < DC
21
22
 
22
23
  # Return the rectangle in device coordinates that corresponds to the full paper area, including the nonprinting regions of the paper.
24
+ #
23
25
  # The point (0,0) in device coordinates is the top left corner of the page rectangle, which is the printable area on MSW and Mac. The coordinates of the top left corner of the paper rectangle will therefore have small negative values, while the bottom right coordinates will be somewhat larger than the values returned by {Wx::DC#get_size}.
24
26
  # @return [Wx::Rect]
25
27
  def get_paper_rect; end
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # This event is sent when {Wx::LayoutAlgorithm} wishes to get the size, orientation and alignment of a window.
10
+ #
10
11
  # More precisely, the event is sent by the OnCalculateLayout handler which is itself invoked by {Wx::LayoutAlgorithm}.
11
12
  # ### Events using this class
12
13
  #
@@ -29,24 +30,28 @@ module Wx
29
30
  def initialize(id=0) end
30
31
 
31
32
  # Specifies the alignment of the window (which side of the remaining parent client area the window sticks to).
33
+ #
32
34
  # One of {Wx::LayoutAlignment::LAYOUT_TOP}, {Wx::LayoutAlignment::LAYOUT_LEFT}, {Wx::LayoutAlignment::LAYOUT_RIGHT}, {Wx::LayoutAlignment::LAYOUT_BOTTOM}.
33
35
  # @return [Wx::LayoutAlignment]
34
36
  def get_alignment; end
35
37
  alias_method :alignment, :get_alignment
36
38
 
37
39
  # Returns the flags associated with this event.
40
+ #
38
41
  # Not currently used.
39
42
  # @return [Integer]
40
43
  def get_flags; end
41
44
  alias_method :flags, :get_flags
42
45
 
43
46
  # Returns the orientation that the event handler specified to the event object.
47
+ #
44
48
  # May be one of {Wx::LayoutOrientation::LAYOUT_HORIZONTAL}, {Wx::LayoutOrientation::LAYOUT_VERTICAL}.
45
49
  # @return [Wx::LayoutOrientation]
46
50
  def get_orientation; end
47
51
  alias_method :orientation, :get_orientation
48
52
 
49
53
  # Returns the requested length of the window in the direction of the window orientation.
54
+ #
50
55
  # This information is not yet used.
51
56
  # @return [Integer]
52
57
  def get_requested_length; end
@@ -58,6 +63,7 @@ module Wx
58
63
  alias_method :size, :get_size
59
64
 
60
65
  # Call this to specify the alignment of the window (which side of the remaining parent client area the window sticks to).
66
+ #
61
67
  # May be one of {Wx::LayoutAlignment::LAYOUT_TOP}, {Wx::LayoutAlignment::LAYOUT_LEFT}, {Wx::LayoutAlignment::LAYOUT_RIGHT}, {Wx::LayoutAlignment::LAYOUT_BOTTOM}.
62
68
  # @param alignment [Wx::LayoutAlignment]
63
69
  # @return [void]
@@ -65,6 +71,7 @@ module Wx
65
71
  alias_method :alignment=, :set_alignment
66
72
 
67
73
  # Sets the flags associated with this event.
74
+ #
68
75
  # Not currently used.
69
76
  # @param flags [Integer]
70
77
  # @return [void]
@@ -72,6 +79,7 @@ module Wx
72
79
  alias_method :flags=, :set_flags
73
80
 
74
81
  # Call this to specify the orientation of the window.
82
+ #
75
83
  # May be one of {Wx::LayoutOrientation::LAYOUT_HORIZONTAL}, {Wx::LayoutOrientation::LAYOUT_VERTICAL}.
76
84
  # @param orientation [Wx::LayoutOrientation]
77
85
  # @return [void]
@@ -79,6 +87,7 @@ module Wx
79
87
  alias_method :orientation=, :set_orientation
80
88
 
81
89
  # Sets the requested length of the window in the direction of the window orientation.
90
+ #
82
91
  # This information is not yet used.
83
92
  # @param length [Integer]
84
93
  # @return [void]
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # A radio box item is used to select one of number of mutually exclusive choices.
10
+ #
10
11
  # It is displayed as a vertical column or horizontal row of labelled buttons.
11
12
  # ### Styles
12
13
  #
@@ -38,12 +39,14 @@ module Wx
38
39
  # @overload initialize()
39
40
  # Default constructor.
40
41
  #
42
+ #
41
43
  # @see Wx::RadioBox#create
42
44
  # @see Wx::Validator
43
45
  # @return [Wx::RadioBox]
44
46
  # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, majorDimension=0, style=Wx::RA_SPECIFY_COLS, validator=Wx::DEFAULT_VALIDATOR, name=Wx::RADIO_BOX_NAME_STR)
45
47
  # Constructor, creating and showing a radiobox.
46
48
  #
49
+ #
47
50
  # @see Wx::RadioBox#create
48
51
  # @see Wx::Validator
49
52
  # @param parent [Wx::Window] Parent window. Must not be NULL.
@@ -60,6 +63,7 @@ module Wx
60
63
  # @overload initialize(parent, id, label, pos, size, choices, majorDimension=0, style=Wx::RA_SPECIFY_COLS, validator=Wx::DEFAULT_VALIDATOR, name=Wx::RADIO_BOX_NAME_STR)
61
64
  # Constructor, creating and showing a radiobox.
62
65
  #
66
+ #
63
67
  # @see Wx::RadioBox#create
64
68
  # @see Wx::Validator
65
69
  # @param parent [Wx::Window] Parent window. Must not be NULL.
@@ -77,6 +81,7 @@ module Wx
77
81
 
78
82
  # @overload create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, majorDimension=0, style=Wx::RA_SPECIFY_COLS, validator=Wx::DEFAULT_VALIDATOR, name=Wx::RADIO_BOX_NAME_STR)
79
83
  # Creates the radiobox for two-step construction.
84
+ #
80
85
  # See {Wx::RadioBox#initialize} for further details.
81
86
  # @param parent [Wx::Window]
82
87
  # @param id [Integer]
@@ -91,6 +96,7 @@ module Wx
91
96
  # @return [Boolean]
92
97
  # @overload create(parent, id, label, pos, size, choices, majorDimension=0, style=Wx::RA_SPECIFY_COLS, validator=Wx::DEFAULT_VALIDATOR, name=Wx::RADIO_BOX_NAME_STR)
93
98
  # Creates the radiobox for two-step construction.
99
+ #
94
100
  # See {Wx::RadioBox#initialize} for further details.
95
101
  # @param parent [Wx::Window]
96
102
  # @param id [Integer]
@@ -124,6 +130,7 @@ module Wx
124
130
 
125
131
  # Returns the helptext associated with the specified item if any or {Wx::EmptyString}.
126
132
  #
133
+ #
127
134
  # @see Wx::RadioBox#set_item_help_text
128
135
  # @param item [Integer] The zero-based item index.
129
136
  # @return [String]
@@ -132,6 +139,7 @@ module Wx
132
139
 
133
140
  # Returns the tooltip associated with the specified item if any or NULL.
134
141
  #
142
+ #
135
143
  # @see Wx::RadioBox#set_item_tool_tip
136
144
  # @see Wx::Window#get_tool_tip
137
145
  # @param item [Integer]
@@ -145,6 +153,7 @@ module Wx
145
153
  alias_method :row_count, :get_row_count
146
154
 
147
155
  # Returns true if the item is enabled or false if it was disabled using Enable(n, false).
156
+ #
148
157
  # This function is currently only implemented in WXMSW, WXGTK, {Wx::QT} and {Wx::Universal} and always returns true in the other ports.
149
158
  # @param n [Integer] The zero-based button position.
150
159
  # @return [Boolean]
@@ -152,6 +161,7 @@ module Wx
152
161
  alias_method :item_enabled?, :is_item_enabled
153
162
 
154
163
  # Returns true if the item is currently shown or false if it was hidden using Show(n, false).
164
+ #
155
165
  # Note that this function returns true for an item which hadn't been hidden even if the entire radiobox is not currently shown.
156
166
  # This function is currently only implemented in WXMSW, WXGTK, {Wx::QT} and {Wx::Universal} and always returns true in the other ports.
157
167
  # @param n [Integer] The zero-based button position.
@@ -160,6 +170,7 @@ module Wx
160
170
  alias_method :item_shown?, :is_item_shown
161
171
 
162
172
  # Sets the helptext for an item.
173
+ #
163
174
  # Empty string erases any existing helptext.
164
175
  # @see Wx::RadioBox#get_item_help_text
165
176
  # @param item [Integer] The zero-based item index.
@@ -168,6 +179,7 @@ module Wx
168
179
  def set_item_help_text(item, helptext) end
169
180
 
170
181
  # Sets the tooltip text for the specified item in the radio group.
182
+ #
171
183
  # This function is currently only implemented in WXMSW and WXGTK2 and does nothing in the other ports.
172
184
  # @see Wx::RadioBox#get_item_tool_tip
173
185
  # @see Wx::Window#set_tool_tip
@@ -177,6 +189,7 @@ module Wx
177
189
  def set_item_tool_tip(item, text) end
178
190
 
179
191
  # Sets the selection to the given item.
192
+ #
180
193
  # Notice that a radio box always has selection, so n must be valid here and passing {Wx::NOT_FOUND} is not allowed.
181
194
  # @param n [Integer]
182
195
  # @return [void]
@@ -185,12 +198,14 @@ module Wx
185
198
 
186
199
  # Returns the number of items in the control.
187
200
  #
201
+ #
188
202
  # @see Wx::RadioBox#is_empty
189
203
  # @return [Integer]
190
204
  def get_count; end
191
205
  alias_method :count, :get_count
192
206
 
193
207
  # Returns the label of the item with the given index.
208
+ #
194
209
  # The index must be valid, i.e. less than the value returned by {Wx::RadioBox#get_count}, otherwise an assert is triggered. Notably, this function can't be called if the control is empty.
195
210
  #
196
211
  # The label of the item.
@@ -206,6 +221,7 @@ module Wx
206
221
  def set_string(n, string) end
207
222
 
208
223
  # Returns the index of the selected item.
224
+ #
209
225
  # As radio boxes always have a selected item, the return value is never {Wx::NOT_FOUND} for this class.
210
226
  # @return [Integer]
211
227
  def get_selection; end
@@ -213,6 +229,7 @@ module Wx
213
229
 
214
230
  # Returns true if the control is empty or false if it has some items.
215
231
  #
232
+ #
216
233
  # @see get_count
217
234
  # @return [Boolean]
218
235
  def is_empty; end
@@ -224,6 +241,7 @@ module Wx
224
241
  alias_method :strings, :get_strings
225
242
 
226
243
  # Selects the item with the specified string in the control.
244
+ #
227
245
  # This method doesn't cause any command events to be emitted.
228
246
  # Notice that this method is case-insensitive, i.e. the string is compared with all the elements of the control case-insensitively and the first matching entry is selected, even if it doesn't have exactly the same case as this string and there is an exact match afterwards.
229
247
  #
@@ -235,6 +253,7 @@ module Wx
235
253
 
236
254
  # Returns the label of the selected item or an empty string if no item is selected.
237
255
  #
256
+ #
238
257
  # @see get_selection
239
258
  # @return [String]
240
259
  def get_string_selection; end
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # A radio button item is a button which usually denotes one of several mutually exclusive options.
10
+ #
10
11
  # It has a text label next to a (usually) round button.
11
12
  # Radio buttons are typically used in groups of mutually-exclusive buttons, i.e. exactly one of the buttons in the group is checked, and the other ones are unchecked automatically. Such groups are created implicitly, but can also be started explicitly by using {Wx::RB_GROUP} style: a button with this style starts a new group and will become the initial selection in this group. Alternatively, a radio button may be excluded from the group that it would otherwise belong to by using {Wx::RB_SINGLE} style.
12
13
  # To find the other elements of the same radio button group, you can use {Wx::RadioButton#get_first_in_group}, {Wx::RadioButton#get_previous_in_group}, {Wx::RadioButton#get_next_in_group} and {Wx::RadioButton#get_last_in_group} functions.
@@ -40,12 +41,14 @@ module Wx
40
41
  # @overload initialize()
41
42
  # Default constructor.
42
43
  #
44
+ #
43
45
  # @see Wx::RadioButton#create
44
46
  # @see Wx::Validator
45
47
  # @return [Wx::RadioButton]
46
48
  # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::RADIO_BUTTON_NAME_STR)
47
49
  # Constructor, creating and showing a radio button.
48
50
  #
51
+ #
49
52
  # @see Wx::RadioButton#create
50
53
  # @see Wx::Validator
51
54
  # @param parent [Wx::Window] Parent window. Must not be NULL.
@@ -60,6 +63,7 @@ module Wx
60
63
  def initialize(*args) end
61
64
 
62
65
  # Creates the choice for two-step construction.
66
+ #
63
67
  # See {Wx::RadioButton#initialize} for further details.
64
68
  # @param parent [Wx::Window]
65
69
  # @param id [Integer]
@@ -78,6 +82,7 @@ module Wx
78
82
  alias_method :value, :get_value
79
83
 
80
84
  # Sets the radio button to checked or unchecked status.
85
+ #
81
86
  # This does not cause a {Wx::EVT_RADIOBUTTON} event to get emitted.
82
87
  # If the radio button belongs to a radio group exactly one button in the group may be checked and so this method can be only called with value set to true. To uncheck a radio button in a group you must check another button in the same group.
83
88
  #
@@ -92,6 +97,7 @@ module Wx
92
97
  alias_method :value=, :set_value
93
98
 
94
99
  # Returns the first button of the radio button group this button belongs to.
100
+ #
95
101
  # For a radio button with {Wx::RB_SINGLE} style, this function returns this button itself, as it is the only member of its group. Otherwise, the function returns the closest previous radio button with {Wx::RB_GROUP} style (which could still be this button itself) or the first radio button in the same window.
96
102
  # The returned value is never NULL.
97
103
  # @see Wx::RadioButton#get_previous_in_group
@@ -102,6 +108,7 @@ module Wx
102
108
  alias_method :first_in_group, :get_first_in_group
103
109
 
104
110
  # Returns the last button of the radio button group this button belongs to.
111
+ #
105
112
  # Similarly to {Wx::RadioButton#get_first_in_group}, this function returns this button itself if it has {Wx::RB_SINGLE} style. Otherwise, the function returns the last button before the next button with {Wx::RB_GROUP} style or the last radio button in the same window.
106
113
  # The returned value is never NULL.
107
114
  # @see Wx::RadioButton#get_previous_in_group
@@ -111,6 +118,7 @@ module Wx
111
118
  alias_method :last_in_group, :get_last_in_group
112
119
 
113
120
  # Returns the previous radio button in the same group.
121
+ #
114
122
  # The return value is NULL if there is no predecessor or if this button has {Wx::RB_SINGLE} style.
115
123
  # @see Wx::RadioButton#get_first_in_group
116
124
  # @see Wx::RadioButton#get_next_in_group
@@ -120,6 +128,7 @@ module Wx
120
128
  alias_method :previous_in_group, :get_previous_in_group
121
129
 
122
130
  # Returns the next radio button in the same group.
131
+ #
123
132
  # The return value is NULL if there is no successor or if this button has {Wx::RB_SINGLE} style.
124
133
  # @see Wx::RadioButton#get_first_in_group
125
134
  # @see Wx::RadioButton#get_previous_in_group