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
@@ -18,13 +18,14 @@ module Wx
18
18
  NULL_ICON_BUNDLE = nil
19
19
 
20
20
  # An icon is a small rectangular bitmap usually used for denoting a minimized application.
21
+ #
21
22
  # It differs from a {Wx::Bitmap} in always having a mask associated with it for transparent drawing. On some platforms, icons and bitmaps are implemented identically, since there is no real distinction between a {Wx::Bitmap} with a mask and an icon; and there is no specific icon format on some platforms (X-based applications usually standardize on XPMs for small bitmaps and icons). However, some platforms (such as Windows) make the distinction, so a separate class is provided.
22
23
  #
23
24
  # <div class="wxrb-remark">
24
25
  # <b>Remark:</b>
25
26
  # <p>It is usually desirable to associate a pertinent icon with a frame. Icons can also be used for other purposes, for example with {Wx::TreeCtrl} and {Wx::ListCtrl}. Icons have different formats on different platforms therefore separate icons will usually be created for the different environments. Platform-specific methods for creating a {Wx::Icon} structure are catered for, and this is an occasion where conditional compilation will probably be required. Note that a new icon must be created for every time the icon is to be used for a new window. In Windows, the icon will not be reloaded if it has already been used. An icon allocated to a frame will be deleted when the frame is deleted. For more information please see Bitmaps and Icons.
26
27
  # </p>
27
- # </div>>
28
+ # </div>
28
29
  #
29
30
  # Category: Graphics Device Interface (GDI)
30
31
  # Predefined objects/pointers: {Wx::NULL_ICON}
@@ -41,6 +42,7 @@ module Wx
41
42
 
42
43
  # @overload initialize()
43
44
  # Default ctor.
45
+ #
44
46
  # Constructs an icon object with no data; an assignment or another member function such as {Wx::Icon#load_file} must be called subsequently.
45
47
  # @return [Wx::Icon]
46
48
  # @overload initialize(icon)
@@ -50,6 +52,7 @@ module Wx
50
52
  # @overload initialize(name, type=Wx::ICON_DEFAULT_TYPE, desiredWidth=-1, desiredHeight=-1)
51
53
  # Loads an icon from a file or resource.
52
54
  #
55
+ #
53
56
  # @see Wx::Icon#load_file
54
57
  # @param name [String] This can refer to a resource name or a filename under MS Windows and X. Its meaning is determined by the type parameter.
55
58
  # @param type [Wx::BitmapType] May be one of the {Wx::BitmapType} values and indicates which type of bitmap should be loaded. See the note in the class detailed description. Note that the {Wx::ICON_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the {Wx::icon.h} header for the value it takes for a specific port.
@@ -63,6 +66,7 @@ module Wx
63
66
  def initialize(*args) end
64
67
 
65
68
  # Copies bmp bitmap to this icon.
69
+ #
66
70
  # Under MS Windows the bitmap must have mask colour set.
67
71
  # @see Wx::Icon#load_file
68
72
  # @param bmp [Wx::Bitmap]
@@ -70,6 +74,7 @@ module Wx
70
74
  def copy_from_bitmap(bmp) end
71
75
 
72
76
  # Gets the colour depth of the icon.
77
+ #
73
78
  # A value of 1 indicates a monochrome icon.
74
79
  # @return [Integer]
75
80
  def get_depth; end
@@ -77,6 +82,7 @@ module Wx
77
82
 
78
83
  # Gets the height of the icon in physical pixels.
79
84
  #
85
+ #
80
86
  # @see Wx::Icon#get_width
81
87
  # @see Wx::Icon#get_logical_height
82
88
  # @return [Integer]
@@ -84,24 +90,28 @@ module Wx
84
90
  alias_method :height, :get_height
85
91
 
86
92
  # Gets the height of the icon in logical pixels.
93
+ #
87
94
  # See {Wx::Bitmap#get_logical_height}.
88
95
  # @return [Float]
89
96
  def get_logical_height; end
90
97
  alias_method :logical_height, :get_logical_height
91
98
 
92
99
  # Gets the size of the icon in logical pixels.
100
+ #
93
101
  # See {Wx::Bitmap#get_logical_size}.
94
102
  # @return [Wx::Size]
95
103
  def get_logical_size; end
96
104
  alias_method :logical_size, :get_logical_size
97
105
 
98
106
  # Gets the width of the icon in logical pixels.
107
+ #
99
108
  # See {Wx::Bitmap#get_logical_width}.
100
109
  # @return [Float]
101
110
  def get_logical_width; end
102
111
  alias_method :logical_width, :get_logical_width
103
112
 
104
113
  # Gets the scale factor of this icon.
114
+ #
105
115
  # See {Wx::Bitmap#get_scale_factor}.
106
116
  # @return [Float]
107
117
  def get_scale_factor; end
@@ -109,6 +119,7 @@ module Wx
109
119
 
110
120
  # Gets the size of the icon in physical pixels.
111
121
  #
122
+ #
112
123
  # @see Wx::Icon#get_logical_size
