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
@@ -52,68 +52,71 @@ module Wx
52
52
  # This class represents the file chooser dialog.
53
53
  # The path and filename are distinct elements of a full file pathname. If path is {Wx::EmptyString}, the current directory will be used. If filename is {Wx::EmptyString}, no default filename will be supplied. The wildcard determines what files are displayed in the file selector, and file extension supplies a type extension for the required filename.
54
54
  # The typical usage for the open file dialog is:
55
- #
56
- # void MyFrame::OnOpen(wxCommandEvent& WXUNUSED(event))
57
- # {
58
- # if (...current content has not been saved...)
59
- # {
60
- # if (wxMessageBox(_("Current content has not been saved! Proceed?"), _("Please confirm"),
61
- # wxICON_QUESTION | wxYES_NO, this) == wxNO )
62
- # return;
63
- # //else: proceed asking to the user the new file to open
64
- # }
65
- #
66
- # wxFileDialog
67
- # openFileDialog(this, _("Open XYZ file"), "", "",
68
- # "XYZ files (*.xyz)|*.xyz", wxFD_OPEN|wxFD_FILE_MUST_EXIST);
69
- #
70
- # if (openFileDialog.ShowModal() == wxID_CANCEL)
71
- # return; // the user changed idea...
72
- #
73
- # // proceed loading the file chosen by the user;
74
- # // this can be done with e.g. wxWidgets input streams:
75
- # wxFileInputStream input_stream(openFileDialog.GetPath());
76
- # if (!input_stream.IsOk())
77
- # {
78
- # wxLogError("Cannot open file '%s'.", openFileDialog.GetPath());
79
- # return;
80
- # }
55
+ # ```ruby
56
+ # class MyFrame
57
+ # ...
58
+ # def on_open(event)
59
+ # if (...current content has not been saved...)
60
+ # if Wx.message_box('Current content has not been saved! Proceed?', 'Please confirm',
61
+ # Wx::ICON_QUESTION | Wx::YES_NO, self) == Wx::NO
62
+ # return
63
+ # #else: proceed asking to the user the new file to open
64
+ # end
65
+ # end
81
66
  #
67
+ # Wx::FileDialog(self, "Open XYZ file", "", "",
68
+ # "XYZ files (*.xyz)|*.xyz", Wx::FD_OPEN|Wx::FD_FILE_MUST_EXIST) do |dlg|
69
+ # return if dlg.show_modal == Wx::ID_CANCEL # the user changed idea...?
70
+ #
71
+ # # proceed loading the file chosen by the user
72
+ # file = File.open(dlg.path, 'r') rescue nil
73
+ # unless file
74
+ # Wx.log_error("Cannot open file '#{dlg.path}'.")
75
+ # return
76
+ # end
82
77
  # ...
83
- # }
78
+ # end
79
+ # end
84
80
  #
85
- # The typical usage for the save file dialog is instead somewhat simpler:
81
+ # end
82
+ # ```
86
83
  #
87
- # void MyFrame::OnSaveAs(wxCommandEvent& WXUNUSED(event))
88
- # {
89
- # wxFileDialog
90
- # saveFileDialog(this, _("Save XYZ file"), "", "",
91
- # "XYZ files (*.xyz)|*.xyz", wxFD_SAVE|wxFD_OVERWRITE_PROMPT);
92
- #
93
- # if (saveFileDialog.ShowModal() == wxID_CANCEL)
94
- # return; // the user changed idea...
95
- #
96
- # // save the current contents in the file;
97
- # // this can be done with e.g. wxWidgets output streams:
98
- # wxFileOutputStream output_stream(saveFileDialog.GetPath());
99
- # if (!output_stream.IsOk())
100
- # {
101
- # wxLogError("Cannot save current contents in file '%s'.", saveFileDialog.GetPath());
102
- # return;
103
- # }
84
+ # The typical usage for the save file dialog is instead somewhat simpler:
85
+ # ```ruby
86
+ # class MyFrame
87
+ # ...
88
+ # def on_save_as(event)
89
+ # Wx::FileDialog(self, "Save XYZ file", "", "",
90
+ # "XYZ files (*.xyz)|*.xyz", Wx::FD_SAVE|Wx::FD_OVERWRITE_PROMPT) do |dlg|
91
+ # return if dlg.show_modal == Wx::ID_CANCEL # the user changed idea...?
104
92
  #
