wxruby3 0.9.0.pre.beta.14-x64-mingw-ucrt → 0.9.0.pre.rc.2-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (278) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -0
  3. data/INSTALL.md +51 -22
  4. data/README.md +81 -6
  5. data/assets/hello_button-macos.png +0 -0
  6. data/assets/hello_button-msw.png +0 -0
  7. data/assets/hello_button.png +0 -0
  8. data/assets/hello_button_clicked-macos.png +0 -0
  9. data/assets/hello_button_clicked-msw.png +0 -0
  10. data/assets/hello_button_clicked.png +0 -0
  11. data/assets/hello_button_clicked_combi.png +0 -0
  12. data/assets/hello_world-macos.png +0 -0
  13. data/assets/hello_world-msw.png +0 -0
  14. data/assets/hello_world.png +0 -0
  15. data/assets/hello_world_combi.png +0 -0
  16. data/assets/repo-social-preview.png +0 -0
  17. data/ext/wxbase32u_gcc_custom.dll +0 -0
  18. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  19. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  20. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  21. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  22. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  23. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  24. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  25. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  26. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  27. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  28. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  29. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  30. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  31. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  32. data/lib/wx/core/art_locator.rb +2 -2
  33. data/lib/wx/core/artprovider.rb +2 -2
  34. data/lib/wx/core/bitmap.rb +6 -5
  35. data/lib/wx/core/bitmap_combobox.rb +34 -0
  36. data/lib/wx/core/brush.rb +6 -0
  37. data/lib/wx/core/controlwithitems.rb +52 -14
  38. data/lib/wx/core/cursor.rb +1 -1
  39. data/lib/wx/core/dc.rb +0 -20
  40. data/lib/wx/core/event_blocker.rb +14 -0
  41. data/lib/wx/core/events/evt_list.rb +19 -0
  42. data/lib/wx/core/evthandler.rb +48 -2
  43. data/lib/wx/core/find_replace_dialog.rb +24 -0
  44. data/lib/wx/core/font.rb +22 -14
  45. data/lib/wx/core/helpprovider.rb +2 -2
  46. data/lib/wx/core/icon.rb +1 -1
  47. data/lib/wx/core/image.rb +1 -1
  48. data/lib/wx/core/menu.rb +5 -0
  49. data/lib/wx/core/paintdc.rb +8 -0
  50. data/lib/wx/core/pen.rb +6 -0
  51. data/lib/wx/core/text_entry.rb +15 -0
  52. data/lib/wx/core/v_list_box.rb +13 -0
  53. data/lib/wx/core/window.rb +29 -2
  54. data/lib/wx/doc/app.rb +40 -0
  55. data/lib/wx/doc/brush.rb +17 -0
  56. data/lib/wx/doc/busy_info.rb +21 -0
  57. data/lib/wx/doc/client_dc.rb +28 -0
  58. data/lib/wx/doc/controlwithitems.rb +11 -0
  59. data/lib/wx/doc/dc.rb +0 -14
  60. data/lib/wx/doc/event_blocker.rb +27 -0
  61. data/lib/wx/doc/evthandler.rb +4 -0
  62. data/lib/wx/doc/extra/02_lifecycles.md +49 -0
  63. data/lib/wx/doc/extra/10_art.md +1 -1
  64. data/lib/wx/doc/extra/11_drawing_and_dc.md +62 -0
  65. data/lib/wx/doc/font.rb +27 -0
  66. data/lib/wx/doc/gen/about_dialog_info.rb +27 -24
  67. data/lib/wx/doc/gen/accelerator.rb +11 -12
  68. data/lib/wx/doc/gen/activity_indicator.rb +65 -0
  69. data/lib/wx/doc/gen/app.rb +6 -3
  70. data/lib/wx/doc/gen/art_provider.rb +53 -29
  71. data/lib/wx/doc/gen/aui/aui_manager.rb +4 -0
  72. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +1 -1
  73. data/lib/wx/doc/gen/aui/aui_pane_info.rb +2 -0
  74. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +2 -0
  75. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +2 -2
  76. data/lib/wx/doc/gen/bitmap.rb +25 -25
  77. data/lib/wx/doc/gen/bitmap_combo_box.rb +157 -0
  78. data/lib/wx/doc/gen/box_sizer.rb +6 -8
  79. data/lib/wx/doc/gen/brush.rb +2 -0
  80. data/lib/wx/doc/gen/busy_info.rb +52 -46
  81. data/lib/wx/doc/gen/caret.rb +0 -4
  82. data/lib/wx/doc/gen/check_list_box.rb +0 -2
  83. data/lib/wx/doc/gen/choice.rb +1 -5
  84. data/lib/wx/doc/gen/client_dc.rb +13 -18
  85. data/lib/wx/doc/gen/clipboard.rb +30 -27
  86. data/lib/wx/doc/gen/collapsible_pane.rb +11 -9
  87. data/lib/wx/doc/gen/colour.rb +6 -3
  88. data/lib/wx/doc/gen/colour_dialog.rb +111 -23
  89. data/lib/wx/doc/gen/combo_box.rb +2 -4
  90. data/lib/wx/doc/gen/context_help_button.rb +48 -0
  91. data/lib/wx/doc/gen/control.rb +20 -18
  92. data/lib/wx/doc/gen/core.rb +2 -2
  93. data/lib/wx/doc/gen/cursor.rb +18 -50
  94. data/lib/wx/doc/gen/data_format.rb +0 -2
  95. data/lib/wx/doc/gen/data_object.rb +37 -44
  96. data/lib/wx/doc/gen/dc.rb +16 -24
  97. data/lib/wx/doc/gen/defs.rb +3 -40
  98. data/lib/wx/doc/gen/dialog.rb +21 -17
  99. data/lib/wx/doc/gen/dir_dialog.rb +10 -8
  100. data/lib/wx/doc/gen/event.rb +2 -2
  101. data/lib/wx/doc/gen/event_blocker.rb +51 -0
  102. data/lib/wx/doc/gen/event_filter.rb +88 -0
  103. data/lib/wx/doc/gen/event_list.rb +23 -2
  104. data/lib/wx/doc/gen/events.rb +103 -112
  105. data/lib/wx/doc/gen/evt_handler.rb +28 -52
  106. data/lib/wx/doc/gen/file_dialog.rb +53 -50
  107. data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
  108. data/lib/wx/doc/gen/font.rb +19 -2
  109. data/lib/wx/doc/gen/font_data.rb +2 -0
  110. data/lib/wx/doc/gen/font_dialog.rb +1 -1
  111. data/lib/wx/doc/gen/frame.rb +4 -3
  112. data/lib/wx/doc/gen/fs_file.rb +8 -0
  113. data/lib/wx/doc/gen/gcdc.rb +2 -22
  114. data/lib/wx/doc/gen/gdi_common.rb +18 -2
  115. data/lib/wx/doc/gen/gdi_object.rb +2 -0
  116. data/lib/wx/doc/gen/graphics_context.rb +4 -43
  117. data/lib/wx/doc/gen/graphics_object.rb +2 -0
  118. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +2 -1
  119. data/lib/wx/doc/gen/grid/grid_ctrl.rb +4 -2
  120. data/lib/wx/doc/gen/grid/grid_table_message.rb +2 -0
  121. data/lib/wx/doc/gen/grid_bag_sizer.rb +4 -0
  122. data/lib/wx/doc/gen/help_controller.rb +4 -1
  123. data/lib/wx/doc/gen/html/html_cell.rb +4 -1
  124. data/lib/wx/doc/gen/html/html_help_controller.rb +4 -1
  125. data/lib/wx/doc/gen/html/html_help_data.rb +4 -0
  126. data/lib/wx/doc/gen/html/html_help_window.rb +2 -1
  127. data/lib/wx/doc/gen/html/html_list_box.rb +138 -11
  128. data/lib/wx/doc/gen/html/html_window.rb +9 -3
  129. data/lib/wx/doc/gen/hyperlink_ctrl.rb +147 -0
  130. data/lib/wx/doc/gen/hyperlink_event.rb +43 -0
  131. data/lib/wx/doc/gen/icon.rb +7 -1
  132. data/lib/wx/doc/gen/icon_location.rb +2 -0
  133. data/lib/wx/doc/gen/image.rb +15 -8
  134. data/lib/wx/doc/gen/keyboard_state.rb +6 -0
  135. data/lib/wx/doc/gen/list_box.rb +0 -11
  136. data/lib/wx/doc/gen/list_ctrl.rb +10 -13
  137. data/lib/wx/doc/gen/locale.rb +7 -3
  138. data/lib/wx/doc/gen/log.rb +6 -2
  139. data/lib/wx/doc/gen/mdi_frame.rb +2 -0
  140. data/lib/wx/doc/gen/media_ctrl.rb +2 -0
  141. data/lib/wx/doc/gen/memory_dc.rb +105 -18
  142. data/lib/wx/doc/gen/menu.rb +4 -2
  143. data/lib/wx/doc/gen/menu_bar.rb +0 -8
  144. data/lib/wx/doc/gen/menu_item.rb +9 -3
  145. data/lib/wx/doc/gen/message_dialog.rb +6 -3
  146. data/lib/wx/doc/gen/mirror_dc.rb +2 -8
  147. data/lib/wx/doc/gen/mouse_state.rb +2 -0
  148. data/lib/wx/doc/gen/multi_choice_dialog.rb +0 -2
  149. data/lib/wx/doc/gen/non_owned_window.rb +2 -1
  150. data/lib/wx/doc/gen/notebook.rb +4 -2
  151. data/lib/wx/doc/gen/paint_dc.rb +2 -6
  152. data/lib/wx/doc/gen/palette.rb +3 -3
  153. data/lib/wx/doc/gen/pen.rb +6 -1
  154. data/lib/wx/doc/gen/pg/pg_editor.rb +2 -1
  155. data/lib/wx/doc/gen/pg/pg_multi_button.rb +4 -0
  156. data/lib/wx/doc/gen/pg/pg_properties.rb +30 -3
  157. data/lib/wx/doc/gen/pg/pg_property.rb +30 -4
  158. data/lib/wx/doc/gen/pg/pg_validation_info.rb +2 -0
  159. data/lib/wx/doc/gen/pg/property_grid.rb +5 -2
  160. data/lib/wx/doc/gen/pg/property_grid_interface.rb +6 -2
  161. data/lib/wx/doc/gen/pg/property_grid_manager.rb +2 -0
  162. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +2 -0
  163. data/lib/wx/doc/gen/picker_base.rb +2 -1
  164. data/lib/wx/doc/gen/platform_info.rb +4 -1
  165. data/lib/wx/doc/gen/property_sheet_dialog.rb +2 -0
  166. data/lib/wx/doc/gen/prt/post_script_dc.rb +2 -8
  167. data/lib/wx/doc/gen/prt/print_data.rb +6 -0
  168. data/lib/wx/doc/gen/prt/printer.rb +0 -3
  169. data/lib/wx/doc/gen/prt/printer_dc.rb +2 -6
  170. data/lib/wx/doc/gen/radio_box.rb +2 -10
  171. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +6 -0
  172. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +1 -1
  173. data/lib/wx/doc/gen/region.rb +2 -0
  174. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +6 -0
  175. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +0 -4
  176. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +2 -0
  177. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +2 -1
  178. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +2 -0
  179. data/lib/wx/doc/gen/screen_dc.rb +2 -0
  180. data/lib/wx/doc/gen/scroll_bar.rb +2 -1
  181. data/lib/wx/doc/gen/scrolled_canvas.rb +4 -8
  182. data/lib/wx/doc/gen/scrolled_control.rb +4 -8
  183. data/lib/wx/doc/gen/scrolled_window.rb +4 -8
  184. data/lib/wx/doc/gen/search_ctrl.rb +131 -0
  185. data/lib/wx/doc/gen/single_choice_dialog.rb +0 -2
  186. data/lib/wx/doc/gen/sizer.rb +14 -3
  187. data/lib/wx/doc/gen/splash_screen.rb +2 -0
  188. data/lib/wx/doc/gen/static_box.rb +6 -3
  189. data/lib/wx/doc/gen/static_box_sizer.rb +2 -1
  190. data/lib/wx/doc/gen/status_bar.rb +0 -5
  191. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +4 -5
  192. data/lib/wx/doc/gen/svg_file_dc.rb +10 -11
  193. data/lib/wx/doc/gen/text_ctrl.rb +10 -3
  194. data/lib/wx/doc/gen/text_entry.rb +8 -3
  195. data/lib/wx/doc/gen/text_entry_dialog.rb +4 -2
  196. data/lib/wx/doc/gen/timer_event.rb +2 -0
  197. data/lib/wx/doc/gen/tool_bar.rb +8 -4
  198. data/lib/wx/doc/gen/top_level_window.rb +5 -2
  199. data/lib/wx/doc/gen/tree_ctrl.rb +0 -6
  200. data/lib/wx/doc/gen/ui_action_simulator.rb +100 -0
  201. data/lib/wx/doc/gen/utils.rb +1 -1
  202. data/lib/wx/doc/gen/v_list_box.rb +36 -26
  203. data/lib/wx/doc/gen/validator.rb +2 -1
  204. data/lib/wx/doc/gen/variant.rb +10 -0
  205. data/lib/wx/doc/gen/window.rb +38 -17
  206. data/lib/wx/doc/gen/window_dc.rb +2 -0
  207. data/lib/wx/doc/gen/window_disabler.rb +2 -0
  208. data/lib/wx/doc/gen/wizard_page_simple.rb +2 -0
  209. data/lib/wx/doc/gen/xml_node.rb +6 -0
  210. data/lib/wx/doc/gen/xml_resource.rb +4 -1
  211. data/lib/wx/doc/memory_dc.rb +75 -0
  212. data/lib/wx/doc/mirror_dc.rb +16 -0
  213. data/lib/wx/doc/pen.rb +17 -0
  214. data/lib/wx/doc/prt/printer_dc.rb +26 -0
  215. data/lib/wx/doc/radio_box.rb +20 -0
  216. data/lib/wx/doc/screen_dc.rb +10 -6
  217. data/lib/wx/doc/svg_file_dc.rb +20 -0
  218. data/lib/wx/doc/v_list_box.rb +9 -0
  219. data/lib/wx/doc/window.rb +27 -0
  220. data/lib/wx/doc/window_disabler.rb +10 -0
  221. data/lib/wx/html/keyword_defs.rb +6 -7
  222. data/lib/wx/html/require.rb +1 -0
  223. data/lib/wx/html/simple_html_listbox.rb +105 -0
  224. data/lib/wx/keyword_defs.rb +83 -75
  225. data/lib/wx/prt/keyword_defs.rb +5 -1
  226. data/lib/wx/version.rb +1 -1
  227. data/lib/wx/wxruby/cmd/test.rb +1 -1
  228. data/lib/wxruby_aui.so +0 -0
  229. data/lib/wxruby_core.so +0 -0
  230. data/lib/wxruby_grid.so +0 -0
  231. data/lib/wxruby_html.so +0 -0
  232. data/lib/wxruby_pg.so +0 -0
  233. data/lib/wxruby_prt.so +0 -0
  234. data/lib/wxruby_rbn.so +0 -0
  235. data/lib/wxruby_rtc.so +0 -0
  236. data/lib/wxruby_stc.so +0 -0
  237. data/rakelib/install.rb +20 -7
  238. data/rakelib/lib/config/linux.rb +4 -2
  239. data/rakelib/lib/config/macosx.rb +120 -1
  240. data/rakelib/lib/config/mingw.rb +6 -1
  241. data/rakelib/lib/config/unixish.rb +26 -11
  242. data/rakelib/lib/config.rb +15 -6
  243. data/rakelib/yard/yard/relative_markdown_links.rb +5 -1
  244. data/samples/aui/aui.rb +432 -363
  245. data/samples/bigdemo/wxArtProvider.rbw +5 -4
  246. data/samples/controls/controls.rb +2 -2
  247. data/samples/controls/htlbox.rb +411 -0
  248. data/samples/controls/tn_htlbox.png +0 -0
  249. data/samples/drawing/graphics_drawing.rb +1 -2
  250. data/samples/drawing/{svgtest.rb → image_prt.rb} +49 -18
  251. data/samples/drawing/tn_image_prt.png +0 -0
  252. data/samples/propgrid/propgrid.rb +26 -21
  253. data/samples/ribbon/ribbon.rb +47 -46
  254. data/samples/sampler/editor.rb +33 -25
  255. data/samples/sampler/sample.rb +2 -2
  256. data/samples/sampler/stc_editor.rb +4 -2
  257. data/tests/lib/item_container_tests.rb +82 -0
  258. data/tests/lib/text_entry_tests.rb +80 -0
  259. data/tests/lib/wxapp_runner.rb +15 -3
  260. data/tests/lib/wxframe_runner.rb +144 -0
  261. data/tests/test_app_event_filter.rb +74 -0
  262. data/tests/test_art_provider.rb +52 -0
  263. data/tests/test_clipboard.rb +2 -1
  264. data/tests/test_event_handling.rb +199 -16
  265. data/tests/test_events.rb +4 -11
  266. data/tests/test_ext_controls.rb +28 -0
  267. data/tests/test_font.rb +239 -0
  268. data/tests/test_gdi_object.rb +161 -0
  269. data/tests/test_intl.rb +16 -15
  270. data/tests/test_item_data.rb +33 -1
  271. data/tests/test_std_controls.rb +373 -0
  272. data/tests/test_window.rb +340 -0
  273. metadata +61 -8
  274. data/lib/wx/doc/gen/auto_buffered_paint_dc.rb +0 -47
  275. data/lib/wx/doc/gen/buffered_dc.rb +0 -95
  276. data/lib/wx/doc/gen/buffered_paint_dc.rb +0 -55
  277. data/lib/wx/doc/gen/colour_data.rb +0 -96
  278. data/samples/drawing/tn_svgtest.png +0 -0
