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
@@ -660,6 +660,7 @@ module Wx::RBN
660
660
  EVT_RIBBONBAR_HELP_CLICK = 10450
661
661
 
662
662
  # {Wx::RBN::RibbonArtProvider} is responsible for drawing all the components of the ribbon interface.
663
+ #
663
664
  # This allows a ribbon bar to have a pluggable look-and-feel, while retaining the same underlying behaviour. As a single art provider is used for all ribbon components, a ribbon bar usually has a consistent (though unique) appearance.
664
665
  # By default, a {Wx::RBN::RibbonBar} uses an instance of this class called {Wx::RBN::RibbonDefaultArtProvider}, which resolves to {Wx::RBN::RibbonAUIArtProvider}, {Wx::RBN::RibbonMSWArtProvider}, or {Wx::RibbonOSXArtProvider} - whichever is most appropriate to the current platform. These art providers are all slightly configurable with regard to colours and fonts, but for larger modifications, you can derive from one of these classes, or write a completely new art provider class. Call {Wx::RBN::RibbonBar#set_art_provider} to change the art provider being used.
665
666
  #
@@ -679,6 +680,7 @@ module Wx::RBN
679
680
  def clone; end
680
681
 
681
682
  # Set the style flags.
683
+ #
682
684
  # Normally called automatically by {Wx::RBN::RibbonBar#set_art_provider} with the ribbon bar's style flags, so that the art provider has the same flags as the bar which it is serving.
683
685
  # @param flags [Integer]
684
686
  # @return [void]
@@ -691,6 +693,7 @@ module Wx::RBN
691
693
  alias_method :flags, :get_flags
692
694
 
693
695
  # Get the value of a certain integer setting.
696
+ #
694
697
  # id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
695
698
  # @param id [Integer]
696
699
  # @return [Integer]
@@ -698,6 +701,7 @@ module Wx::RBN
698
701
  alias_method :metric, :get_metric
699
702
 
700
703
  # Set the value of a certain integer setting to the value new_val.
704
+ #
701
705
  # id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
702
706
  # @param id [Integer]
703
707
  # @param new_val [Integer]
@@ -705,6 +709,7 @@ module Wx::RBN
705
709
  def set_metric(id, new_val) end
706
710
 
707
711
  # Set the value of a certain font setting to the value font.
712
+ #
708
713
  # id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
709
714
  # @param id [Integer]
710
715
  # @param font [Wx::Font,Wx::FontInfo]
@@ -712,6 +717,7 @@ module Wx::RBN
712
717
  def set_font(id, font) end
713
718
 
714
719
  # Get the value of a certain font setting.
720
+ #
715
721
  # id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
716
722
  # @param id [Integer]
717
723
  # @return [Wx::Font]
@@ -719,6 +725,7 @@ module Wx::RBN
719
725
  alias_method :font, :get_font
720
726
 
721
727
  # Get the value of a certain colour setting.
728
+ #
722
729
  # id can be one of the colour values of {Wx::RBN::RibbonArtSetting}.
723
730
  # @param id [Integer]
724
731
  # @return [Wx::Colour]
@@ -726,6 +733,7 @@ module Wx::RBN
726
733
  alias_method :colour, :get_colour
727
734
 
728
735
  # Set the value of a certain colour setting to the value colour.
736
+ #
729
737
  # id can be one of the colour values of {Wx::RBN::RibbonArtSetting}, though not all colour settings will have an effect on every art provider.
730
738
  # @see Wx::RBN::RibbonArtProvider#set_colour_scheme
731
739
  # @param id [Integer]
@@ -733,6 +741,7 @@ module Wx::RBN
733
741
  # @return [void]
734
742
  def set_colour(id, colour) end
735
743
 
744
+ #
736
745
  #
737
746
  #
738
747
  # @see Wx::RBN::RibbonArtProvider#get_colour
@@ -741,6 +750,7 @@ module Wx::RBN
741
750
  def get_color(id) end
742
751
  alias_method :color, :get_color
743
752
 
753
+ #
744
754
  #
745
755
  #
746
756
  # @see Wx::RBN::RibbonArtProvider#set_colour
@@ -750,6 +760,7 @@ module Wx::RBN
750
760
  def set_color(id, color) end
751
761
 
752
762
  # Get the current colour scheme.
763
+ #
753
764
  # Returns three colours such that if {Wx::RBN::RibbonArtProvider#set_colour_scheme} were called with them, the colour scheme would be restored to what it was when {Wx::RBN::RibbonArtProvider#set_colour_scheme} was last called. In practice, this usually means that the returned values are the three colours given in the last call to {Wx::RBN::RibbonArtProvider#set_colour_scheme}, however if {Wx::RBN::RibbonArtProvider#set_colour_scheme} performs an idempotent operation upon the colours it is given (like clamping a component of the colour), then the returned values may not be the three colours given in the last call to {Wx::RBN::RibbonArtProvider#set_colour_scheme}. If {Wx::RBN::RibbonArtProvider#set_colour_scheme} has not been called, then the returned values should result in a colour scheme similar to, if not identical to, the default colours of the art provider. Note that if {Wx::RBN::RibbonArtProvider#set_colour} is called, then {Wx::RBN::RibbonArtProvider#get_colour_scheme} does not try and return a colour scheme similar to colours being used - it's return values are dependent upon the last values given to {Wx::RBN::RibbonArtProvider#set_colour_scheme}, as described above.