105
- # ...
106
- # }
93
+ # # save the current contents in the file
94
+ # begin
95
+ # File.open(dlg.path, 'w+') do |f|
96
+ # # save to file
97
+ # end
98
+ # rescue
99
+ # Wx.log_error("Cannot save current contents in file '#{dlg.path}'.")
100
+ # return
101
+ # end
102
+ # end
103
+ # ...
104
+ # end
105
+ #
106
+ # end
107
+ # ```
107
108
  #
108
109
  # == Wildcard Filters
109
110
  #
110
111
  # All implementations of the {Wx::FileDialog} provide a wildcard filter. Typing a filename containing wildcards (*, ?) in the filename text item, and clicking on Ok, will result in only those files matching the pattern being displayed. The wildcard may be a specification for multiple types of file with a description for each, such as:
111
- #
112
+ # ```
112
113
  # "BMP and GIF files (*.bmp;*.gif)|*.bmp;*.gif|PNG files (*.png)|*.png"
114
+ # ```
113
115
  #
114
116
  # On Mac macOS in the open file dialog the filter choice box is not shown by default. Instead all given wildcards are applied at the same time: So in the above example all bmp, gif and png files are displayed. To enforce the display of the filter choice set the corresponding {Wx::SystemOptions} before calling the file open dialog:
115
- #
116
- # wxSystemOptions::SetOption(wxOSX_FILEDIALOG_ALWAYS_SHOW_TYPES, 1)
117
+ # ```ruby
118
+ # Wx::SystemOptions.set_option(Wx::OSX_FILEDIALOG_ALWAYS_SHOW_TYPES, 1)
119
+ # ```
117
120
  # But in contrast to Windows and Unix, where the file type choice filters only the selected files, on Mac macOS even in this case the dialog shows all files matching all file types. The files which does not match the currently selected file type are greyed out and are not selectable.
118
121
  #
119
122
  # == Dialog Customization
@@ -34,7 +34,7 @@ module Wx
34
34
  def create(parent, data, title, style=0) end
35
35
 
36
36
  # Get the {Wx::FindReplaceData} object used by this dialog.
37
- # @return [void]
37
+ # @return [Wx::FindReplaceData]
38
38
  def get_data; end
39
39
  alias_method :data, :get_data
40
40
 
@@ -657,6 +657,8 @@ module Wx
657
657
  # @see Wx::SystemSettings
658
658
  #
659
659
  #
660
+ #
661
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
660
662
  class Font < GDIObject
661
663
 
662
664
  # Returns a font with the same face/size as the given one but with normal weight and style and not underlined nor stricken through.
@@ -914,6 +916,15 @@ module Wx
914
916
  def set_family(family) end
915
917
  alias_method :family=, :set_family
916
918
 
919
+ # Creates the font corresponding to the given native font description string which must have been previously returned by {Wx::Font#get_native_font_info_desc}.
920
+ # If the string is invalid, font is unchanged. This function is typically used for de-serializing a {Wx::Font} object previously saved in a string-form.
921
+ # true if the creation was successful.
922
+ # @see Wx::Font#set_native_font_info_user_desc
923
+ # @param info [String]
924
+ # @return [true,false]
925
+ def set_native_font_info(info) end
926
+ alias_method :native_font_info=, :set_native_font_info
927
+
917
928
  # Creates the font corresponding to the given native font description string and returns true if the creation was successful.
918
929
  # Unlike {Wx::Font#set_native_font_info}, this function accepts strings which are user-friendly. Examples of accepted string formats are:
919
930
  #
@@ -1082,16 +1093,19 @@ module Wx
1082
1093
  # Creates a font object using the specified font description.
1083
1094
  # This is the preferred way to create font objects as using this ctor results in more readable code and it is also extensible, e.g. it could continue to be used if support for more font attributes is added in the future. For example, this constructor provides the only way of creating fonts with strike-through style.
1084
1095
  # Example of creating a font using this ctor:
1085
- #
1096
+ # ```
1086
1097
  # wxFont font(wxFontInfo(10).Bold().Underlined());
1098
+ # ```
1087
1099
  # @param fontInfo [Wx::FontInfo]
1088
1100
  # @return [Font]
1089
1101
  # @overload initialize(pointSize, family, style, weight, underline=false, faceName=(''), encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
1090
1102
  # Creates a font object with the specified attributes and size in points.
1091
1103
  # Notice that the use of this constructor is often more verbose and less readable than using wxFont(const wxFontInfo& font), e.g. the example in that constructor documentation would need to be written as:
1092
1104
  #
1105
+ # ```
1093
1106
  # wxFont font(10, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL,
