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
@@ -132,13 +132,14 @@ module Wx::AUI
132
132
  EVT_AUITOOLBAR_BEGIN_DRAG = 10410
133
133
 
134
134
  # {Wx::AUI::AuiToolBarEvent} is used for the events generated by {Wx::AUI::AuiToolBar}.
135
+ #
135
136
  # Category: Window Docking (wxAUI), {Wx::Events}
136
137
  #
137
138
  # @wxrb_require USE_AUI
138
139
  class AuiToolBarEvent < NotifyEvent
139
140
 
140
141
  # @overload initialize(commandType=Wx::EVT_NULL, winId=0)
141
- # @param commandType [Wx::Slider::EventType]
142
+ # @param commandType [Wx::StaticLine::EventType]
142
143
  # @param winId [Integer]
143
144
  # @return [Wx::AUI::AuiToolBarEvent]
144
145
  # @overload initialize(c)
@@ -7,6 +7,7 @@
7
7
  module Wx::AUI
8
8
 
9
9
  # {Wx::AUI::AuiToolBarItem} is part of the {Wx::AUI} class framework, representing a toolbar element.
10
+ #
10
11
  # See also {Wx::AUI::AuiToolBar} and wxAUI Overview.
11
12
  # It has a unique id (except for the separators which always have id = -1), the style (telling whether it is a normal button, separator or a control), the state (toggled or not, enabled or not) and short and long help strings. The default implementations use the short help string for the tooltip text which is popped up when the mouse pointer enters the tool and the long help string for the applications status bar (currently not implemented).
12
13
  #
@@ -58,6 +59,7 @@ module Wx::AUI
58
59
  alias_method :kind=, :set_kind
59
60
 
60
61
  # Returns the toolbar item kind.
62
+ #
61
63
  # one of {Wx::ItemKind::ITEM_NORMAL}, {Wx::ItemKind::ITEM_CHECK} or {Wx::ItemKind::ITEM_RADIO}, {Wx::ItemKind::ITEM_SEPARATOR}, {Wx::ITEM_CONTROL}, {Wx::ITEM_SPACER}, {Wx::ITEM_LABEL},
62
64
  # @return [Integer]
63
65
  def get_kind; end
@@ -70,6 +72,7 @@ module Wx::AUI
70
72
  alias_method :state=, :set_state
71
73
 
72
74
  # Gets the current state of the toolbar item.
75
+ #
73
76
  # an or'd combination of flags from {Wx::AUI::AuiPaneButtonState} representing the current state
74
77
  # @return [Integer]
75
78
  def get_state; end
@@ -175,6 +178,7 @@ module Wx::AUI
175
178
  alias_method :active?, :is_active
176
179
 
177
180
  # Set whether this tool has a drop down button.
181
+ #
178
182
  # This is only valid for {Wx::ItemKind::ITEM_NORMAL} tools.
179
183
  # @param b [Boolean]
180
184
  # @return [void]
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # A simple banner window showing either a bitmap or text.
10
+ #
10
11
  # Banner windows can be used to present some overview of the current window contents to the user in an aesthetically pleasant way. They are typically positioned along the left or top edge of the window (although this class also supports right- and bottom-aligned banners) and show either a bitmap with a logo or a few lines of text on a gradient-filled background.
11
12
  # Using this class is very simple, e.g.:
12
13
  # ```
@@ -41,10 +42,12 @@ module Wx
41
42
 
42
43
  # @overload initialize()
43
44
  # Default constructor, use {Wx::BannerWindow#create} later.
45
+ #
44
46
  # This constructor is only used for two-step creation, if possible, prefer using the constructor below directly instead of using this one and calling {Wx::BannerWindow#create} later.
45
47
  # @return [Wx::BannerWindow]
46
48
  # @overload initialize(parent, winid, dir=Wx::Direction::LEFT, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::BANNER_WINDOW_NAME_STR)
47
49
  # Full constructor provided for consistency with the other classes only.
50
+ #
48
51
  # Prefer to use the shorter constructor documented above. You should rarely, if ever, need to use non-default values for any other parameters: as the banner window doesn't generate any events, its identifier is not particularly useful; its position and size will be almost always managed by the containing sizer and it doesn't have any specific styles. So only the parent and the banner direction need to be specified.
49
52
  # @param parent [Wx::Window]
50
53
  # @param winid [Integer]
@@ -57,6 +60,7 @@ module Wx
57
60
  def initialize(*args) end
58
61
 
59
62
  # Really create the banner window for the objects created using the default constructor.
63
+ #
60
64
  # It's an error to call {Wx::BannerWindow#create} for the objects created using non-default constructor.
61
65
  # @param parent [Wx::Window]
62
66
  # @param winid [Integer]
@@ -69,6 +73,7 @@ module Wx
69
73
  def create(parent, winid, dir=Wx::Direction::LEFT, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::BANNER_WINDOW_NAME_STR) end
70
74
 
