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
@@ -67,6 +67,7 @@ module Wx
67
67
  NULL_ANIMATION = nil
68
68
 
69
69
  # The {Wx::Animation} class handles the interface between the animation control and the details of the animation image or data.
70
+ #
70
71
  # Predefined objects/pointers: {Wx::NULL_ANIMATION}
71
72
  # @see Wx::AnimationCtrl
72
73
  # @see Animation Sample
@@ -77,12 +78,14 @@ module Wx
77
78
 
78
79
  # @overload initialize()
79
80
  # Constructs a new empty animation object.
81
+ #
80
82
  # Call {Wx::Animation#load} to initialize it.
81
83
  # @see Wx::AnimationCtrl#create_animation
82
84
  # @return [Wx::Animation]
83
85
  # @overload initialize(name, type=Wx::AnimationType::ANIMATION_TYPE_ANY)
84
86
  # Constructs a new animation object and load the animation data from the given filename.
85
87
  #
88
+ #
86
89
  # @see Wx::AnimationCtrl#create_animation
87
90
  # @param name [String] A filename.
88
91
  # @param type [Wx::AnimationType] One of the {Wx::AnimationType} values; {Wx::AnimationType::ANIMATION_TYPE_ANY} means that the function should try to autodetect the filetype.
@@ -99,6 +102,7 @@ module Wx
99
102
  alias_method :ok?, :is_ok
100
103
 
101
104
  # Returns the delay for the i-th frame in milliseconds.
105
+ #
102
106
  # If <code>-1</code> is returned the frame is to be displayed forever.
103
107
  # @param frame [Integer]
104
108
  # @return [Integer]
@@ -106,12 +110,14 @@ module Wx
106
110
  alias_method :delay, :get_delay
107
111
 
108
112
  # Returns the number of frames for this animation.
113
+ #
109
114
  # This method is not implemented in the native WXGTK implementation of this class and always returns 0 there.
110
115
  # @return [Integer]
111
116
  def get_frame_count; end
112
117
  alias_method :frame_count, :get_frame_count
113
118
 
114
119
  # Returns the i-th frame as a {Wx::Image}.
120
+ #
115
121
  # This method is not implemented in the native WXGTK implementation of this class and always returns an invalid image there.
116
122
  # @param frame [Integer]
117
123
  # @return [Wx::Image]
@@ -124,6 +130,7 @@ module Wx
124
130
  alias_method :size, :get_size
125
131
 
126
132
  # Loads an animation from a file.
133
+ #
127
134
  # true if the operation succeeded, false otherwise.
128
135
  # @param name [String] A filename.
129
136
  # @param type [Wx::AnimationType] One of the {Wx::AnimationType} values; {Wx::AnimationType::ANIMATION_TYPE_ANY} means that the function should try to autodetect the filetype.
@@ -131,6 +138,7 @@ module Wx
131
138
  def load_file(name, type=Wx::AnimationType::ANIMATION_TYPE_ANY) end
132
139
 
133
140
  # Loads an animation from the given stream.
141
+ #
134
142
  # true if the operation succeeded, false otherwise.
135
143
  # @param stream [IO,Wx::InputStream] The stream to use to load the animation. Under WXGTK may be any kind of stream; under other platforms this must be a seekable stream.
136
144
  # @param type [Wx::AnimationType] One of the {Wx::AnimationType} enumeration values.
@@ -157,11 +165,13 @@ module Wx
157
165
  def self.find_handler(animType) end
158
166
 
159
167
  # Load the stock animation decoders (currently GIF and ANI) into the list of decoders.
168
+ #
160
169
  # This is called automatically at program startup.
161
170
  # @return [void]
162
171
  def self.init_standard_handlers; end
163
172
 
164
173
  # Clear out the animation decoder list.
174
+ #
165
175
  # This is called automatically at program shutdown.
166
176
  # @return [void]
167
177
  def self.clean_up_handlers; end
@@ -171,6 +181,7 @@ module Wx
171
181
  # {Wx::AnimationDecoder} is used by {Wx::Animation} for loading frames and other information for the animation from the animation image file.