113
124
  # @return [Wx::Size]
114
125
  def get_size; end
@@ -116,6 +127,7 @@ module Wx
116
127
 
117
128
  # Gets the width of the icon in physical pixels.
118
129
  #
130
+ #
119
131
  # @see Wx::Icon#get_height
120
132
  # @see Wx::Icon#get_logical_width
121
133
  # @return [Integer]
@@ -128,6 +140,7 @@ module Wx
128
140
  alias_method :ok?, :is_ok
129
141
 
130
142
  # Loads an icon from a file or resource.
143
+ #
131
144
  # true if the operation succeeded, false otherwise.
132
145
  # @param name [String] Either a filename or a Windows resource name. The meaning of name is determined by the type parameter.
133
146
  # @param type [Wx::BitmapType] One of the {Wx::BitmapType} values; see the note in the class detailed description. Note that the {Wx::ICON_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the {Wx::icon.h} header for the value it takes for a specific port.
@@ -139,6 +152,7 @@ module Wx
139
152
  end # Icon
140
153
 
141
154
  # This class contains multiple copies of an icon in different sizes.
155
+ #
142
156
  # It is typically used in {Wx::Dialog#set_icons} and {Wx::TopLevelWindow#set_icons}.
143
157
  #
144
158
  # Category: Graphics Device Interface (GDI)
@@ -170,6 +184,7 @@ module Wx
170
184
  # @return [Wx::IconBundle]
171
185
  # @overload initialize(stream, type=Wx::BitmapType::BITMAP_TYPE_ANY)
172
186
  # Initializes the bundle with the icon(s) found in the stream.
187
+ #
173
188
  # Notice that the stream must be seekable, at least if it contains more than one icon. The stream pointer is positioned after the last icon read from the stream when this function returns.
174
189
  # @param stream [IO,Wx::InputStream]
175
190
  # @param type [Wx::BitmapType]
@@ -191,6 +206,7 @@ module Wx
191
206
  # @return [void]
192
207
  # @overload add_icon(stream, type=Wx::BitmapType::BITMAP_TYPE_ANY)
193
208
  # Adds all the icons contained in the stream to the bundle; if the collection already contains icons with the same width and height, they are replaced by the new ones.
209
+ #
194
210
  # Notice that, as well as in the constructor loading the icon bundle from stream, the stream must be seekable, at least if more than one icon is to be loaded from it.
195
211
  # @param stream [IO,Wx::InputStream]
196
212
  # @param type [Wx::BitmapType]
@@ -203,6 +219,7 @@ module Wx
203
219
 
204
220
  # @overload get_icon(size, flags=Wx::IconBundle::FALLBACK_SYSTEM)
205
221
  # Returns the icon with the given size.
222
+ #
206
223
  # If size is {Wx::DEFAULT_SIZE}, it is interpreted as the standard system icon size, i.e. the size returned by {Wx::SystemSettings.get_metric} for {Wx::SystemMetric::SYS_ICON_X} and {Wx::SystemMetric::SYS_ICON_Y}.
207
224
  # If the bundle contains an icon with exactly the requested size, it's always returned. Otherwise, the behaviour depends on the flags. If only {Wx::IconBundle::FALLBACK_NONE} is given, the function returns an invalid icon. If {Wx::IconBundle::FALLBACK_SYSTEM} is given, it tries to find the icon of standard system size, regardless of the size passed as parameter. Otherwise, or if the icon system size is not found either, but {Wx::IconBundle::FALLBACK_NEAREST_LARGER} flag is specified, the function returns the smallest icon of the size larger than the requested one or, if this fails too, just the icon closest to the specified size.
208
225
  # The flags parameter is available only since wxWidgets 2.9.4.
@@ -211,6 +228,7 @@ module Wx
211
228
  # @return [Wx::Icon]
212
229
  # @overload get_icon(size=Wx::DEFAULT_COORD, flags=Wx::IconBundle::FALLBACK_SYSTEM)
213
230
  # Same as.
231
+ #
214
232
  # ```
215
233
  # GetIcon( wxSize( size, size ) )
216
234
  # ```
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # {Wx::IconLocation} is a tiny class describing the location of an (external, i.e.
10
+ #
10
11
  # not embedded into the application resources) icon. For most platforms it simply contains the file name but under some others (notably Windows) the same file may contain multiple icons and so this class also stores the index of the icon inside the file.
11
12
  # In any case, its details should be of no interest to the application code and most of them are not even documented here (on purpose) as it is only meant to be used as an opaque class: the application may get the object of this class from somewhere and the only reasonable thing to do with it later is to create a {Wx::Icon} from it.
12
13
  #
@@ -246,6 +246,7 @@ module Wx
246
246
  NULL_IMAGE = nil
247
247
 
248
248
  # This class encapsulates a platform-independent image.
249
+ #
249
250
  # An image can be created from data, or using {Wx::Bitmap#convert_to_image}. An image can be loaded from a file in a variety of formats, and is extensible to new formats via image format handlers. Functions are available to set and get image bits, so it can be used for basic image manipulation.