1094
1107
  # wxFONTWEIGHT_BOLD, true);
1108
+ # ```
1095
1109
  #
1096
1110
  # If the desired font does not exist, the closest match will be chosen. Under Windows, only scalable TrueType fonts are used.
1097
1111
  # @param pointSize [Integer] Size in points. See {Wx::Font#set_point_size} for more info. Notice that, for historical reasons, the value 70 here is interpreted at {Wx::DEFAULT} and results in creation of the font with the default size and not of a font with the size of 70pt. If you really need the latter, please use SetPointSize(70). Note that this constructor and the matching Create() method overload are the only places in {Wx::Font} API handling {Wx::DEFAULT} specially: neither {Wx::Font#set_point_size} nor the constructor taking {Wx::FontInfo} handle this value in this way.
@@ -1155,12 +1169,15 @@ module Wx
1155
1169
 
1156
1170
  # This class is a helper used for {Wx::Font} creation using named parameter idiom: it allows specifying various {Wx::Font} attributes using the chained calls to its clearly named methods instead of passing them in the fixed order to {Wx::Font} constructors.
1157
1171
  # For example, to create an italic font with the given face name and size you could use:
1158
- #
1172
+ # ```
1159
1173
  # wxFont font(wxFontInfo(12).FaceName("Helvetica").Italic());
1174
+ # ```
1160
1175
  #
1161
1176
  # Notice that all of the methods of this object return a reference to the object itself, allowing the calls to them to be chained as in the example above.
1162
1177
  # All methods taking boolean parameters can be used to turn the specified font attribute on or off and turn it on by default.
1163
1178
  #
1179
+ #
1180
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1164
1181
  class FontInfo < ::Object
1165
1182
 
1166
1183
  # @overload initialize()
@@ -15,6 +15,8 @@ module Wx
15
15
  # @see Wx::FontDialog
16
16
  #
17
17
  #
18
+ #
19
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
18
20
  class FontData < Object
19
21
 
20
22
  # Constructor.
@@ -25,7 +25,7 @@ module Wx
25
25
  class FontDialog < Dialog
26
26
 
27
27
  # Returns the font data associated with the font dialog.
28
- # @return [void]
28
+ # @return [Wx::FontData]
29
29
  def get_font_data; end
30
30
  alias_method :font_data, :get_font_data
31
31
 
@@ -50,7 +50,9 @@ module Wx
50
50
  #
51
51
  # The default frame style is for normal, resizable frames. To create a frame which cannot be resized by user, you may use the following combination of styles:
52
52
  #
53
+ # ```
53
54
  # wxDEFAULT_FRAME_STYLE & ~(wxRESIZE_BORDER | wxMAXIMIZE_BOX)
55
+ # ```
54
56
  #
55
57
  # See also the Window Styles.
56
58
  #
@@ -238,8 +240,6 @@ module Wx
238
240
 
239
241
  # Sets the widths of the fields in the status bar.
240
242
  # The widths of the variable fields are calculated from the total width of all fields, minus the sum of widths of the non-variable fields, divided by the number of variable fields.
241
- #
242
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes the field widths as parameters.
243
243
  # @param n [Integer] The number of fields in the status bar. It must be the same used in CreateStatusBar.
244
244
  # @param widths_field [int] Must contain an array of n integers, each of which is a status field width in pixels. A value of -1 indicates that the field is variable width; at least one field must be -1. You should delete this array after calling {Wx::Frame#set_status_widths}.
245
245
  # @return [void]
@@ -255,8 +255,9 @@ module Wx
255
255
  # Returns a {Wx::TaskBarButton} pointer representing the taskbar button of the window under Windows 7 or later. The returned {Wx::TaskBarButton} may be used, if non-NULL, to access the functionality including thumbnail representations, thumbnail toolbars, notification and status overlays, and progress indicators.
256
256
  # The returned pointer must not be deleted, it is owned by the frame and will be only deleted when the frame itself is destroyed.
257
257
  # This function is not available in the other ports by design, any occurrences of it in the portable code must be guarded by
258
- #
258
+ # ```
259
259
  # #ifdef __WXMSW__
260
+ # ```
260
261
  # preprocessor guards.
261
262
  # @return [Wx::TaskBarButton]
262
263
  def msw_get_task_bar_button; end
@@ -40,6 +40,7 @@ module Wx
40
40
  # You probably won't use it. See the Note for details.