71
75
  # Provide the bitmap to use as background.
76
+ #
72
77
  # Notice that ideally the bitmap should be big enough to always cover the entire banner, e.g. for a horizontal banner with {Wx::Direction::TOP} style its width should be bigger than any reasonable window size. Otherwise the bitmap is extended to cover the entire window area with a solid colour taken from the bitmap pixel on the edge in which direction the extension occurs so all bitmap pixels on this edge (top for {Wx::Direction::LEFT}, right for {Wx::Direction::TOP} and {Wx::Direction::BOTTOM} and bottom for {Wx::Direction::RIGHT}) should have the same colour to avoid jarring discontinuity.
73
78
  # If, on the other hand, the bitmap is bigger than the window size, then it is truncated. For {Wx::Direction::LEFT} orientation the bitmap is truncated from the top, for {Wx::Direction::TOP} and {Wx::Direction::BOTTOM} from the right and for {Wx::Direction::RIGHT} from the bottom, so put the most important part of the bitmap information in the opposite direction where it will never be truncated.
74
79
  # If no valid background bitmap is specified, the banner draws gradient background but if a valid bitmap is given here, the gradient is not draw and the start and end colours specified for it are ignored.
@@ -78,6 +83,7 @@ module Wx
78
83
  alias_method :bitmap=, :set_bitmap
79
84
 
80
85
  # Set the text to display.
86
+ #
81
87
  # This is mutually exclusive with {Wx::BannerWindow#set_bitmap}.
82
88
  # Title is rendered in bold and should be single line, message can have multiple lines but is not wrapped automatically, include explicit line breaks in the string if you want to have multiple lines.
83
89
  # @param title [String]
@@ -86,6 +92,7 @@ module Wx
86
92
  def set_text(title, message) end
87
93
 
88
94
  # Set the colours between which the gradient runs.
95
+ #
89
96
  # The gradient colours are ignored if {Wx::BannerWindow#set_bitmap} is used.
90
97
  # @param start [Wx::Colour,String,Symbol]
91
98
  # @param end_ [Wx::Colour,String,Symbol]
@@ -14,6 +14,7 @@ module Wx
14
14
  NULL_BITMAP = nil
15
15
 
16
16
  # This class encapsulates the concept of a platform-dependent bitmap, either monochrome or colour or colour with alpha channel support.
17
+ #
17
18
  # If you need direct access the bitmap data instead going through drawing to it using {Wx::MemoryDC} you need to use the {Wx::PixelData} class (either {Wx::NativePixelData} for RGB bitmaps or {Wx::AlphaPixelData} for bitmaps with an additionally alpha channel).
18
19
  # Note that many {Wx::Bitmap} functions take a type parameter, which is a value of the {Wx::BitmapType} enumeration. The validity of those values depends however on the platform where your program is running and from the wxWidgets configuration. If all possible wxWidgets settings are used:
19
20
  #
@@ -43,10 +44,12 @@ module Wx
43
44
 
44
45
  # @overload initialize()
45
46
  # Default constructor.
47
+ #
46
48
  # Constructs a bitmap object with no data; an assignment or another member function such as {Wx::Bitmap#create} or {Wx::Bitmap#load_file} must be called subsequently.
47
49
  # @return [Wx::Bitmap]
48
50
  # @overload initialize(bitmap)
49
51
  # Copy constructor, uses reference counting.
52
+ #
50
53
  # To make a real copy, you can use:
51
54
  # ```ruby
52
55
  # newBitmap = oldBitmap.get_sub_bitmap(
@@ -56,6 +59,7 @@ module Wx
56
59
  # @return [Wx::Bitmap]
57
60
  # @overload initialize(width, height, depth=Wx::BITMAP_SCREEN_DEPTH)
58
61
  # Creates a new bitmap.
62
+ #
59
63
  # A depth of {Wx::BITMAP_SCREEN_DEPTH} indicates the depth of the current screen or visual.
60
64
  # Some platforms only support 1 for monochrome and {Wx::BITMAP_SCREEN_DEPTH} for the current colour setting.
61
65
  # A depth of 32 including an alpha channel is supported under MSW, Mac and GTK+.
@@ -77,12 +81,14 @@ module Wx
77
81
  # @overload initialize(name, type=Wx::BITMAP_DEFAULT_TYPE)
78
82
  # Loads a bitmap from a file or resource.
79
83
  #
84
+ #
80
85
  # @see Wx::Bitmap#load_file
81
86
  # @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.
82
87
  # @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::BITMAP_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the bitmap.h header for the value it takes for a specific port.
83
88
  # @return [Wx::Bitmap]
84
89
  # @overload initialize(img, depth=Wx::BITMAP_SCREEN_DEPTH)
85
90
  # Creates this bitmap object from the given image.
91
+ #
86
92
  # This has to be done to actually display an image as you cannot draw an image directly on a window.