@@ -9,17 +9,17 @@ module Wx
9
9
  # This function shows the standard about dialog containing the information specified in info.
10
10
  # If the current platform has a native about dialog which is capable of showing all the fields in info, the native dialog is used, otherwise the function falls back to the generic wxWidgets version of the dialog, i.e. does the same thing as {generic_about_box}.
11
11
  # Here is an example of how this function may be used:
12
- #
13
- # void MyFrame::ShowSimpleAboutDialog(wxCommandEvent& WXUNUSED(event))
14
- # {
15
- # wxAboutDialogInfo info;
16
- # info.SetName(_("My Program"));
17
- # info.SetVersion(_("1.2.3 Beta"));
18
- # info.SetDescription(_("This program does something great."));
19
- # info.SetCopyright(wxT("(C) 2007 Me <my@email.addre.ss>"));
20
- #
21
- # wxAboutBox(info);
22
- # }
12
+ # ```ruby
13
+ # def show_simple_about_dialog(event)
14
+ # info = Wx::AboutDialogInfo.new
15
+ # info.name = 'My Program'
16
+ # info.version = '1.2.3 Beta'
17
+ # info.description = 'This program does something great.'
18
+ # info.copyright = '(C) 2007 Me <my@email.addre.ss>'
19
+ #
20
+ # Wx.about_box(info)
21
+ # end
22
+ # ```
23
23
  #