754
765
  # @param primary [Wx::Colour] Pointer to a location to store the primary colour, or NULL.
755
766
  # @param secondary [Wx::Colour] Pointer to a location to store the secondary colour, or NULL.
@@ -759,6 +770,7 @@ module Wx::RBN
759
770
  alias_method :colour_scheme, :get_colour_scheme
760
771
 
761
772
  # Set all applicable colour settings from a few base colours.
773
+ #
762
774
  # Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
763
775
  # @see Wx::RBN::RibbonArtProvider#set_colour
764
776
  #
@@ -793,6 +805,7 @@ module Wx::RBN
793
805
 
794
806
  # Draw the background of a ribbon page.
795
807
  #
808
+ #
796
809
  # @see Wx::RBN::RibbonArtProvider#get_page_background_redraw_area
797
810
  # @param dc [Wx::DC] The device context to draw onto.
798
811
  # @param wnd [Wx::Window] The window which is being drawn onto (which is commonly the {Wx::RBN::RibbonPage} whose background is being drawn, but doesn't have to be).
@@ -809,6 +822,7 @@ module Wx::RBN
809
822
  def draw_scroll_button(dc, wnd, rect, style) end
810
823
 
811
824
  # Draw the background and chrome for a ribbon panel.
825
+ #
812
826
  # This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel.
813
827
  # Note that when a panel is minimised, this function is not called - only {Wx::RBN::RibbonArtProvider#draw_minimised_panel} is called, so a background should be explicitly painted by that if required.
814
828
  # @param dc [Wx::DC] The device context to draw onto.
@@ -818,6 +832,7 @@ module Wx::RBN
818
832
  def draw_panel_background(dc, wnd, rect) end
819
833
 
820
834
  # Draw the background and chrome for a {Wx::RBN::RibbonGallery} control.
835
+ #
821
836
  # This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.
822
837
  # @param dc [Wx::DC] The device context to draw onto.
823
838
  # @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery whose background and chrome is being drawn. Attributes used during drawing like the gallery hover state and individual button states can be queried from this parameter by {Wx::RBN::RibbonGallery#is_hovered}, {Wx::RBN::RibbonGallery#get_extension_button_state}, {Wx::RBN::RibbonGallery#get_up_button_state}, and {Wx::RBN::RibbonGallery#get_down_button_state}.
@@ -826,6 +841,7 @@ module Wx::RBN
826
841
  def draw_gallery_background(dc, wnd, rect) end
827
842
 
828
843
  # Draw the background of a single item in a {Wx::RBN::RibbonGallery} control.
844
+ #
829
845
  # This is painted on top of a gallery background, and behind the items bitmap. Unlike {Wx::RBN::RibbonArtProvider#draw_button_bar_button} and {Wx::RBN::RibbonArtProvider#draw_tool}, it is not expected to draw the item bitmap - that is done by the gallery control itself.
830
846
  # @param dc [Wx::DC] The device context to draw onto.
831
847
  # @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery which contains the item being drawn.
@@ -886,6 +902,7 @@ module Wx::RBN
886
902
  def draw_tool(dc, wnd, rect, bitmap, kind, state) end
887
903
 
888
904
  # Draw toggle button on {Wx::RBN::RibbonBar}.
905
+ #
889
906
  # This should draw a small toggle button at top right corner of ribbon bar.
890
907
  # @param dc [Wx::DC] The device context to draw onto.
891
908
  # @param wnd [Wx::RBN::RibbonBar] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
@@ -895,6 +912,7 @@ module Wx::RBN
895
912
  def draw_toggle_button(dc, wnd, rect, mode) end
896
913
 
897
914
  # Draw help button on {Wx::RBN::RibbonBar}.
915
+ #
898
916
  # This should draw a help button at top right corner of ribbon bar.
899
917
  # @param dc [Wx::DC] The device context to draw onto.
900
918
  # @param wnd [Wx::RBN::RibbonBar] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
@@ -912,6 +930,7 @@ module Wx::RBN
912
930
  alias_method :bar_tab_width, :get_bar_tab_width
913
931
 
914
932
  # Calculate the height (in pixels) of the tab region of a ribbon bar.
933
+ #
915
934
  # Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.
916
935
  # @param dc [Wx::DC] A device context to use when one is required for size calculations.
917
936
  # @param wnd [Wx::Window] The window onto which the tabs will eventually be drawn.
@@ -929,6 +948,7 @@ module Wx::RBN
929
948
  alias_method :scroll_button_minimum_size, :get_scroll_button_minimum_size
930
949
 
931
950
  # Calculate the size of a panel for a given client size.
951
+ #
932
952
  # This should increment the given size by enough to fit the panel label and other chrome.
933
953
  # @see Wx::RBN::RibbonArtProvider#get_panel_client_size
934
954
  # @param dc [Wx::DC] A device context to use if one is required for size calculations.
@@ -940,6 +960,7 @@ module Wx::RBN
940
960
  alias_method :panel_size, :get_panel_size
941
961
 
942
962
  # Calculate the client size of a panel for a given overall size.
963
+ #
943
964
  # This should act as the inverse to {Wx::RBN::RibbonArtProvider#get_panel_size}, and decrement the given size by enough to fit the panel label and other chrome.
944
965
  # @see Wx::RBN::RibbonArtProvider#get_panel_size
945
966
  # @param dc [Wx::DC] A device context to use if one is required for size calculations.
@@ -959,6 +980,7 @@ module Wx::RBN
959
980
  alias_method :panel_ext_button_area, :get_panel_ext_button_area