172
182
  #
173
183
  #
184
+ #
174
185
  # @wxrb_require USE_ANIMATIONCTRL
175
186
  class AnimationDecoder < ::Object
176
187
 
@@ -219,6 +230,7 @@ module Wx
219
230
  alias_method :disposal_method, :get_disposal_method
220
231
 
221
232
  # Return the number of milliseconds this frame should be displayed.
233
+ #
222
234
  # If -1 is returned then the frame must be displayed forever.
223
235
  # @param frame [Integer]
224
236
  # @return [Integer]
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # This is a static control which displays an animation.
10
+ #
10
11
  # {Wx::AnimationCtrl} API is as simple as possible and won't give you full control on the animation; if you need it then use {Wx::MediaCtrl}.
11
12
  # This control is useful to display a (small) animation while doing a long task (e.g. a "throbber").
12
13
  # It is only available if {Wx::Setup::USE_ANIMATIONCTRL} is set to 1 (the default).
@@ -44,6 +45,7 @@ module Wx
44
45
  def initialize(parent, id, anim=Wx::NULL_ANIMATION, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AC_DEFAULT_STYLE, name=Wx::ANIMATION_CTRL_NAME_STR) end
45
46
 
46
47
  # Creates the control with the given anim animation.
48
+ #
47
49
  # After control creation you must explicitly call {Wx::AnimationCtrl#play} to start to play the animation. Until that function won't be called, the first frame of the animation is displayed.
48
50
  #
49
51
  # true if the control was successfully created or false if creation failed.
@@ -58,6 +60,7 @@ module Wx
58
60
  def create(parent, id, anim=Wx::NULL_ANIMATION, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AC_DEFAULT_STYLE, name=Wx::ANIMATION_CTRL_NAME_STR) end
59
61
 
60
62
  # Create a new animation object compatible with this control.
63
+ #
61
64
  # A {Wx::Animation} object created using this function is always compatible with controls of this type, see {Wx::Animation#is_compatible_with}.
62
65
  # @see Wx::AnimationCtrl.create_compatible_animation
63
66
  # @return [Wx::Animation]
@@ -79,6 +82,7 @@ module Wx
79
82
  alias_method :playing?, :is_playing
80
83
 
81
84
  # Loads the animation from the given file and calls {Wx::AnimationCtrl#set_animation}.
85
+ #
82
86
  # See {Wx::Animation#load_file} for more info.
83
87
  # @param file [String]
84
88
  # @param animType [Wx::AnimationType]
@@ -86,6 +90,7 @@ module Wx
86
90
  def load_file(file, animType=Wx::AnimationType::ANIMATION_TYPE_ANY) end
87
91
 
88
92
  # Loads the animation from the given stream and calls {Wx::AnimationCtrl#set_animation}.
93
+ #
89
94
  # See {Wx::Animation#load} for more info.
90
95
  # @param file [IO,Wx::InputStream]
91
96
  # @param animType [Wx::AnimationType]
@@ -93,11 +98,13 @@ module Wx
93
98
  def load(file, animType=Wx::AnimationType::ANIMATION_TYPE_ANY) end
94
99
 
95
100
  # Starts playing the animation.
101
+ #
96
102
  # The animation is always played in loop mode (unless the last frame of the animation has an infinite delay time) and always start from the first frame even if you {Wx::stopped} it while some other frame was displayed.
97
103
  # @return [Boolean]
98
104
  def play; end
99
105
 
100
106
  # Sets the animation to play in this control.
107
+ #
101
108
  # If the previous animation is being played, it's {Wx::AnimationCtrl#stop} stopped. Until {Wx::AnimationCtrl#play} isn't called, a static image, the first frame of the given animation or the background colour will be shown (see {Wx::AnimationCtrl#set_inactive_bitmap} for more info).
102
109
  # @param anim [Wx::Animation]
103
110
  # @return [void]
@@ -105,6 +112,7 @@ module Wx
105
112
  alias_method :animation=, :set_animation