24
24
  # Please see the Dialogs Sample for more examples of using this function and {Wx::AboutDialogInfo} for the description of the information which can be shown in the about dialog.
25
25
  # @param info [Wx::AboutDialogInfo]
@@ -39,20 +39,21 @@ module Wx
39
39
  # {Wx::AboutDialogInfo} contains information shown in the standard About dialog displayed by the {about_box} function.
40
40
  # This class contains the general information about the program, such as its name, version, copyright and so on, as well as lists of the program developers, documentation writers, artists and translators. The simple properties from the former group are represented as a string with the exception of the program icon and the program web site, while the lists from the latter group are stored as {Wx::ArrayString} and can be either set entirely at once using {Wx::AboutDialogInfo#set_developers} and similar functions or built one by one using {Wx::AboutDialogInfo#add_developer} etc.
41
41
  # Please also notice that while all the main platforms have the native implementation of the about dialog, they are often more limited than the generic version provided by wxWidgets and so the generic version is used if {Wx::AboutDialogInfo} has any fields not supported by the native version. Currently GTK+ version supports all the possible fields natively but MSW and Mac versions don't support URLs, licence text nor custom icons in the about dialog and if either of those is used, {about_box} will automatically use the generic version so you should avoid specifying these fields to achieve more native look and feel.