41
41
  # It is seldom used by the application programmer but you will need it if you are writing your own virtual FS. For example you may need something similar to {Wx::MemoryInputStream}, but because {Wx::MemoryInputStream} doesn't free the memory when destroyed and thus passing a memory stream pointer into {Wx::FSFile} constructor would lead to memory leaks, you can write your own class derived from {Wx::FSFile}:
42
42
  #
43
+ # ```
43
44
  # class wxMyFSFile : public wxFSFile
44
45
  # {
45
46
  # private:
@@ -49,6 +50,7 @@ module Wx
49
50
  # ~wxMyFSFile() {free(m_Mem);}
50
51
  # // of course dtor is virtual ;-)
51
52
  # };
53
+ # ```
52
54
  #
53
55
  # If you are not sure of the meaning of these params, see the description of the GetXXXX() functions.
54
56
  # @param stream [IO] The input stream that will be used to access data
@@ -113,6 +115,8 @@ module Wx
113
115
  # @see Wx::StreamBuffer
114
116
  #
115
117
  #
118
+ #
119
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
116
120
  class StreamBase < ::Object
117
121
 
118
122
  # Creates a dummy stream object.
@@ -166,6 +170,8 @@ module Wx
166
170
  #
167
171
  # Category: {Wx::Streams}
168
172
  #
173
+ #
174
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
169
175
  class InputStream < StreamBase
170
176
 
171
177
  # Creates a dummy input stream.
@@ -230,6 +236,8 @@ module Wx
230
236
  #
231
237
  # Category: {Wx::Streams}
232
238
  #
239
+ #
240
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
233
241
  class OutputStream < StreamBase
234
242
 
235
243
  # Creates a dummy {Wx::OutputStream} object.
@@ -18,30 +18,10 @@ module Wx
18
18
  # @see Wx::GraphicsContext
19
19
  #
20
20
  #
21
+ #
22
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
21
23
  class GCDC < DC
22
24
 
23
- # @overload initialize(windowDC)
24
- # Constructs a {Wx::GCDC} from a {Wx::WindowDC}.
25
- # @param windowDC [Wx::WindowDC]
26
- # @return [GCDC]
27
- # @overload initialize(memoryDC)
28
- # Constructs a {Wx::GCDC} from a {Wx::MemoryDC}.
29
- # @param memoryDC [Wx::MemoryDC]
30
- # @return [GCDC]
31
- # @overload initialize(printerDC)
32
- # Constructs a {Wx::GCDC} from a {Wx::PRT::PrinterDC}.
33
- # @param printerDC [Wx::PrinterDC]
34
- # @return [GCDC]
35
- # @overload initialize(context)
36
- # Construct a {Wx::GCDC} from an existing graphics context.
37
- # Note that this object takes ownership of context and will delete it when it is destroyed or when {Wx::GCDC#set_graphics_context} is called with a different context object.
38
- # Also notice that context will continue using the same font, pen and brush as before until {Wx::GCDC#set_font}, {Wx::GCDC#set_pen} or {Wx::GCDC#set_brush} is explicitly called to change them. This means that the code can use this {Wx::DC}-derived object to work using pens and brushes with alpha component, for example (which normally isn't supported by {Wx::DC} API), but it also means that the return values of {Wx::GCDC#get_font}, {Wx::GCDC#get_pen} and {Wx::GCDC#get_brush} won't really correspond to the actually used objects because they simply can't represent them anyhow. If you wish to avoid such discrepancy, you need to call the setter methods to bring {Wx::DC} and {Wx::GraphicsContext} font, pen and brush in sync with each other.
39
- # @param context [Wx::GraphicsContext]
40
- # @return [GCDC]
41
- # @overload initialize()
42
- # @return [GCDC]
43
- def initialize(*args) end
44
-
45
25
  # Retrieves associated {Wx::GraphicsContext}.
46
26
  # @return [Wx::GraphicsContext]
47
27
  def get_graphics_context; end
@@ -352,6 +352,8 @@ module Wx
352
352
  # @see Wx::RealPoint
353
353
  #
354
354
  #
355
+ #
356
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
355
357
  class Point < ::Object
356
358
 
357
359
  # Returns true if neither of the point components is equal to {Wx::DEFAULT_COORD}.
@@ -363,10 +365,12 @@ module Wx
363
365
  # Combine this object with another one replacing the uninitialized values.
364
366
  # It is typically used like this:
365
367
  #
368
+ # ```
366
369
  # if ( !pos.IsFullySpecified() )
367
370
  # {