960
981
 
961
982
  # Calculate the size of a {Wx::RBN::RibbonGallery} control for a given client size.
983
+ #
962
984
  # This should increment the given size by enough to fit the gallery border, buttons, and any other chrome.
963
985
  # @see Wx::RBN::RibbonArtProvider#get_gallery_client_size
964
986
  # @param dc [Wx::DC] A device context to use if one is required for size calculations.
@@ -969,6 +991,7 @@ module Wx::RBN
969
991
  alias_method :gallery_size, :get_gallery_size
970
992
 
971
993
  # Calculate the client size of a {Wx::RBN::RibbonGallery} control for a given size.
994
+ #
972
995
  # This should act as the inverse to {Wx::RBN::RibbonArtProvider#get_gallery_size}, and decrement the given size by enough to fit the gallery border, buttons, and other chrome.
973
996
  # @param dc [Wx::DC] A device context to use if one is required for size calculations.
974
997
  # @param wnd [Wx::RBN::RibbonGallery] The gallery in question.
@@ -982,6 +1005,7 @@ module Wx::RBN
982
1005
  alias_method :gallery_client_size, :get_gallery_client_size
983
1006
 
984
1007
  # Calculate the portion of a page background which needs to be redrawn when a page is resized.
1008
+ #
985
1009
  # To optimise the drawing of page backgrounds, as small an area as possible should be returned. Of course, if the way in which a background is drawn means that the entire background needs to be repainted on resize, then the entire new size should be returned.
986
1010
  # @param dc [Wx::DC] A device context to use when one is required for size calculations.
987
1011
  # @param wnd [Wx::RBN::RibbonPage] The page which is being resized.
@@ -992,6 +1016,7 @@ module Wx::RBN
992
1016
  alias_method :page_background_redraw_area, :get_page_background_redraw_area
993
1017
 
994
1018
  # Calculate the size of a button within a {Wx::RBN::RibbonButtonBar}.
1019
+ #
995
1020
  # true if a size exists for the button, false otherwise.
996
1021
  # @param dc [Wx::DC] A device context to use when one is required for size calculations.
997
1022
  # @param wnd [Wx::Window] The window onto which the button will eventually be drawn (which is normally a {Wx::RBN::RibbonButtonBar}, though this is not guaranteed).
@@ -1009,6 +1034,7 @@ module Wx::RBN
1009
1034
  alias_method :button_bar_button_size, :get_button_bar_button_size
1010
1035
 
1011
1036
  # Gets the width of the string if it is used as a {Wx::RBN::RibbonButtonBar} button label.
1037
+ #
1012
1038
  # Width of the given label text in pixel.
1013
1039
  #
1014
1040
  # <div class="wxrb-note">
@@ -1062,6 +1088,7 @@ module Wx::RBN
1062
1088
  #
1063
1089
  #
1064
1090
  #
1091
+ #
1065
1092
  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1066
1093
  # @wxrb_require USE_RIBBON
1067
1094
  class RibbonPageTabInfo < ::Object
@@ -1072,6 +1099,7 @@ module Wx::RBN
1072
1099
  #
1073
1100
  #
1074
1101
  #
1102
+ #
1075
1103
  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1076
1104
  # @wxrb_require USE_RIBBON
1077
1105
  class RibbonMSWArtProvider < RibbonArtProvider
@@ -1085,6 +1113,7 @@ module Wx::RBN
1085
1113
  def clone; end
1086
1114
 
1087
1115
  # Set the style flags.
1116
+ #
1088
1117
  # Normally called automatically by {Wx::RBN::RibbonBar#set_art_provider} with the ribbon bar's style flags, so that the art provider has the same flags as the bar which it is serving.
1089
1118
  # @param flags [Integer]
1090
1119
  # @return [void]
@@ -1097,6 +1126,7 @@ module Wx::RBN
1097
1126
  alias_method :flags, :get_flags
1098
1127
 
1099
1128
  # Get the value of a certain integer setting.
1129
+ #
1100
1130
  # id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
1101
1131
  # @param id [Integer]
1102
1132
  # @return [Integer]
@@ -1104,6 +1134,7 @@ module Wx::RBN
1104
1134
  alias_method :metric, :get_metric
1105
1135
 
1106
1136
  # Set the value of a certain integer setting to the value new_val.
1137
+ #
1107
1138
  # id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
1108
1139
  # @param id [Integer]
1109
1140
  # @param new_val [Integer]
@@ -1111,6 +1142,7 @@ module Wx::RBN
1111
1142
  def set_metric(id, new_val) end
1112
1143
 
1113
1144
  # Set the value of a certain font setting to the value font.
1145
+ #
1114
1146
  # id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
1115
1147
  # @param id [Integer]
1116
1148
  # @param font [Wx::Font,Wx::FontInfo]
@@ -1118,6 +1150,7 @@ module Wx::RBN
1118
1150
  def set_font(id, font) end
1119
1151
 
1120
1152
  # Get the value of a certain font setting.
1153
+ #
1121
1154
  # id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
1122
1155
  # @param id [Integer]
1123
1156
  # @return [Wx::Font]
@@ -1125,6 +1158,7 @@ module Wx::RBN
1125
1158
  alias_method :font, :get_font
1126
1159
 
1127
1160
  # Get the value of a certain colour setting.
1161
+ #
1128
1162
  # id can be one of the colour values of {Wx::RBN::RibbonArtSetting}.