42
- # Example of usage:
43
42
  #
44
- # void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
45
- # {
46
- # wxAboutDialogInfo aboutInfo;
47
- # aboutInfo.SetName("MyApp");
48
- # aboutInfo.SetVersion(MY_APP_VERSION_STRING);
49
- # aboutInfo.SetDescription(_("My wxWidgets-based application!"));
50
- # aboutInfo.SetCopyright("(C) 1992-2023");
51
- # aboutInfo.SetWebSite("http://myapp.org");
52
- # aboutInfo.AddDeveloper("My Self");
53
- #
54
- # wxAboutBox(aboutInfo);
55
- # }
43
+ # Example of usage:
44
+ #
45
+ # ```ruby
46
+ # def on_about(event)
47
+ # info = Wx::AboutDialogInfo.new
48
+ # info.name = 'MyApp'
49
+ # info.version = MY_APP_VERSION_STRING
50
+ # info.description = 'My wxWidgets-based application!'
51
+ # info.copyright = '(C) 1992-2023'
52
+ # info.add_developer('My Self')
53
+ #
54
+ # Wx.about_box(info)
55
+ # end
56
+ # ```
56
57
  #
57
58
  # ===
58
59
  #
@@ -60,6 +61,8 @@ module Wx
60
61
  # @see Wx::AboutDialogInfo#set_artists
61
62
  #
62
63
  #
64
+ #
65
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
63
66
  class AboutDialogInfo < ::Object
64
67
 
65
68
  # Default constructor leaves all fields are initially uninitialized, in general you should call at least {Wx::AboutDialogInfo#set_version}, {Wx::AboutDialogInfo#set_copyright} and {Wx::AboutDialogInfo#set_description}.
@@ -55,7 +55,7 @@ module Wx
55
55
  # @overload initialize(flags=0, keyCode=0, cmd=0, item=nil)
56
56
  # Constructor.
57
57
  # @param flags [Integer] A combination of the {Wx::AcceleratorEntryFlags} values, which indicates which modifier keys are held down.
58
- # @param keyCode [Integer] The keycode to be detected. See {Wx::KeyCode} for a full list of keycodes.
58
+ # @param keyCode [Integer,String] The keycode (or character) to be detected. See {Wx::KeyCode} for a full list of keycodes.
59
59
  # @param cmd [Integer] The menu or control command identifier (ID).
60
60
  # @param item [Wx::MenuItem] The menu item associated with this accelerator.
61
61
  # @return [AcceleratorEntry]
@@ -87,7 +87,7 @@ module Wx
87
87
 
88
88
  # Sets the accelerator entry parameters.
89
89
  # @param flags [Integer] A combination of the {Wx::AcceleratorEntryFlags} values, which indicates which modifier keys are held down.
90
- # @param keyCode [Integer] The keycode to be detected. See {Wx::KeyCode} for a full list of keycodes.
90
+ # @param keyCode [Integer,String] The keycode to be detected. See {Wx::KeyCode} for a full list of keycodes.
91
91
  # @param cmd [Integer] The menu or control command identifier (ID).
92
92
  # @param item [Wx::MenuItem] The menu item associated with this accelerator.
93
93
  # @return [void]
@@ -124,15 +124,15 @@ module Wx
124
124
  # An accelerator table allows the application to specify a table of keyboard shortcuts for menu or button commands.
125
125
  # The object {Wx::NULL_ACCELERATOR_TABLE} is defined to be a table with no data, and is the initial accelerator table for a window.
126
126
  # Example:
127
- #
128
- # wxAcceleratorEntry entries[4];
129
- # entries[0].Set(wxACCEL_CTRL, (int) 'N', ID_NEW_WINDOW);
130
- # entries[1].Set(wxACCEL_CTRL, (int) 'X', wxID_EXIT);
131
- # entries[2].Set(wxACCEL_SHIFT, (int) 'A', ID_ABOUT);
132
- # entries[3].Set(wxACCEL_NORMAL, WXK_DELETE, wxID_CUT);
133
- #
134
- # wxAcceleratorTable accel(4, entries);
135
- # frame->SetAcceleratorTable(accel);
127
+ # ```ruby
128
+ # entries = [
129
+ # Wx::AcceleratorEntry.new(Wx::ACCEL_CTRL, 'N', ID_NEW_WINDOW),
130
+ # Wx::AcceleratorEntry.new(Wx::ACCEL_CTRL, 'X', Wx::ID_EXIT),
131
+ # Wx::AcceleratorEntry.new(Wx::ACCEL_CTRL, 'A', Wx::ID_ABOUT),
132
+ # Wx::AcceleratorEntry.new(Wx::ACCEL_CTRL, 'N', Wx::ID_CUT)
133
+ # ]
134
+ # frame.accelerator_table = Wx::AcceleratorTable[entries]
135
+ # ```
136
136
  #
137
137
  # An accelerator takes precedence over normal processing and can be a convenient way to program some event handling. For example, you can use an accelerator table to enable a dialog with a multi-line text control to accept CTRL-Enter as meaning 'OK'.
138
138
  #
@@ -151,7 +151,6 @@ module Wx
151
151
  # @return [AcceleratorTable]
152
152
  # @overload initialize(entries)
153
153
  # Initializes the accelerator table from an array of {Wx::AcceleratorEntry}.
154
- # <b>{Wx::Perl} Note:</b> The {Wx::Perl} constructor accepts a list of either Wx::AcceleratorEntry objects or references to 3-element arrays [flags, keyCode, cmd] , like the parameters of Wx::AcceleratorEntry::new.
155
154
  # @param entries [Array<Wx::AcceleratorEntry>] The array of entries.
156
155
  # @return [AcceleratorTable]
157
156
  # @overload initialize(resource)