87
93
  # The resulting bitmap will use the provided colour depth (or that of the current system if depth is {Wx::BITMAP_SCREEN_DEPTH}) which entails that a colour reduction may take place.
88
94
  # On Windows, if there is a palette present (set with SetPalette), it will be used when creating the {Wx::Bitmap} (most useful in 8-bit display mode). On other platforms, the palette is currently ignored.
@@ -91,24 +97,28 @@ module Wx
91
97
  # @return [Wx::Bitmap]
92
98
  # @overload initialize(img, dc)
93
99
  # Creates a bitmap compatible with the given DC from the given image.
100
+ #
94
101
  # This constructor initializes the bitmap with the data of the given image, which must be valid, but inherits the scaling factor from the given device context instead of simply using the default factor of 1.
95
102
  # @param img [Wx::Image] Platform-independent {Wx::Image} object.
96
103
  # @param dc [Wx::DC] DC from which the scaling factor is inherited
97
104
  # @return [Wx::Bitmap]
98
105
  # @overload initialize(cursor)
99
106
  # Creates bitmap corresponding to the given cursor.
107
+ #
100
108
  # This can be useful to display a cursor as it cannot be drawn directly on a window.
101
109
  # @param cursor [Wx::Cursor] A valid {Wx::Cursor}.
102
110
  # @return [Wx::Bitmap]
103
111
  def initialize(*args) end
104
112
 
105
113
  # Returns disabled (dimmed) version of the bitmap.
114
+ #
106
115
  # This method is not available when <code>wxUSE_IMAGE == 0</code>.
107
116
  # @param brightness [Integer]
108
117
  # @return [Wx::Bitmap]
109
118
  def convert_to_disabled(brightness=255) end
110
119
 
111
120
  # Creates an image from a platform-dependent bitmap.
121
+ #
112
122
  # This preserves mask information so that bitmaps and images can be converted back and forth without loss in that respect.
113
123
  # @return [Wx::Image]
114
124
  def convert_to_image; end
@@ -120,6 +130,7 @@ module Wx
120
130
 
121
131
  # @overload create(width, height, depth=Wx::BITMAP_SCREEN_DEPTH)
122
132
  # Creates a fresh bitmap.
133
+ #
123
134
  # If the final argument is omitted, the display depth of the screen is used.
124
135
  #
125
136
  # true if the creation was successful.
@@ -134,6 +145,7 @@ module Wx
134
145
  # @return [Boolean]
135
146
  # @overload create(width, height, dc)
136
147
  # Create a bitmap compatible with the given DC, inheriting its magnification factor.
148
+ #
137
149
  # true if the creation was successful.
138
150
  # @param width [Integer] The width of the bitmap in pixels, must be strictly positive.
139
151
  # @param height [Integer] The height of the bitmap in pixels, must be strictly positive.
@@ -143,6 +155,7 @@ module Wx
143
155
 
144
156
  # @overload create_with_dip_size(size, scale, depth=Wx::BITMAP_SCREEN_DEPTH)
145
157
  # Create a bitmap specifying its size in DPI-independent pixels and the scale factor to use.
158
+ #
146
159
  # The physical size of the bitmap is obtained by multiplying the given size by scale and rounding it to the closest integer.
147
160
  # After using this function the following postconditions are true:
148
161
  #
@@ -165,6 +178,7 @@ module Wx
165
178
  def create_with_dip_size(*args) end
166
179
 
167
180
  # Create a bitmap with a scale factor.
181
+ #
168
182
  # This is an older synonym for {Wx::Bitmap#create_with_dip_size}, use the new function in the new code.
169
183
  #
170
184
  # true if the creation was successful.
@@ -176,12 +190,14 @@ module Wx
176
190
  def create_scaled(width, height, depth, logicalScale) end
177
191
 
178
192
  # Gets the colour depth of the bitmap.
193
+ #
179
194
  # A value of 1 indicates a monochrome bitmap.
180
195
  # @return [Integer]
181
196
  def get_depth; end
182
197
  alias_method :depth, :get_depth
183
198
 
184
199
  # Returns the size of bitmap in DPI-independent units.
200
+ #
185
201
  # This assumes that the bitmap was created using the value of scale factor corresponding to the current DPI (see {Wx::Bitmap#create_with_dip_size} and {Wx::Bitmap#set_scale_factor}) and returns its physical size divided by this scale factor.
186
202
  # Unlike {Wx::Bitmap#get_logical_size}, this function returns the same value under all platforms and so its result should not be used as window or device context coordinates.
187
203
  # @return [Wx::Size]
@@ -190,6 +206,7 @@ module Wx
190
206
 
191
207
  # Returns the height of the bitmap in physical pixels.
192
208
  #
209
+ #
193
210
  # @see Wx::Bitmap#get_width
194
211
  # @see Wx::Bitmap#get_size
195
212
  # @see Wx::Bitmap#get_logical_height
@@ -198,6 +215,7 @@ module Wx
198
215
  alias_method :height, :get_height
199
216
 