250
251
  # A {Wx::Image} cannot (currently) be drawn directly to a {Wx::DC}. Instead, a platform-specific {Wx::Bitmap} object must be created from it using the {Wx::Bitmap#initialize(wxImage,depth)} constructor. This bitmap can then be drawn in a device context, using {Wx::DC#draw_bitmap}.
251
252
  # More on the difference between {Wx::Image} and {Wx::Bitmap}: {Wx::Image} is just a buffer of RGB bytes with an optional buffer for the alpha bytes. It is all generic, platform independent and image file format independent code. It includes generic code for scaling, resizing, clipping, and other manipulations of the image data. OTOH, {Wx::Bitmap} is intended to be a wrapper of whatever is the native image format that is quickest/easiest to draw to a DC or to be the target of the drawing operations performed on a {Wx::MemoryDC}. By splitting the responsibilities between {Wx::Image}/{Wx::Bitmap} like this then it's easier to use generic code shared by all platforms and image types for generic operations and platform specific code where performance or compatibility is needed.
@@ -295,6 +296,7 @@ module Wx
295
296
 
296
297
  # @overload create(width, height, clear=true)
297
298
  # Creates a fresh image.
299
+ #
298
300
  # See {Wx::Image#initialize(int,int,bool)} for more info.
299
301
  # true if the call succeeded, false otherwise.
300
302
  # @param width [Integer]
@@ -308,6 +310,7 @@ module Wx
308
310
  # @return [Boolean]
309
311
  # @overload create(width, height, data)
310
312
  # Creates a fresh image.
313
+ #
311
314
  # See wxImage::wxImage(int,int,unsigned char*,bool) for more info.
312
315
  # true if the call succeeded, false otherwise.
313
316
  # @param width [Integer]
@@ -321,6 +324,7 @@ module Wx
321
324
  # @return [Boolean]
322
325
  # @overload create(width, height, data, alpha)
323
326
  # Creates a fresh image.
327
+ #
324
328
  # See wxImage::wxImage(int,int,unsigned char*,unsigned char*,bool) for more info.
325
329
  # true if the call succeeded, false otherwise.
326
330
  # @param width [Integer]
@@ -346,11 +350,13 @@ module Wx
346
350
  def destroy; end
347
351
 
348
352
  # Initializes the image alpha channel data.
353
+ #
349
354
  # It is an error to call it if the image already has alpha data. If it doesn't, alpha data will be by default initialized to all pixels being fully opaque. But if the image has a mask colour, all mask pixels will be completely transparent.
350
355
  # @return [void]
351
356
  def init_alpha; end
352
357
 
353
358
  # Blurs the image in both horizontal and vertical directions by the specified pixel blurRadius.
359
+ #
354
360
  # This should not be used when using a single mask colour for transparency.
355
361
  # @see Wx::Image#blur_horizontal
356
362
  # @see Wx::Image#blur_vertical
@@ -359,6 +365,7 @@ module Wx
359
365
  def blur(blurRadius) end
360
366
 
361
367
  # Blurs the image in the horizontal direction only.
368
+ #
362
369
  # This should not be used when using a single mask colour for transparency.
363
370
  # @see Wx::Image#blur
364
371
  # @see Wx::Image#blur_vertical
@@ -367,6 +374,7 @@ module Wx
367
374
  def blur_horizontal(blurRadius) end
368
375
 
369
376
  # Blurs the image in the vertical direction only.
377
+ #
370
378
  # This should not be used when using a single mask colour for transparency.
371
379
  # @see Wx::Image#blur
372
380
  # @see Wx::Image#blur_horizontal
@@ -375,12 +383,14 @@ module Wx
375
383
  def blur_vertical(blurRadius) end
376
384
 
377
385
  # Returns a mirrored copy of the image.
386
+ #
378
387
  # The parameter horizontally indicates the orientation.
379
388
  # @param horizontally [Boolean]
380
389
  # @return [Wx::Image]
381
390
  def mirror(horizontally=true) end
382
391
 
383
392
  # Copy the data of the given image to the specified position in this image.
393
+ #
384
394
  # Takes care of the mask colour and out of bounds problems.
385
395
  # @param image [Wx::Image] The image containing the data to copy, must be valid.
386
396
  # @param x [Integer] The horizontal position of the position to copy the data to.
@@ -400,6 +410,7 @@ module Wx
400
410
  def replace(r1, g1, b1, r2, g2, b2) end
401
411
 
402
412
  # Changes the size of the image in-place by scaling it: after a call to this function,the image will have the given width and height.
413
+ #
403
414
  # For a description of the quality parameter, see the {Wx::Image#scale} function. Returns the (modified) image itself.
404
415
  # @see Wx::Image#scale
405
416
  # @param width [Integer]
@@ -409,6 +420,7 @@ module Wx
409
420
  def rescale(width, height, quality=Wx::ImageResizeQuality::IMAGE_QUALITY_NORMAL) end
410
421
 