1129
1163
  # @param id [Integer]
1130
1164
  # @return [Wx::Colour]
@@ -1132,6 +1166,7 @@ module Wx::RBN
1132
1166
  alias_method :colour, :get_colour
1133
1167
 
1134
1168
  # Set the value of a certain colour setting to the value colour.
1169
+ #
1135
1170
  # id can be one of the colour values of {Wx::RBN::RibbonArtSetting}, though not all colour settings will have an effect on every art provider.
1136
1171
  # @see Wx::RBN::RibbonMSWArtProvider#set_colour_scheme
1137
1172
  # @param id [Integer]
@@ -1140,6 +1175,7 @@ module Wx::RBN
1140
1175
  def set_colour(id, colour) end
1141
1176
 
1142
1177
  # Get the current colour scheme.
1178
+ #
1143
1179
  # Returns three colours such that if {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} were called with them, the colour scheme would be restored to what it was when {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} was last called. In practice, this usually means that the returned values are the three colours given in the last call to {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme}, however if {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} performs an idempotent operation upon the colours it is given (like clamping a component of the colour), then the returned values may not be the three colours given in the last call to {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme}. If {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} has not been called, then the returned values should result in a colour scheme similar to, if not identical to, the default colours of the art provider. Note that if {Wx::RBN::RibbonMSWArtProvider#set_colour} is called, then {Wx::RBN::RibbonMSWArtProvider#get_colour_scheme} does not try and return a colour scheme similar to colours being used - it's return values are dependent upon the last values given to {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme}, as described above.
1144
1180
  # @param primary [Wx::Colour] Pointer to a location to store the primary colour, or NULL.
1145
1181
  # @param secondary [Wx::Colour] Pointer to a location to store the secondary colour, or NULL.
@@ -1149,6 +1185,7 @@ module Wx::RBN
1149
1185
  alias_method :colour_scheme, :get_colour_scheme
1150
1186
 
1151
1187
  # Set all applicable colour settings from a few base colours.
1188
+ #
1152
1189
  # Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
1153
1190
  # @see Wx::RBN::RibbonMSWArtProvider#set_colour
1154
1191
  #
@@ -1160,6 +1197,7 @@ module Wx::RBN
1160
1197
  def set_colour_scheme(primary, secondary, tertiary) end
1161
1198
 
1162
1199
  # Calculate the height (in pixels) of the tab region of a ribbon bar.
1200
+ #
1163
1201
  # Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.
1164
1202
  # @param dc [Wx::DC] A device context to use when one is required for size calculations.
1165
1203
  # @param wnd [Wx::Window] The window onto which the tabs will eventually be drawn.
@@ -1192,6 +1230,7 @@ module Wx::RBN
1192
1230
 
1193
1231
  # Draw the background of a ribbon page.
1194
1232
  #
1233
+ #
1195
1234
  # @see Wx::RBN::RibbonMSWArtProvider#get_page_background_redraw_area
1196
1235
  # @param dc [Wx::DC] The device context to draw onto.
1197
1236
  # @param wnd [Wx::Window] The window which is being drawn onto (which is commonly the {Wx::RBN::RibbonPage} whose background is being drawn, but doesn't have to be).
@@ -1208,6 +1247,7 @@ module Wx::RBN
1208
1247
  def draw_scroll_button(dc, wnd, rect, style) end
1209
1248
 
1210
1249
  # Draw the background and chrome for a ribbon panel.
1250
+ #
1211
1251
  # This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel.
1212
1252
  # Note that when a panel is minimised, this function is not called - only {Wx::RBN::RibbonMSWArtProvider#draw_minimised_panel} is called, so a background should be explicitly painted by that if required.
1213
1253
  # @param dc [Wx::DC] The device context to draw onto.
@@ -1217,6 +1257,7 @@ module Wx::RBN
1217
1257
  def draw_panel_background(dc, wnd, rect) end
1218
1258
 
1219
1259
  # Draw the background and chrome for a {Wx::RBN::RibbonGallery} control.
1260
+ #
1220
1261
  # This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.
1221
1262
  # @param dc [Wx::DC] The device context to draw onto.
1222
1263
  # @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery whose background and chrome is being drawn. Attributes used during drawing like the gallery hover state and individual button states can be queried from this parameter by {Wx::RBN::RibbonGallery#is_hovered}, {Wx::RBN::RibbonGallery#get_extension_button_state}, {Wx::RBN::RibbonGallery#get_up_button_state}, and {Wx::RBN::RibbonGallery#get_down_button_state}.
@@ -1225,6 +1266,7 @@ module Wx::RBN
1225
1266
  def draw_gallery_background(dc, wnd, rect) end
1226
1267
 
1227
1268
  # Draw the background of a single item in a {Wx::RBN::RibbonGallery} control.
1269
+ #
1228
1270
  # This is painted on top of a gallery background, and behind the items bitmap. Unlike {Wx::RBN::RibbonMSWArtProvider#draw_button_bar_button} and {Wx::RBN::RibbonMSWArtProvider#draw_tool}, it is not expected to draw the item bitmap - that is done by the gallery control itself.
1229
1271
  # @param dc [Wx::DC] The device context to draw onto.
1230
1272
  # @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery which contains the item being drawn.
@@ -1285,6 +1327,7 @@ module Wx::RBN
1285
1327
  def draw_tool(dc, wnd, rect, bitmap, kind, state) end
1286
1328
 
1287
1329
  # Draw toggle button on {Wx::RBN::RibbonBar}.