@@ -0,0 +1,65 @@
1
+ # :stopdoc:
2
+ # This file is automatically generated by the WXRuby3 documentation
3
+ # generator. Do not alter this file.
4
+ # :startdoc:
5
+
6
+
7
+ module Wx
8
+
9
+ # Small control showing an animation indicating that the program is currently busy performing some background task.
10
+ # ===
11
+ #
12
+ # Category: {Wx::Controls} <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
13
+ # </td><td> {Wx::GTK} Appearance
14
+ # </td><td> {Wx::OSX} Appearance
15
+ # </td></tr></table></div>
16
+ #
17
+ class ActivityIndicator < Control
18
+
19
+ # @overload initialize()
20
+ # Default constructor.
21
+ # Use {Wx::ActivityIndicator#create} to really create the control after using this constructor.
22
+ # @return [ActivityIndicator]
23
+ # @overload initialize(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=("activityindicator"))
24
+ # Constructor fully creating the control.
25
+ # The arguments have the usual meanings and only parent is typically required.
26
+ # @param parent [Wx::Window]
27
+ # @param winid [Integer]
28
+ # @param pos [Array(Integer, Integer), Wx::Point]
29
+ # @param size [Array(Integer, Integer), Wx::Size]
30
+ # @param style [Integer]
31
+ # @param name [String]
32
+ # @return [ActivityIndicator]
33
+ def initialize(*args) end
34
+
35
+ # Create the control initialized using the default constructor.
36
+ # This method can be used to finish the control creation if it hadn't been done already by using the non-default constructor.
37
+ # @param parent [Wx::Window]
38
+ # @param winid [Integer]
39
+ # @param pos [Array(Integer, Integer), Wx::Point]
40
+ # @param size [Array(Integer, Integer), Wx::Size]
41
+ # @param style [Integer]
42
+ # @param name [String]
43
+ # @return [true,false]
44
+ def create(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=("activityindicator")) end
45
+
46
+ # Starts animation of the indicator.
47
+ # Does nothing if the indicator is already running.
48
+ # @return [void]
49
+ def start; end
50
+
51
+ # Stops the animation of the indicator.
52
+ # Notice that the animation is stopped even if {Wx::ActivityIndicator#start} had been called multiple times before, i.e. the calls are not cumulative.
53
+ # @return [void]
54
+ def stop; end
55
+
56
+ # Returns true if the control is currently showing activity.
57
+ # Returns false initially, true once {Wx::ActivityIndicator#start} is called and false again after calling {Wx::ActivityIndicator#stop}.
58
+ # @return [true,false]
59
+ def is_running; end
60
+ alias_method :running?, :is_running
61
+
62
+ end # ActivityIndicator
63
+
64
+
65
+ end
@@ -172,8 +172,9 @@ module Wx
172
172
  # Sets the 'top' window.
173
173
  # 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.
174
174
  # 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
175
- #
175
+ # ```
176
176
  # wxApp::SetTopWindow(NULL)
177
+ # ```
177
178
  # .
178
179
  # @see Wx::App#get_top_window
179
180
  # @see Wx::App#on_init
@@ -342,12 +343,14 @@ module Wx
342
343
  # Sets the C locale to the default locale for the current environment.
343
344
  # 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.
344
345
  # Calling this function is roughly equivalent to calling
345
- #
346
+ # ```
346
347
  # setlocale(LC_ALL, "");
348
+ # ```
347
349
  # but performs additional toolkit-specific tasks under some platforms and so should be used instead of <code>setlocale()</code> itself. Alternatively, you can use {Wx::Locale} to change the locale with more control.
348
350
  # Notice that this does not change the global C++ locale, you need to do it explicitly if you want, e.g.
349
- #
351
+ # ```
350
352
  # std::locale::global(std::locale(""));
353
+ # ```
351
354
  # but be warned that locale support in C++ standard library can be poor or worse under some platforms.
352
355
  # @return [void]
353
356
  def set_c_locale; end
@@ -270,28 +270,19 @@ module Wx
270
270
  # When wxWidgets needs to display an icon or a bitmap (e.g. in the standard file dialog), it does not use a hard-coded resource but asks {Wx::ArtProvider} for it instead. This way users can plug in their own {Wx::ArtProvider} class and easily replace standard art with their own version.
271
271
  # All that is needed is to derive a class from {Wx::ArtProvider}, override either its {Wx::ArtProvider#create_bitmap} and/or its {Wx::ArtProvider#create_icon_bundle} methods and register the provider with {Wx::ArtProvider.push}:
272
272
  #
273
- # class MyProvider : public wxArtProvider
274
- # {
275
- # protected:
276
- # // Override this method to return a bundle containing the required
277
- # // bitmap in all available sizes.
278
- # wxBitmapBundle CreateBitmapBundle(const wxArtID& id,
279
- # const wxArtClient& client,
280
- # const wxSize& size) override;
281
- #
282
- # // If all bitmaps are available in a single size only, it may be
283
- # // simpler to override just this one.
284
- # wxBitmap CreateBitmap(const wxArtID& id,
285
- # const wxArtClient& client,
286
- # const wxSize& size) override;
287
- #
288
- # // optionally override this one as well
289
- # wxIconBundle CreateIconBundle(const wxArtID& id,
290
- # const wxArtClient& client) override;
291
- # { ... }
292
- # };
293
- # ...
294
- # wxArtProvider::Push(new MyProvider);
273
+ # Example:
274
+ #
275
+ # ```ruby
276
+ # class MyArtProvider < Wx::ArtProvider
277
+ #
278
+ # def create_bitmap(id, client, size)
279
+ # # ... create and return bitmap
280
+ # end
281
+ #
282
+ # end
283
+ #
284
+ # Wx::ArtProvider.push(MyArtProvider.new)
285
+ # ```
295
286
  #
296
287
  # If you need bitmap images (of the same artwork) that should be displayed at different sizes you should probably consider overriding {Wx::ArtProvider#create_icon_bundle} and supplying icon bundles that contain different bitmap sizes.
297
288
  # There's another way of taking advantage of this class: you can use it in your code and use platform native icons as provided by {Wx::ArtProvider.get_bitmap_bundle} or {Wx::ArtProvider.get_icon}.
@@ -359,14 +350,12 @@ module Wx
359
350
  # - {Wx::ART_REMOVABLE}
360
351
  # - {Wx::ART_WX_LOGO} (since 3.1.6)
361
352
  #
362
- # When building with {Wx::NO_IMPLICIT_WXSTRING_ENCODING} defined (see wxString Overview for more details), you need to explicitly use {ascii_str} around these constants.
363
- #
364
- # Additionally, any string recognized by custom art providers registered using {Wx::ArtProvider.push} may be used.
365
353
  # When running under GTK+ 2, GTK+ stock item IDs (e.g. <code>"gtk-cdrom"</code>) may be used as well:
366
- #
367
- # #ifdef __WXGTK__
368
- # wxBitmap bmp = wxArtProvider::GetBitmap("gtk-cdrom", wxART_MENU);
369
- # #endif
354
+ # ```ruby
355
+ # if Wx::PLATFORM == 'WXGTK'
356
+ # bmp = Wx::ArtProvider.get_bitmap("gtk-cdrom", Wx::ART_MENU)
357
+ # end
358
+ # ```
370
359
  # For a list of the GTK+ stock items please refer to the GTK+ documentation page. It is also possible to load icons from the current icon theme by specifying their name (without extension and directory components). Icon themes recognized by GTK+ follow the freedesktop.org Icon Themes specification. Note that themes are not guaranteed to contain all icons, so {Wx::ArtProvider} may return {Wx::NULL_BITMAP} or {Wx::NULL_ICON}. The default theme is typically installed in <code>/usr/share/icons/hicolor</code>.
371
360
  #
372
361
  # == Clients
@@ -491,6 +480,41 @@ module Wx
491
480
  # @return [Wx::Icon]
492
481
  def self.get_message_box_icon(flags) end
493
482
 