368
371
  # pos.SetDefaults(GetDefaultPosition());
369
372
  # }
373
+ # ```
370
374
  # @see Wx::Point#is_fully_specified
371
375
  # @param pt [Array(Integer, Integer), Wx::Point]
372
376
  # @return [void]
@@ -409,11 +413,12 @@ module Wx
409
413
  # @overload initialize(pt)
410
414
  # Converts the given {Wx::RealPoint} (with floating point coordinates) to a {Wx::Point} instance.
411
415
  # Notice that this truncates the floating point values of pt components, if you want to round them instead you need to do it manually, e.g.
412
- #
416
+ # ```
413
417
  # #include <wx/math.h> // for wxRound()
414
418
  #
415
419
  # wxRealPoint rp = ...;
416
420
  # wxPoint p(wxRound(rp.x), wxRound(rp.y));
421
+ # ```
417
422
  # @param pt [Wx::RealPoint]
418
423
  # @return [Point]
419
424
  def initialize(*args) end
@@ -432,6 +437,8 @@ module Wx
432
437
  # @see Wx::RealPoint
433
438
  #
434
439
  #
440
+ #
441
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
435
442
  class Size < ::Object
436
443
 
437
444
  # @overload dec_by(pt)
@@ -551,10 +558,12 @@ module Wx
551
558
  # Combine this size object with another one replacing the default (i.e. equal to -1) components of this object with those of the other.
552
559
  # It is typically used like this:
553
560
  #
561
+ # ```
554
562
  # if ( !size.IsFullySpecified() )
555
563
  # {
556
564
  # size.SetDefaults(GetDefaultSize());
557
565
  # }
566
+ # ```
558
567
  # @see Wx::Size#is_fully_specified
559
568
  # @param sizeDefault [Array(Integer, Integer), Wx::Size]
560
569
  # @return [void]
@@ -577,9 +586,10 @@ module Wx
577
586
 
578
587
  # Represents a rectangle with integer coordinates.
579
588
  # x and y members specify the coordinates of the rectangle top-left corner and width and height specify its width and height respectively. The usual C++ semi-open interval convention is used: point p lies inside the rectangle if and only if both conditions below are satisfied:
580
- #
589
+ # ```
581
590
  # x <= p.x < x + width
582
591
  # y <= p.y < y + height
592
+ # ```
583
593
  #
584
594
  # In other words, the rectangle left and right boundaries are at x and <code>x+width-1</code> and its top and bottom boundaries are at y and <code>y+height-1</code> respectively.
585
595
  # Note that the x and y coordinates may be negative, but width and height are always strictly positive for non-empty rectangles.
@@ -590,6 +600,8 @@ module Wx
590
600
  # @see Wx::Size
591
601
  #
592
602
  #
603
+ #
604
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
593
605
  class Rect < ::Object
594
606
 
595
607
  # Returns the rectangle having the same size as this one but centered relatively to the given rectangle r.
@@ -887,6 +899,8 @@ module Wx
887
899
  # @see Wx::Point
888
900
  #
889
901
  #
902
+ #
903
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
890
904
  class RealPoint < ::Object
891
905
 
892
906
  # X coordinate of this point.
@@ -1073,6 +1087,8 @@ module Wx
1073
1087
  # @see Wx::Colour
1074
1088
  #
1075
1089
  #
1090
+ #
1091
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1076
1092
  class ColourDatabase < ::Object
1077
1093
 
1078
1094
  # Constructs the colour database.
@@ -17,6 +17,8 @@ module Wx
17
17
  # @see Wx::Font
18
18
  #
19
19
  #
20
+ #
21
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
20
22
  class GDIObject < Object
21
23
 
22
24
  # Default constructor.
@@ -165,6 +165,7 @@ module Wx
165
165
  # A {Wx::GraphicsContext} instance is the object that is drawn upon.
166
166
  # It is created by a renderer using Wx::GraphicsRenderer#create_context. This can be either directly using a renderer instance, or indirectly using the static convenience {Wx::GraphicsContext.create} functions of {Wx::GraphicsContext} that always delegate the task to the default renderer.
167
167
  #
168
+ # ```
168
169
  # void MyCanvas::OnPaint(wxPaintEvent &event)
169
170
  # {
170
171
  # // Create paint DC
@@ -191,6 +192,7 @@ module Wx
191
192
  # delete gc;
192
193
  # }
193
194
  # }
195
+ # ```
194
196
  #