411
422
  # Changes the size of the image in-place without scaling it by adding either a border with the given colour or cropping as necessary.
423
+ #
412
424
  # The image is pasted into a new image with the given size and background colour at the position pos relative to the upper left of the new image.
413
425
  # If red = green = blue = -1 then use either the current mask colour if set or find, use, and set a suitable mask colour for any newly exposed areas.
414
426
  # The (modified) image itself.
@@ -422,6 +434,7 @@ module Wx
422
434
  def resize(size, pos, red=-1, green=-1, blue=-1) end
423
435
 
424
436
  # Rotates the image about the given point, by angle radians.
437
+ #
425
438
  # Passing true to interpolating results in better image quality, but is slower.
426
439
  # If the image has a mask, then the mask colour is used for the uncovered pixels in the rotated image background. Else, black (rgb 0, 0, 0) will be used.
427
440
  # Returns the rotated image, leaving this image intact.
@@ -447,18 +460,21 @@ module Wx
447
460
  def rotate_hue(angle) end
448
461
 
449
462
  # Changes the saturation of each pixel in the image.
463
+ #
450
464
  # factor is a double in the range [-1.0..+1.0], where -1.0 corresponds to -100 percent and +1.0 corresponds to +100 percent.
451
465
  # @param factor [Float]
452
466
  # @return [void]
453
467
  def change_saturation(factor) end
454
468
 
455
469
  # Changes the brightness (value) of each pixel in the image.
470
+ #
456
471
  # factor is a double in the range [-1.0..+1.0], where -1.0 corresponds to -100 percent and +1.0 corresponds to +100 percent.
457
472
  # @param factor [Float]
458
473
  # @return [void]
459
474
  def change_brightness(factor) end
460
475
 
461
476
  # Changes the hue, the saturation and the brightness (value) of each pixel in the image.
477
+ #
462
478
  # angleH is a double in the range [-1.0..+1.0], where -1.0 corresponds to -360 degrees and +1.0 corresponds to +360 degrees, factorS is a double in the range [-1.0..+1.0], where -1.0 corresponds to -100 percent and +1.0 corresponds to +100 percent and factorV is a double in the range [-1.0..+1.0], where -1.0 corresponds to -100 percent and +1.0 corresponds to +100 percent.
463
479
  # @param angleH [Float]
464
480
  # @param factorS [Float]
@@ -467,6 +483,7 @@ module Wx
467
483
  def change_hsv(angleH, factorS, factorV) end
468
484
 
469
485
  # Returns a scaled version of the image.
486
+ #
470
487
  # This is also useful for scaling bitmaps in general as the only other way to scale bitmaps is to blit a {Wx::MemoryDC} into another {Wx::MemoryDC}.
471
488
  # The parameter quality determines what method to use for resampling the image, see {Wx::ImageResizeQuality} documentation.
472
489
  # It should be noted that although using {Wx::ImageResizeQuality::IMAGE_QUALITY_HIGH} produces much nicer looking results it is a slower method. Downsampling will use the box averaging method which seems to operate very fast. If you are upsampling larger images using this method you will most likely notice that it is a bit slower and in extreme cases it will be quite substantially slower as the bicubic algorithm has to process a lot of data.
@@ -500,6 +517,7 @@ module Wx
500
517
  def scale(width, height, quality=Wx::ImageResizeQuality::IMAGE_QUALITY_NORMAL) end
501
518
 
502
519
  # Returns a resized version of this image without scaling it by adding either a border with the given colour or cropping as necessary.
520
+ #
503
521
  # The image is pasted into a new image with the given size and background colour at the position pos relative to the upper left of the new image.
504
522
  # If red = green = blue = -1 then the areas of the larger image not covered by this image are made transparent by filling them with the image mask colour (which will be allocated automatically if it isn't currently set).
505
523
  # Otherwise, the areas will be filled with the colour with the specified RGB components.
@@ -514,6 +532,7 @@ module Wx
514
532
 
515
533
  # @overload convert_alpha_to_mask(threshold=Wx::IMAGE_ALPHA_THRESHOLD)
516
534
  # If the image has alpha channel, this method converts it to mask.
535
+ #
517
536
  # If the image has an alpha channel, all pixels with alpha value less than threshold are replaced with the mask colour and the alpha channel is removed. Otherwise nothing is done.
518
537
  # The mask colour is chosen automatically using {Wx::Image#find_first_unused_colour}, see the overload below if this is not appropriate.
519
538
  # Returns true on success, false on error.
@@ -521,6 +540,7 @@ module Wx
521
540
  # @return [Boolean]
522
541
  # @overload convert_alpha_to_mask(mr, mg, mb, threshold=Wx::IMAGE_ALPHA_THRESHOLD)
523
542
  # If the image has alpha channel, this method converts it to mask using the specified colour as the mask colour.
543
+ #
524
544
  # If the image has an alpha channel, all pixels with alpha value less than threshold are replaced with the mask colour and the alpha channel is removed. Otherwise nothing is done.
525
545
  #
526
546
  # Returns true on success, false on error.