106
113
 
107
114
  # Sets the bitmap to show on the control when it's not playing an animation.
115
+ #
108
116
  # If you set as inactive bitmap {Wx::NULL_BITMAP} (which is the default), then the first frame of the animation is instead shown when the control is inactive; in this case, if there's no valid animation associated with the control (see {Wx::AnimationCtrl#set_animation}), then the background colour of the window is shown.
109
117
  # If the control is not playing the animation, the given bitmap will be immediately shown, otherwise it will be shown as soon as {Wx::AnimationCtrl#stop} is called.
110
118
  # Note that the inactive bitmap, if smaller than the control's size, will be centered in the control; if bigger, it will be stretched to fit it.
@@ -114,11 +122,13 @@ module Wx
114
122
  alias_method :inactive_bitmap=, :set_inactive_bitmap
115
123
 
116
124
  # Stops playing the animation.
125
+ #
117
126
  # The control will show the first frame of the animation, a custom static image or the window's background colour as specified by the last {Wx::AnimationCtrl#set_inactive_bitmap} call.
118
127
  # @return [void]
119
128
  def stop; end
120
129
 
121
130
  # Create a new animation object compatible with this control.
131
+ #
122
132
  # This method does the same thing as {Wx::AnimationCtrl#create_animation} but is static, i.e. can be called without creating any {Wx::AnimationCtrl} objects.
123
133
  # @return [Wx::Animation]
124
134
  def self.create_compatible_animation; end
@@ -33,11 +33,13 @@ module Wx
33
33
  # A class for common button functionality used as the base for the various button classes.
34
34
  #
35
35
  #
36
+ #
36
37
  # @wxrb_require USE_BUTTON|USE_TOGGLEBTN
37
38
  class AnyButton < Control
38
39
 
39
40
  # @overload set_bitmap_margins(x, y)
40
41
  # Set the margins between the bitmap and the text of the button.
42
+ #
41
43
  # This method is currently only implemented under MSW. If it is not called, default margin is used around the bitmap.
42
44
  # @see Wx::AnyButton#set_bitmap
43
45
  # @see Wx::AnyButton#set_bitmap_position
@@ -46,6 +48,7 @@ module Wx
46
48
  # @return [void]
47
49
  # @overload set_bitmap_margins(sz)
48
50
  # Set the margins between the bitmap and the text of the button.
51
+ #
49
52
  # This method is currently only implemented under MSW. If it is not called, default margin is used around the bitmap.
50
53
  # @see Wx::AnyButton#set_bitmap
51
54
  # @see Wx::AnyButton#set_bitmap_position
@@ -58,6 +61,7 @@ module Wx
58
61
  def initialize; end
59
62
 
60
63
  # Return the bitmap shown by the button.
64
+ #
61
65
  # The returned bitmap may be invalid only if the button doesn't show any images.
62
66
  # @see Wx::AnyButton#set_bitmap
63
67
  # @return [Wx::Bitmap]
@@ -65,24 +69,28 @@ module Wx
65
69
  alias_method :bitmap, :get_bitmap
66
70
 
67
71
  # Returns the bitmap used when the mouse is over the button.
72
+ #
68
73
  # The returned bitmap is only valid if {Wx::AnyButton#set_bitmap_current} had been previously called.
69
74
  # @return [Wx::Bitmap]
70
75
  def get_bitmap_current; end
71
76
  alias_method :bitmap_current, :get_bitmap_current
72
77
 
73
78
  # Returns the bitmap used for the disabled state.
79
+ #
74
80
  # The returned bitmap is only valid if {Wx::AnyButton#set_bitmap_disabled} had been previously called.
75
81
  # @return [Wx::Bitmap]
76
82
  def get_bitmap_disabled; end
77
83
  alias_method :bitmap_disabled, :get_bitmap_disabled
78
84
 
79
85
  # Returns the bitmap used for the focused state.
86
+ #
80
87
  # The returned bitmap is only valid if {Wx::AnyButton#set_bitmap_focus} had been previously called.