200
217
  # Returns the height of the bitmap in logical pixels.
218
+ #
201
219
  # See {Wx::Bitmap#get_logical_size} for more information.
202
220
  # @see Wx::Bitmap#get_logical_width
203
221
  # @see Wx::Bitmap#get_width
@@ -206,6 +224,7 @@ module Wx
206
224
  alias_method :logical_height, :get_logical_height
207
225
 
208
226
  # Returns the size of the bitmap in logical pixels.
227
+ #
209
228
  # For the platforms using DPI-independent pixels, i.e. those where {Wx::HAS_DPI_INDEPENDENT_PIXELS} is defined, such as WXOSX or WXGTK 3, this function returns the physical size of the bitmap, as returned by {Wx::Bitmap#get_size}, divided by its scale factor, as returned by {Wx::Bitmap#get_scale_factor}, while for the other platforms, it simply returns the same thing as {Wx::Bitmap#get_size}.
210
229
  # This ensures that the result of this function is always expressed in the pixel coordinates appropriate for the current platform, i.e. its return value is always in logical pixels, used for window and {Wx::DC} coordinates, whether these pixels are the same as physical pixels, which are returned by {Wx::Bitmap#get_size}, or not.
211
230
  # @see Wx::Bitmap#get_logical_width
@@ -216,6 +235,7 @@ module Wx
216
235
  alias_method :logical_size, :get_logical_size
217
236
 
218
237
  # Returns the width of the bitmap in logical pixels.
238
+ #
219
239
  # See {Wx::Bitmap#get_logical_size} for more information.
220
240
  # @see Wx::Bitmap#get_logical_height
221
241
  # @see Wx::Bitmap#get_width
@@ -225,6 +245,7 @@ module Wx
225
245
 
226
246
  # Gets the associated mask (if any) which may have been loaded from a file or set for the bitmap.
227
247
  #
248
+ #
228
249
  # @see Wx::Bitmap#set_mask
229
250
  # @see Wx::Mask
230
251
  # @return [Wx::Mask]
@@ -232,6 +253,7 @@ module Wx
232
253
  alias_method :mask, :get_mask
233
254
 
234
255
  # Returns a sub bitmap of the current one as long as the rect belongs entirely to the bitmap.
256
+ #
235
257
  # This function preserves bit depth and mask information.
236
258
  # @param rect [Wx::Rect]
237
259
  # @return [Wx::Bitmap]
@@ -239,6 +261,7 @@ module Wx
239
261
  alias_method :sub_bitmap, :get_sub_bitmap
240
262
 
241
263
  # Returns the scale factor of this bitmap.
264
+ #
242
265
  # Scale factor is 1 by default, but can be greater to indicate that the size of bitmap in logical, DPI-independent pixels is smaller than its actual size in physical pixels. Bitmaps with scale factor greater than 1 must be used in high DPI to appear sharp on the screen.
243
266
  # Note that the scale factor is only used in the ports where logical pixels are not the same as physical ones, such as WXOSX or WXGTK3, and this function always returns 1 under the other platforms.
244
267
  # @see Wx::Bitmap#set_scale_factor
@@ -250,24 +273,28 @@ module Wx
250
273
  alias_method :scale_factor, :get_scale_factor
251
274
 
252
275
  # Returns the height of the bitmap in logical pixels.
276
+ #
253
277
  # This is an older synonym for {Wx::Bitmap#get_logical_height}, use the new function in the new code.
254
278
  # @return [Float]
255
279
  def get_scaled_height; end
256
280
  alias_method :scaled_height, :get_scaled_height
257
281
 
258
282
  # Returns the size of the bitmap in logical pixels.
283
+ #
259
284
  # This is an older synonym for {Wx::Bitmap#get_logical_size}, use the new function in the new code.
260
285
  # @return [Wx::Size]
261
286
  def get_scaled_size; end
262
287
  alias_method :scaled_size, :get_scaled_size
263
288
 
264
289
  # Returns the width of the bitmap in logical pixels.
290
+ #
265
291
  # This is an older synonym for {Wx::Bitmap#get_logical_width}, use the new function in the new code.
266
292
  # @return [Float]
267
293
  def get_scaled_width; end
268
294
  alias_method :scaled_width, :get_scaled_width
269
295
 
270
296
  # Returns the size of the bitmap in physical pixels.
297
+ #
271
298
  # The return value of this function doesn't depend on the scale factor, it is always the physical size of the bitmap, i.e. corresponding to the actual number of pixels in it.
272
299
  # @see Wx::Bitmap#get_height
273
300
  # @see Wx::Bitmap#get_width
@@ -278,6 +305,7 @@ module Wx
278
305
 
279
306
  # Returns the width of the bitmap in physical pixels.
280
307
  #
308
+ #
281
309
  # @see Wx::Bitmap#get_height
282
310
  # @see Wx::Bitmap#get_size
283
311
  # @see Wx::Bitmap#get_logical_width