483
+
484
+ protected
485
+
486
+ # Derived art provider classes may override this method to return the size of the images used by this provider.
487
+ # Note that the returned size should be in DPI-independent pixels, i.e. DIPs. The default implementation returns the result of {Wx::ArtProvider.get_native_dip_size_hint}.
488
+ # @param client [Wx::ArtClient]
489
+ # @return [Wx::Size]
490
+ def do_get_size_hint(client) end
491
+
492
+ # Derived art provider classes may override this method to create requested art resource.
493
+ # For bitmaps available in more than one size, {Wx::ArtProvider#create_bitmap_bundle} should be overridden instead.
494
+ # Note that returned bitmaps are cached by {Wx::ArtProvider} and it is therefore not necessary to optimize {Wx::ArtProvider#create_bitmap} for speed (e.g. you may create {Wx::Bitmap} objects from XPMs here).
495
+ #
496
+ # This is not part of {Wx::ArtProvider}'s public API, use {Wx::ArtProvider.get_bitmap} or {Wx::ArtProvider.get_icon_bundle} or {Wx::ArtProvider.get_icon} to query {Wx::ArtProvider} for a resource.
497
+ # @see Wx::ArtProvider#create_icon_bundle
498
+ # @param id [Wx::ArtID] {Wx::ArtID} unique identifier of the bitmap.
499
+ # @param client [Wx::ArtClient] {Wx::ArtClient} identifier of the client (i.e. who is asking for the bitmap). This only serves as a hint.
500
+ # @param size [Array(Integer, Integer), Wx::Size] Preferred size of the bitmap. The function may return a bitmap of different dimensions, it will be automatically rescaled to meet client's request.
501
+ # @return [Wx::Bitmap]
502
+ def create_bitmap(id, client, size) end
503
+
504
+ # Override this method to create the requested art resources available in more than one size.
505
+ # Unlike {Wx::ArtProvider#create_bitmap}, this method can be overridden to return the same bitmap in several (or all, if {Wx::BitmapBundle.from_svg} is used) sizes at once, which will allow selecting the size best suited for the current display resolution automatically.
506
+ # @param id [Wx::ArtID] {Wx::ArtID} unique identifier of the bitmap.
507
+ # @param client [Wx::ArtClient] {Wx::ArtClient} identifier of the client (i.e. who is asking for the bitmap). This only serves as a hint.
508
+ # @param size [Array(Integer, Integer), Wx::Size] Default size of the bitmaps returned by the bundle.
509
+ # @return [Wx::BitmapBundle]
510
+ def create_bitmap_bundle(id, client, size) end
511
+
512
+ # This method is similar to {Wx::ArtProvider#create_bitmap} but can be used when a bitmap (or an icon) exists in several sizes.
513
+ # @param id [Wx::ArtID]
514
+ # @param client [Wx::ArtClient]
515
+ # @return [Wx::IconBundle]
516
+ def create_icon_bundle(id, client) end
517
+
494
518
  end # ArtProvider
495
519
 
496
520
 
@@ -12,15 +12,19 @@ module Wx::AUI
12
12
  # {Wx::AUI::AuiManager} works as follows: the programmer adds panes to the class, or makes changes to existing pane properties (dock position, floating state, show state, etc.). To apply these changes, {Wx::AUI::AuiManager}'s {Wx::AUI::AuiManager#update} function is called. This batch processing can be used to avoid flicker, by modifying more than one pane at a time, and then "committing" all of the changes at once by calling {Wx::AUI::AuiManager#update}.
13
13
  # Panes can be added quite easily:
14
14
  #
15
+ # ```
15
16
  # wxTextCtrl* text1 = new wxTextCtrl(this, -1);
16
17
  # wxTextCtrl* text2 = new wxTextCtrl(this, -1);
17
18
  # m_mgr.AddPane(text1, wxLEFT, "Pane Caption");
18
19
  # m_mgr.AddPane(text2, wxBOTTOM, "Pane Caption");
19
20
  # m_mgr.Update();
21
+ # ```
20
22
  #
21
23
  # Later on, the positions can be modified easily. The following will float an existing pane in a tool window:
22
24
  #
25
+ # ```
23
26
  # m_mgr.GetPane(text1).Float();
27
+ # ```
24
28
  #
25
29
  # == Layers, Rows and Directions, Positions
26
30
  #
@@ -57,7 +57,7 @@ module Wx::AUI
57
57
  def set_icons(icons) end
58
58
  alias_method :icons=, :set_icons
59
59
 
60
- # @return [void]
60
+ # @return [Wx::IconBundle]
61
61
  def get_icons; end
62
62
  alias_method :icons, :get_icons
63
63
 
@@ -128,6 +128,8 @@ module Wx::AUI
128
128
  # @see Wx::AUI::AuiDockArt
129
129
  #
130
130
  #
131
+ #
132
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
131
133
  class AuiPaneInfo < ::Object
132
134
 
133
135
  # name of the pane
@@ -139,6 +139,8 @@ module Wx::AUI
139
139
  #
140
140
  # Category: Window Docking (wxAUI)
141
141
  #
142
+ #
143
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
142
144
  class AuiTabContainerButton < ::Object
143
145
 
144
146
  end # AuiTabContainerButton
@@ -415,8 +415,8 @@ module Wx::AUI
415
415
  # If there are custom items set, then the overflow menu will be displayed even if there are no items from the main toolbar that overflow.
416
416
  #
417
417
  # The toolbar must have the {Wx::AUI::AuiToolBarStyle::AUI_TB_OVERFLOW} style.
418
- # @param prepend [Wx::AuiToolBarItemArray] are the items to show before any overflow items
419
- # @param append [Wx::AuiToolBarItemArray] are the items to show after any overflow items
418
+ # @param prepend [Array<Wx::AUI::AuiToolbarItem>,nil] are the items to show before any overflow items
419
+ # @param append [Array<Wx::AUI::AuiToolbarItem>,nil] are the items to show after any overflow items
420
420
  # @return [void]
421
421
  def set_custom_overflow_items(prepend, append) end
422
422
 
@@ -34,6 +34,8 @@ module Wx
34
34
  # @see Wx::PixelData
35
35
  #
36
36
  #
37
+ #
38
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
37
39
  class Bitmap < GDIObject
38
40
 
39
41
  # @overload initialize()
@@ -43,9 +45,10 @@ module Wx
43
45
  # @overload initialize(bitmap)
44
46
  # Copy constructor, uses reference counting.
45
47
  # To make a real copy, you can use:
46
- #
47
- # wxBitmap newBitmap = oldBitmap.GetSubBitmap(
48
- # wxRect(0, 0, oldBitmap.GetWidth(), oldBitmap.GetHeight()));
48
+ # ```ruby
49
+ # newBitmap = oldBitmap.get_sub_bitmap(
50
+ # Wx::Rect.new(0, 0, oldBitmap.width, oldBitmap.height))
51
+ # ```
49
52
  # @param bitmap [Wx::Bitmap]
50
53
  # @return [Bitmap]
51
54
  # @overload initialize(width, height, depth=Wx::BITMAP_SCREEN_DEPTH)