1330
+ #
1288
1331
  # This should draw a small toggle button at top right corner of ribbon bar.
1289
1332
  # @param dc [Wx::DC] The device context to draw onto.
1290
1333
  # @param wnd [Wx::RBN::RibbonBar] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
@@ -1294,6 +1337,7 @@ module Wx::RBN
1294
1337
  def draw_toggle_button(dc, wnd, rect, mode) end
1295
1338
 
1296
1339
  # Draw help button on {Wx::RBN::RibbonBar}.
1340
+ #
1297
1341
  # This should draw a help button at top right corner of ribbon bar.
1298
1342
  # @param dc [Wx::DC] The device context to draw onto.
1299
1343
  # @param wnd [Wx::RBN::RibbonBar] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
@@ -1319,6 +1363,7 @@ module Wx::RBN
1319
1363
  alias_method :scroll_button_minimum_size, :get_scroll_button_minimum_size
1320
1364
 
1321
1365
  # Calculate the size of a panel for a given client size.
1366
+ #
1322
1367
  # This should increment the given size by enough to fit the panel label and other chrome.
1323
1368
  # @see Wx::RBN::RibbonMSWArtProvider#get_panel_client_size
1324
1369
  # @param dc [Wx::DC] A device context to use if one is required for size calculations.
@@ -1330,6 +1375,7 @@ module Wx::RBN
1330
1375
  alias_method :panel_size, :get_panel_size
1331
1376
 
1332
1377
  # Calculate the client size of a panel for a given overall size.
1378
+ #
1333
1379
  # This should act as the inverse to {Wx::RBN::RibbonMSWArtProvider#get_panel_size}, and decrement the given size by enough to fit the panel label and other chrome.
1334
1380
  # @see Wx::RBN::RibbonMSWArtProvider#get_panel_size
1335
1381
  # @param dc [Wx::DC] A device context to use if one is required for size calculations.
@@ -1349,6 +1395,7 @@ module Wx::RBN
1349
1395
  alias_method :panel_ext_button_area, :get_panel_ext_button_area
1350
1396
 
1351
1397
  # Calculate the size of a {Wx::RBN::RibbonGallery} control for a given client size.
1398
+ #
1352
1399
  # This should increment the given size by enough to fit the gallery border, buttons, and any other chrome.
1353
1400
  # @see Wx::RBN::RibbonMSWArtProvider#get_gallery_client_size
1354
1401
  # @param dc [Wx::DC] A device context to use if one is required for size calculations.
@@ -1359,6 +1406,7 @@ module Wx::RBN
1359
1406
  alias_method :gallery_size, :get_gallery_size
1360
1407
 
1361
1408
  # Calculate the client size of a {Wx::RBN::RibbonGallery} control for a given size.
1409
+ #
1362
1410
  # This should act as the inverse to {Wx::RBN::RibbonMSWArtProvider#get_gallery_size}, and decrement the given size by enough to fit the gallery border, buttons, and other chrome.
1363
1411
  # @param dc [Wx::DC] A device context to use if one is required for size calculations.
1364
1412
  # @param wnd [Wx::RBN::RibbonGallery] The gallery in question.
@@ -1372,6 +1420,7 @@ module Wx::RBN
1372
1420
  alias_method :gallery_client_size, :get_gallery_client_size
1373
1421
 
1374
1422
  # Calculate the portion of a page background which needs to be redrawn when a page is resized.
1423
+ #
1375
1424
  # To optimise the drawing of page backgrounds, as small an area as possible should be returned. Of course, if the way in which a background is drawn means that the entire background needs to be repainted on resize, then the entire new size should be returned.
1376
1425
  # @param dc [Wx::DC] A device context to use when one is required for size calculations.
1377
1426
  # @param wnd [Wx::RBN::RibbonPage] The page which is being resized.
@@ -1382,6 +1431,7 @@ module Wx::RBN
1382
1431
  alias_method :page_background_redraw_area, :get_page_background_redraw_area
1383
1432
 
1384
1433
  # Calculate the size of a button within a {Wx::RBN::RibbonButtonBar}.
1434
+ #
1385
1435
  # true if a size exists for the button, false otherwise.
1386
1436
  # @param dc [Wx::DC] A device context to use when one is required for size calculations.
1387
1437
  # @param wnd [Wx::Window] The window onto which the button will eventually be drawn (which is normally a {Wx::RBN::RibbonButtonBar}, though this is not guaranteed).
@@ -1399,6 +1449,7 @@ module Wx::RBN
1399
1449
  alias_method :button_bar_button_size, :get_button_bar_button_size
1400
1450
 
1401
1451
  # Gets the width of the string if it is used as a {Wx::RBN::RibbonButtonBar} button label.
1452
+ #
1402
1453
  # Width of the given label text in pixel.
1403
1454
  #
1404
1455
  # <div class="wxrb-note">
@@ -1452,6 +1503,7 @@ module Wx::RBN
1452
1503
  #
1453
1504
  #
1454
1505
  #
1506
+ #
1455
1507
  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1456
1508
  # @wxrb_require USE_RIBBON
1457
1509
  class RibbonAUIArtProvider < RibbonMSWArtProvider
@@ -1464,6 +1516,7 @@ module Wx::RBN
1464
1516
  def clone; end
1465
1517
 
1466
1518
  # Get the value of a certain colour setting.
1519
+ #
1467
1520
  # id can be one of the colour values of {Wx::RBN::RibbonArtSetting}.