@@ -286,6 +314,7 @@ module Wx
286
314
  alias_method :width, :get_width
287
315
 
288
316
  # Returns true if the bitmap has an alpha channel.
317
+ #
289
318
  # Note that the fact that a bitmap has an alpha channel doesn't necessarily mean that it has any transparency, as all of its pixels could be using {Wx::ALPHA_OPAQUE} value. To actually examine the alpha values, the bitmap can be converted to {Wx::Image}.
290
319
  # @return [Boolean]
291
320
  def has_alpha; end
@@ -297,13 +326,14 @@ module Wx
297
326
  alias_method :ok?, :is_ok
298
327
 
299
328
  # Loads a bitmap from a file or resource.
329
+ #
300
330
  # true if the operation succeeded, false otherwise.
301
331
  #
302
332
  # <div class="wxrb-remark">
303
333
  # <b>Remark:</b>
304
334
  # <p>A palette may be associated with the bitmap if one exists (especially for colour Windows bitmaps), and if the code supports it. You can check if one has been created by using the {Wx::Bitmap#get_palette} member.
305
335
  # </p>
306
- # </div>>
336
+ # </div>
307
337
  # @see Wx::Bitmap#save_file
308
338
  # @param name [String] Either a filename or a Windows resource name. The meaning of name is determined by the type parameter.
309
339
  # @param type [Wx::BitmapType] One of the {Wx::BitmapType} values; see the note in the class detailed description. Note that the {Wx::BITMAP_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the bitmap.h header for the value it takes for a specific port.
@@ -311,18 +341,20 @@ module Wx
311
341
  def load_file(name, type=Wx::BITMAP_DEFAULT_TYPE) end
312
342
 
313
343
  # Remove alpha channel from the bitmap.
344
+ #
314
345
  # This is the same as calling {Wx::Bitmap#use_alpha} with false argument.
315
346
  # @return [void]
316
347
  def reset_alpha; end
317
348
 
318
349
  # Saves a bitmap in the named file.
350
+ #
319
351
  # true if the operation succeeded, false otherwise.
320
352
  #
321
353
  # <div class="wxrb-remark">
322
354
  # <b>Remark:</b>
323
355
  # <p>Depending on how wxWidgets has been configured, not all formats may be available.
324
356
  # </p>
325
- # </div>>
357
+ # </div>
326
358
  # @see Wx::Bitmap#load_file
327
359
  # @param name [String] A filename. The meaning of name is determined by the type parameter.
328
360
  # @param type [Wx::BitmapType] One of the {Wx::BitmapType} values; see the note in the class detailed description.
@@ -331,6 +363,7 @@ module Wx
331
363
  def save_file(name, type, palette=nil) end
332
364
 
333
365
  # Sets the bitmap scale factor.
366
+ #
334
367
  # This doesn't change the bitmap actual size or its contents, but changes its scale factor, so that it appears in a smaller size when it is drawn on screen: e.g. setting scale to 2 means that the bitmap will be twice smaller (in each direction) when drawn on screen in the ports in which logical and physical pixels differ (i.e. WXOSX and WXGTK3, but not WXMSW).
335
368
  # When creating a new bitmap, {Wx::Bitmap#create_with_dip_size} can be used to specify the correct scale factor from the beginning.
336
369
  # @param scale [Float]
@@ -339,11 +372,12 @@ module Wx
339
372
  alias_method :scale_factor=, :set_scale_factor
340
373
 
341
374
  # Sets the mask for this bitmap.
375
+ #
342
376
  # <div class="wxrb-remark">
343
377
  # <b>Remark:</b>
344
378
  # <p>The bitmap object owns the mask once this has been called.
345
379
  # </p>
346
- # </div>>
380
+ # </div>
347
381
  #
348
382
  # <div class="wxrb-note">
349
383
  # <b>Note:</b>
@@ -358,6 +392,7 @@ module Wx
358
392
  alias_method :mask=, :set_mask
359
393
 
360
394
  # Rescale the given bitmap to the requested size.
395
+ #
361
396
  # This function is just a convenient wrapper for {Wx::Image#rescale} used to resize the given bmp to the requested size. If you need more control over resizing, e.g. to specify the quality option different from {Wx::ImageResizeQuality::IMAGE_QUALITY_NEAREST} used by this function, please use the {Wx::Image} function directly instead.
362
397
  # Both the bitmap itself and size must be valid.
363
398
  # @param bmp [Wx::Bitmap]
@@ -368,6 +403,7 @@ module Wx
368
403
  end # Bitmap
369
404
 
370
405
  # Contains representations of the same bitmap in different resolutions.
406
+ #
371
407
  # This class generalizes {Wx::Bitmap} for applications supporting multiple DPIs and allows to operate with multiple versions of the same bitmap, in the sizes appropriate to the currently used display resolution, as a single unit. Notably, an entire {Wx::BitmapBundle} can be passed to functions such as {Wx::ToolBar#add_tool} to allow toolbar to select the best available bitmap to be shown.