@@ -533,13 +553,14 @@ module Wx
533
553
 
534
554
  # @overload convert_to_greyscale(weight_r, weight_g, weight_b)
535
555
  # Returns a greyscale version of the image.
556
+ #
536
557
  # The returned image uses the luminance component of the original to calculate the greyscale. Defaults to using the standard ITU-T BT.601 when converting to YUV, where every pixel equals (R * weight_r) + (G * weight_g) + (B * weight_b).
537
558
  #
538
559
  # <div class="wxrb-remark">
539
560
  # <b>Remark:</b>
540
561
  # <p>This function calls {Wx::Colour.make_grey} for each pixel in the image.
541
562
  # </p>
542
- # </div>>
563
+ # </div>
543
564
  # @param weight_r [Float]
544
565
  # @param weight_g [Float]
545
566
  # @param weight_b [Float]
@@ -550,13 +571,14 @@ module Wx
550
571
  def convert_to_greyscale(*args) end
551
572
 
552
573
  # Returns monochromatic version of the image.
574
+ #
553
575
  # The returned image has white colour where the original has (r,g,b) colour and black colour everywhere else.
554
576
  #
555
577
  # <div class="wxrb-remark">
556
578
  # <b>Remark:</b>
557
579
  # <p>This function calls {Wx::Colour.make_mono} for each pixel in the image.
558
580
  # </p>
559
- # </div>>
581
+ # </div>
560
582
  # @param r [Integer]
561
583
  # @param g [Integer]
562
584
  # @param b [Integer]
@@ -564,28 +586,31 @@ module Wx
564
586
  def convert_to_mono(r, g, b) end
565
587
 
566
588
  # Returns disabled (dimmed) version of the image.
589
+ #
567
590
  # <div class="wxrb-remark">
568
591
  # <b>Remark:</b>
569
592
  # <p>This function calls {Wx::Colour#make_disabled} for each pixel in the image.
570
593
  # </p>
571
- # </div>>
594
+ # </div>
572
595
  # @param brightness [Integer]
573
596
  # @return [Wx::Image]
574
597
  def convert_to_disabled(brightness=255) end
575
598
 
576
599
  # Returns a changed version of the image based on the given lightness.
600
+ #
577
601
  # This utility function simply darkens or lightens a color, based on the specified percentage ialpha. ialpha of 0 would make the color completely black, 200 completely white and 100 would not change the color.
578
602
  #
579
603
  # <div class="wxrb-remark">
580
604
  # <b>Remark:</b>
581
605
  # <p>This function calls {Wx::Colour#change_lightness} for each pixel in the image.
582
606
  # </p>
583
- # </div>>
607
+ # </div>
584
608
  # @param alpha [Integer]
585
609
  # @return [Wx::Image]
586
610
  def change_lightness(alpha) end
587
611
 
588
612
  # Finds the first colour that is never used in the image.
613
+ #
589
614
  # The search begins at given initial colour and continues by increasing R, G and B components (in this order) by 1 until an unused colour is found or the colour space exhausted.
590
615
  # The parameters r, g, b are pointers to variables to save the colour.
591
616
  # The parameters startR, startG, startB define the initial values of the colour. The returned colour will have RGB values equal to or greater than these.
@@ -640,6 +665,7 @@ module Wx
640
665
 
641
666
  # Gets the width of the image in pixels.
642
667
  #
668
+ #
643
669
  # @see Wx::Image#get_height
644
670
  # @see Wx::Image#get_size
645
671
  # @return [Integer]
@@ -648,6 +674,7 @@ module Wx
648
674
 
649
675
  # Gets the height of the image in pixels.
650
676
  #
677
+ #
651
678
  # @see Wx::Image#get_width
652
679
  # @see Wx::Image#get_size
653
680
  # @return [Integer]
@@ -656,12 +683,14 @@ module Wx
656
683
 
657
684
  # Returns the size of the image in pixels.
658
685
  #
686
+ #
659
687
  # @see Wx::Image#get_height
660
688
  # @see Wx::Image#get_width
661
689
  # @return [Wx::Size]
662
690
  def get_size; end
663
691
 
664
692
  # Gets a user-defined string-valued option.
693
+ #
665
694
  # Generic options:
666
695
  #
667
696
  # - {Wx::IMAGE_OPTION_FILENAME}: The name of the file from which the image was loaded.
@@ -680,6 +709,7 @@ module Wx
680
709
  alias_method :option, :get_option
681
710
 
682
711
  # Gets a user-defined integer-valued option.
712
+ #
683
713
  # The function is case-insensitive to name. If the given option is not present, the function returns 0. Use {Wx::Image#has_option} if 0 is a possibly valid value for the option.
684
714
  # Generic options:
685
715
  #
@@ -738,12 +768,14 @@ module Wx
738
768
  alias_method :option_int, :get_option_int
739
769
 
740
770
  # Get the current mask colour or find a suitable unused colour that could be used as a mask colour.
771
+ #
741
772
  # Returns true if the image currently has a mask.