@@ -350,37 +353,34 @@ module Wx
350
353
  # - A custom bitmap source using {Wx::BitmapBundleImpl}.
351
354
  # - A single {Wx::Bitmap} or {Wx::Image} for backwards compatibility.
352
355
  # Objects of {Wx::BitmapBundle} class have value-like semantics, i.e. they can be copied around freely (and cheaply) and don't need to be allocated on the heap. However they usually are created using static factory functions (known as "pseudo-constructors") such as {Wx::BitmapBundle.from_bitmaps} instead of using the real constructors.
353
- # Example of using this class to initialize a toolbar in a frame constructor:
354
- #
355
- # MyFrame::MyFrame()
356
- # : wxFrame(nullptr, wxID_ANY, "My frame")
357
- # {
358
- # ...
359
- # wxToolBar* toolBar = CreateToolBar();
360
- #
361
- # wxVector<wxBitmap> bitmaps;
362
- # bitmaps.push_back(wxBITMAP_PNG(open_32x32));
363
- # bitmaps.push_back(wxBITMAP_PNG(open_48x48));
364
- # bitmaps.push_back(wxBITMAP_PNG(open_64x64));
365
- #
366
- # toolBar->AddTool(wxID_OPEN, "Open", wxBitmapBundle::FromBitmaps(bitmaps));
367
- # }
356
+ # ```ruby
357
+ # class MyFrame < Wx::Frame
358
+ #
359
+ # def initialize
360
+ # super(nil, Wx::ID_ANY, "My frame")
361
+ # # ...
362
+ # tool_bar = create_toolBar
363
+ #
364
+ # bitmaps = [
365
+ # Wx::Bitmap(:open_32x32, Wx::BitmapType::BITMAP_TYPE_PNG),
366
+ # Wx::Bitmap(:open_48x48, Wx::BitmapType::BITMAP_TYPE_PNG),
367
+ # Wx::Bitmap(:open_64x64, Wx::BitmapType::BITMAP_TYPE_PNG)
368
+ # ]
369
+ #
370
+ # tool_bar.add_tool(Wx::ID_OPEN, "Open", Wx::BitmapBundle.from_bitmaps(bitmaps))
371
+ # end
372
+ # ```
368
373
  #
369
374
  # The code shown above will use 32 pixel bitmap in normal DPI, 64 pixel bitmap in "high DPI", i.e. pixel-doubling or 200% resolution, and 48 pixel bitmap in 150% resolution. For all the other resolutions, the bitmap with the "best" matching size will be used, where "best" is deemed to be the bitmap with the closest size if it can be used without scaling (so that in this example the 64px bitmap will be used at 175% resolution because it typically looks much better than either downscaling it or upscaling the 48px bitmap to 56px) or, if there is no bitmap with close enough size, a bitmap upscaled by an integer scaling factor is used. Note that custom bitmap bundles can use a different algorithm for selecting the best match by overriding Wx::BitmapBundleImpl#get_preferred_bitmap_size_at_scale.
370
375
  # Of course, this code relies on actually having the resources with the corresponding names (i.e. open_NxN) in MSW .rc file or Mac application bundle and open_NxN_png arrays being defined in the program code, e.g. by including a file generated with bin2c (see {bitmap_png_from_data}), on the other platforms.
371
- # For the platforms with resources support, you can also create the bundle from the bitmaps defined in the resources, which has the advantage of not having to explicitly list all the bitmaps, e.g. the code above becomes
372
376
  #
373
- # #ifdef wxHAS_IMAGE_RESOURCES
374
- # toolBar->AddTool(wxID_OPEN, "Open", wxBitmapBundle::FromResources("open"));
375
- # #else
376
- # ... same code as shown above ...
377
- # #endif
378
- # and will load all resources called open, open_2x, open_1_5x etc (at least the first one of them must be available). See also {bitmap_bundle_2} macro which can avoid the need to check for {Wx::HAS_IMAGE_RESOURCES} explicitly in the code in a common case of having only 2 embedded resources (for standard and high DPI). See also {Wx::BitmapBundle.from_svg_resource}.
379
377
  # Also note that the existing code using {Wx::Bitmap} is compatible with the functions taking {Wx::BitmapBundle} in wxWidgets 3.1.6 and later because bitmaps are implicitly convertible to the objects of this class, so just passing {Wx::Bitmap} to the functions taking {Wx::BitmapBundle} continues to work and if high resolution versions of bitmap are not (yet) available for the other toolbar tools, single bitmaps can continue to be used instead.
380
378
  # ===
381
379
  #
382
380
  # Category: Graphics Device Interface (GDI)
383
381
  #
382
+ #
383
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
384
384
  class BitmapBundle < ::Object
385
385
 
386
386
  # @overload initialize()