81
88
  # @return [Wx::Bitmap]
82
89
  def get_bitmap_focus; end
83
90
  alias_method :bitmap_focus, :get_bitmap_focus
84
91
 
85
92
  # Returns the bitmap for the normal state.
93
+ #
86
94
  # This is exactly the same as {Wx::AnyButton#get_bitmap} but uses a name backwards-compatible with {Wx::BitmapButton}.
87
95
  # @see Wx::AnyButton#set_bitmap
88
96
  # @see Wx::AnyButton#set_bitmap_label
@@ -91,12 +99,14 @@ module Wx
91
99
  alias_method :bitmap_label, :get_bitmap_label
92
100
 
93
101
  # Returns the bitmap used when the button is pressed.
102
+ #
94
103
  # The returned bitmap is only valid if {Wx::AnyButton#set_bitmap_pressed} had been previously called.
95
104
  # @return [Wx::Bitmap]
96
105
  def get_bitmap_pressed; end
97
106
  alias_method :bitmap_pressed, :get_bitmap_pressed
98
107
 
99
108
  # Sets the bitmap to display in the button.
109
+ #
100
110
  # The bitmap is displayed together with the button label. This method sets up a single bitmap which is used in all button states, use {Wx::AnyButton#set_bitmap_disabled}, {Wx::AnyButton#set_bitmap_pressed}, {Wx::AnyButton#set_bitmap_current} or {Wx::AnyButton#set_bitmap_focus} to change the individual images used in different states.
101
111
  # @see Wx::AnyButton#set_bitmap_position
102
112
  # @see Wx::AnyButton#set_bitmap_margins
@@ -107,6 +117,7 @@ module Wx
107
117
  alias_method :bitmap=, :set_bitmap
108
118
 
109
119
  # Sets the bitmap to be shown when the mouse is over the button.
120
+ #
110
121
  # If bitmap is invalid, the normal bitmap will be used in the current state.
111
122
  # @see Wx::AnyButton#get_bitmap_current
112
123
  # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
@@ -115,6 +126,7 @@ module Wx
115
126
  alias_method :bitmap_current=, :set_bitmap_current
116
127
 
117
128
  # Sets the bitmap for the disabled button appearance.
129
+ #
118
130
  # If bitmap is invalid, the disabled bitmap is set to the automatically generated greyed out version of the normal bitmap, i.e. the same bitmap as is used by default if this method is not called at all. Use {Wx::AnyButton#set_bitmap} with an invalid bitmap to remove the bitmap completely (for all states).
119
131
  # @see Wx::AnyButton#get_bitmap_disabled
120
132
  # @see Wx::AnyButton#set_bitmap_label
@@ -126,6 +138,7 @@ module Wx
126
138
  alias_method :bitmap_disabled=, :set_bitmap_disabled
127
139
 
128
140
  # Sets the bitmap for the button appearance when it has the keyboard focus.
141
+ #
129
142
  # If bitmap is invalid, the normal bitmap will be used in the focused state.
130
143
  # @see Wx::AnyButton#get_bitmap_focus
131
144
  # @see Wx::AnyButton#set_bitmap_label
@@ -137,11 +150,12 @@ module Wx
137
150
  alias_method :bitmap_focus=, :set_bitmap_focus
138
151
 
139
152
  # Sets the bitmap label for the button.
153
+ #
140
154
  # <div class="wxrb-remark">
141
155
  # <b>Remark:</b>
142
156
  # <p>This is the bitmap used for the unselected state, and for all other states if no other bitmaps are provided.
143
157
  # </p>
144
- # </div>>
158
+ # </div>
145
159
  # @see Wx::AnyButton#set_bitmap
146
160
  # @see Wx::AnyButton#get_bitmap_label
147
161
  # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
@@ -157,12 +171,14 @@ module Wx
157
171
 
158
172
  # Get the margins between the bitmap and the text of the button.
159
173
  #
174
+ #
160
175
  # @see Wx::AnyButton#set_bitmap_margins
161
176
  # @return [Wx::Size]