742
773
  # @return [Array(Boolean,Integer,Integer,Integer)]
743
774
  def get_or_find_mask_colour; end
744
775
  alias_method :or_find_mask_colour, :get_or_find_mask_colour
745
776
 
746
777
  # Returns the palette associated with the image.
778
+ #
747
779
  # Currently the palette is only used when converting to {Wx::Bitmap} under Windows.
748
780
  # Some of the {Wx::Image} handlers have been modified to set the palette if one exists in the image file (usually 256 or less colour images in GIF or PNG format).
749
781
  # @return [Wx::Palette]
@@ -763,6 +795,7 @@ module Wx
763
795
 
764
796
  # Returns true if this image has alpha channel, false otherwise.
765
797
  #
798
+ #
766
799
  # @see Wx::Image#get_alpha
767
800
  # @see Wx::Image#set_alpha
768
801
  # @return [Boolean]
@@ -775,6 +808,7 @@ module Wx
775
808
  alias_method :has_mask?, :has_mask
776
809
 
777
810
  # Returns true if the given option is present.
811
+ #
778
812
  # The function is case-insensitive to name.
779
813
  # The lists of the currently supported options are in {Wx::Image#get_option} and {Wx::Image#get_option_int} function docs.
780
814
  # @see Wx::Image#set_option
@@ -800,6 +834,7 @@ module Wx
800
834
 
801
835
  # @overload load_stream(stream, type=Wx::BitmapType::BITMAP_TYPE_ANY, index=-1)
802
836
  # Loads an image from an input stream.
837
+ #
803
838
  # If the file can't be loaded, this function returns false and logs an error using {log_error}. If the file can be loaded but some problems were detected while doing it, it can also call {log_warning} to notify about these problems. If this is undesirable, use {Wx::Image#set_load_flags} to reset Load_Verbose flag and suppress these warnings.
804
839
  #
805
840
  # true if the operation succeeded, false otherwise. If the optional index parameter is out of range, false is returned and a call to {log_error} takes place.
@@ -808,7 +843,7 @@ module Wx
808
843
  # <b>Remark:</b>
809
844
  # <p>Depending on how wxWidgets has been configured, not all formats may be available.
810
845
  # </p>
811
- # </div>>
846
+ # </div>
812
847
  #
813
848
  # <div class="wxrb-note">
814
849
  # <b>Note:</b>
@@ -861,6 +896,7 @@ module Wx
861
896
 
862
897
  # @overload load_file(name, type=Wx::BitmapType::BITMAP_TYPE_ANY, index=-1)
863
898
  # Loads an image from a file.
899
+ #
864
900
  # If no handler type is provided, the library will try to autodetect the format.
865
901
  # @param name [String] Name of the file from which to load the image.
866
902
  # @param type [Wx::BitmapType] See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
@@ -868,6 +904,7 @@ module Wx
868
904
  # @return [Boolean]
869
905
  # @overload load_file(name, mimetype, index=-1)
870
906
  # Loads an image from a file.
907
+ #
871
908
  # If no handler type is provided, the library will try to autodetect the format.
872
909
  # @param name [String] Name of the file from which to load the image.
873
910
  # @param mimetype [String] MIME type string (for example 'image/jpeg')
@@ -877,13 +914,14 @@ module Wx
877
914
 
878
915
  # @overload write(stream, mimetype)
879
916
  # Saves an image in the given stream.
917
+ #
880
918
  # true if the operation succeeded, false otherwise.
881
919
  #
882
920
  # <div class="wxrb-remark">
883
921
  # <b>Remark:</b>
884
922
  # <p>Depending on how wxWidgets has been configured, not all formats may be available.
885
923
  # </p>
886
- # </div>>
924
+ # </div>
887
925
  #
888
926
  # <div class="wxrb-note">
889
927
  # <b>Note:</b>
@@ -936,29 +974,31 @@ module Wx
936
974
  # @return [Boolean]
937
975
  # @overload save_file(name)
938
976
  # Saves an image in the named file.
977
+ #
939
978
  # File type is determined from the extension of the file name. Note that this function may fail if the extension is not recognized! You can use one of the forms above to save images to files with non-standard extensions.
940
979
  # @param name [String] Name of the file to save the image to.
941
980
  # @return [Boolean]
942
981
  def save_file(*args) end
943
982
 
944
983
  # This function is similar to {Wx::Image#set_data} and has similar restrictions.
984
+ #
945
985
  # The pointer passed to it may however be NULL in which case the function will allocate the alpha array internally this is useful to add alpha channel data to an image which doesn't have any.
946
986
  # If the pointer is not NULL, it must have one byte for each image pixel and be allocated with malloc(). {Wx::Image} takes ownership of the pointer and will free it unless static_data parameter is set to true in this case the caller should do it.
947
987
  # @param alpha [String]
948
988
  # @return [void]
949
989
  def set_alpha_data(alpha=nil) end
950
- alias_method :alpha_data=, :set_alpha_data
951
990
 
952
991
  # Sets the alpha value for the given pixel.