372
408
  # Objects of this class are typically created by the application and then passed to wxWidgets functions, but not used by the application itself. Currently bitmap bundles can be created from: - A vector of bitmaps, of any provenance.
373
409
  # - An SVG (as memory block, file, or resource) which will be rasterized at required resolutions.
@@ -405,20 +441,24 @@ module Wx
405
441
 
406
442
  # @overload initialize()
407
443
  # Default constructor constructs an empty bundle.
444
+ #
408
445
  # An empty bundle can't be used for anything, but can be assigned something else later.
409
446
  # @return [Wx::BitmapBundle]
410
447
  # @overload initialize(bitmap)
411
448
  # Conversion constructor from a single bitmap.
449
+ #
412
450
  # This constructor does the same thing as {Wx::BitmapBundle.from_bitmap} and only exists for interoperability with the existing code using {Wx::Bitmap}.
413
451
  # @param bitmap [Wx::Bitmap]
414
452
  # @return [Wx::BitmapBundle]
415
453
  # @overload initialize(icon)
416
454
  # Conversion constructor from a single icon.
455
+ #
417
456
  # This constructor does the same thing as {Wx::BitmapBundle.from_bitmap} and only exists for interoperability with the existing code using {Wx::Icon}.
418
457
  # @param icon [Wx::Icon]
419
458
  # @return [Wx::BitmapBundle]
420
459
  # @overload initialize(image)
421
460
  # Conversion constructor from a single image.
461
+ #
422
462
  # Similarly to the constructor from {Wx::Bitmap}, this constructor only exists for interoperability with the existing code using {Wx::Image} and can be replaced with more readable {Wx::BitmapBundle.from_image} in the new code.
423
463
  # @param image [Wx::Image]
424
464
  # @return [Wx::BitmapBundle]
@@ -429,18 +469,21 @@ module Wx
429
469
  def initialize(*args) end
430
470
 
431
471
  # Clear the existing bundle contents.
472
+ #
432
473
  # After calling this function {Wx::BitmapBundle#is_ok} returns false.
433
474
  # This is the same as assigning a default-constructed bitmap bundle to this object but slightly more explicit.
434
475
  # @return [void]
435
476
  def clear; end
436
477
 
437
478
  # Check if bitmap bundle is non-empty.
479
+ #
438
480
  # Return true if the bundle contains any bitmaps or false if it is empty.
439
481
  # @return [Boolean]
440
482
  def is_ok; end
441
483
  alias_method :ok?, :is_ok
442
484
 
443
485
  # Get the size of the bitmap represented by this bundle in default resolution or, equivalently, at 100% scaling.
486
+ #
444
487
  # When creating the bundle from a number of bitmaps, this will be just the size of the smallest bitmap in it.
445
488
  # Note that this function is mostly used by wxWidgets itself and not the application.
446
489
  # @return [Wx::Size]
@@ -448,6 +491,7 @@ module Wx
448
491
  alias_method :default_size, :get_default_size
449
492
 
450
493
  # Get the size that would be best to use for this bundle at the given DPI scaling factor.
494
+ #
451
495
  # For bundles containing some number of the fixed-size bitmaps, this function returns the size of an existing bitmap closest to the ideal size at the given scale, i.e. {Wx::BitmapBundle#get_default_size} multiplied by scale.
452
496
  # Passing a size returned by this function to {Wx::BitmapBundle#get_bitmap} ensures that bitmap doesn't need to be rescaled, which typically significantly lowers its quality.
453
497
  # @param scale [Float]
@@ -456,6 +500,7 @@ module Wx
456
500
  alias_method :preferred_bitmap_size_at_scale, :get_preferred_bitmap_size_at_scale
457
501
 
458
502
  # Get the size that would be best to use for this bundle at the DPI scaling factor used by the given window.
503
+ #
459
504
  # This is just a convenient wrapper for {Wx::BitmapBundle#get_preferred_bitmap_size_at_scale} calling that function with the result of {Wx::Window#get_dpi_scale_factor}.
460
505
  # @param window [Wx::Window] Non-null and fully created window.
461
506
  # @return [Wx::Size]
@@ -463,6 +508,7 @@ module Wx
463
508
  alias_method :preferred_bitmap_size_for, :get_preferred_bitmap_size_for
464
509
 
465
510
  # Get the size that would be best to use for this bundle at the DPI scaling factor used by the given window in logical size.
511
+ #
466
512
  # This is just call {Wx::BitmapBundle#get_preferred_bitmap_size_at_scale} with the result of {Wx::Window#get_dpi_scale_factor} and convert returned value with {Wx::Window#from_phys}.
467
513
  # @param window [Wx::Window] Non-null and fully created window.
468
514
  # @return [Wx::Size]
@@ -470,6 +516,7 @@ module Wx
470
516
  alias_method :preferred_logical_size_for, :get_preferred_logical_size_for