162
177
  def get_bitmap_margins; end
163
178
  alias_method :bitmap_margins, :get_bitmap_margins
164
179
 
165
180
  # Set the position at which the bitmap is displayed.
181
+ #
166
182
  # This method should only be called if the button does have an associated bitmap.
167
183
  # @param dir [Wx::Direction] Direction in which the bitmap should be positioned, one of {Wx::Direction::LEFT}, {Wx::Direction::RIGHT}, {Wx::Direction::TOP} or {Wx::Direction::BOTTOM}.
168
184
  # @return [void]
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # The {Wx::App} class represents the application itself when <code>wxUSE_GUI=1</code>.
10
+ #
10
11
  # In addition to the features provided by {Wx::AppConsole} it keeps track of the top window (see {Wx::App#set_top_window}) and adds support for video modes (see {Wx::App#set_display_mode}).
11
12
  # In general, application-wide settings for GUI-only apps are accessible from {Wx::App} (or from {Wx::SystemSettings} or {Wx::SystemOptions} classes).
12
13
  # ### Events emitted by this class
@@ -37,12 +38,14 @@ module Wx
37
38
  class App < EvtHandler
38
39
 
39
40
  # Constructor.
41
+ #
40
42
  # Called implicitly with a definition of a {Wx::App} object.
41
43
  # @return [Wx::App]
42
44
  def initialize; end
43
45
 
44
46
  # Returns true if the application will exit when the top-level frame is deleted.
45
47
  #
48
+ #
46
49
  # @see Wx::App#set_exit_on_frame_delete
47
50
  # @return [Boolean]
48
51
  def get_exit_on_frame_delete; end
@@ -55,29 +58,33 @@ module Wx
55
58
 
56
59
  # Returns true if the application will use the best visual on systems that support different visuals, false otherwise.
57
60
  #
61
+ #
58
62
  # @see Wx::App#set_use_best_visual
59
63
  # @return [Boolean]
60
64
  def get_use_best_visual; end
61
65
  alias_method :use_best_visual, :get_use_best_visual
62
66
 
63
67
  # Returns a pointer to the top window.
68
+ #
64
69
  # <div class="wxrb-remark">
65
70
  # <b>Remark:</b>
66
71
  # <p>If the top window hasn't been set using {Wx::App#set_top_window}, this function will find the first top-level window (frame or dialog or instance of {Wx::TopLevelWindow}) from the internal top level window list and return that.
67
72
  # </p>
68
- # </div>>
73
+ # </div>
69
74
  # @see Wx::App#set_top_window
70
75
  # @return [Wx::Window]
71
76
  def get_top_window; end
72
77
  alias_method :top_window, :get_top_window
73
78
 
74
79
  # Returns true if the application is active, i.e. if one of its windows is currently in the foreground.
80
+ #
75
81
  # If this function returns false and you need to attract users attention to the application, you may use {Wx::TopLevelWindow#request_user_attention} to do it.
76
82
  # @return [Boolean]
77
83
  def is_active; end
78
84
  alias_method :active?, :is_active
79
85
 
80
86
  # This function is similar to {yield}, except that it disables the user input to all program windows before calling Wx::AppConsole::Yield and re-enables it again afterwards.
87
+ #
81
88
  # If win is not NULL, this window will remain enabled, allowing the implementation of some limited user interaction. Returns the result of the call to Wx::AppConsole::Yield.
82
89
  # @see safe_yield
83
90
  # @param win [Wx::Window]
@@ -86,6 +93,7 @@ module Wx
86
93
  def safe_yield(win, onlyIfNeeded) end
87
94
 
88
95
  # Works like {Wx::App#safe_yield} with onlyIfNeeded == true except that it allows the caller to specify a mask of events to be processed.
96
+ #
89
97
  # See Wx::AppConsole::YieldFor for more info.
90
98
  # @param win [Wx::Window]
91
99
  # @param eventsToProcess [Integer]
@@ -94,6 +102,7 @@ module Wx
94
102
 
95
103
  # Allows the programmer to specify whether the application will exit when the top-level frame is deleted.