1468
1521
  # @param id [Integer]
1469
1522
  # @return [Wx::Colour]
@@ -1471,6 +1524,7 @@ module Wx::RBN
1471
1524
  alias_method :colour, :get_colour
1472
1525
 
1473
1526
  # Set the value of a certain colour setting to the value colour.
1527
+ #
1474
1528
  # id can be one of the colour values of {Wx::RBN::RibbonArtSetting}, though not all colour settings will have an effect on every art provider.
1475
1529
  # @see Wx::RBN::RibbonAUIArtProvider#set_colour_scheme
1476
1530
  # @param id [Integer]
@@ -1479,6 +1533,7 @@ module Wx::RBN
1479
1533
  def set_colour(id, colour) end
1480
1534
 
1481
1535
  # Set all applicable colour settings from a few base colours.
1536
+ #
1482
1537
  # Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
1483
1538
  # @see Wx::RBN::RibbonAUIArtProvider#set_colour
1484
1539
  #
@@ -1490,6 +1545,7 @@ module Wx::RBN
1490
1545
  def set_colour_scheme(primary, secondary, tertiary) end
1491
1546
 
1492
1547
  # Set the value of a certain font setting to the value font.
1548
+ #
1493
1549
  # id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
1494
1550
  # @param id [Integer]
1495
1551
  # @param font [Wx::Font,Wx::FontInfo]
@@ -1513,6 +1569,7 @@ module Wx::RBN
1513
1569
  def draw_scroll_button(dc, wnd, rect, style) end
1514
1570
 
1515
1571
  # Calculate the size of a panel for a given client size.
1572
+ #
1516
1573
  # This should increment the given size by enough to fit the panel label and other chrome.
1517
1574
  # @see Wx::RBN::RibbonAUIArtProvider#get_panel_client_size
1518
1575
  # @param dc [Wx::DC] A device context to use if one is required for size calculations.
@@ -1524,6 +1581,7 @@ module Wx::RBN
1524
1581
  alias_method :panel_size, :get_panel_size
1525
1582
 
1526
1583
  # Calculate the client size of a panel for a given overall size.
1584
+ #
1527
1585
  # This should act as the inverse to {Wx::RBN::RibbonAUIArtProvider#get_panel_size}, and decrement the given size by enough to fit the panel label and other chrome.
1528
1586
  # @see Wx::RBN::RibbonAUIArtProvider#get_panel_size
1529
1587
  # @param dc [Wx::DC] A device context to use if one is required for size calculations.
@@ -1550,6 +1608,7 @@ module Wx::RBN
1550
1608
  def draw_tab_ctrl_background(dc, wnd, rect) end
1551
1609
 
1552
1610
  # Calculate the height (in pixels) of the tab region of a ribbon bar.
1611
+ #
1553
1612
  # Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.
1554
1613
  # @param dc [Wx::DC] A device context to use when one is required for size calculations.
1555
1614
  # @param wnd [Wx::Window] The window onto which the tabs will eventually be drawn.
@@ -1584,6 +1643,7 @@ module Wx::RBN
1584
1643
 
1585
1644
  # Draw the background of a ribbon page.
1586
1645
  #
1646
+ #
1587
1647
  # @see Wx::GetPageBackgroundRedrawArea
1588
1648
  # @param dc [Wx::DC] The device context to draw onto.
1589
1649
  # @param wnd [Wx::Window] The window which is being drawn onto (which is commonly the {Wx::RBN::RibbonPage} whose background is being drawn, but doesn't have to be).
@@ -1592,6 +1652,7 @@ module Wx::RBN
1592
1652
  def draw_page_background(dc, wnd, rect) end
1593
1653
 
1594
1654
  # Draw the background and chrome for a ribbon panel.
1655
+ #
1595
1656
  # This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel.
1596
1657
  # Note that when a panel is minimised, this function is not called - only {Wx::RBN::RibbonAUIArtProvider#draw_minimised_panel} is called, so a background should be explicitly painted by that if required.
1597
1658
  # @param dc [Wx::DC] The device context to draw onto.
@@ -1609,6 +1670,7 @@ module Wx::RBN
1609
1670
  def draw_minimised_panel(dc, wnd, rect, bitmap) end
1610
1671
 
1611
1672
  # Draw the background and chrome for a {Wx::RBN::RibbonGallery} control.
1673
+ #
1612
1674
  # This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.
1613
1675
  # @param dc [Wx::DC] The device context to draw onto.
1614
1676
  # @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery whose background and chrome is being drawn. Attributes used during drawing like the gallery hover state and individual button states can be queried from this parameter by {Wx::RBN::RibbonGallery#is_hovered}, {Wx::RBN::RibbonGallery#get_extension_button_state}, {Wx::RBN::RibbonGallery#get_up_button_state}, and {Wx::RBN::RibbonGallery#get_down_button_state}.
@@ -1617,6 +1679,7 @@ module Wx::RBN
1617
1679
  def draw_gallery_background(dc, wnd, rect) end
1618
1680
 
1619
1681
  # Draw the background of a single item in a {Wx::RBN::RibbonGallery} control.
1682
+ #
1620
1683
  # This is painted on top of a gallery background, and behind the items bitmap. Unlike {Wx::RBN::RibbonAUIArtProvider#draw_button_bar_button} and {Wx::RBN::RibbonAUIArtProvider#draw_tool}, it is not expected to draw the item bitmap - that is done by the gallery control itself.