471
517
 
472
518
  # Get bitmap of the specified size, creating a new bitmap from the closest available size by rescaling it if necessary.
519
+ #
473
520
  # This function is mostly used by wxWidgets itself and not the application. As all bitmaps created by it dynamically are currently cached, avoid calling it for many different sizes if you do use it, as this will create many bitmaps that will never be deleted and will consume resources until the application termination.
474
521
  # @param size [Array(Integer, Integer), Wx::Size] The size of the bitmap to return, in physical pixels. If this parameter is {Wx::DEFAULT_SIZE}, default bundle size is used.
475
522
  # @return [Wx::Bitmap]
@@ -477,6 +524,7 @@ module Wx
477
524
  alias_method :bitmap, :get_bitmap
478
525
 
479
526
  # Get bitmap of the size appropriate for the DPI scaling used by the given window.
527
+ #
480
528
  # This helper function simply combines {Wx::BitmapBundle#get_preferred_bitmap_size_for} and {Wx::BitmapBundle#get_bitmap}, i.e. it returns a (normally unscaled) bitmap from the bundle of the closest size to the size that should be used at the DPI scaling of the provided window.
481
529
  # @param window [Wx::Window] Non-null and fully created window.
482
530
  # @return [Wx::Bitmap]
@@ -484,6 +532,7 @@ module Wx
484
532
  alias_method :bitmap_for, :get_bitmap_for
485
533
 
486
534
  # Get icon of the specified size.
535
+ #
487
536
  # This is just a convenient wrapper for {Wx::BitmapBundle#get_bitmap} and simply converts the returned bitmap to {Wx::Icon}.
488
537
  # @param size [Array(Integer, Integer), Wx::Size]
489
538
  # @return [Wx::Icon]
@@ -491,6 +540,7 @@ module Wx
491
540
  alias_method :icon, :get_icon
492
541
 
493
542
  # Get icon of the size appropriate for the DPI scaling used by the given window.
543
+ #
494
544
  # This is similar to {Wx::BitmapBundle#get_bitmap_for}, but returns a {Wx::Icon}, as {Wx::BitmapBundle#get_icon} does.
495
545
  # @param window [Wx::Window] Non-null and fully created window.
496
546
  # @return [Wx::Icon]
@@ -498,6 +548,7 @@ module Wx
498
548
  alias_method :icon_for, :get_icon_for
499
549
 
500
550
  # Check if the two bundles refer to the same object.
551
+ #
501
552
  # Bundles are considered to be same only if they actually use the same underlying object, i.e. are copies of each other. If the two bundles were independently constructed, they're not considered to be the same, even if they were created from the same bitmap.
502
553
  # @param other [Wx::BitmapBundle]
503
554
  # @return [Boolean]
@@ -506,6 +557,7 @@ module Wx
506
557
 
507
558
  # @overload self.from_bitmaps(bitmaps)
508
559
  # Create a bundle from the given collection of bitmaps.
560
+ #
509
561
  # If the bitmaps vector is empty, an invalid, empty bundle is returned, otherwise initialize the bundle with all the bitmaps in this vector which must be themselves valid.
510
562
  # @param bitmaps [Array<Wx::Bitmap>]
511
563
  # @return [Wx::BitmapBundle]
@@ -517,6 +569,7 @@ module Wx
517
569
  def self.from_bitmaps(*args) end
518
570
 
519
571
  # Create a bundle from a single bitmap.
572
+ #
520
573
  # This is only useful for compatibility with the existing code using {Wx::Bitmap}.
521
574
  # If bitmap is invalid, empty bundle is returned.
522
575
  # @param bitmap [Wx::Bitmap]
@@ -524,12 +577,14 @@ module Wx
524
577
  def self.from_bitmap(bitmap) end
525
578
 
526
579
  # Create a bundle from an icon bundle.
580
+ #
527
581
  # If iconBundle is invalid or empty, empty bundle is returned.
528
582
  # @param iconBundle [Wx::IconBundle]
529
583
  # @return [Wx::BitmapBundle]
530
584
  def self.from_icon_bundle(iconBundle) end
531
585
 
532
586
  # Create a bundle from a single image.
587
+ #
533
588
  # This is only useful for compatibility with the existing code using {Wx::Image}.
534
589
  # If image is invalid, empty bundle is returned.
535
590
  # @param image [Wx::Image]
@@ -538,6 +593,7 @@ module Wx
538
593
 
539
594
  # @overload self.from_files(path, filename, extension=("PNG"))
540
595
  # Create a bundle from bitmaps stored as files.
596
+ #
541
597
  # Looking in path for files using filename as prefix and potentionally a suffix with scale, e.g. "_2x" or "@2x"
542
598
  # @param path [String] Path of the directory containing the files
543
599
  # @param filename [String] Bitmap's filename without any scale suffix
@@ -556,6 +612,7 @@ module Wx
556
612
  def self.from_svg(data, sizeDef) end