96
104
  #
105
+ #
97
106
  # @see Wx::App#get_exit_on_frame_delete
98
107
  # @see Application Shutdown
99
108
  # @param flag [Boolean] If true (the default), the application will exit when the top-level frame is deleted. If false, the application will continue to run.
@@ -102,6 +111,7 @@ module Wx
102
111
  alias_method :exit_on_frame_delete=, :set_exit_on_frame_delete
103
112
 
104
113
  # Allows runtime switching of the UI environment theme.
114
+ #
105
115
  # Currently implemented for WXGTK2-only. Return true if theme was successfully changed.
106
116
  # @param theme [String] The name of the new theme or an absolute path to a gtkrc-theme-file
107
117
  # @return [Boolean]
@@ -109,6 +119,7 @@ module Wx
109
119
  alias_method :native_theme=, :set_native_theme
110
120
 
111
121
  # Sets the 'top' window.
122
+ #
112
123
  # You can call this from within {Wx::App#on_init} to let wxWidgets know which is the main window. You don't have to set the top window; it is only a convenience so that (for example) certain dialogs without parents can use a specific window as the top window.
113
124
  # If no top window is specified by the application, wxWidgets just uses the first frame or dialog (or better, any {Wx::TopLevelWindow}) in its top-level window list, when it needs to use the top window. If you previously called {Wx::App#set_top_window} and now you need to restore this automatic behaviour you can call
114
125
  # ```
@@ -123,6 +134,7 @@ module Wx
123
134
  alias_method :top_window=, :set_top_window
124
135
 
125
136
  # Allows the programmer to specify whether the application will use the best visual on systems that support several visual on the same display.
137
+ #
126
138
  # This is typically the case under Solaris and IRIX, where the default visual is only 8-bit whereas certain applications are supposed to run in TrueColour mode.
127
139
  # Note that this function has to be called in the constructor of the {Wx::App} instance and won't have any effect when called later on. This function currently only has effect under GTK.
128
140
  # @param flag [Boolean] If true, the app will use the best visual.
@@ -132,17 +144,20 @@ module Wx
132
144
  alias_method :use_best_visual=, :set_use_best_visual
133
145
 
134
146
  # Returns a pointer to the top application window if any.
147
+ #
135
148
  # This function is safe to call even before creating, or after destroying, the application object, as it simply returns NULL if it doesn't exist. Otherwise it's equivalent to calling <code>wxTheApp->Wx::App#get_top_window</code>.
136
149
  # @return [Wx::Window]
137
150
  def self.get_main_top_window; end
138
151
 
139
152
  # Call this to explicitly exit the main message (event) loop.
153
+ #
140
154
  # You should normally exit the main loop (and the application) by deleting the top window.
141
155
  # This function simply calls Wx::EvtLoopBase#exit on the active loop.
142
156
  # @return [void]
143
157
  def exit_main_loop; end
144
158
 
145
159
  # Overridden {Wx::EventFilter} method.
160
+ #
146
161
  # This function is called before processing any event and allows the application to preempt the processing of some events, see {Wx::EventFilter} documentation for more information.
147
162
  # {Wx::App} implementation of this method always return -1 indicating that the event should be processed normally.
148
163
  # @param event [Wx::Event]
@@ -150,12 +165,14 @@ module Wx
150
165
  def filter_event(event) end
151
166
 
152
167
  # Returns true if the application is using an event loop.
168
+ #
153
169
  # This function always returns true for the GUI applications which must use an event loop but by default only returns true for the console programs if an event loop is already running as it can't know whether one will be created in the future.
154
170
  # Thus, it only makes sense to override it in console applications which do use an event loop, to return true instead of checking if there is a currently active event loop.
155
171
  # @return [Boolean]
156
172
  def uses_event_loop; end
157
173
 
158
174
  # Process all pending events; it is necessary to call this function to process events posted with {Wx::EvtHandler#queue_event} or {Wx::EvtHandler#add_pending_event}.