@@ -0,0 +1,157 @@
1
+ # :stopdoc:
2
+ # This file is automatically generated by the WXRuby3 documentation
3
+ # generator. Do not alter this file.
4
+ # :startdoc:
5
+
6
+
7
+ module Wx
8
+
9
+ # A combobox that displays bitmap in front of the list items.
10
+ # It currently only allows using bitmaps of one size, and resizes itself so that a bitmap can be shown next to the text field.
11
+ # While {Wx::BitmapComboBox} contains the {Wx::ComboBox} API, but it might not actually be derived from that class. In fact, if the platform does not have a native implementation, {Wx::BitmapComboBox} will inherit from {Wx::OwnerDrawnComboBox}. You can determine if the implementation is generic by checking whether {Wx::GENERIC_BITMAPCOMBOBOX} is defined. Currently {Wx::BitmapComboBox} is implemented natively for MSW and GTK+.
12
+ #
13
+ # === Styles
14
+ #
15
+ # This class supports the following styles:
16
+ #
17
+ # - {Wx::CB_READONLY}: Creates a combobox without a text editor. On some platforms the control may appear very different when this style is used.
18
+ # - {Wx::CB_SORT}: Sorts the entries in the list alphabetically.
19
+ # - {Wx::TE_PROCESS_ENTER}: The control will generate the event {Wx::EVT_TEXT_ENTER} (otherwise pressing Enter key is either processed internally by the control or used for navigation between dialog controls). Windows only.
20
+ #
21
+ # Todocreate {Wx::CB_PROCESS_ENTER} rather than reusing {Wx::TE_PROCESS_ENTER}!
22
+ #
23
+ # === Events emitted by this class
24
+ #
25
+ # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
26
+ # Event handler methods for events emitted by this class:
27
+ # - {Wx::EvtHandler#evt_combobox}(id, meth = nil, &block): Process a {Wx::EVT_COMBOBOX} event, when an item on the list is selected.
28
+ # - {Wx::EvtHandler#evt_text}(id, meth = nil, &block): Process a {Wx::EVT_TEXT} event, when the combobox text changes.
29
+ # - {Wx::EvtHandler#evt_text_enter}(id, meth = nil, &block): Process a {Wx::EVT_TEXT_ENTER} event, when RETURN is pressed in the combobox.
30
+ #
31
+ # ===
32
+ #
33
+ # Category: {Wx::Controls} <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
34
+ # </td><td> {Wx::GTK} Appearance
35
+ # </td><td> {Wx::OSX} Appearance
36
+ # </td></tr></table></div>
37
+ # @see Wx::ComboBox
38
+ # @see Wx::Choice
39
+ # @see Wx::OwnerDrawnComboBox
40
+ # @see Wx::CommandEvent
41
+ #
42
+ #
43
+ class BitmapComboBox < ComboBox
44
+
45
+ # @overload initialize()
46
+ # Default ctor.
47
+ # @return [BitmapComboBox]
48
+ # @overload initialize(parent, id=Wx::StandardID::ID_ANY, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BitmapComboBoxNameStr)
49
+ # Constructor, creating and showing a combobox.
50
+ #
51
+ # @see Wx::BitmapComboBox#create
52
+ # @see Wx::Validator
53
+ # @param parent [Wx::Window] Parent window. Must not be NULL.
54
+ # @param id [Integer] Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
55
+ # @param value [String] Initial selection string. An empty string indicates no selection.
56
+ # @param pos [Array(Integer, Integer), Wx::Point] Initial position.
57
+ # @param size [Array(Integer, Integer), Wx::Size] Initial size.
58
+ # @param choices [Array<String>] An array of strings with which to initialise the control.
59
+ # @param style [Integer] The window style, see {Wx::CB_}* flags.
60
+ # @param validator [Wx::Validator] Validator which can be used for additional data checks.
61
+ # @param name [String] Control name.
62
+ # @return [BitmapComboBox]
63
+ # @overload initialize(parent, id, value, pos, size, choices, style, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BitmapComboBoxNameStr)
64
+ # Constructor, creating and showing a combobox.
65
+ #
66
+ # @see Wx::BitmapComboBox#create
67
+ # @see Wx::Validator
68
+ # @param parent [Wx::Window] Parent window. Must not be NULL.
69
+ # @param id [Integer] Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
70
+ # @param value [String] Initial selection string. An empty string indicates no selection.
71
+ # @param pos [Array(Integer, Integer), Wx::Point] Initial position.
72
+ # @param size [Array(Integer, Integer), Wx::Size] Initial size.
73
+ # @param choices [Array<String>] A {Wx::ArrayString} with which to initialise the control.
74
+ # @param style [Integer] The window style, see {Wx::CB_}* flags.
75
+ # @param validator [Wx::Validator] Validator which can be used for additional data checks.
76
+ # @param name [String] Control name.
77
+ # @return [BitmapComboBox]
78
+ def initialize(*args) end
79
+
80
+ # @overload append(item, bitmap=Wx::NULL_BITMAP)
81
+ # Adds the item to the end of the combo box.
82
+ # @param item [String]
83
+ # @param bitmap [Wx::Bitmap]
84
+ # @return [Integer]
85
+ # @overload append(item, bitmap, clientData)
86
+ # Adds the item to the end of the combo box, associating the given untyped, client data pointer clientData with the item.
87
+ # @param item [String]
88
+ # @param bitmap [Wx::Bitmap]
89
+ # @param clientData [Object]
90
+ # @return [Integer]
91
+ def append(*args) end
92
+
93
+ # @overload create(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BitmapComboBoxNameStr)
94
+ # Creates the combobox for two-step construction.
95
+ # @param parent [Wx::Window]
96
+ # @param id [Integer]
97
+ # @param value [String]
98
+ # @param pos [Array(Integer, Integer), Wx::Point]
99
+ # @param size [Array(Integer, Integer), Wx::Size]
100
+ # @param choices [Array<String>]
101
+ # @param style [Integer]
102
+ # @param validator [Wx::Validator]
103
+ # @param name [String]
104
+ # @return [true,false]
105
+ # @overload create(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BitmapComboBoxNameStr)
106
+ # Creates the combobox for two-step construction.
107
+ # @param parent [Wx::Window]
108
+ # @param id [Integer]
109
+ # @param value [String]
110
+ # @param pos [Array(Integer, Integer), Wx::Point]
111
+ # @param size [Array(Integer, Integer), Wx::Size]
112
+ # @param choices [Array<String>]
113
+ # @param style [Integer]
114
+ # @param validator [Wx::Validator]
115
+ # @param name [String]
116
+ # @return [true,false]
117
+ def create(*args) end
118
+
119
+ # Returns the size of the bitmaps used in the combo box.
120
+ # If the combo box is empty, then {Wx::DEFAULT_SIZE} is returned.
121
+ # @return [Wx::Size]
122
+ def get_bitmap_size; end
123
+ alias_method :bitmap_size, :get_bitmap_size
124
+
125
+ # Returns the bitmap of the item with the given index.
126
+ # @param n [Integer]
127
+ # @return [Wx::Bitmap]
128
+ def get_item_bitmap(n) end
129
+ alias_method :item_bitmap, :get_item_bitmap
130
+
131
+ # @overload insert(item, bitmap, pos)
132
+ # Inserts the item into the list before pos.
133
+ # Not valid for {Wx::CB_SORT} style, use {Wx::BitmapComboBox#append} instead.
134
+ # @param item [String]
135
+ # @param bitmap [Wx::Bitmap]
136
+ # @param pos [Integer]
137
+ # @return [Integer]
138
+ # @overload insert(item, bitmap, pos, clientData)
139
+ # Inserts the item into the list before pos, associating the given untyped, client data pointer with the item.
140
+ # Not valid for {Wx::CB_SORT} style, use {Wx::BitmapComboBox#append} instead.
141
+ # @param item [String]
142
+ # @param bitmap [Wx::Bitmap]
143
+ # @param pos [Integer]
144
+ # @param clientData [Object]
145
+ # @return [Integer]
146
+ def insert(*args) end
147
+
148
+ # Sets the bitmap for the given item.
149
+ # @param n [Integer]
150
+ # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
151
+ # @return [void]
152
+ def set_item_bitmap(n, bitmap) end
153
+
154
+ end # BitmapComboBox
155
+
156
+
157
+ end
@@ -25,15 +25,13 @@ module Wx
25
25
 
26
26
  # Adds non-stretchable space to the main orientation of the sizer only.
27
27
  # More readable way of calling:
28
- #
29
- # if ( wxBoxSizer::IsVertical() )
30
- # {
31
- # wxBoxSizer::Add(0, size, 0).
32
- # }
28
+ # ```ruby
29
+ # if box_sizer.vertical?
30
+ # box_sizer.add(0, size, 0)
33
31
  # else
34
- # {
35
- # wxBoxSizer::Add(size, 0, 0).
36
- # }
32
+ # box_size.add(size, 0, 0)
33
+ # end
34
+ # ```
37
35
  # @param size [Integer]
38
36
  # @return [Wx::SizerItem]
39
37
  def add_spacer(size) end