557
613
 
558
614
  # Create a bundle from the SVG image loaded from the given file.
615
+ #
559
616
  # This function loads the SVG data from the given path and calls {Wx::BitmapBundle.from_svg} with it. As it is just a wrapper for {Wx::BitmapBundle.from_svg}, please see that function documentation for more information about SVG support.
560
617
  # @param path [String] Path to the SVG file. Notice that it should a local file, not an URL.
561
618
  # @param sizeDef [Array(Integer, Integer), Wx::Size] The default size to return from {Wx::BitmapBundle#get_default_size} for this bundle.
@@ -565,6 +622,7 @@ module Wx
565
622
  end # BitmapBundle
566
623
 
567
624
  # This class encapsulates a monochrome mask bitmap, where the masked area is black and the unmasked area is white.
625
+ #
568
626
  # When associated with a bitmap and drawn in a device context, the unmasked area of the bitmap will be drawn, and the masked area will not be drawn.
569
627
  #
570
628
  # <div class="wxrb-note">
@@ -586,6 +644,7 @@ module Wx
586
644
  # @return [Wx::Mask]
587
645
  # @overload initialize(bitmap, index)
588
646
  # Constructs a mask from a bitmap and a palette index that indicates the background.
647
+ #
589
648
  # Not implemented for GTK.
590
649
  # @param bitmap [Wx::Bitmap] A valid bitmap.
591
650
  # @param index [Integer] Index into a palette, specifying the transparency colour.
@@ -603,6 +662,7 @@ module Wx
603
662
 
604
663
  # @overload create(bitmap, index)
605
664
  # Constructs a mask from a bitmap and a palette index that indicates the background.
665
+ #
606
666
  # Not implemented for GTK.
607
667
  # @param bitmap [Wx::Bitmap] A valid bitmap.
608
668
  # @param index [Integer] Index into a palette, specifying the transparency colour.
@@ -619,6 +679,7 @@ module Wx
619
679
  def create(*args) end
620
680
 
621
681
  # Returns the mask as a monochrome bitmap.
682
+ #
622
683
  # Currently this method is implemented in WXMSW, WXGTK and WXOSX.
623
684
  # @return [Wx::Bitmap]
624
685
  def get_bitmap; end
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # A bitmap button is a control that contains a bitmap.
10
+ #
10
11
  # Notice that since wxWidgets 2.9.1 bitmap display is supported by the base {Wx::Button} class itself and the only tiny advantage of using this class is that it allows specifying the bitmap in its constructor, unlike {Wx::Button}. Please see the base class documentation for more information about images support in {Wx::Button}.
11
12
  # ### Styles
12
13
  #
@@ -43,11 +44,12 @@ module Wx
43
44
  # @return [Wx::BitmapButton]
44
45
  # @overload initialize(parent, id, bitmap, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BUTTON_NAME_STR)
45
46
  # Constructor, creating and showing a button.
47
+ #
46
48
  # <div class="wxrb-remark">
47
49
  # <b>Remark:</b>
48
50
  # <p>The bitmap parameter is normally the only bitmap you need to provide, and wxWidgets will draw the button correctly in its different states. If you want more control, call any of the functions {Wx::BitmapButton#set_bitmap_pressed}, {Wx::BitmapButton#set_bitmap_focus}, {Wx::BitmapButton#set_bitmap_disabled}.
49
51
  # </p>
50
- # </div>>
52
+ # </div>
51
53
  # @see Wx::BitmapButton#create
52
54
  # @see Wx::Validator
53
55
  # @param parent [Wx::Window] Parent window. Must not be NULL.
@@ -62,6 +64,7 @@ module Wx
62
64
  def initialize(*args) end
63
65
 
64
66
  # Button creation function for two-step creation.
67
+ #
65
68
  # For more details, see {Wx::BitmapButton#initialize}.
66
69
  # @param parent [Wx::Window]
67
70
  # @param id [Integer]
@@ -75,6 +78,7 @@ module Wx
75
78
  def create(parent, id, bitmap, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BUTTON_NAME_STR) end
76
79
 
77
80
  # Creation function for two-step creation of "Close" button.
81
+ #
78
82
  # It is usually not necessary to use this function directly as {Wx::BitmapButton.new_close_button} is more convenient, but, if required, it can be called on a default-constructed {Wx::BitmapButton} object to achieve the same effect.
79
83
  # @param parent [Wx::Window] The button parent window, must be non-NULL.
80
84
  # @param winid [Integer] The identifier for the new button.
@@ -83,6 +87,7 @@ module Wx
83
87
  def create_close_button(parent, winid, name=(())) end
84
88
 
85
89
  # Helper function creating a standard-looking "Close" button.
90
+ #
86
91
  # To get the best results, platform-specific code may need to be used to create a small, title bar-like "Close" button. This function is provided to avoid the need to test for the current platform and creates the button with as native look as possible.
87
92
  #
88
93
  # The new button.