992
+ #
953
993
  # This function should only be called if the image has alpha channel data, use {Wx::Image#has_alpha} to check for this.
954
994
  # @param x [Integer]
955
995
  # @param y [Integer]
956
996
  # @param alpha [Integer]
957
997
  # @return [void]
958
998
  def set_alpha(x, y, alpha) end
959
- alias_method :alpha=, :set_alpha
960
999
 
961
1000
  # Removes the alpha channel from the image.
1001
+ #
962
1002
  # This function should only be called if the image has alpha channel data, use {Wx::Image#has_alpha} to check for this.
963
1003
  # @return [void]
964
1004
  def clear_alpha; end
@@ -969,9 +1009,9 @@ module Wx
969
1009
  # @param new_height [Integer]
970
1010
  # @return [void]
971
1011
  def set_rgb_data_with_size(data, new_width, new_height) end
972
- alias_method :rgb_data_with_size=, :set_rgb_data_with_size
973
1012
 
974
1013
  # Sets the flags used for loading image files by this object.
1014
+ #
975
1015
  # The flags will affect any future calls to {Wx::Image#load_file} for this object. To change the flags for all image objects, call {Wx::Image.set_default_load_flags} before creating any of them.
976
1016
  # Currently the only defined flag is Load_Verbose which determines if the non-fatal (i.e. not preventing the file from being loaded completely) problems should result in the calls to {log_warning} function. It is recommended to customize handling of these warnings by e.g. defining a custom log target (see Logging Overview), but if such warnings should be completely suppressed, clearing this flag provides a simple way to do it, for example:
977
1017
  # ```ruby
@@ -988,6 +1028,7 @@ module Wx
988
1028
  alias_method :load_flags=, :set_load_flags
989
1029
 
990
1030
  # Specifies whether there is a mask or not.
1031
+ #
991
1032
  # The area of the mask is determined by the current mask colour.
992
1033
  # @param hasMask [Boolean]
993
1034
  # @return [void]
@@ -1002,6 +1043,7 @@ module Wx
1002
1043
  def set_mask_colour(red, green, blue) end
1003
1044
 
1004
1045
  # Sets image's mask so that the pixels that have RGB value of mr,mg,mb in mask will be masked in the image.
1046
+ #
1005
1047
  # This is done by first finding an unused colour in the image, setting this colour as the mask colour and then using this colour to draw all pixels in the image who corresponding pixel in mask has given RGB value.
1006
1048
  # The parameter mask is the mask image to extract mask shape from. It must have the same dimensions as the image.
1007
1049
  # The parameters mr, mg, mb are the RGB values of the pixels in mask that will be used to create the mask.
@@ -1021,6 +1063,7 @@ module Wx
1021
1063
 
1022
1064
  # @overload set_option(name, value)
1023
1065
  # Sets a user-defined option.
1066
+ #
1024
1067
  # The function is case-insensitive to name.
1025
1068
  # For example, when saving as a JPEG file, the option <b>quality</b> is used, which is a number between 0 and 100 (0 is terrible, 100 is very good).
1026
1069
  # The lists of the currently supported options are in {Wx::Image#get_option} and {Wx::Image#get_option_int} function docs.
@@ -1038,6 +1081,7 @@ module Wx
1038
1081
  def set_option(*args) end
1039
1082
 
1040
1083
  # Associates a palette with the image.
1084
+ #
1041
1085
  # The palette may be used when converting {Wx::Image} to {Wx::Bitmap} (MSW only at present) or in file save operations (none as yet).
1042
1086
  # @param palette [Wx::Palette]
1043
1087
  # @return [void]
@@ -1054,6 +1098,7 @@ module Wx
1054
1098
  # @return [void]
1055
1099
  # @overload set_rgb(rect, red, green, blue)
1056
1100
  # Sets the colour of the pixels within the given rectangle.
1101
+ #
1057
1102
  # This routine performs bounds-checks for the coordinate so it can be considered a safe way to manipulate the data.
1058
1103
  # @param rect [Wx::Rect]
1059
1104
  # @param red [Integer]
@@ -1063,6 +1108,7 @@ module Wx
1063
1108
  def set_rgb(*args) end
1064
1109
 
1065
1110
  # Set the type of image returned by {Wx::Image#get_type}.
1111
+ #
1066
1112
  # This method is mostly used internally by the library but can also be called from the user code if the image was created from data in the given bitmap format without using {Wx::Image#load_file} (which would set the type correctly automatically).
1067
1113
  # Notice that the image must be created before this function is called.
1068
1114
  # @param type [Wx::BitmapType] One of bitmap type constants, {Wx::BitmapType::BITMAP_TYPE_INVALID} is a valid value for it and can be used to reset the bitmap type to default but {Wx::BITMAP_TYPE_MAX} is not allowed here.
@@ -1071,6 +1117,7 @@ module Wx
1071
1117
  alias_method :type=, :set_type
1072
1118
 
1073
1119
  # Sets the default value for the flags used for loading image files.