1621
1684
  # @param dc [Wx::DC] The device context to draw onto.
1622
1685
  # @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery which contains the item being drawn.
@@ -7,6 +7,7 @@
7
7
  module Wx::RBN
8
8
 
9
9
  # Top-level control in a ribbon user interface.
10
+ #
10
11
  # Serves as a tabbed container for {Wx::RBN::RibbonPage} - a ribbon user interface typically has a ribbon bar, which contains one or more {Wx::RibbonPages}, which in turn each contain one or more {Wx::RibbonPanels}, which in turn contain controls.
11
12
  # While a {Wx::RBN::RibbonBar} has tabs similar to a {Wx::Notebook}, it does not follow the same API for adding pages. Containers like {Wx::Notebook} can contain any type of window as a page, hence the normal procedure is to create the sub-window and then call {Wx::BookCtrlBase#add_page}. As {Wx::RBN::RibbonBar} can only have {Wx::RBN::RibbonPage} as children (and a {Wx::RBN::RibbonPage} can only have a {Wx::RBN::RibbonBar} as parent), when a page is created, it is automatically added to the bar - there is no AddPage equivalent to call.
12
13
  # After all pages have been created, and all controls and panels placed on those pages, {Wx::RBN::RibbonBar#realize} must be called.
@@ -69,6 +70,7 @@ module Wx::RBN
69
70
 
70
71
  # @overload initialize()
71
72
  # Default constructor.
73
+ #
72
74
  # With this constructor, {Wx::RBN::RibbonBar#create} should be called in order to create the ribbon bar.
73
75
  # @return [Wx::RBN::RibbonBar]
74
76
  # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RBN::RibbonBarOption::RIBBON_BAR_DEFAULT_STYLE)
@@ -82,6 +84,7 @@ module Wx::RBN
82
84
  def initialize(*args) end
83
85
 
84
86
  # Create a ribbon bar in two-step ribbon bar construction.
87
+ #
85
88
  # Should only be called when the default constructor is used, and arguments have the same meaning as in the full constructor.
86
89
  # @param parent [Wx::Window]
87
90
  # @param id [Integer]
@@ -92,6 +95,7 @@ module Wx::RBN
92
95
  def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RBN::RibbonBarOption::RIBBON_BAR_DEFAULT_STYLE) end
93
96
 
94
97
  # Set the margin widths (in pixels) on the left and right sides of the tab bar region of the ribbon bar.
98
+ #
95
99
  # These margins will be painted with the tab background, but tabs and scroll buttons will never be painted in the margins.
96
100
  # The left margin could be used for rendering something equivalent to the "Office Button", though this is not currently implemented. The right margin could be used for rendering a help button, and/or MDI buttons, but again, this is not currently implemented.
97
101
  # @param left [Integer]
@@ -100,6 +104,7 @@ module Wx::RBN
100
104
  def set_tab_ctrl_margins(left, right) end
101
105
 
102
106
  # Set the art provider to be used be the ribbon bar.
107
+ #
103
108
  # Also sets the art provider on all current {Wx::RBN::RibbonPage} children, and any {Wx::RBN::RibbonPage} children added in the future.
104
109
  # Note that unlike most other ribbon controls, the ribbon bar creates a default art provider when initialised, so an explicit call to {Wx::RBN::RibbonBar#set_art_provider} is not required if the default art provider is sufficient. Also, unlike other ribbon controls, the ribbon bar takes ownership of the given pointer, and will delete it when the art provider is changed or the bar is destroyed. If this behaviour is not desired, then clone the art provider before setting it.
105
110
  # @param art [Wx::RBN::RibbonArtProvider]
@@ -109,11 +114,13 @@ module Wx::RBN
109
114
 
110
115
  # @overload set_active_page(page)
111
116
  # Set the active page by index, without triggering any events.
117
+ #
112
118
  # true if the specified page is now active, false if it could not be activated (for example because the page index is invalid).
113
119
  # @param page [Integer] The zero-based index of the page to activate.
114
120
  # @return [Boolean]
115
121
  # @overload set_active_page(page)
116
122
  # Set the active page, without triggering any events.
123
+ #
117
124
  # true if the specified page is now active, false if it could not be activated (for example because the given page is not a child of the ribbon bar).
118
125
  # @param page [Wx::RBN::RibbonPage] The page to activate.
119
126
  # @return [Boolean]
@@ -121,12 +128,14 @@ module Wx::RBN
121
128
  alias_method :active_page=, :set_active_page
122
129
 
123
130
  # Get the index of the active page.
131
+ #
124
132
  # In the rare case of no page being active, -1 is returned.
125
133
  # @return [Integer]
126
134
  def get_active_page; end
127
135
  alias_method :active_page, :get_active_page
128
136
 
129
137
  # Get a page by index.
138
+ #
130
139
  # NULL will be returned if the given index is out of range.
131
140
  # @param n [Integer]
132
141
  # @return [Wx::RBN::RibbonPage]
@@ -139,11 +148,13 @@ module Wx::RBN
139
148
  alias_method :page_count, :get_page_count
140
149
 
141
150
  # Dismiss the expanded panel of the currently active page.
151
+ #
142
152
  # Calls and returns the value from {Wx::RBN::RibbonPage#dismiss_expanded_panel} for the currently active page, or false if there is no active page.
143
153
  # @return [Boolean]
144
154
  def dismiss_expanded_panel; end
145
155
 
146
156
  # Returns the number for a given ribbon bar page.