175
+ #
159
176
  # This happens during each event loop iteration (see {Wx::EventLoopBase}) in GUI mode but it may be also called directly.
160
177
  # Note that this function does not only process the pending events for the {Wx::App} object itself (which derives from {Wx::EvtHandler}) but also the pending events for any event handler of this application.
161
178
  # This function will immediately return and do nothing if {Wx::App#suspend_processing_of_pending_events} was called.
@@ -163,11 +180,13 @@ module Wx
163
180
  def process_pending_events; end
164
181
 
165
182
  # Deletes the pending events of all {Wx::EvtHandlers} of this application.
183
+ #
166
184
  # See {Wx::EvtHandler#delete_pending_events} for warnings about deleting the pending events.
167
185
  # @return [void]
168
186
  def delete_pending_events; end
169
187
 
170
188
  # Returns true if there are pending events on the internal pending event list.
189
+ #
171
190
  # Whenever {Wx::EvtHandler#queue_event} or {Wx::EvtHandler#add_pending_event} are called (not only for {Wx::App} itself, but for any event handler of the application!), the internal {Wx::App}'s list of handlers with pending events is updated and this function will return true.
172
191
  # @return [Boolean]
173
192
  def has_pending_events; end
@@ -175,6 +194,7 @@ module Wx
175
194
 
176
195
  # Temporary suspends processing of the pending events.
177
196
  #
197
+ #
178
198
  # @see Wx::App#resume_processing_of_pending_events
179
199
  # @return [void]
180
200
  def suspend_processing_of_pending_events; end
@@ -184,6 +204,7 @@ module Wx
184
204
  def resume_processing_of_pending_events; end
185
205
 
186
206
  # This function is called when an assert failure occurs, i.e. the condition specified in {assert} macro evaluated to false.
207
+ #
187
208
  # It is only called in debug mode (when __WXDEBUG__ is defined) as asserts are not left in the release code at all. The base class version shows the default assert failure dialog box proposing to the user to stop the program, continue or ignore all subsequent asserts.
188
209
  # @param file [String] the name of the source file where the assert occurred
189
210
  # @param line [Integer] the line number in this file where the assert occurred
@@ -194,6 +215,7 @@ module Wx
194
215
  def on_assert_failure(file, line, func, cond, msg) end
195
216
 
196
217
  # Returns the user-readable application name.
218
+ #
197
219
  # The difference between this string and the one returned by {Wx::App#get_app_name} is that this one is meant to be shown to the user and so should be used for the window titles, page headers and so on while the other one should be only used internally, e.g. for the file names or configuration file keys.
198
220
  # If the application name for display had been previously set by {Wx::App#set_app_display_name}, it will be returned by this function. Otherwise, if {Wx::App#set_app_name} had been called its value will be returned; also as is. Finally if none was called, this function returns the program name capitalized using Wx::String#capitalize.
199
221
  # @return [String]
@@ -201,6 +223,7 @@ module Wx
201
223
  alias_method :app_display_name, :get_app_display_name
202
224
 
203
225
  # Returns the application name.
226
+ #
204
227
  # If {Wx::App#set_app_name} had been called, returns the string passed to it. Otherwise returns the program name, i.e. the value of argv[0] passed to the <code>main()</code> function.
205
228
  # @see Wx::App#get_app_display_name
206
229
  # @return [String]
@@ -208,6 +231,7 @@ module Wx
208
231
  alias_method :app_name, :get_app_name
209
232
 
210
233
  # Gets the class name of the application.
234
+ #
211
235
  # The class name may be used in a platform specific manner to refer to the application.
212
236
  # @see Wx::App#set_class_name
213
237
  # @return [String]
@@ -215,12 +239,14 @@ module Wx
215
239
  alias_method :class_name, :get_class_name
216
240
 
217
241
  # Returns a pointer to the {Wx::AppTraits} object for the application.
242
+ #
218
243
  # If you want to customize the {Wx::AppTraits} object, you must override the {Wx::App#create_traits} function.
219
244
  # @return [Wx::AppTraits]
220
245
  def get_traits; end