1120
+ #
1074
1121
  # This method changes the global value of the flags used for all the subsequently created {Wx::Image} objects by default. It doesn't affect the already existing objects.
1075
1122
  # By default, the global flags include Load_Verbose flag value.
1076
1123
  # @see Wx::Image#load_file
@@ -1081,6 +1128,7 @@ module Wx
1081
1128
  def self.set_default_load_flags(flags) end
1082
1129
 
1083
1130
  # If the image file contains more than one image and the image handler is capable of retrieving these individually, this function will return the number of available images.
1131
+ #
1084
1132
  # For the overload taking the parameter filename, that's the name of the file to query. For the overload taking the parameter stream, that's the opened input stream with image data.
1085
1133
  # See Wx::ImageHandler#get_image_count for more info.
1086
1134
  # The parameter type may be one of the following values:
@@ -1122,6 +1170,7 @@ module Wx
1122
1170
  # @return [Wx::Image]
1123
1171
  # @overload initialize(width, height, clear=true)
1124
1172
  # Creates an image with the given size and clears it if requested.
1173
+ #
1125
1174
  # Does not create an alpha channel.
1126
1175
  # @param width [Integer] Specifies the width of the image.
1127
1176
  # @param height [Integer] Specifies the height of the image.
@@ -1134,6 +1183,7 @@ module Wx
1134
1183
  # @return [Wx::Image]
1135
1184
  # @overload initialize(width, height, data)
1136
1185
  # Creates an image from data in memory.
1186
+ #
1137
1187
  # If static_data is false then the {Wx::Image} will take ownership of the data and free it afterwards. For this, it has to be allocated with malloc.
1138
1188
  # @param width [Integer] Specifies the width of the image.
1139
1189
  # @param height [Integer] Specifies the height of the image.
@@ -1146,6 +1196,7 @@ module Wx
1146
1196
  # @return [Wx::Image]
1147
1197
  # @overload initialize(width, height, data, alpha)
1148
1198
  # Creates an image from data in memory.
1199
+ #
1149
1200
  # If static_data is false then the {Wx::Image} will take ownership of the data and free it afterwards. For this, it has to be allocated with malloc.
1150
1201
  # @param width [Integer] Specifies the width of the image.
1151
1202
  # @param height [Integer] Specifies the height of the image.
@@ -1160,11 +1211,12 @@ module Wx
1160
1211
  # @return [Wx::Image]
1161
1212
  # @overload initialize(name, type=Wx::BitmapType::BITMAP_TYPE_ANY, index=-1)
1162
1213
  # Creates an image from a file.
1214
+ #
1163
1215
  # <div class="wxrb-remark">
1164
1216
  # <b>Remark:</b>
1165
1217
  # <p>Depending on how wxWidgets has been configured and by which handlers have been loaded, not all formats may be available. Any handler other than BMP must be previously initialized with {Wx::Image.add_handler} or {init_all_image_handlers}.
1166
1218
  # </p>
1167
- # </div>>
1219
+ # </div>
1168
1220
  #
1169
1221
  # <div class="wxrb-note">
1170
1222
  # <b>Note:</b>
@@ -1216,6 +1268,7 @@ module Wx
1216
1268
  def initialize(*args) end
1217
1269
 
1218
1270
  # Returns the file load flags used for this object.
1271
+ #
1219
1272
  # See {Wx::Image#set_load_flags} for more information about these flags.
1220
1273
  # @return [Integer]
1221
1274
  def get_load_flags; end
@@ -1223,22 +1276,26 @@ module Wx
1223
1276
 
1224
1277
  # @overload self.can_read(filename)
1225
1278
  # Returns true if at least one of the available image handlers can read the file with the given name.
1279
+ #
1226
1280
  # See Wx::ImageHandler::CanRead for more info.
1227
1281
  # @param filename [String]
1228
1282
  # @return [Boolean]
1229
1283
  # @overload self.can_read(stream)
1230
1284
  # Returns true if at least one of the available image handlers can read the data in the given stream.
1285
+ #
1231
1286
  # See Wx::ImageHandler::CanRead for more info.
1232
1287
  # @param stream [IO,Wx::InputStream]
1233
1288
  # @return [Boolean]
1234
1289
  def self.can_read(*args) end
1235
1290
 
1236
1291
  # Returns the currently used default file load flags.
1292
+ #
1237
1293
  # See {Wx::Image.set_default_load_flags} for more information about these flags.
1238
1294
  # @return [Integer]
1239
1295
  def self.get_default_load_flags; end
1240
1296
 
1241
1297
  # Iterates all registered {Wx::ImageHandler} objects, and returns a string containing file extension masks suitable for passing to file open/save dialog boxes.
1298
+ #
1242
1299
  # The format of the returned string is <code>"(*.ext1;*.ext2)|*.ext1;*.ext2"</code>. It is usually a good idea to prepend a description before passing the result to the dialog. Example:
1243
1300
  # ```ruby
1244
1301
  # Wx::FileDialog(self, 'Choose Image', Dir.getwd, '',