157
+ #
147
158
  # The number can be used in other ribbon bar calls.
148
159
  # @param page [Wx::RBN::RibbonPage]
149
160
  # @return [Integer]
@@ -151,6 +162,7 @@ module Wx::RBN
151
162
  alias_method :page_number, :get_page_number
152
163
 
153
164
  # Delete a single page from this ribbon bar.
165
+ #
154
166
  # The user must call {Wx::RBN::RibbonBar#realize} after one (or more) calls to this function.
155
167
  # @param n [Integer]
156
168
  # @return [void]
@@ -161,6 +173,7 @@ module Wx::RBN
161
173
  def clear_pages; end
162
174
 
163
175
  # Indicates whether the tab for the given page is shown to the user or not.
176
+ #
164
177
  # By default all page tabs are shown.
165
178
  # @param page [Integer]
166
179
  # @return [Boolean]
@@ -168,6 +181,7 @@ module Wx::RBN
168
181
  alias_method :page_shown?, :is_page_shown
169
182
 
170
183
  # Show or hide the tab for a given page.
184
+ #
171
185
  # After showing or hiding a tab, you need to call {Wx::RBN::RibbonBar#realize}. If you hide the tab for the currently active page (GetActivePage) then you should call SetActivePage to activate a different page.
172
186
  # @param page [Integer]
173
187
  # @param show_tab [Boolean]
@@ -175,6 +189,7 @@ module Wx::RBN
175
189
  def show_page(page, show_tab=true) end
176
190
 
177
191
  # Hides the tab for a given page.
192
+ #
178
193
  # Equivalent to <code>ShowPage(page, false)</code>.
179
194
  # @param page [Integer]
180
195
  # @return [void]
@@ -182,6 +197,7 @@ module Wx::RBN
182
197
 
183
198
  # Indicates whether a tab is currently highlighted.
184
199
  #
200
+ #
185
201
  # @see Wx::RBN::RibbonBar#add_page_highlight
186
202
  # @param page [Integer]
187
203
  # @return [Boolean]
@@ -189,6 +205,7 @@ module Wx::RBN
189
205
  alias_method :page_highlighted?, :is_page_highlighted
190
206
 
191
207
  # Highlight the specified tab.
208
+ #
192
209
  # Highlighted tabs have a colour between that of the active tab and a tab over which the mouse is hovering. This can be used to make a tab (usually temporarily) more noticeable to the user.
193
210
  # @param page [Integer]
194
211
  # @param highlight [Boolean]
@@ -197,6 +214,7 @@ module Wx::RBN
197
214
 
198
215
  # Changes a tab to not be highlighted.
199
216
  #
217
+ #
200
218
  # @see Wx::RBN::RibbonBar#add_page_highlight
201
219
  # @param page [Integer]
202
220
  # @return [void]
@@ -208,6 +226,7 @@ module Wx::RBN
208
226
  # @return [void]
209
227
  # @overload show_panels(show=true)
210
228
  # Shows or hides the panel area of the ribbon bar.
229
+ #
211
230
  # If the panel area is hidden, then only the tab of the ribbon bar will be shown. This is useful for giving the user more screen space to work with when he/she doesn't need to see the ribbon's options.
212
231
  # If the panel is currently shown, this method pins it, use the other overload of this method to specify the exact panel display mode to avoid it.
213
232
  # @param show [Boolean]
@@ -215,24 +234,28 @@ module Wx::RBN
215
234
  def show_panels(*args) end
216
235
 
217
236
  # Hides the panel area of the ribbon bar.
237
+ #
218
238
  # This method behaves like {Wx::RBN::RibbonBar#show_panels} with false argument.
219
239
  # @return [void]
220
240
  def hide_panels; end
221
241
 
222
242
  # Indicates whether the panel area of the ribbon bar is shown.
223
243
  #
244
+ #
224
245
  # @see Wx::RBN::RibbonBar#show_panels
225
246
  # @return [Boolean]
226
247
  def are_panels_shown; end
227
248
 
228
249
  # Returns the current display mode of the panel area.
229
250
  #
251
+ #
230
252
  # @see Wx::RBN::RibbonBar#show_panels
231
253
  # @return [Wx::RibbonDisplayMode]
232
254
  def get_display_mode; end
233
255
  alias_method :display_mode, :get_display_mode
234
256
 
235
257
  # Perform initial layout and size calculations of the bar and its children.
258
+ #
236
259
  # This must be called after all of the bar's children have been created (and their children created, etc.) - if it is not, then windows may not be laid out or sized correctly.
237
260
  # Also calls {Wx::RBN::RibbonPage#realize} on each child page.
238
261
  # @return [Boolean]
@@ -7,6 +7,7 @@
7
7
  module Wx::RBN
8
8
 
9
9
  # Event used to indicate various actions relating to a {Wx::RBN::RibbonBar}.
10
+ #
10
11
  # See {Wx::RBN::RibbonBar} for available event types.
11
12
  #
12
13
  # Category: {Wx::Events}, Ribbon User Interface
@@ -17,7 +18,7 @@ module Wx::RBN
17
18
  class RibbonBarEvent < NotifyEvent
18
19
 
19
20
  # Constructor.
20
- # @param command_type [Wx::Slider::EventType]
21
+ # @param command_type [Wx::StaticLine::EventType]
21
22
  # @param win_id [Integer]
22
23
  # @param page [Wx::RBN::RibbonPage]
23
24
  # @return [Wx::RBN::RibbonBarEvent]