221
246
  alias_method :traits, :get_traits
222
247
 
223
248
  # Returns the user-readable vendor name.
249
+ #
224
250
  # The difference between this string and the one returned by {Wx::App#get_vendor_name} is that this one is meant to be shown to the user and so should be used for the window titles, page headers and so on while the other one should be only used internally, e.g. for the file names or configuration file keys.
225
251
  # By default, returns the same string as {Wx::App#get_vendor_name}.
226
252
  # @return [Wx::String]
@@ -233,6 +259,7 @@ module Wx
233
259
  alias_method :vendor_name, :get_vendor_name
234
260
 
235
261
  # Set the application name to be used in the user-visible places such as window titles.
262
+ #
236
263
  # See {Wx::App#get_app_display_name} for more about the differences between the display name and name.
237
264
  # Notice that if this function is called, the name is used as is, without any capitalization as done by default by {Wx::App#get_app_display_name}.
238
265
  # @param name [String]
@@ -241,6 +268,7 @@ module Wx
241
268
  alias_method :app_display_name=, :set_app_display_name
242
269
 
243
270
  # Sets the name of the application.
271
+ #
244
272
  # This name should be used for file names, configuration file entries and other internal strings. For the user-visible strings, such as the window titles, the application display name set by {Wx::App#set_app_display_name} is used instead.
245
273
  # By default the application name is set to the name of its executable file.
246
274
  # @see Wx::App#get_app_name
@@ -250,6 +278,7 @@ module Wx
250
278
  alias_method :app_name=, :set_app_name
251
279
 
252
280
  # Sets the class name of the application.
281
+ #
253
282
  # This may be used in a platform specific manner to refer to the application.
254
283
  # @see Wx::App#get_class_name
255
284
  # @param name [String]
@@ -258,6 +287,7 @@ module Wx
258
287
  alias_method :class_name=, :set_class_name
259
288
 
260
289
  # Set the vendor name to be used in the user-visible places.
290
+ #
261
291
  # See {Wx::App#get_vendor_display_name} for more about the differences between the display name and name.
262
292
  # @param name [String]
263
293
  # @return [void]
@@ -265,6 +295,7 @@ module Wx
265
295
  alias_method :vendor_display_name=, :set_vendor_display_name
266
296
 
267
297
  # Sets the name of application's vendor.
298
+ #
268
299
  # The name will be used in registry access. A default name is set by wxWidgets.
269
300
  # @see Wx::App#get_vendor_name
270
301
  # @param name [String]
@@ -273,6 +304,7 @@ module Wx
273
304
  alias_method :vendor_name=, :set_vendor_name
274
305
 
275
306
  # Yields control to pending messages in the event loop.
307
+ #
276
308
  # This method is a convenient wrapper for Wx::EvtLoopBase#yield. If the main loop is currently running, it calls this method on it. Otherwise it creates a temporary event loop and uses it instead, which can be useful to process pending messages during the program startup, before the main loop is created.
277
309
  # Use extreme caution when calling this function as, just as Wx::EvtLoopBase#yield, it can result in unexpected reentrances.
278
310
  # @param onlyIfNeeded [Boolean]
@@ -280,6 +312,7 @@ module Wx
280
312
  def yield(onlyIfNeeded=false) end
281
313
 
282
314
  # Sets the C locale to the default locale for the current environment.
315
+ #
283
316
  # It is advised to call this to ensure that the underlying toolkit uses the locale in which the numbers and monetary amounts are shown in the format expected by user and so on.
284
317
  # Calling this function is roughly equivalent to calling
285
318
  # ```
@@ -295,6 +328,7 @@ module Wx
295
328
  def set_c_locale; end
296
329
 
297
330
  # Returns true if the main event loop is currently running, i.e. if the application is inside {Wx::App#on_run}.
331
+ #
298
332
  # This can be useful to test whether events can be dispatched. For example, if this function returns false, non-blocking sockets cannot be used because the events from them would never be processed.
299
333
  # @return [Boolean]
300
334
  def self.is_main_loop_running; end