195
197
  # For some renderers (like Direct2D or Cairo) processing of drawing operations may be deferred (Direct2D render target normally builds up a batch of rendering commands but defers processing of these commands, Cairo operates on a separate surface) so to make drawing results visible you need to update the content of the context by calling {Wx::GraphicsContext#flush} or by destroying the context.
196
198
  #
@@ -202,51 +204,10 @@ module Wx
202
204
  # @see Wx::DC
203
205
  #
204
206
  #
207
+ #
208
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
205
209
  class GraphicsContext < GraphicsObject
206
210
 
207
- # @overload self.create(window)
208
- # Creates a {Wx::GraphicsContext} from a {Wx::Window}.
209
- #
210
- # @see Wx::GraphicsRenderer#create_context
211
- # @param window [Wx::Window]
212
- # @return [Wx::GraphicsContext]
213
- # @overload self.create(windowDC)
214
- # Creates a {Wx::GraphicsContext} from a {Wx::WindowDC}.
215
- #
216
- # @see Wx::GraphicsRenderer#create_context
217
- # @param windowDC [Wx::WindowDC]
218
- # @return [Wx::GraphicsContext]
219
- # @overload self.create(memoryDC)
220
- # Creates a {Wx::GraphicsContext} from a {Wx::MemoryDC}.
221
- #
222
- # @see Wx::GraphicsRenderer#create_context
223
- # @param memoryDC [Wx::MemoryDC]
224
- # @return [Wx::GraphicsContext]
225
- # @overload self.create(printerDC)
226
- # Creates a {Wx::GraphicsContext} from a {Wx::PRT::PrinterDC}.
227
- # Under GTK+, this will only work when using the GtkPrint printing backend which is available since GTK+ 2.10.
228
- # @see Wx::GraphicsRenderer#create_context
229
- # @see Printing Under Unix (GTK+)
230
- # @param printerDC [Wx::PrinterDC]
231
- # @return [Wx::GraphicsContext]
232
- # @overload self.create(image)
233
- # Creates a {Wx::GraphicsContext} associated with a {Wx::Image}.
234
- # The image specifies the size of the context as well as whether alpha is supported (if {Wx::Image#has_alpha}) or not and the initial contents of the context. The image object must have a life time greater than that of the new context as the context copies its contents back to the image when it is destroyed.
235
- # @param image [Wx::Image]
236
- # @return [Wx::GraphicsContext]
237
- # @overload self.create()
238
- # Create a lightweight context that can be used only for measuring text.
239
- # @return [Wx::GraphicsContext]
240
- def self.create(*args) end
241
-
242
- # Creates a {Wx::GraphicsContext} from a DC of unknown specific type.
243
- # Creates a {Wx::GraphicsContext} if dc is a supported type (i.e. has a corresponding {Wx::GraphicsContext.create} method, e.g. {Wx::WindowDC} or {Wx::MemoryDC}). Returns NULL if the DC is unsupported.
244
- # This method is only useful as a helper in generic code that operates with {Wx::DC} and doesn't known its exact type. Use {Wx::GraphicsContext.create} instead if you know that the DC is e.g. {Wx::WindowDC}.
245
- # @see Wx::GraphicsRenderer#create_context_from_unknown_dc
246
- # @param dc [Wx::DC]
247
- # @return [Wx::GraphicsContext]
248
- def self.create_from_unknown_dc(dc) end
249
-
250
211
  # Resets the clipping to original shape.
251
212
  # @return [void]
252
213
  def reset_clip; end
@@ -407,7 +407,9 @@ module Wx
407
407
  # Concatenates the matrix passed with the current matrix.
408
408
  # The effect of the resulting transformation is to first apply the transformation in t to the coordinates and then apply the transformation in the current matrix to the coordinates.
409
409
  #
410
+ # ```
410
411
  # // matrix = t x matrix
412
+ # ```
411
413
  # @param t [Wx::GraphicsMatrix] The parameter matrix is the multiplicand.
412
414
  # @return [void]
413
415
  def concat(t) end
@@ -97,10 +97,11 @@ module Wx::GRID
97
97
  # Get the alignment defined by this attribute.
98
98
  # Unlike {Wx::GRID::GridCellAttr#get_alignment} this function only modifies hAlign and vAlign if this attribute does define a non-default alignment. This means that they must be initialized before calling this function and that their values will be preserved unchanged if they are different from {Wx::Alignment::ALIGN_INVALID}.
99
99
  # For example, the following fragment can be used to use the cell alignment if one is defined but right-align its contents by default (instead of left-aligning it by default) while still using the default vertical alignment:
100
- #
100
+ # ```
101
101
  # int hAlign = wxALIGN_RIGHT,
102
102
  # vAlign = wxALIGN_INVALID;
103
103
  # attr.GetNonDefaultAlignment(&hAlign, &vAlign);
104
+ # ```
104
105
  # @return [Array(Integer,Integer)]
105
106
  def get_non_default_alignment; end
106
107
  alias_method :non_default_alignment, :get_non_default_alignment
@@ -374,7 +374,7 @@ module Wx::GRID
374
374
  # Returns the pen used for horizontal grid lines.
375
375
  # This virtual function may be overridden in derived classes in order to change the appearance of individual grid line for the given row.
376
376
  # Example:
377
- #
377
+ # ```
378
378
  # // in a grid displaying music notation, use a solid black pen between
379
379
  # // octaves (C0=row 127, C1=row 115 etc.)
380
380
  # wxPen MidiGrid::GetRowGridLinePen(int row)
@@ -384,6 +384,7 @@ module Wx::GRID
384
384
  # else
385
385
  # return GetDefaultGridLinePen();
386
386
  # }
387
+ # ```
387
388
  # @param row [Integer]
388
389
  # @return [Wx::Pen]
389
390
  def get_row_grid_line_pen(row) end
@@ -1258,7 +1259,7 @@ module Wx::GRID
1258
1259
  # For normal cells, the function fills both num_rows and num_cols with 1 and returns CellSpan_None. For cells which span multiple cells, i.e. for which {Wx::GRID::Grid#set_cell_size} had been called, the returned values are the same ones as were passed to {Wx::GRID::Grid#set_cell_size} call and the function return value is CellSpan_Main.
1259
1260
  # More unexpectedly, perhaps, the returned values may be negative for the cells which are inside a span covered by a cell occupying multiple rows or columns. They correspond to the offset of the main cell of the span from the cell passed to this functions and the function returns CellSpan_Inside value to indicate this.
1260
1261
  # As an example, consider a 3*3 grid with the cell (1, 1) (the one in the middle) having a span of 2 rows and 2 columns, i.e. the grid looks like
1261
- #
1262
+ # ```
1262
1263
  # +----+----+----+
1263
1264
  # | | | |
1264
1265
  # +----+----+----+
@@ -1266,6 +1267,7 @@ module Wx::GRID
1266
1267
  # +----+ |
1267
1268
  # | | |
1268
1269
  # +----+----+----+
1270
+ # ```
1269
1271
  # Then the function returns 2 and 2 in num_rows and num_cols for the cell (1, 1) itself and -1 and -1 for the cell (2, 2) as well as -1 and 0 for the cell (2, 1).
1270
1272
  #
1271
1273
  # The kind of this cell span (the return value is new in wxWidgets 2.9.1, this function was void in previous wxWidgets versions).
@@ -9,6 +9,8 @@ module Wx::GRID
9
9
  # Message class used by the grid table to send requests and notifications to the grid view.
10
10
  # A message object of this class must be sent to the grid using {Wx::GRID::Grid#process_table_message} every time the table changes, e.g. rows are added/deleted. The messages are just notifications and don't result in any actual changes but just allow the view to react to changes to the model.
11
11
  #
12
+ #
13
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
12
14
  class GridTableMessage < ::Object
13
15
 
14
16
  # @overload initialize()
@@ -207,6 +207,8 @@ module Wx
207
207
  #
208
208
  # Category: Window Layout
209
209
  #
210
+ #
211
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
210
212
  class GBSpan < ::Object
211
213
 
212
214
  # @overload initialize()
@@ -253,6 +255,8 @@ module Wx
253
255
  #
254
256
  # Category: Window Layout
255
257
  #
258
+ #
259
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
256
260
  class GBPosition < ::Object
257
261
 
258
262
  # @overload initialize()
@@ -34,8 +34,9 @@ module Wx
34
34
  # The remaining help controller classes need to be named explicitly by an application that wishes to make use of them.
35
35
  # The following help controller classes are defined:
36
36
  # - {Wx::WinHelpController}, for controlling Windows Help.- {Wx::CHMHelpController}, for controlling MS HTML Help. To use this, you need to set {Wx::Setup::USE_MS_HTML_HELP} to 1 in setup.h and have the htmlhelp.h header from Microsoft's HTML Help kit. (You don't need the VC++-specific htmlhelp.lib because wxWidgets loads necessary DLL at runtime and so it works with all compilers.)- {Wx::BestHelpController}, for controlling MS HTML Help or, if Microsoft's runtime is not available, {Wx::HTML::HtmlHelpController}. You need to provide <b>both</b> CHM and HTB versions of the help file. For {Wx::MSW} only.- {Wx::ExtHelpController}, for controlling external browsers under Unix. The default browser is Netscape Navigator. The 'help' sample shows its use.- {Wx::HTML::HtmlHelpController}, a sophisticated help controller using {Wx::HTML}, in a similar style to the Microsoft HTML Help viewer and using some of the same files. Although it has an API compatible with other help controllers, it has more advanced features, so it is recommended that you use the specific API for this class instead. Note that if you use .zip or .htb formats for your books, you must add this line to your application initialization:
37
- #
37
+ # ```
38
38
  # wxFileSystem::AddHandler(new wxArchiveFSHandler);
39
+ # ```
39
40
  # or nothing will be shown in your help window.
40
41
  #
41
42
  # ===
@@ -119,9 +120,11 @@ module Wx
119
120
  # Sets detailed viewer information.
120
121
  # So far this is only relevant to {Wx::ExtHelpController}. Some examples of usage:
121
122
  #
123
+ # ```
122
124
  # m_help.SetViewer("kdehelp");
123
125
  # m_help.SetViewer("gnome-help-browser");
124
126
  # m_help.SetViewer("netscape", wxHELP_NETSCAPE);
127
+ # ```
125
128
  #
126
129
  # Todomodernize this function with {Wx::LaunchDefaultBrowser}
127
130
  # @param viewer [String] This defaults to "netscape" for {Wx::ExtHelpController}.
@@ -269,6 +269,8 @@ module Wx::HTML
269
269
  #
270
270
  # Category: {Wx::HTML}
271
271
  #
272
+ #
273
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
272
274
  class HtmlLinkInfo < Object
273
275
 
274
276
  # @overload initialize()
@@ -420,8 +422,9 @@ module Wx::HTML
420
422
  # Sets floating width adjustment.
421
423
  # The normal behaviour of container is that its width is the same as the width of parent container (and thus you can have only one sub-container per line). You can change this by setting the floating width adjustment.
422
424
  # @param w [Integer] Width of the container. If the value is negative it means complement to full width of parent container. E.g.
423
- #
425
+ # ```
424
426
  # SetWidthFloat(-50, wxHTML_UNITS_PIXELS)
427
+ # ```
425
428
  # sets the width of container to parent's width minus 50 pixels. This is useful when creating tables - you can call SetWidthFloat(50) and SetWidthFloat(-50).
426
429
  # @param units [Integer] Units of w This parameter affects the interpretation of value.
427
430
  # - {Wx::HTML::HTML_UNITS_PIXELS}: w is number of pixels- {Wx::HTML::HTML_UNITS_PERCENT}: w is interpreted as percents of width of parent container
@@ -73,8 +73,9 @@ module Wx::HTML
73
73
  # Adds a book (i.e.
74
74
  # a .hhp file; an HTML Help Workshop project file) into the list of loaded books.
75
75
  # This must be called at least once before displaying any help. bookFile or bookUrl may be either <code>".hhp"</code> file or a ZIP archive that contains an arbitrary number of <code>".hhp"</code> files in its top-level directory. This ZIP archive must have <code>".zip"</code> or <code>".htb"</code> extension (the latter stands for "HTML book"). In other words,
76
- #
76
+ # ```
77
77
  # AddBook(wxFileName("help.zip"))
78
+ # ```
78
79
  # is possible and is the recommended way.
79
80
  # @param bookFile [Wx::FileName] Help book filename. It is recommended to use this prototype instead of the one taking URL, because it is less error-prone.
80
81
  # @param showWaitMsg [true,false] If true then a decoration-less window with progress message is displayed.
@@ -239,9 +240,11 @@ module Wx::HTML
239
240
  # Sets detailed viewer information.
240
241
  # So far this is only relevant to {Wx::ExtHelpController}. Some examples of usage:
241
242
  #
243
+ # ```
242
244
  # m_help.SetViewer("kdehelp");
243
245
  # m_help.SetViewer("gnome-help-browser");
244
246
  # m_help.SetViewer("netscape", wxHELP_NETSCAPE);
247
+ # ```
245
248
  #
246
249
  # Todomodernize this function with {Wx::LaunchDefaultBrowser}
247
250
  # @param viewer [String] This defaults to "netscape" for {Wx::ExtHelpController}.